lib/dns/include/dns/types.h

   1 /*
   2  * Copyright (C) 2004-2010  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or 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.138.16.3 2010/05/14 23:49:21 tbox Exp $ */
  19
  20 #ifndef DNS_TYPES_H
  21 #define DNS_TYPES_H 1
  22
  23 /*! \file dns/types.h
  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_client                       dns_client_t;
  48 typedef void                                    dns_clientrestrans_t;
  49 typedef void                                    dns_clientreqtrans_t;
  50 typedef void                                    dns_clientupdatetrans_t;
  51 typedef struct dns_cache                        dns_cache_t;
  52 typedef isc_uint16_t                            dns_cert_t;
  53 typedef struct dns_compress                     dns_compress_t;
  54 typedef struct dns_db                           dns_db_t;
  55 typedef struct dns_dbimplementation             dns_dbimplementation_t;
  56 typedef struct dns_dbiterator                   dns_dbiterator_t;
  57 typedef void                                    dns_dbload_t;
  58 typedef void                                    dns_dbnode_t;
  59 typedef struct dns_dbtable                      dns_dbtable_t;
  60 typedef void                                    dns_dbversion_t;
  61 typedef struct dns_dlzimplementation            dns_dlzimplementation_t;
  62 typedef struct dns_dlzdb                        dns_dlzdb_t;
  63 typedef struct dns_sdlzimplementation           dns_sdlzimplementation_t;
  64 typedef struct dns_decompress                   dns_decompress_t;
  65 typedef struct dns_dispatch                     dns_dispatch_t;
  66 typedef struct dns_dispatchevent                dns_dispatchevent_t;
  67 typedef struct dns_dispatchlist                 dns_dispatchlist_t;
  68 typedef struct dns_dispatchmgr                  dns_dispatchmgr_t;
  69 typedef struct dns_dispentry                    dns_dispentry_t;
  70 typedef struct dns_dnsseckey                    dns_dnsseckey_t;
  71 typedef ISC_LIST(dns_dnsseckey_t)               dns_dnsseckeylist_t;
  72 typedef struct dns_dumpctx                      dns_dumpctx_t;
  73 typedef struct dns_fetch                        dns_fetch_t;
  74 typedef struct dns_fixedname                    dns_fixedname_t;
  75 typedef struct dns_forwarders                   dns_forwarders_t;
  76 typedef struct dns_fwdtable                     dns_fwdtable_t;
  77 typedef struct dns_iptable                      dns_iptable_t;
  78 typedef isc_uint32_t                            dns_iterations_t;
  79 typedef isc_uint16_t                            dns_keyflags_t;
  80 typedef struct dns_keynode                      dns_keynode_t;
  81 typedef ISC_LIST(dns_keynode_t)                 dns_keynodelist_t;
  82 typedef struct dns_keytable                     dns_keytable_t;
  83 typedef isc_uint16_t                            dns_keytag_t;
  84 typedef struct dns_loadctx                      dns_loadctx_t;
  85 typedef struct dns_loadmgr                      dns_loadmgr_t;
  86 typedef struct dns_message                      dns_message_t;
  87 typedef isc_uint16_t                            dns_messageid_t;
  88 typedef isc_region_t                            dns_label_t;
  89 typedef struct dns_lookup                       dns_lookup_t;
  90 typedef struct dns_name                         dns_name_t;
  91 typedef ISC_LIST(dns_name_t)                    dns_namelist_t;
  92 typedef isc_uint16_t                            dns_opcode_t;
  93 typedef unsigned char                           dns_offsets_t[128];
  94 typedef struct dns_order                        dns_order_t;
  95 typedef struct dns_peer                         dns_peer_t;
  96 typedef struct dns_peerlist                     dns_peerlist_t;
  97 typedef struct dns_portlist                     dns_portlist_t;
  98 typedef struct dns_rbt                          dns_rbt_t;
  99 typedef isc_uint16_t                            dns_rcode_t;
 100 typedef struct dns_rdata                        dns_rdata_t;
 101 typedef struct dns_rdatacallbacks               dns_rdatacallbacks_t;
 102 typedef isc_uint16_t                            dns_rdataclass_t;
 103 typedef struct dns_rdatalist                    dns_rdatalist_t;
 104 typedef struct dns_rdataset                     dns_rdataset_t;
 105 typedef ISC_LIST(dns_rdataset_t)                dns_rdatasetlist_t;
 106 typedef struct dns_rdatasetiter                 dns_rdatasetiter_t;
 107 typedef isc_uint16_t                            dns_rdatatype_t;
 108 typedef struct dns_request                      dns_request_t;
 109 typedef struct dns_requestmgr                   dns_requestmgr_t;
 110 typedef struct dns_resolver                     dns_resolver_t;
 111 typedef struct dns_sdbimplementation            dns_sdbimplementation_t;
 112 typedef isc_uint8_t                             dns_secalg_t;
 113 typedef isc_uint8_t                             dns_secproto_t;
 114 typedef struct dns_signature                    dns_signature_t;
 115 typedef struct dns_ssurule                      dns_ssurule_t;
 116 typedef struct dns_ssutable                     dns_ssutable_t;
 117 typedef struct dns_stats                        dns_stats_t;
 118 typedef isc_uint32_t                            dns_rdatastatstype_t;
 119 typedef struct dns_tkeyctx                      dns_tkeyctx_t;
 120 typedef isc_uint16_t                            dns_trust_t;
 121 typedef struct dns_tsec                         dns_tsec_t;
 122 typedef struct dns_tsig_keyring                 dns_tsig_keyring_t;
 123 typedef struct dns_tsigkey                      dns_tsigkey_t;
 124 typedef isc_uint32_t                            dns_ttl_t;
 125 typedef struct dns_validator                    dns_validator_t;
 126 typedef struct dns_view                         dns_view_t;
 127 typedef ISC_LIST(dns_view_t)                    dns_viewlist_t;
 128 typedef struct dns_zone                         dns_zone_t;
 129 typedef ISC_LIST(dns_zone_t)                    dns_zonelist_t;
 130 typedef struct dns_zonemgr                      dns_zonemgr_t;
 131 typedef struct dns_zt                           dns_zt_t;
 132
 133 /*
 134  * If we are not using GSSAPI, define the types we use as opaque types here.
 135  */
 136 #ifndef GSSAPI
 137 typedef struct not_defined_gss_cred_id *gss_cred_id_t;
 138 typedef struct not_defined_gss_ctx *gss_ctx_id_t;
 139 #endif
 140 typedef struct dst_gssapi_signverifyctx dst_gssapi_signverifyctx_t;
 141
 142 typedef enum {
 143         dns_hash_sha1 = 1
 144 } dns_hash_t;
 145
 146 typedef enum {
 147         dns_fwdpolicy_none = 0,
 148         dns_fwdpolicy_first = 1,
 149         dns_fwdpolicy_only = 2
 150 } dns_fwdpolicy_t;
 151
 152 typedef enum {
 153         dns_namereln_none = 0,
 154         dns_namereln_contains = 1,
 155         dns_namereln_subdomain = 2,
 156         dns_namereln_equal = 3,
 157         dns_namereln_commonancestor = 4
 158 } dns_namereln_t;
 159
 160 typedef enum {
 161         dns_one_answer, dns_many_answers
 162 } dns_transfer_format_t;
 163
 164 typedef enum {
 165         dns_dbtype_zone = 0, dns_dbtype_cache = 1, dns_dbtype_stub = 3
 166 } dns_dbtype_t;
 167
 168 typedef enum {
 169         dns_notifytype_no = 0,
 170         dns_notifytype_yes = 1,
 171         dns_notifytype_explicit = 2,
 172         dns_notifytype_masteronly = 3
 173 } dns_notifytype_t;
 174
 175 typedef enum {
 176         dns_dialuptype_no = 0,
 177         dns_dialuptype_yes = 1,
 178         dns_dialuptype_notify = 2,
 179         dns_dialuptype_notifypassive = 3,
 180         dns_dialuptype_refresh = 4,
 181         dns_dialuptype_passive = 5
 182 } dns_dialuptype_t;
 183
 184 typedef enum {
 185         dns_masterformat_none = 0,
 186         dns_masterformat_text = 1,
 187         dns_masterformat_raw = 2
 188 } dns_masterformat_t;
 189
 190 #ifdef ALLOW_FILTER_AAAA_ON_V4
 191 typedef enum {
 192         dns_v4_aaaa_ok = 0,
 193         dns_v4_aaaa_filter = 1,
 194         dns_v4_aaaa_break_dnssec = 2
 195 } dns_v4_aaaa_t;
 196
 197 #endif
 198
 199 /*
 200  * These are generated by gen.c.
 201  */
 202 #include <dns/enumtype.h>       /* Provides dns_rdatatype_t. */
 203 #include <dns/enumclass.h>      /* Provides dns_rdataclass_t. */
 204
 205 /*%
 206  * rcodes.
 207  */
 208 enum {
 209         /*
 210          * Standard rcodes.
 211          */
 212         dns_rcode_noerror = 0,
 213 #define dns_rcode_noerror               ((dns_rcode_t)dns_rcode_noerror)
 214         dns_rcode_formerr = 1,
 215 #define dns_rcode_formerr               ((dns_rcode_t)dns_rcode_formerr)
 216         dns_rcode_servfail = 2,
 217 #define dns_rcode_servfail              ((dns_rcode_t)dns_rcode_servfail)
 218         dns_rcode_nxdomain = 3,
 219 #define dns_rcode_nxdomain              ((dns_rcode_t)dns_rcode_nxdomain)
 220         dns_rcode_notimp = 4,
 221 #define dns_rcode_notimp                ((dns_rcode_t)dns_rcode_notimp)
 222         dns_rcode_refused = 5,
 223 #define dns_rcode_refused               ((dns_rcode_t)dns_rcode_refused)
 224         dns_rcode_yxdomain = 6,
 225 #define dns_rcode_yxdomain              ((dns_rcode_t)dns_rcode_yxdomain)
 226         dns_rcode_yxrrset = 7,
 227 #define dns_rcode_yxrrset               ((dns_rcode_t)dns_rcode_yxrrset)
 228         dns_rcode_nxrrset = 8,
 229 #define dns_rcode_nxrrset               ((dns_rcode_t)dns_rcode_nxrrset)
 230         dns_rcode_notauth = 9,
 231 #define dns_rcode_notauth               ((dns_rcode_t)dns_rcode_notauth)
 232         dns_rcode_notzone = 10,
 233 #define dns_rcode_notzone               ((dns_rcode_t)dns_rcode_notzone)
 234         /*
 235          * Extended rcodes.
 236          */
 237         dns_rcode_badvers = 16
 238 #define dns_rcode_badvers               ((dns_rcode_t)dns_rcode_badvers)
 239 };
 240
 241 /*%
 242  * TSIG errors.
 243  */
 244 enum {
 245         dns_tsigerror_badsig = 16,
 246         dns_tsigerror_badkey = 17,
 247         dns_tsigerror_badtime = 18,
 248         dns_tsigerror_badmode = 19,
 249         dns_tsigerror_badname = 20,
 250         dns_tsigerror_badalg = 21,
 251         dns_tsigerror_badtrunc = 22
 252 };
 253
 254 /*%
 255  * Opcodes.
 256  */
 257 enum {
 258         dns_opcode_query = 0,
 259 #define dns_opcode_query                ((dns_opcode_t)dns_opcode_query)
 260         dns_opcode_iquery = 1,
 261 #define dns_opcode_iquery               ((dns_opcode_t)dns_opcode_iquery)
 262         dns_opcode_status = 2,
 263 #define dns_opcode_status               ((dns_opcode_t)dns_opcode_status)
 264         dns_opcode_notify = 4,
 265 #define dns_opcode_notify               ((dns_opcode_t)dns_opcode_notify)
 266         dns_opcode_update = 5           /* dynamic update */
 267 #define dns_opcode_update               ((dns_opcode_t)dns_opcode_update)
 268 };
 269
 270 /*%
 271  * Trust levels.  Must be kept in sync with trustnames[] in masterdump.c.
 272  */
 273 enum {
 274         /* Sentinel value; no data should have this trust level. */
 275         dns_trust_none = 0,
 276 #define dns_trust_none                  ((dns_trust_t)dns_trust_none)
 277
 278         /*%
 279          * Subject to DNSSEC validation but has not yet been validated
 280          * dns_trust_pending_additional (from the additional section).
 281          */
 282         dns_trust_pending_additional = 1,
 283 #define dns_trust_pending_additional \
 284                  ((dns_trust_t)dns_trust_pending_additional)
 285
 286         dns_trust_pending_answer = 2,
 287 #define dns_trust_pending_answer        ((dns_trust_t)dns_trust_pending_answer)
 288
 289         /*% Received in the additional section of a response. */
 290         dns_trust_additional = 3,
 291 #define dns_trust_additional            ((dns_trust_t)dns_trust_additional)
 292
 293         /* Received in a referral response. */
 294         dns_trust_glue = 4,
 295 #define dns_trust_glue                  ((dns_trust_t)dns_trust_glue)
 296
 297         /* Answer from a non-authoritative server */
 298         dns_trust_answer = 5,
 299 #define dns_trust_answer                ((dns_trust_t)dns_trust_answer)
 300
 301         /*  Received in the authority section as part of an
 302             authoritative response */
 303         dns_trust_authauthority = 6,
 304 #define dns_trust_authauthority         ((dns_trust_t)dns_trust_authauthority)
 305
 306         /* Answer from an authoritative server */
 307         dns_trust_authanswer = 7,
 308 #define dns_trust_authanswer            ((dns_trust_t)dns_trust_authanswer)
 309
 310         /* Successfully DNSSEC validated */
 311         dns_trust_secure = 8,
 312 #define dns_trust_secure                ((dns_trust_t)dns_trust_secure)
 313
 314         /* This server is authoritative */
 315         dns_trust_ultimate = 9
 316 #define dns_trust_ultimate              ((dns_trust_t)dns_trust_ultimate)
 317 };
 318
 319 #define DNS_TRUST_PENDING(x)            ((x) == dns_trust_pending_answer || \
 320                                          (x) == dns_trust_pending_additional)
 321 #define DNS_TRUST_ADDITIONAL(x)         ((x) == dns_trust_additional || \
 322                                          (x) == dns_trust_pending_additional)
 323 #define DNS_TRUST_GLUE(x)               ((x) == dns_trust_glue)
 324 #define DNS_TRUST_ANSWER(x)             ((x) == dns_trust_answer)
 325
 326
 327 /*%
 328  * Name checking severities.
 329  */
 330 typedef enum {
 331         dns_severity_ignore,
 332         dns_severity_warn,
 333         dns_severity_fail
 334 } dns_severity_t;
 335
 336 /*
 337  * Functions.
 338  */
 339 typedef void
 340 (*dns_dumpdonefunc_t)(void *, isc_result_t);
 341
 342 typedef void
 343 (*dns_loaddonefunc_t)(void *, isc_result_t);
 344
 345 typedef isc_result_t
 346 (*dns_addrdatasetfunc_t)(void *, dns_name_t *, dns_rdataset_t *);
 347
 348 typedef isc_result_t
 349 (*dns_additionaldatafunc_t)(void *, dns_name_t *, dns_rdatatype_t);
 350
 351 typedef isc_result_t
 352 (*dns_digestfunc_t)(void *, isc_region_t *);
 353
 354 typedef void
 355 (*dns_xfrindone_t)(dns_zone_t *, isc_result_t);
 356
 357 typedef void
 358 (*dns_updatecallback_t)(void *, isc_result_t, dns_message_t *);
 359
 360 typedef int
 361 (*dns_rdatasetorderfunc_t)(const dns_rdata_t *, const void *);
 362
 363 typedef isc_boolean_t
 364 (*dns_checkmxfunc_t)(dns_zone_t *, dns_name_t *, dns_name_t *);
 365
 366 typedef isc_boolean_t
 367 (*dns_checksrvfunc_t)(dns_zone_t *, dns_name_t *, dns_name_t *);
 368
 369 typedef isc_boolean_t
 370 (*dns_checknsfunc_t)(dns_zone_t *, dns_name_t *, dns_name_t *,
 371                      dns_rdataset_t *, dns_rdataset_t *);
 372
 373 typedef isc_boolean_t
 374 (*dns_isselffunc_t)(dns_view_t *, dns_tsigkey_t *, isc_sockaddr_t *,
 375                     isc_sockaddr_t *, dns_rdataclass_t, void *);
 376
 377 #endif /* DNS_TYPES_H */