xref: /openbsd-src/include/resolv.h (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1 /*	$OpenBSD: resolv.h,v 1.16 2005/03/30 02:58:28 tedu 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++ 1983, 1987, 1989, 1993
34  * -
35  * Copyright (c) 1983, 1987, 1989, 1993
36  *    The Regents of the University of California.  All rights reserved.
37  *
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. Neither the name of the University nor the names of its contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
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.
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
85  *	$From: resolv.h,v 8.17 1996/11/26 10:11:20 vixie Exp $
86  */
87 
88 #ifndef _RESOLV_H_
89 #define	_RESOLV_H_
90 
91 #include <sys/param.h>
92 #if (!defined(BSD)) || (BSD < 199306)
93 # include <sys/bitypes.h>
94 #else
95 # include <sys/types.h>
96 #endif
97 #include <sys/cdefs.h>
98 #include <sys/socket.h>
99 #include <stdio.h>
100 
101 /*
102  * Revision information.  This is the release date in YYYYMMDD format.
103  * It can change every day so the right thing to do with it is use it
104  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
105  * compare for equality; rather, use it to determine whether your resolver
106  * is new enough to contain a certain feature.
107  */
108 
109 #define	__RES	19960801
110 
111 /*
112  * Resolver configuration file.
113  * Normally not present, but may contain the address of the
114  * initial name server(s) to query and the domain search list.
115  */
116 
117 #ifndef _PATH_RESCONF
118 #define _PATH_RESCONF        "/etc/resolv.conf"
119 #endif
120 
121 /*
122  * Global defines and variables for resolver stub.
123  */
124 #define	MAXNS			3	/* max # name servers we'll track */
125 #define	MAXDFLSRCH		3	/* # default domain levels to try */
126 #define	MAXDNSRCH		6	/* max # domains in search path */
127 #define	LOCALDOMAINPARTS	2	/* min levels in name that is "local" */
128 #define MAXDNSLUS		4	/* max # of host lookup types */
129 
130 #define	RES_TIMEOUT		5	/* min. seconds between retries */
131 #define	MAXRESOLVSORT		10	/* number of net to sort on */
132 #define	RES_MAXNDOTS		15	/* should reflect bit field size */
133 
134 struct __res_state {
135 	int	retrans;	 	/* retransmission time interval */
136 	int	retry;			/* number of times to retransmit */
137 	unsigned int	options;	/* option flags - see below. */
138 	int	nscount;		/* number of name servers */
139 	struct sockaddr_in
140 		nsaddr_list[MAXNS];	/* address of name server */
141 #define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
142 	unsigned short	id;		/* current message id */
143 	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
144 	char	defdname[256];		/* default domain (deprecated) */
145 	unsigned int	pfcode;		/* RES_PRF_ flags - see below. */
146 	unsigned ndots:4;		/* threshold for initial abs. query */
147 	unsigned nsort:4;		/* number of elements in sort_list[] */
148 	char	unused[3];
149 	struct {
150 		struct in_addr	addr;
151 		u_int32_t	mask;
152 	} sort_list[MAXRESOLVSORT];
153 	char    lookups[MAXDNSLUS];
154 	struct timespec	restimespec;
155 	time_t	reschktime;
156 };
157 
158 #if 1 /* INET6 */
159 /*
160  * replacement of __res_state, separated to keep binary compatibility.
161  */
162 struct __res_state_ext {
163 	struct sockaddr_storage nsaddr_list[MAXNS];
164 	struct {
165 		int	af;		/* address family for addr, mask */
166 		union {
167 			struct in_addr ina;
168 			struct in6_addr in6a;
169 		} addr, mask;
170 	} sort_list[MAXRESOLVSORT];
171 };
172 #endif
173 
174 
175 /*
176  * Resolver options (keep these in synch with res_debug.c, please)
177  */
178 #define RES_INIT	0x00000001	/* address initialized */
179 #define RES_DEBUG	0x00000002	/* print debug messages */
180 #define RES_AAONLY	0x00000004	/* authoritative answers only (!IMPL)*/
181 #define RES_USEVC	0x00000008	/* use virtual circuit */
182 #define RES_PRIMARY	0x00000010	/* query primary server only (!IMPL) */
183 #define RES_IGNTC	0x00000020	/* ignore trucation errors */
184 #define RES_RECURSE	0x00000040	/* recursion desired */
185 #define RES_DEFNAMES	0x00000080	/* use default domain name */
186 #define RES_STAYOPEN	0x00000100	/* Keep TCP socket open */
187 #define RES_DNSRCH	0x00000200	/* search up local domain tree */
188 #define	RES_INSECURE1	0x00000400	/* type 1 security disabled */
189 #define	RES_INSECURE2	0x00000800	/* type 2 security disabled */
190 #define	RES_NOALIASES	0x00001000	/* shuts off HOSTALIASES feature */
191 #define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
192 /* KAME extensions: use higher bit to avoid conflict with ISC use */
193 #define	RES_USE_EDNS0	0x40000000	/* use EDNS0 */
194 /* DNSSEC extensions: use higher bit to avoid conflict with ISC use */
195 #define	RES_USE_DNSSEC	0x20000000	/* use DNSSEC using OK bit in OPT */
196 
197 #define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
198 
199 /*
200  * Resolver "pfcode" values.  Used by dig.
201  */
202 #define RES_PRF_STATS	0x00000001
203 /*			0x00000002	*/
204 #define RES_PRF_CLASS   0x00000004
205 #define RES_PRF_CMD	0x00000008
206 #define RES_PRF_QUES	0x00000010
207 #define RES_PRF_ANS	0x00000020
208 #define RES_PRF_AUTH	0x00000040
209 #define RES_PRF_ADD	0x00000080
210 #define RES_PRF_HEAD1	0x00000100
211 #define RES_PRF_HEAD2	0x00000200
212 #define RES_PRF_TTLID	0x00000400
213 #define RES_PRF_HEADX	0x00000800
214 #define RES_PRF_QUERY	0x00001000
215 #define RES_PRF_REPLY	0x00002000
216 #define RES_PRF_INIT    0x00004000
217 /*			0x00008000	*/
218 
219 /* hooks are still experimental as of 4.9.2 */
220 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
221 	res_sendhookact;
222 
223 typedef res_sendhookact (*res_send_qhook)(struct sockaddr_in * const *ns,
224 					      const unsigned char **query,
225 					      int *querylen,
226 					      unsigned char *ans,
227 					      int anssiz,
228 					      int *resplen);
229 
230 typedef res_sendhookact (*res_send_rhook)(const struct sockaddr_in *ns,
231 					      const unsigned char *query,
232 					      int querylen,
233 					      unsigned char *ans,
234 					      int anssiz,
235 					      int *resplen);
236 
237 struct res_sym {
238 	int	number;		/* Identifying number, like T_MX */
239 	char *	name;		/* Its symbolic name, like "MX" */
240 	char *	humanname;	/* Its fun name, like "mail exchanger" */
241 };
242 
243 extern struct __res_state _res;
244 #if 1 /* INET6 */
245 extern struct __res_state_ext _res_ext;
246 #endif
247 extern const struct res_sym __p_class_syms[];
248 extern const struct res_sym __p_type_syms[];
249 
250 /* Private routines shared between libc/net, named, nslookup and others. */
251 #define	res_hnok	__res_hnok
252 #define	res_ownok	__res_ownok
253 #define	res_mailok	__res_mailok
254 #define	res_dnok	__res_dnok
255 #define	sym_ston	__sym_ston
256 #define	sym_ntos	__sym_ntos
257 #define	sym_ntop	__sym_ntop
258 #define b64_ntop	__b64_ntop
259 #define	b64_pton	__b64_pton
260 #define	loc_ntoa	__loc_ntoa
261 #define	loc_aton	__loc_aton
262 #define	dn_skipname	__dn_skipname
263 #define	fp_resstat	__fp_resstat
264 #define	fp_query	__fp_query
265 #define	fp_nquery	__fp_nquery
266 #define	hostalias	__hostalias
267 #define	putlong		__putlong
268 #define	putshort	__putshort
269 #define p_class		__p_class
270 #define p_time		__p_time
271 #define p_type		__p_type
272 #define	p_query		__p_query
273 #define	p_cdnname	__p_cdnname
274 #define	p_cdname	__p_cdname
275 #define	p_fqnname	__p_fqnname
276 #define	p_fqname	__p_fqname
277 #define	p_rr		__p_rr
278 #define	p_option	__p_option
279 #define	p_secstodate	__p_secstodate
280 #define	dn_count_labels	__dn_count_labels
281 #define	dn_comp		__dn_comp
282 #define	res_randomid	__res_randomid
283 #define	res_send	__res_send
284 #define	res_isourserver	__res_isourserver
285 #define	res_nameinquery	__res_nameinquery
286 #define	res_queriesmatch __res_queriesmatch
287 #define	res_close	__res_close
288 #define	res_opt		__res_opt
289 
290 #ifdef BIND_RES_POSIX3
291 #define	dn_expand	__dn_expand
292 #define	res_init	__res_init
293 #define	res_query	__res_query
294 #define	res_search	__res_search
295 #define	res_querydomain	__res_querydomain
296 #define	res_mkquery	__res_mkquery
297 #endif
298 
299 __BEGIN_DECLS
300 int			res_hnok(const char *);
301 int			res_ownok(const char *);
302 int			res_mailok(const char *);
303 int			res_dnok(const char *);
304 int			sym_ston(const struct res_sym *, char *, int *);
305 const char *		sym_ntos(const struct res_sym *, int, int *);
306 const char *		sym_ntop(const struct res_sym *, int, int *);
307 int			b64_ntop(unsigned char const *, size_t, char *, size_t);
308 int			b64_pton(char const *, unsigned char *, size_t);
309 int			loc_aton(const char *, unsigned char *);
310 const char *		loc_ntoa(const unsigned char *, char *);
311 int			dn_skipname(const unsigned char *,
312 			    const unsigned char *);
313 void			fp_resstat(struct __res_state *, FILE *);
314 void			fp_query(const unsigned char *, FILE *);
315 void			fp_nquery(const unsigned char *, int, FILE *);
316 const char *		hostalias(const char *);
317 void			putlong(u_int32_t, unsigned char *);
318 void			putshort(u_int16_t, unsigned char *);
319 const char *		p_class(int);
320 const char *		p_time(u_int32_t);
321 const char *		p_type(int);
322 void			p_query(const unsigned char *);
323 const unsigned char *	p_cdnname(const unsigned char *, const unsigned char *,
324 			    int, FILE *);
325 const unsigned char *	p_cdname(const unsigned char *, const unsigned char *,
326 			    FILE *);
327 const unsigned char *	p_fqnname(const unsigned char *, const unsigned char *,
328 			    int, char *, int);
329 const unsigned char *	p_fqname(const unsigned char *, const unsigned char *,
330 			    FILE *);
331 const unsigned char *	p_rr(const unsigned char *, const unsigned char *,
332 			    FILE *);
333 const char *		p_option(unsigned long);
334 char *			p_secstodate(unsigned long);
335 int			dn_count_labels(char *);
336 int			dn_comp(const char *, unsigned char *, int,
337 			    unsigned char **, unsigned char **);
338 int			dn_expand(const unsigned char *, const unsigned char *,
339 			    const unsigned char *, char *, int);
340 int			res_init(void);
341 int			_res_init(int);
342 unsigned int		res_randomid(void);
343 int			res_query(const char *, int, int, unsigned char *, int)
344 			__attribute__((__bounded__(__string__,4,5)));
345 int			res_search(const char *, int, int, unsigned char *, int)
346 			    __attribute__((__bounded__(__string__,4,5)));
347 int			res_querydomain(const char *, const char *, int, int,
348 			    unsigned char *, int)
349 			__attribute__((__bounded__(__string__,5,6)));
350 int			res_mkquery(int, const char *, int, int,
351 			    const unsigned char *, int, const unsigned char *,
352 			    unsigned char *, int)
353 			__attribute__((__bounded__(__string__,5,6)))
354 			__attribute__((__bounded__(__string__,8,9)));
355 int			res_send(const unsigned char *, int, unsigned char *,
356 			    int)
357 			__attribute__((__bounded__(__string__,3,4)));
358 int			res_isourserver(const struct sockaddr_in *);
359 int			res_nameinquery(const char *, int, int,
360 			    const unsigned char *, const unsigned char *);
361 int			res_queriesmatch(const unsigned char *,
362 			    const unsigned char *, const unsigned char *,
363 			    const unsigned char *);
364 void			res_close(void);
365 __END_DECLS
366 
367 #endif /* !_RESOLV_H_ */
368