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