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