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