RTEMS CPU Kit with SuperCore  4.11.3
nameser.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 1983, 1989, 1993
3  * The Regents of the University of California. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  * must display the following acknowledgement:
15  * This product includes software developed by the University of
16  * California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  * may be used to endorse or promote products derived from this software
19  * without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 /*
35  * Copyright (c) 1996 by Internet Software Consortium.
36  *
37  * Permission to use, copy, modify, and distribute this software for any
38  * purpose with or without fee is hereby granted, provided that the above
39  * copyright notice and this permission notice appear in all copies.
40  *
41  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
42  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
44  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
45  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
46  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
47  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
48  * SOFTWARE.
49  */
50 
51 /*
52  * From: Id: nameser.h,v 8.16 1998/02/06 00:35:58 halley Exp
53  * $FreeBSD: src/include/arpa/nameser.h,v 1.16 2002/03/23 17:24:55 imp Exp $
54  */
55 
56 
57 #ifndef _ARPA_NAMESER_H_
58 #define _ARPA_NAMESER_H_
59 
60 #define BIND_4_COMPAT
61 
62 #include <sys/types.h>
63 #include <sys/cdefs.h>
64 
65 /*
66  * revision information. this is the release date in YYYYMMDD format.
67  * it can change every day so the right thing to do with it is use it
68  * in preprocessor commands such as "#if (__NAMESER > 19931104)". do not
69  * compare for equality; rather, use it to determine whether your libnameser.a
70  * is new enough to contain a certain feature.
71  */
72 
73 /* XXXRTH I made this bigger than __BIND in 4.9.5 T6B */
74 #define __NAMESER 19961001 /* New interface version stamp. */
75 
76 /*
77  * Define constants based on RFC 883, RFC 1034, RFC 1035
78  */
79 #define NS_PACKETSZ 512 /* maximum packet size */
80 #define NS_MAXDNAME 1025 /* maximum domain name */
81 #define NS_MAXCDNAME 255 /* maximum compressed domain name */
82 #define NS_MAXLABEL 63 /* maximum length of domain label */
83 #define NS_HFIXEDSZ 12 /* #/bytes of fixed data in header */
84 #define NS_QFIXEDSZ 4 /* #/bytes of fixed data in query */
85 #define NS_RRFIXEDSZ 10 /* #/bytes of fixed data in r record */
86 #define NS_INT32SZ 4 /* #/bytes of data in a u_int32_t */
87 #define NS_INT16SZ 2 /* #/bytes of data in a u_int16_t */
88 #define NS_INT8SZ 1 /* #/bytes of data in a u_int8_t */
89 #define NS_INADDRSZ 4 /* IPv4 T_A */
90 #define NS_IN6ADDRSZ 16 /* IPv6 T_AAAA */
91 #define NS_CMPRSFLGS 0xc0 /* Flag bits indicating name compression. */
92 #define NS_DEFAULTPORT 53 /* For both TCP and UDP. */
93 
94 /*
95  * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord()
96  * in synch with it.
97  */
98 typedef enum __ns_sect {
99  ns_s_qd = 0, /* Query: Question. */
100  ns_s_zn = 0, /* Update: Zone. */
101  ns_s_an = 1, /* Query: Answer. */
102  ns_s_pr = 1, /* Update: Prerequisites. */
103  ns_s_ns = 2, /* Query: Name servers. */
104  ns_s_ud = 2, /* Update: Update. */
105  ns_s_ar = 3, /* Query|Update: Additional records. */
106  ns_s_max = 4
107 } ns_sect;
108 
109 /*
110  * This is a message handle. It is caller allocated and has no dynamic data.
111  * This structure is intended to be opaque to all but ns_parse.c, thus the
112  * leading _'s on the member names. Use the accessor functions, not the _'s.
113  */
114 typedef struct __ns_msg {
115  const u_char *_msg, *_eom;
116  u_int16_t _id, _flags, _counts[ns_s_max];
117  const u_char *_sections[ns_s_max];
118  ns_sect _sect;
119  int _rrnum;
120  const u_char *_ptr;
121 } ns_msg;
122 
123 /* Private data structure - do not use from outside library. */
124 struct _ns_flagdata { int mask, shift; };
125 extern struct _ns_flagdata _ns_flagdata[];
126 
127 /* Accessor macros - this is part of the public interface. */
128 #define ns_msg_getflag(handle, flag) ( \
129  ((handle)._flags & _ns_flagdata[flag].mask) \
130  >> _ns_flagdata[flag].shift \
131  )
132 #define ns_msg_id(handle) ((handle)._id + 0)
133 #define ns_msg_base(handle) ((handle)._msg + 0)
134 #define ns_msg_end(handle) ((handle)._eom + 0)
135 #define ns_msg_size(handle) ((handle)._eom - (handle)._msg)
136 #define ns_msg_count(handle, section) ((handle)._counts[section] + 0)
137 
138 /*
139  * This is a parsed record. It is caller allocated and has no dynamic data.
140  */
141 typedef struct __ns_rr {
142  char name[NS_MAXDNAME]; /* XXX need to malloc */
143  u_int16_t type;
144  u_int16_t rr_class;
145  u_int32_t ttl;
146  u_int16_t rdlength;
147  const u_char *rdata;
148 } ns_rr;
149 
150 /* Accessor macros - this is part of the public interface. */
151 #define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".")
152 #define ns_rr_type(rr) ((rr).type + 0)
153 #define ns_rr_class(rr) ((rr).rr_class + 0)
154 #define ns_rr_ttl(rr) ((rr).ttl + 0)
155 #define ns_rr_rdlen(rr) ((rr).rdlength + 0)
156 #define ns_rr_rdata(rr) ((rr).rdata + 0)
157 
158 /*
159  * These don't have to be in the same order as in the packet flags word,
160  * and they can even overlap in some cases, but they will need to be kept
161  * in synch with ns_parse.c:ns_flagdata[].
162  */
163 typedef enum __ns_flag {
164  ns_f_qr, /* Question/Response. */
165  ns_f_opcode, /* Operation code. */
166  ns_f_aa, /* Authoritative Answer. */
167  ns_f_tc, /* Truncation occurred. */
168  ns_f_rd, /* Recursion Desired. */
169  ns_f_ra, /* Recursion Available. */
170  ns_f_z, /* MBZ. */
171  ns_f_ad, /* Authentic Data (DNSSEC). */
172  ns_f_cd, /* Checking Disabled (DNSSEC). */
173  ns_f_rcode, /* Response code. */
174  ns_f_max
175 } ns_flag;
176 
177 /*
178  * Currently defined opcodes.
179  */
180 typedef enum __ns_opcode {
181  ns_o_query = 0, /* Standard query. */
182  ns_o_iquery = 1, /* Inverse query (deprecated/unsupported). */
183  ns_o_status = 2, /* Name server status query (unsupported). */
184  /* Opcode 3 is undefined/reserved. */
185  ns_o_notify = 4, /* Zone change notification. */
186  ns_o_update = 5, /* Zone update message. */
187  ns_o_max = 6
188 } ns_opcode;
189 
190 /*
191  * Currently defined response codes.
192  */
193 typedef enum __ns_rcode {
194  ns_r_noerror = 0, /* No error occurred. */
195  ns_r_formerr = 1, /* Format error. */
196  ns_r_servfail = 2, /* Server failure. */
197  ns_r_nxdomain = 3, /* Name error. */
198  ns_r_notimpl = 4, /* Unimplemented. */
199  ns_r_refused = 5, /* Operation refused. */
200  /* these are for BIND_UPDATE */
201  ns_r_yxdomain = 6, /* Name exists */
202  ns_r_yxrrset = 7, /* RRset exists */
203  ns_r_nxrrset = 8, /* RRset does not exist */
204  ns_r_notauth = 9, /* Not authoritative for zone */
205  ns_r_notzone = 10, /* Zone of record different from zone section */
206  ns_r_max = 11
207 } ns_rcode;
208 
209 /* BIND_UPDATE */
210 typedef enum __ns_update_operation {
211  ns_uop_delete = 0,
212  ns_uop_add = 1,
213  ns_uop_max = 2
214 } ns_update_operation;
215 
216 /*
217  * This RR-like structure is particular to UPDATE.
218  */
219 struct ns_updrec {
220  struct ns_updrec *r_prev; /* prev record */
221  struct ns_updrec *r_next; /* next record */
222  u_int8_t r_section; /* ZONE/PREREQUISITE/UPDATE */
223  char * r_dname; /* owner of the RR */
224  u_int16_t r_class; /* class number */
225  u_int16_t r_type; /* type number */
226  u_int32_t r_ttl; /* time to live */
227  u_char * r_data; /* rdata fields as text string */
228  u_int16_t r_size; /* size of r_data field */
229  int r_opcode; /* type of operation */
230  /* following fields for private use by the resolver/server routines */
231  struct ns_updrec *r_grpnext; /* next record when grouped */
232  struct databuf *r_dp; /* databuf to process */
233  struct databuf *r_deldp; /* databuf's deleted/overwritten */
234  u_int16_t r_zone; /* zone number on server */
235 };
236 typedef struct ns_updrec ns_updrec;
237 
238 /*
239  * Currently defined type values for resources and queries.
240  */
241 typedef enum __ns_type {
242  ns_t_a = 1, /* Host address. */
243  ns_t_ns = 2, /* Authoritative server. */
244  ns_t_md = 3, /* Mail destination. */
245  ns_t_mf = 4, /* Mail forwarder. */
246  ns_t_cname = 5, /* Canonical name. */
247  ns_t_soa = 6, /* Start of authority zone. */
248  ns_t_mb = 7, /* Mailbox domain name. */
249  ns_t_mg = 8, /* Mail group member. */
250  ns_t_mr = 9, /* Mail rename name. */
251  ns_t_null = 10, /* Null resource record. */
252  ns_t_wks = 11, /* Well known service. */
253  ns_t_ptr = 12, /* Domain name pointer. */
254  ns_t_hinfo = 13, /* Host information. */
255  ns_t_minfo = 14, /* Mailbox information. */
256  ns_t_mx = 15, /* Mail routing information. */
257  ns_t_txt = 16, /* Text strings. */
258  ns_t_rp = 17, /* Responsible person. */
259  ns_t_afsdb = 18, /* AFS cell database. */
260  ns_t_x25 = 19, /* X_25 calling address. */
261  ns_t_isdn = 20, /* ISDN calling address. */
262  ns_t_rt = 21, /* Router. */
263  ns_t_nsap = 22, /* NSAP address. */
264  ns_t_nsap_ptr = 23, /* Reverse NSAP lookup (deprecated). */
265  ns_t_sig = 24, /* Security signature. */
266  ns_t_key = 25, /* Security key. */
267  ns_t_px = 26, /* X.400 mail mapping. */
268  ns_t_gpos = 27, /* Geographical position (withdrawn). */
269  ns_t_aaaa = 28, /* Ip6 Address. */
270  ns_t_loc = 29, /* Location Information. */
271  ns_t_nxt = 30, /* Next domain (security). */
272  ns_t_eid = 31, /* Endpoint identifier. */
273  ns_t_nimloc = 32, /* Nimrod Locator. */
274  ns_t_srv = 33, /* Server Selection. */
275  ns_t_atma = 34, /* ATM Address */
276  ns_t_naptr = 35, /* Naming Authority PoinTeR */
277  ns_t_opt = 41, /* OPT pseudo-RR, RFC2761 */
278  /* Query type values which do not appear in resource records. */
279  ns_t_ixfr = 251, /* Incremental zone transfer. */
280  ns_t_axfr = 252, /* Transfer zone of authority. */
281  ns_t_mailb = 253, /* Transfer mailbox records. */
282  ns_t_maila = 254, /* Transfer mail agent records. */
283  ns_t_any = 255, /* Wildcard match. */
284  ns_t_max = 65536
285 } ns_type;
286 
287 /*
288  * Values for class field
289  */
290 typedef enum __ns_class {
291  ns_c_in = 1, /* Internet. */
292  /* Class 2 unallocated/unsupported. */
293  ns_c_chaos = 3, /* MIT Chaos-net. */
294  ns_c_hs = 4, /* MIT Hesiod. */
295  /* Query class values which do not appear in resource records */
296  ns_c_none = 254, /* for prereq. sections in update requests */
297  ns_c_any = 255, /* Wildcard match. */
298  ns_c_max = 65536
299 } ns_class;
300 
301 /*
302  * Flags field of the KEY RR rdata
303  */
304 #define NS_KEY_TYPEMASK 0xC000 /* Mask for "type" bits */
305 #define NS_KEY_TYPE_AUTH_CONF 0x0000 /* Key usable for both */
306 #define NS_KEY_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */
307 #define NS_KEY_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */
308 #define NS_KEY_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */
309 /* The type bits can also be interpreted independently, as single bits: */
310 #define NS_KEY_NO_AUTH 0x8000 /* Key unusable for authentication */
311 #define NS_KEY_NO_CONF 0x4000 /* Key unusable for confidentiality */
312 #define NS_KEY_EXPERIMENTAL 0x2000 /* Security is *mandatory* if bit=0 */
313 #define NS_KEY_RESERVED3 0x1000 /* reserved - must be zero */
314 #define NS_KEY_RESERVED4 0x0800 /* reserved - must be zero */
315 #define NS_KEY_USERACCOUNT 0x0400 /* key is assoc. with a user acct */
316 #define NS_KEY_ENTITY 0x0200 /* key is assoc. with entity eg host */
317 #define NS_KEY_ZONEKEY 0x0100 /* key is zone key */
318 #define NS_KEY_IPSEC 0x0080 /* key is for IPSEC (host or user)*/
319 #define NS_KEY_EMAIL 0x0040 /* key is for email (MIME security) */
320 #define NS_KEY_RESERVED10 0x0020 /* reserved - must be zero */
321 #define NS_KEY_RESERVED11 0x0010 /* reserved - must be zero */
322 #define NS_KEY_SIGNATORYMASK 0x000F /* key can sign RR's of same name */
323 
324 #define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED3 | \
325  NS_KEY_RESERVED4 | \
326  NS_KEY_RESERVED10 | \
327  NS_KEY_RESERVED11 )
328 
329 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */
330 #define NS_ALG_MD5RSA 1 /* MD5 with RSA */
331 #define NS_ALG_EXPIRE_ONLY 253 /* No alg, no security */
332 #define NS_ALG_PRIVATE_OID 254 /* Key begins with OID giving alg */
333 
334 /* Signatures */
335 #define NS_MD5RSA_MIN_BITS 512 /* Size of a mod or exp in bits */
336 #define NS_MD5RSA_MAX_BITS 2552
337  /* Total of binary mod and exp */
338 #define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3)
339  /* Max length of text sig block */
340 #define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4)
341 
342 /* Offsets into SIG record rdata to find various values */
343 #define NS_SIG_TYPE 0 /* Type flags */
344 #define NS_SIG_ALG 2 /* Algorithm */
345 #define NS_SIG_LABELS 3 /* How many labels in name */
346 #define NS_SIG_OTTL 4 /* Original TTL */
347 #define NS_SIG_EXPIR 8 /* Expiration time */
348 #define NS_SIG_SIGNED 12 /* Signature time */
349 #define NS_SIG_FOOT 16 /* Key footprint */
350 #define NS_SIG_SIGNER 18 /* Domain name of who signed it */
351 
352 /* How RR types are represented as bit-flags in NXT records */
353 #define NS_NXT_BITS 8
354 #define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS)))
355 #define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS)))
356 #define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS)))
357 
358 
359 /*
360  * Inline versions of get/put short/long. Pointer is advanced.
361  */
362 #define NS_GET16(s, cp) { \
363  register u_char *t_cp = (u_char *)(cp); \
364  (s) = ((u_int16_t)t_cp[0] << 8) \
365  | ((u_int16_t)t_cp[1]) \
366  ; \
367  (cp) += NS_INT16SZ; \
368 }
369 
370 #define NS_GET32(l, cp) { \
371  register u_char *t_cp = (u_char *)(cp); \
372  (l) = ((u_int32_t)t_cp[0] << 24) \
373  | ((u_int32_t)t_cp[1] << 16) \
374  | ((u_int32_t)t_cp[2] << 8) \
375  | ((u_int32_t)t_cp[3]) \
376  ; \
377  (cp) += NS_INT32SZ; \
378 }
379 
380 #define NS_PUT16(s, cp) { \
381  register u_int16_t t_s = (u_int16_t)(s); \
382  register u_char *t_cp = (u_char *)(cp); \
383  *t_cp++ = t_s >> 8; \
384  *t_cp = t_s; \
385  (cp) += NS_INT16SZ; \
386 }
387 
388 #define NS_PUT32(l, cp) { \
389  register u_int32_t t_l = (u_int32_t)(l); \
390  register u_char *t_cp = (u_char *)(cp); \
391  *t_cp++ = t_l >> 24; \
392  *t_cp++ = t_l >> 16; \
393  *t_cp++ = t_l >> 8; \
394  *t_cp = t_l; \
395  (cp) += NS_INT32SZ; \
396 }
397 
398 /*
399  * ANSI C identifier hiding.
400  */
401 #define ns_get16 __ns_get16
402 #define ns_get32 __ns_get32
403 #define ns_put16 __ns_put16
404 #define ns_put32 __ns_put32
405 #define ns_initparse __ns_initparse
406 #define ns_parserr __ns_parserr
407 #define ns_sprintrr __ns_sprintrr
408 #define ns_sprintrrf __ns_sprintrrf
409 #define ns_format_ttl __ns_format_ttl
410 #define ns_parse_ttl __ns_parse_ttl
411 #define ns_name_ntop __ns_name_ntop
412 #define ns_name_pton __ns_name_pton
413 #define ns_name_unpack __ns_name_unpack
414 #define ns_name_pack __ns_name_pack
415 #define ns_name_compress __ns_name_compress
416 #define ns_name_uncompress __ns_name_uncompress
417 
418 __BEGIN_DECLS
419 u_int ns_get16(const u_char *);
420 u_long ns_get32(const u_char *);
421 void ns_put16(u_int, u_char *);
422 void ns_put32(u_long, u_char *);
423 int ns_initparse(const u_char *, int, ns_msg *);
424 int ns_parserr(ns_msg *, ns_sect, int, ns_rr *);
425 int ns_sprintrr(const ns_msg *, const ns_rr *,
426  const char *, const char *, char *, size_t);
427 int ns_sprintrrf(const u_char *, size_t, const char *,
428  ns_class, ns_type, u_long, const u_char *,
429  size_t, const char *, const char *,
430  char *, size_t);
431 int ns_format_ttl(u_long, char *, size_t);
432 int ns_parse_ttl(const char *, u_long *);
433 int ns_name_ntop(const u_char *, char *, size_t);
434 int ns_name_pton(const char *, u_char *, size_t);
435 int ns_name_unpack(const u_char *, const u_char *,
436  const u_char *, u_char *, size_t);
437 int ns_name_pack(const u_char *, u_char *, int,
438  const u_char **, const u_char **);
439 int ns_name_uncompress(const u_char *, const u_char *,
440  const u_char *, char *, size_t);
441 int ns_name_compress(const char *, u_char *, size_t,
442  const u_char **, const u_char **);
443 int ns_name_skip(const u_char **, const u_char *);
444 __END_DECLS
445 
446 #ifdef BIND_4_COMPAT
447 #include <arpa/nameser_compat.h>
448 #endif
449 
450 #endif /* !_ARPA_NAMESER_H_ */
__ns_msg
Definition: nameser.h:115
__ns_rr
Definition: nameser.h:142
nameser_compat.h
Generated by   doxygen 1.8.13