contrib/bind-9.3/lib/dns/include/dns/types.h

   1 /*
   2  * Copyright (C) 2004, 2006  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: types.h,v 1.103.12.9 2006/03/02 00:37:20 marka Exp $ */
  19
  20 #ifndef DNS_TYPES_H
  21 #define DNS_TYPES_H 1
  22
  23 /*
  24  * Including this file gives you type declarations suitable for use in
  25  * .h files, which lets us avoid circular type reference problems.
  26  *
  27  * To actually use a type or get declarations of its methods, you must
  28  * include the appropriate .h file too.
  29  */
  30
  31 #include <isc/types.h>
  32
  33 typedef struct dns_acl                          dns_acl_t;
  34 typedef struct dns_aclelement                   dns_aclelement_t;
  35 typedef struct dns_aclenv                       dns_aclenv_t;
  36 typedef struct dns_adb                          dns_adb_t;
  37 typedef struct dns_adbaddrinfo                  dns_adbaddrinfo_t;
  38 typedef ISC_LIST(dns_adbaddrinfo_t)             dns_adbaddrinfolist_t;
  39 typedef struct dns_adbentry                     dns_adbentry_t;
  40 typedef struct dns_adbfind                      dns_adbfind_t;
  41 typedef ISC_LIST(dns_adbfind_t)                 dns_adbfindlist_t;
  42 typedef struct dns_byaddr                       dns_byaddr_t;
  43 typedef struct dns_cache                        dns_cache_t;
  44 typedef isc_uint16_t                            dns_cert_t;
  45 typedef struct dns_compress                     dns_compress_t;
  46 typedef struct dns_db                           dns_db_t;
  47 typedef struct dns_dbimplementation             dns_dbimplementation_t;
  48 typedef struct dns_dbiterator                   dns_dbiterator_t;
  49 typedef void                                    dns_dbload_t;
  50 typedef void                                    dns_dbnode_t;
  51 typedef struct dns_dbtable                      dns_dbtable_t;
  52 typedef void                                    dns_dbversion_t;
  53 typedef struct dns_decompress                   dns_decompress_t;
  54 typedef struct dns_dispatch                     dns_dispatch_t;
  55 typedef struct dns_dispatchevent                dns_dispatchevent_t;
  56 typedef struct dns_dispatchlist                 dns_dispatchlist_t;
  57 typedef struct dns_dispatchmgr                  dns_dispatchmgr_t;
  58 typedef struct dns_dispentry                    dns_dispentry_t;
  59 typedef struct dns_dumpctx                      dns_dumpctx_t;
  60 typedef struct dns_fetch                        dns_fetch_t;
  61 typedef struct dns_fixedname                    dns_fixedname_t;
  62 typedef struct dns_forwarders                   dns_forwarders_t;
  63 typedef struct dns_fwdtable                     dns_fwdtable_t;
  64 typedef isc_uint16_t                            dns_keyflags_t;
  65 typedef struct dns_keynode                      dns_keynode_t;
  66 typedef struct dns_keytable                     dns_keytable_t;
  67 typedef isc_uint16_t                            dns_keytag_t;
  68 typedef struct dns_loadctx                      dns_loadctx_t;
  69 typedef struct dns_loadmgr                      dns_loadmgr_t;
  70 typedef struct dns_message                      dns_message_t;
  71 typedef isc_uint16_t                            dns_messageid_t;
  72 typedef isc_region_t                            dns_label_t;
  73 typedef struct dns_lookup                       dns_lookup_t;
  74 typedef struct dns_name                         dns_name_t;
  75 typedef ISC_LIST(dns_name_t)                    dns_namelist_t;
  76 typedef isc_uint16_t                            dns_opcode_t;
  77 typedef unsigned char                           dns_offsets_t[128];
  78 typedef struct dns_order                        dns_order_t;
  79 typedef struct dns_peer                         dns_peer_t;
  80 typedef struct dns_peerlist                     dns_peerlist_t;
  81 typedef struct dns_portlist                     dns_portlist_t;
  82 typedef struct dns_rbt                          dns_rbt_t;
  83 typedef isc_uint16_t                            dns_rcode_t;
  84 typedef struct dns_rdata                        dns_rdata_t;
  85 typedef struct dns_rdatacallbacks               dns_rdatacallbacks_t;
  86 typedef isc_uint16_t                            dns_rdataclass_t;
  87 typedef struct dns_rdatalist                    dns_rdatalist_t;
  88 typedef struct dns_rdataset                     dns_rdataset_t;
  89 typedef ISC_LIST(dns_rdataset_t)                dns_rdatasetlist_t;
  90 typedef struct dns_rdatasetiter                 dns_rdatasetiter_t;
  91 typedef isc_uint16_t                            dns_rdatatype_t;
  92 typedef struct dns_request                      dns_request_t;
  93 typedef struct dns_requestmgr                   dns_requestmgr_t;
  94 typedef struct dns_resolver                     dns_resolver_t;
  95 typedef struct dns_sdbimplementation            dns_sdbimplementation_t;
  96 typedef isc_uint8_t                             dns_secalg_t;
  97 typedef isc_uint8_t                             dns_secproto_t;
  98 typedef struct dns_signature                    dns_signature_t;
  99 typedef struct dns_ssurule                      dns_ssurule_t;
 100 typedef struct dns_ssutable                     dns_ssutable_t;
 101 typedef struct dns_tkeyctx                      dns_tkeyctx_t;
 102 typedef isc_uint16_t                            dns_trust_t;
 103 typedef struct dns_tsig_keyring                 dns_tsig_keyring_t;
 104 typedef struct dns_tsigkey                      dns_tsigkey_t;
 105 typedef isc_uint32_t                            dns_ttl_t;
 106 typedef struct dns_validator                    dns_validator_t;
 107 typedef struct dns_view                         dns_view_t;
 108 typedef ISC_LIST(dns_view_t)                    dns_viewlist_t;
 109 typedef struct dns_zone                         dns_zone_t;
 110 typedef ISC_LIST(dns_zone_t)                    dns_zonelist_t;
 111 typedef struct dns_zonemgr                      dns_zonemgr_t;
 112 typedef struct dns_zt                           dns_zt_t;
 113
 114 typedef enum {
 115         dns_fwdpolicy_none = 0,
 116         dns_fwdpolicy_first = 1,
 117         dns_fwdpolicy_only = 2
 118 } dns_fwdpolicy_t;
 119
 120 typedef enum {
 121         dns_namereln_none = 0,
 122         dns_namereln_contains = 1,
 123         dns_namereln_subdomain = 2,
 124         dns_namereln_equal = 3,
 125         dns_namereln_commonancestor = 4
 126 } dns_namereln_t;
 127
 128 typedef enum {
 129         dns_one_answer, dns_many_answers
 130 } dns_transfer_format_t;
 131
 132 typedef enum {
 133         dns_dbtype_zone = 0, dns_dbtype_cache = 1, dns_dbtype_stub = 3
 134 } dns_dbtype_t;
 135
 136 typedef enum {
 137         dns_notifytype_no = 0,
 138         dns_notifytype_yes = 1,
 139         dns_notifytype_explicit = 2
 140 } dns_notifytype_t;
 141
 142 typedef enum {
 143         dns_dialuptype_no = 0,
 144         dns_dialuptype_yes = 1,
 145         dns_dialuptype_notify = 2,
 146         dns_dialuptype_notifypassive = 3,
 147         dns_dialuptype_refresh = 4,
 148         dns_dialuptype_passive = 5
 149 } dns_dialuptype_t;
 150
 151 /*
 152  * These are generated by gen.c.
 153  */
 154 #include <dns/enumtype.h>       /* Provides dns_rdatatype_t. */
 155 #include <dns/enumclass.h>      /* Provides dns_rdataclass_t. */
 156
 157 /*
 158  * rcodes.
 159  */
 160 enum {
 161         /*
 162          * Standard rcodes.
 163          */
 164         dns_rcode_noerror = 0,
 165 #define dns_rcode_noerror               ((dns_rcode_t)dns_rcode_noerror)
 166         dns_rcode_formerr = 1,
 167 #define dns_rcode_formerr               ((dns_rcode_t)dns_rcode_formerr)
 168         dns_rcode_servfail = 2,
 169 #define dns_rcode_servfail              ((dns_rcode_t)dns_rcode_servfail)
 170         dns_rcode_nxdomain = 3,
 171 #define dns_rcode_nxdomain              ((dns_rcode_t)dns_rcode_nxdomain)
 172         dns_rcode_notimp = 4,
 173 #define dns_rcode_notimp                ((dns_rcode_t)dns_rcode_notimp)
 174         dns_rcode_refused = 5,
 175 #define dns_rcode_refused               ((dns_rcode_t)dns_rcode_refused)
 176         dns_rcode_yxdomain = 6,
 177 #define dns_rcode_yxdomain              ((dns_rcode_t)dns_rcode_yxdomain)
 178         dns_rcode_yxrrset = 7,
 179 #define dns_rcode_yxrrset               ((dns_rcode_t)dns_rcode_yxrrset)
 180         dns_rcode_nxrrset = 8,
 181 #define dns_rcode_nxrrset               ((dns_rcode_t)dns_rcode_nxrrset)
 182         dns_rcode_notauth = 9,
 183 #define dns_rcode_notauth               ((dns_rcode_t)dns_rcode_notauth)
 184         dns_rcode_notzone = 10,
 185 #define dns_rcode_notzone               ((dns_rcode_t)dns_rcode_notzone)
 186         /*
 187          * Extended rcodes.
 188          */
 189         dns_rcode_badvers = 16
 190 #define dns_rcode_badvers               ((dns_rcode_t)dns_rcode_badvers)
 191 };
 192
 193 /*
 194  * TSIG errors.
 195  */
 196 enum {
 197         dns_tsigerror_badsig = 16,
 198         dns_tsigerror_badkey = 17,
 199         dns_tsigerror_badtime = 18,
 200         dns_tsigerror_badmode = 19,
 201         dns_tsigerror_badname = 20,
 202         dns_tsigerror_badalg = 21
 203 };
 204
 205 /*
 206  * Opcodes.
 207  */
 208 enum {
 209         dns_opcode_query = 0,
 210 #define dns_opcode_query                ((dns_opcode_t)dns_opcode_query)
 211         dns_opcode_iquery = 1,
 212 #define dns_opcode_iquery               ((dns_opcode_t)dns_opcode_iquery)
 213         dns_opcode_status = 2,
 214 #define dns_opcode_status               ((dns_opcode_t)dns_opcode_status)
 215         dns_opcode_notify = 4,
 216 #define dns_opcode_notify               ((dns_opcode_t)dns_opcode_notify)
 217         dns_opcode_update = 5           /* dynamic update */
 218 #define dns_opcode_update               ((dns_opcode_t)dns_opcode_update)
 219 };
 220
 221 /*
 222  * Trust levels.  Must be kept in sync with trustnames[] in masterdump.c.
 223  */
 224 enum {
 225         /* Sentinel value; no data should have this trust level. */
 226         dns_trust_none = 0,
 227 #define dns_trust_none                  ((dns_trust_t)dns_trust_none)
 228
 229         /* Subject to DNSSEC validation but has not yet been validated */
 230         dns_trust_pending = 1,
 231 #define dns_trust_pending               ((dns_trust_t)dns_trust_pending)
 232
 233         /* Received in the additional section of a response. */
 234         dns_trust_additional = 2,
 235 #define dns_trust_additional            ((dns_trust_t)dns_trust_additional)
 236
 237         /* Received in a referral response. */
 238         dns_trust_glue = 3,
 239 #define dns_trust_glue                  ((dns_trust_t)dns_trust_glue)
 240
 241         /* Answser from a non-authoritative server */
 242         dns_trust_answer = 4,
 243 #define dns_trust_answer                ((dns_trust_t)dns_trust_answer)
 244
 245         /*  Received in the authority section as part of an
 246             authoritative response */
 247         dns_trust_authauthority = 5,
 248 #define dns_trust_authauthority         ((dns_trust_t)dns_trust_authauthority)
 249
 250         /* Answser from an authoritative server */
 251         dns_trust_authanswer = 6,
 252 #define dns_trust_authanswer            ((dns_trust_t)dns_trust_authanswer)
 253
 254         /* Successfully DNSSEC validated */
 255         dns_trust_secure = 7,
 256 #define dns_trust_secure                ((dns_trust_t)dns_trust_secure)
 257
 258         /* This server is authoritative */
 259         dns_trust_ultimate = 8
 260 #define dns_trust_ultimate              ((dns_trust_t)dns_trust_ultimate)
 261 };
 262
 263 /*
 264  * Name checking severites.
 265  */
 266 typedef enum {
 267         dns_severity_ignore,
 268         dns_severity_warn,
 269         dns_severity_fail
 270 } dns_severity_t;
 271
 272 /*
 273  * Functions.
 274  */
 275 typedef void
 276 (*dns_dumpdonefunc_t)(void *, isc_result_t);
 277
 278 typedef void
 279 (*dns_loaddonefunc_t)(void *, isc_result_t);
 280
 281 typedef isc_result_t
 282 (*dns_addrdatasetfunc_t)(void *, dns_name_t *, dns_rdataset_t *);
 283
 284 typedef isc_result_t
 285 (*dns_additionaldatafunc_t)(void *, dns_name_t *, dns_rdatatype_t);
 286
 287 typedef isc_result_t
 288 (*dns_digestfunc_t)(void *, isc_region_t *);
 289
 290 typedef void
 291 (*dns_xfrindone_t)(dns_zone_t *, isc_result_t);
 292
 293 typedef void
 294 (*dns_updatecallback_t)(void *, isc_result_t, dns_message_t *);
 295
 296 typedef int
 297 (*dns_rdatasetorderfunc_t)(const dns_rdata_t *rdata, const void *arg);
 298
 299 #endif /* DNS_TYPES_H */