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