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. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 /* 31 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC") 32 * Portions Copyright (c) 1996-1999 by Internet Software Consortium. 33 * 34 * Permission to use, copy, modify, and distribute this software for any 35 * purpose with or without fee is hereby granted, provided that the above 36 * copyright notice and this permission notice appear in all copies. 37 * 38 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES 39 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 40 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR 41 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 42 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 43 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT 44 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 45 */ 46 47 /*% 48 * @(#)resolv.h 8.1 (Berkeley) 6/2/93 49 * $Id: resolv.h,v 1.19.18.4 2008/04/03 23:15:15 marka 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 20030124 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) - 2*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 }; 191 192 typedef struct __res_state *res_state; 193 194 union res_sockaddr_union { 195 struct sockaddr_in sin; 196 #ifdef IN6ADDR_ANY_INIT 197 struct sockaddr_in6 sin6; 198 #endif 199 #ifdef ISC_ALIGN64 200 int64_t __align64; /*%< 64bit alignment */ 201 #else 202 int32_t __align32; /*%< 32bit alignment */ 203 #endif 204 char __space[128]; /*%< max size */ 205 }; 206 207 /*% 208 * Resolver flags (used to be discrete per-module statics ints). 209 */ 210 #define RES_F_VC 0x00000001 /*%< socket is TCP */ 211 #define RES_F_CONN 0x00000002 /*%< socket is connected */ 212 #define RES_F_EDNS0ERR 0x00000004 /*%< EDNS0 caused errors */ 213 #define RES_F__UNUSED 0x00000008 /*%< (unused) */ 214 #define RES_F_LASTMASK 0x000000F0 /*%< ordinal server of last res_nsend */ 215 #define RES_F_LASTSHIFT 4 /*%< bit position of LASTMASK "flag" */ 216 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT) 217 218 /* res_findzonecut2() options */ 219 #define RES_EXHAUSTIVE 0x00000001 /*%< always do all queries */ 220 #define RES_IPV4ONLY 0x00000002 /*%< IPv4 only */ 221 #define RES_IPV6ONLY 0x00000004 /*%< IPv6 only */ 222 223 /*% 224 * Resolver options (keep these in synch with res_debug.c, please) 225 */ 226 #define RES_INIT 0x00000001 /*%< address initialized */ 227 #define RES_DEBUG 0x00000002 /*%< print debug messages */ 228 #define RES_AAONLY 0x00000004 /*%< authoritative answers only (!IMPL)*/ 229 #define RES_USEVC 0x00000008 /*%< use virtual circuit */ 230 #define RES_PRIMARY 0x00000010 /*%< query primary server only (!IMPL) */ 231 #define RES_IGNTC 0x00000020 /*%< ignore truncation errors */ 232 #define RES_RECURSE 0x00000040 /*%< recursion desired */ 233 #define RES_DEFNAMES 0x00000080 /*%< use default domain name */ 234 #define RES_STAYOPEN 0x00000100 /*%< Keep TCP socket open */ 235 #define RES_DNSRCH 0x00000200 /*%< search up local domain tree */ 236 #define RES_INSECURE1 0x00000400 /*%< type 1 security disabled */ 237 #define RES_INSECURE2 0x00000800 /*%< type 2 security disabled */ 238 #define RES_NOALIASES 0x00001000 /*%< shuts off HOSTALIASES feature */ 239 #define RES_USE_INET6 0x00002000 /*%< use/map IPv6 in gethostbyname() */ 240 #define RES_ROTATE 0x00004000 /*%< rotate ns list after each query */ 241 #define RES_NOCHECKNAME 0x00008000 /*%< do not check names for sanity. */ 242 #define RES_KEEPTSIG 0x00010000 /*%< do not strip TSIG records */ 243 #define RES_BLAST 0x00020000 /*%< blast all recursive servers */ 244 #define RES_NSID 0x00040000 /*%< request name server ID */ 245 #define RES_NOTLDQUERY 0x00100000 /*%< don't unqualified name as a tld */ 246 #define RES_USE_DNSSEC 0x00200000 /*%< use DNSSEC using OK bit in OPT */ 247 /* #define RES_DEBUG2 0x00400000 */ /* nslookup internal */ 248 /* KAME extensions: use higher bit to avoid conflict with ISC use */ 249 #define RES_USE_DNAME 0x10000000 /*%< use DNAME */ 250 #define RES_USE_EDNS0 0x40000000 /*%< use EDNS0 if configured */ 251 #define RES_NO_NIBBLE2 0x80000000 /*%< disable alternate nibble lookup */ 252 253 #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | \ 254 RES_DNSRCH | RES_NO_NIBBLE2) 255 256 /*% 257 * Resolver "pfcode" values. Used by dig. 258 */ 259 #define RES_PRF_STATS 0x00000001 260 #define RES_PRF_UPDATE 0x00000002 261 #define RES_PRF_CLASS 0x00000004 262 #define RES_PRF_CMD 0x00000008 263 #define RES_PRF_QUES 0x00000010 264 #define RES_PRF_ANS 0x00000020 265 #define RES_PRF_AUTH 0x00000040 266 #define RES_PRF_ADD 0x00000080 267 #define RES_PRF_HEAD1 0x00000100 268 #define RES_PRF_HEAD2 0x00000200 269 #define RES_PRF_TTLID 0x00000400 270 #define RES_PRF_HEADX 0x00000800 271 #define RES_PRF_QUERY 0x00001000 272 #define RES_PRF_REPLY 0x00002000 273 #define RES_PRF_INIT 0x00004000 274 #define RES_PRF_TRUNC 0x00008000 275 /* 0x00010000 */ 276 277 /* Things involving an internal (static) resolver context. */ 278 __BEGIN_DECLS 279 extern struct __res_state *__res_state(void); 280 __END_DECLS 281 #define _res (*__res_state()) 282 283 #ifndef __BIND_NOSTATIC 284 #define fp_nquery __fp_nquery 285 #define fp_query __fp_query 286 #define hostalias __hostalias 287 #define p_query __p_query 288 #define res_close __res_close 289 #define res_init __res_init 290 #define res_isourserver __res_isourserver 291 #define res_mkquery __res_mkquery 292 #define res_opt __res_opt 293 #define res_query __res_query 294 #define res_querydomain __res_querydomain 295 #define res_search __res_search 296 #define res_send __res_send 297 #define res_sendsigned __res_sendsigned 298 299 __BEGIN_DECLS 300 void fp_nquery(const u_char *, int, FILE *); 301 void fp_query(const u_char *, FILE *); 302 const char * hostalias(const char *); 303 void p_query(const u_char *); 304 void res_close(void); 305 int res_init(void); 306 int res_isourserver(const struct sockaddr_in *); 307 int res_mkquery(int, const char *, int, int, const u_char *, 308 int, const u_char *, u_char *, int); 309 int res_opt(int, u_char *, int, int); 310 int res_query(const char *, int, int, u_char *, int); 311 int res_querydomain(const char *, const char *, int, int, 312 u_char *, int); 313 int res_search(const char *, int, int, u_char *, int); 314 int res_send(const u_char *, int, u_char *, int); 315 int res_sendsigned(const u_char *, int, ns_tsig_key *, 316 u_char *, int); 317 __END_DECLS 318 #endif 319 320 #if !defined(SHARED_LIBBIND) || defined(LIB) 321 /* 322 * If libbind is a shared object (well, DLL anyway) 323 * these externs break the linker when resolv.h is 324 * included by a lib client (like named) 325 * Make them go away if a client is including this 326 * 327 */ 328 extern const struct res_sym __p_key_syms[]; 329 extern const struct res_sym __p_cert_syms[]; 330 extern const struct res_sym __p_class_syms[]; 331 extern const struct res_sym __p_type_syms[]; 332 extern const struct res_sym __p_rcode_syms[]; 333 #endif /* SHARED_LIBBIND */ 334 335 #define b64_ntop __b64_ntop 336 #define b64_pton __b64_pton 337 #define dn_comp __dn_comp 338 #define dn_count_labels __dn_count_labels 339 #define dn_expand __dn_expand 340 #define dn_skipname __dn_skipname 341 #define fp_resstat __fp_resstat 342 #define loc_aton __loc_aton 343 #define loc_ntoa __loc_ntoa 344 #define p_cdname __p_cdname 345 #define p_cdnname __p_cdnname 346 #define p_class __p_class 347 #define p_fqname __p_fqname 348 #define p_fqnname __p_fqnname 349 #define p_option __p_option 350 #define p_secstodate __p_secstodate 351 #define p_section __p_section 352 #define p_time __p_time 353 #define p_type __p_type 354 #define p_rcode __p_rcode 355 #define p_sockun __p_sockun 356 #define putlong __putlong 357 #define putshort __putshort 358 #define res_dnok __res_dnok 359 #if 0 360 #define res_findzonecut __res_findzonecut 361 #endif 362 #define res_findzonecut2 __res_findzonecut2 363 #define res_hnok __res_hnok 364 #define res_hostalias __res_hostalias 365 #define res_mailok __res_mailok 366 #define res_nameinquery __res_nameinquery 367 #define res_nclose __res_nclose 368 #define res_ninit __res_ninit 369 #define res_nmkquery __res_nmkquery 370 #define res_pquery __res_pquery 371 #define res_nquery __res_nquery 372 #define res_nquerydomain __res_nquerydomain 373 #define res_nsearch __res_nsearch 374 #define res_nsend __res_nsend 375 #if 0 376 #define res_nsendsigned __res_nsendsigned 377 #endif 378 #define res_nisourserver __res_nisourserver 379 #define res_ownok __res_ownok 380 #define res_queriesmatch __res_queriesmatch 381 #define res_randomid __res_randomid 382 #define sym_ntop __sym_ntop 383 #define sym_ntos __sym_ntos 384 #define sym_ston __sym_ston 385 #define res_nopt __res_nopt 386 #define res_nopt_rdata __res_nopt_rdata 387 #define res_ndestroy __res_ndestroy 388 #define res_nametoclass __res_nametoclass 389 #define res_nametotype __res_nametotype 390 #define res_setservers __res_setservers 391 #define res_getservers __res_getservers 392 #if 0 393 #define res_buildprotolist __res_buildprotolist 394 #define res_destroyprotolist __res_destroyprotolist 395 #define res_destroyservicelist __res_destroyservicelist 396 #define res_get_nibblesuffix __res_get_nibblesuffix 397 #define res_get_nibblesuffix2 __res_get_nibblesuffix2 398 #endif 399 #define res_ourserver_p __res_ourserver_p 400 #if 0 401 #define res_protocolname __res_protocolname 402 #define res_protocolnumber __res_protocolnumber 403 #endif 404 #define res_send_setqhook __res_send_setqhook 405 #define res_send_setrhook __res_send_setrhook 406 #if 0 407 #define res_servicename __res_servicename 408 #define res_servicenumber __res_servicenumber 409 #endif 410 __BEGIN_DECLS 411 int res_hnok(const char *); 412 int res_ownok(const char *); 413 int res_mailok(const char *); 414 int res_dnok(const char *); 415 int sym_ston(const struct res_sym *, const char *, int *); 416 const char * sym_ntos(const struct res_sym *, int, int *); 417 const char * sym_ntop(const struct res_sym *, int, int *); 418 int b64_ntop(u_char const *, size_t, char *, size_t); 419 int b64_pton(char const *, u_char *, size_t); 420 int loc_aton(const char *, u_char *); 421 const char * loc_ntoa(const u_char *, char *); 422 int dn_skipname(const u_char *, const u_char *); 423 void putlong(u_int32_t, u_char *); 424 void putshort(u_int16_t, u_char *); 425 #ifndef __ultrix__ 426 u_int16_t _getshort(const u_char *); 427 u_int32_t _getlong(const u_char *); 428 #endif 429 const char * p_class(int); 430 const char * p_time(u_int32_t); 431 const char * p_type(int); 432 const char * p_rcode(int); 433 const char * p_sockun(union res_sockaddr_union, char *, size_t); 434 const u_char * p_cdnname(const u_char *, const u_char *, int, FILE *); 435 const u_char * p_cdname(const u_char *, const u_char *, FILE *); 436 const u_char * p_fqnname(const u_char *, const u_char *, int, char *, int); 437 const u_char * p_fqname(const u_char *, const u_char *, FILE *); 438 const char * p_option(u_long); 439 char * p_secstodate(u_long); 440 int dn_count_labels(const char *); 441 int dn_comp(const char *, u_char *, int, u_char **, u_char **); 442 int dn_expand(const u_char *, const u_char *, const u_char *, 443 char *, int); 444 u_int res_randomid(void); 445 int res_nameinquery(const char *, int, int, const u_char *, 446 const u_char *); 447 int res_queriesmatch(const u_char *, const u_char *, 448 const u_char *, const u_char *); 449 const char * p_section(int, int); 450 /* Things involving a resolver context. */ 451 int res_ninit(res_state); 452 int res_nisourserver(const res_state, const struct sockaddr_in *); 453 void fp_resstat(const res_state, FILE *); 454 void res_pquery(const res_state, const u_char *, int, FILE *); 455 const char * res_hostalias(const res_state, const char *, char *, size_t); 456 int res_nquery(res_state, const char *, int, int, u_char *, int); 457 int res_nsearch(res_state, const char *, int, int, u_char *, int); 458 int res_nquerydomain(res_state, const char *, const char *, 459 int, int, u_char *, int); 460 int res_nmkquery(res_state, int, const char *, int, int, 461 const u_char *, int, const u_char *, 462 u_char *, int); 463 int res_nsend(res_state, const u_char *, int, u_char *, int); 464 #if 0 465 int res_nsendsigned(res_state, const u_char *, int, 466 ns_tsig_key *, u_char *, int); 467 int res_findzonecut(res_state, const char *, ns_class, int, 468 char *, size_t, struct in_addr *, int); 469 #endif 470 int res_findzonecut2(res_state, const char *, ns_class, int, 471 char *, size_t, 472 union res_sockaddr_union *, int); 473 void res_nclose(res_state); 474 int res_nopt(res_state, int, u_char *, int, int); 475 int res_nopt_rdata(res_state, int, u_char *, int, u_char *, 476 u_short, u_short, u_char *); 477 void res_send_setqhook(res_send_qhook); 478 void res_send_setrhook(res_send_rhook); 479 int __res_vinit(res_state, int); 480 #if 0 481 void res_destroyservicelist(void); 482 const char * res_servicename(u_int16_t, const char *); 483 const char * res_protocolname(int); 484 void res_destroyprotolist(void); 485 void res_buildprotolist(void); 486 const char * res_get_nibblesuffix(res_state); 487 const char * res_get_nibblesuffix2(res_state); 488 #endif 489 void res_ndestroy(res_state); 490 u_int16_t res_nametoclass(const char *, int *); 491 u_int16_t res_nametotype(const char *, int *); 492 void res_setservers(res_state, const union res_sockaddr_union *, 493 int); 494 int res_getservers(res_state, union res_sockaddr_union *, int); 495 __END_DECLS 496 497 #endif /* !_RESOLV_H_ */ 498 /*! \file */ 499