1 /*- 2 * SPDX-License-Identifier: (ISC AND BSD-3-Clause) 3 * 4 * Portions Copyright (C) 2004, 2005, 2008, 2009 Internet Systems Consortium, Inc. ("ISC") 5 * Portions Copyright (C) 1995-2003 Internet Software Consortium. 6 * 7 * Permission to use, copy, modify, and/or distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 12 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 13 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 14 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 15 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 16 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17 * PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 /* 21 * Copyright (c) 1983, 1987, 1989 22 * The Regents of the University of California. All rights reserved. 23 * 24 * Redistribution and use in source and binary forms, with or without 25 * modification, are permitted provided that the following conditions 26 * are met: 27 * 1. Redistributions of source code must retain the above copyright 28 * notice, this list of conditions and the following disclaimer. 29 * 2. Redistributions in binary form must reproduce the above copyright 30 * notice, this list of conditions and the following disclaimer in the 31 * documentation and/or other materials provided with the distribution. 32 * 3. Neither the name of the University nor the names of its contributors 33 * may be used to endorse or promote products derived from this software 34 * without specific prior written permission. 35 * 36 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 37 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 39 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 40 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 41 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 42 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 44 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 45 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 46 * SUCH DAMAGE. 47 */ 48 49 /*% 50 * $Id: resolv.h,v 1.30 2009/03/03 01:52:48 each Exp $ 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 <netinet/in.h> 62 #include <arpa/nameser.h> 63 64 /*% 65 * Revision information. This is the release date in YYYYMMDD format. 66 * It can change every day so the right thing to do with it is use it 67 * in preprocessor commands such as "#if (__RES > 19931104)". Do not 68 * compare for equality; rather, use it to determine whether your resolver 69 * is new enough to contain a certain feature. 70 */ 71 72 #define __RES 20090302 73 74 /*% 75 * This used to be defined in res_query.c, now it's in herror.c. 76 * [XXX no it's not. It's in irs/irs_data.c] 77 * It was 78 * never extern'd by any *.h file before it was placed here. For thread 79 * aware programs, the last h_errno value set is stored in res->h_errno. 80 * 81 * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO 82 * (and __h_errno_set) to the public via <resolv.h>. 83 * XXX: __h_errno_set is really part of IRS, not part of the resolver. 84 * If somebody wants to build and use a resolver that doesn't use IRS, 85 * what do they do? Perhaps something like 86 * #ifdef WANT_IRS 87 * # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 88 * #else 89 * # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x)) 90 * #endif 91 */ 92 93 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x) 94 struct __res_state; /*%< forward */ 95 __BEGIN_DECLS 96 void __h_errno_set(struct __res_state *, int); 97 __END_DECLS 98 99 /*% 100 * Resolver configuration file. 101 * Normally not present, but may contain the address of the 102 * initial name server(s) to query and the domain search list. 103 */ 104 105 #ifndef _PATH_RESCONF 106 #define _PATH_RESCONF "/etc/resolv.conf" 107 #endif 108 109 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error } 110 res_sendhookact; 111 112 typedef res_sendhookact (*res_send_qhook)(struct sockaddr * const *, 113 const u_char **, int *, 114 u_char *, int, int *); 115 116 typedef res_sendhookact (*res_send_rhook)(const struct sockaddr *, 117 const u_char *, int, u_char *, 118 int, int *); 119 120 struct res_sym { 121 int number; /*%< Identifying number, like T_MX */ 122 const char * name; /*%< Its symbolic name, like "MX" */ 123 const char * humanname; /*%< Its fun name, like "mail exchanger" */ 124 }; 125 126 /*% 127 * Global defines and variables for resolver stub. 128 */ 129 #define MAXNS 3 /*%< max # name servers we'll track */ 130 #define MAXDFLSRCH 3 /*%< # default domain levels to try */ 131 #define MAXDNSRCH 6 /*%< max # domains in search path */ 132 #define LOCALDOMAINPARTS 2 /*%< min levels in name that is "local" */ 133 #define RES_TIMEOUT 5 /*%< min. seconds between retries */ 134 #define MAXRESOLVSORT 10 /*%< number of net to sort on */ 135 #define RES_MAXNDOTS 15 /*%< should reflect bit field size */ 136 #define RES_MAXRETRANS 30 /*%< only for resolv.conf/RES_OPTIONS */ 137 #define RES_MAXRETRY 5 /*%< only for resolv.conf/RES_OPTIONS */ 138 #define RES_DFLRETRY 2 /*%< Default #/tries. */ 139 #define RES_MAXTIME 65535 /*%< Infinity, in milliseconds. */ 140 struct __res_state_ext; 141 142 struct __res_state { 143 int retrans; /*%< retransmission time interval */ 144 int retry; /*%< number of times to retransmit */ 145 /* 146 * XXX: If `sun' is defined, `options' and `pfcode' are 147 * defined as u_int in original BIND9 distribution. However, 148 * it breaks binary backward compatibility against FreeBSD's 149 * resolver. So, we changed not to see `sun'. 150 */ 151 u_long options; /*%< option flags - see below. */ 152 int nscount; /*%< number of name servers */ 153 struct sockaddr_in 154 nsaddr_list[MAXNS]; /*%< address of name server */ 155 #define nsaddr nsaddr_list[0] /*%< for backward compatibility */ 156 u_short id; /*%< current message id */ 157 char *dnsrch[MAXDNSRCH+1]; /*%< components of domain to search */ 158 char defdname[256]; /*%< default domain (deprecated) */ 159 u_long pfcode; /*%< RES_PRF_ flags - see below. */ 160 unsigned ndots:4; /*%< threshold for initial abs. query */ 161 unsigned nsort:4; /*%< number of elements in sort_list[] */ 162 char unused[3]; 163 struct { 164 struct in_addr addr; 165 u_int32_t mask; 166 } sort_list[MAXRESOLVSORT]; 167 res_send_qhook qhook; /*%< query hook */ 168 res_send_rhook rhook; /*%< response hook */ 169 int res_h_errno; /*%< last one set for this context */ 170 int _vcsock; /*%< PRIVATE: for res_send VC i/o */ 171 u_int _flags; /*%< PRIVATE: see below */ 172 u_int _pad; /*%< make _u 64 bit aligned */ 173 union { 174 /* On an 32-bit arch this means 512b total. */ 175 char pad[72 - 4*sizeof (int) - 3*sizeof (void *)]; 176 struct { 177 u_int16_t nscount; 178 u_int16_t nstimes[MAXNS]; /*%< ms. */ 179 int nssocks[MAXNS]; 180 struct __res_state_ext *ext; /*%< extension for IPv6 */ 181 } _ext; 182 } _u; 183 u_char *_rnd; /*%< PRIVATE: random state (unused) */ 184 }; 185 186 typedef struct __res_state *res_state; 187 188 union res_sockaddr_union { 189 struct sockaddr_in sin; 190 struct sockaddr_in6 sin6; 191 #ifdef ISC_ALIGN64 192 int64_t __align64; /*%< 64bit alignment */ 193 #else 194 int32_t __align32; /*%< 32bit alignment */ 195 #endif 196 char __space[128]; /*%< max size */ 197 }; 198 199 /*% 200 * Resolver flags (used to be discrete per-module statics ints). 201 */ 202 #define RES_F_VC 0x00000001 /*%< socket is TCP */ 203 #define RES_F_CONN 0x00000002 /*%< socket is connected */ 204 #define RES_F_EDNS0ERR 0x00000004 /*%< EDNS0 caused errors */ 205 #define RES_F__UNUSED 0x00000008 /*%< (unused) */ 206 #define RES_F_LASTMASK 0x000000F0 /*%< ordinal server of last res_nsend */ 207 #define RES_F_LASTSHIFT 4 /*%< bit position of LASTMASK "flag" */ 208 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT) 209 210 /* res_findzonecut2() options */ 211 #define RES_EXHAUSTIVE 0x00000001 /*%< always do all queries */ 212 #define RES_IPV4ONLY 0x00000002 /*%< IPv4 only */ 213 #define RES_IPV6ONLY 0x00000004 /*%< IPv6 only */ 214 215 /*% 216 * Resolver options (keep these in synch with res_debug.c, please) 217 */ 218 #define RES_INIT 0x00000001 /*%< address initialized */ 219 #define RES_DEBUG 0x00000002 /*%< print debug messages */ 220 #define RES_AAONLY 0x00000004 /*%< authoritative answers only (!IMPL)*/ 221 #define RES_USEVC 0x00000008 /*%< use virtual circuit */ 222 #define RES_PRIMARY 0x00000010 /*%< query primary server only (!IMPL) */ 223 #define RES_IGNTC 0x00000020 /*%< ignore truncation errors */ 224 #define RES_RECURSE 0x00000040 /*%< recursion desired */ 225 #define RES_DEFNAMES 0x00000080 /*%< use default domain name */ 226 #define RES_STAYOPEN 0x00000100 /*%< Keep TCP socket open */ 227 #define RES_DNSRCH 0x00000200 /*%< search up local domain tree */ 228 #define RES_INSECURE1 0x00000400 /*%< type 1 security disabled */ 229 #define RES_INSECURE2 0x00000800 /*%< type 2 security disabled */ 230 #define RES_NOALIASES 0x00001000 /*%< shuts off HOSTALIASES feature */ 231 #define RES_USE_INET6 0x00002000 /*%< use/map IPv6 in gethostbyname() */ 232 #define RES_ROTATE 0x00004000 /*%< rotate ns list after each query */ 233 #define RES_NOCHECKNAME 0x00008000 /*%< do not check names for sanity. */ 234 #define RES_KEEPTSIG 0x00010000 /*%< do not strip TSIG records */ 235 #define RES_BLAST 0x00020000 /*%< blast all recursive servers */ 236 #define RES_NSID 0x00040000 /*%< request name server ID */ 237 #define RES_NOTLDQUERY 0x00100000 /*%< don't unqualified name as a tld */ 238 #define RES_USE_DNSSEC 0x00200000 /*%< use DNSSEC using OK bit in OPT */ 239 /* #define RES_DEBUG2 0x00400000 */ /* nslookup internal */ 240 /* KAME extensions: use higher bit to avoid conflict with ISC use */ 241 #define RES_USE_DNAME 0x10000000 /*%< use DNAME */ 242 #define RES_USE_EDNS0 0x40000000 /*%< use EDNS0 if configured */ 243 #define RES_NO_NIBBLE2 0x80000000 /*%< disable alternate nibble lookup */ 244 245 #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | \ 246 RES_DNSRCH | RES_NO_NIBBLE2) 247 248 /*% 249 * Resolver "pfcode" values. Used by dig. 250 */ 251 #define RES_PRF_STATS 0x00000001 252 #define RES_PRF_UPDATE 0x00000002 253 #define RES_PRF_CLASS 0x00000004 254 #define RES_PRF_CMD 0x00000008 255 #define RES_PRF_QUES 0x00000010 256 #define RES_PRF_ANS 0x00000020 257 #define RES_PRF_AUTH 0x00000040 258 #define RES_PRF_ADD 0x00000080 259 #define RES_PRF_HEAD1 0x00000100 260 #define RES_PRF_HEAD2 0x00000200 261 #define RES_PRF_TTLID 0x00000400 262 #define RES_PRF_HEADX 0x00000800 263 #define RES_PRF_QUERY 0x00001000 264 #define RES_PRF_REPLY 0x00002000 265 #define RES_PRF_INIT 0x00004000 266 #define RES_PRF_TRUNC 0x00008000 267 /* 0x00010000 */ 268 269 /* Things involving an internal (static) resolver context. */ 270 __BEGIN_DECLS 271 extern struct __res_state *__res_state(void); 272 __END_DECLS 273 #define _res (*__res_state()) 274 275 #ifndef __BIND_NOSTATIC 276 #define fp_nquery __fp_nquery 277 #define fp_query __fp_query 278 #define hostalias __hostalias 279 #define p_query __p_query 280 #define res_close __res_close 281 #define res_init __res_init 282 #define res_isourserver __res_isourserver 283 #define res_mkquery __res_mkquery 284 #define res_opt __res_opt 285 #define res_query __res_query 286 #define res_querydomain __res_querydomain 287 #define res_search __res_search 288 #define res_send __res_send 289 #define res_sendsigned __res_sendsigned 290 291 __BEGIN_DECLS 292 void fp_nquery(const u_char *, int, FILE *); 293 void fp_query(const u_char *, FILE *); 294 const char * hostalias(const char *); 295 void p_query(const u_char *); 296 void res_close(void); 297 int res_init(void); 298 int res_isourserver(const struct sockaddr_in *); 299 int res_mkquery(int, const char *, int, int, const u_char *, 300 int, const u_char *, u_char *, int); 301 int res_opt(int, u_char *, int, int); 302 int res_query(const char *, int, int, u_char *, int); 303 int res_querydomain(const char *, const char *, int, int, 304 u_char *, int); 305 int res_search(const char *, int, int, u_char *, int); 306 int res_send(const u_char *, int, u_char *, int); 307 int res_sendsigned(const u_char *, int, ns_tsig_key *, 308 u_char *, int); 309 __END_DECLS 310 #endif 311 312 #if !defined(SHARED_LIBBIND) || defined(LIB) 313 /* 314 * If libbind is a shared object (well, DLL anyway) 315 * these externs break the linker when resolv.h is 316 * included by a lib client (like named) 317 * Make them go away if a client is including this 318 * 319 */ 320 extern const struct res_sym __p_key_syms[]; 321 extern const struct res_sym __p_cert_syms[]; 322 extern const struct res_sym __p_class_syms[]; 323 extern const struct res_sym __p_type_syms[]; 324 extern const struct res_sym __p_rcode_syms[]; 325 #endif /* SHARED_LIBBIND */ 326 327 #define b64_ntop __b64_ntop 328 #define b64_pton __b64_pton 329 #define dn_comp __dn_comp 330 #define dn_count_labels __dn_count_labels 331 #define dn_expand __dn_expand 332 #define dn_skipname __dn_skipname 333 #define fp_resstat __fp_resstat 334 #define loc_aton __loc_aton 335 #define loc_ntoa __loc_ntoa 336 #define p_cdname __p_cdname 337 #define p_cdnname __p_cdnname 338 #define p_class __p_class 339 #define p_fqname __p_fqname 340 #define p_fqnname __p_fqnname 341 #define p_option __p_option 342 #define p_secstodate __p_secstodate 343 #define p_section __p_section 344 #define p_time __p_time 345 #define p_type __p_type 346 #define p_rcode __p_rcode 347 #define p_sockun __p_sockun 348 #define putlong __putlong 349 #define putshort __putshort 350 #define res_dnok __res_dnok 351 #define res_findzonecut2 __res_findzonecut2 352 #define res_hnok __res_hnok 353 #define res_hostalias __res_hostalias 354 #define res_mailok __res_mailok 355 #define res_nameinquery __res_nameinquery 356 #define res_nclose __res_nclose 357 #define res_ninit __res_ninit 358 #define res_nmkquery __res_nmkquery 359 #define res_pquery __res_pquery 360 #define res_nquery __res_nquery 361 #define res_nquerydomain __res_nquerydomain 362 #define res_nsearch __res_nsearch 363 #define res_nsend __res_nsend 364 #define res_nisourserver __res_nisourserver 365 #define res_ownok __res_ownok 366 #define res_queriesmatch __res_queriesmatch 367 #define res_randomid __res_randomid 368 #define res_nrandomid __res_nrandomid 369 #define sym_ntop __sym_ntop 370 #define sym_ntos __sym_ntos 371 #define sym_ston __sym_ston 372 #define res_nopt __res_nopt 373 #define res_nopt_rdata __res_nopt_rdata 374 #define res_ndestroy __res_ndestroy 375 #define res_nametoclass __res_nametoclass 376 #define res_nametotype __res_nametotype 377 #define res_setservers __res_setservers 378 #define res_getservers __res_getservers 379 #define res_ourserver_p __res_ourserver_p 380 #define res_send_setqhook __res_send_setqhook 381 #define res_send_setrhook __res_send_setrhook 382 __BEGIN_DECLS 383 int res_hnok(const char *); 384 int res_ownok(const char *); 385 int res_mailok(const char *); 386 int res_dnok(const char *); 387 int sym_ston(const struct res_sym *, const char *, int *); 388 const char * sym_ntos(const struct res_sym *, int, int *); 389 const char * sym_ntop(const struct res_sym *, int, int *); 390 int b64_ntop(u_char const *, size_t, char *, size_t); 391 int b64_pton(char const *, u_char *, size_t); 392 int loc_aton(const char *, u_char *); 393 const char * loc_ntoa(const u_char *, char *); 394 int dn_skipname(const u_char *, const u_char *); 395 void putlong(u_int32_t, u_char *); 396 void putshort(u_int16_t, u_char *); 397 u_int16_t _getshort(const u_char *); 398 u_int32_t _getlong(const u_char *); 399 const char * p_class(int); 400 const char * p_time(u_int32_t); 401 const char * p_type(int); 402 const char * p_rcode(int); 403 const char * p_sockun(union res_sockaddr_union, char *, size_t); 404 const u_char * p_cdnname(const u_char *, const u_char *, int, FILE *); 405 const u_char * p_cdname(const u_char *, const u_char *, FILE *); 406 const u_char * p_fqnname(const u_char *, const u_char *, int, char *, int); 407 const u_char * p_fqname(const u_char *, const u_char *, FILE *); 408 const char * p_option(u_long); 409 char * p_secstodate(u_long); 410 int dn_count_labels(const char *); 411 int dn_comp(const char *, u_char *, int, u_char **, u_char **); 412 int dn_expand(const u_char *, const u_char *, const u_char *, 413 char *, int); 414 u_int res_randomid(void); 415 u_int res_nrandomid(res_state); 416 int res_nameinquery(const char *, int, int, const u_char *, 417 const u_char *); 418 int res_queriesmatch(const u_char *, const u_char *, 419 const u_char *, const u_char *); 420 const char * p_section(int, int); 421 /* Things involving a resolver context. */ 422 int res_ninit(res_state); 423 int res_nisourserver(const res_state, const struct sockaddr_in *); 424 void fp_resstat(const res_state, FILE *); 425 void res_pquery(const res_state, const u_char *, int, FILE *); 426 const char * res_hostalias(const res_state, const char *, char *, size_t); 427 int res_nquery(res_state, const char *, int, int, u_char *, int); 428 int res_nsearch(res_state, const char *, int, int, u_char *, int); 429 int res_nquerydomain(res_state, const char *, const char *, 430 int, int, u_char *, int); 431 int res_nmkquery(res_state, int, const char *, int, int, 432 const u_char *, int, const u_char *, 433 u_char *, int); 434 int res_nsend(res_state, const u_char *, int, u_char *, int); 435 int res_findzonecut2(res_state, const char *, ns_class, int, 436 char *, size_t, 437 union res_sockaddr_union *, int); 438 void res_nclose(res_state); 439 int res_nopt(res_state, int, u_char *, int, int); 440 int res_nopt_rdata(res_state, int, u_char *, int, u_char *, 441 u_short, u_short, u_char *); 442 void res_send_setqhook(res_send_qhook); 443 void res_send_setrhook(res_send_rhook); 444 int __res_vinit(res_state, int); 445 void res_ndestroy(res_state); 446 u_int16_t res_nametoclass(const char *, int *); 447 u_int16_t res_nametotype(const char *, int *); 448 void res_setservers(res_state, const union res_sockaddr_union *, 449 int); 450 int res_getservers(res_state, union res_sockaddr_union *, int); 451 __END_DECLS 452 453 #endif /* !_RESOLV_H_ */ 454