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