nameser.h revision 1.25 1 1.25 christos /* $NetBSD: nameser.h,v 1.25 2009/04/12 17:07:34 christos Exp $ */
2 1.25 christos
3 1.25 christos /*
4 1.25 christos * Portions Copyright (C) 2004, 2005, 2008, 2009 Internet Systems Consortium, Inc. ("ISC")
5 1.25 christos * Portions Copyright (C) 1996-2003 Internet Software Consortium.
6 1.25 christos *
7 1.25 christos * Permission to use, copy, modify, and/or distribute this software for any
8 1.25 christos * purpose with or without fee is hereby granted, provided that the above
9 1.25 christos * copyright notice and this permission notice appear in all copies.
10 1.25 christos *
11 1.25 christos * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12 1.25 christos * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13 1.25 christos * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14 1.25 christos * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 1.25 christos * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16 1.25 christos * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 1.25 christos * PERFORMANCE OF THIS SOFTWARE.
18 1.25 christos */
19 1.16 christos
20 1.1 cgd /*
21 1.8 mrg * Copyright (c) 1983, 1989, 1993
22 1.8 mrg * The Regents of the University of California. All rights reserved.
23 1.25 christos *
24 1.1 cgd * Redistribution and use in source and binary forms, with or without
25 1.1 cgd * modification, are permitted provided that the following conditions
26 1.1 cgd * are met:
27 1.1 cgd * 1. Redistributions of source code must retain the above copyright
28 1.1 cgd * notice, this list of conditions and the following disclaimer.
29 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
30 1.1 cgd * notice, this list of conditions and the following disclaimer in the
31 1.1 cgd * documentation and/or other materials provided with the distribution.
32 1.15 agc * 3. Neither the name of the University nor the names of its contributors
33 1.1 cgd * may be used to endorse or promote products derived from this software
34 1.1 cgd * without specific prior written permission.
35 1.25 christos *
36 1.1 cgd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
37 1.1 cgd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 1.1 cgd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
39 1.1 cgd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
40 1.1 cgd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
41 1.1 cgd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
42 1.1 cgd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 1.1 cgd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
44 1.1 cgd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
45 1.1 cgd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 1.1 cgd * SUCH DAMAGE.
47 1.16 christos */
48 1.16 christos
49 1.16 christos /*
50 1.25 christos * Id: nameser.h,v 1.16 2009/03/03 01:52:48 each Exp
51 1.1 cgd */
52 1.1 cgd
53 1.11 perry #ifndef _ARPA_NAMESER_H_
54 1.11 perry #define _ARPA_NAMESER_H_
55 1.1 cgd
56 1.16 christos #define BIND_4_COMPAT
57 1.16 christos
58 1.8 mrg #include <sys/param.h>
59 1.8 mrg #if (!defined(BSD)) || (BSD < 199306)
60 1.8 mrg # include <sys/bitypes.h>
61 1.8 mrg #else
62 1.8 mrg # include <sys/types.h>
63 1.8 mrg #endif
64 1.5 deraadt #include <sys/cdefs.h>
65 1.4 mycroft
66 1.20 christos /*%
67 1.16 christos * Revision information. This is the release date in YYYYMMDD format.
68 1.16 christos * It can change every day so the right thing to do with it is use it
69 1.16 christos * in preprocessor commands such as "#if (__NAMESER > 19931104)". Do not
70 1.16 christos * compare for equality; rather, use it to determine whether your libbind.a
71 1.16 christos * contains a new enough lib/nameser/ to support the feature you need.
72 1.16 christos */
73 1.16 christos
74 1.25 christos #define __NAMESER 20090302 /*%< New interface version stamp. */
75 1.16 christos /*
76 1.20 christos * Define constants based on RFC0883, RFC1034, RFC 1035
77 1.16 christos */
78 1.20 christos #define NS_PACKETSZ 512 /*%< default UDP packet size */
79 1.25 christos #define NS_MAXDNAME 1025 /*%< maximum domain name (presentation format)*/
80 1.20 christos #define NS_MAXMSG 65535 /*%< maximum message size */
81 1.20 christos #define NS_MAXCDNAME 255 /*%< maximum compressed domain name */
82 1.20 christos #define NS_MAXLABEL 63 /*%< maximum length of domain label */
83 1.25 christos #define NS_MAXLABELS 128 /*%< theoretical max #/labels per domain name */
84 1.25 christos #define NS_MAXNNAME 256 /*%< maximum uncompressed (binary) domain name*/
85 1.25 christos #define NS_MAXPADDR (sizeof "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")
86 1.20 christos #define NS_HFIXEDSZ 12 /*%< #/bytes of fixed data in header */
87 1.20 christos #define NS_QFIXEDSZ 4 /*%< #/bytes of fixed data in query */
88 1.20 christos #define NS_RRFIXEDSZ 10 /*%< #/bytes of fixed data in r record */
89 1.25 christos #define NS_INT32SZ 4 /*%< #/bytes of data in a uint32_t */
90 1.25 christos #define NS_INT16SZ 2 /*%< #/bytes of data in a uint16_t */
91 1.20 christos #define NS_INT8SZ 1 /*%< #/bytes of data in a u_int8_t */
92 1.20 christos #define NS_INADDRSZ 4 /*%< IPv4 T_A */
93 1.20 christos #define NS_IN6ADDRSZ 16 /*%< IPv6 T_AAAA */
94 1.20 christos #define NS_CMPRSFLGS 0xc0 /*%< Flag bits indicating name compression. */
95 1.20 christos #define NS_DEFAULTPORT 53 /*%< For both TCP and UDP. */
96 1.16 christos
97 1.16 christos /*
98 1.16 christos * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
99 1.16 christos * in synch with it.
100 1.16 christos */
101 1.16 christos typedef enum __ns_sect {
102 1.21 christos ns_s_qd = 0, /*%< Query: Question. */
103 1.21 christos ns_s_zn = 0, /*%< Update: Zone. */
104 1.21 christos ns_s_an = 1, /*%< Query: Answer. */
105 1.21 christos ns_s_pr = 1, /*%< Update: Prerequisites. */
106 1.21 christos ns_s_ns = 2, /*%< Query: Name servers. */
107 1.21 christos ns_s_ud = 2, /*%< Update: Update. */
108 1.21 christos ns_s_ar = 3, /*%< Query|Update: Additional records. */
109 1.16 christos ns_s_max = 4
110 1.16 christos } ns_sect;
111 1.16 christos
112 1.20 christos /*%
113 1.25 christos * Network name (compressed or not) type. Equivilent to a pointer when used
114 1.25 christos * in a function prototype. Can be const'd.
115 1.25 christos */
116 1.25 christos typedef u_char ns_nname[NS_MAXNNAME];
117 1.25 christos typedef const u_char *ns_nname_ct;
118 1.25 christos typedef u_char *ns_nname_t;
119 1.25 christos
120 1.25 christos struct ns_namemap { ns_nname_ct base; int len; };
121 1.25 christos typedef struct ns_namemap *ns_namemap_t;
122 1.25 christos typedef const struct ns_namemap *ns_namemap_ct;
123 1.25 christos
124 1.25 christos /*%
125 1.16 christos * This is a message handle. It is caller allocated and has no dynamic data.
126 1.16 christos * This structure is intended to be opaque to all but ns_parse.c, thus the
127 1.16 christos * leading _'s on the member names. Use the accessor functions, not the _'s.
128 1.16 christos */
129 1.16 christos typedef struct __ns_msg {
130 1.16 christos const u_char *_msg, *_eom;
131 1.19 perry uint16_t _id, _flags, _counts[ns_s_max];
132 1.16 christos const u_char *_sections[ns_s_max];
133 1.16 christos ns_sect _sect;
134 1.16 christos int _rrnum;
135 1.16 christos const u_char *_msg_ptr;
136 1.16 christos } ns_msg;
137 1.16 christos
138 1.25 christos /*
139 1.25 christos * This is a newmsg handle, used when constructing new messages with
140 1.25 christos * ns_newmsg_init, et al.
141 1.25 christos */
142 1.25 christos struct ns_newmsg {
143 1.25 christos ns_msg msg;
144 1.25 christos const u_char *dnptrs[25];
145 1.25 christos const u_char **lastdnptr;
146 1.25 christos };
147 1.25 christos typedef struct ns_newmsg ns_newmsg;
148 1.25 christos
149 1.16 christos /* Private data structure - do not use from outside library. */
150 1.16 christos struct _ns_flagdata { int mask, shift; };
151 1.16 christos extern struct _ns_flagdata _ns_flagdata[];
152 1.16 christos
153 1.16 christos /* Accessor macros - this is part of the public interface. */
154 1.16 christos
155 1.16 christos #define ns_msg_id(handle) ((handle)._id + 0)
156 1.16 christos #define ns_msg_base(handle) ((handle)._msg + 0)
157 1.16 christos #define ns_msg_end(handle) ((handle)._eom + 0)
158 1.16 christos #define ns_msg_size(handle) ((size_t)((handle)._eom - (handle)._msg))
159 1.16 christos #define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
160 1.16 christos
161 1.20 christos /*%
162 1.16 christos * This is a parsed record. It is caller allocated and has no dynamic data.
163 1.16 christos */
164 1.16 christos typedef struct __ns_rr {
165 1.16 christos char name[NS_MAXDNAME];
166 1.19 perry uint16_t type;
167 1.19 perry uint16_t rr_class;
168 1.19 perry uint32_t ttl;
169 1.19 perry uint16_t rdlength;
170 1.16 christos const u_char * rdata;
171 1.16 christos } ns_rr;
172 1.16 christos
173 1.25 christos /*
174 1.25 christos * Same thing, but using uncompressed network binary names, and real C types.
175 1.25 christos */
176 1.25 christos typedef struct __ns_rr2 {
177 1.25 christos ns_nname nname;
178 1.25 christos size_t nnamel;
179 1.25 christos int type;
180 1.25 christos int rr_class;
181 1.25 christos u_int ttl;
182 1.25 christos int rdlength;
183 1.25 christos const u_char * rdata;
184 1.25 christos } ns_rr2;
185 1.25 christos
186 1.16 christos /* Accessor macros - this is part of the public interface. */
187 1.16 christos #define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
188 1.25 christos #define ns_rr_nname(rr) ((const ns_nname_t)(rr).nname)
189 1.25 christos #define ns_rr_nnamel(rr) ((rr).nnamel + 0)
190 1.16 christos #define ns_rr_type(rr) ((ns_type)((rr).type + 0))
191 1.16 christos #define ns_rr_class(rr) ((ns_class)((rr).rr_class + 0))
192 1.16 christos #define ns_rr_ttl(rr) ((u_long)(rr).ttl + 0)
193 1.16 christos #define ns_rr_rdlen(rr) ((size_t)(rr).rdlength + 0)
194 1.16 christos #define ns_rr_rdata(rr) ((rr).rdata + 0)
195 1.16 christos
196 1.20 christos /*%
197 1.16 christos * These don't have to be in the same order as in the packet flags word,
198 1.16 christos * and they can even overlap in some cases, but they will need to be kept
199 1.16 christos * in synch with ns_parse.c:ns_flagdata[].
200 1.16 christos */
201 1.16 christos typedef enum __ns_flag {
202 1.20 christos ns_f_qr, /*%< Question/Response. */
203 1.20 christos ns_f_opcode, /*%< Operation code. */
204 1.20 christos ns_f_aa, /*%< Authoritative Answer. */
205 1.20 christos ns_f_tc, /*%< Truncation occurred. */
206 1.20 christos ns_f_rd, /*%< Recursion Desired. */
207 1.20 christos ns_f_ra, /*%< Recursion Available. */
208 1.20 christos ns_f_z, /*%< MBZ. */
209 1.20 christos ns_f_ad, /*%< Authentic Data (DNSSEC). */
210 1.20 christos ns_f_cd, /*%< Checking Disabled (DNSSEC). */
211 1.20 christos ns_f_rcode, /*%< Response code. */
212 1.16 christos ns_f_max
213 1.16 christos } ns_flag;
214 1.16 christos
215 1.20 christos /*%
216 1.16 christos * Currently defined opcodes.
217 1.16 christos */
218 1.16 christos typedef enum __ns_opcode {
219 1.20 christos ns_o_query = 0, /*%< Standard query. */
220 1.20 christos ns_o_iquery = 1, /*%< Inverse query (deprecated/unsupported). */
221 1.20 christos ns_o_status = 2, /*%< Name server status query (unsupported). */
222 1.16 christos /* Opcode 3 is undefined/reserved. */
223 1.20 christos ns_o_notify = 4, /*%< Zone change notification. */
224 1.20 christos ns_o_update = 5, /*%< Zone update message. */
225 1.16 christos ns_o_max = 6
226 1.16 christos } ns_opcode;
227 1.16 christos
228 1.20 christos /*%
229 1.16 christos * Currently defined response codes.
230 1.16 christos */
231 1.16 christos typedef enum __ns_rcode {
232 1.20 christos ns_r_noerror = 0, /*%< No error occurred. */
233 1.20 christos ns_r_formerr = 1, /*%< Format error. */
234 1.20 christos ns_r_servfail = 2, /*%< Server failure. */
235 1.20 christos ns_r_nxdomain = 3, /*%< Name error. */
236 1.20 christos ns_r_notimpl = 4, /*%< Unimplemented. */
237 1.20 christos ns_r_refused = 5, /*%< Operation refused. */
238 1.16 christos /* these are for BIND_UPDATE */
239 1.20 christos ns_r_yxdomain = 6, /*%< Name exists */
240 1.20 christos ns_r_yxrrset = 7, /*%< RRset exists */
241 1.20 christos ns_r_nxrrset = 8, /*%< RRset does not exist */
242 1.20 christos ns_r_notauth = 9, /*%< Not authoritative for zone */
243 1.20 christos ns_r_notzone = 10, /*%< Zone of record different from zone section */
244 1.16 christos ns_r_max = 11,
245 1.16 christos /* The following are EDNS extended rcodes */
246 1.16 christos ns_r_badvers = 16,
247 1.16 christos /* The following are TSIG errors */
248 1.16 christos ns_r_badsig = 16,
249 1.16 christos ns_r_badkey = 17,
250 1.16 christos ns_r_badtime = 18
251 1.16 christos } ns_rcode;
252 1.16 christos
253 1.16 christos /* BIND_UPDATE */
254 1.16 christos typedef enum __ns_update_operation {
255 1.16 christos ns_uop_delete = 0,
256 1.16 christos ns_uop_add = 1,
257 1.16 christos ns_uop_max = 2
258 1.16 christos } ns_update_operation;
259 1.16 christos
260 1.20 christos /*%
261 1.16 christos * This structure is used for TSIG authenticated messages
262 1.16 christos */
263 1.16 christos struct ns_tsig_key {
264 1.25 christos char name[NS_MAXDNAME], alg[NS_MAXDNAME];
265 1.25 christos unsigned char *data;
266 1.25 christos int len;
267 1.16 christos };
268 1.16 christos typedef struct ns_tsig_key ns_tsig_key;
269 1.16 christos
270 1.20 christos /*%
271 1.16 christos * This structure is used for TSIG authenticated TCP messages
272 1.16 christos */
273 1.16 christos struct ns_tcp_tsig_state {
274 1.16 christos int counter;
275 1.16 christos struct dst_key *key;
276 1.16 christos void *ctx;
277 1.16 christos unsigned char sig[NS_PACKETSZ];
278 1.16 christos int siglen;
279 1.16 christos };
280 1.16 christos typedef struct ns_tcp_tsig_state ns_tcp_tsig_state;
281 1.16 christos
282 1.16 christos #define NS_TSIG_FUDGE 300
283 1.16 christos #define NS_TSIG_TCP_COUNT 100
284 1.16 christos #define NS_TSIG_ALG_HMAC_MD5 "HMAC-MD5.SIG-ALG.REG.INT"
285 1.16 christos
286 1.16 christos #define NS_TSIG_ERROR_NO_TSIG -10
287 1.16 christos #define NS_TSIG_ERROR_NO_SPACE -11
288 1.16 christos #define NS_TSIG_ERROR_FORMERR -12
289 1.16 christos
290 1.20 christos /*%
291 1.16 christos * Currently defined type values for resources and queries.
292 1.16 christos */
293 1.16 christos typedef enum __ns_type {
294 1.20 christos ns_t_invalid = 0, /*%< Cookie. */
295 1.20 christos ns_t_a = 1, /*%< Host address. */
296 1.20 christos ns_t_ns = 2, /*%< Authoritative server. */
297 1.20 christos ns_t_md = 3, /*%< Mail destination. */
298 1.20 christos ns_t_mf = 4, /*%< Mail forwarder. */
299 1.20 christos ns_t_cname = 5, /*%< Canonical name. */
300 1.20 christos ns_t_soa = 6, /*%< Start of authority zone. */
301 1.20 christos ns_t_mb = 7, /*%< Mailbox domain name. */
302 1.20 christos ns_t_mg = 8, /*%< Mail group member. */
303 1.20 christos ns_t_mr = 9, /*%< Mail rename name. */
304 1.20 christos ns_t_null = 10, /*%< Null resource record. */
305 1.20 christos ns_t_wks = 11, /*%< Well known service. */
306 1.20 christos ns_t_ptr = 12, /*%< Domain name pointer. */
307 1.20 christos ns_t_hinfo = 13, /*%< Host information. */
308 1.20 christos ns_t_minfo = 14, /*%< Mailbox information. */
309 1.20 christos ns_t_mx = 15, /*%< Mail routing information. */
310 1.20 christos ns_t_txt = 16, /*%< Text strings. */
311 1.20 christos ns_t_rp = 17, /*%< Responsible person. */
312 1.20 christos ns_t_afsdb = 18, /*%< AFS cell database. */
313 1.20 christos ns_t_x25 = 19, /*%< X_25 calling address. */
314 1.20 christos ns_t_isdn = 20, /*%< ISDN calling address. */
315 1.20 christos ns_t_rt = 21, /*%< Router. */
316 1.20 christos ns_t_nsap = 22, /*%< NSAP address. */
317 1.20 christos ns_t_nsap_ptr = 23, /*%< Reverse NSAP lookup (deprecated). */
318 1.20 christos ns_t_sig = 24, /*%< Security signature. */
319 1.20 christos ns_t_key = 25, /*%< Security key. */
320 1.20 christos ns_t_px = 26, /*%< X.400 mail mapping. */
321 1.20 christos ns_t_gpos = 27, /*%< Geographical position (withdrawn). */
322 1.25 christos ns_t_aaaa = 28, /*%< IPv6 Address. */
323 1.20 christos ns_t_loc = 29, /*%< Location Information. */
324 1.20 christos ns_t_nxt = 30, /*%< Next domain (security). */
325 1.20 christos ns_t_eid = 31, /*%< Endpoint identifier. */
326 1.20 christos ns_t_nimloc = 32, /*%< Nimrod Locator. */
327 1.20 christos ns_t_srv = 33, /*%< Server Selection. */
328 1.20 christos ns_t_atma = 34, /*%< ATM Address */
329 1.20 christos ns_t_naptr = 35, /*%< Naming Authority PoinTeR */
330 1.20 christos ns_t_kx = 36, /*%< Key Exchange */
331 1.20 christos ns_t_cert = 37, /*%< Certification record */
332 1.25 christos ns_t_a6 = 38, /*%< IPv6 address (experimental) */
333 1.25 christos ns_t_dname = 39, /*%< Non-terminal DNAME */
334 1.20 christos ns_t_sink = 40, /*%< Kitchen sink (experimentatl) */
335 1.20 christos ns_t_opt = 41, /*%< EDNS0 option (meta-RR) */
336 1.20 christos ns_t_apl = 42, /*%< Address prefix list (RFC3123) */
337 1.25 christos ns_t_ds = 43, /*%< Delegation Signer */
338 1.25 christos ns_t_sshfp = 44, /*%< SSH Fingerprint */
339 1.25 christos ns_t_ipseckey = 45, /*%< IPSEC Key */
340 1.25 christos ns_t_rrsig = 46, /*%< RRset Signature */
341 1.25 christos ns_t_nsec = 47, /*%< Negative security */
342 1.25 christos ns_t_dnskey = 48, /*%< DNS Key */
343 1.25 christos ns_t_dhcid = 49, /*%< Dynamic host configuratin identifier */
344 1.25 christos ns_t_nsec3 = 50, /*%< Negative security type 3 */
345 1.25 christos ns_t_nsec3param = 51, /*%< Negative security type 3 parameters */
346 1.25 christos ns_t_hip = 55, /*%< Host Identity Protocol */
347 1.25 christos ns_t_spf = 99, /*%< Sender Policy Framework */
348 1.20 christos ns_t_tkey = 249, /*%< Transaction key */
349 1.20 christos ns_t_tsig = 250, /*%< Transaction signature. */
350 1.20 christos ns_t_ixfr = 251, /*%< Incremental zone transfer. */
351 1.20 christos ns_t_axfr = 252, /*%< Transfer zone of authority. */
352 1.20 christos ns_t_mailb = 253, /*%< Transfer mailbox records. */
353 1.20 christos ns_t_maila = 254, /*%< Transfer mail agent records. */
354 1.20 christos ns_t_any = 255, /*%< Wildcard match. */
355 1.20 christos ns_t_zxfr = 256, /*%< BIND-specific, nonstandard. */
356 1.25 christos ns_t_dlv = 32769, /*%< DNSSEC look-aside validatation. */
357 1.16 christos ns_t_max = 65536
358 1.16 christos } ns_type;
359 1.16 christos
360 1.16 christos /* Exclusively a QTYPE? (not also an RTYPE) */
361 1.16 christos #define ns_t_qt_p(t) (ns_t_xfr_p(t) || (t) == ns_t_any || \
362 1.16 christos (t) == ns_t_mailb || (t) == ns_t_maila)
363 1.16 christos /* Some kind of meta-RR? (not a QTYPE, but also not an RTYPE) */
364 1.16 christos #define ns_t_mrr_p(t) ((t) == ns_t_tsig || (t) == ns_t_opt)
365 1.16 christos /* Exclusively an RTYPE? (not also a QTYPE or a meta-RR) */
366 1.16 christos #define ns_t_rr_p(t) (!ns_t_qt_p(t) && !ns_t_mrr_p(t))
367 1.16 christos #define ns_t_udp_p(t) ((t) != ns_t_axfr && (t) != ns_t_zxfr)
368 1.16 christos #define ns_t_xfr_p(t) ((t) == ns_t_axfr || (t) == ns_t_ixfr || \
369 1.16 christos (t) == ns_t_zxfr)
370 1.1 cgd
371 1.20 christos /*%
372 1.1 cgd * Values for class field
373 1.1 cgd */
374 1.16 christos typedef enum __ns_class {
375 1.20 christos ns_c_invalid = 0, /*%< Cookie. */
376 1.20 christos ns_c_in = 1, /*%< Internet. */
377 1.20 christos ns_c_2 = 2, /*%< unallocated/unsupported. */
378 1.20 christos ns_c_chaos = 3, /*%< MIT Chaos-net. */
379 1.20 christos ns_c_hs = 4, /*%< MIT Hesiod. */
380 1.1 cgd /* Query class values which do not appear in resource records */
381 1.20 christos ns_c_none = 254, /*%< for prereq. sections in update requests */
382 1.20 christos ns_c_any = 255, /*%< Wildcard match. */
383 1.16 christos ns_c_max = 65536
384 1.16 christos } ns_class;
385 1.16 christos
386 1.16 christos /* DNSSEC constants. */
387 1.16 christos
388 1.16 christos typedef enum __ns_key_types {
389 1.20 christos ns_kt_rsa = 1, /*%< key type RSA/MD5 */
390 1.20 christos ns_kt_dh = 2, /*%< Diffie Hellman */
391 1.20 christos ns_kt_dsa = 3, /*%< Digital Signature Standard (MANDATORY) */
392 1.20 christos ns_kt_private = 254 /*%< Private key type starts with OID */
393 1.16 christos } ns_key_types;
394 1.16 christos
395 1.16 christos typedef enum __ns_cert_types {
396 1.20 christos cert_t_pkix = 1, /*%< PKIX (X.509v3) */
397 1.20 christos cert_t_spki = 2, /*%< SPKI */
398 1.20 christos cert_t_pgp = 3, /*%< PGP */
399 1.20 christos cert_t_url = 253, /*%< URL private type */
400 1.20 christos cert_t_oid = 254 /*%< OID private type */
401 1.16 christos } ns_cert_types;
402 1.16 christos
403 1.16 christos /* Flags field of the KEY RR rdata. */
404 1.20 christos #define NS_KEY_TYPEMASK 0xC000 /*%< Mask for "type" bits */
405 1.20 christos #define NS_KEY_TYPE_AUTH_CONF 0x0000 /*%< Key usable for both */
406 1.20 christos #define NS_KEY_TYPE_CONF_ONLY 0x8000 /*%< Key usable for confidentiality */
407 1.20 christos #define NS_KEY_TYPE_AUTH_ONLY 0x4000 /*%< Key usable for authentication */
408 1.20 christos #define NS_KEY_TYPE_NO_KEY 0xC000 /*%< No key usable for either; no key */
409 1.9 mrg /* The type bits can also be interpreted independently, as single bits: */
410 1.20 christos #define NS_KEY_NO_AUTH 0x8000 /*%< Key unusable for authentication */
411 1.20 christos #define NS_KEY_NO_CONF 0x4000 /*%< Key unusable for confidentiality */
412 1.16 christos #define NS_KEY_RESERVED2 0x2000 /* Security is *mandatory* if bit=0 */
413 1.20 christos #define NS_KEY_EXTENDED_FLAGS 0x1000 /*%< reserved - must be zero */
414 1.20 christos #define NS_KEY_RESERVED4 0x0800 /*%< reserved - must be zero */
415 1.20 christos #define NS_KEY_RESERVED5 0x0400 /*%< reserved - must be zero */
416 1.20 christos #define NS_KEY_NAME_TYPE 0x0300 /*%< these bits determine the type */
417 1.20 christos #define NS_KEY_NAME_USER 0x0000 /*%< key is assoc. with user */
418 1.20 christos #define NS_KEY_NAME_ENTITY 0x0200 /*%< key is assoc. with entity eg host */
419 1.20 christos #define NS_KEY_NAME_ZONE 0x0100 /*%< key is zone key */
420 1.20 christos #define NS_KEY_NAME_RESERVED 0x0300 /*%< reserved meaning */
421 1.20 christos #define NS_KEY_RESERVED8 0x0080 /*%< reserved - must be zero */
422 1.20 christos #define NS_KEY_RESERVED9 0x0040 /*%< reserved - must be zero */
423 1.20 christos #define NS_KEY_RESERVED10 0x0020 /*%< reserved - must be zero */
424 1.20 christos #define NS_KEY_RESERVED11 0x0010 /*%< reserved - must be zero */
425 1.20 christos #define NS_KEY_SIGNATORYMASK 0x000F /*%< key can sign RR's of same name */
426 1.16 christos #define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED2 | \
427 1.16 christos NS_KEY_RESERVED4 | \
428 1.16 christos NS_KEY_RESERVED5 | \
429 1.16 christos NS_KEY_RESERVED8 | \
430 1.16 christos NS_KEY_RESERVED9 | \
431 1.16 christos NS_KEY_RESERVED10 | \
432 1.16 christos NS_KEY_RESERVED11 )
433 1.20 christos #define NS_KEY_RESERVED_BITMASK2 0xFFFF /*%< no bits defined here */
434 1.9 mrg
435 1.9 mrg /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
436 1.20 christos #define NS_ALG_MD5RSA 1 /*%< MD5 with RSA */
437 1.20 christos #define NS_ALG_DH 2 /*%< Diffie Hellman KEY */
438 1.20 christos #define NS_ALG_DSA 3 /*%< DSA KEY */
439 1.16 christos #define NS_ALG_DSS NS_ALG_DSA
440 1.20 christos #define NS_ALG_EXPIRE_ONLY 253 /*%< No alg, no security */
441 1.20 christos #define NS_ALG_PRIVATE_OID 254 /*%< Key begins with OID giving alg */
442 1.16 christos
443 1.16 christos /* Protocol values */
444 1.16 christos /* value 0 is reserved */
445 1.16 christos #define NS_KEY_PROT_TLS 1
446 1.16 christos #define NS_KEY_PROT_EMAIL 2
447 1.16 christos #define NS_KEY_PROT_DNSSEC 3
448 1.16 christos #define NS_KEY_PROT_IPSEC 4
449 1.16 christos #define NS_KEY_PROT_ANY 255
450 1.9 mrg
451 1.9 mrg /* Signatures */
452 1.20 christos #define NS_MD5RSA_MIN_BITS 512 /*%< Size of a mod or exp in bits */
453 1.16 christos #define NS_MD5RSA_MAX_BITS 4096
454 1.16 christos /* Total of binary mod and exp */
455 1.16 christos #define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
456 1.16 christos /* Max length of text sig block */
457 1.16 christos #define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
458 1.16 christos #define NS_MD5RSA_MIN_SIZE ((NS_MD5RSA_MIN_BITS+7)/8)
459 1.16 christos #define NS_MD5RSA_MAX_SIZE ((NS_MD5RSA_MAX_BITS+7)/8)
460 1.16 christos
461 1.16 christos #define NS_DSA_SIG_SIZE 41
462 1.16 christos #define NS_DSA_MIN_SIZE 213
463 1.16 christos #define NS_DSA_MAX_BYTES 405
464 1.16 christos
465 1.16 christos /* Offsets into SIG record rdata to find various values */
466 1.20 christos #define NS_SIG_TYPE 0 /*%< Type flags */
467 1.20 christos #define NS_SIG_ALG 2 /*%< Algorithm */
468 1.20 christos #define NS_SIG_LABELS 3 /*%< How many labels in name */
469 1.20 christos #define NS_SIG_OTTL 4 /*%< Original TTL */
470 1.20 christos #define NS_SIG_EXPIR 8 /*%< Expiration time */
471 1.20 christos #define NS_SIG_SIGNED 12 /*%< Signature time */
472 1.20 christos #define NS_SIG_FOOT 16 /*%< Key footprint */
473 1.20 christos #define NS_SIG_SIGNER 18 /*%< Domain name of who signed it */
474 1.16 christos
475 1.16 christos /* How RR types are represented as bit-flags in NXT records */
476 1.16 christos #define NS_NXT_BITS 8
477 1.16 christos #define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS)))
478 1.16 christos #define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
479 1.16 christos #define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS)))
480 1.16 christos #define NS_NXT_MAX 127
481 1.1 cgd
482 1.20 christos /*%
483 1.23 christos * EDNS0 extended flags and option codes, host order.
484 1.1 cgd */
485 1.16 christos #define NS_OPT_DNSSEC_OK 0x8000U
486 1.23 christos #define NS_OPT_NSID 3
487 1.1 cgd
488 1.20 christos /*%
489 1.8 mrg * Inline versions of get/put short/long. Pointer is advanced.
490 1.1 cgd */
491 1.16 christos #define NS_GET16(s, cp) do { \
492 1.18 perry const u_char *t_cp = (const u_char *)(cp); \
493 1.19 perry (s) = ((uint16_t)t_cp[0] << 8) \
494 1.19 perry | ((uint16_t)t_cp[1]) \
495 1.8 mrg ; \
496 1.16 christos (cp) += NS_INT16SZ; \
497 1.16 christos } while (/*CONSTCOND*/0)
498 1.1 cgd
499 1.16 christos #define NS_GET32(l, cp) do { \
500 1.18 perry const u_char *t_cp = (const u_char *)(cp); \
501 1.19 perry (l) = ((uint32_t)t_cp[0] << 24) \
502 1.19 perry | ((uint32_t)t_cp[1] << 16) \
503 1.19 perry | ((uint32_t)t_cp[2] << 8) \
504 1.19 perry | ((uint32_t)t_cp[3]) \
505 1.8 mrg ; \
506 1.16 christos (cp) += NS_INT32SZ; \
507 1.16 christos } while (/*CONSTCOND*/0)
508 1.1 cgd
509 1.16 christos #define NS_PUT16(s, cp) do { \
510 1.19 perry uint32_t t_s = (uint32_t)(s); \
511 1.18 perry u_char *t_cp = (u_char *)(cp); \
512 1.16 christos *t_cp++ = t_s >> 8; \
513 1.5 deraadt *t_cp = t_s; \
514 1.16 christos (cp) += NS_INT16SZ; \
515 1.16 christos } while (/*CONSTCOND*/0)
516 1.1 cgd
517 1.16 christos #define NS_PUT32(l, cp) do { \
518 1.19 perry uint32_t t_l = (uint32_t)(l); \
519 1.18 perry u_char *t_cp = (u_char *)(cp); \
520 1.5 deraadt *t_cp++ = t_l >> 24; \
521 1.5 deraadt *t_cp++ = t_l >> 16; \
522 1.5 deraadt *t_cp++ = t_l >> 8; \
523 1.5 deraadt *t_cp = t_l; \
524 1.16 christos (cp) += NS_INT32SZ; \
525 1.16 christos } while (/*CONSTCOND*/0)
526 1.16 christos
527 1.20 christos /*%
528 1.16 christos * ANSI C identifier hiding for bind's lib/nameser.
529 1.16 christos */
530 1.16 christos #define ns_msg_getflag __ns_msg_getflag
531 1.16 christos #define ns_get16 __ns_get16
532 1.16 christos #define ns_get32 __ns_get32
533 1.16 christos #define ns_put16 __ns_put16
534 1.16 christos #define ns_put32 __ns_put32
535 1.16 christos #define ns_initparse __ns_initparse
536 1.16 christos #define ns_skiprr __ns_skiprr
537 1.16 christos #define ns_parserr __ns_parserr
538 1.25 christos #define ns_parserr2 __ns_parserr2
539 1.16 christos #define ns_sprintrr __ns_sprintrr
540 1.16 christos #define ns_sprintrrf __ns_sprintrrf
541 1.16 christos #define ns_format_ttl __ns_format_ttl
542 1.16 christos #define ns_parse_ttl __ns_parse_ttl
543 1.16 christos #define ns_datetosecs __ns_datetosecs
544 1.16 christos #define ns_name_ntol __ns_name_ntol
545 1.16 christos #define ns_name_ntop __ns_name_ntop
546 1.16 christos #define ns_name_pton __ns_name_pton
547 1.25 christos #define ns_name_pton2 __ns_name_pton2
548 1.16 christos #define ns_name_unpack __ns_name_unpack
549 1.25 christos #define ns_name_unpack2 __ns_name_unpack2
550 1.16 christos #define ns_name_pack __ns_name_pack
551 1.16 christos #define ns_name_compress __ns_name_compress
552 1.16 christos #define ns_name_uncompress __ns_name_uncompress
553 1.16 christos #define ns_name_skip __ns_name_skip
554 1.16 christos #define ns_name_rollback __ns_name_rollback
555 1.25 christos #define ns_name_length __ns_name_length
556 1.25 christos #define ns_name_eq __ns_name_eq
557 1.25 christos #define ns_name_owned __ns_name_owned
558 1.25 christos #define ns_name_map __ns_name_map
559 1.25 christos #define ns_name_labels __ns_name_labels
560 1.16 christos #define ns_sign __ns_sign
561 1.16 christos #define ns_sign2 __ns_sign2
562 1.16 christos #define ns_sign_tcp __ns_sign_tcp
563 1.16 christos #define ns_sign_tcp2 __ns_sign_tcp2
564 1.16 christos #define ns_sign_tcp_init __ns_sign_tcp_init
565 1.16 christos #define ns_find_tsig __ns_find_tsig
566 1.16 christos #define ns_verify __ns_verify
567 1.16 christos #define ns_verify_tcp __ns_verify_tcp
568 1.16 christos #define ns_verify_tcp_init __ns_verify_tcp_init
569 1.16 christos #define ns_samedomain __ns_samedomain
570 1.16 christos #define ns_subdomain __ns_subdomain
571 1.16 christos #define ns_makecanon __ns_makecanon
572 1.16 christos #define ns_samename __ns_samename
573 1.25 christos #define ns_newmsg_init __ns_newmsg_init
574 1.25 christos #define ns_newmsg_copy __ns_newmsg_copy
575 1.25 christos #define ns_newmsg_id __ns_newmsg_id
576 1.25 christos #define ns_newmsg_flag __ns_newmsg_flag
577 1.25 christos #define ns_newmsg_q __ns_newmsg_q
578 1.25 christos #define ns_newmsg_rr __ns_newmsg_rr
579 1.25 christos #define ns_newmsg_done __ns_newmsg_done
580 1.25 christos #define ns_rdata_unpack __ns_rdata_unpack
581 1.25 christos #define ns_rdata_equal __ns_rdata_equal
582 1.25 christos #define ns_rdata_refers __ns_rdata_refers
583 1.16 christos
584 1.16 christos __BEGIN_DECLS
585 1.17 perry int ns_msg_getflag(ns_msg, int);
586 1.19 perry uint16_t ns_get16(const u_char *);
587 1.19 perry uint32_t ns_get32(const u_char *);
588 1.19 perry void ns_put16(uint16_t, u_char *);
589 1.19 perry void ns_put32(uint32_t, u_char *);
590 1.17 perry int ns_initparse(const u_char *, int, ns_msg *);
591 1.17 perry int ns_skiprr(const u_char *, const u_char *, ns_sect, int);
592 1.17 perry int ns_parserr(ns_msg *, ns_sect, int, ns_rr *);
593 1.25 christos int ns_parserr2(ns_msg *, ns_sect, int, ns_rr2 *);
594 1.17 perry int ns_sprintrr(const ns_msg *, const ns_rr *,
595 1.17 perry const char *, const char *, char *, size_t);
596 1.17 perry int ns_sprintrrf(const u_char *, size_t, const char *,
597 1.16 christos ns_class, ns_type, u_long, const u_char *,
598 1.16 christos size_t, const char *, const char *,
599 1.17 perry char *, size_t);
600 1.17 perry int ns_format_ttl(u_long, char *, size_t);
601 1.17 perry int ns_parse_ttl(const char *, u_long *);
602 1.19 perry uint32_t ns_datetosecs(const char *cp, int *errp);
603 1.17 perry int ns_name_ntol(const u_char *, u_char *, size_t);
604 1.17 perry int ns_name_ntop(const u_char *, char *, size_t);
605 1.17 perry int ns_name_pton(const char *, u_char *, size_t);
606 1.25 christos int ns_name_pton2(const char *, u_char *, size_t, size_t *);
607 1.17 perry int ns_name_unpack(const u_char *, const u_char *,
608 1.17 perry const u_char *, u_char *, size_t);
609 1.25 christos int ns_name_unpack2(const u_char *, const u_char *,
610 1.25 christos const u_char *, u_char *, size_t,
611 1.25 christos size_t *);
612 1.17 perry int ns_name_pack(const u_char *, u_char *, int,
613 1.17 perry const u_char **, const u_char **);
614 1.17 perry int ns_name_uncompress(const u_char *, const u_char *,
615 1.17 perry const u_char *, char *, size_t);
616 1.17 perry int ns_name_compress(const char *, u_char *, size_t,
617 1.17 perry const u_char **, const u_char **);
618 1.17 perry int ns_name_skip(const u_char **, const u_char *);
619 1.17 perry void ns_name_rollback(const u_char *, const u_char **,
620 1.17 perry const u_char **);
621 1.24 christos #ifndef __LIBC12_SOURCE__
622 1.17 perry int ns_sign(u_char *, int *, int, int, void *,
623 1.24 christos const u_char *, int, u_char *, int *, time_t)
624 1.24 christos __RENAME(__ns_sign50);
625 1.17 perry int ns_sign2(u_char *, int *, int, int, void *,
626 1.16 christos const u_char *, int, u_char *, int *, time_t,
627 1.24 christos u_char **, u_char **)
628 1.24 christos __RENAME(__ns_sign250);
629 1.24 christos #endif
630 1.25 christos ssize_t ns_name_length(ns_nname_ct, size_t);
631 1.25 christos int ns_name_eq(ns_nname_ct, size_t, ns_nname_ct, size_t);
632 1.25 christos int ns_name_owned(ns_namemap_ct, int, ns_namemap_ct, int);
633 1.25 christos int ns_name_map(ns_nname_ct, size_t, ns_namemap_t, int);
634 1.25 christos int ns_name_labels(ns_nname_ct, size_t);
635 1.17 perry int ns_sign_tcp(u_char *, int *, int, int,
636 1.17 perry ns_tcp_tsig_state *, int);
637 1.17 perry int ns_sign_tcp2(u_char *, int *, int, int,
638 1.16 christos ns_tcp_tsig_state *, int,
639 1.17 perry u_char **, u_char **);
640 1.17 perry int ns_sign_tcp_init(void *, const u_char *, int,
641 1.17 perry ns_tcp_tsig_state *);
642 1.17 perry u_char *ns_find_tsig(u_char *, u_char *);
643 1.24 christos #ifndef __LIBC12_SOURCE__
644 1.17 perry int ns_verify(u_char *, int *, void *,
645 1.16 christos const u_char *, int, u_char *, int *,
646 1.24 christos time_t *, int)
647 1.24 christos __RENAME(__ns_verify50);
648 1.24 christos #endif
649 1.17 perry int ns_verify_tcp(u_char *, int *, ns_tcp_tsig_state *, int);
650 1.17 perry int ns_verify_tcp_init(void *, const u_char *, int,
651 1.17 perry ns_tcp_tsig_state *);
652 1.17 perry int ns_samedomain(const char *, const char *);
653 1.17 perry int ns_subdomain(const char *, const char *);
654 1.17 perry int ns_makecanon(const char *, char *, size_t);
655 1.17 perry int ns_samename(const char *, const char *);
656 1.25 christos int ns_newmsg_init(u_char *buffer, size_t bufsiz, ns_newmsg *);
657 1.25 christos int ns_newmsg_copy(ns_newmsg *, ns_msg *);
658 1.25 christos void ns_newmsg_id(ns_newmsg *handle, uint16_t id);
659 1.25 christos void ns_newmsg_flag(ns_newmsg *handle, ns_flag flag, u_int value);
660 1.25 christos int ns_newmsg_q(ns_newmsg *handle, ns_nname_ct qname,
661 1.25 christos ns_type qtype, ns_class qclass);
662 1.25 christos int ns_newmsg_rr(ns_newmsg *handle, ns_sect sect,
663 1.25 christos ns_nname_ct name, ns_type type,
664 1.25 christos ns_class rr_class, uint32_t ttl,
665 1.25 christos uint16_t rdlen, const u_char *rdata);
666 1.25 christos size_t ns_newmsg_done(ns_newmsg *handle);
667 1.25 christos ssize_t ns_rdata_unpack(const u_char *, const u_char *, ns_type,
668 1.25 christos const u_char *, size_t, u_char *, size_t);
669 1.25 christos int ns_rdata_equal(ns_type,
670 1.25 christos const u_char *, size_t,
671 1.25 christos const u_char *, size_t);
672 1.25 christos int ns_rdata_refers(ns_type,
673 1.25 christos const u_char *, size_t,
674 1.25 christos const u_char *);
675 1.16 christos __END_DECLS
676 1.16 christos
677 1.16 christos #ifdef BIND_4_COMPAT
678 1.16 christos #include <arpa/nameser_compat.h>
679 1.16 christos #endif
680 1.1 cgd
681 1.16 christos #endif /* !_ARPA_NAMESER_H_ */
682