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