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