xref: /freebsd/include/resolv.h (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
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.18 1997/06/01 20:34:32 vixie Exp
56  *	$Id: resolv.h,v 1.13 1997/06/27 08:32:38 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 <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 
99 struct __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	pad[72];		/* on an i386 this means 512b total */
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 truncation 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 #define	RES_NOTLDQUERY	0x00004000	/* Don't query TLD names */
139 
140 #define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
141 
142 /*
143  * Resolver "pfcode" values.  Used by dig.
144  */
145 #define	RES_PRF_STATS	0x00000001
146 /*			0x00000002	*/
147 #define	RES_PRF_CLASS   0x00000004
148 #define	RES_PRF_CMD	0x00000008
149 #define	RES_PRF_QUES	0x00000010
150 #define	RES_PRF_ANS	0x00000020
151 #define	RES_PRF_AUTH	0x00000040
152 #define	RES_PRF_ADD	0x00000080
153 #define	RES_PRF_HEAD1	0x00000100
154 #define	RES_PRF_HEAD2	0x00000200
155 #define	RES_PRF_TTLID	0x00000400
156 #define	RES_PRF_HEADX	0x00000800
157 #define	RES_PRF_QUERY	0x00001000
158 #define	RES_PRF_REPLY	0x00002000
159 #define	RES_PRF_INIT    0x00004000
160 /*			0x00008000	*/
161 
162 /* hooks are still experimental as of 4.9.2 */
163 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
164 	res_sendhookact;
165 
166 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr_in * const *ns,
167 					      const u_char **query,
168 					      int *querylen,
169 					      u_char *ans,
170 					      int anssiz,
171 					      int *resplen));
172 
173 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr_in *ns,
174 					      const u_char *query,
175 					      int querylen,
176 					      u_char *ans,
177 					      int anssiz,
178 					      int *resplen));
179 
180 struct res_sym {
181 	int	number;		/* Identifying number, like T_MX */
182 	char *	name;		/* Its symbolic name, like "MX" */
183 	char *	humanname;	/* Its fun name, like "mail exchanger" */
184 };
185 
186 extern struct __res_state _res;
187 extern const struct res_sym __p_class_syms[];
188 extern const struct res_sym __p_type_syms[];
189 
190 /* Private routines shared between libc/net, named, nslookup and others. */
191 #define	res_hnok	__res_hnok
192 #define	res_ownok	__res_ownok
193 #define	res_mailok	__res_mailok
194 #define	res_dnok	__res_dnok
195 #define	sym_ston	__sym_ston
196 #define	sym_ntos	__sym_ntos
197 #define	sym_ntop	__sym_ntop
198 #define	b64_ntop	__b64_ntop
199 #define	b64_pton	__b64_pton
200 #define	loc_ntoa	__loc_ntoa
201 #define	loc_aton	__loc_aton
202 #define	dn_skipname	__dn_skipname
203 #define	fp_resstat	__fp_resstat
204 #define	fp_query	__fp_query
205 #define	fp_nquery	__fp_nquery
206 #define	hostalias	__hostalias
207 #define	putlong		__putlong
208 #define	putshort	__putshort
209 #define	p_class		__p_class
210 #define	p_time		__p_time
211 #define	p_type		__p_type
212 #define	p_query		__p_query
213 #define	p_cdnname	__p_cdnname
214 #define	p_cdname	__p_cdname
215 #define	p_fqnname	__p_fqnname
216 #define	p_fqname	__p_fqname
217 #define	p_rr		__p_rr
218 #define	p_option	__p_option
219 #define	p_secstodate	__p_secstodate
220 #define	dn_count_labels	__dn_count_labels
221 #define	dn_comp		__dn_comp
222 #define	res_randomid	__res_randomid
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 #define	res_send	__res_send
236 #endif
237 
238 __BEGIN_DECLS
239 int		res_hnok __P((const char *));
240 int		res_ownok __P((const char *));
241 int		res_mailok __P((const char *));
242 int		res_dnok __P((const char *));
243 int		sym_ston __P((const struct res_sym *, char *, int *));
244 const char *	sym_ntos __P((const struct res_sym *, int, int *));
245 const char *	sym_ntop __P((const struct res_sym *, int, int *));
246 int		b64_ntop __P((u_char const *, size_t, char *, size_t));
247 int		b64_pton __P((char const *, u_char *, size_t));
248 int		loc_aton __P((const char *, u_char *));
249 const char *	loc_ntoa __P((const u_char *, char *));
250 int		dn_skipname __P((const u_char *, const u_char *));
251 void		fp_resstat __P((struct __res_state *, FILE *));
252 void		fp_query __P((const u_char *, FILE *));
253 void		fp_nquery __P((const u_char *, int, FILE *));
254 const char *	hostalias __P((const char *));
255 void		putlong __P((u_int32_t, u_char *));
256 void		putshort __P((u_int16_t, u_char *));
257 const char *	p_class __P((int));
258 const char *	p_time __P((u_int32_t));
259 const char *	p_type __P((int));
260 void		p_query __P((const u_char *));
261 const u_char *	p_cdnname __P((const u_char *, const u_char *, int, FILE *));
262 const u_char *	p_cdname __P((const u_char *, const u_char *, FILE *));
263 const u_char *	p_fqnname __P((const u_char *, const u_char *,
264 			       int, char *, int));
265 const u_char *	p_fqname __P((const u_char *, const u_char *, FILE *));
266 const u_char *	p_rr __P((const u_char *, const u_char *, FILE *));
267 const char *	p_option __P((u_long));
268 char *		p_secstodate __P((u_long));
269 int		dn_count_labels __P((char *));
270 int		dn_comp __P((const char *, u_char *, int,
271 			     u_char **, u_char **));
272 int		dn_expand __P((const u_char *, const u_char *, const u_char *,
273 			       char *, int));
274 int		res_init __P((void));
275 u_int		res_randomid __P((void));
276 int		res_query __P((const char *, int, int, u_char *, int));
277 int		res_search __P((const char *, int, int, u_char *, int));
278 int		res_querydomain __P((const char *, const char *, int, int,
279 				     u_char *, int));
280 int		res_mkquery __P((int, const char *, int, int, const u_char *,
281 				 int, const u_char *, u_char *, int));
282 int		res_send __P((const u_char *, int, u_char *, int));
283 int		res_isourserver __P((const struct sockaddr_in *));
284 int		res_nameinquery __P((const char *, int, int,
285 				     const u_char *, const u_char *));
286 int		res_queriesmatch __P((const u_char *, const u_char *,
287 				      const u_char *, const u_char *));
288 void		res_close __P((void));
289 __END_DECLS
290 
291 #endif /* !_RESOLV_H_ */
292