source: rtems/cpukit/libnetworking/arpa/nameser.h @ 5c7dd995

4.104.114.84.95
Last change on this file since 5c7dd995 was 5c7dd995, checked in by Ralf Corsepius <ralf.corsepius@…>, on 05/24/05 at 04:48:45

Update from FreeBSD.

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