4 * Portions Copyright (C) 2004, 2005, 2008, 2009 Internet Systems Consortium, Inc. ("ISC")
5 * Portions Copyright (C) 1995-2003 Internet Software Consortium.
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.
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.
21 * Copyright (c) 1983, 1987, 1989
22 * The Regents of the University of California. All rights reserved.
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
33 * must display the following acknowledgement:
34 * This product includes software developed by the University of
35 * California, Berkeley and its contributors.
36 * 4. Neither the name of the University nor the names of its contributors
37 * may be used to endorse or promote products derived from this software
38 * without specific prior written permission.
40 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * @(#)resolv.h 8.1 (Berkeley) 6/2/93
55 * Id: resolv.h,v 1.30 2009/03/03 01:52:48 each Exp
61 #include <sys/param.h>
62 #if (!defined(BSD)) || (BSD < 199306)
63 # include <sys/bitypes.h>
65 # include <sys/types.h>
67 #include <sys/cdefs.h>
68 #include <sys/socket.h>
70 #include <arpa/nameser.h>
73 * Revision information. This is the release date in YYYYMMDD format.
74 * It can change every day so the right thing to do with it is use it
75 * in preprocessor commands such as "#if (__RES > 19931104)". Do not
76 * compare for equality; rather, use it to determine whether your resolver
77 * is new enough to contain a certain feature.
80 #define __RES 20090302
83 * This used to be defined in res_query.c, now it's in herror.c.
84 * [XXX no it's not. It's in irs/irs_data.c]
86 * never extern'd by any *.h file before it was placed here. For thread
87 * aware programs, the last h_errno value set is stored in res->h_errno.
89 * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO
90 * (and __h_errno_set) to the public via <resolv.h>.
91 * XXX: __h_errno_set is really part of IRS, not part of the resolver.
92 * If somebody wants to build and use a resolver that doesn't use IRS,
93 * what do they do? Perhaps something like
95 * # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
97 * # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
101 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
102 struct __res_state
; /*%< forward */
104 void __h_errno_set(struct __res_state
*res
, int err
);
108 * Resolver configuration file.
109 * Normally not present, but may contain the address of the
110 * initial name server(s) to query and the domain search list.
113 #ifndef _PATH_RESCONF
114 #define _PATH_RESCONF "/etc/resolv.conf"
117 typedef enum { res_goahead
, res_nextns
, res_modified
, res_done
, res_error
}
121 #if defined(__STDC__) || defined(__cplusplus)
122 #define __PMT(args) args
124 #define __PMT(args) ()
128 typedef res_sendhookact (*res_send_qhook
)__PMT((struct sockaddr
* const *,
129 const u_char
**, int *,
130 u_char
*, int, int *));
132 typedef res_sendhookact (*res_send_rhook
)__PMT((const struct sockaddr
*,
133 const u_char
*, int, u_char
*,
137 int number
; /*%< Identifying number, like T_MX */
138 const char * name
; /*%< Its symbolic name, like "MX" */
139 const char * humanname
; /*%< Its fun name, like "mail exchanger" */
143 * Global defines and variables for resolver stub.
145 #define MAXNS 3 /*%< max # name servers we'll track */
146 #define MAXDFLSRCH 3 /*%< # default domain levels to try */
147 #define MAXDNSRCH 6 /*%< max # domains in search path */
148 #define LOCALDOMAINPARTS 2 /*%< min levels in name that is "local" */
149 #define RES_TIMEOUT 5 /*%< min. seconds between retries */
150 #define MAXRESOLVSORT 10 /*%< number of net to sort on */
151 #define RES_MAXNDOTS 15 /*%< should reflect bit field size */
152 #define RES_MAXRETRANS 30 /*%< only for resolv.conf/RES_OPTIONS */
153 #define RES_MAXRETRY 5 /*%< only for resolv.conf/RES_OPTIONS */
154 #define RES_DFLRETRY 2 /*%< Default #/tries. */
155 #define RES_MAXTIME 65535 /*%< Infinity, in milliseconds. */
156 struct __res_state_ext
;
159 int retrans
; /*%< retransmission time interval */
160 int retry
; /*%< number of times to retransmit */
162 u_int options
; /*%< option flags - see below. */
164 u_long options
; /*%< option flags - see below. */
166 int nscount
; /*%< number of name servers */
168 nsaddr_list
[MAXNS
]; /*%< address of name server */
169 #define nsaddr nsaddr_list[0] /*%< for backward compatibility */
170 u_short id
; /*%< current message id */
171 char *dnsrch
[MAXDNSRCH
+1]; /*%< components of domain to search */
172 char defdname
[256]; /*%< default domain (deprecated) */
174 u_int pfcode
; /*%< RES_PRF_ flags - see below. */
176 u_long pfcode
; /*%< RES_PRF_ flags - see below. */
178 unsigned ndots
:4; /*%< threshold for initial abs. query */
179 unsigned nsort
:4; /*%< number of elements in sort_list[] */
184 } sort_list
[MAXRESOLVSORT
];
185 res_send_qhook qhook
; /*%< query hook */
186 res_send_rhook rhook
; /*%< response hook */
187 int res_h_errno
; /*%< last one set for this context */
188 int _vcsock
; /*%< PRIVATE: for res_send VC i/o */
189 u_int _flags
; /*%< PRIVATE: see below */
190 u_char _rnd
[16]; /*%< PRIVATE: random state */
191 u_int _pad
; /*%< make _u 64 bit aligned */
193 /* On an 32-bit arch this means 512b total. */
194 char pad
[56 - 4*sizeof (int) - 2*sizeof (void *)];
197 u_int16_t nstimes
[MAXNS
]; /*%< ms. */
199 struct __res_state_ext
*ext
; /*%< extention for IPv6 */
204 typedef struct __res_state
*res_state
;
206 union res_sockaddr_union
{
207 struct sockaddr_in sin
;
208 #ifdef IN6ADDR_ANY_INIT
209 struct sockaddr_in6 sin6
;
212 int64_t __align64
; /*%< 64bit alignment */
214 int32_t __align32
; /*%< 32bit alignment */
216 char __space
[128]; /*%< max size */
220 * Resolver flags (used to be discrete per-module statics ints).
222 #define RES_F_VC 0x00000001 /*%< socket is TCP */
223 #define RES_F_CONN 0x00000002 /*%< socket is connected */
224 #define RES_F_EDNS0ERR 0x00000004 /*%< EDNS0 caused errors */
225 #define RES_F__UNUSED 0x00000008 /*%< (unused) */
226 #define RES_F_LASTMASK 0x000000F0 /*%< ordinal server of last res_nsend */
227 #define RES_F_LASTSHIFT 4 /*%< bit position of LASTMASK "flag" */
228 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT)
230 /* res_findzonecut2() options */
231 #define RES_EXHAUSTIVE 0x00000001 /*%< always do all queries */
232 #define RES_IPV4ONLY 0x00000002 /*%< IPv4 only */
233 #define RES_IPV6ONLY 0x00000004 /*%< IPv6 only */
236 * Resolver options (keep these in synch with res_debug.c, please)
238 #define RES_INIT 0x00000001 /*%< address initialized */
239 #define RES_DEBUG 0x00000002 /*%< print debug messages */
240 #define RES_AAONLY 0x00000004 /*%< authoritative answers only (!IMPL)*/
241 #define RES_USEVC 0x00000008 /*%< use virtual circuit */
242 #define RES_PRIMARY 0x00000010 /*%< query primary server only (!IMPL) */
243 #define RES_IGNTC 0x00000020 /*%< ignore trucation errors */
244 #define RES_RECURSE 0x00000040 /*%< recursion desired */
245 #define RES_DEFNAMES 0x00000080 /*%< use default domain name */
246 #define RES_STAYOPEN 0x00000100 /*%< Keep TCP socket open */
247 #define RES_DNSRCH 0x00000200 /*%< search up local domain tree */
248 #define RES_INSECURE1 0x00000400 /*%< type 1 security disabled */
249 #define RES_INSECURE2 0x00000800 /*%< type 2 security disabled */
250 #define RES_NOALIASES 0x00001000 /*%< shuts off HOSTALIASES feature */
251 #define RES_USE_INET6 0x00002000 /*%< use/map IPv6 in gethostbyname() */
252 #define RES_ROTATE 0x00004000 /*%< rotate ns list after each query */
253 #define RES_NOCHECKNAME 0x00008000 /*%< do not check names for sanity. */
254 #define RES_KEEPTSIG 0x00010000 /*%< do not strip TSIG records */
255 #define RES_BLAST 0x00020000 /*%< blast all recursive servers */
256 #define RES_NSID 0x00040000 /*%< request name server ID */
257 #define RES_NOTLDQUERY 0x00100000 /*%< don't unqualified name as a tld */
258 #define RES_USE_DNSSEC 0x00200000 /*%< use DNSSEC using OK bit in OPT */
259 /* #define RES_DEBUG2 0x00400000 */ /* nslookup internal */
260 /* KAME extensions: use higher bit to avoid conflict with ISC use */
261 #define RES_USE_DNAME 0x10000000 /*%< use DNAME */
262 #define RES_USE_EDNS0 0x40000000 /*%< use EDNS0 if configured */
263 #define RES_NO_NIBBLE2 0x80000000 /*%< disable alternate nibble lookup */
265 #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | \
266 RES_DNSRCH | RES_NO_NIBBLE2)
269 * Resolver "pfcode" values. Used by dig.
271 #define RES_PRF_STATS 0x00000001
272 #define RES_PRF_UPDATE 0x00000002
273 #define RES_PRF_CLASS 0x00000004
274 #define RES_PRF_CMD 0x00000008
275 #define RES_PRF_QUES 0x00000010
276 #define RES_PRF_ANS 0x00000020
277 #define RES_PRF_AUTH 0x00000040
278 #define RES_PRF_ADD 0x00000080
279 #define RES_PRF_HEAD1 0x00000100
280 #define RES_PRF_HEAD2 0x00000200
281 #define RES_PRF_TTLID 0x00000400
282 #define RES_PRF_HEADX 0x00000800
283 #define RES_PRF_QUERY 0x00001000
284 #define RES_PRF_REPLY 0x00002000
285 #define RES_PRF_INIT 0x00004000
286 #define RES_PRF_TRUNC 0x00008000
289 /* Things involving an internal (static) resolver context. */
292 extern struct __res_state
*__res_state(void);
294 #define _res (*__res_state())
298 extern struct __res_state
* __res_state(void);
301 #ifndef __BIND_NOSTATIC
302 extern struct __res_state _res
;
306 #ifndef __BIND_NOSTATIC
307 #define fp_nquery __fp_nquery
308 #define fp_query __fp_query
309 #define hostalias __hostalias
310 #define p_query __p_query
311 #define res_close __res_close
312 #define res_init __res_init
313 #define res_isourserver __res_isourserver
314 #define res_mkquery __res_mkquery
315 #define res_query __res_query
316 #define res_querydomain __res_querydomain
317 #define res_search __res_search
318 #define res_send __res_send
319 #define res_sendsigned __res_sendsigned
322 void fp_nquery
__P((const u_char
*, int, FILE *));
323 void fp_query
__P((const u_char
*, FILE *));
324 const char * hostalias
__P((const char *));
325 void p_query
__P((const u_char
*));
326 void res_close
__P((void));
327 int res_init
__P((void));
328 int res_isourserver
__P((const struct sockaddr_in
*));
329 int res_mkquery
__P((int, const char *, int, int, const u_char
*,
330 int, const u_char
*, u_char
*, int));
331 int res_query
__P((const char *, int, int, u_char
*, int));
332 int res_querydomain
__P((const char *, const char *, int, int,
334 int res_search
__P((const char *, int, int, u_char
*, int));
335 int res_send
__P((const u_char
*, int, u_char
*, int));
336 int res_sendsigned
__P((const u_char
*, int, ns_tsig_key
*,
341 #if !defined(SHARED_LIBBIND) || defined(LIB)
343 * If libbind is a shared object (well, DLL anyway)
344 * these externs break the linker when resolv.h is
345 * included by a lib client (like named)
346 * Make them go away if a client is including this
349 extern const struct res_sym __p_key_syms
[];
350 extern const struct res_sym __p_cert_syms
[];
351 extern const struct res_sym __p_class_syms
[];
352 extern const struct res_sym __p_type_syms
[];
353 extern const struct res_sym __p_rcode_syms
[];
354 #endif /* SHARED_LIBBIND */
356 #define b64_ntop __b64_ntop
357 #define b64_pton __b64_pton
358 #define dn_comp __dn_comp
359 #define dn_count_labels __dn_count_labels
360 #define dn_expand __dn_expand
361 #define dn_skipname __dn_skipname
362 #define fp_resstat __fp_resstat
363 #define loc_aton __loc_aton
364 #define loc_ntoa __loc_ntoa
365 #define p_cdname __p_cdname
366 #define p_cdnname __p_cdnname
367 #define p_class __p_class
368 #define p_fqname __p_fqname
369 #define p_fqnname __p_fqnname
370 #define p_option __p_option
371 #define p_secstodate __p_secstodate
372 #define p_section __p_section
373 #define p_time __p_time
374 #define p_type __p_type
375 #define p_rcode __p_rcode
376 #define p_sockun __p_sockun
377 #define putlong __putlong
378 #define putshort __putshort
379 #define res_dnok __res_dnok
380 #define res_findzonecut __res_findzonecut
381 #define res_findzonecut2 __res_findzonecut2
382 #define res_hnok __res_hnok
383 #define res_hostalias __res_hostalias
384 #define res_mailok __res_mailok
385 #define res_nameinquery __res_nameinquery
386 #define res_nclose __res_nclose
387 #define res_ninit __res_ninit
388 #define res_nmkquery __res_nmkquery
389 #define res_pquery __res_pquery
390 #define res_nquery __res_nquery
391 #define res_nquerydomain __res_nquerydomain
392 #define res_nsearch __res_nsearch
393 #define res_nsend __res_nsend
394 #define res_nsendsigned __res_nsendsigned
395 #define res_nisourserver __res_nisourserver
396 #define res_ownok __res_ownok
397 #define res_queriesmatch __res_queriesmatch
398 #define res_rndinit __res_rndinit
399 #define res_randomid __res_randomid
400 #define res_nrandomid __res_nrandomid
401 #define sym_ntop __sym_ntop
402 #define sym_ntos __sym_ntos
403 #define sym_ston __sym_ston
404 #define res_nopt __res_nopt
405 #define res_nopt_rdata __res_nopt_rdata
406 #define res_ndestroy __res_ndestroy
407 #define res_nametoclass __res_nametoclass
408 #define res_nametotype __res_nametotype
409 #define res_setservers __res_setservers
410 #define res_getservers __res_getservers
411 #define res_buildprotolist __res_buildprotolist
412 #define res_destroyprotolist __res_destroyprotolist
413 #define res_destroyservicelist __res_destroyservicelist
414 #define res_get_nibblesuffix __res_get_nibblesuffix
415 #define res_get_nibblesuffix2 __res_get_nibblesuffix2
416 #define res_ourserver_p __res_ourserver_p
417 #define res_protocolname __res_protocolname
418 #define res_protocolnumber __res_protocolnumber
419 #define res_send_setqhook __res_send_setqhook
420 #define res_send_setrhook __res_send_setrhook
421 #define res_servicename __res_servicename
422 #define res_servicenumber __res_servicenumber
424 int res_hnok
__P((const char *));
425 int res_ownok
__P((const char *));
426 int res_mailok
__P((const char *));
427 int res_dnok
__P((const char *));
428 int sym_ston
__P((const struct res_sym
*, const char *, int *));
429 const char * sym_ntos
__P((const struct res_sym
*, int, int *));
430 const char * sym_ntop
__P((const struct res_sym
*, int, int *));
431 int b64_ntop
__P((u_char
const *, size_t, char *, size_t));
432 int b64_pton
__P((char const *, u_char
*, size_t));
433 int loc_aton
__P((const char *, u_char
*));
434 const char * loc_ntoa
__P((const u_char
*, char *));
435 int dn_skipname
__P((const u_char
*, const u_char
*));
436 void putlong
__P((u_int32_t
, u_char
*));
437 void putshort
__P((u_int16_t
, u_char
*));
439 u_int16_t _getshort
__P((const u_char
*));
440 u_int32_t _getlong
__P((const u_char
*));
442 const char * p_class
__P((int));
443 const char * p_time
__P((u_int32_t
));
444 const char * p_type
__P((int));
445 const char * p_rcode
__P((int));
446 const char * p_sockun
__P((union res_sockaddr_union
, char *, size_t));
447 const u_char
* p_cdnname
__P((const u_char
*, const u_char
*, int, FILE *));
448 const u_char
* p_cdname
__P((const u_char
*, const u_char
*, FILE *));
449 const u_char
* p_fqnname
__P((const u_char
*, const u_char
*,
451 const u_char
* p_fqname
__P((const u_char
*, const u_char
*, FILE *));
452 const char * p_option
__P((u_long
));
453 char * p_secstodate
__P((u_long
));
454 int dn_count_labels
__P((const char *));
455 int dn_comp
__P((const char *, u_char
*, int,
456 u_char
**, u_char
**));
457 int dn_expand
__P((const u_char
*, const u_char
*, const u_char
*,
459 void res_rndinit
__P((res_state
));
460 u_int res_randomid
__P((void));
461 u_int res_nrandomid
__P((res_state
));
462 int res_nameinquery
__P((const char *, int, int, const u_char
*,
464 int res_queriesmatch
__P((const u_char
*, const u_char
*,
465 const u_char
*, const u_char
*));
466 const char * p_section
__P((int, int));
467 /* Things involving a resolver context. */
468 int res_ninit
__P((res_state
));
469 int res_nisourserver
__P((const res_state
,
470 const struct sockaddr_in
*));
471 void fp_resstat
__P((const res_state
, FILE *));
472 void res_pquery
__P((const res_state
, const u_char
*, int, FILE *));
473 const char * res_hostalias
__P((const res_state
, const char *,
475 int res_nquery
__P((res_state
, const char *, int, int,
477 int res_nsearch
__P((res_state
, const char *, int, int, u_char
*,
479 int res_nquerydomain
__P((res_state
, const char *, const char *,
480 int, int, u_char
*, int));
481 int res_nmkquery
__P((res_state
, int, const char *, int, int,
482 const u_char
*, int, const u_char
*,
484 int res_nsend
__P((res_state
, const u_char
*, int, u_char
*, int));
485 int res_nsendsigned
__P((res_state
, const u_char
*, int,
486 ns_tsig_key
*, u_char
*, int));
487 int res_findzonecut
__P((res_state
, const char *, ns_class
, int,
488 char *, size_t, struct in_addr
*, int));
489 int res_findzonecut2
__P((res_state
, const char *, ns_class
, int,
491 union res_sockaddr_union
*, int));
492 void res_nclose
__P((res_state
));
493 int res_nopt
__P((res_state
, int, u_char
*, int, int));
494 int res_nopt_rdata
__P((res_state
, int, u_char
*, int, u_char
*,
495 u_short
, u_short
, u_char
*));
496 void res_send_setqhook
__P((res_send_qhook
));
497 void res_send_setrhook
__P((res_send_rhook
));
498 int __res_vinit
__P((res_state
, int));
499 void res_destroyservicelist
__P((void));
500 const char * res_servicename
__P((u_int16_t
, const char *));
501 const char * res_protocolname
__P((int));
502 void res_destroyprotolist
__P((void));
503 void res_buildprotolist
__P((void));
504 const char * res_get_nibblesuffix
__P((res_state
));
505 const char * res_get_nibblesuffix2
__P((res_state
));
506 void res_ndestroy
__P((res_state
));
507 u_int16_t res_nametoclass
__P((const char *, int *));
508 u_int16_t res_nametotype
__P((const char *, int *));
509 void res_setservers
__P((res_state
,
510 const union res_sockaddr_union
*, int));
511 int res_getservers
__P((res_state
,
512 union res_sockaddr_union
*, int));
515 #endif /* !_RESOLV_H_ */