xref: /haiku/headers/posix/resolv.h (revision d5cd5d63ff0ad395989db6cf4841a64d5b545d1d)
1 /*	$OpenBSD: resolv.h,v 1.7 2001/07/31 22:02:18 jakob 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. All advertising materials mentioning features or use of this software
47  *    must display the following acknowledgement:
48  * 	This product includes software developed by the University of
49  * 	California, Berkeley and its contributors.
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.
53  *
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.
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
89  *	$From: resolv.h,v 8.17 1996/11/26 10:11:20 vixie Exp $
90  */
91 
92 #ifndef _RESOLV_H_
93 #define	_RESOLV_H_
94 
95 /* #include <kernel/OS.h> */
96 #include <sys/param.h>
97 #include <sys/types.h>
98 #include <sys/socket.h>
99 #include <stdio.h>
100 
101 #ifdef __cplusplus
102 extern "C" {
103 #endif
104 
105 /*
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
109  * compare for equality; rather, use it to determine whether your resolver
110  * is new enough to contain a certain feature.
111  */
112 
113 #define	__RES	19960801
114 
115 /*
116  * Resolver configuration file.
117  * Normally not present, but may contain the address of the
118  * initial 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" */
132 #define MAXDNSLUS		4	/* max # of host lookup types */
133 
134 #define	RES_TIMEOUT		5	/* min. seconds between retries */
135 #define	MAXRESOLVSORT		10	/* number of net to sort on */
136 #define	RES_MAXNDOTS		15	/* should reflect bit field size */
137 
138 struct __res_state {
139 	int	retrans;	 	/* retransmition time interval */
140 	int	retry;			/* number of times to retransmit */
141 	u_long	options;		/* option flags - see below. */
142 	int	nscount;		/* number of name servers */
143 	struct sockaddr_in
144 		nsaddr_list[MAXNS];	/* address of name server */
145 #define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
146 	u_short	id;			/* current message id */
147 	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
148 	char	defdname[256];		/* default domain (deprecated) */
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[] */
152 	char	unused[3];
153 	struct {
154 		struct in_addr	addr;
155 		uint32	mask;
156 	} sort_list[MAXRESOLVSORT];
157 	char    lookups[MAXDNSLUS];
158 	char	pad[68];		/* on an i386 this means 512b total */
159 };
160 
161 #ifdef 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 
178 /*
179  * Resolver options (keep these in synch with res_debug.c, please)
180  */
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 */
194 #define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
195 /* KAME extensions: use higher bit to avoid conflict with ISC use */
196 #define	RES_USE_EDNS0	0x40000000	/* use EDNS0 */
197 /* DNSSEC extensions: use higher bit to avoid conflict with ISC use */
198 #define	RES_USE_DNSSEC	0x20000000	/* use DNSSEC using OK bit in OPT */
199 
200 #define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
201 
202 /*
203  * Resolver "pfcode" values.  Used by dig.
204  */
205 #define RES_PRF_STATS	0x00000001
206 /*			0x00000002	*/
207 #define RES_PRF_CLASS   0x00000004
208 #define RES_PRF_CMD	0x00000008
209 #define RES_PRF_QUES	0x00000010
210 #define RES_PRF_ANS	0x00000020
211 #define RES_PRF_AUTH	0x00000040
212 #define RES_PRF_ADD	0x00000080
213 #define RES_PRF_HEAD1	0x00000100
214 #define RES_PRF_HEAD2	0x00000200
215 #define RES_PRF_TTLID	0x00000400
216 #define RES_PRF_HEADX	0x00000800
217 #define RES_PRF_QUERY	0x00001000
218 #define RES_PRF_REPLY	0x00002000
219 #define RES_PRF_INIT    0x00004000
220 /*			0x00008000	*/
221 
222 /* hooks are still experimental as of 4.9.2 */
223 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
224 	res_sendhookact;
225 
226 typedef res_sendhookact (*res_send_qhook)(struct sockaddr_in * const *ns,
227 					      const uchar **query,
228 					      int *querylen,
229 					      uchar *ans,
230 					      int anssiz,
231 					      int *resplen);
232 
233 typedef res_sendhookact (*res_send_rhook)(const struct sockaddr_in *ns,
234 					      const uchar *query,
235 					      int querylen,
236 					      uchar *ans,
237 					      int anssiz,
238 					      int *resplen);
239 
240 struct res_sym {
241 	int	number;		/* Identifying number, like T_MX */
242 	char *	name;		/* Its symbolic name, like "MX" */
243 	char *	humanname;	/* Its fun name, like "mail exchanger" */
244 };
245 
246 extern struct __res_state _res;
247 
248 #ifdef INET6
249 extern struct __res_state_ext _res_ext;
250 #endif
251 extern const struct res_sym __p_class_syms[];
252 extern const struct res_sym __p_type_syms[];
253 
254 /* Private routines shared between libc/net, named, nslookup and others. */
255 #define	res_hnok	__res_hnok
256 #define	res_ownok	__res_ownok
257 #define	res_mailok	__res_mailok
258 #define	res_dnok	__res_dnok
259 #define	sym_ston	__sym_ston
260 #define	sym_ntos	__sym_ntos
261 #define	sym_ntop	__sym_ntop
262 #define b64_ntop	__b64_ntop
263 #define	b64_pton	__b64_pton
264 #define	loc_ntoa	__loc_ntoa
265 #define	loc_aton	__loc_aton
266 #define	dn_skipname	__dn_skipname
267 #define	fp_resstat	__fp_resstat
268 #define	fp_query	__fp_query
269 #define	fp_nquery	__fp_nquery
270 #define	hostalias	__hostalias
271 #define	putlong		__putlong
272 #define	putshort	__putshort
273 #define p_class		__p_class
274 #define p_time		__p_time
275 #define p_type		__p_type
276 #define	p_query		__p_query
277 #define	p_cdnname	__p_cdnname
278 #define	p_cdname	__p_cdname
279 #define	p_fqnname	__p_fqnname
280 #define	p_fqname	__p_fqname
281 #define	p_rr		__p_rr
282 #define	p_option	__p_option
283 #define	p_secstodate	__p_secstodate
284 #define	dn_count_labels	__dn_count_labels
285 #define	dn_comp		__dn_comp
286 #define	res_randomid	__res_randomid
287 #define	res_send	__res_send
288 #define	res_isourserver	__res_isourserver
289 #define	res_nameinquery	__res_nameinquery
290 #define	res_queriesmatch __res_queriesmatch
291 #define	res_close	__res_close
292 #define	res_opt		__res_opt
293 
294 #ifdef BIND_RES_POSIX3
295 #define	dn_expand	__dn_expand
296 #define	res_init	__res_init
297 #define	res_query	__res_query
298 #define	res_search	__res_search
299 #define	res_querydomain	__res_querydomain
300 #define	res_mkquery	__res_mkquery
301 #endif
302 
303 int		res_hnok (const char *);
304 int		res_ownok (const char *);
305 int		res_mailok (const char *);
306 int		res_dnok (const char *);
307 int		sym_ston (const struct res_sym *, char *, int *);
308 const char *	sym_ntos (const struct res_sym *, int, int *);
309 const char *	sym_ntop (const struct res_sym *, int, int *);
310 int		b64_ntop (uchar const *, size_t, char *, size_t);
311 int		b64_pton (char const *, uchar *, size_t);
312 int		loc_aton (const char *, uchar *);
313 const char *	loc_ntoa (const uchar *, char *);
314 int		dn_skipname (const uchar *, const uchar *);
315 void		fp_resstat (struct __res_state *, FILE *);
316 void		fp_query (const uchar *, FILE *);
317 void		fp_nquery (const uchar *, int, FILE *);
318 const char *	hostalias (const char *);
319 void		putlong (uint32, uchar *);
320 void		putshort (uint16, uchar *);
321 const char *	p_class (int);
322 const char *	p_time (uint32);
323 const char *	p_type (int);
324 void		p_query (const uchar *);
325 const uchar *	p_cdnname (const uchar *, const uchar *, int, FILE *);
326 const uchar *	p_cdname (const uchar *, const uchar *, FILE *);
327 const uchar *	p_fqnname (const uchar *cp, const uchar *msg,
328 			       int, char *, int);
329 const uchar *	p_fqname (const uchar *, const uchar *, FILE *);
330 const uchar *	p_rr (const uchar *, const uchar *, FILE *);
331 const char *	p_option (u_long option);
332 char *		p_secstodate (u_long);
333 int		dn_count_labels (char *);
334 int		dn_comp (const char *, uchar *, int,
335 			     uchar **, uchar **);
336 int		dn_expand (const uchar *, const uchar *, const uchar *,
337 			       char *, int);
338 int		res_init (void);
339 uint		res_randomid (void);
340 int		res_query (const char *, int, int, uchar *, int);
341 int		res_search (const char *, int, int, uchar *, int);
342 int		res_querydomain (const char *, const char *, int, int,
343 				     uchar *, int);
344 int		res_mkquery (int, const char *, int, int, const uchar *, int,
345 				 const uchar *, uchar *, int);
346 int		res_send (const uchar *, int, uchar *, int);
347 int		res_isourserver (const struct sockaddr_in *);
348 int		res_nameinquery (const char *, int, int,
349 				     const uchar *, const uchar *);
350 int		res_queriesmatch (const uchar *, const uchar *,
351 				      const uchar *, const uchar *);
352 void		res_close (void);
353 
354 #ifdef __cplusplus
355 }
356 #endif
357 
358 #endif /* !_RESOLV_H_ */
359