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 * Portions Copyright (c) 1996-1999 by Internet Software Consortium. 36 * 37 * Permission to use, copy, modify, and distribute this software for any 38 * purpose with or without fee is hereby granted, provided that the above 39 * copyright notice and this permission notice appear in all copies. 40 * 41 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS 42 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE 44 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 45 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 46 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS 47 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 48 * SOFTWARE. 49 */ 50 51 /* 52 * @(#)resolv.h 8.1 (Berkeley) 6/2/93 53 * $Id: resolv.h,v 1.6 2004/04/15 15:54:33 wkornew Exp $ 54 */ 55 56 #ifndef _RESOLV_H_ 57 #define _RESOLV_H_ 58 59 #include <sys/param.h> 60 #if (!defined(BSD)) || (BSD < 199306) 61 # include <sys/bitypes.h> 62 #else 63 # include <sys/types.h> 64 #endif 65 #include <sys/cdefs.h> 66 #include <sys/socket.h> 67 #include <stdio.h> 68 #include <arpa/nameser.h> 69 70 /* 71 * Revision information. This is the release date in YYYYMMDD format. 72 * It can change every day so the right thing to do with it is use it 73 * in preprocessor commands such as "#if (__RES > 19931104)". Do not 74 * compare for equality; rather, use it to determine whether your resolver 75 * is new enough to contain a certain feature. 76 */ 77 78 #define __RES 20030124 79 80 /* 81 * This used to be defined in res_query.c, now it's in herror.c. 82 * [XXX no it's not. It's in irs/irs_data.c] 83 * It was 84 * never extern'd by any *.h file before it was placed here. For thread 85 * aware programs, the last h_errno value set is stored in res->h_errno. 86 * 87 * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO 88 * (and __h_errno_set) to the public via <resolv.h>. 89 * XXX: __h_errno_set is really part of IRS, not part of the resolver. 90 * If somebody wants to build and use a resolver that doesn't use IRS, 91 * what do they do? Perhaps something like 92 * #ifdef WANT_IRS 93 * # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 94 * #else 95 * # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x)) 96 * #endif 97 */ 98 99 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 100 struct __res_state; /* forward */ 101 __BEGIN_DECLS 102 void __h_errno_set(struct __res_state *res, int err); 103 __END_DECLS 104 105 /* 106 * Resolver configuration file. 107 * Normally not present, but may contain the address of the 108 * initial name server(s) to query and the domain search list. 109 */ 110 111 #ifndef _PATH_RESCONF 112 #define _PATH_RESCONF "/etc/resolv.conf" 113 #endif 114 115 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error } 116 res_sendhookact; 117 118 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr * const *, 119 const u_char **, int *, 120 u_char *, int, int *)); 121 122 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr *, 123 const u_char *, int, u_char *, 124 int, int *)); 125 126 struct res_sym { 127 int number; /* Identifying number, like T_MX */ 128 const char * name; /* Its symbolic name, like "MX" */ 129 const char * humanname; /* Its fun name, like "mail exchanger" */ 130 }; 131 132 /* 133 * Global defines and variables for resolver stub. 134 */ 135 #define MAXNS 3 /* max # name servers we'll track */ 136 #define MAXDFLSRCH 3 /* # default domain levels to try */ 137 #define MAXDNSRCH 6 /* max # domains in search path */ 138 #define LOCALDOMAINPARTS 2 /* min levels in name that is "local" */ 139 140 #define RES_TIMEOUT 5 /* min. seconds between retries */ 141 #define MAXRESOLVSORT 10 /* number of net to sort on */ 142 #define RES_MAXNDOTS 15 /* should reflect bit field size */ 143 #define RES_MAXRETRANS 30 /* only for resolv.conf/RES_OPTIONS */ 144 #define RES_MAXRETRY 5 /* only for resolv.conf/RES_OPTIONS */ 145 #define RES_DFLRETRY 2 /* Default #/tries. */ 146 #define RES_MAXTIME 65535 /* Infinity, in milliseconds. */ 147 148 struct __res_state_ext; 149 150 struct __res_state { 151 int retrans; /* retransmission time interval */ 152 int retry; /* number of times to retransmit */ 153 #ifdef sun 154 u_int options; /* option flags - see below. */ 155 #else 156 u_long options; /* option flags - see below. */ 157 #endif 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 #ifdef sun 166 u_int pfcode; /* RES_PRF_ flags - see below. */ 167 #else 168 u_long pfcode; /* RES_PRF_ flags - see below. */ 169 #endif 170 unsigned ndots:4; /* threshold for initial abs. query */ 171 unsigned nsort:4; /* number of elements in sort_list[] */ 172 char unused[3]; 173 struct { 174 struct in_addr addr; 175 u_int32_t mask; 176 } sort_list[MAXRESOLVSORT]; 177 res_send_qhook qhook; /* query hook */ 178 res_send_rhook rhook; /* response hook */ 179 int res_h_errno; /* last one set for this context */ 180 int _vcsock; /* PRIVATE: for res_send VC i/o */ 181 u_int _flags; /* PRIVATE: see below */ 182 u_int _pad; /* make _u 64 bit aligned */ 183 union { 184 /* On an 32-bit arch this means 512b total. */ 185 char pad[72 - 4*sizeof (int) - 2*sizeof (void *)]; 186 struct { 187 u_int16_t nscount; 188 u_int16_t nstimes[MAXNS]; /* ms. */ 189 int nssocks[MAXNS]; 190 struct __res_state_ext *ext; /* extention for IPv6 */ 191 } _ext; 192 } _u; 193 }; 194 195 typedef struct __res_state *res_state; 196 197 union res_sockaddr_union { 198 struct sockaddr_in sin; 199 #ifdef IN6ADDR_ANY_INIT 200 struct sockaddr_in6 sin6; 201 #endif 202 #ifdef ISC_ALIGN64 203 int64_t __align64; /* 64bit alignment */ 204 #else 205 int32_t __align32; /* 32bit alignment */ 206 #endif 207 char __space[128]; /* max size */ 208 }; 209 210 /* 211 * Resolver flags (used to be discrete per-module statics ints). 212 */ 213 #define RES_F_VC 0x00000001 /* socket is TCP */ 214 #define RES_F_CONN 0x00000002 /* socket is connected */ 215 #define RES_F_EDNS0ERR 0x00000004 /* EDNS0 caused errors */ 216 #define RES_F__UNUSED 0x00000008 /* (unused) */ 217 #define RES_F_LASTMASK 0x000000F0 /* ordinal server of last res_nsend */ 218 #define RES_F_LASTSHIFT 4 /* bit position of LASTMASK "flag" */ 219 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT) 220 221 /* res_findzonecut2() options */ 222 #define RES_EXHAUSTIVE 0x00000001 /* always do all queries */ 223 #define RES_IPV4ONLY 0x00000002 /* IPv4 only */ 224 #define RES_IPV6ONLY 0x00000004 /* IPv6 only */ 225 226 /* 227 * Resolver options (keep these in synch with res_debug.c, please) 228 */ 229 #define RES_INIT 0x00000001 /* address initialized */ 230 #define RES_DEBUG 0x00000002 /* print debug messages */ 231 #define RES_AAONLY 0x00000004 /* authoritative answers only (!IMPL)*/ 232 #define RES_USEVC 0x00000008 /* use virtual circuit */ 233 #define RES_PRIMARY 0x00000010 /* query primary server only (!IMPL) */ 234 #define RES_IGNTC 0x00000020 /* ignore trucation errors */ 235 #define RES_RECURSE 0x00000040 /* recursion desired */ 236 #define RES_DEFNAMES 0x00000080 /* use default domain name */ 237 #define RES_STAYOPEN 0x00000100 /* Keep TCP socket open */ 238 #define RES_DNSRCH 0x00000200 /* search up local domain tree */ 239 #define RES_INSECURE1 0x00000400 /* type 1 security disabled */ 240 #define RES_INSECURE2 0x00000800 /* type 2 security disabled */ 241 #define RES_NOALIASES 0x00001000 /* shuts off HOSTALIASES feature */ 242 #define RES_USE_INET6 0x00002000 /* use/map IPv6 in gethostbyname() */ 243 #define RES_ROTATE 0x00004000 /* rotate ns list after each query */ 244 #define RES_NOCHECKNAME 0x00008000 /* do not check names for sanity. */ 245 #define RES_KEEPTSIG 0x00010000 /* do not strip TSIG records */ 246 #define RES_BLAST 0x00020000 /* blast all recursive servers */ 247 #define RES_NOTLDQUERY 0x00100000 /* don't unqualified name as a tld */ 248 #define RES_USE_DNSSEC 0x00200000 /* use DNSSEC using OK bit in OPT */ 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 | RES_DNSRCH) 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_query __res_query 293 #define res_querydomain __res_querydomain 294 #define res_search __res_search 295 #define res_send __res_send 296 #define res_sendsigned __res_sendsigned 297 298 __BEGIN_DECLS 299 void fp_nquery __P((const u_char *, int, FILE *)); 300 void fp_query __P((const u_char *, FILE *)); 301 const char * hostalias __P((const char *)); 302 void p_query __P((const u_char *)); 303 void res_close __P((void)); 304 int res_init __P((void)); 305 int res_isourserver __P((const struct sockaddr_in *)); 306 int res_mkquery __P((int, const char *, int, int, const u_char *, 307 int, const u_char *, u_char *, int)); 308 int res_query __P((const char *, int, int, u_char *, int)); 309 int res_querydomain __P((const char *, const char *, int, int, 310 u_char *, int)); 311 int res_search __P((const char *, int, int, u_char *, int)); 312 int res_send __P((const u_char *, int, u_char *, int)); 313 int res_sendsigned __P((const u_char *, int, ns_tsig_key *, 314 u_char *, int)); 315 __END_DECLS 316 #endif 317 318 #if !defined(SHARED_LIBBIND) || defined(LIB) 319 /* 320 * If libbind is a shared object (well, DLL anyway) 321 * these externs break the linker when resolv.h is 322 * included by a lib client (like named) 323 * Make them go away if a client is including this 324 * 325 */ 326 extern const struct res_sym __p_key_syms[]; 327 extern const struct res_sym __p_cert_syms[]; 328 extern const struct res_sym __p_class_syms[]; 329 extern const struct res_sym __p_type_syms[]; 330 extern const struct res_sym __p_rcode_syms[]; 331 #endif /* SHARED_LIBBIND */ 332 333 #define b64_ntop __b64_ntop 334 #define b64_pton __b64_pton 335 #define dn_comp __dn_comp 336 #define dn_count_labels __dn_count_labels 337 #define dn_expand __dn_expand 338 #define dn_skipname __dn_skipname 339 #define fp_resstat __fp_resstat 340 #define loc_aton __loc_aton 341 #define loc_ntoa __loc_ntoa 342 #define p_cdname __p_cdname 343 #define p_cdnname __p_cdnname 344 #define p_class __p_class 345 #define p_fqname __p_fqname 346 #define p_fqnname __p_fqnname 347 #define p_option __p_option 348 #define p_secstodate __p_secstodate 349 #define p_section __p_section 350 #define p_time __p_time 351 #define p_type __p_type 352 #define p_rcode __p_rcode 353 #define p_sockun __p_sockun 354 #define putlong __putlong 355 #define putshort __putshort 356 #define res_dnok __res_dnok 357 #define res_findzonecut __res_findzonecut 358 #define res_findzonecut2 __res_findzonecut2 359 #define res_hnok __res_hnok 360 #define res_hostalias __res_hostalias 361 #define res_mailok __res_mailok 362 #define res_nameinquery __res_nameinquery 363 #define res_nclose __res_nclose 364 #define res_ninit __res_ninit 365 #define res_nmkquery __res_nmkquery 366 #define res_pquery __res_pquery 367 #define res_nquery __res_nquery 368 #define res_nquerydomain __res_nquerydomain 369 #define res_nsearch __res_nsearch 370 #define res_nsend __res_nsend 371 #define res_nsendsigned __res_nsendsigned 372 #define res_nisourserver __res_nisourserver 373 #define res_ownok __res_ownok 374 #define res_queriesmatch __res_queriesmatch 375 #define res_randomid __res_randomid 376 #define sym_ntop __sym_ntop 377 #define sym_ntos __sym_ntos 378 #define sym_ston __sym_ston 379 #define res_nopt __res_nopt 380 #define res_ndestroy __res_ndestroy 381 #define res_nametoclass __res_nametoclass 382 #define res_nametotype __res_nametotype 383 #define res_setservers __res_setservers 384 #define res_getservers __res_getservers 385 #define res_buildprotolist __res_buildprotolist 386 #define res_destroyprotolist __res_destroyprotolist 387 #define res_destroyservicelist __res_destroyservicelist 388 #define res_get_nibblesuffix __res_get_nibblesuffix 389 #define res_get_nibblesuffix2 __res_get_nibblesuffix2 390 #define res_ourserver_p __res_ourserver_p 391 #define res_protocolname __res_protocolname 392 #define res_protocolnumber __res_protocolnumber 393 #define res_send_setqhook __res_send_setqhook 394 #define res_send_setrhook __res_send_setrhook 395 #define res_servicename __res_servicename 396 #define res_servicenumber __res_servicenumber 397 __BEGIN_DECLS 398 int res_hnok __P((const char *)); 399 int res_ownok __P((const char *)); 400 int res_mailok __P((const char *)); 401 int res_dnok __P((const char *)); 402 int sym_ston __P((const struct res_sym *, const char *, int *)); 403 const char * sym_ntos __P((const struct res_sym *, int, int *)); 404 const char * sym_ntop __P((const struct res_sym *, int, int *)); 405 int b64_ntop __P((u_char const *, size_t, char *, size_t)); 406 int b64_pton __P((char const *, u_char *, size_t)); 407 int loc_aton __P((const char *, u_char *)); 408 const char * loc_ntoa __P((const u_char *, char *)); 409 int dn_skipname __P((const u_char *, const u_char *)); 410 void putlong __P((u_int32_t, u_char *)); 411 void putshort __P((u_int16_t, u_char *)); 412 #ifndef __ultrix__ 413 u_int16_t _getshort __P((const u_char *)); 414 u_int32_t _getlong __P((const u_char *)); 415 #endif 416 const char * p_class __P((int)); 417 const char * p_time __P((u_int32_t)); 418 const char * p_type __P((int)); 419 const char * p_rcode __P((int)); 420 const char * p_sockun __P((union res_sockaddr_union, char *, size_t)); 421 const u_char * p_cdnname __P((const u_char *, const u_char *, int, FILE *)); 422 const u_char * p_cdname __P((const u_char *, const u_char *, FILE *)); 423 const u_char * p_fqnname __P((const u_char *, const u_char *, 424 int, char *, int)); 425 const u_char * p_fqname __P((const u_char *, const u_char *, FILE *)); 426 const char * p_option __P((u_long)); 427 char * p_secstodate __P((u_long)); 428 int dn_count_labels __P((const char *)); 429 int dn_comp __P((const char *, u_char *, int, 430 u_char **, u_char **)); 431 int dn_expand __P((const u_char *, const u_char *, const u_char *, 432 char *, int)); 433 u_int res_randomid __P((void)); 434 int res_nameinquery __P((const char *, int, int, const u_char *, 435 const u_char *)); 436 int res_queriesmatch __P((const u_char *, const u_char *, 437 const u_char *, const u_char *)); 438 const char * p_section __P((int, int)); 439 /* Things involving a resolver context. */ 440 int res_ninit __P((res_state)); 441 int res_nisourserver __P((const res_state, 442 const struct sockaddr_in *)); 443 void fp_resstat __P((const res_state, FILE *)); 444 void res_pquery __P((const res_state, const u_char *, int, FILE *)); 445 const char * res_hostalias __P((const res_state, const char *, 446 char *, size_t)); 447 int res_nquery __P((res_state, const char *, int, int, 448 u_char *, int)); 449 int res_nsearch __P((res_state, const char *, int, int, u_char *, 450 int)); 451 int res_nquerydomain __P((res_state, const char *, const char *, 452 int, int, u_char *, int)); 453 int res_nmkquery __P((res_state, int, const char *, int, int, 454 const u_char *, int, const u_char *, 455 u_char *, int)); 456 int res_nsend __P((res_state, const u_char *, int, u_char *, int)); 457 int res_nsendsigned __P((res_state, const u_char *, int, 458 ns_tsig_key *, u_char *, int)); 459 int res_findzonecut __P((res_state, const char *, ns_class, int, 460 char *, size_t, struct in_addr *, int)); 461 int res_findzonecut2 __P((res_state, const char *, ns_class, int, 462 char *, size_t, 463 union res_sockaddr_union *, int)); 464 void res_nclose __P((res_state)); 465 int res_nopt __P((res_state, int, u_char *, int, int)); 466 void res_send_setqhook __P((res_send_qhook)); 467 void res_send_setrhook __P((res_send_rhook)); 468 int __res_vinit __P((res_state, int)); 469 void res_destroyservicelist __P((void)); 470 const char * res_servicename __P((u_int16_t, const char *)); 471 const char * res_protocolname __P((int)); 472 void res_destroyprotolist __P((void)); 473 void res_buildprotolist __P((void)); 474 const char * res_get_nibblesuffix __P((res_state)); 475 const char * res_get_nibblesuffix2 __P((res_state)); 476 void res_ndestroy __P((res_state)); 477 u_int16_t res_nametoclass __P((const char *, int *)); 478 u_int16_t res_nametotype __P((const char *, int *)); 479 void res_setservers __P((res_state, 480 const union res_sockaddr_union *, int)); 481 int res_getservers __P((res_state, 482 union res_sockaddr_union *, int)); 483 __END_DECLS 484 485 #endif /* !_RESOLV_H_ */ 486