resolv.h revision 36888
1/*-
2 * Copyright (c) 1983, 1987, 1989, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 */
33
34/*
35 * Portions Copyright (c) 1996 by Internet Software Consortium.
36 *
37 * Permission to use, copy, modify, and distribute this software for any
38 * purpose with or without fee is hereby granted, provided that the above
39 * copyright notice and this permission notice appear in all copies.
40 *
41 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
42 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
44 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
45 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
46 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
47 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
48 * SOFTWARE.
49 */
50
51/*
52 *	@(#)resolv.h	8.1 (Berkeley) 6/2/93
53 *	From Id: resolv.h,v 8.12 1998/04/28 19:36:46 halley Exp $
54 *	$Id: resolv.h,v 1.14 1997/09/01 01:19:10 brian Exp $
55 */
56
57#ifndef _RESOLV_H_
58#define	_RESOLV_H_
59
60#include <sys/param.h>
61#include <sys/types.h>
62#include <sys/cdefs.h>
63#include <stdio.h>
64
65/*
66 * Revision information.  This is the release date in YYYYMMDD format.
67 * It can change every day so the right thing to do with it is use it
68 * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
69 * compare for equality; rather, use it to determine whether your resolver
70 * is new enough to contain a certain feature.
71 */
72
73#define	__RES	19960801
74
75/*
76 * This used to be defined in res_query.c, now it's in herror.c.  It was
77 * never extern'd by any *.h file before it was placed here.  herror.c is
78 * part of libresolv.a even though it might make more sense in libnetdb.a
79 * or even libnet.a.
80 */
81
82extern int h_errno;
83
84/*
85 * Resolver configuration file.
86 * Normally not present, but may contain the address of the
87 * inital name server(s) to query and the domain search list.
88 */
89
90#ifndef _PATH_RESCONF
91#define	_PATH_RESCONF        "/etc/resolv.conf"
92#endif
93
94/*
95 * Global defines and variables for resolver stub.
96 */
97#define	MAXNS			3	/* max # name servers we'll track */
98#define	MAXDFLSRCH		3	/* # default domain levels to try */
99#define	MAXDNSRCH		6	/* max # domains in search path */
100#define	LOCALDOMAINPARTS	2	/* min levels in name that is "local" */
101
102#define	RES_TIMEOUT		5	/* min. seconds between retries */
103#define	MAXRESOLVSORT		10	/* number of net to sort on */
104#define	RES_MAXNDOTS		15	/* should reflect bit field size */
105
106struct __res_state {
107	int	retrans;	 	/* retransmition time interval */
108	int	retry;			/* number of times to retransmit */
109	u_long	options;		/* option flags - see below. */
110	int	nscount;		/* number of name servers */
111	struct sockaddr_in
112		nsaddr_list[MAXNS];	/* address of name server */
113#define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
114	u_short	id;			/* current message id */
115	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
116	char	defdname[256];		/* default domain (deprecated) */
117	u_long	pfcode;			/* RES_PRF_ flags - see below. */
118	unsigned ndots:4;		/* threshold for initial abs. query */
119	unsigned nsort:4;		/* number of elements in sort_list[] */
120	char	unused[3];
121	struct {
122		struct in_addr	addr;
123		u_int32_t	mask;
124	} sort_list[MAXRESOLVSORT];
125	char	pad[72];		/* on an i386 this means 512b total */
126};
127
128/*
129 * Resolver options (keep these in synch with res_debug.c, please)
130 */
131#define RES_INIT	0x00000001	/* address initialized */
132#define RES_DEBUG	0x00000002	/* print debug messages */
133#define RES_AAONLY	0x00000004	/* authoritative answers only (!IMPL)*/
134#define RES_USEVC	0x00000008	/* use virtual circuit */
135#define RES_PRIMARY	0x00000010	/* query primary server only (!IMPL) */
136#define RES_IGNTC	0x00000020	/* ignore truncation errors */
137#define RES_RECURSE	0x00000040	/* recursion desired */
138#define RES_DEFNAMES	0x00000080	/* use default domain name */
139#define RES_STAYOPEN	0x00000100	/* Keep TCP socket open */
140#define RES_DNSRCH	0x00000200	/* search up local domain tree */
141#define	RES_INSECURE1	0x00000400	/* type 1 security disabled */
142#define	RES_INSECURE2	0x00000800	/* type 2 security disabled */
143#define	RES_NOALIASES	0x00001000	/* shuts off HOSTALIASES feature */
144#define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
145#define	RES_NOTLDQUERY	0x00004000	/* Don't query TLD names */
146
147#define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
148
149/*
150 * Resolver "pfcode" values.  Used by dig.
151 */
152#define	RES_PRF_STATS	0x00000001
153#define	RES_PRF_UPDATE	0x00000002
154#define	RES_PRF_CLASS   0x00000004
155#define	RES_PRF_CMD	0x00000008
156#define	RES_PRF_QUES	0x00000010
157#define	RES_PRF_ANS	0x00000020
158#define	RES_PRF_AUTH	0x00000040
159#define	RES_PRF_ADD	0x00000080
160#define	RES_PRF_HEAD1	0x00000100
161#define	RES_PRF_HEAD2	0x00000200
162#define	RES_PRF_TTLID	0x00000400
163#define	RES_PRF_HEADX	0x00000800
164#define	RES_PRF_QUERY	0x00001000
165#define	RES_PRF_REPLY	0x00002000
166#define	RES_PRF_INIT    0x00004000
167/*			0x00008000	*/
168
169typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
170	res_sendhookact;
171
172typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr_in * const *ns,
173					      const u_char **query,
174					      int *querylen,
175					      u_char *ans,
176					      int anssiz,
177					      int *resplen));
178
179typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr_in *ns,
180					      const u_char *query,
181					      int querylen,
182					      u_char *ans,
183					      int anssiz,
184					      int *resplen));
185
186struct res_sym {
187	int	number;		/* Identifying number, like T_MX */
188	char *	name;		/* Its symbolic name, like "MX" */
189	char *	humanname;	/* Its fun name, like "mail exchanger" */
190};
191
192extern struct __res_state _res;
193extern const struct res_sym __p_class_syms[];
194extern const struct res_sym __p_type_syms[];
195
196/* Private routines shared between libc/net, named, nslookup and others. */
197#define	res_hnok	__res_hnok
198#define	res_ownok	__res_ownok
199#define	res_mailok	__res_mailok
200#define	res_dnok	__res_dnok
201#define	sym_ston	__sym_ston
202#define	sym_ntos	__sym_ntos
203#define	sym_ntop	__sym_ntop
204#define	b64_ntop	__b64_ntop
205#define	b64_pton	__b64_pton
206#define	loc_ntoa	__loc_ntoa
207#define	loc_aton	__loc_aton
208#define	fp_resstat	__fp_resstat		/* XXX new divert */
209#define	p_query		__p_query		/* XXX new divert */
210#define	dn_skipname	__dn_skipname
211#define	fp_resstat	__fp_resstat
212#define	fp_query	__fp_query
213#define	fp_nquery	__fp_nquery
214#define	hostalias	__hostalias
215#define	putlong		__putlong
216#define	putshort	__putshort
217#define	p_class		__p_class
218#define	p_time		__p_time
219#define	p_type		__p_type
220#define	p_query		__p_query
221#define	p_cdnname	__p_cdnname
222#define	p_section	__p_section		/* XXX new func in 8.1 */
223#define	p_cdname	__p_cdname
224#define	p_fqnname	__p_fqnname
225#define	p_fqname	__p_fqname
226/* XXX p_rr gone */
227#define	p_option	__p_option
228#define	p_secstodate	__p_secstodate
229#define	dn_count_labels	__dn_count_labels
230#define	dn_comp		__dn_comp
231#define	dn_expand	__dn_expand		/* XXX unmasked */
232#define	res_init	__res_init		/* XXX unmasked */
233#define	res_randomid	__res_randomid
234#define	res_query	__res_query		/* XXX unmasked */
235#define	res_search	__res_search		/* XXX unmasked */
236#define	res_querydomain	__res_querydomain	/* XXX unmasked */
237#define	res_mkquery	__res_mkquery		/* XXX unmasked */
238#define	res_send	__res_send		/* XXX unmasked */
239#define	res_isourserver	__res_isourserver
240#define	res_nameinquery	__res_nameinquery
241#define	res_queriesmatch __res_queriesmatch
242#define	res_close	__res_close
243#define res_mkupdate	__res_mkupdate		/* XXX new func in 8.1 */
244#define	res_mkupdrec	__res_mkupdrec		/* XXX new func in 8.1 */
245#define res_freeupdrec	__res_freeupdrec	/* XXX new func in 8.1 */
246
247__BEGIN_DECLS
248int		res_hnok __P((const char *));
249int		res_ownok __P((const char *));
250int		res_mailok __P((const char *));
251int		res_dnok __P((const char *));
252int		sym_ston __P((const struct res_sym *, const char *, int *));
253const char *	sym_ntos __P((const struct res_sym *, int, int *));
254const char *	sym_ntop __P((const struct res_sym *, int, int *));
255int		b64_ntop __P((u_char const *, size_t, char *, size_t));
256int		b64_pton __P((char const *, u_char *, size_t));
257int		loc_aton __P((const char *, u_char *));
258const char *	loc_ntoa __P((const u_char *, char *));
259int		dn_skipname __P((const u_char *, const u_char *));
260void		fp_resstat __P((struct __res_state *, FILE *));
261void		fp_query __P((const u_char *, FILE *));
262void		fp_nquery __P((const u_char *, int, FILE *));
263const char *	hostalias __P((const char *));
264void		putlong __P((u_int32_t, u_char *));
265void		putshort __P((u_int16_t, u_char *));
266const char *	p_class __P((int));
267const char *	p_time __P((u_int32_t));
268const char *	p_type __P((int));
269void		p_query __P((const u_char *));
270const u_char *	p_cdnname __P((const u_char *, const u_char *, int, FILE *));
271const u_char *	p_cdname __P((const u_char *, const u_char *, FILE *));
272const u_char *	p_fqnname __P((const u_char *, const u_char *,
273			       int, char *, int));
274const u_char *	p_fqname __P((const u_char *, const u_char *, FILE *));
275const char *	p_option __P((u_long));
276char *		p_secstodate __P((u_long));
277int		dn_count_labels __P((const char *));
278int		dn_comp __P((const char *, u_char *, int,
279			     u_char **, u_char **));
280int		dn_expand __P((const u_char *, const u_char *, const u_char *,
281			       char *, int));
282int		res_init __P((void));
283u_int		res_randomid __P((void));
284int		res_query __P((const char *, int, int, u_char *, int));
285int		res_search __P((const char *, int, int, u_char *, int));
286int		res_querydomain __P((const char *, const char *, int, int,
287				     u_char *, int));
288int		res_mkquery __P((int, const char *, int, int, const u_char *,
289				 int, const u_char *, u_char *, int));
290int		res_send __P((const u_char *, int, u_char *, int));
291int		res_isourserver __P((const struct sockaddr_in *));
292int		res_nameinquery __P((const char *, int, int,
293				     const u_char *, const u_char *));
294int		res_queriesmatch __P((const u_char *, const u_char *,
295				      const u_char *, const u_char *));
296void		res_close __P((void));
297const char *	p_section __P((int, int));
298int		res_update __P((ns_updrec *));
299int		res_mkupdate __P((ns_updrec *, u_char *, int));
300ns_updrec *	res_mkupdrec __P((int, const char *, u_int, u_int, u_long));
301void		res_freeupdrec __P((ns_updrec *));
302__END_DECLS
303
304#endif /* !_RESOLV_H_ */
305