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