]> git.saurik.com Git - apple/libresolv.git/blob - resolv.h
libresolv-25.tar.gz
[apple/libresolv.git] / resolv.h
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.1 2006/03/01 19:01:39 majka Exp $
54 */
55
56 /*
57 * Important note regarding the BIND-9 API on Mac OS
58 * -------------------------------------------------
59 *
60 * Mac OS supports a DNS query routing API (see <dns.h>) which is used by
61 * most system services to access DNS. The BIND-9 APIs described here are
62 * a lower-level that does not do query routing or search amongst multiple
63 * resolver clients. The results of DNS queries from this API may differ
64 * significantly from the results of queries sent to the <dns.h> API. We
65 * strongly encourage developers to use higher-level APIs where possible.
66 */
67
68 #ifndef _RESOLV_9_H_
69 #define _RESOLV_9_H_
70
71 #ifdef BIND_8_COMPAT
72 #include <resolv8_compat.h>
73 #else
74
75 #include <sys/param.h>
76 #if (!defined(BSD)) || (BSD < 199306)
77 # include <sys/bitypes.h>
78 #else
79 # include <sys/types.h>
80 #endif
81 #include <sys/cdefs.h>
82 #include <sys/socket.h>
83 #include <netinet/in.h>
84 #include <stdio.h>
85 #include <arpa/nameser.h>
86
87
88 /*
89 * Revision information. This is the release date in YYYYMMDD format.
90 * It can change every day so the right thing to do with it is use it
91 * in preprocessor commands such as "#if (__RES > 19931104)". Do not
92 * compare for equality; rather, use it to determine whether your resolver
93 * is new enough to contain a certain feature.
94 */
95
96 #define __RES 19991006
97
98 #define __h_errno_set _res_9_h_errno_set
99 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
100
101 #define __res_state __res_9_state
102 struct __res_state; /* forward */
103
104 __BEGIN_DECLS
105 void __h_errno_set(struct __res_state *res, int err);
106 __END_DECLS
107
108 /*
109 * Resolver configuration file.
110 * Normally not present, but may contain the address of the
111 * inital name server(s) to query and the domain search list.
112 *
113 * Apple Note: The default DNS resolver client configuration
114 * is now stored in a system configuration database, not in
115 */
116
117 #ifndef _PATH_RESCONF
118 #define _PATH_RESCONF "/etc/resolv.conf"
119 #endif
120
121 #define res_goahead res_9_goahead
122 #define res_nextns res_9_nextns
123 #define res_modified res_9_modified
124 #define res_done res_9_done
125 #define res_error res_9_error
126 #define res_sendhookact res_9_sendhookact
127
128 typedef enum
129 {
130 res_goahead,
131 res_nextns,
132 res_modified,
133 res_done,
134 res_error
135 } res_sendhookact;
136
137 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr * const *ns,
138 const u_char **query,
139 int *querylen,
140 u_char *ans,
141 int anssiz,
142 int *resplen));
143
144 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr *ns,
145 const u_char *query,
146 int querylen,
147 u_char *ans,
148 int anssiz,
149 int *resplen));
150
151 #define res_sym res_9_sym
152
153 struct res_sym
154 {
155 int number; /* Identifying number, like T_MX */
156 const char * name; /* Its symbolic name, like "MX" */
157 const char * humanname; /* Its fun name, like "mail exchanger" */
158 };
159
160 /*
161 * Global defines and variables for resolver stub.
162 */
163 #define MAXNS 3 /* max # name servers we'll track */
164 #define MAXDFLSRCH 3 /* # default domain levels to try */
165 #define MAXDNSRCH 6 /* max # domains in search path */
166 #define LOCALDOMAINPARTS 2 /* min levels in name that is "local" */
167
168 #define RES_TIMEOUT 5 /* min. seconds between retries */
169 #define MAXRESOLVSORT 10 /* number of net to sort on */
170 #define RES_MAXNDOTS 15 /* should reflect bit field size */
171 #define RES_MAXRETRANS 30 /* only for resolv.conf/RES_OPTIONS */
172 #define RES_MAXRETRY 5 /* only for resolv.conf/RES_OPTIONS */
173 #define RES_DFLRETRY 2 /* Default #/tries. */
174 #define RES_MAXTIME 65535 /* Infinity, in milliseconds. */
175
176 #define __res_state_ext __res_9_state_ext
177 struct __res_state_ext;
178
179 #define __res_state __res_9_state
180 struct __res_state {
181 int retrans; /* retransmition time interval */
182 int retry; /* number of times to transmit (attempts, not retries) */
183 #ifdef sun
184 u_int options; /* option flags - see below. */
185 #else
186 u_long options; /* option flags - see below. */
187 #endif
188 int nscount; /* number of name servers */
189 struct sockaddr_in
190 nsaddr_list[MAXNS]; /* address of name server */
191 #define nsaddr nsaddr_list[0] /* for backward compatibility */
192 u_short id; /* current message id */
193 char *dnsrch[MAXDNSRCH+1]; /* components of domain to search */
194 char defdname[256]; /* default domain (deprecated) */
195 #ifdef sun
196 u_int pfcode; /* RES_PRF_ flags - see below. */
197 #else
198 u_long pfcode; /* RES_PRF_ flags - see below. */
199 #endif
200 unsigned ndots:4; /* threshold for initial abs. query */
201 unsigned nsort:4; /* number of elements in sort_list[] */
202 char unused[3];
203 struct {
204 struct in_addr addr;
205 u_int32_t mask;
206 } sort_list[MAXRESOLVSORT];
207 res_send_qhook qhook; /* query hook */
208 res_send_rhook rhook; /* response hook */
209 int res_h_errno; /* last one set for this context */
210 int _vcsock; /* PRIVATE: for res_send VC i/o */
211 u_int _flags; /* PRIVATE: see below */
212 u_int _pad; /* make _u 64 bit aligned */
213 union {
214 /* On an 32-bit arch this means 512b total. */
215 char pad[72 - 4*sizeof (int) - 2*sizeof (void *)];
216 struct {
217 u_int16_t nscount;
218 u_int16_t nstimes[MAXNS]; /* ms. */
219 int nssocks[MAXNS];
220 struct __res_state_ext *ext; /* extention for IPv6 */
221 } _ext;
222 } _u;
223 };
224
225 #define res_state res_9_state
226
227 typedef struct __res_state *res_state;
228
229 #define res_sockaddr_union res_9_sockaddr_union
230
231 union res_sockaddr_union {
232 struct sockaddr_in sin;
233 #ifdef IN6ADDR_ANY_INIT
234 struct sockaddr_in6 sin6;
235 #endif
236 #ifdef ISC_ALIGN64
237 int64_t __align64; /* 64bit alignment */
238 #else
239 int32_t __align32; /* 32bit alignment */
240 #endif
241 char __space[128]; /* max size */
242 };
243
244 /*
245 * Resolver flags (used to be discrete per-module statics ints).
246 */
247 #define RES_F_VC 0x00000001 /* socket is TCP */
248 #define RES_F_CONN 0x00000002 /* socket is connected */
249 #define RES_F_EDNS0ERR 0x00000004 /* EDNS0 caused errors */
250
251 /* res_findzonecut2() options */
252 #define RES_EXHAUSTIVE 0x00000001 /* always do all queries */
253 #define RES_IPV4ONLY 0x00000002 /* IPv4 only */
254 #define RES_IPV6ONLY 0x00000004 /* IPv6 only */
255
256 /*
257 * Resolver options (keep these in synch with res_debug.c, please)
258 */
259 #define RES_INIT 0x00000001 /* address initialized */
260 #define RES_DEBUG 0x00000002 /* print debug messages */
261 #define RES_AAONLY 0x00000004 /* authoritative answers only (!IMPL)*/
262 #define RES_USEVC 0x00000008 /* use virtual circuit */
263 #define RES_PRIMARY 0x00000010 /* query primary server only (!IMPL) */
264 #define RES_IGNTC 0x00000020 /* ignore trucation errors */
265 #define RES_RECURSE 0x00000040 /* recursion desired */
266 #define RES_DEFNAMES 0x00000080 /* use default domain name */
267 #define RES_STAYOPEN 0x00000100 /* Keep TCP socket open */
268 #define RES_DNSRCH 0x00000200 /* search up local domain tree */
269 #define RES_INSECURE1 0x00000400 /* type 1 security disabled */
270 #define RES_INSECURE2 0x00000800 /* type 2 security disabled */
271 #define RES_NOALIASES 0x00001000 /* shuts off HOSTALIASES feature */
272 #define RES_USE_INET6 0x00002000 /* use/map IPv6 in gethostbyname() */
273 #define RES_ROTATE 0x00004000 /* rotate ns list after each query */
274 #define RES_NOCHECKNAME 0x00008000 /* do not check names for sanity. */
275 #define RES_KEEPTSIG 0x00010000 /* do not strip TSIG records */
276 #define RES_BLAST 0x00020000 /* blast all recursive servers */
277 #define RES_NO_NIBBLE 0x00040000 /* disable IPv6 nibble mode reverse */
278 #define RES_NO_BITSTRING 0x00080000 /* disable IPv6 bitstring mode reverse */
279 #define RES_NOTLDQUERY 0x00100000 /* don't unqualified name as a tld */
280 #define RES_USE_DNSSEC 0x00200000 /* use DNSSEC using OK bit in OPT */
281 /* KAME extensions: use higher bit to avoid conflict with ISC use */
282 #define RES_USE_DNAME 0x10000000 /* use DNAME */
283 #define RES_USE_A6 0x20000000 /* use A6 */
284 #define RES_USE_EDNS0 0x40000000 /* use EDNS0 if configured */
285 #define RES_NO_NIBBLE2 0x80000000 /* disable alternate nibble lookup */
286
287 #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH | RES_INSECURE1)
288
289 /*
290 * Resolver "pfcode" values. Used by dig.
291 */
292 #define RES_PRF_STATS 0x00000001
293 #define RES_PRF_UPDATE 0x00000002
294 #define RES_PRF_CLASS 0x00000004
295 #define RES_PRF_CMD 0x00000008
296 #define RES_PRF_QUES 0x00000010
297 #define RES_PRF_ANS 0x00000020
298 #define RES_PRF_AUTH 0x00000040
299 #define RES_PRF_ADD 0x00000080
300 #define RES_PRF_HEAD1 0x00000100
301 #define RES_PRF_HEAD2 0x00000200
302 #define RES_PRF_TTLID 0x00000400
303 #define RES_PRF_HEADX 0x00000800
304 #define RES_PRF_QUERY 0x00001000
305 #define RES_PRF_REPLY 0x00002000
306 #define RES_PRF_INIT 0x00004000
307 #define RES_PRF_TRUNC 0x00008000
308 /* 0x00010000 */
309
310 /* Things involving an internal (static) resolver context. */
311 #ifndef __BIND_NOSTATIC
312 extern struct __res_state _res;
313 #endif
314
315 #ifndef __BIND_NOSTATIC
316 #define fp_nquery res_9_fp_nquery
317 #define fp_query res_9_fp_query
318 #define hostalias res_9_hostalias_1
319 #define p_query res_9_p_query
320 #define res_close res_9_close
321 #define res_init res_9_init
322 #define res_isourserver res_9_isourserver
323 #define res_mkquery res_9_mkquery
324 #define res_query res_9_query
325 #define res_querydomain res_9_querydomain
326 #define res_search res_9_search
327 #define res_send res_9_send
328 #define res_sendsigned res_9_sendsigned
329
330 __BEGIN_DECLS
331 void fp_nquery __P((const u_char *, int, FILE *));
332 void fp_query __P((const u_char *, FILE *));
333 const char *hostalias __P((const char *));
334 void p_query __P((const u_char *));
335 void res_close __P((void));
336 int res_init __P((void));
337 int res_isourserver __P((const struct sockaddr_in *));
338 int res_mkquery __P((int, const char *, int, int, const u_char *,
339 int, const u_char *, u_char *, int));
340 int res_query __P((const char *, int, int, u_char *, int));
341 int res_querydomain __P((const char *, const char *, int, int,
342 u_char *, int));
343 int res_search __P((const char *, int, int, u_char *, int));
344 int res_send __P((const u_char *, int, u_char *, int));
345 int res_sendsigned __P((const u_char *, int, ns_tsig_key *,
346 u_char *, int));
347 __END_DECLS
348 #endif
349
350 #if !defined(SHARED_LIBBIND) || defined(LIB)
351 /*
352 * If libbind is a shared object (well, DLL anyway)
353 * these externs break the linker when resolv.h is
354 * included by a lib client (like named)
355 * Make them go away if a client is including this
356 *
357 */
358 #define res_sym res_9_sym
359 #define __p_key_syms __res_9_p_key_syms
360 #define __p_cert_syms __res_9_p_cert_syms
361 #define __p_class_syms __res_9_p_class_syms
362 #define __p_type_syms __res_9_p_type_syms
363 #define __p_rcode_syms __res_9_p_rcode_syms
364
365 extern const struct res_sym __p_key_syms[];
366 extern const struct res_sym __p_cert_syms[];
367 extern const struct res_sym __p_class_syms[];
368 extern const struct res_sym __p_type_syms[];
369 extern const struct res_sym __p_rcode_syms[];
370 #endif /* SHARED_LIBBIND */
371
372 #define b64_ntop res_9_b64_ntop
373 #define b64_pton res_9_b64_pton
374 #define dn_comp res_9_dn_comp
375 #define dn_count_labels res_9_dn_count_labels
376 #define dn_expand res_9_dn_expand
377 #define dn_skipname res_9_dn_skipname
378 #define fp_resstat res_9_fp_resstat
379 #define loc_aton res_9_loc_aton
380 #define loc_ntoa res_9_loc_ntoa
381 #define p_cdname res_9_p_cdname
382 #define p_cdnname res_9_p_cdnname
383 #define p_class res_9_p_class
384 #define p_fqname res_9_p_fqname
385 #define p_fqnname res_9_p_fqnname
386 #define p_option res_9_p_option
387 #define p_secstodate res_9_p_secstodate
388 #define p_section res_9_p_section
389 #define p_time res_9_p_time
390 #define p_type res_9_p_type
391 #define p_rcode res_9_p_rcode
392 #define putlong res_9_putlong
393 #define putshort res_9_putshort
394 #define res_dnok res_9_dnok
395 #define res_findzonecut res_9_findzonecut
396 #define res_findzonecut2 res_9_findzonecut2
397 #define res_hnok res_9_hnok
398 #define res_hostalias res_9_hostalias_2
399 #define res_mailok res_9_mailok
400 #define res_nameinquery res_9_nameinquery
401 #define res_nclose res_9_nclose
402 #define res_ninit res_9_ninit
403 #define res_nmkquery res_9_nmkquery
404 #define res_pquery res_9_pquery
405 #define res_nquery res_9_nquery
406 #define res_nquerydomain res_9_nquerydomain
407 #define res_nsearch res_9_nsearch
408 #define res_nsend res_9_nsend
409 #define res_nsendsigned res_9_nsendsigned
410 #define res_nisourserver res_9_nisourserver
411 #define res_ownok res_9_ownok
412 #define res_queriesmatch res_9_queriesmatch
413 #define res_randomid res_9_randomid
414 #define sym_ntop res_9_sym_ntop
415 #define sym_ntos res_9_sym_ntos
416 #define sym_ston res_9_sym_ston
417 #define res_nopt res_9_nopt
418 #define res_ndestroy res_9_ndestroy
419 #define res_nametoclass res_9_nametoclass
420 #define res_nametotype res_9_nametotype
421 #define res_setservers res_9_setservers
422 #define res_getservers res_9_getservers
423 #define _getshort res_9_getshort
424 #define _getlong res_9_getlong
425 #define __res_vinit res_9_vinit
426
427 __BEGIN_DECLS
428 int res_hnok __P((const char *));
429 int res_ownok __P((const char *));
430 int res_mailok __P((const char *));
431 int res_dnok __P((const char *));
432 int sym_ston __P((const struct res_sym *, const char *, int *));
433 const char * sym_ntos __P((const struct res_sym *, int, int *));
434 const char *sym_ntop __P((const struct res_sym *, int, int *));
435 int b64_ntop __P((u_char const *, size_t, char *, size_t));
436 int b64_pton __P((char const *, u_char *, size_t));
437 int loc_aton __P((const char *ascii, u_char *binary));
438 const char * loc_ntoa __P((const u_char *binary, char *ascii));
439 int dn_skipname __P((const u_char *, const u_char *));
440 void putlong __P((u_int32_t, u_char *));
441 void putshort __P((u_int16_t, u_char *));
442 #ifndef __ultrix__
443 u_int16_t _getshort __P((const u_char *src));
444 u_int32_t _getlong __P((const u_char *src));
445 #endif
446 const char * p_class __P((int));
447 const char * p_time __P((u_int32_t));
448 const char * p_type __P((int));
449 const char * p_rcode __P((int));
450 const u_char * p_cdnname __P((const u_char *, const u_char *, int, FILE *));
451 const u_char * p_cdname __P((const u_char *, const u_char *, FILE *));
452 const u_char * p_fqnname __P((const u_char *cp, const u_char *msg, int, char *, int));
453 const u_char * p_fqname __P((const u_char *, const u_char *, FILE *));
454 const char * p_option __P((u_long option));
455 char * p_secstodate __P((u_long));
456 int dn_count_labels __P((const char *));
457 int dn_comp __P((const char *, u_char *, int, u_char **, u_char **));
458 int dn_expand __P((const u_char *, const u_char *, const u_char *, char *, int));
459 u_int res_randomid __P((void));
460 int res_nameinquery __P((const char *, int, int, const u_char *, const u_char *));
461 int res_queriesmatch __P((const u_char *, const u_char *, const u_char *, const u_char *));
462 const char * p_section __P((int section, int opcode));
463
464 /* Things involving a resolver context. */
465 int res_ninit __P((res_state));
466 int res_nisourserver __P((const res_state, const struct sockaddr_in *));
467 void fp_resstat __P((const res_state, FILE *));
468 void res_pquery __P((const res_state, const u_char *, int, FILE *));
469 const char *res_hostalias __P((const res_state, const char *, char *, size_t));
470 int res_nquery __P((res_state, const char *, int, int, u_char *, int));
471 int res_nsearch __P((res_state, const char *, int, int, u_char *, int));
472 int res_nquerydomain __P((res_state, const char *, const char *, int, int, u_char *, int));
473 int res_nmkquery __P((res_state, int, const char *, int, int, const u_char *, int, const u_char *, u_char *, int));
474 int res_nsend __P((res_state, const u_char *, int, u_char *, int));
475 int res_nsendsigned __P((res_state, const u_char *, int, ns_tsig_key *, u_char *, int));
476 int res_findzonecut __P((res_state, const char *, ns_class, int, char *, size_t, struct in_addr *, int));
477 int res_findzonecut2 __P((res_state, const char *, ns_class, int, char *, size_t, union res_sockaddr_union *, int));
478 void res_nclose __P((res_state));
479 int res_nopt __P((res_state, int, u_char *, int, int));
480 void res_send_setqhook __P((res_send_qhook hook));
481 void res_send_setrhook __P((res_send_rhook hook));
482 int __res_vinit __P((res_state, int));
483 void res_destroyservicelist __P((void));
484 const char * res_servicename __P((u_int16_t port, const char *proto));
485 const char * res_protocolname __P((int num));
486 void res_destroyprotolist __P((void));
487 void res_buildprotolist __P((void));
488 const char * res_get_nibblesuffix __P((res_state));
489 const char * res_get_nibblesuffix2 __P((res_state));
490 const char * res_get_bitstringsuffix __P((res_state));
491 void res_ndestroy __P((res_state));
492 u_int16_t res_nametoclass __P((const char *buf, int *success));
493 u_int16_t res_nametotype __P((const char *buf, int *success));
494 void res_setservers __P((res_state, const union res_sockaddr_union *, int));
495 int res_getservers __P((res_state, union res_sockaddr_union *, int));
496 __END_DECLS
497
498 #endif /* !BIND_8_COMPAT */
499 #endif /* !_RESOLV_9_H_ */