00001 /* 00002 * Copyright (c) 1983, 1989, 1993 00003 * The Regents of the University of California. All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions 00007 * are met: 00008 * 1. Redistributions of source code must retain the above copyright 00009 * notice, this list of conditions and the following disclaimer. 00010 * 2. Redistributions in binary form must reproduce the above copyright 00011 * notice, this list of conditions and the following disclaimer in the 00012 * documentation and/or other materials provided with the distribution. 00013 * 3. All advertising materials mentioning features or use of this software 00014 * must display the following acknowledgement: 00015 * This product includes software developed by the University of 00016 * California, Berkeley and its contributors. 00017 * 4. Neither the name of the University nor the names of its contributors 00018 * may be used to endorse or promote products derived from this software 00019 * without specific prior written permission. 00020 * 00021 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 00022 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00023 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00024 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 00025 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00026 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 00027 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00028 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00029 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 00030 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00031 * SUCH DAMAGE. 00032 00033 * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved. 00034 00035 * Copyright (c) 1996 by Internet Software Consortium. 00036 * 00037 * Permission to use, copy, modify, and distribute this software for any 00038 * purpose with or without fee is hereby granted, provided that the above 00039 * copyright notice and this permission notice appear in all copies. 00040 * 00041 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS 00042 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES 00043 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE 00044 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 00045 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 00046 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS 00047 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 00048 * SOFTWARE. 00049 */ 00050 00051 /* 00052 * From: Id: nameser.h,v 8.16 1998/02/06 00:35:58 halley Exp 00053 * $FreeBSD: src/include/arpa/nameser.h,v 1.16 2002/03/23 17:24:55 imp Exp $ 00054 */ 00055 00056 #ifndef _ARPA_NAMESER_H_ 00057 #define _ARPA_NAMESER_H_ 00058 00059 #define BIND_4_COMPAT 00060 00061 #include <sys/types.h> 00062 #include <sys/cdefs.h> 00063 00064 /* 00065 * revision information. this is the release date in YYYYMMDD format. 00066 * it can change every day so the right thing to do with it is use it 00067 * in preprocessor commands such as "#if (__NAMESER > 19931104)". do not 00068 * compare for equality; rather, use it to determine whether your libnameser.a 00069 * is new enough to contain a certain feature. 00070 */ 00071 00072 /* XXXRTH I made this bigger than __BIND in 4.9.5 T6B */ 00073 #define __NAMESER 19961001 /* New interface version stamp. */ 00074 00075 /* 00076 * Define constants based on RFC 883, RFC 1034, RFC 1035 00077 */ 00078 #define NS_PACKETSZ 512 /* maximum packet size */ 00079 #define NS_MAXDNAME 1025 /* maximum domain name */ 00080 #define NS_MAXCDNAME 255 /* maximum compressed domain name */ 00081 #define NS_MAXLABEL 63 /* maximum length of domain label */ 00082 #define NS_HFIXEDSZ 12 /* #/bytes of fixed data in header */ 00083 #define NS_QFIXEDSZ 4 /* #/bytes of fixed data in query */ 00084 #define NS_RRFIXEDSZ 10 /* #/bytes of fixed data in r record */ 00085 #define NS_INT32SZ 4 /* #/bytes of data in a u_int32_t */ 00086 #define NS_INT16SZ 2 /* #/bytes of data in a u_int16_t */ 00087 #define NS_INT8SZ 1 /* #/bytes of data in a u_int8_t */ 00088 #define NS_INADDRSZ 4 /* IPv4 T_A */ 00089 #define NS_IN6ADDRSZ 16 /* IPv6 T_AAAA */ 00090 #define NS_CMPRSFLGS 0xc0 /* Flag bits indicating name compression. */ 00091 #define NS_DEFAULTPORT 53 /* For both TCP and UDP. */ 00092 00093 /* 00094 * These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord() 00095 * in synch with it. 00096 */ 00097 typedef enum __ns_sect { 00098 ns_s_qd = 0, /* Query: Question. */ 00099 ns_s_zn = 0, /* Update: Zone. */ 00100 ns_s_an = 1, /* Query: Answer. */ 00101 ns_s_pr = 1, /* Update: Prerequisites. */ 00102 ns_s_ns = 2, /* Query: Name servers. */ 00103 ns_s_ud = 2, /* Update: Update. */ 00104 ns_s_ar = 3, /* Query|Update: Additional records. */ 00105 ns_s_max = 4 00106 } ns_sect; 00107 00108 /* 00109 * This is a message handle. It is caller allocated and has no dynamic data. 00110 * This structure is intended to be opaque to all but ns_parse.c, thus the 00111 * leading _'s on the member names. Use the accessor functions, not the _'s. 00112 */ 00113 typedef struct __ns_msg { 00114 const u_char *_msg, *_eom; 00115 u_int16_t _id, _flags, _counts[ns_s_max]; 00116 const u_char *_sections[ns_s_max]; 00117 ns_sect _sect; 00118 int _rrnum; 00119 const u_char *_ptr; 00120 } ns_msg; 00121 00122 /* Private data structure - do not use from outside library. */ 00123 struct _ns_flagdata { int mask, shift; }; 00124 extern struct _ns_flagdata _ns_flagdata[]; 00125 00126 /* Accessor macros - this is part of the public interface. */ 00127 #define ns_msg_getflag(handle, flag) ( \ 00128 ((handle)._flags & _ns_flagdata[flag].mask) \ 00129 >> _ns_flagdata[flag].shift \ 00130 ) 00131 #define ns_msg_id(handle) ((handle)._id + 0) 00132 #define ns_msg_base(handle) ((handle)._msg + 0) 00133 #define ns_msg_end(handle) ((handle)._eom + 0) 00134 #define ns_msg_size(handle) ((handle)._eom - (handle)._msg) 00135 #define ns_msg_count(handle, section) ((handle)._counts[section] + 0) 00136 00137 /* 00138 * This is a parsed record. It is caller allocated and has no dynamic data. 00139 */ 00140 typedef struct __ns_rr { 00141 char name[NS_MAXDNAME]; /* XXX need to malloc */ 00142 u_int16_t type; 00143 u_int16_t rr_class; 00144 u_int32_t ttl; 00145 u_int16_t rdlength; 00146 const u_char *rdata; 00147 } ns_rr; 00148 00149 /* Accessor macros - this is part of the public interface. */ 00150 #define ns_rr_name(rr) (((rr).name[0] != '\0') ? (rr).name : ".") 00151 #define ns_rr_type(rr) ((rr).type + 0) 00152 #define ns_rr_class(rr) ((rr).rr_class + 0) 00153 #define ns_rr_ttl(rr) ((rr).ttl + 0) 00154 #define ns_rr_rdlen(rr) ((rr).rdlength + 0) 00155 #define ns_rr_rdata(rr) ((rr).rdata + 0) 00156 00157 /* 00158 * These don't have to be in the same order as in the packet flags word, 00159 * and they can even overlap in some cases, but they will need to be kept 00160 * in synch with ns_parse.c:ns_flagdata[]. 00161 */ 00162 typedef enum __ns_flag { 00163 ns_f_qr, /* Question/Response. */ 00164 ns_f_opcode, /* Operation code. */ 00165 ns_f_aa, /* Authoritative Answer. */ 00166 ns_f_tc, /* Truncation occurred. */ 00167 ns_f_rd, /* Recursion Desired. */ 00168 ns_f_ra, /* Recursion Available. */ 00169 ns_f_z, /* MBZ. */ 00170 ns_f_ad, /* Authentic Data (DNSSEC). */ 00171 ns_f_cd, /* Checking Disabled (DNSSEC). */ 00172 ns_f_rcode, /* Response code. */ 00173 ns_f_max 00174 } ns_flag; 00175 00176 /* 00177 * Currently defined opcodes. 00178 */ 00179 typedef enum __ns_opcode { 00180 ns_o_query = 0, /* Standard query. */ 00181 ns_o_iquery = 1, /* Inverse query (deprecated/unsupported). */ 00182 ns_o_status = 2, /* Name server status query (unsupported). */ 00183 /* Opcode 3 is undefined/reserved. */ 00184 ns_o_notify = 4, /* Zone change notification. */ 00185 ns_o_update = 5, /* Zone update message. */ 00186 ns_o_max = 6 00187 } ns_opcode; 00188 00189 /* 00190 * Currently defined response codes. 00191 */ 00192 typedef enum __ns_rcode { 00193 ns_r_noerror = 0, /* No error occurred. */ 00194 ns_r_formerr = 1, /* Format error. */ 00195 ns_r_servfail = 2, /* Server failure. */ 00196 ns_r_nxdomain = 3, /* Name error. */ 00197 ns_r_notimpl = 4, /* Unimplemented. */ 00198 ns_r_refused = 5, /* Operation refused. */ 00199 /* these are for BIND_UPDATE */ 00200 ns_r_yxdomain = 6, /* Name exists */ 00201 ns_r_yxrrset = 7, /* RRset exists */ 00202 ns_r_nxrrset = 8, /* RRset does not exist */ 00203 ns_r_notauth = 9, /* Not authoritative for zone */ 00204 ns_r_notzone = 10, /* Zone of record different from zone section */ 00205 ns_r_max = 11 00206 } ns_rcode; 00207 00208 /* BIND_UPDATE */ 00209 typedef enum __ns_update_operation { 00210 ns_uop_delete = 0, 00211 ns_uop_add = 1, 00212 ns_uop_max = 2 00213 } ns_update_operation; 00214 00215 /* 00216 * This RR-like structure is particular to UPDATE. 00217 */ 00218 struct ns_updrec { 00219 struct ns_updrec *r_prev; /* prev record */ 00220 struct ns_updrec *r_next; /* next record */ 00221 u_int8_t r_section; /* ZONE/PREREQUISITE/UPDATE */ 00222 char * r_dname; /* owner of the RR */ 00223 u_int16_t r_class; /* class number */ 00224 u_int16_t r_type; /* type number */ 00225 u_int32_t r_ttl; /* time to live */ 00226 u_char * r_data; /* rdata fields as text string */ 00227 u_int16_t r_size; /* size of r_data field */ 00228 int r_opcode; /* type of operation */ 00229 /* following fields for private use by the resolver/server routines */ 00230 struct ns_updrec *r_grpnext; /* next record when grouped */ 00231 struct databuf *r_dp; /* databuf to process */ 00232 struct databuf *r_deldp; /* databuf's deleted/overwritten */ 00233 u_int16_t r_zone; /* zone number on server */ 00234 }; 00235 typedef struct ns_updrec ns_updrec; 00236 00237 /* 00238 * Currently defined type values for resources and queries. 00239 */ 00240 typedef enum __ns_type { 00241 ns_t_a = 1, /* Host address. */ 00242 ns_t_ns = 2, /* Authoritative server. */ 00243 ns_t_md = 3, /* Mail destination. */ 00244 ns_t_mf = 4, /* Mail forwarder. */ 00245 ns_t_cname = 5, /* Canonical name. */ 00246 ns_t_soa = 6, /* Start of authority zone. */ 00247 ns_t_mb = 7, /* Mailbox domain name. */ 00248 ns_t_mg = 8, /* Mail group member. */ 00249 ns_t_mr = 9, /* Mail rename name. */ 00250 ns_t_null = 10, /* Null resource record. */ 00251 ns_t_wks = 11, /* Well known service. */ 00252 ns_t_ptr = 12, /* Domain name pointer. */ 00253 ns_t_hinfo = 13, /* Host information. */ 00254 ns_t_minfo = 14, /* Mailbox information. */ 00255 ns_t_mx = 15, /* Mail routing information. */ 00256 ns_t_txt = 16, /* Text strings. */ 00257 ns_t_rp = 17, /* Responsible person. */ 00258 ns_t_afsdb = 18, /* AFS cell database. */ 00259 ns_t_x25 = 19, /* X_25 calling address. */ 00260 ns_t_isdn = 20, /* ISDN calling address. */ 00261 ns_t_rt = 21, /* Router. */ 00262 ns_t_nsap = 22, /* NSAP address. */ 00263 ns_t_nsap_ptr = 23, /* Reverse NSAP lookup (deprecated). */ 00264 ns_t_sig = 24, /* Security signature. */ 00265 ns_t_key = 25, /* Security key. */ 00266 ns_t_px = 26, /* X.400 mail mapping. */ 00267 ns_t_gpos = 27, /* Geographical position (withdrawn). */ 00268 ns_t_aaaa = 28, /* Ip6 Address. */ 00269 ns_t_loc = 29, /* Location Information. */ 00270 ns_t_nxt = 30, /* Next domain (security). */ 00271 ns_t_eid = 31, /* Endpoint identifier. */ 00272 ns_t_nimloc = 32, /* Nimrod Locator. */ 00273 ns_t_srv = 33, /* Server Selection. */ 00274 ns_t_atma = 34, /* ATM Address */ 00275 ns_t_naptr = 35, /* Naming Authority PoinTeR */ 00276 ns_t_opt = 41, /* OPT pseudo-RR, RFC2761 */ 00277 /* Query type values which do not appear in resource records. */ 00278 ns_t_ixfr = 251, /* Incremental zone transfer. */ 00279 ns_t_axfr = 252, /* Transfer zone of authority. */ 00280 ns_t_mailb = 253, /* Transfer mailbox records. */ 00281 ns_t_maila = 254, /* Transfer mail agent records. */ 00282 ns_t_any = 255, /* Wildcard match. */ 00283 ns_t_max = 65536 00284 } ns_type; 00285 00286 /* 00287 * Values for class field 00288 */ 00289 typedef enum __ns_class { 00290 ns_c_in = 1, /* Internet. */ 00291 /* Class 2 unallocated/unsupported. */ 00292 ns_c_chaos = 3, /* MIT Chaos-net. */ 00293 ns_c_hs = 4, /* MIT Hesiod. */ 00294 /* Query class values which do not appear in resource records */ 00295 ns_c_none = 254, /* for prereq. sections in update requests */ 00296 ns_c_any = 255, /* Wildcard match. */ 00297 ns_c_max = 65536 00298 } ns_class; 00299 00300 /* 00301 * Flags field of the KEY RR rdata 00302 */ 00303 #define NS_KEY_TYPEMASK 0xC000 /* Mask for "type" bits */ 00304 #define NS_KEY_TYPE_AUTH_CONF 0x0000 /* Key usable for both */ 00305 #define NS_KEY_TYPE_CONF_ONLY 0x8000 /* Key usable for confidentiality */ 00306 #define NS_KEY_TYPE_AUTH_ONLY 0x4000 /* Key usable for authentication */ 00307 #define NS_KEY_TYPE_NO_KEY 0xC000 /* No key usable for either; no key */ 00308 /* The type bits can also be interpreted independently, as single bits: */ 00309 #define NS_KEY_NO_AUTH 0x8000 /* Key unusable for authentication */ 00310 #define NS_KEY_NO_CONF 0x4000 /* Key unusable for confidentiality */ 00311 #define NS_KEY_EXPERIMENTAL 0x2000 /* Security is *mandatory* if bit=0 */ 00312 #define NS_KEY_RESERVED3 0x1000 /* reserved - must be zero */ 00313 #define NS_KEY_RESERVED4 0x0800 /* reserved - must be zero */ 00314 #define NS_KEY_USERACCOUNT 0x0400 /* key is assoc. with a user acct */ 00315 #define NS_KEY_ENTITY 0x0200 /* key is assoc. with entity eg host */ 00316 #define NS_KEY_ZONEKEY 0x0100 /* key is zone key */ 00317 #define NS_KEY_IPSEC 0x0080 /* key is for IPSEC (host or user)*/ 00318 #define NS_KEY_EMAIL 0x0040 /* key is for email (MIME security) */ 00319 #define NS_KEY_RESERVED10 0x0020 /* reserved - must be zero */ 00320 #define NS_KEY_RESERVED11 0x0010 /* reserved - must be zero */ 00321 #define NS_KEY_SIGNATORYMASK 0x000F /* key can sign RR's of same name */ 00322 00323 #define NS_KEY_RESERVED_BITMASK ( NS_KEY_RESERVED3 | \ 00324 NS_KEY_RESERVED4 | \ 00325 NS_KEY_RESERVED10 | \ 00326 NS_KEY_RESERVED11 ) 00327 00328 /* The Algorithm field of the KEY and SIG RR's is an integer, {1..254} */ 00329 #define NS_ALG_MD5RSA 1 /* MD5 with RSA */ 00330 #define NS_ALG_EXPIRE_ONLY 253 /* No alg, no security */ 00331 #define NS_ALG_PRIVATE_OID 254 /* Key begins with OID giving alg */ 00332 00333 /* Signatures */ 00334 #define NS_MD5RSA_MIN_BITS 512 /* Size of a mod or exp in bits */ 00335 #define NS_MD5RSA_MAX_BITS 2552 00336 /* Total of binary mod and exp */ 00337 #define NS_MD5RSA_MAX_BYTES ((NS_MD5RSA_MAX_BITS+7/8)*2+3) 00338 /* Max length of text sig block */ 00339 #define NS_MD5RSA_MAX_BASE64 (((NS_MD5RSA_MAX_BYTES+2)/3)*4) 00340 00341 /* Offsets into SIG record rdata to find various values */ 00342 #define NS_SIG_TYPE 0 /* Type flags */ 00343 #define NS_SIG_ALG 2 /* Algorithm */ 00344 #define NS_SIG_LABELS 3 /* How many labels in name */ 00345 #define NS_SIG_OTTL 4 /* Original TTL */ 00346 #define NS_SIG_EXPIR 8 /* Expiration time */ 00347 #define NS_SIG_SIGNED 12 /* Signature time */ 00348 #define NS_SIG_FOOT 16 /* Key footprint */ 00349 #define NS_SIG_SIGNER 18 /* Domain name of who signed it */ 00350 00351 /* How RR types are represented as bit-flags in NXT records */ 00352 #define NS_NXT_BITS 8 00353 #define NS_NXT_BIT_SET( n,p) (p[(n)/NS_NXT_BITS] |= (0x80>>((n)%NS_NXT_BITS))) 00354 #define NS_NXT_BIT_CLEAR(n,p) (p[(n)/NS_NXT_BITS] &= ~(0x80>>((n)%NS_NXT_BITS))) 00355 #define NS_NXT_BIT_ISSET(n,p) (p[(n)/NS_NXT_BITS] & (0x80>>((n)%NS_NXT_BITS))) 00356 00357 00358 /* 00359 * Inline versions of get/put short/long. Pointer is advanced. 00360 */ 00361 #define NS_GET16(s, cp) { \ 00362 register u_char *t_cp = (u_char *)(cp); \ 00363 (s) = ((u_int16_t)t_cp[0] << 8) \ 00364 | ((u_int16_t)t_cp[1]) \ 00365 ; \ 00366 (cp) += NS_INT16SZ; \ 00367 } 00368 00369 #define NS_GET32(l, cp) { \ 00370 register u_char *t_cp = (u_char *)(cp); \ 00371 (l) = ((u_int32_t)t_cp[0] << 24) \ 00372 | ((u_int32_t)t_cp[1] << 16) \ 00373 | ((u_int32_t)t_cp[2] << 8) \ 00374 | ((u_int32_t)t_cp[3]) \ 00375 ; \ 00376 (cp) += NS_INT32SZ; \ 00377 } 00378 00379 #define NS_PUT16(s, cp) { \ 00380 register u_int16_t t_s = (u_int16_t)(s); \ 00381 register u_char *t_cp = (u_char *)(cp); \ 00382 *t_cp++ = t_s >> 8; \ 00383 *t_cp = t_s; \ 00384 (cp) += NS_INT16SZ; \ 00385 } 00386 00387 #define NS_PUT32(l, cp) { \ 00388 register u_int32_t t_l = (u_int32_t)(l); \ 00389 register u_char *t_cp = (u_char *)(cp); \ 00390 *t_cp++ = t_l >> 24; \ 00391 *t_cp++ = t_l >> 16; \ 00392 *t_cp++ = t_l >> 8; \ 00393 *t_cp = t_l; \ 00394 (cp) += NS_INT32SZ; \ 00395 } 00396 00397 /* 00398 * ANSI C identifier hiding. 00399 */ 00400 #define ns_get16 __ns_get16 00401 #define ns_get32 __ns_get32 00402 #define ns_put16 __ns_put16 00403 #define ns_put32 __ns_put32 00404 #define ns_initparse __ns_initparse 00405 #define ns_parserr __ns_parserr 00406 #define ns_sprintrr __ns_sprintrr 00407 #define ns_sprintrrf __ns_sprintrrf 00408 #define ns_format_ttl __ns_format_ttl 00409 #define ns_parse_ttl __ns_parse_ttl 00410 #define ns_name_ntop __ns_name_ntop 00411 #define ns_name_pton __ns_name_pton 00412 #define ns_name_unpack __ns_name_unpack 00413 #define ns_name_pack __ns_name_pack 00414 #define ns_name_compress __ns_name_compress 00415 #define ns_name_uncompress __ns_name_uncompress 00416 00417 #ifdef BIND_4_COMPAT 00418 #include <arpa/nameser_compat.h> 00419 #endif 00420 00421 #endif /* !_ARPA_NAMESER_H_ */