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