1/*	$NetBSD: resolv.h,v 1.31 2005/12/26 19:01:47 perry Exp $	*/
2
3/*
4 * Copyright (c) 1983, 1987, 1989
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. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32/*
33 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
34 * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
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.
39 *
40 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
41 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
42 * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
43 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
44 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
45 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
46 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
47 */
48
49/*
50 *	@(#)resolv.h	8.1 (Berkeley) 6/2/93
51 *	Id: resolv.h,v 1.7.2.11.4.2 2004/06/25 00:41:05 marka Exp
52 */
53
54#ifndef _RESOLV_PRIVATE_H_
55#define	_RESOLV_PRIVATE_H_
56
57#include <sys/cdefs.h>
58
59#include <resolv.h>
60#include "resolv_static.h"
61#include <net/if.h>
62
63/* Despite this file's name, it's part of libresolv. On Android, that means it's part of libc :-( */
64#pragma GCC visibility push(default)
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	20030124
75
76/*
77 * This used to be defined in res_query.c, now it's in herror.c.
78 * [XXX no it's not.  It's in irs/irs_data.c]
79 * It was
80 * never extern'd by any *.h file before it was placed here.  For thread
81 * aware programs, the last h_errno value set is stored in res->h_errno.
82 *
83 * XXX:	There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO
84 *	(and __h_errno_set) to the public via <resolv.h>.
85 * XXX:	__h_errno_set is really part of IRS, not part of the resolver.
86 *	If somebody wants to build and use a resolver that doesn't use IRS,
87 *	what do they do?  Perhaps something like
88 *		#ifdef WANT_IRS
89 *		# define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
90 *		#else
91 *		# define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
92 *		#endif
93 */
94
95#define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
96struct __res_state; /* forward */
97
98/*
99 * Resolver configuration file.
100 * Normally not present, but may contain the address of the
101 * initial name server(s) to query and the domain search list.
102 */
103
104#ifndef _PATH_RESCONF
105#ifdef ANDROID_CHANGES
106#define _PATH_RESCONF        "/etc/ppp/resolv.conf"
107#else
108#define _PATH_RESCONF        "/etc/resolv.conf"
109#endif
110#endif
111
112typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
113	res_sendhookact;
114
115typedef res_sendhookact (*res_send_qhook)(struct sockaddr * const *,
116					      const u_char **, int *,
117					      u_char *, int, int *);
118
119typedef res_sendhookact (*res_send_rhook)(const struct sockaddr *,
120					      const u_char *, int, u_char *,
121					      int, int *);
122
123struct res_sym {
124	int		number;	   /* Identifying number, like T_MX */
125	const char *	name;	   /* Its symbolic name, like "MX" */
126	const char *	humanname; /* Its fun name, like "mail exchanger" */
127};
128
129/*
130 * Global defines and variables for resolver stub.
131 */
132#define	MAXNS			3	/* max # name servers we'll track */
133#define	MAXDFLSRCH		3	/* # default domain levels to try */
134#define	MAXDNSRCH		6	/* max # domains in search path */
135#define	LOCALDOMAINPARTS	2	/* min levels in name that is "local" */
136
137#define	RES_TIMEOUT		5	/* min. seconds between retries */
138#define	MAXRESOLVSORT		10	/* number of net to sort on */
139#define	RES_MAXNDOTS		15	/* should reflect bit field size */
140#define	RES_MAXRETRANS		30	/* only for resolv.conf/RES_OPTIONS */
141#define	RES_MAXRETRY		5	/* only for resolv.conf/RES_OPTIONS */
142#define	RES_DFLRETRY		2	/* Default #/tries. */
143#define	RES_MAXTIME		65535	/* Infinity, in milliseconds. */
144
145struct __res_state_ext;
146
147struct __res_state {
148	unsigned	netid;			/* NetId: cache key and socket mark */
149	int	retrans;	 	/* retransmission time interval */
150	int	retry;			/* number of times to retransmit */
151#ifdef sun
152	u_int	options;		/* option flags - see below. */
153#else
154	u_long	options;		/* option flags - see below. */
155#endif
156	int	nscount;		/* number of name servers */
157	struct sockaddr_in
158		nsaddr_list[MAXNS];	/* address of name server */
159#define	nsaddr	nsaddr_list[0]		/* for backward compatibility */
160	u_short	id;			/* current message id */
161	char	*dnsrch[MAXDNSRCH+1];	/* components of domain to search */
162	char	defdname[256];		/* default domain (deprecated) */
163#ifdef sun
164	u_int	pfcode;			/* RES_PRF_ flags - see below. */
165#else
166	u_long	pfcode;			/* RES_PRF_ flags - see below. */
167#endif
168	unsigned ndots:4;		/* threshold for initial abs. query */
169	unsigned nsort:4;		/* number of elements in sort_list[] */
170	char	unused[3];
171	struct {
172		struct in_addr	addr;
173		uint32_t	mask;
174	} sort_list[MAXRESOLVSORT];
175#ifdef __OLD_RES_STATE
176	char lookups[4];
177#else
178	res_send_qhook qhook;		/* query hook */
179	res_send_rhook rhook;		/* response hook */
180	int	res_h_errno;		/* last one set for this context */
181	unsigned _mark;			/* If non-0 SET_MARK to _mark on all request sockets */
182	int	_vcsock;		/* PRIVATE: for res_send VC i/o */
183	u_int	_flags;			/* PRIVATE: see below */
184	u_int	_pad;			/* make _u 64 bit aligned */
185	union {
186		/* On an 32-bit arch this means 512b total. */
187		char	pad[72 - 4*sizeof (int) - 2*sizeof (void *)];
188		struct {
189			uint16_t		nscount;
190			uint16_t		nstimes[MAXNS];	/* ms. */
191			int			nssocks[MAXNS];
192			struct __res_state_ext *ext;	/* extention for IPv6 */
193		} _ext;
194	} _u;
195#endif
196        struct res_static   rstatic[1];
197};
198
199typedef struct __res_state *res_state;
200
201union res_sockaddr_union {
202	struct sockaddr_in	sin;
203#ifdef IN6ADDR_ANY_INIT
204	struct sockaddr_in6	sin6;
205#endif
206#ifdef ISC_ALIGN64
207	int64_t			__align64;	/* 64bit alignment */
208#else
209	int32_t			__align32;	/* 32bit alignment */
210#endif
211	char			__space[128];   /* max size */
212};
213
214/*
215 * Resolver flags (used to be discrete per-module statics ints).
216 */
217#define	RES_F_VC	0x00000001	/* socket is TCP */
218#define	RES_F_CONN	0x00000002	/* socket is connected */
219#define	RES_F_EDNS0ERR	0x00000004	/* EDNS0 caused errors */
220#define	RES_F__UNUSED	0x00000008	/* (unused) */
221#define	RES_F_LASTMASK	0x000000F0	/* ordinal server of last res_nsend */
222#define	RES_F_LASTSHIFT	4		/* bit position of LASTMASK "flag" */
223#define	RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT)
224
225/* res_findzonecut2() options */
226#define	RES_EXHAUSTIVE	0x00000001	/* always do all queries */
227#define	RES_IPV4ONLY	0x00000002	/* IPv4 only */
228#define	RES_IPV6ONLY	0x00000004	/* IPv6 only */
229
230/*
231 * Resolver options (keep these in synch with res_debug.c, please)
232 */
233#define RES_INIT	0x00000001	/* address initialized */
234#define RES_DEBUG	0x00000002	/* print debug messages */
235#define RES_AAONLY	0x00000004	/* authoritative answers only (!IMPL)*/
236#define RES_USEVC	0x00000008	/* use virtual circuit */
237#define RES_PRIMARY	0x00000010	/* query primary server only (!IMPL) */
238#define RES_IGNTC	0x00000020	/* ignore trucation errors */
239#define RES_RECURSE	0x00000040	/* recursion desired */
240#define RES_DEFNAMES	0x00000080	/* use default domain name */
241#define RES_STAYOPEN	0x00000100	/* Keep TCP socket open */
242#define RES_DNSRCH	0x00000200	/* search up local domain tree */
243#define	RES_INSECURE1	0x00000400	/* type 1 security disabled */
244#define	RES_INSECURE2	0x00000800	/* type 2 security disabled */
245#define	RES_NOALIASES	0x00001000	/* shuts off HOSTALIASES feature */
246#define	RES_USE_INET6	0x00002000	/* use/map IPv6 in gethostbyname() */
247#define RES_ROTATE	0x00004000	/* rotate ns list after each query */
248#define	RES_NOCHECKNAME	0x00008000	/* do not check names for sanity. */
249#define	RES_KEEPTSIG	0x00010000	/* do not strip TSIG records */
250#define	RES_BLAST	0x00020000	/* blast all recursive servers */
251#define RES_NOTLDQUERY	0x00100000	/* don't unqualified name as a tld */
252#define RES_USE_DNSSEC	0x00200000	/* use DNSSEC using OK bit in OPT */
253/* #define RES_DEBUG2	0x00400000 */	/* nslookup internal */
254/* KAME extensions: use higher bit to avoid conflict with ISC use */
255#define RES_USE_DNAME	0x10000000	/* use DNAME */
256#define RES_USE_EDNS0	0x40000000	/* use EDNS0 if configured */
257#define RES_NO_NIBBLE2	0x80000000	/* disable alternate nibble lookup */
258
259#define RES_DEFAULT	(RES_RECURSE | RES_DEFNAMES | \
260			 RES_DNSRCH | RES_NO_NIBBLE2)
261
262/*
263 * Resolver "pfcode" values.  Used by dig.
264 */
265#define RES_PRF_STATS	0x00000001
266#define RES_PRF_UPDATE	0x00000002
267#define RES_PRF_CLASS   0x00000004
268#define RES_PRF_CMD	0x00000008
269#define RES_PRF_QUES	0x00000010
270#define RES_PRF_ANS	0x00000020
271#define RES_PRF_AUTH	0x00000040
272#define RES_PRF_ADD	0x00000080
273#define RES_PRF_HEAD1	0x00000100
274#define RES_PRF_HEAD2	0x00000200
275#define RES_PRF_TTLID	0x00000400
276#define RES_PRF_HEADX	0x00000800
277#define RES_PRF_QUERY	0x00001000
278#define RES_PRF_REPLY	0x00002000
279#define RES_PRF_INIT	0x00004000
280#define RES_PRF_TRUNC	0x00008000
281/*			0x00010000	*/
282
283/* Things involving an internal (static) resolver context. */
284__BEGIN_DECLS
285
286__LIBC_HIDDEN__ extern struct __res_state *__res_get_state(void);
287__LIBC_HIDDEN__ extern void __res_put_state(struct __res_state *);
288
289#ifndef ANDROID_CHANGES
290/*
291 * Source and Binary compatibility; _res will not work properly
292 * with multi-threaded programs.
293 */
294extern struct __res_state *__res_state(void);
295#define _res (*__res_state())
296#endif
297
298__END_DECLS
299
300#ifndef __BIND_NOSTATIC
301#define fp_nquery		__fp_nquery
302#define fp_query		__fp_query
303#define hostalias		__hostalias
304#define p_query			__p_query
305#define res_close		__res_close
306#define res_opt			__res_opt
307#define res_isourserver		__res_isourserver
308#define	res_querydomain		__res_querydomain
309#define res_send		__res_send
310#define res_sendsigned		__res_sendsigned
311
312#ifdef BIND_RES_POSIX3
313#define	dn_expand	__dn_expand
314#define	res_init	__res_init
315#define	res_query	__res_query
316#define	res_search	__res_search
317#define	res_mkquery	__res_mkquery
318#endif
319
320__BEGIN_DECLS
321void		fp_nquery(const u_char *, int, FILE *);
322void		fp_query(const u_char *, FILE *);
323const char *	hostalias(const char *);
324void		p_query(const u_char *);
325void		res_close(void);
326int		res_init(void);
327__LIBC_HIDDEN__ int		res_opt(int, u_char *, int, int);
328int		res_isourserver(const struct sockaddr_in *);
329int		res_mkquery(int, const char *, int, int, const u_char *, int, const u_char *, u_char *, int);
330int		res_query(const char *, int, int, u_char *, int);
331int		res_querydomain(const char *, const char *, int, int, u_char *, int);
332int		res_search(const char *, int, int, u_char *, int);
333int		res_send(const u_char *, int, u_char *, int);
334int		res_sendsigned(const u_char *, int, ns_tsig_key *, u_char *, int);
335__END_DECLS
336#endif
337
338#if !defined(SHARED_LIBBIND) || defined(LIB)
339/*
340 * If libbind is a shared object (well, DLL anyway)
341 * these externs break the linker when resolv.h is
342 * included by a lib client (like named)
343 * Make them go away if a client is including this
344 *
345 */
346__LIBC_HIDDEN__ extern const struct res_sym __p_key_syms[];
347__LIBC_HIDDEN__ extern const struct res_sym __p_cert_syms[];
348extern const struct res_sym __p_class_syms[];
349extern const struct res_sym __p_type_syms[];
350__LIBC_HIDDEN__ extern const struct res_sym __p_rcode_syms[];
351#endif /* SHARED_LIBBIND */
352
353#ifndef ANDROID_CHANGES
354#define dn_comp			__dn_comp
355#endif
356#define dn_count_labels		__dn_count_labels
357#define dn_skipname		__dn_skipname
358#define fp_resstat		__fp_resstat
359#define loc_aton		__loc_aton
360#define loc_ntoa		__loc_ntoa
361#define p_cdname		__p_cdname
362#define p_cdnname		__p_cdnname
363#define p_class			__p_class
364#define p_fqname		__p_fqname
365#define p_fqnname		__p_fqnname
366#define p_option		__p_option
367#define p_secstodate		__p_secstodate
368#define p_section		__p_section
369#define p_time			__p_time
370#define p_type			__p_type
371#define p_rcode			__p_rcode
372#define p_sockun		__p_sockun
373#define putlong			__putlong
374#define putshort		__putshort
375#define res_dnok		__res_dnok
376#define res_findzonecut		__res_findzonecut
377#define res_findzonecut2	__res_findzonecut2
378#define res_hnok		__res_hnok
379#define res_hostalias		__res_hostalias
380#define res_mailok		__res_mailok
381#define res_nameinquery		__res_nameinquery
382#define res_nclose		__res_nclose
383#define res_ninit		__res_ninit
384#define res_nmkquery		__res_nmkquery
385#define res_pquery		__res_pquery
386#define res_nquery		__res_nquery
387#define res_nquerydomain	__res_nquerydomain
388#define res_nsearch		__res_nsearch
389#define res_nsend		__res_nsend
390#define res_nsendsigned		__res_nsendsigned
391#define res_nisourserver	__res_nisourserver
392#define res_ownok		__res_ownok
393#define res_queriesmatch	__res_queriesmatch
394#define res_randomid		__res_randomid
395#define sym_ntop		__sym_ntop
396#define sym_ntos		__sym_ntos
397#define sym_ston		__sym_ston
398#define res_nopt		__res_nopt
399#define res_ndestroy		__res_ndestroy
400#define	res_nametoclass		__res_nametoclass
401#define	res_nametotype		__res_nametotype
402#define	res_setservers		__res_setservers
403#define	res_getservers		__res_getservers
404#define	res_buildprotolist	__res_buildprotolist
405#define	res_destroyprotolist	__res_destroyprotolist
406#define	res_destroyservicelist	__res_destroyservicelist
407#define	res_get_nibblesuffix	__res_get_nibblesuffix
408#define	res_get_nibblesuffix2	__res_get_nibblesuffix2
409#define	res_ourserver_p		__res_ourserver_p
410#define	res_protocolname	__res_protocolname
411#define	res_protocolnumber	__res_protocolnumber
412#define	res_send_setqhook	__res_send_setqhook
413#define	res_send_setrhook	__res_send_setrhook
414#define	res_servicename		__res_servicename
415#define	res_servicenumber	__res_servicenumber
416__BEGIN_DECLS
417int		res_hnok(const char *);
418int		res_ownok(const char *);
419int		res_mailok(const char *);
420int		res_dnok(const char *);
421int		sym_ston(const struct res_sym *, const char *, int *);
422const char *	sym_ntos(const struct res_sym *, int, int *);
423const char *	sym_ntop(const struct res_sym *, int, int *);
424#ifndef ANDROID_CHANGES
425int		b64_ntop(u_char const *, size_t, char *, size_t);
426int		b64_pton(char const *, u_char *, size_t);
427#endif
428int		loc_aton(const char *, u_char *);
429const char *	loc_ntoa(const u_char *, char *);
430int		dn_skipname(const u_char *, const u_char *);
431void		putlong(uint32_t, u_char *);
432void		putshort(uint16_t, u_char *);
433#ifndef __ultrix__
434uint16_t	_getshort(const u_char *);
435uint32_t	_getlong(const u_char *);
436#endif
437const char *	p_class(int);
438const char *	p_time(uint32_t);
439const char *	p_type(int);
440const char *	p_rcode(int);
441__LIBC_HIDDEN__ const char *	p_sockun(union res_sockaddr_union, char *, size_t);
442const u_char *	p_cdnname(const u_char *, const u_char *, int, FILE *);
443const u_char *	p_cdname(const u_char *, const u_char *, FILE *);
444const u_char *	p_fqnname(const u_char *, const u_char *,
445			       int, char *, int);
446const u_char *	p_fqname(const u_char *, const u_char *, FILE *);
447const char *	p_option(u_long);
448char *		p_secstodate(u_long);
449int		dn_count_labels(const char *);
450u_int		res_randomid(void);
451int		res_nameinquery(const char *, int, int, const u_char *,
452				     const u_char *);
453int		res_queriesmatch(const u_char *, const u_char *,
454				      const u_char *, const u_char *);
455__LIBC_HIDDEN__ const char *	p_section(int, int);
456/* Things involving a resolver context. */
457int		res_ninit(res_state);
458int		res_nisourserver(const res_state, const struct sockaddr_in *);
459void		fp_resstat(const res_state, FILE *);
460__LIBC_HIDDEN__ void		res_pquery(const res_state, const u_char *, int, FILE *);
461const char *	res_hostalias(const res_state, const char *, char *, size_t);
462int		res_nquery(res_state, const char *, int, int, u_char *, int);
463int		res_nsearch(res_state, const char *, int, int, u_char *, int);
464int		res_nquerydomain(res_state, const char *, const char *,
465				      int, int, u_char *, int);
466int		res_nmkquery(res_state, int, const char *, int, int,
467				  const u_char *, int, const u_char *,
468				  u_char *, int);
469int		res_nsend(res_state, const u_char *, int, u_char *, int);
470int		res_nsendsigned(res_state, const u_char *, int,
471				     ns_tsig_key *, u_char *, int);
472int		res_findzonecut(res_state, const char *, ns_class, int,
473				     char *, size_t, struct in_addr *, int);
474int		res_findzonecut2(res_state, const char *, ns_class, int,
475				      char *, size_t,
476				      union res_sockaddr_union *, int);
477void		res_nclose(res_state);
478__LIBC_HIDDEN__ int		res_nopt(res_state, int, u_char *, int, int);
479void		res_send_setqhook(res_send_qhook);
480void		res_send_setrhook(res_send_rhook);
481__LIBC_HIDDEN__ int		__res_vinit(res_state, int);
482void		res_destroyservicelist(void);
483const char *	res_servicename(uint16_t, const char *);
484const char *	res_protocolname(int);
485void		res_destroyprotolist(void);
486void		res_buildprotolist(void);
487__LIBC_HIDDEN__ const char *	res_get_nibblesuffix(res_state);
488__LIBC_HIDDEN__ const char *	res_get_nibblesuffix2(res_state);
489__LIBC_HIDDEN__ void		res_ndestroy(res_state);
490__LIBC_HIDDEN__ uint16_t	res_nametoclass(const char *, int *);
491__LIBC_HIDDEN__ uint16_t	res_nametotype(const char *, int *);
492__LIBC_HIDDEN__ void		res_setservers(res_state,
493				    const union res_sockaddr_union *, int);
494__LIBC_HIDDEN__ int		res_getservers(res_state,
495				    union res_sockaddr_union *, int);
496
497__LIBC_HIDDEN__ void res_setnetid(res_state, unsigned);
498__LIBC_HIDDEN__ void res_setmark(res_state, unsigned);
499u_int  res_randomid(void);
500
501#ifdef __i386__
502# define __socketcall extern __attribute__((__cdecl__))
503#else
504# define __socketcall extern
505#endif
506
507__socketcall int __connect(int, const struct sockaddr*, socklen_t);
508
509#undef __socketcall
510
511__END_DECLS
512
513#pragma GCC visibility pop
514
515#endif /* !_RESOLV_PRIVATE_H_ */
516