Annotation of src/include/resolv.h, Revision 1.19
1.19 ! deraadt 1: /* $OpenBSD: resolv.h,v 1.18 2012/07/10 11:46:23 guenther Exp $ */
1.4 itojun 2:
3: /*
4: * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5: * All rights reserved.
6: *
7: * Redistribution and use in source and binary forms, with or without
8: * modification, are permitted provided that the following conditions
9: * are met:
10: * 1. Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * 2. Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * 3. Neither the name of the project nor the names of its contributors
16: * may be used to endorse or promote products derived from this software
17: * without specific prior written permission.
18: *
19: * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: * SUCH DAMAGE.
30: */
1.3 downsj 31:
1.1 deraadt 32: /*
1.2 dm 33: * ++Copyright++ 1983, 1987, 1989, 1993
34: * -
35: * Copyright (c) 1983, 1987, 1989, 1993
36: * The Regents of the University of California. All rights reserved.
37: *
1.1 deraadt 38: * Redistribution and use in source and binary forms, with or without
39: * modification, are permitted provided that the following conditions
40: * are met:
41: * 1. Redistributions of source code must retain the above copyright
42: * notice, this list of conditions and the following disclaimer.
43: * 2. Redistributions in binary form must reproduce the above copyright
44: * notice, this list of conditions and the following disclaimer in the
45: * documentation and/or other materials provided with the distribution.
1.11 millert 46: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 47: * may be used to endorse or promote products derived from this software
48: * without specific prior written permission.
1.2 dm 49: *
1.1 deraadt 50: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60: * SUCH DAMAGE.
1.2 dm 61: * -
62: * Portions Copyright (c) 1993 by Digital Equipment Corporation.
63: *
64: * Permission to use, copy, modify, and distribute this software for any
65: * purpose with or without fee is hereby granted, provided that the above
66: * copyright notice and this permission notice appear in all copies, and that
67: * the name of Digital Equipment Corporation not be used in advertising or
68: * publicity pertaining to distribution of the document or software without
69: * specific, written prior permission.
70: *
71: * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
72: * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
73: * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT
74: * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
75: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
76: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
77: * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
78: * SOFTWARE.
79: * -
80: * --Copyright--
81: */
82:
83: /*
84: * @(#)resolv.h 8.1 (Berkeley) 6/2/93
1.3 downsj 85: * $From: resolv.h,v 8.17 1996/11/26 10:11:20 vixie Exp $
1.1 deraadt 86: */
87:
88: #ifndef _RESOLV_H_
89: #define _RESOLV_H_
90:
1.18 guenther 91: #include <sys/types.h>
1.4 itojun 92: #include <sys/socket.h>
1.2 dm 93: #include <stdio.h>
94:
1.1 deraadt 95: /*
1.3 downsj 96: * Revision information. This is the release date in YYYYMMDD format.
97: * It can change every day so the right thing to do with it is use it
98: * in preprocessor commands such as "#if (__RES > 19931104)". Do not
1.1 deraadt 99: * compare for equality; rather, use it to determine whether your resolver
100: * is new enough to contain a certain feature.
101: */
102:
1.3 downsj 103: #define __RES 19960801
1.1 deraadt 104:
105: /*
106: * Resolver configuration file.
107: * Normally not present, but may contain the address of the
1.5 todd 108: * initial name server(s) to query and the domain search list.
1.1 deraadt 109: */
110:
111: #ifndef _PATH_RESCONF
112: #define _PATH_RESCONF "/etc/resolv.conf"
113: #endif
114:
115: /*
116: * Global defines and variables for resolver stub.
117: */
118: #define MAXNS 3 /* max # name servers we'll track */
119: #define MAXDFLSRCH 3 /* # default domain levels to try */
120: #define MAXDNSRCH 6 /* max # domains in search path */
121: #define LOCALDOMAINPARTS 2 /* min levels in name that is "local" */
1.3 downsj 122: #define MAXDNSLUS 4 /* max # of host lookup types */
1.1 deraadt 123:
124: #define RES_TIMEOUT 5 /* min. seconds between retries */
1.2 dm 125: #define MAXRESOLVSORT 10 /* number of net to sort on */
126: #define RES_MAXNDOTS 15 /* should reflect bit field size */
1.1 deraadt 127:
128: struct __res_state {
1.10 deraadt 129: int retrans; /* retransmission time interval */
1.1 deraadt 130: int retry; /* number of times to retransmit */
1.16 tedu 131: unsigned int options; /* option flags - see below. */
1.1 deraadt 132: int nscount; /* number of name servers */
1.17 pyr 133: int family[2]; /* specifies which address
134: * families will be queried and
135: * in which order */
1.2 dm 136: struct sockaddr_in
137: nsaddr_list[MAXNS]; /* address of name server */
1.1 deraadt 138: #define nsaddr nsaddr_list[0] /* for backward compatibility */
1.15 espie 139: unsigned short id; /* current message id */
1.1 deraadt 140: char *dnsrch[MAXDNSRCH+1]; /* components of domain to search */
1.3 downsj 141: char defdname[256]; /* default domain (deprecated) */
1.16 tedu 142: unsigned int pfcode; /* RES_PRF_ flags - see below. */
1.2 dm 143: unsigned ndots:4; /* threshold for initial abs. query */
144: unsigned nsort:4; /* number of elements in sort_list[] */
1.1 deraadt 145: char unused[3];
146: struct {
1.2 dm 147: struct in_addr addr;
148: u_int32_t mask;
1.1 deraadt 149: } sort_list[MAXRESOLVSORT];
1.3 downsj 150: char lookups[MAXDNSLUS];
1.16 tedu 151: struct timespec restimespec;
152: time_t reschktime;
1.1 deraadt 153: };
154:
1.4 itojun 155: #if 1 /* INET6 */
156: /*
157: * replacement of __res_state, separated to keep binary compatibility.
158: */
159: struct __res_state_ext {
160: struct sockaddr_storage nsaddr_list[MAXNS];
161: struct {
162: int af; /* address family for addr, mask */
163: union {
164: struct in_addr ina;
165: struct in6_addr in6a;
166: } addr, mask;
167: } sort_list[MAXRESOLVSORT];
168: };
169: #endif
170:
171:
1.1 deraadt 172: /*
1.2 dm 173: * Resolver options (keep these in synch with res_debug.c, please)
1.1 deraadt 174: */
1.2 dm 175: #define RES_INIT 0x00000001 /* address initialized */
176: #define RES_DEBUG 0x00000002 /* print debug messages */
177: #define RES_AAONLY 0x00000004 /* authoritative answers only (!IMPL)*/
178: #define RES_USEVC 0x00000008 /* use virtual circuit */
179: #define RES_PRIMARY 0x00000010 /* query primary server only (!IMPL) */
180: #define RES_IGNTC 0x00000020 /* ignore trucation errors */
181: #define RES_RECURSE 0x00000040 /* recursion desired */
182: #define RES_DEFNAMES 0x00000080 /* use default domain name */
183: #define RES_STAYOPEN 0x00000100 /* Keep TCP socket open */
184: #define RES_DNSRCH 0x00000200 /* search up local domain tree */
185: #define RES_INSECURE1 0x00000400 /* type 1 security disabled */
186: #define RES_INSECURE2 0x00000800 /* type 2 security disabled */
187: #define RES_NOALIASES 0x00001000 /* shuts off HOSTALIASES feature */
1.3 downsj 188: #define RES_USE_INET6 0x00002000 /* use/map IPv6 in gethostbyname() */
1.6 itojun 189: /* KAME extensions: use higher bit to avoid conflict with ISC use */
190: #define RES_USE_EDNS0 0x40000000 /* use EDNS0 */
1.7 jakob 191: /* DNSSEC extensions: use higher bit to avoid conflict with ISC use */
192: #define RES_USE_DNSSEC 0x20000000 /* use DNSSEC using OK bit in OPT */
1.1 deraadt 193:
194: #define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
195:
196: /*
197: * Resolver "pfcode" values. Used by dig.
198: */
1.2 dm 199: #define RES_PRF_STATS 0x00000001
200: /* 0x00000002 */
201: #define RES_PRF_CLASS 0x00000004
202: #define RES_PRF_CMD 0x00000008
203: #define RES_PRF_QUES 0x00000010
204: #define RES_PRF_ANS 0x00000020
205: #define RES_PRF_AUTH 0x00000040
206: #define RES_PRF_ADD 0x00000080
207: #define RES_PRF_HEAD1 0x00000100
208: #define RES_PRF_HEAD2 0x00000200
209: #define RES_PRF_TTLID 0x00000400
210: #define RES_PRF_HEADX 0x00000800
211: #define RES_PRF_QUERY 0x00001000
212: #define RES_PRF_REPLY 0x00002000
213: #define RES_PRF_INIT 0x00004000
214: /* 0x00008000 */
215:
216: /* hooks are still experimental as of 4.9.2 */
217: typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
218: res_sendhookact;
219:
1.9 millert 220: typedef res_sendhookact (*res_send_qhook)(struct sockaddr_in * const *ns,
1.15 espie 221: const unsigned char **query,
1.2 dm 222: int *querylen,
1.15 espie 223: unsigned char *ans,
1.2 dm 224: int anssiz,
1.9 millert 225: int *resplen);
1.2 dm 226:
1.9 millert 227: typedef res_sendhookact (*res_send_rhook)(const struct sockaddr_in *ns,
1.15 espie 228: const unsigned char *query,
1.2 dm 229: int querylen,
1.15 espie 230: unsigned char *ans,
1.2 dm 231: int anssiz,
1.9 millert 232: int *resplen);
1.1 deraadt 233:
1.3 downsj 234: struct res_sym {
235: int number; /* Identifying number, like T_MX */
236: char * name; /* Its symbolic name, like "MX" */
237: char * humanname; /* Its fun name, like "mail exchanger" */
238: };
239:
1.1 deraadt 240: extern struct __res_state _res;
1.4 itojun 241: #if 1 /* INET6 */
242: extern struct __res_state_ext _res_ext;
243: #endif
1.3 downsj 244: extern const struct res_sym __p_class_syms[];
245: extern const struct res_sym __p_type_syms[];
1.1 deraadt 246:
247: /* Private routines shared between libc/net, named, nslookup and others. */
1.3 downsj 248: #define res_hnok __res_hnok
249: #define res_ownok __res_ownok
250: #define res_mailok __res_mailok
251: #define res_dnok __res_dnok
252: #define sym_ston __sym_ston
253: #define sym_ntos __sym_ntos
254: #define sym_ntop __sym_ntop
255: #define b64_ntop __b64_ntop
256: #define b64_pton __b64_pton
257: #define loc_ntoa __loc_ntoa
258: #define loc_aton __loc_aton
1.1 deraadt 259: #define dn_skipname __dn_skipname
1.3 downsj 260: #define fp_resstat __fp_resstat
1.1 deraadt 261: #define fp_query __fp_query
1.2 dm 262: #define fp_nquery __fp_nquery
1.1 deraadt 263: #define hostalias __hostalias
264: #define putlong __putlong
265: #define putshort __putshort
266: #define p_class __p_class
267: #define p_time __p_time
268: #define p_type __p_type
1.3 downsj 269: #define p_query __p_query
1.2 dm 270: #define p_cdnname __p_cdnname
271: #define p_cdname __p_cdname
1.3 downsj 272: #define p_fqnname __p_fqnname
1.2 dm 273: #define p_fqname __p_fqname
274: #define p_rr __p_rr
275: #define p_option __p_option
1.3 downsj 276: #define p_secstodate __p_secstodate
277: #define dn_count_labels __dn_count_labels
278: #define dn_comp __dn_comp
1.2 dm 279: #define res_randomid __res_randomid
1.3 downsj 280: #define res_send __res_send
1.2 dm 281: #define res_isourserver __res_isourserver
282: #define res_nameinquery __res_nameinquery
283: #define res_queriesmatch __res_queriesmatch
1.3 downsj 284: #define res_close __res_close
1.6 itojun 285: #define res_opt __res_opt
1.3 downsj 286:
287: #ifdef BIND_RES_POSIX3
288: #define dn_expand __dn_expand
289: #define res_init __res_init
290: #define res_query __res_query
291: #define res_search __res_search
292: #define res_querydomain __res_querydomain
293: #define res_mkquery __res_mkquery
294: #endif
295:
1.1 deraadt 296: __BEGIN_DECLS
1.15 espie 297: int res_hnok(const char *);
298: int res_ownok(const char *);
299: int res_mailok(const char *);
300: int res_dnok(const char *);
301: int sym_ston(const struct res_sym *, char *, int *);
302: const char * sym_ntos(const struct res_sym *, int, int *);
303: const char * sym_ntop(const struct res_sym *, int, int *);
304: int b64_ntop(unsigned char const *, size_t, char *, size_t);
305: int b64_pton(char const *, unsigned char *, size_t);
306: int loc_aton(const char *, unsigned char *);
307: const char * loc_ntoa(const unsigned char *, char *);
308: int dn_skipname(const unsigned char *,
309: const unsigned char *);
310: void fp_resstat(struct __res_state *, FILE *);
311: void fp_query(const unsigned char *, FILE *);
312: void fp_nquery(const unsigned char *, int, FILE *);
313: const char * hostalias(const char *);
314: void putlong(u_int32_t, unsigned char *);
315: void putshort(u_int16_t, unsigned char *);
316: const char * p_class(int);
317: const char * p_time(u_int32_t);
318: const char * p_type(int);
319: void p_query(const unsigned char *);
320: const unsigned char * p_cdnname(const unsigned char *, const unsigned char *,
321: int, FILE *);
322: const unsigned char * p_cdname(const unsigned char *, const unsigned char *,
323: FILE *);
324: const unsigned char * p_fqnname(const unsigned char *, const unsigned char *,
325: int, char *, int);
326: const unsigned char * p_fqname(const unsigned char *, const unsigned char *,
327: FILE *);
328: const unsigned char * p_rr(const unsigned char *, const unsigned char *,
329: FILE *);
330: const char * p_option(unsigned long);
331: char * p_secstodate(unsigned long);
332: int dn_count_labels(char *);
333: int dn_comp(const char *, unsigned char *, int,
334: unsigned char **, unsigned char **);
335: int dn_expand(const unsigned char *, const unsigned char *,
336: const unsigned char *, char *, int);
337: int res_init(void);
1.16 tedu 338: int _res_init(int);
1.15 espie 339: unsigned int res_randomid(void);
340: int res_query(const char *, int, int, unsigned char *, int)
1.14 avsm 341: __attribute__((__bounded__(__string__,4,5)));
1.15 espie 342: int res_search(const char *, int, int, unsigned char *, int)
343: __attribute__((__bounded__(__string__,4,5)));
344: int res_querydomain(const char *, const char *, int, int,
345: unsigned char *, int)
1.14 avsm 346: __attribute__((__bounded__(__string__,5,6)));
1.15 espie 347: int res_mkquery(int, const char *, int, int,
348: const unsigned char *, int, const unsigned char *,
349: unsigned char *, int)
1.14 avsm 350: __attribute__((__bounded__(__string__,5,6)))
351: __attribute__((__bounded__(__string__,8,9)));
1.15 espie 352: int res_send(const unsigned char *, int, unsigned char *,
353: int)
1.14 avsm 354: __attribute__((__bounded__(__string__,3,4)));
1.15 espie 355: int res_isourserver(const struct sockaddr_in *);
356: int res_nameinquery(const char *, int, int,
357: const unsigned char *, const unsigned char *);
358: int res_queriesmatch(const unsigned char *,
359: const unsigned char *, const unsigned char *,
360: const unsigned char *);
361: void res_close(void);
1.1 deraadt 362: __END_DECLS
363:
364: #endif /* !_RESOLV_H_ */