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