xref: /netbsd-src/include/resolv.h (revision 76dfffe33547c37f8bdd446e3e4ab0f3c16cea4b)
1 /*
2  * ++Copyright++ 1983, 1987, 1989, 1993
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  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
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, and that
40  * the name of Digital Equipment Corporation not be used in advertising or
41  * publicity pertaining to distribution of the document or software without
42  * specific, written prior permission.
43  *
44  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
45  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
46  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
47  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
48  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
49  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
50  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
51  * SOFTWARE.
52  * -
53  * --Copyright--
54  */
55 
56 /*
57  *	@(#)resolv.h	8.1 (Berkeley) 6/2/93
58  *	$Id: resolv.h,v 8.5 1995/12/22 10:20:27 vixie Exp
59  */
60 
61 #ifndef _RESOLV_H_
62 #define	_RESOLV_H_
63 
64 #include <sys/param.h>
65 #if (!defined(BSD)) || (BSD < 199306)
66 # include <sys/bitypes.h>
67 #else
68 # include <sys/types.h>
69 #endif
70 #include <sys/cdefs.h>
71 #include <stdio.h>
72 
73 /*
74  * revision information.  this is the release date in YYYYMMDD format.
75  * it can change every day so the right thing to do with it is use it
76  * in preprocessor commands such as "#if (__RES > 19931104)".  do not
77  * compare for equality; rather, use it to determine whether your resolver
78  * is new enough to contain a certain feature.
79  */
80 
81 #define	__RES	19951031
82 
83 /*
84  * Resolver configuration file.
85  * Normally not present, but may contain the address of the
86  * inital name server(s) to query and the domain search list.
87  */
88 
89 #ifndef _PATH_RESCONF
90 #define _PATH_RESCONF        "/etc/resolv.conf"
91 #endif
92 
93 /*
94  * Global defines and variables for resolver stub.
95  */
96 #define	MAXNS			3	/* max # name servers we'll track */
97 #define	MAXDFLSRCH		3	/* # default domain levels to try */
98 #define	MAXDNSRCH		6	/* max # domains in search path */
99 #define	LOCALDOMAINPARTS	2	/* min levels in name that is "local" */
100 #define	MAXDNSLUS		4	/* max # of host lookup types */
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 
106 struct __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 packet id */
115 	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
116 	char	defdname[MAXDNAME];	/* default domain */
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	lookups[MAXDNSLUS];
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 trucation 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 
145 #define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
146 
147 /*
148  * Resolver "pfcode" values.  Used by dig.
149  */
150 #define RES_PRF_STATS	0x00000001
151 /*			0x00000002	*/
152 #define RES_PRF_CLASS   0x00000004
153 #define RES_PRF_CMD	0x00000008
154 #define RES_PRF_QUES	0x00000010
155 #define RES_PRF_ANS	0x00000020
156 #define RES_PRF_AUTH	0x00000040
157 #define RES_PRF_ADD	0x00000080
158 #define RES_PRF_HEAD1	0x00000100
159 #define RES_PRF_HEAD2	0x00000200
160 #define RES_PRF_TTLID	0x00000400
161 #define RES_PRF_HEADX	0x00000800
162 #define RES_PRF_QUERY	0x00001000
163 #define RES_PRF_REPLY	0x00002000
164 #define RES_PRF_INIT    0x00004000
165 /*			0x00008000	*/
166 
167 /* hooks are still experimental as of 4.9.2 */
168 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
169 	res_sendhookact;
170 
171 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr_in * const *ns,
172 					      const u_char **query,
173 					      int *querylen,
174 					      u_char *ans,
175 					      int anssiz,
176 					      int *resplen));
177 
178 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr_in *ns,
179 					      const u_char *query,
180 					      int querylen,
181 					      u_char *ans,
182 					      int anssiz,
183 					      int *resplen));
184 
185 extern struct __res_state _res;
186 
187 /* Private routines shared between libc/net, named, nslookup and others. */
188 #define	dn_skipname	__dn_skipname
189 #define	fp_query	__fp_query
190 #define	fp_nquery	__fp_nquery
191 #define	hostalias	__hostalias
192 #define	putlong		__putlong
193 #define	putshort	__putshort
194 #define p_class		__p_class
195 #define p_time		__p_time
196 #define p_type		__p_type
197 #define	p_cdnname	__p_cdnname
198 #define	p_cdname	__p_cdname
199 #define	p_fqname	__p_fqname
200 #define	p_rr		__p_rr
201 #define	p_option	__p_option
202 #define	res_randomid	__res_randomid
203 #define	res_isourserver	__res_isourserver
204 #define	res_nameinquery	__res_nameinquery
205 #define	res_queriesmatch __res_queriesmatch
206 __BEGIN_DECLS
207 int	 __dn_skipname __P((const u_char *, const u_char *));
208 void	 __fp_resstat __P((struct __res_state *, FILE *));
209 void	 __fp_query __P((const u_char *, FILE *));
210 void	 __fp_nquery __P((const u_char *, int, FILE *));
211 char	*__hostalias __P((const char *));
212 void	 __putlong __P((u_int32_t, u_char *));
213 void	 __putshort __P((u_int16_t, u_char *));
214 char	*__p_time __P((u_int32_t));
215 void	 __p_query __P((const u_char *));
216 const u_char *__p_cdnname __P((const u_char *, const u_char *, int, FILE *));
217 const u_char *__p_cdname __P((const u_char *, const u_char *, FILE *));
218 const u_char *__p_fqname __P((const u_char *, const u_char *, FILE *));
219 const u_char *__p_rr __P((const u_char *, const u_char *, FILE *));
220 const char *__p_type __P((int));
221 const char *__p_class __P((int));
222 const char *__p_option __P((u_long option));
223 int	 dn_comp __P((const char *, u_char *, int, u_char **, u_char **));
224 int	 dn_expand __P((const u_char *, const u_char *, const u_char *,
225 			char *, int));
226 int	 res_init __P((void));
227 u_int16_t res_randomid __P((void));
228 int	 res_query __P((const char *, int, int, u_char *, int));
229 int	 res_search __P((const char *, int, int, u_char *, int));
230 int	 res_querydomain __P((const char *, const char *, int, int,
231 			      u_char *, int));
232 int	 res_mkquery __P((int, const char *, int, int, const u_char *, int,
233 			  const u_char *, u_char *, int));
234 int	 res_send __P((const u_char *, int, u_char *, int));
235 int	 res_isourserver __P((const struct sockaddr_in *));
236 int	 res_nameinquery __P((const char *, int, int,
237 			      const u_char *, const u_char *));
238 int	 res_queriesmatch __P((const u_char *, const u_char *,
239 			       const u_char *, const u_char *));
240 /* XXX - these last two don't belong in the resolver */
241 u_int	 inet_nsap_addr __P((const char *, u_char *, int maxlen));
242 char	*inet_nsap_ntoa __P((int, const u_char *, char *ascii));
243 __END_DECLS
244 
245 #endif /* !_RESOLV_H_ */
246