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