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