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_int _pad; /*%< make _u 64 bit aligned */ 180 union { 181 /* On an 32-bit arch this means 512b total. */ 182 char pad[72 - 4*sizeof (int) - 3*sizeof (void *)]; 183 struct { 184 u_int16_t nscount; 185 u_int16_t nstimes[MAXNS]; /*%< ms. */ 186 int nssocks[MAXNS]; 187 struct __res_state_ext *ext; /*%< extension for IPv6 */ 188 } _ext; 189 } _u; 190 u_char *_rnd; /*%< PRIVATE: random state */ 191 }; 192 193 typedef struct __res_state *res_state; 194 195 union res_sockaddr_union { 196 struct sockaddr_in sin; 197 #ifdef IN6ADDR_ANY_INIT 198 struct sockaddr_in6 sin6; 199 #endif 200 #ifdef ISC_ALIGN64 201 int64_t __align64; /*%< 64bit alignment */ 202 #else 203 int32_t __align32; /*%< 32bit alignment */ 204 #endif 205 char __space[128]; /*%< max size */ 206 }; 207 208 /*% 209 * Resolver flags (used to be discrete per-module statics ints). 210 */ 211 #define RES_F_VC 0x00000001 /*%< socket is TCP */ 212 #define RES_F_CONN 0x00000002 /*%< socket is connected */ 213 #define RES_F_EDNS0ERR 0x00000004 /*%< EDNS0 caused errors */ 214 #define RES_F__UNUSED 0x00000008 /*%< (unused) */ 215 #define RES_F_LASTMASK 0x000000F0 /*%< ordinal server of last res_nsend */ 216 #define RES_F_LASTSHIFT 4 /*%< bit position of LASTMASK "flag" */ 217 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT) 218 219 /* res_findzonecut2() options */ 220 #define RES_EXHAUSTIVE 0x00000001 /*%< always do all queries */ 221 #define RES_IPV4ONLY 0x00000002 /*%< IPv4 only */ 222 #define RES_IPV6ONLY 0x00000004 /*%< IPv6 only */ 223 224 /*% 225 * Resolver options (keep these in synch with res_debug.c, please) 226 */ 227 #define RES_INIT 0x00000001 /*%< address initialized */ 228 #define RES_DEBUG 0x00000002 /*%< print debug messages */ 229 #define RES_AAONLY 0x00000004 /*%< authoritative answers only (!IMPL)*/ 230 #define RES_USEVC 0x00000008 /*%< use virtual circuit */ 231 #define RES_PRIMARY 0x00000010 /*%< query primary server only (!IMPL) */ 232 #define RES_IGNTC 0x00000020 /*%< ignore truncation errors */ 233 #define RES_RECURSE 0x00000040 /*%< recursion desired */ 234 #define RES_DEFNAMES 0x00000080 /*%< use default domain name */ 235 #define RES_STAYOPEN 0x00000100 /*%< Keep TCP socket open */ 236 #define RES_DNSRCH 0x00000200 /*%< search up local domain tree */ 237 #define RES_INSECURE1 0x00000400 /*%< type 1 security disabled */ 238 #define RES_INSECURE2 0x00000800 /*%< type 2 security disabled */ 239 #define RES_NOALIASES 0x00001000 /*%< shuts off HOSTALIASES feature */ 240 #define RES_USE_INET6 0x00002000 /*%< use/map IPv6 in gethostbyname() */ 241 #define RES_ROTATE 0x00004000 /*%< rotate ns list after each query */ 242 #define RES_NOCHECKNAME 0x00008000 /*%< do not check names for sanity. */ 243 #define RES_KEEPTSIG 0x00010000 /*%< do not strip TSIG records */ 244 #define RES_BLAST 0x00020000 /*%< blast all recursive servers */ 245 #define RES_NSID 0x00040000 /*%< request name server ID */ 246 #define RES_NOTLDQUERY 0x00100000 /*%< don't unqualified name as a tld */ 247 #define RES_USE_DNSSEC 0x00200000 /*%< use DNSSEC using OK bit in OPT */ 248 /* #define RES_DEBUG2 0x00400000 */ /* nslookup internal */ 249 /* KAME extensions: use higher bit to avoid conflict with ISC use */ 250 #define RES_USE_DNAME 0x10000000 /*%< use DNAME */ 251 #define RES_USE_EDNS0 0x40000000 /*%< use EDNS0 if configured */ 252 #define RES_NO_NIBBLE2 0x80000000 /*%< disable alternate nibble lookup */ 253 254 #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | \ 255 RES_DNSRCH | RES_NO_NIBBLE2) 256 257 /*% 258 * Resolver "pfcode" values. Used by dig. 259 */ 260 #define RES_PRF_STATS 0x00000001 261 #define RES_PRF_UPDATE 0x00000002 262 #define RES_PRF_CLASS 0x00000004 263 #define RES_PRF_CMD 0x00000008 264 #define RES_PRF_QUES 0x00000010 265 #define RES_PRF_ANS 0x00000020 266 #define RES_PRF_AUTH 0x00000040 267 #define RES_PRF_ADD 0x00000080 268 #define RES_PRF_HEAD1 0x00000100 269 #define RES_PRF_HEAD2 0x00000200 270 #define RES_PRF_TTLID 0x00000400 271 #define RES_PRF_HEADX 0x00000800 272 #define RES_PRF_QUERY 0x00001000 273 #define RES_PRF_REPLY 0x00002000 274 #define RES_PRF_INIT 0x00004000 275 #define RES_PRF_TRUNC 0x00008000 276 /* 0x00010000 */ 277 278 /* Things involving an internal (static) resolver context. */ 279 __BEGIN_DECLS 280 extern struct __res_state *__res_state(void); 281 __END_DECLS 282 #define _res (*__res_state()) 283 284 #ifndef __BIND_NOSTATIC 285 #define fp_nquery __fp_nquery 286 #define fp_query __fp_query 287 #define hostalias __hostalias 288 #define p_query __p_query 289 #define res_close __res_close 290 #define res_init __res_init 291 #define res_isourserver __res_isourserver 292 #define res_mkquery __res_mkquery 293 #define res_opt __res_opt 294 #define res_query __res_query 295 #define res_querydomain __res_querydomain 296 #define res_search __res_search 297 #define res_send __res_send 298 #define res_sendsigned __res_sendsigned 299 300 __BEGIN_DECLS 301 void fp_nquery(const u_char *, int, FILE *); 302 void fp_query(const u_char *, FILE *); 303 const char * hostalias(const char *); 304 void p_query(const u_char *); 305 void res_close(void); 306 int res_init(void); 307 int res_isourserver(const struct sockaddr_in *); 308 int res_mkquery(int, const char *, int, int, const u_char *, 309 int, const u_char *, u_char *, int); 310 int res_opt(int, u_char *, int, int); 311 int res_query(const char *, int, int, u_char *, int); 312 int res_querydomain(const char *, const char *, int, int, 313 u_char *, int); 314 int res_search(const char *, int, int, u_char *, int); 315 int res_send(const u_char *, int, u_char *, int); 316 int res_sendsigned(const u_char *, int, ns_tsig_key *, 317 u_char *, int); 318 __END_DECLS 319 #endif 320 321 #if !defined(SHARED_LIBBIND) || defined(LIB) 322 /* 323 * If libbind is a shared object (well, DLL anyway) 324 * these externs break the linker when resolv.h is 325 * included by a lib client (like named) 326 * Make them go away if a client is including this 327 * 328 */ 329 extern const struct res_sym __p_key_syms[]; 330 extern const struct res_sym __p_cert_syms[]; 331 extern const struct res_sym __p_class_syms[]; 332 extern const struct res_sym __p_type_syms[]; 333 extern const struct res_sym __p_rcode_syms[]; 334 #endif /* SHARED_LIBBIND */ 335 336 #define b64_ntop __b64_ntop 337 #define b64_pton __b64_pton 338 #define dn_comp __dn_comp 339 #define dn_count_labels __dn_count_labels 340 #define dn_expand __dn_expand 341 #define dn_skipname __dn_skipname 342 #define fp_resstat __fp_resstat 343 #define loc_aton __loc_aton 344 #define loc_ntoa __loc_ntoa 345 #define p_cdname __p_cdname 346 #define p_cdnname __p_cdnname 347 #define p_class __p_class 348 #define p_fqname __p_fqname 349 #define p_fqnname __p_fqnname 350 #define p_option __p_option 351 #define p_secstodate __p_secstodate 352 #define p_section __p_section 353 #define p_time __p_time 354 #define p_type __p_type 355 #define p_rcode __p_rcode 356 #define p_sockun __p_sockun 357 #define putlong __putlong 358 #define putshort __putshort 359 #define res_dnok __res_dnok 360 #if 0 361 #define res_findzonecut __res_findzonecut 362 #endif 363 #define res_findzonecut2 __res_findzonecut2 364 #define res_hnok __res_hnok 365 #define res_hostalias __res_hostalias 366 #define res_mailok __res_mailok 367 #define res_nameinquery __res_nameinquery 368 #define res_nclose __res_nclose 369 #define res_ninit __res_ninit 370 #define res_nmkquery __res_nmkquery 371 #define res_pquery __res_pquery 372 #define res_nquery __res_nquery 373 #define res_nquerydomain __res_nquerydomain 374 #define res_nsearch __res_nsearch 375 #define res_nsend __res_nsend 376 #if 0 377 #define res_nsendsigned __res_nsendsigned 378 #endif 379 #define res_nisourserver __res_nisourserver 380 #define res_ownok __res_ownok 381 #define res_queriesmatch __res_queriesmatch 382 #define res_rndinit __res_rndinit 383 #define res_randomid __res_randomid 384 #define res_nrandomid __res_nrandomid 385 #define sym_ntop __sym_ntop 386 #define sym_ntos __sym_ntos 387 #define sym_ston __sym_ston 388 #define res_nopt __res_nopt 389 #define res_nopt_rdata __res_nopt_rdata 390 #define res_ndestroy __res_ndestroy 391 #define res_nametoclass __res_nametoclass 392 #define res_nametotype __res_nametotype 393 #define res_setservers __res_setservers 394 #define res_getservers __res_getservers 395 #if 0 396 #define res_buildprotolist __res_buildprotolist 397 #define res_destroyprotolist __res_destroyprotolist 398 #define res_destroyservicelist __res_destroyservicelist 399 #define res_get_nibblesuffix __res_get_nibblesuffix 400 #define res_get_nibblesuffix2 __res_get_nibblesuffix2 401 #endif 402 #define res_ourserver_p __res_ourserver_p 403 #if 0 404 #define res_protocolname __res_protocolname 405 #define res_protocolnumber __res_protocolnumber 406 #endif 407 #define res_send_setqhook __res_send_setqhook 408 #define res_send_setrhook __res_send_setrhook 409 #if 0 410 #define res_servicename __res_servicename 411 #define res_servicenumber __res_servicenumber 412 #endif 413 __BEGIN_DECLS 414 int res_hnok(const char *); 415 int res_ownok(const char *); 416 int res_mailok(const char *); 417 int res_dnok(const char *); 418 int sym_ston(const struct res_sym *, const char *, int *); 419 const char * sym_ntos(const struct res_sym *, int, int *); 420 const char * sym_ntop(const struct res_sym *, int, int *); 421 int b64_ntop(u_char const *, size_t, char *, size_t); 422 int b64_pton(char const *, u_char *, size_t); 423 int loc_aton(const char *, u_char *); 424 const char * loc_ntoa(const u_char *, char *); 425 int dn_skipname(const u_char *, const u_char *); 426 void putlong(u_int32_t, u_char *); 427 void putshort(u_int16_t, u_char *); 428 #ifndef __ultrix__ 429 u_int16_t _getshort(const u_char *); 430 u_int32_t _getlong(const u_char *); 431 #endif 432 const char * p_class(int); 433 const char * p_time(u_int32_t); 434 const char * p_type(int); 435 const char * p_rcode(int); 436 const char * p_sockun(union res_sockaddr_union, char *, size_t); 437 const u_char * p_cdnname(const u_char *, const u_char *, int, FILE *); 438 const u_char * p_cdname(const u_char *, const u_char *, FILE *); 439 const u_char * p_fqnname(const u_char *, const u_char *, int, char *, int); 440 const u_char * p_fqname(const u_char *, const u_char *, FILE *); 441 const char * p_option(u_long); 442 char * p_secstodate(u_long); 443 int dn_count_labels(const char *); 444 int dn_comp(const char *, u_char *, int, u_char **, u_char **); 445 int dn_expand(const u_char *, const u_char *, const u_char *, 446 char *, int); 447 void res_rndinit(res_state); 448 u_int res_randomid(void); 449 u_int res_nrandomid(res_state); 450 int res_nameinquery(const char *, int, int, const u_char *, 451 const u_char *); 452 int res_queriesmatch(const u_char *, const u_char *, 453 const u_char *, const u_char *); 454 const char * p_section(int, int); 455 /* Things involving a resolver context. */ 456 int res_ninit(res_state); 457 int res_nisourserver(const res_state, const struct sockaddr_in *); 458 void fp_resstat(const res_state, FILE *); 459 void res_pquery(const res_state, const u_char *, int, FILE *); 460 const char * res_hostalias(const res_state, const char *, char *, size_t); 461 int res_nquery(res_state, const char *, int, int, u_char *, int); 462 int res_nsearch(res_state, const char *, int, int, u_char *, int); 463 int res_nquerydomain(res_state, const char *, const char *, 464 int, int, u_char *, int); 465 int res_nmkquery(res_state, int, const char *, int, int, 466 const u_char *, int, const u_char *, 467 u_char *, int); 468 int res_nsend(res_state, const u_char *, int, u_char *, int); 469 #if 0 470 int res_nsendsigned(res_state, const u_char *, int, 471 ns_tsig_key *, u_char *, int); 472 int res_findzonecut(res_state, const char *, ns_class, int, 473 char *, size_t, struct in_addr *, int); 474 #endif 475 int res_findzonecut2(res_state, const char *, ns_class, int, 476 char *, size_t, 477 union res_sockaddr_union *, int); 478 void res_nclose(res_state); 479 int res_nopt(res_state, int, u_char *, int, int); 480 int res_nopt_rdata(res_state, int, u_char *, int, u_char *, 481 u_short, u_short, u_char *); 482 void res_send_setqhook(res_send_qhook); 483 void res_send_setrhook(res_send_rhook); 484 int __res_vinit(res_state, int); 485 #if 0 486 void res_destroyservicelist(void); 487 const char * res_servicename(u_int16_t, const char *); 488 const char * res_protocolname(int); 489 void res_destroyprotolist(void); 490 void res_buildprotolist(void); 491 const char * res_get_nibblesuffix(res_state); 492 const char * res_get_nibblesuffix2(res_state); 493 #endif 494 void res_ndestroy(res_state); 495 u_int16_t res_nametoclass(const char *, int *); 496 u_int16_t res_nametotype(const char *, int *); 497 void res_setservers(res_state, const union res_sockaddr_union *, 498 int); 499 int res_getservers(res_state, union res_sockaddr_union *, int); 500 __END_DECLS 501 502 #endif /* !_RESOLV_H_ */ 503 /*! \file */ 504