Remove extra whitespace.
[dragonfly.git] / include / resolv.h
CommitLineData
984263bc
MD
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: src/include/resolv.h,v 1.19.2.1 2001/06/15 22:08:26 ume Exp $
5baeefc7 55 * $DragonFly: src/include/resolv.h,v 1.4 2004/02/26 13:58:25 joerg Exp $
984263bc
MD
56 */
57
58#ifndef _RESOLV_H_
59#define _RESOLV_H_
60
61#include <sys/param.h>
62#include <sys/types.h>
63#include <sys/cdefs.h>
64#include <sys/socket.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 pad[72]; /* on an i386 this means 512b total */
119};
120
121/* for INET6 */
122/*
123 * replacement of __res_state, separated to keep binary compatibility.
124 */
125struct __res_state_ext {
126 struct sockaddr_storage nsaddr_list[MAXNS];
127 struct {
128 int af; /* address family for addr, mask */
129 union {
130 struct in_addr ina;
131 struct in6_addr in6a;
132 } addr, mask;
133 } sort_list[MAXRESOLVSORT];
134};
135
136/*
137 * Resolver options (keep these in synch with res_debug.c, please)
138 */
139#define RES_INIT 0x00000001 /* address initialized */
140#define RES_DEBUG 0x00000002 /* print debug messages */
141#define RES_AAONLY 0x00000004 /* authoritative answers only (!IMPL)*/
142#define RES_USEVC 0x00000008 /* use virtual circuit */
143#define RES_PRIMARY 0x00000010 /* query primary server only (!IMPL) */
144#define RES_IGNTC 0x00000020 /* ignore truncation errors */
145#define RES_RECURSE 0x00000040 /* recursion desired */
146#define RES_DEFNAMES 0x00000080 /* use default domain name */
147#define RES_STAYOPEN 0x00000100 /* Keep TCP socket open */
148#define RES_DNSRCH 0x00000200 /* search up local domain tree */
149#define RES_INSECURE1 0x00000400 /* type 1 security disabled */
150#define RES_INSECURE2 0x00000800 /* type 2 security disabled */
151#define RES_NOALIASES 0x00001000 /* shuts off HOSTALIASES feature */
152#define RES_USE_INET6 0x00002000 /* use/map IPv6 in gethostbyname() */
153#define RES_NOTLDQUERY 0x00004000 /* Don't query TLD names */
154/* KAME extensions: use higher bit to avoid conflict with ISC use */
155#define RES_USE_EDNS0 0x40000000 /* use EDNS0 */
156
157#define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
158
159/*
160 * Resolver "pfcode" values. Used by dig.
161 */
162#define RES_PRF_STATS 0x00000001
163#define RES_PRF_UPDATE 0x00000002
164#define RES_PRF_CLASS 0x00000004
165#define RES_PRF_CMD 0x00000008
166#define RES_PRF_QUES 0x00000010
167#define RES_PRF_ANS 0x00000020
168#define RES_PRF_AUTH 0x00000040
169#define RES_PRF_ADD 0x00000080
170#define RES_PRF_HEAD1 0x00000100
171#define RES_PRF_HEAD2 0x00000200
172#define RES_PRF_TTLID 0x00000400
173#define RES_PRF_HEADX 0x00000800
174#define RES_PRF_QUERY 0x00001000
175#define RES_PRF_REPLY 0x00002000
176#define RES_PRF_INIT 0x00004000
177/* 0x00008000 */
178
179typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
180 res_sendhookact;
181
5baeefc7
JS
182typedef res_sendhookact (*res_send_qhook)(struct sockaddr_in * const *,
183 const u_char **, int *,
184 u_char *, int, int *);
984263bc 185
5baeefc7
JS
186typedef res_sendhookact (*res_send_rhook)(const struct sockaddr_in *,
187 const u_char *, int,
188 u_char *, int, int *);
984263bc
MD
189
190struct res_sym {
191 int number; /* Identifying number, like T_MX */
192 char * name; /* Its symbolic name, like "MX" */
193 char * humanname; /* Its fun name, like "mail exchanger" */
194};
195
196extern struct __res_state _res;
197/* for INET6 */
198extern struct __res_state_ext _res_ext;
199
200extern const struct res_sym __p_class_syms[];
201extern const struct res_sym __p_type_syms[];
202
203/* Private routines shared between libc/net, named, nslookup and others. */
204#define res_hnok __res_hnok
205#define res_ownok __res_ownok
206#define res_mailok __res_mailok
207#define res_dnok __res_dnok
208#define sym_ston __sym_ston
209#define sym_ntos __sym_ntos
210#define sym_ntop __sym_ntop
211#define b64_ntop __b64_ntop
212#define b64_pton __b64_pton
213#define loc_ntoa __loc_ntoa
214#define loc_aton __loc_aton
215#define fp_resstat __fp_resstat
216#define p_query __p_query
217#define dn_skipname __dn_skipname
218#define fp_resstat __fp_resstat
219#define fp_query __fp_query
220#define fp_nquery __fp_nquery
221#define hostalias __hostalias
222#define putlong __putlong
223#define putshort __putshort
224#define p_class __p_class
225#define p_time __p_time
226#define p_type __p_type
227#define p_query __p_query
228#define p_cdnname __p_cdnname
229#define p_section __p_section
230#define p_cdname __p_cdname
231#define p_fqnname __p_fqnname
232#define p_fqname __p_fqname
233#define p_option __p_option
234#define p_secstodate __p_secstodate
235#define dn_count_labels __dn_count_labels
236#define dn_comp __dn_comp
237#define dn_expand __dn_expand
238#define res_init __res_init
239#define res_randomid __res_randomid
240#define res_query __res_query
241#define res_search __res_search
242#define res_querydomain __res_querydomain
243#define res_mkquery __res_mkquery
244#define res_send __res_send
245#define res_isourserver __res_isourserver
246#define res_nameinquery __res_nameinquery
247#define res_queriesmatch __res_queriesmatch
248#define res_close __res_close
249#define res_opt __res_opt
250#define res_mkupdate __res_mkupdate
251#define res_mkupdrec __res_mkupdrec
252#define res_freeupdrec __res_freeupdrec
253
254__BEGIN_DECLS
5baeefc7
JS
255int res_hnok(const char *);
256int res_ownok(const char *);
257int res_mailok(const char *);
258int res_dnok(const char *);
259int sym_ston(const struct res_sym *, const char *, int *);
260const char *sym_ntos(const struct res_sym *, int, int *);
261const char *sym_ntop(const struct res_sym *, int, int *);
262int b64_ntop(u_char const *, size_t, char *, size_t);
263int b64_pton(char const *, u_char *, size_t);
264int loc_aton(const char *, u_char *);
265const char *loc_ntoa(const u_char *, char *);
266int dn_skipname(const u_char *, const u_char *);
267void fp_resstat(struct __res_state *, FILE *);
268void fp_query(const u_char *, FILE *);
269void fp_nquery(const u_char *, int, FILE *);
270const char *hostalias(const char *);
271void putlong(u_int32_t, u_char *);
272void putshort(u_int16_t, u_char *);
273const char *p_class(int);
274const char *p_time(u_int32_t);
275const char *p_type(int);
276void p_query(const u_char *);
277const u_char *p_cdnname(const u_char *, const u_char *, int, FILE *);
278const u_char *p_cdname(const u_char *, const u_char *, FILE *);
279const u_char *p_fqnname(const u_char *, const u_char *,
280 int, char *, int);
281const u_char *p_fqname(const u_char *, const u_char *, FILE *);
282const char *p_option(u_long);
283char *p_secstodate(u_long);
284int dn_count_labels(const char *);
285int dn_comp(const char *, u_char *, int,
286 u_char **, u_char **);
287int dn_expand(const u_char *, const u_char *, const u_char *,
288 char *, int);
289int res_init(void);
290u_int res_randomid(void);
291int res_query(const char *, int, int, u_char *, int);
292int res_search(const char *, int, int, u_char *, int);
293int res_querydomain(const char *, const char *, int, int,
294 u_char *, int);
295int res_mkquery(int, const char *, int, int, const u_char *,
296 int, const u_char *, u_char *, int);
297int res_send(const u_char *, int, u_char *, int);
298int res_isourserver(const struct sockaddr_in *);
299int res_nameinquery(const char *, int, int,
300 const u_char *, const u_char *);
301int res_queriesmatch(const u_char *, const u_char *,
302 const u_char *, const u_char *);
303void res_close(void);
304int res_opt(int, u_char *, int, int);
305const char *p_section(int, int);
984263bc
MD
306/* XXX The following depend on the ns_updrec typedef in arpa/nameser.h */
307#ifdef _ARPA_NAMESER_H_
5baeefc7
JS
308int res_update(ns_updrec *);
309int res_mkupdate(ns_updrec *, u_char *, int);
310ns_updrec *res_mkupdrec(int, const char *, u_int, u_int, u_long);
311void res_freeupdrec(ns_updrec *);
984263bc
MD
312#endif
313__END_DECLS
314
315#endif /* !_RESOLV_H_ */