xref: /haiku/headers/posix/resolv.h (revision 820dca4df6c7bf955c46e8f6521b9408f50b2900)
1 /*
2  * Copyright 2009-2012 Haiku, Inc. All Rights Reserved.
3  * Distributed under the terms of the MIT License.
4  */
5 
6 /*
7  * Portions Copyright (C) 2004, 2005, 2008, 2009  Internet Systems Consortium, Inc. ("ISC")
8  * Portions Copyright (C) 1995-2003  Internet Software Consortium.
9  *
10  * Permission to use, copy, modify, and/or distribute this software for any
11  * purpose with or without fee is hereby granted, provided that the above
12  * copyright notice and this permission notice appear in all copies.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
15  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
16  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
17  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
18  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
19  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
20  * PERFORMANCE OF THIS SOFTWARE.
21  */
22 
23 /*
24  * Copyright (c) 1983, 1987, 1989
25  *    The Regents of the University of California.  All rights reserved.
26  *
27  * Redistribution and use in source and binary forms, with or without
28  * modification, are permitted provided that the following conditions
29  * are met:
30  * 1. Redistributions of source code must retain the above copyright
31  *    notice, this list of conditions and the following disclaimer.
32  * 2. Redistributions in binary form must reproduce the above copyright
33  *    notice, this list of conditions and the following disclaimer in the
34  *    documentation and/or other materials provided with the distribution.
35  * 3. All advertising materials mentioning features or use of this software
36  *    must display the following acknowledgement:
37  * 	This product includes software developed by the University of
38  * 	California, Berkeley and its contributors.
39  * 4. Neither the name of the University nor the names of its contributors
40  *    may be used to endorse or promote products derived from this software
41  *    without specific prior written permission.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53  * SUCH DAMAGE.
54  */
55 
56 #ifndef _RESOLV_H_
57 #define	_RESOLV_H_
58 
59 #include <sys/param.h>
60 #include <sys/types.h>
61 #include <sys/cdefs.h>
62 #include <sys/socket.h>
63 #include <stdio.h>
64 #include <arpa/nameser.h>
65 
66 /*
67  * Revision information.  This is the release date in YYYYMMDD format.
68  * It can change every day so the right thing to do with it is use it
69  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
70  * compare for equality; rather, use it to determine whether your resolver
71  * is new enough to contain a certain feature.
72  */
73 
74 #define	__RES	20090302
75 
76 /*
77  * This used to be defined in res_query.c, now it's in herror.c.
78  * [XXX no it's not.  It's in irs/irs_data.c]
79  * It was
80  * never extern'd by any *.h file before it was placed here.  For thread
81  * aware programs, the last h_errno value set is stored in res->h_errno.
82  *
83  * XXX:	There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO
84  *	(and __h_errno_set) to the public via <resolv.h>.
85  * XXX:	__h_errno_set is really part of IRS, not part of the resolver.
86  *	If somebody wants to build and use a resolver that doesn't use IRS,
87  *	what do they do?  Perhaps something like
88  *		#ifdef WANT_IRS
89  *		# define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
90  *		#else
91  *		# define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
92  *		#endif
93  */
94 
95 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
96 struct __res_state; /* forward */
97 __BEGIN_DECLS
98 void __h_errno_set(struct __res_state *res, int err);
99 __END_DECLS
100 
101 
102 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
103 	res_sendhookact;
104 
105 #ifndef __PMT
106 #if defined(__STDC__) || defined(__cplusplus)
107 #define __PMT(args) args
108 #else
109 #define __PMT(args) ()
110 #endif
111 #endif
112 
113 typedef res_sendhookact (*res_send_qhook)(struct sockaddr * const *,
114 	const u_char **, int *, u_char *, int, int *);
115 
116 typedef res_sendhookact (*res_send_rhook)(const struct sockaddr *,
117 	const u_char *, int, u_char *, int, int *);
118 
119 struct res_sym {
120 	int			number;	   /* Identifying number, like T_MX */
121 	const char *name;	   /* Its symbolic name, like "MX" */
122 	const char *humanname; /* Its fun name, like "mail exchanger" */
123 };
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	RES_TIMEOUT			5	/* min. seconds between retries */
133 #define	MAXRESOLVSORT		10	/* number of net to sort on */
134 #define	RES_MAXNDOTS		15	/* should reflect bit field size */
135 #define	RES_MAXRETRANS		30	/* only for resolv.conf/RES_OPTIONS */
136 #define	RES_MAXRETRY		5	/* only for resolv.conf/RES_OPTIONS */
137 #define	RES_DFLRETRY		2	/* Default #/tries. */
138 #define	RES_MAXTIME			65535	/* Infinity, in milliseconds. */
139 struct __res_state_ext;
140 
141 struct __res_state {
142 	int	retrans;		 	/* retransmission time interval */
143 	int	retry;				/* number of times to retransmit */
144 #ifdef sun
145 	u_int	options;		/* option flags - see below. */
146 #else
147 	u_long	options;		/* option flags - see below. */
148 #endif
149 	int	nscount;			/* number of name servers */
150 	struct sockaddr_in
151 		nsaddr_list[MAXNS];	/* address of name server */
152 #define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
153 	u_short	id;				/* current message id */
154 	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
155 	char	defdname[256];	/* default domain (deprecated) */
156 #ifdef sun
157 	u_int	pfcode;			/* RES_PRF_ flags - see below. */
158 #else
159 	u_long	pfcode;			/* RES_PRF_ flags - see below. */
160 #endif
161 	unsigned ndots:4;		/* threshold for initial abs. query */
162 	unsigned nsort:4;		/* number of elements in sort_list[] */
163 	char	unused[3];
164 	struct {
165 		struct in_addr	addr;
166 		u_int32_t	mask;
167 	} sort_list[MAXRESOLVSORT];
168 	res_send_qhook qhook;	/* query hook */
169 	res_send_rhook rhook;	/* response hook */
170 	int	res_h_errno;		/* last one set for this context */
171 	int	_vcsock;			/* PRIVATE: for res_send VC i/o */
172 	u_int	_flags;			/* PRIVATE: see below */
173 	u_char	_rnd[16];		/* PRIVATE: random state */
174 	u_int	_pad;			/* make _u 64 bit aligned */
175 	union {
176 		/* On an 32-bit arch this means 512b total. */
177 		char	pad[56 - 4*sizeof (int) - 2*sizeof (void *)];
178 		struct {
179 			u_int16_t		nscount;
180 			u_int16_t		nstimes[MAXNS];	/* ms. */
181 			int			nssocks[MAXNS];
182 			struct __res_state_ext *ext;	/* extention for IPv6 */
183 		} _ext;
184 	} _u;
185 };
186 
187 typedef struct __res_state *res_state;
188 
189 union res_sockaddr_union {
190 	struct sockaddr_in	sin;
191 	struct sockaddr_in6	sin6;
192 #ifdef ISC_ALIGN64
193 	int64_t			__align64;		/* 64bit alignment */
194 #else
195 	int32_t			__align32;		/* 32bit alignment */
196 #endif
197 	char			__space[128];   /* max size */
198 };
199 
200 /*
201  * Resolver flags (used to be discrete per-module statics ints).
202  */
203 #define	RES_F_VC		0x00000001	/* socket is TCP */
204 #define	RES_F_CONN		0x00000002	/* socket is connected */
205 #define	RES_F_EDNS0ERR	0x00000004	/* EDNS0 caused errors */
206 #define	RES_F__UNUSED	0x00000008	/* (unused) */
207 #define	RES_F_LASTMASK	0x000000F0	/* ordinal server of last res_nsend */
208 #define	RES_F_LASTSHIFT	4			/* bit position of LASTMASK "flag" */
209 #define	RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT)
210 
211 /* res_findzonecut2() options */
212 #define	RES_EXHAUSTIVE	0x00000001	/* always do all queries */
213 #define	RES_IPV4ONLY	0x00000002	/* IPv4 only */
214 #define	RES_IPV6ONLY	0x00000004	/* IPv6 only */
215 
216 /*
217  * Resolver options (keep these in synch with res_debug.c, please)
218  */
219 #define RES_INIT		0x00000001	/* address initialized */
220 #define RES_DEBUG		0x00000002	/* print debug messages */
221 #define RES_AAONLY		0x00000004	/* authoritative answers only (!IMPL)*/
222 #define RES_USEVC		0x00000008	/* use virtual circuit */
223 #define RES_PRIMARY		0x00000010	/* query primary server only (!IMPL) */
224 #define RES_IGNTC		0x00000020	/* ignore trucation errors */
225 #define RES_RECURSE		0x00000040	/* recursion desired */
226 #define RES_DEFNAMES	0x00000080	/* use default domain name */
227 #define RES_STAYOPEN	0x00000100	/* Keep TCP socket open */
228 #define RES_DNSRCH		0x00000200	/* search up local domain tree */
229 #define	RES_INSECURE1	0x00000400	/* type 1 security disabled */
230 #define	RES_INSECURE2	0x00000800	/* type 2 security disabled */
231 #define	RES_NOALIASES	0x00001000	/* shuts off HOSTALIASES feature */
232 #define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
233 #define RES_ROTATE		0x00004000	/* rotate ns list after each query */
234 #define	RES_NOCHECKNAME	0x00008000	/* do not check names for sanity. */
235 #define	RES_KEEPTSIG	0x00010000	/* do not strip TSIG records */
236 #define	RES_BLAST		0x00020000	/* blast all recursive servers */
237 #define RES_NSID		0x00040000	/* request name server ID */
238 #define RES_NOTLDQUERY	0x00100000	/* don't unqualified name as a tld */
239 #define RES_USE_DNSSEC	0x00200000	/* use DNSSEC using OK bit in OPT */
240 /* #define RES_DEBUG2	0x00400000 */	/* nslookup internal */
241 /* KAME extensions: use higher bit to avoid conflict with ISC use */
242 #define RES_USE_DNAME	0x10000000	/* use DNAME */
243 #define RES_USE_EDNS0	0x40000000	/* use EDNS0 if configured */
244 #define RES_NO_NIBBLE2	0x80000000	/* disable alternate nibble lookup */
245 
246 #define RES_DEFAULT	\
247 	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH | RES_NO_NIBBLE2)
248 
249 /*
250  * Resolver "pfcode" values.  Used by dig.
251  */
252 #define RES_PRF_STATS	0x00000001
253 #define RES_PRF_UPDATE	0x00000002
254 #define RES_PRF_CLASS   0x00000004
255 #define RES_PRF_CMD		0x00000008
256 #define RES_PRF_QUES	0x00000010
257 #define RES_PRF_ANS		0x00000020
258 #define RES_PRF_AUTH	0x00000040
259 #define RES_PRF_ADD		0x00000080
260 #define RES_PRF_HEAD1	0x00000100
261 #define RES_PRF_HEAD2	0x00000200
262 #define RES_PRF_TTLID	0x00000400
263 #define RES_PRF_HEADX	0x00000800
264 #define RES_PRF_QUERY	0x00001000
265 #define RES_PRF_REPLY	0x00002000
266 #define RES_PRF_INIT	0x00004000
267 #define RES_PRF_TRUNC	0x00008000
268 /*			0x00010000	*/
269 
270 /* Things involving an internal (static) resolver context. */
271 __BEGIN_DECLS
272 extern struct __res_state *__res_state(void);
273 __END_DECLS
274 #define _res (*__res_state())
275 
276 #ifndef __BIND_NOSTATIC
277 #define fp_nquery		__fp_nquery
278 #define fp_query		__fp_query
279 #define hostalias		__hostalias
280 #define p_query			__p_query
281 #define res_close		__res_close
282 #define res_init		__res_init
283 #define res_isourserver	__res_isourserver
284 #define res_mkquery		__res_mkquery
285 #define res_query		__res_query
286 #define res_querydomain	__res_querydomain
287 #define res_search		__res_search
288 #define res_send		__res_send
289 #define res_sendsigned	__res_sendsigned
290 
291 __BEGIN_DECLS
292 void		fp_nquery(const u_char *, int, FILE *);
293 void		fp_query(const u_char *, FILE *);
294 const char *hostalias(const char *);
295 void		p_query(const u_char *);
296 void		res_close(void);
297 int			res_init(void);
298 int			res_isourserver(const struct sockaddr_in *);
299 int			res_mkquery(int, const char *, int, int, const u_char *,
300 				 int, const u_char *, u_char *, int);
301 int			res_query(const char *, int, int, u_char *, int);
302 int			res_querydomain(const char *, const char *, int, int,
303 				u_char *, int);
304 int			res_search(const char *, int, int, u_char *, int);
305 int			res_send(const u_char *, int, u_char *, int);
306 int			res_sendsigned(const u_char *, int, ns_tsig_key *,
307 				u_char *, int);
308 __END_DECLS
309 #endif
310 
311 #if !defined(SHARED_LIBBIND) || defined(LIB)
312 /*
313  * If libbind is a shared object (well, DLL anyway)
314  * these externs break the linker when resolv.h is
315  * included by a lib client (like named)
316  * Make them go away if a client is including this
317  *
318  */
319 extern const struct res_sym __p_key_syms[];
320 extern const struct res_sym __p_cert_syms[];
321 extern const struct res_sym __p_class_syms[];
322 extern const struct res_sym __p_type_syms[];
323 extern const struct res_sym __p_rcode_syms[];
324 #endif /* SHARED_LIBBIND */
325 
326 #define b64_ntop			__b64_ntop
327 #define b64_pton			__b64_pton
328 #define dn_comp				__dn_comp
329 #define dn_count_labels		__dn_count_labels
330 #define dn_expand			__dn_expand
331 #define dn_skipname			__dn_skipname
332 #define fp_resstat			__fp_resstat
333 #define loc_aton			__loc_aton
334 #define loc_ntoa			__loc_ntoa
335 #define p_cdname			__p_cdname
336 #define p_cdnname			__p_cdnname
337 #define p_class				__p_class
338 #define p_fqname			__p_fqname
339 #define p_fqnname			__p_fqnname
340 #define p_option			__p_option
341 #define p_secstodate		__p_secstodate
342 #define p_section			__p_section
343 #define p_time				__p_time
344 #define p_type				__p_type
345 #define p_rcode				__p_rcode
346 #define p_sockun			__p_sockun
347 #define putlong				__putlong
348 #define putshort			__putshort
349 #define res_dnok			__res_dnok
350 #define res_findzonecut		__res_findzonecut
351 #define res_findzonecut2	__res_findzonecut2
352 #define res_hnok			__res_hnok
353 #define res_hostalias		__res_hostalias
354 #define res_mailok			__res_mailok
355 #define res_nameinquery		__res_nameinquery
356 #define res_nclose			__res_nclose
357 #define res_ninit			__res_ninit
358 #define res_nmkquery		__res_nmkquery
359 #define res_pquery			__res_pquery
360 #define res_nquery			__res_nquery
361 #define res_nquerydomain	__res_nquerydomain
362 #define res_nsearch			__res_nsearch
363 #define res_nsend			__res_nsend
364 #define res_nsendsigned		__res_nsendsigned
365 #define res_nisourserver	__res_nisourserver
366 #define res_ownok			__res_ownok
367 #define res_queriesmatch	__res_queriesmatch
368 #define res_rndinit			__res_rndinit
369 #define res_randomid		__res_randomid
370 #define res_nrandomid		__res_nrandomid
371 #define sym_ntop			__sym_ntop
372 #define sym_ntos			__sym_ntos
373 #define sym_ston			__sym_ston
374 #define res_nopt			__res_nopt
375 #define res_nopt_rdata		__res_nopt_rdata
376 #define res_ndestroy		__res_ndestroy
377 #define	res_nametoclass		__res_nametoclass
378 #define	res_nametotype		__res_nametotype
379 #define	res_setservers		__res_setservers
380 #define	res_getservers		__res_getservers
381 #define	res_buildprotolist	__res_buildprotolist
382 #define	res_destroyprotolist	__res_destroyprotolist
383 #define	res_destroyservicelist	__res_destroyservicelist
384 #define	res_get_nibblesuffix	__res_get_nibblesuffix
385 #define	res_get_nibblesuffix2	__res_get_nibblesuffix2
386 #define	res_ourserver_p		__res_ourserver_p
387 #define	res_protocolname	__res_protocolname
388 #define	res_protocolnumber	__res_protocolnumber
389 #define	res_send_setqhook	__res_send_setqhook
390 #define	res_send_setrhook	__res_send_setrhook
391 #define	res_servicename		__res_servicename
392 #define	res_servicenumber	__res_servicenumber
393 
394 __BEGIN_DECLS
395 int				res_hnok(const char *);
396 int				res_ownok(const char *);
397 int				res_mailok(const char *);
398 int				res_dnok(const char *);
399 int				sym_ston(const struct res_sym *, const char *, int *);
400 const char *	sym_ntos(const struct res_sym *, int, int *);
401 const char *	sym_ntop(const struct res_sym *, int, int *);
402 int				b64_ntop(u_char const *, size_t, char *, size_t);
403 int				b64_pton(char const *, u_char *, size_t);
404 int				loc_aton(const char *, u_char *);
405 const char *	loc_ntoa(const u_char *, char *);
406 int				dn_skipname(const u_char *, const u_char *);
407 void			putlong(u_int32_t, u_char *);
408 void			putshort(u_int16_t, u_char *);
409 #if !defined(__ultrix__) && !defined(__HAIKU__)
410 u_int16_t		_getshort(const u_char *);
411 u_int32_t		_getlong(const u_char *);
412 #endif
413 const char *	p_class(int);
414 const char *	p_time(u_int32_t);
415 const char *	p_type(int);
416 const char *	p_rcode(int);
417 const char *	p_sockun(union res_sockaddr_union, char *, size_t);
418 const u_char *	p_cdnname(const u_char *, const u_char *, int, FILE *);
419 const u_char *	p_cdname(const u_char *, const u_char *, FILE *);
420 const u_char *	p_fqnname(const u_char *, const u_char *, int, char *, int);
421 const u_char *	p_fqname(const u_char *, const u_char *, FILE *);
422 const char *	p_option(u_long);
423 char *			p_secstodate(u_long);
424 int				dn_count_labels(const char *);
425 int				dn_comp(const char *, u_char *, int, u_char **, u_char **);
426 int				dn_expand(const u_char *, const u_char *, const u_char *,
427 					char *, int);
428 void			res_rndinit(res_state);
429 u_int			res_randomid(void);
430 u_int			res_nrandomid(res_state);
431 int				res_nameinquery(const char *, int, int, const u_char *,
432 					const u_char *);
433 int				res_queriesmatch(const u_char *, const u_char *, const u_char *,
434 					const u_char *);
435 const char *	p_section(int, int);
436 /* Things involving a resolver context. */
437 int				res_ninit(res_state);
438 int				res_nisourserver(const res_state, const struct sockaddr_in *);
439 void			fp_resstat(const res_state, FILE *);
440 void			res_pquery(const res_state, const u_char *, int, FILE *);
441 const char *	res_hostalias(const res_state, const char *, char *, size_t);
442 int				res_nquery(res_state, const char *, int, int, u_char *, int);
443 int				res_nsearch(res_state, const char *, int, int, u_char *, int);
444 int				res_nquerydomain(res_state, const char *, const char *, int,
445 					int, u_char *, int);
446 int				res_nmkquery(res_state, int, const char *, int, int,
447 					const u_char *, int, const u_char *, u_char *, int);
448 int				res_nsend(res_state, const u_char *, int, u_char *, int);
449 int				res_nsendsigned(res_state, const u_char *, int, ns_tsig_key *,
450 					u_char *, int);
451 int				res_findzonecut(res_state, const char *, ns_class, int, char *,
452 					size_t, struct in_addr *, int);
453 int				res_findzonecut2(res_state, const char *, ns_class, int, char *,
454 					size_t, union res_sockaddr_union *, int);
455 void			res_nclose(res_state);
456 int				res_nopt(res_state, int, u_char *, int, int);
457 int				res_nopt_rdata(res_state, int, u_char *, int, u_char *, u_short,
458 					u_short, u_char *);
459 void			res_send_setqhook(res_send_qhook);
460 void			res_send_setrhook(res_send_rhook);
461 int				__res_vinit(res_state, int);
462 void			res_destroyservicelist(void);
463 const char *	res_servicename(u_int16_t, const char *);
464 const char *	res_protocolname(int);
465 void			res_destroyprotolist(void);
466 void			res_buildprotolist(void);
467 const char *	res_get_nibblesuffix(res_state);
468 const char *	res_get_nibblesuffix2(res_state);
469 void			res_ndestroy(res_state);
470 u_int16_t		res_nametoclass(const char *, int *);
471 u_int16_t		res_nametotype(const char *, int *);
472 void			res_setservers(res_state, const union res_sockaddr_union *,
473 					int);
474 int				res_getservers(res_state, union res_sockaddr_union *, int);
475 __END_DECLS
476 
477 #endif /* !_RESOLV_H_ */
478