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