xref: /freebsd/include/resolv.h (revision b52b9d56d4e96089873a75f9e29062eec19fabba)
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  * $FreeBSD$
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 <sys/socket.h>
64 #include <stdio.h>
65 
66 /*
67  * Revision information.  This is the release date in YYYYMMDD format.
68  * It can change every day so the right thing to do with it is use it
69  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
70  * compare for equality; rather, use it to determine whether your resolver
71  * is new enough to contain a certain feature.
72  */
73 
74 #define	__RES	19960801
75 
76 /*
77  * Resolver configuration file.
78  * Normally not present, but may contain the address of the
79  * inital name server(s) to query and the domain search list.
80  */
81 
82 #ifndef _PATH_RESCONF
83 #define	_PATH_RESCONF        "/etc/resolv.conf"
84 #endif
85 
86 /*
87  * Global defines and variables for resolver stub.
88  */
89 #define	MAXNS			3	/* max # name servers we'll track */
90 #define	MAXDFLSRCH		3	/* # default domain levels to try */
91 #define	MAXDNSRCH		6	/* max # domains in search path */
92 #define	LOCALDOMAINPARTS	2	/* min levels in name that is "local" */
93 
94 #define	RES_TIMEOUT		5	/* min. seconds between retries */
95 #define	MAXRESOLVSORT		10	/* number of net to sort on */
96 #define	RES_MAXNDOTS		15	/* should reflect bit field size */
97 
98 struct __res_state {
99 	int	retrans;	 	/* retransmition time interval */
100 	int	retry;			/* number of times to retransmit */
101 	u_long	options;		/* option flags - see below. */
102 	int	nscount;		/* number of name servers */
103 	struct sockaddr_in
104 		nsaddr_list[MAXNS];	/* address of name server */
105 #define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
106 	u_short	id;			/* current message id */
107 	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
108 	char	defdname[256];		/* default domain (deprecated) */
109 	u_long	pfcode;			/* RES_PRF_ flags - see below. */
110 	unsigned ndots:4;		/* threshold for initial abs. query */
111 	unsigned nsort:4;		/* number of elements in sort_list[] */
112 	char	unused[3];
113 	struct {
114 		struct in_addr	addr;
115 		u_int32_t	mask;
116 	} sort_list[MAXRESOLVSORT];
117 	char	pad[72];		/* on an i386 this means 512b total */
118 };
119 
120 /* for INET6 */
121 /*
122  * replacement of __res_state, separated to keep binary compatibility.
123  */
124 struct __res_state_ext {
125 	struct sockaddr_storage nsaddr_list[MAXNS];
126 	struct {
127 		int	af;		/* address family for addr, mask */
128 		union {
129 			struct	in_addr ina;
130 			struct	in6_addr in6a;
131 		} addr, mask;
132 	} sort_list[MAXRESOLVSORT];
133 };
134 
135 /*
136  * Resolver options (keep these in synch with res_debug.c, please)
137  */
138 #define RES_INIT	0x00000001	/* address initialized */
139 #define RES_DEBUG	0x00000002	/* print debug messages */
140 #define RES_AAONLY	0x00000004	/* authoritative answers only (!IMPL)*/
141 #define RES_USEVC	0x00000008	/* use virtual circuit */
142 #define RES_PRIMARY	0x00000010	/* query primary server only (!IMPL) */
143 #define RES_IGNTC	0x00000020	/* ignore truncation errors */
144 #define RES_RECURSE	0x00000040	/* recursion desired */
145 #define RES_DEFNAMES	0x00000080	/* use default domain name */
146 #define RES_STAYOPEN	0x00000100	/* Keep TCP socket open */
147 #define RES_DNSRCH	0x00000200	/* search up local domain tree */
148 #define	RES_INSECURE1	0x00000400	/* type 1 security disabled */
149 #define	RES_INSECURE2	0x00000800	/* type 2 security disabled */
150 #define	RES_NOALIASES	0x00001000	/* shuts off HOSTALIASES feature */
151 #define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
152 #define	RES_NOTLDQUERY	0x00004000	/* Don't query TLD names */
153 /* KAME extensions: use higher bit to avoid conflict with ISC use */
154 #define	RES_USE_EDNS0	0x40000000	/* use EDNS0 */
155 
156 #define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
157 
158 /*
159  * Resolver "pfcode" values.  Used by dig.
160  */
161 #define	RES_PRF_STATS	0x00000001
162 #define	RES_PRF_UPDATE	0x00000002
163 #define	RES_PRF_CLASS   0x00000004
164 #define	RES_PRF_CMD	0x00000008
165 #define	RES_PRF_QUES	0x00000010
166 #define	RES_PRF_ANS	0x00000020
167 #define	RES_PRF_AUTH	0x00000040
168 #define	RES_PRF_ADD	0x00000080
169 #define	RES_PRF_HEAD1	0x00000100
170 #define	RES_PRF_HEAD2	0x00000200
171 #define	RES_PRF_TTLID	0x00000400
172 #define	RES_PRF_HEADX	0x00000800
173 #define	RES_PRF_QUERY	0x00001000
174 #define	RES_PRF_REPLY	0x00002000
175 #define	RES_PRF_INIT    0x00004000
176 /*			0x00008000	*/
177 
178 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
179 	res_sendhookact;
180 
181 typedef res_sendhookact (*res_send_qhook)(struct sockaddr_in * const *ns,
182 					  const u_char **query,
183 					  int *querylen,
184 					  u_char *ans,
185 					  int anssiz,
186 					  int *resplen);
187 
188 typedef res_sendhookact (*res_send_rhook)(const struct sockaddr_in *ns,
189 					  const u_char *query,
190 					  int querylen,
191 					  u_char *ans,
192 					  int anssiz,
193 					  int *resplen);
194 
195 struct res_sym {
196 	int	number;		/* Identifying number, like T_MX */
197 	char *	name;		/* Its symbolic name, like "MX" */
198 	char *	humanname;	/* Its fun name, like "mail exchanger" */
199 };
200 
201 extern struct __res_state _res;
202 /* for INET6 */
203 extern struct __res_state_ext _res_ext;
204 
205 extern const struct res_sym __p_class_syms[];
206 extern const struct res_sym __p_type_syms[];
207 
208 /* Private routines shared between libc/net, named, nslookup and others. */
209 #define	res_hnok	__res_hnok
210 #define	res_ownok	__res_ownok
211 #define	res_mailok	__res_mailok
212 #define	res_dnok	__res_dnok
213 #define	sym_ston	__sym_ston
214 #define	sym_ntos	__sym_ntos
215 #define	sym_ntop	__sym_ntop
216 #define	b64_ntop	__b64_ntop
217 #define	b64_pton	__b64_pton
218 #define	loc_ntoa	__loc_ntoa
219 #define	loc_aton	__loc_aton
220 #define	fp_resstat	__fp_resstat
221 #define	p_query		__p_query
222 #define	dn_skipname	__dn_skipname
223 #define	fp_resstat	__fp_resstat
224 #define	fp_query	__fp_query
225 #define	fp_nquery	__fp_nquery
226 #define	hostalias	__hostalias
227 #define	putlong		__putlong
228 #define	putshort	__putshort
229 #define	p_class		__p_class
230 #define	p_time		__p_time
231 #define	p_type		__p_type
232 #define	p_query		__p_query
233 #define	p_cdnname	__p_cdnname
234 #define	p_section	__p_section
235 #define	p_cdname	__p_cdname
236 #define	p_fqnname	__p_fqnname
237 #define	p_fqname	__p_fqname
238 #define	p_option	__p_option
239 #define	p_secstodate	__p_secstodate
240 #define	dn_count_labels	__dn_count_labels
241 #define	dn_comp		__dn_comp
242 #define	dn_expand	__dn_expand
243 #define	res_init	__res_init
244 #define	res_randomid	__res_randomid
245 #define	res_query	__res_query
246 #define	res_search	__res_search
247 #define	res_querydomain	__res_querydomain
248 #define	res_mkquery	__res_mkquery
249 #define	res_send	__res_send
250 #define	res_isourserver	__res_isourserver
251 #define	res_nameinquery	__res_nameinquery
252 #define	res_queriesmatch __res_queriesmatch
253 #define	res_close	__res_close
254 #define	res_opt		__res_opt
255 #define	res_mkupdate	__res_mkupdate
256 #define	res_mkupdrec	__res_mkupdrec
257 #define	res_freeupdrec	__res_freeupdrec
258 
259 __BEGIN_DECLS
260 int		res_hnok(const char *);
261 int		res_ownok(const char *);
262 int		res_mailok(const char *);
263 int		res_dnok(const char *);
264 int		sym_ston(const struct res_sym *, const char *, int *);
265 const char *	sym_ntos(const struct res_sym *, int, int *);
266 const char *	sym_ntop(const struct res_sym *, int, int *);
267 int		b64_ntop(u_char const *, size_t, char *, size_t);
268 int		b64_pton(char const *, u_char *, size_t);
269 int		loc_aton(const char *, u_char *);
270 const char *	loc_ntoa(const u_char *, char *);
271 int		dn_skipname(const u_char *, const u_char *);
272 void		fp_resstat(struct __res_state *, FILE *);
273 void		fp_query(const u_char *, FILE *);
274 void		fp_nquery(const u_char *, int, FILE *);
275 const char *	hostalias(const char *);
276 void		putlong(u_int32_t, u_char *);
277 void		putshort(u_int16_t, u_char *);
278 const char *	p_class(int);
279 const char *	p_time(u_int32_t);
280 const char *	p_type(int);
281 void		p_query(const u_char *);
282 const u_char *	p_cdnname(const u_char *, const u_char *, int, FILE *);
283 const u_char *	p_cdname(const u_char *, const u_char *, FILE *);
284 const u_char *	p_fqnname(const u_char *, const u_char *,
285 			  int, char *, int);
286 const u_char *	p_fqname(const u_char *, const u_char *, FILE *);
287 const char *	p_option(u_long);
288 char *		p_secstodate(u_long);
289 int		dn_count_labels(const char *);
290 int		dn_comp(const char *, u_char *, int, u_char **, u_char **);
291 int		dn_expand(const u_char *, const u_char *, const u_char *,
292 			  char *, int);
293 int		res_init(void);
294 u_int		res_randomid(void);
295 int		res_query(const char *, int, int, u_char *, int);
296 int		res_search(const char *, int, int, u_char *, int);
297 int		res_querydomain(const char *, const char *, int, int,
298 				u_char *, int);
299 int		res_mkquery(int, const char *, int, int, const u_char *,
300 			    int, const u_char *, u_char *, int);
301 int		res_send(const u_char *, int, u_char *, int);
302 int		res_isourserver(const struct sockaddr_in *);
303 int		res_nameinquery(const char *, int, int,
304 				const u_char *, const u_char *);
305 int		res_queriesmatch(const u_char *, const u_char *,
306 				 const u_char *, const u_char *);
307 void		res_close(void);
308 int		res_opt(int, u_char *, int, int);
309 const char *	p_section(int, int);
310 /* XXX The following depend on the ns_updrec typedef in arpa/nameser.h */
311 #ifdef _ARPA_NAMESER_H_
312 int		res_update(ns_updrec *);
313 int		res_mkupdate(ns_updrec *, u_char *, int);
314 ns_updrec *	res_mkupdrec(int, const char *, u_int, u_int, u_long);
315 void		res_freeupdrec(ns_updrec *);
316 #endif
317 __END_DECLS
318 
319 #endif /* !_RESOLV_H_ */
320