1 /* $NetBSD: resolv.h,v 1.27 2004/06/04 09:54:03 he Exp $ */ 2 3 /* 4 * Copyright (c) 1983, 1987, 1989 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 /* 33 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC") 34 * Portions Copyright (c) 1996-1999 by Internet Software Consortium. 35 * 36 * Permission to use, copy, modify, and distribute this software for any 37 * purpose with or without fee is hereby granted, provided that the above 38 * copyright notice and this permission notice appear in all copies. 39 * 40 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES 41 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 42 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR 43 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 44 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 45 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT 46 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 47 */ 48 49 /* 50 * @(#)resolv.h 8.1 (Berkeley) 6/2/93 51 * Id: resolv.h,v 1.7.2.11.4.1 2004/03/09 08:33:29 marka Exp 52 */ 53 54 #ifndef _RESOLV_H_ 55 #define _RESOLV_H_ 56 57 #include <sys/param.h> 58 #if (!defined(BSD)) || (BSD < 199306) 59 # include <sys/bitypes.h> 60 #else 61 #include <sys/types.h> 62 #endif 63 #include <sys/cdefs.h> 64 #include <sys/socket.h> 65 #include <stdio.h> 66 #include <arpa/nameser.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 (__RES > 19931104)". Do not 72 * compare for equality; rather, use it to determine whether your resolver 73 * is new enough to contain a certain feature. 74 */ 75 76 #define __RES 20030124 77 78 /* 79 * This used to be defined in res_query.c, now it's in herror.c. 80 * [XXX no it's not. It's in irs/irs_data.c] 81 * It was 82 * never extern'd by any *.h file before it was placed here. For thread 83 * aware programs, the last h_errno value set is stored in res->h_errno. 84 * 85 * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO 86 * (and __h_errno_set) to the public via <resolv.h>. 87 * XXX: __h_errno_set is really part of IRS, not part of the resolver. 88 * If somebody wants to build and use a resolver that doesn't use IRS, 89 * what do they do? Perhaps something like 90 * #ifdef WANT_IRS 91 * # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 92 * #else 93 * # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x)) 94 * #endif 95 */ 96 97 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 98 struct __res_state; /* forward */ 99 __BEGIN_DECLS 100 void __h_errno_set(struct __res_state *, int); 101 __END_DECLS 102 103 /* 104 * Resolver configuration file. 105 * Normally not present, but may contain the address of the 106 * initial name server(s) to query and the domain search list. 107 */ 108 109 #ifndef _PATH_RESCONF 110 #define _PATH_RESCONF "/etc/resolv.conf" 111 #endif 112 113 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error } 114 res_sendhookact; 115 116 #ifndef __PMT 117 #if defined(__STDC__) || defined(__cplusplus) 118 #define __PMT(args) args 119 #else 120 #define __PMT(args) () 121 #endif 122 #endif 123 124 typedef res_sendhookact (*res_send_qhook)__PMT((struct sockaddr * const *, 125 const u_char **, int *, 126 u_char *, int, int *)); 127 128 typedef res_sendhookact (*res_send_rhook)__PMT((const struct sockaddr *, 129 const u_char *, int, u_char *, 130 int, int *)); 131 132 struct res_sym { 133 int number; /* Identifying number, like T_MX */ 134 const char * name; /* Its symbolic name, like "MX" */ 135 const char * humanname; /* Its fun name, like "mail exchanger" */ 136 }; 137 138 /* 139 * Global defines and variables for resolver stub. 140 */ 141 #define MAXNS 3 /* max # name servers we'll track */ 142 #define MAXDFLSRCH 3 /* # default domain levels to try */ 143 #define MAXDNSRCH 6 /* max # domains in search path */ 144 #define LOCALDOMAINPARTS 2 /* min levels in name that is "local" */ 145 146 #define RES_TIMEOUT 5 /* min. seconds between retries */ 147 #define MAXRESOLVSORT 10 /* number of net to sort on */ 148 #define RES_MAXNDOTS 15 /* should reflect bit field size */ 149 #define RES_MAXRETRANS 30 /* only for resolv.conf/RES_OPTIONS */ 150 #define RES_MAXRETRY 5 /* only for resolv.conf/RES_OPTIONS */ 151 #define RES_DFLRETRY 2 /* Default #/tries. */ 152 #define RES_MAXTIME 65535 /* Infinity, in milliseconds. */ 153 154 struct __res_state_ext; 155 156 struct __res_state { 157 int retrans; /* retransmission time interval */ 158 int retry; /* number of times to retransmit */ 159 #ifdef sun 160 u_int options; /* option flags - see below. */ 161 #else 162 u_long options; /* option flags - see below. */ 163 #endif 164 int nscount; /* number of name servers */ 165 struct sockaddr_in 166 nsaddr_list[MAXNS]; /* address of name server */ 167 #define nsaddr nsaddr_list[0] /* for backward compatibility */ 168 u_short id; /* current message id */ 169 char *dnsrch[MAXDNSRCH+1]; /* components of domain to search */ 170 char defdname[256]; /* default domain (deprecated) */ 171 #ifdef sun 172 u_int pfcode; /* RES_PRF_ flags - see below. */ 173 #else 174 u_long pfcode; /* RES_PRF_ flags - see below. */ 175 #endif 176 unsigned ndots:4; /* threshold for initial abs. query */ 177 unsigned nsort:4; /* number of elements in sort_list[] */ 178 char unused[3]; 179 struct { 180 struct in_addr addr; 181 u_int32_t mask; 182 } sort_list[MAXRESOLVSORT]; 183 res_send_qhook qhook; /* query hook */ 184 res_send_rhook rhook; /* response hook */ 185 int res_h_errno; /* last one set for this context */ 186 int _vcsock; /* PRIVATE: for res_send VC i/o */ 187 u_int _flags; /* PRIVATE: see below */ 188 u_int _pad; /* make _u 64 bit aligned */ 189 union { 190 /* On an 32-bit arch this means 512b total. */ 191 char pad[72 - 4*sizeof (int) - 2*sizeof (void *)]; 192 struct { 193 u_int16_t nscount; 194 u_int16_t nstimes[MAXNS]; /* ms. */ 195 int nssocks[MAXNS]; 196 struct __res_state_ext *ext; /* extention for IPv6 */ 197 } _ext; 198 } _u; 199 }; 200 201 typedef struct __res_state *res_state; 202 203 union res_sockaddr_union { 204 struct sockaddr_in sin; 205 #ifdef IN6ADDR_ANY_INIT 206 struct sockaddr_in6 sin6; 207 #endif 208 #ifdef ISC_ALIGN64 209 int64_t __align64; /* 64bit alignment */ 210 #else 211 int32_t __align32; /* 32bit alignment */ 212 #endif 213 char __space[128]; /* max size */ 214 }; 215 216 /* 217 * Resolver flags (used to be discrete per-module statics ints). 218 */ 219 #define RES_F_VC 0x00000001 /* socket is TCP */ 220 #define RES_F_CONN 0x00000002 /* socket is connected */ 221 #define RES_F_EDNS0ERR 0x00000004 /* EDNS0 caused errors */ 222 #define RES_F__UNUSED 0x00000008 /* (unused) */ 223 #define RES_F_LASTMASK 0x000000F0 /* ordinal server of last res_nsend */ 224 #define RES_F_LASTSHIFT 4 /* bit position of LASTMASK "flag" */ 225 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT) 226 227 /* res_findzonecut2() options */ 228 #define RES_EXHAUSTIVE 0x00000001 /* always do all queries */ 229 #define RES_IPV4ONLY 0x00000002 /* IPv4 only */ 230 #define RES_IPV6ONLY 0x00000004 /* IPv6 only */ 231 232 /* 233 * Resolver options (keep these in synch with res_debug.c, please) 234 */ 235 #define RES_INIT 0x00000001 /* address initialized */ 236 #define RES_DEBUG 0x00000002 /* print debug messages */ 237 #define RES_AAONLY 0x00000004 /* authoritative answers only (!IMPL)*/ 238 #define RES_USEVC 0x00000008 /* use virtual circuit */ 239 #define RES_PRIMARY 0x00000010 /* query primary server only (!IMPL) */ 240 #define RES_IGNTC 0x00000020 /* ignore trucation errors */ 241 #define RES_RECURSE 0x00000040 /* recursion desired */ 242 #define RES_DEFNAMES 0x00000080 /* use default domain name */ 243 #define RES_STAYOPEN 0x00000100 /* Keep TCP socket open */ 244 #define RES_DNSRCH 0x00000200 /* search up local domain tree */ 245 #define RES_INSECURE1 0x00000400 /* type 1 security disabled */ 246 #define RES_INSECURE2 0x00000800 /* type 2 security disabled */ 247 #define RES_NOALIASES 0x00001000 /* shuts off HOSTALIASES feature */ 248 #define RES_USE_INET6 0x00002000 /* use/map IPv6 in gethostbyname() */ 249 #define RES_ROTATE 0x00004000 /* rotate ns list after each query */ 250 #define RES_NOCHECKNAME 0x00008000 /* do not check names for sanity. */ 251 #define RES_KEEPTSIG 0x00010000 /* do not strip TSIG records */ 252 #define RES_BLAST 0x00020000 /* blast all recursive servers */ 253 #define RES_NOTLDQUERY 0x00100000 /* don't unqualified name as a tld */ 254 #define RES_USE_DNSSEC 0x00200000 /* use DNSSEC using OK bit in OPT */ 255 /* KAME extensions: use higher bit to avoid conflict with ISC use */ 256 #define RES_USE_DNAME 0x10000000 /* use DNAME */ 257 #define RES_USE_EDNS0 0x40000000 /* use EDNS0 if configured */ 258 #define RES_NO_NIBBLE2 0x80000000 /* disable alternate nibble lookup */ 259 260 #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | \ 261 RES_DNSRCH | RES_NO_NIBBLE2) 262 263 /* 264 * Resolver "pfcode" values. Used by dig. 265 */ 266 #define RES_PRF_STATS 0x00000001 267 #define RES_PRF_UPDATE 0x00000002 268 #define RES_PRF_CLASS 0x00000004 269 #define RES_PRF_CMD 0x00000008 270 #define RES_PRF_QUES 0x00000010 271 #define RES_PRF_ANS 0x00000020 272 #define RES_PRF_AUTH 0x00000040 273 #define RES_PRF_ADD 0x00000080 274 #define RES_PRF_HEAD1 0x00000100 275 #define RES_PRF_HEAD2 0x00000200 276 #define RES_PRF_TTLID 0x00000400 277 #define RES_PRF_HEADX 0x00000800 278 #define RES_PRF_QUERY 0x00001000 279 #define RES_PRF_REPLY 0x00002000 280 #define RES_PRF_INIT 0x00004000 281 #define RES_PRF_TRUNC 0x00008000 282 /* 0x00010000 */ 283 284 /* Things involving an internal (static) resolver context. */ 285 __BEGIN_DECLS 286 extern struct __res_state *__res_get_state(void); 287 extern void __res_put_state(struct __res_state *); 288 289 /* 290 * Source and Binary compatibility; _res will not work properly 291 * with multi-threaded programs. 292 */ 293 extern struct __res_state *__res_state(void); 294 #define _res (*__res_state()) 295 296 __END_DECLS 297 298 #ifndef __BIND_NOSTATIC 299 #define fp_nquery __fp_nquery 300 #define fp_query __fp_query 301 #define hostalias __hostalias 302 #define p_query __p_query 303 #define res_close __res_close 304 #define res_opt __res_opt 305 #define res_isourserver __res_isourserver 306 #define res_querydomain __res_querydomain 307 #define res_send __res_send 308 #define res_sendsigned __res_sendsigned 309 310 #ifdef BIND_RES_POSIX3 311 #define dn_expand __dn_expand 312 #define res_init __res_init 313 #define res_query __res_query 314 #define res_search __res_search 315 #define res_mkquery __res_mkquery 316 #endif 317 318 __BEGIN_DECLS 319 void fp_nquery __P((const u_char *, int, FILE *)); 320 void fp_query __P((const u_char *, FILE *)); 321 const char * hostalias __P((const char *)); 322 void p_query __P((const u_char *)); 323 void res_close __P((void)); 324 int res_init __P((void)); 325 int res_opt __P((int, u_char *, int, int)); 326 int res_isourserver __P((const struct sockaddr_in *)); 327 int res_mkquery __P((int, const char *, int, int, const u_char *, 328 int, const u_char *, u_char *, int)); 329 int res_query __P((const char *, int, int, u_char *, int)); 330 int res_querydomain __P((const char *, const char *, int, int, 331 u_char *, int)); 332 int res_search __P((const char *, int, int, u_char *, int)); 333 int res_send __P((const u_char *, int, u_char *, int)); 334 int res_sendsigned __P((const u_char *, int, ns_tsig_key *, 335 u_char *, int)); 336 __END_DECLS 337 #endif 338 339 #if !defined(SHARED_LIBBIND) || defined(LIB) 340 /* 341 * If libbind is a shared object (well, DLL anyway) 342 * these externs break the linker when resolv.h is 343 * included by a lib client (like named) 344 * Make them go away if a client is including this 345 * 346 */ 347 extern const struct res_sym __p_key_syms[]; 348 extern const struct res_sym __p_cert_syms[]; 349 extern const struct res_sym __p_class_syms[]; 350 extern const struct res_sym __p_type_syms[]; 351 extern const struct res_sym __p_rcode_syms[]; 352 #endif /* SHARED_LIBBIND */ 353 354 #define b64_ntop __b64_ntop 355 #define b64_pton __b64_pton 356 #define dn_comp __dn_comp 357 #define dn_count_labels __dn_count_labels 358 #define dn_skipname __dn_skipname 359 #define fp_resstat __fp_resstat 360 #define loc_aton __loc_aton 361 #define loc_ntoa __loc_ntoa 362 #define p_cdname __p_cdname 363 #define p_cdnname __p_cdnname 364 #define p_class __p_class 365 #define p_fqname __p_fqname 366 #define p_fqnname __p_fqnname 367 #define p_option __p_option 368 #define p_secstodate __p_secstodate 369 #define p_section __p_section 370 #define p_time __p_time 371 #define p_type __p_type 372 #define p_rcode __p_rcode 373 #define p_sockun __p_sockun 374 #define putlong __putlong 375 #define putshort __putshort 376 #define res_dnok __res_dnok 377 #define res_findzonecut __res_findzonecut 378 #define res_findzonecut2 __res_findzonecut2 379 #define res_hnok __res_hnok 380 #define res_hostalias __res_hostalias 381 #define res_mailok __res_mailok 382 #define res_nameinquery __res_nameinquery 383 #define res_nclose __res_nclose 384 #define res_ninit __res_ninit 385 #define res_nmkquery __res_nmkquery 386 #define res_pquery __res_pquery 387 #define res_nquery __res_nquery 388 #define res_nquerydomain __res_nquerydomain 389 #define res_nsearch __res_nsearch 390 #define res_nsend __res_nsend 391 #define res_nsendsigned __res_nsendsigned 392 #define res_nisourserver __res_nisourserver 393 #define res_ownok __res_ownok 394 #define res_queriesmatch __res_queriesmatch 395 #define res_randomid __res_randomid 396 #define sym_ntop __sym_ntop 397 #define sym_ntos __sym_ntos 398 #define sym_ston __sym_ston 399 #define res_nopt __res_nopt 400 #define res_ndestroy __res_ndestroy 401 #define res_nametoclass __res_nametoclass 402 #define res_nametotype __res_nametotype 403 #define res_setservers __res_setservers 404 #define res_getservers __res_getservers 405 #define res_buildprotolist __res_buildprotolist 406 #define res_destroyprotolist __res_destroyprotolist 407 #define res_destroyservicelist __res_destroyservicelist 408 #define res_get_nibblesuffix __res_get_nibblesuffix 409 #define res_get_nibblesuffix2 __res_get_nibblesuffix2 410 #define res_ourserver_p __res_ourserver_p 411 #define res_protocolname __res_protocolname 412 #define res_protocolnumber __res_protocolnumber 413 #define res_send_setqhook __res_send_setqhook 414 #define res_send_setrhook __res_send_setrhook 415 #define res_servicename __res_servicename 416 #define res_servicenumber __res_servicenumber 417 __BEGIN_DECLS 418 int res_hnok __P((const char *)); 419 int res_ownok __P((const char *)); 420 int res_mailok __P((const char *)); 421 int res_dnok __P((const char *)); 422 int sym_ston __P((const struct res_sym *, const char *, int *)); 423 const char * sym_ntos __P((const struct res_sym *, int, int *)); 424 const char * sym_ntop __P((const struct res_sym *, int, int *)); 425 int b64_ntop __P((u_char const *, size_t, char *, size_t)); 426 int b64_pton __P((char const *, u_char *, size_t)); 427 int loc_aton __P((const char *, u_char *)); 428 const char * loc_ntoa __P((const u_char *, char *)); 429 int dn_skipname __P((const u_char *, const u_char *)); 430 void putlong __P((u_int32_t, u_char *)); 431 void putshort __P((u_int16_t, u_char *)); 432 #ifndef __ultrix__ 433 u_int16_t _getshort __P((const u_char *)); 434 u_int32_t _getlong __P((const u_char *)); 435 #endif 436 const char * p_class __P((int)); 437 const char * p_time __P((u_int32_t)); 438 const char * p_type __P((int)); 439 const char * p_rcode __P((int)); 440 const char * p_sockun __P((union res_sockaddr_union, char *, size_t)); 441 const u_char * p_cdnname __P((const u_char *, const u_char *, int, FILE *)); 442 const u_char * p_cdname __P((const u_char *, const u_char *, FILE *)); 443 const u_char * p_fqnname __P((const u_char *, const u_char *, 444 int, char *, int)); 445 const u_char * p_fqname __P((const u_char *, const u_char *, FILE *)); 446 const char * p_option __P((u_long)); 447 char * p_secstodate __P((u_long)); 448 int dn_count_labels __P((const char *)); 449 int dn_comp __P((const char *, u_char *, int, 450 u_char **, u_char **)); 451 int dn_expand __P((const u_char *, const u_char *, const u_char *, 452 char *, int)); 453 u_int res_randomid __P((void)); 454 int res_nameinquery __P((const char *, int, int, const u_char *, 455 const u_char *)); 456 int res_queriesmatch __P((const u_char *, const u_char *, 457 const u_char *, const u_char *)); 458 const char * p_section __P((int, int)); 459 /* Things involving a resolver context. */ 460 int res_ninit __P((res_state)); 461 int res_nisourserver __P((const res_state, 462 const struct sockaddr_in *)); 463 void fp_resstat __P((const res_state, FILE *)); 464 void res_pquery __P((const res_state, const u_char *, int, FILE *)); 465 const char * res_hostalias __P((const res_state, const char *, 466 char *, size_t)); 467 int res_nquery __P((res_state, const char *, int, int, 468 u_char *, int)); 469 int res_nsearch __P((res_state, const char *, int, int, u_char *, 470 int)); 471 int res_nquerydomain __P((res_state, const char *, const char *, 472 int, int, u_char *, int)); 473 int res_nmkquery __P((res_state, int, const char *, int, int, 474 const u_char *, int, const u_char *, 475 u_char *, int)); 476 int res_nsend __P((res_state, const u_char *, int, u_char *, int)); 477 int res_nsendsigned __P((res_state, const u_char *, int, 478 ns_tsig_key *, u_char *, int)); 479 int res_findzonecut __P((res_state, const char *, ns_class, int, 480 char *, size_t, struct in_addr *, int)); 481 int res_findzonecut2 __P((res_state, const char *, ns_class, int, 482 char *, size_t, 483 union res_sockaddr_union *, int)); 484 void res_nclose __P((res_state)); 485 int res_nopt __P((res_state, int, u_char *, int, int)); 486 void res_send_setqhook __P((res_send_qhook)); 487 void res_send_setrhook __P((res_send_rhook)); 488 int __res_vinit __P((res_state, int)); 489 void res_destroyservicelist __P((void)); 490 const char * res_servicename __P((u_int16_t, const char *)); 491 const char * res_protocolname __P((int)); 492 void res_destroyprotolist __P((void)); 493 void res_buildprotolist __P((void)); 494 const char * res_get_nibblesuffix __P((res_state)); 495 const char * res_get_nibblesuffix2 __P((res_state)); 496 void res_ndestroy __P((res_state)); 497 u_int16_t res_nametoclass __P((const char *, int *)); 498 u_int16_t res_nametotype __P((const char *, int *)); 499 void res_setservers __P((res_state, 500 const union res_sockaddr_union *, int)); 501 int res_getservers __P((res_state, 502 union res_sockaddr_union *, int)); 503 __END_DECLS 504 505 #endif /* !_RESOLV_H_ */ 506