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