Import bind 9.5.2 vendor sources.
[dragonfly.git] / contrib / bind-9.5.2 / lib / dns / include / dns / types.h
1 /*
2  * Copyright (C) 2004-2009  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.126.62.6 2009/01/29 22:41:45 jinmei 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_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 struct dns_iptable                      dns_iptable_t;
72 typedef isc_uint16_t                            dns_keyflags_t;
73 typedef struct dns_keynode                      dns_keynode_t;
74 typedef struct dns_keytable                     dns_keytable_t;
75 typedef isc_uint16_t                            dns_keytag_t;
76 typedef struct dns_loadctx                      dns_loadctx_t;
77 typedef struct dns_loadmgr                      dns_loadmgr_t;
78 typedef struct dns_message                      dns_message_t;
79 typedef isc_uint16_t                            dns_messageid_t;
80 typedef isc_region_t                            dns_label_t;
81 typedef struct dns_lookup                       dns_lookup_t;
82 typedef struct dns_name                         dns_name_t;
83 typedef ISC_LIST(dns_name_t)                    dns_namelist_t;
84 typedef isc_uint16_t                            dns_opcode_t;
85 typedef unsigned char                           dns_offsets_t[128];
86 typedef struct dns_order                        dns_order_t;
87 typedef struct dns_peer                         dns_peer_t;
88 typedef struct dns_peerlist                     dns_peerlist_t;
89 typedef struct dns_portlist                     dns_portlist_t;
90 typedef struct dns_rbt                          dns_rbt_t;
91 typedef isc_uint16_t                            dns_rcode_t;
92 typedef struct dns_rdata                        dns_rdata_t;
93 typedef struct dns_rdatacallbacks               dns_rdatacallbacks_t;
94 typedef isc_uint16_t                            dns_rdataclass_t;
95 typedef struct dns_rdatalist                    dns_rdatalist_t;
96 typedef struct dns_rdataset                     dns_rdataset_t;
97 typedef ISC_LIST(dns_rdataset_t)                dns_rdatasetlist_t;
98 typedef struct dns_rdatasetiter                 dns_rdatasetiter_t;
99 typedef isc_uint16_t                            dns_rdatatype_t;
100 typedef struct dns_request                      dns_request_t;
101 typedef struct dns_requestmgr                   dns_requestmgr_t;
102 typedef struct dns_resolver                     dns_resolver_t;
103 typedef struct dns_sdbimplementation            dns_sdbimplementation_t;
104 typedef isc_uint8_t                             dns_secalg_t;
105 typedef isc_uint8_t                             dns_secproto_t;
106 typedef struct dns_signature                    dns_signature_t;
107 typedef struct dns_ssurule                      dns_ssurule_t;
108 typedef struct dns_ssutable                     dns_ssutable_t;
109 typedef struct dns_stats                        dns_stats_t;
110 typedef isc_uint32_t                            dns_rdatastatstype_t;
111 typedef struct dns_tkeyctx                      dns_tkeyctx_t;
112 typedef isc_uint16_t                            dns_trust_t;
113 typedef struct dns_tsig_keyring                 dns_tsig_keyring_t;
114 typedef struct dns_tsigkey                      dns_tsigkey_t;
115 typedef isc_uint32_t                            dns_ttl_t;
116 typedef struct dns_validator                    dns_validator_t;
117 typedef struct dns_view                         dns_view_t;
118 typedef ISC_LIST(dns_view_t)                    dns_viewlist_t;
119 typedef struct dns_zone                         dns_zone_t;
120 typedef ISC_LIST(dns_zone_t)                    dns_zonelist_t;
121 typedef struct dns_zonemgr                      dns_zonemgr_t;
122 typedef struct dns_zt                           dns_zt_t;
123
124 /*
125  * If we are not using GSSAPI, define the types we use as opaque types here.
126  */
127 #ifndef GSSAPI
128 typedef struct not_defined_gss_cred_id *gss_cred_id_t;
129 typedef struct not_defined_gss_ctx *gss_ctx_id_t;
130 #endif
131 typedef struct dst_gssapi_signverifyctx dst_gssapi_signverifyctx_t;
132
133 typedef enum {
134         dns_fwdpolicy_none = 0,
135         dns_fwdpolicy_first = 1,
136         dns_fwdpolicy_only = 2
137 } dns_fwdpolicy_t;
138
139 typedef enum {
140         dns_namereln_none = 0,
141         dns_namereln_contains = 1,
142         dns_namereln_subdomain = 2,
143         dns_namereln_equal = 3,
144         dns_namereln_commonancestor = 4
145 } dns_namereln_t;
146
147 typedef enum {
148         dns_one_answer, dns_many_answers
149 } dns_transfer_format_t;
150
151 typedef enum {
152         dns_dbtype_zone = 0, dns_dbtype_cache = 1, dns_dbtype_stub = 3
153 } dns_dbtype_t;
154
155 typedef enum {
156         dns_notifytype_no = 0,
157         dns_notifytype_yes = 1,
158         dns_notifytype_explicit = 2,
159         dns_notifytype_masteronly = 3
160 } dns_notifytype_t;
161
162 typedef enum {
163         dns_dialuptype_no = 0,
164         dns_dialuptype_yes = 1,
165         dns_dialuptype_notify = 2,
166         dns_dialuptype_notifypassive = 3,
167         dns_dialuptype_refresh = 4,
168         dns_dialuptype_passive = 5
169 } dns_dialuptype_t;
170
171 typedef enum {
172         dns_masterformat_none = 0,
173         dns_masterformat_text = 1,
174         dns_masterformat_raw = 2
175 } dns_masterformat_t;
176
177 /*
178  * These are generated by gen.c.
179  */
180 #include <dns/enumtype.h>       /* Provides dns_rdatatype_t. */
181 #include <dns/enumclass.h>      /* Provides dns_rdataclass_t. */
182
183 /*%
184  * rcodes.
185  */
186 enum {
187         /*
188          * Standard rcodes.
189          */
190         dns_rcode_noerror = 0,
191 #define dns_rcode_noerror               ((dns_rcode_t)dns_rcode_noerror)
192         dns_rcode_formerr = 1,
193 #define dns_rcode_formerr               ((dns_rcode_t)dns_rcode_formerr)
194         dns_rcode_servfail = 2,
195 #define dns_rcode_servfail              ((dns_rcode_t)dns_rcode_servfail)
196         dns_rcode_nxdomain = 3,
197 #define dns_rcode_nxdomain              ((dns_rcode_t)dns_rcode_nxdomain)
198         dns_rcode_notimp = 4,
199 #define dns_rcode_notimp                ((dns_rcode_t)dns_rcode_notimp)
200         dns_rcode_refused = 5,
201 #define dns_rcode_refused               ((dns_rcode_t)dns_rcode_refused)
202         dns_rcode_yxdomain = 6,
203 #define dns_rcode_yxdomain              ((dns_rcode_t)dns_rcode_yxdomain)
204         dns_rcode_yxrrset = 7,
205 #define dns_rcode_yxrrset               ((dns_rcode_t)dns_rcode_yxrrset)
206         dns_rcode_nxrrset = 8,
207 #define dns_rcode_nxrrset               ((dns_rcode_t)dns_rcode_nxrrset)
208         dns_rcode_notauth = 9,
209 #define dns_rcode_notauth               ((dns_rcode_t)dns_rcode_notauth)
210         dns_rcode_notzone = 10,
211 #define dns_rcode_notzone               ((dns_rcode_t)dns_rcode_notzone)
212         /*
213          * Extended rcodes.
214          */
215         dns_rcode_badvers = 16
216 #define dns_rcode_badvers               ((dns_rcode_t)dns_rcode_badvers)
217 };
218
219 /*%
220  * TSIG errors.
221  */
222 enum {
223         dns_tsigerror_badsig = 16,
224         dns_tsigerror_badkey = 17,
225         dns_tsigerror_badtime = 18,
226         dns_tsigerror_badmode = 19,
227         dns_tsigerror_badname = 20,
228         dns_tsigerror_badalg = 21,
229         dns_tsigerror_badtrunc = 22
230 };
231
232 /*%
233  * Opcodes.
234  */
235 enum {
236         dns_opcode_query = 0,
237 #define dns_opcode_query                ((dns_opcode_t)dns_opcode_query)
238         dns_opcode_iquery = 1,
239 #define dns_opcode_iquery               ((dns_opcode_t)dns_opcode_iquery)
240         dns_opcode_status = 2,
241 #define dns_opcode_status               ((dns_opcode_t)dns_opcode_status)
242         dns_opcode_notify = 4,
243 #define dns_opcode_notify               ((dns_opcode_t)dns_opcode_notify)
244         dns_opcode_update = 5           /* dynamic update */
245 #define dns_opcode_update               ((dns_opcode_t)dns_opcode_update)
246 };
247
248 /*%
249  * Trust levels.  Must be kept in sync with trustnames[] in masterdump.c.
250  */
251 enum {
252         /* Sentinel value; no data should have this trust level. */
253         dns_trust_none = 0,
254 #define dns_trust_none                  ((dns_trust_t)dns_trust_none)
255
256         /*% Subject to DNSSEC validation but has not yet been validated */
257         dns_trust_pending = 1,
258 #define dns_trust_pending               ((dns_trust_t)dns_trust_pending)
259
260         /*% Received in the additional section of a response. */
261         dns_trust_additional = 2,
262 #define dns_trust_additional            ((dns_trust_t)dns_trust_additional)
263
264         /* Received in a referral response. */
265         dns_trust_glue = 3,
266 #define dns_trust_glue                  ((dns_trust_t)dns_trust_glue)
267
268         /* Answer from a non-authoritative server */
269         dns_trust_answer = 4,
270 #define dns_trust_answer                ((dns_trust_t)dns_trust_answer)
271
272         /*  Received in the authority section as part of an
273             authoritative response */
274         dns_trust_authauthority = 5,
275 #define dns_trust_authauthority         ((dns_trust_t)dns_trust_authauthority)
276
277         /* Answer from an authoritative server */
278         dns_trust_authanswer = 6,
279 #define dns_trust_authanswer            ((dns_trust_t)dns_trust_authanswer)
280
281         /* Successfully DNSSEC validated */
282         dns_trust_secure = 7,
283 #define dns_trust_secure                ((dns_trust_t)dns_trust_secure)
284
285         /* This server is authoritative */
286         dns_trust_ultimate = 8
287 #define dns_trust_ultimate              ((dns_trust_t)dns_trust_ultimate)
288 };
289
290 /*%
291  * Name checking severities.
292  */
293 typedef enum {
294         dns_severity_ignore,
295         dns_severity_warn,
296         dns_severity_fail
297 } dns_severity_t;
298
299 /*
300  * Functions.
301  */
302 typedef void
303 (*dns_dumpdonefunc_t)(void *, isc_result_t);
304
305 typedef void
306 (*dns_loaddonefunc_t)(void *, isc_result_t);
307
308 typedef isc_result_t
309 (*dns_addrdatasetfunc_t)(void *, dns_name_t *, dns_rdataset_t *);
310
311 typedef isc_result_t
312 (*dns_additionaldatafunc_t)(void *, dns_name_t *, dns_rdatatype_t);
313
314 typedef isc_result_t
315 (*dns_digestfunc_t)(void *, isc_region_t *);
316
317 typedef void
318 (*dns_xfrindone_t)(dns_zone_t *, isc_result_t);
319
320 typedef void
321 (*dns_updatecallback_t)(void *, isc_result_t, dns_message_t *);
322
323 typedef int
324 (*dns_rdatasetorderfunc_t)(const dns_rdata_t *, const void *);
325
326 typedef isc_boolean_t
327 (*dns_checkmxfunc_t)(dns_zone_t *, dns_name_t *, dns_name_t *);
328
329 typedef isc_boolean_t
330 (*dns_checksrvfunc_t)(dns_zone_t *, dns_name_t *, dns_name_t *);
331
332 typedef isc_boolean_t
333 (*dns_checknsfunc_t)(dns_zone_t *, dns_name_t *, dns_name_t *,
334                      dns_rdataset_t *, dns_rdataset_t *);
335
336 typedef isc_boolean_t
337 (*dns_isselffunc_t)(dns_view_t *, dns_tsigkey_t *, isc_sockaddr_t *,
338                     isc_sockaddr_t *, dns_rdataclass_t, void *);
339
340 #endif /* DNS_TYPES_H */