xref: /illumos-gate/usr/src/head/resolv.h (revision 7c478bd9)
1 /*
2  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
3  * Use is subject to license terms.
4  *
5  * Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T
6  * All Rights Reserved
7  *
8  * Portions of this source code were derived from Berkeley
9  * 4.3 BSD under license from the regents of the University of
10  * California.
11  */
12 
13 /*
14  * BIND 4.9.4:
15  */
16 
17 /*
18  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
19  *
20  * Permission to use, copy, modify, and distribute this software for any
21  * purpose with or without fee is hereby granted, provided that the above
22  * copyright notice and this permission notice appear in all copies, and that
23  * the name of Digital Equipment Corporation not be used in advertising or
24  * publicity pertaining to distribution of the document or software without
25  * specific, written prior permission.
26  *
27  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
28  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
29  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
30  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
31  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
33  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
34  * SOFTWARE.
35  * --Copyright--
36  *
37  * End BIND 4.9.4
38  */
39 
40 /*
41  * Copyright (c) 1983, 1987, 1989
42  *    The Regents of the University of California.  All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  * 	This product includes software developed by the University of
55  * 	California, Berkeley and its contributors.
56  * 4. Neither the name of the University nor the names of its contributors
57  *    may be used to endorse or promote products derived from this software
58  *    without specific prior written permission.
59  *
60  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
70  * SUCH DAMAGE.
71  */
72 
73 /*
74  * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
75  *
76  * Permission to use, copy, modify, and distribute this software for any
77  * purpose with or without fee is hereby granted, provided that the above
78  * copyright notice and this permission notice appear in all copies.
79  *
80  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
81  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
82  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
83  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
84  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
85  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
86  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
87  * SOFTWARE.
88  */
89 
90 /*
91  *	@(#)resolv.h	8.1 (Berkeley) 6/2/93
92  *	$Id: resolv.h,v 8.52 2003/04/29 02:27:03 marka Exp $
93  */
94 
95 #ifndef _RESOLV_H_
96 #define	_RESOLV_H_
97 
98 #pragma ident	"%Z%%M%	%I%	%E% SMI"
99 
100 #include <sys/param.h>
101 
102 #include <stdio.h>
103 #include <arpa/nameser.h>
104 #include <sys/socket.h>
105 
106 #ifdef	__cplusplus
107 extern "C" {
108 #endif
109 
110 /*
111  * Revision information.  This is the release date in YYYYMMDD format.
112  * It can change every day so the right thing to do with it is use it
113  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
114  * compare for equality; rather, use it to determine whether your resolver
115  * is new enough to contain a certain feature.
116  */
117 
118 #define	__RES	20030124
119 
120 #define	RES_SET_H_ERRNO(r, x)	__h_errno_set(r, x)
121 struct __res_state;					/* forward */
122 
123 void __h_errno_set(struct __res_state *res, int err);
124 
125 /*
126  * Resolver configuration file.
127  * Normally not present, but may contain the address of the
128  * initial name server(s) to query and the domain search list.
129  */
130 
131 #ifndef _PATH_RESCONF
132 #define	_PATH_RESCONF		"/etc/resolv.conf"
133 #endif
134 
135 #ifdef __STDC__
136 #ifndef __P
137 #define	__P(x)	x
138 #endif
139 #else
140 #ifndef __P
141 #define	__P(x)	()
142 #endif
143 #endif /* __STDC__ */
144 
145 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
146 	res_sendhookact;
147 
148 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr * const *ns,
149 						const uchar_t **query,
150 						int *querylen,
151 						uchar_t *ans,
152 						int anssiz,
153 						int *resplen));
154 
155 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr *ns,
156 						const uchar_t *query,
157 						int querylen,
158 						uchar_t *ans,
159 						int anssiz,
160 						int *resplen));
161 
162 struct res_sym {
163 	int		number;	   /* Identifying number, like T_MX */
164 	const char 	*name;	   /* Its symbolic name, like "MX" */
165 	const char 	*humanname; /* Its fun name, like "mail exchanger" */
166 };
167 
168 /*
169  * Global defines and variables for resolver stub.
170  */
171 /* ADDRSORT and MAXADDR retained for compatibility; not used */
172 #define	ADDRSORT	1	/* enable the address-sorting option */
173 #define	MAXADDR		10	/* max # addresses to sort by */
174 
175 #define	MAXNS			3	/* max # name servers we'll track */
176 #define	MAXDFLSRCH		3	/* # default domain levels to try */
177 #define	MAXDNSRCH		6	/* max # domains in search path */
178 #define	LOCALDOMAINPARTS	2	/* min levels in name that is "local" */
179 
180 #define	RES_TIMEOUT		5	/* min. seconds between retries */
181 #define	MAXRESOLVSORT		10	/* number of net to sort on */
182 #define	RES_MAXNDOTS		15	/* should reflect bit field size */
183 #define	RES_MAXRETRANS		30	/* only for resolv.conf/RES_OPTIONS */
184 #define	RES_MAXRETRY		5	/* only for resolv.conf/RES_OPTIONS */
185 #define	RES_DFLRETRY		2	/* Default #/tries. */
186 #define	RES_MAXTIME		65535	/* Infinity, in milliseconds. */
187 
188 struct __res_state_ext;
189 
190 struct __res_state {
191 	int	retrans;		/* retransmission time interval */
192 	int	retry;			/* number of times to retransmit */
193 #ifdef __sun
194 	uint_t	options;		/* option flags - see below. */
195 #else
196 	ulong_t	options;		/* option flags - see below. */
197 #endif
198 	int	nscount;		/* number of name servers */
199 	struct sockaddr_in
200 		nsaddr_list[MAXNS];	/* address of name server */
201 #define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
202 	ushort_t id;			/* current packet id */
203 	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
204 	char	defdname[256];		/* default domain (deprecated) */
205 #ifdef __sun
206 	uint_t	pfcode;			/* RES_PRF_ flags - see below. */
207 #else
208 	ulong_t	pfcode;			/* RES_PRF_ flags - see below. */
209 #endif
210 	unsigned ndots:4;		/* threshold for initial abs. query */
211 	unsigned nsort:4;		/* number of elements in sort_list[] */
212 	char	unused[3];
213 	struct {
214 		struct in_addr	addr;
215 		unsigned int	mask;
216 	} sort_list[MAXRESOLVSORT];
217 	res_send_qhook qhook;		/* query hook */
218 	res_send_rhook rhook;		/* response hook */
219 	int		res_h_errno;	/* last one set for this context */
220 	int		_vcsock;	/* PRIVATE: for res_send VC i/o */
221 	uint_t	_flags;		/* PRIVATE: see below */
222 	uint_t	_pad;			/* make _u 64 bit aligned */
223 	union {
224 		/* On an 32-bit arch this means 512b total. */
225 		char	pad[72 - 4*sizeof (int) - 2*sizeof (void *)];
226 		struct {
227 			uint16_t		nscount;
228 			uint16_t		nstimes[MAXNS];	/* ms. */
229 			int			nssocks[MAXNS];
230 			struct __res_state_ext *ext;	/* extention for IPv6 */
231 		} _ext;
232 	} _u;
233 };
234 
235 typedef	struct __res_state	*res_state;
236 
237 union res_sockaddr_union {
238 	struct sockaddr_in	sin;
239 #ifdef IN6ADDR_ANY_INIT
240 	struct sockaddr_in6	sin6;
241 #endif
242 #ifdef ISC_ALIGN64
243 	int64_t			__align64;	/* 64bit alignment */
244 #else
245 	int32_t			__align32;	/* 32bit alignment */
246 #endif
247 	char			__space[128];   /* max size */
248 };
249 
250 /*
251  * Resolver flags (used to be discrete per-module statics ints).
252  */
253 #define	RES_F_VC	0x00000001	/* socket is TCP */
254 #define	RES_F_CONN	0x00000002	/* socket is connected */
255 #define	RES_F_EDNS0ERR	0x00000004	/* EDNS0 caused errors */
256 #define	RES_F__UNUSED	0x00000008	/* (unused) */
257 #define	RES_F_LASTMASK	0x000000F0	/* ordinal server of last res_nsend */
258 #define	RES_F_LASTSHIFT	4		/* bit position of LASTMASK "flag" */
259 #define	RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT)
260 
261 /* res_findzonecut2() options */
262 #define	RES_EXHAUSTIVE	0x00000001	/* always do all queries */
263 #define	RES_IPV4ONLY	0x00000002	/* IPv4 only */
264 #define	RES_IPV6ONLY	0x00000004	/* IPv6 only */
265 
266 /*
267  * Resolver options (keep these in synch with res_debug.c, please)
268  */
269 #define	RES_INIT	0x00000001	/* address initialized */
270 #define	RES_DEBUG	0x00000002	/* print debug messages */
271 #define	RES_AAONLY	0x00000004	/* authoritative answers only (!IMPL) */
272 #define	RES_USEVC	0x00000008	/* use virtual circuit */
273 #define	RES_PRIMARY	0x00000010	/* query primary server only (!IMPL) */
274 #define	RES_IGNTC	0x00000020	/* ignore trucation errors */
275 #define	RES_RECURSE	0x00000040	/* recursion desired */
276 #define	RES_DEFNAMES	0x00000080	/* use default domain name */
277 #define	RES_STAYOPEN	0x00000100	/* Keep TCP socket open */
278 #define	RES_DNSRCH	0x00000200	/* search up local domain tree */
279 #define	RES_INSECURE1	0x00000400	/* type 1 security disabled */
280 #define	RES_INSECURE2	0x00000800	/* type 2 security disabled */
281 #define	RES_NOALIASES	0x00001000	/* shuts off HOSTALIASES feature */
282 #define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
283 #define	RES_ROTATE	0x00004000	/* rotate ns list after each query */
284 #define	RES_NOCHECKNAME	0x00008000	/* do not check names for sanity. */
285 #define	RES_KEEPTSIG	0x00010000	/* do not strip TSIG records */
286 #define	RES_BLAST	0x00020000	/* blast all recursive servers */
287 #define	RES_NO_NIBBLE	0x00040000	/* disable IPv6 nibble mode reverse */
288 #define	RES_NO_BITSTRING 0x00080000	/* disable IPv6 bitstring mode revrse */
289 #define	RES_NOTLDQUERY	0x00100000	/* don't unqualified name as a tld */
290 #define	RES_USE_DNSSEC	0x00200000	/* use DNSSEC using OK bit in OPT */
291 /* KAME extensions: use higher bit to avoid conflict with ISC use */
292 #define	RES_USE_DNAME	0x10000000	/* use DNAME */
293 #define	RES_USE_EDNS0	0x40000000	/* use EDNS0 if configured */
294 #define	RES_NO_NIBBLE2	0x80000000	/* disable alternate nibble lookup */
295 
296 #define	RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
297 
298 /*
299  * Resolver "pfcode" values.  Used by dig.
300  */
301 #define	RES_PRF_STATS	0x00000001
302 #define	RES_PRF_UPDATE	0x00000002
303 #define	RES_PRF_CLASS   0x00000004
304 #define	RES_PRF_CMD		0x00000008
305 #define	RES_PRF_QUES	0x00000010
306 #define	RES_PRF_ANS		0x00000020
307 #define	RES_PRF_AUTH	0x00000040
308 #define	RES_PRF_ADD		0x00000080
309 #define	RES_PRF_HEAD1	0x00000100
310 #define	RES_PRF_HEAD2	0x00000200
311 #define	RES_PRF_TTLID	0x00000400
312 #define	RES_PRF_HEADX	0x00000800
313 #define	RES_PRF_QUERY	0x00001000
314 #define	RES_PRF_REPLY	0x00002000
315 #define	RES_PRF_INIT	0x00004000
316 #define	RES_PRF_TRUNC	0x00008000
317 /*			0x00010000	*/
318 
319 /* Things involving an internal (static) resolver context. */
320 #ifdef _REENTRANT
321 extern struct __res_state *__res_state(void);
322 #define	_res (*__res_state())
323 #else
324 #ifndef __BIND_NOSTATIC
325 extern struct __res_state _res;
326 #endif
327 #endif
328 
329 #ifndef __BIND_NOSTATIC
330 void		fp_nquery __P((const uchar_t *, int, FILE *));
331 void		fp_query __P((const uchar_t *, FILE *));
332 const char *hostalias __P((const char *));
333 void		p_query __P((const uchar_t *));
334 void		res_close __P((void));
335 int		res_init __P((void));
336 int		res_isourserver __P((const struct sockaddr_in *));
337 int		res_mkquery __P((int, const char *, int, int, const uchar_t *,
338 				int, const uchar_t *, uchar_t *, int));
339 int		res_query	__P((const char *, int, int, uchar_t *, int));
340 int		res_querydomain __P((const char *, const char *, int, int,
341 				uchar_t *, int));
342 int		res_search __P((const char *, int, int, uchar_t *, int));
343 int		res_send __P((const uchar_t *, int, uchar_t *, int));
344 int		res_sendsigned __P((const uchar_t *, int, ns_tsig_key *,
345 				    uchar_t *, int));
346 #endif	/* __BIND_NOSTATIC */
347 
348 extern const struct res_sym __p_key_syms[];
349 extern const struct res_sym __p_cert_syms[];
350 extern const struct res_sym __p_class_syms[];
351 extern const struct res_sym __p_type_syms[];
352 extern const struct res_sym __p_rcode_syms[];
353 
354 int		res_hnok __P((const char *));
355 int		res_ownok __P((const char *));
356 int		res_mailok __P((const char *));
357 int		res_dnok __P((const char *));
358 int		sym_ston __P((const struct res_sym *, const char *, int *));
359 const char	*sym_ntos __P((const struct res_sym *, int, int *));
360 const char	*sym_ntop __P((const struct res_sym *, int, int *));
361 int		b64_ntop __P((uchar_t const *, size_t, char *, size_t));
362 int		b64_pton __P((char const *, uchar_t *, size_t));
363 int		loc_aton __P((const char *ascii, uchar_t *binary));
364 const char	*loc_ntoa __P((const uchar_t *binary, char *ascii));
365 int		dn_skipname __P((const uchar_t *, const uchar_t *));
366 void		putlong __P((unsigned int, uchar_t *));
367 void		putshort __P((unsigned short, uchar_t *));
368 const char	*p_class __P((int));
369 const char	*p_time __P((unsigned int));
370 const char	*p_type __P((int));
371 const char	*p_rcode __P((int));
372 const char	*p_sockun __P((union res_sockaddr_union, char *, size_t));
373 const uchar_t	*p_cdnname __P((const uchar_t *, const uchar_t *, int,
374 			FILE *));
375 const uchar_t	*p_cdname __P((const uchar_t *, const uchar_t *, FILE *));
376 const uchar_t	*p_fqnname __P((const uchar_t *cp, const uchar_t *msg,
377 			int, char *, int));
378 const uchar_t	*p_fqname __P((const uchar_t *, const uchar_t *, FILE *));
379 const char	*p_option __P((uint_t option));
380 char		*p_secstodate __P((uint_t));
381 int		dn_count_labels __P((const char *));
382 int		dn_comp __P((const char *, uchar_t *, int,
383 				uchar_t **, uchar_t **));
384 int		dn_expand __P((const uchar_t *, const uchar_t *,
385 			const uchar_t *, char *, int));
386 uint_t		res_randomid __P((void));
387 int		res_nameinquery __P((const char *, int, int,
388 				const uchar_t *, const uchar_t *));
389 int		res_queriesmatch __P((const uchar_t *, const uchar_t *,
390 				const uchar_t *, const uchar_t *));
391 const char	*p_section __P((int section, int opcode));
392 
393 
394 /* Things involving a resolver context. */
395 int		res_ninit __P((res_state));
396 int		res_nisourserver __P((const res_state,
397 				const struct sockaddr_in *));
398 void	fp_resstat __P((const res_state, FILE *));
399 void	res_pquery	__P((const res_state, const uchar_t *, int, FILE *));
400 const char	*res_hostalias __P((const res_state, const char *,
401 				char *, size_t));
402 int		res_nquery __P((res_state,
403 				const char *, int, int, uchar_t *, int));
404 int		res_nsearch __P((res_state, const char *, int,
405 				int, uchar_t *, int));
406 int		res_nquerydomain __P((res_state,
407 				const char *, const char *, int, int,
408 				uchar_t *, int));
409 int		res_nmkquery __P((res_state,
410 				int, const char *, int, int, const uchar_t *,
411 				int, const uchar_t *, uchar_t *, int));
412 int		res_nsend __P((res_state, const uchar_t *, int, uchar_t *,
413 				int));
414 int		res_nsendsigned __P((res_state, const uchar_t *, int,
415 				ns_tsig_key *, uchar_t *, int));
416 int		res_findzonecut __P((res_state, const char *, ns_class, int,
417 				char *, size_t, struct in_addr *, int));
418 int		res_findzonecut2 __P((res_state, const char *, ns_class, int,
419 				char *, size_t, union res_sockaddr_union *,
420 				int));
421 void		res_nclose __P((res_state));
422 int		res_nopt __P((res_state, int, uchar_t *, int, int));
423 void		res_send_setqhook __P((res_send_qhook hook));
424 void		res_send_setrhook __P((res_send_rhook hook));
425 int		__res_vinit __P((res_state, int));
426 void		res_destroyservicelist __P((void));
427 const char 	*res_servicename __P((uint16_t port, const char *proto));
428 const char 	*res_protocolname __P((int num));
429 void		res_destroyprotolist __P((void));
430 void		res_buildprotolist __P((void));
431 const char 	*res_get_nibblesuffix __P((res_state));
432 const char 	*res_get_nibblesuffix2 __P((res_state));
433 void		res_ndestroy __P((res_state));
434 uint16_t	res_nametoclass __P((const char *buf, int *success));
435 uint16_t	res_nametotype __P((const char *buf, int *success));
436 void		res_setservers __P((res_state,
437 				    const union res_sockaddr_union *, int));
438 int		res_getservers __P((res_state,
439 				    union res_sockaddr_union *, int));
440 
441 
442 #ifdef	__cplusplus
443 }
444 #endif
445 
446 #endif /* !_RESOLV_H_ */
447