1 /* 2 * Copyright (c) 1983, 1987, 1989 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34 /* 35 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC") 36 * Portions Copyright (c) 1996-1999 by Internet Software Consortium. 37 * 38 * Permission to use, copy, modify, and distribute this software for any 39 * purpose with or without fee is hereby granted, provided that the above 40 * copyright notice and this permission notice appear in all copies. 41 * 42 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES 43 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 44 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR 45 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 46 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 47 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT 48 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 49 */ 50 51 /* 52 * @(#)resolv.h 8.1 (Berkeley) 6/2/93 53 * $Id$ 54 */ 55 56 #ifndef _RESOLV_H_ 57 #define _RESOLV_H_ 58 59 #include <sys/param.h> 60 #include <sys/types.h> 61 #include <sys/cdefs.h> 62 #include <sys/socket.h> 63 #include <stdio.h> 64 #include <arpa/nameser.h> 65 66 /* 67 * Revision information. This is the release date in YYYYMMDD format. 68 * It can change every day so the right thing to do with it is use it 69 * in preprocessor commands such as "#if (__RES > 19931104)". Do not 70 * compare for equality; rather, use it to determine whether your resolver 71 * is new enough to contain a certain feature. 72 */ 73 74 #define __RES 20030124 75 76 /* 77 * This used to be defined in res_query.c, now it's in herror.c. 78 * [XXX no it's not. It's in irs/irs_data.c] 79 * It was 80 * never extern'd by any *.h file before it was placed here. For thread 81 * aware programs, the last h_errno value set is stored in res->h_errno. 82 * 83 * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO 84 * (and __h_errno_set) to the public via <resolv.h>. 85 * XXX: __h_errno_set is really part of IRS, not part of the resolver. 86 * If somebody wants to build and use a resolver that doesn't use IRS, 87 * what do they do? Perhaps something like 88 * #ifdef WANT_IRS 89 * # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 90 * #else 91 * # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x)) 92 * #endif 93 */ 94 95 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 96 struct __res_state; /* forward */ 97 __BEGIN_DECLS 98 void __h_errno_set(struct __res_state *res, int err); 99 __END_DECLS 100 101 /* 102 * Resolver configuration file. 103 * Normally not present, but may contain the address of the 104 * initial name server(s) to query and the domain search list. 105 */ 106 107 #ifndef _PATH_RESCONF 108 #define _PATH_RESCONF "/etc/resolv.conf" 109 #endif 110 111 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error } 112 res_sendhookact; 113 114 #ifndef __PMT 115 #if defined(__STDC__) || defined(__cplusplus) 116 #define __PMT(args) args 117 #else 118 #define __PMT(args) () 119 #endif 120 #endif 121 122 typedef res_sendhookact (*res_send_qhook)__PMT((struct sockaddr * const *, 123 const u_char **, int *, 124 u_char *, int, int *)); 125 126 typedef res_sendhookact (*res_send_rhook)__PMT((const struct sockaddr *, 127 const u_char *, int, u_char *, 128 int, int *)); 129 130 struct res_sym { 131 int number; /* Identifying number, like T_MX */ 132 const char * name; /* Its symbolic name, like "MX" */ 133 const char * humanname; /* Its fun name, like "mail exchanger" */ 134 }; 135 136 /* 137 * Global defines and variables for resolver stub. 138 */ 139 #define MAXNS 3 /* max # name servers we'll track */ 140 #define MAXDFLSRCH 3 /* # default domain levels to try */ 141 #define MAXDNSRCH 6 /* max # domains in search path */ 142 #define LOCALDOMAINPARTS 2 /* min levels in name that is "local" */ 143 144 #define RES_TIMEOUT 5 /* min. seconds between retries */ 145 #define MAXRESOLVSORT 10 /* number of net to sort on */ 146 #define RES_MAXNDOTS 15 /* should reflect bit field size */ 147 #define RES_MAXRETRANS 30 /* only for resolv.conf/RES_OPTIONS */ 148 #define RES_MAXRETRY 5 /* only for resolv.conf/RES_OPTIONS */ 149 #define RES_DFLRETRY 2 /* Default #/tries. */ 150 #define RES_MAXTIME 65535 /* Infinity, in milliseconds. */ 151 152 struct __res_state_ext; 153 154 struct __res_state { 155 int retrans; /* retransmission time interval */ 156 int retry; /* number of times to retransmit */ 157 u_long options; /* option flags - see below. */ 158 int nscount; /* number of name servers */ 159 struct sockaddr_in 160 nsaddr_list[MAXNS]; /* address of name server */ 161 #define nsaddr nsaddr_list[0] /* for backward compatibility */ 162 u_short id; /* current message id */ 163 char *dnsrch[MAXDNSRCH+1]; /* components of domain to search */ 164 char defdname[256]; /* default domain (deprecated) */ 165 u_long pfcode; /* RES_PRF_ flags - see below. */ 166 unsigned ndots:4; /* threshold for initial abs. query */ 167 unsigned nsort:4; /* number of elements in sort_list[] */ 168 char unused[3]; 169 struct { 170 struct in_addr addr; 171 u_int32_t mask; 172 } sort_list[MAXRESOLVSORT]; 173 res_send_qhook qhook; /* query hook */ 174 res_send_rhook rhook; /* response hook */ 175 int res_h_errno; /* last one set for this context */ 176 int _vcsock; /* PRIVATE: for res_send VC i/o */ 177 u_int _flags; /* PRIVATE: see below */ 178 u_int _pad; /* make _u 64 bit aligned */ 179 union { 180 /* On an 32-bit arch this means 512b total. */ 181 char pad[72 - 4*sizeof (int) - 2*sizeof (void *)]; 182 struct { 183 u_int16_t nscount; 184 u_int16_t nstimes[MAXNS]; /* ms. */ 185 int nssocks[MAXNS]; 186 struct __res_state_ext *ext; /* extention for IPv6 */ 187 } _ext; 188 } _u; 189 }; 190 191 typedef struct __res_state *res_state; 192 193 union 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 277 extern struct __res_state *__res_state(void); 278 __END_DECLS 279 #define _res (*__res_state()) 280 281 #ifndef __BIND_NOSTATIC 282 #define fp_nquery __fp_nquery 283 #define fp_query __fp_query 284 #define hostalias __hostalias 285 #define p_query __p_query 286 #define res_close __res_close 287 #define res_init __res_init 288 #define res_isourserver __res_isourserver 289 #define res_mkquery __res_mkquery 290 #define res_query __res_query 291 #define res_querydomain __res_querydomain 292 #define res_search __res_search 293 #define res_send __res_send 294 #define res_sendsigned __res_sendsigned 295 296 __BEGIN_DECLS 297 void fp_nquery __P((const u_char *, int, FILE *)); 298 void fp_query __P((const u_char *, FILE *)); 299 const char * hostalias __P((const char *)); 300 void p_query __P((const u_char *)); 301 void res_close __P((void)); 302 int res_init __P((void)); 303 int res_isourserver __P((const struct sockaddr_in *)); 304 int res_mkquery __P((int, const char *, int, int, const u_char *, 305 int, const u_char *, u_char *, int)); 306 int res_query __P((const char *, int, int, u_char *, int)); 307 int res_querydomain __P((const char *, const char *, int, int, 308 u_char *, int)); 309 int res_search __P((const char *, int, int, u_char *, int)); 310 int res_send __P((const u_char *, int, u_char *, int)); 311 int res_sendsigned __P((const u_char *, int, ns_tsig_key *, 312 u_char *, int)); 313 __END_DECLS 314 #endif 315 316 /* 317 * If libbind is a shared object (well, DLL anyway) 318 * these externs break the linker when resolv.h is 319 * included by a lib client (like named) 320 * Make them go away if a client is including this 321 * 322 */ 323 extern const struct res_sym __p_key_syms[]; 324 extern const struct res_sym __p_cert_syms[]; 325 extern const struct res_sym __p_class_syms[]; 326 extern const struct res_sym __p_type_syms[]; 327 extern const struct res_sym __p_rcode_syms[]; 328 329 #define b64_ntop __b64_ntop 330 #define b64_pton __b64_pton 331 #define dn_comp __dn_comp 332 #define dn_count_labels __dn_count_labels 333 #define dn_expand __dn_expand 334 #define dn_skipname __dn_skipname 335 #define fp_resstat __fp_resstat 336 #define loc_aton __loc_aton 337 #define loc_ntoa __loc_ntoa 338 #define p_cdname __p_cdname 339 #define p_cdnname __p_cdnname 340 #define p_class __p_class 341 #define p_fqname __p_fqname 342 #define p_fqnname __p_fqnname 343 #define p_option __p_option 344 #define p_secstodate __p_secstodate 345 #define p_section __p_section 346 #define p_time __p_time 347 #define p_type __p_type 348 #define p_rcode __p_rcode 349 #define p_sockun __p_sockun 350 #define putlong __putlong 351 #define putshort __putshort 352 #define res_dnok __res_dnok 353 #define res_findzonecut __res_findzonecut 354 #define res_findzonecut2 __res_findzonecut2 355 #define res_hnok __res_hnok 356 #define res_hostalias __res_hostalias 357 #define res_mailok __res_mailok 358 #define res_nameinquery __res_nameinquery 359 #define res_nclose __res_nclose 360 #define res_ninit __res_ninit 361 #define res_nmkquery __res_nmkquery 362 #define res_pquery __res_pquery 363 #define res_nquery __res_nquery 364 #define res_nquerydomain __res_nquerydomain 365 #define res_nsearch __res_nsearch 366 #define res_nsend __res_nsend 367 #define res_nsendsigned __res_nsendsigned 368 #define res_nisourserver __res_nisourserver 369 #define res_ownok __res_ownok 370 #define res_queriesmatch __res_queriesmatch 371 #define res_randomid __res_randomid 372 #define sym_ntop __sym_ntop 373 #define sym_ntos __sym_ntos 374 #define sym_ston __sym_ston 375 #define res_nopt __res_nopt 376 #define res_ndestroy __res_ndestroy 377 #define res_nametoclass __res_nametoclass 378 #define res_nametotype __res_nametotype 379 #define res_setservers __res_setservers 380 #define res_getservers __res_getservers 381 #define res_buildprotolist __res_buildprotolist 382 #define res_destroyprotolist __res_destroyprotolist 383 #define res_destroyservicelist __res_destroyservicelist 384 #define res_get_nibblesuffix __res_get_nibblesuffix 385 #define res_get_nibblesuffix2 __res_get_nibblesuffix2 386 #define res_ourserver_p __res_ourserver_p 387 #define res_protocolname __res_protocolname 388 #define res_protocolnumber __res_protocolnumber 389 #define res_send_setqhook __res_send_setqhook 390 #define res_send_setrhook __res_send_setrhook 391 #define res_servicename __res_servicename 392 #define res_servicenumber __res_servicenumber 393 __BEGIN_DECLS 394 int res_hnok __P((const char *)); 395 int res_ownok __P((const char *)); 396 int res_mailok __P((const char *)); 397 int res_dnok __P((const char *)); 398 int sym_ston __P((const struct res_sym *, const char *, int *)); 399 const char * sym_ntos __P((const struct res_sym *, int, int *)); 400 const char * sym_ntop __P((const struct res_sym *, int, int *)); 401 int b64_ntop __P((u_char const *, size_t, char *, size_t)); 402 int b64_pton __P((char const *, u_char *, size_t)); 403 int loc_aton __P((const char *, u_char *)); 404 const char * loc_ntoa __P((const u_char *, char *)); 405 int dn_skipname __P((const u_char *, const u_char *)); 406 void putlong __P((u_int32_t, u_char *)); 407 void putshort __P((u_int16_t, u_char *)); 408 const char * p_class __P((int)); 409 const char * p_time __P((u_int32_t)); 410 const char * p_type __P((int)); 411 const char * p_rcode __P((int)); 412 const char * p_sockun __P((union res_sockaddr_union, char *, size_t)); 413 const u_char * p_cdnname __P((const u_char *, const u_char *, int, FILE *)); 414 const u_char * p_cdname __P((const u_char *, const u_char *, FILE *)); 415 const u_char * p_fqnname __P((const u_char *, const u_char *, 416 int, char *, int)); 417 const u_char * p_fqname __P((const u_char *, const u_char *, FILE *)); 418 const char * p_option __P((u_long)); 419 char * p_secstodate __P((u_long)); 420 int dn_count_labels __P((const char *)); 421 int dn_comp __P((const char *, u_char *, int, 422 u_char **, u_char **)); 423 int dn_expand __P((const u_char *, const u_char *, const u_char *, 424 char *, int)); 425 u_int res_randomid __P((void)); 426 int res_nameinquery __P((const char *, int, int, const u_char *, 427 const u_char *)); 428 int res_queriesmatch __P((const u_char *, const u_char *, 429 const u_char *, const u_char *)); 430 const char * p_section __P((int, int)); 431 /* Things involving a resolver context. */ 432 int res_ninit __P((res_state)); 433 int res_nisourserver __P((const res_state, 434 const struct sockaddr_in *)); 435 void fp_resstat __P((const res_state, FILE *)); 436 void res_pquery __P((const res_state, const u_char *, int, FILE *)); 437 const char * res_hostalias __P((const res_state, const char *, 438 char *, size_t)); 439 int res_nquery __P((res_state, const char *, int, int, 440 u_char *, int)); 441 int res_nsearch __P((res_state, const char *, int, int, u_char *, 442 int)); 443 int res_nquerydomain __P((res_state, const char *, const char *, 444 int, int, u_char *, int)); 445 int res_nmkquery __P((res_state, int, const char *, int, int, 446 const u_char *, int, const u_char *, 447 u_char *, int)); 448 int res_nsend __P((res_state, const u_char *, int, u_char *, int)); 449 int res_nsendsigned __P((res_state, const u_char *, int, 450 ns_tsig_key *, u_char *, int)); 451 int res_findzonecut __P((res_state, const char *, ns_class, int, 452 char *, size_t, struct in_addr *, int)); 453 int res_findzonecut2 __P((res_state, const char *, ns_class, int, 454 char *, size_t, 455 union res_sockaddr_union *, int)); 456 void res_nclose __P((res_state)); 457 int res_nopt __P((res_state, int, u_char *, int, int)); 458 void res_send_setqhook __P((res_send_qhook)); 459 void res_send_setrhook __P((res_send_rhook)); 460 int __res_vinit __P((res_state, int)); 461 void res_destroyservicelist __P((void)); 462 const char * res_servicename __P((u_int16_t, const char *)); 463 const char * res_protocolname __P((int)); 464 void res_destroyprotolist __P((void)); 465 void res_buildprotolist __P((void)); 466 const char * res_get_nibblesuffix __P((res_state)); 467 const char * res_get_nibblesuffix2 __P((res_state)); 468 void res_ndestroy __P((res_state)); 469 u_int16_t res_nametoclass __P((const char *, int *)); 470 u_int16_t res_nametotype __P((const char *, int *)); 471 void res_setservers __P((res_state, 472 const union res_sockaddr_union *, int)); 473 int res_getservers __P((res_state, 474 union res_sockaddr_union *, int)); 475 __END_DECLS 476 477 #endif /* !_RESOLV_H_ */ 478