2003-03-15 Roland McGrath <roland@redhat.com>
[kopensolaris-gnu/glibc.git] / resolv / resolv.h
1 /*
2  * Copyright (c) 1983, 1987, 1989
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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 /*
31  * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
32  *
33  * Permission to use, copy, modify, and distribute this software for any
34  * purpose with or without fee is hereby granted, provided that the above
35  * copyright notice and this permission notice appear in all copies.
36  *
37  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
38  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
40  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
41  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
42  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
43  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44  * SOFTWARE.
45  */
46
47 /*
48  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
49  *      $BINDId: resolv.h,v 8.31 2000/03/30 20:16:50 vixie Exp $
50  */
51
52 #ifndef _RESOLV_H_
53
54 /* These headers are needed for types used in the `struct res_state'
55    declaration.  */
56 #include <sys/types.h>
57 #include <netinet/in.h>
58
59 #ifndef __need_res_state
60 # define _RESOLV_H_
61
62 # include <sys/param.h>
63 # include <sys/cdefs.h>
64 # include <stdio.h>
65 # include <arpa/nameser.h>
66 #endif
67
68 #ifndef __res_state_defined
69 # define __res_state_defined
70
71 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
72         res_sendhookact;
73
74 typedef res_sendhookact (*res_send_qhook) (struct sockaddr_in * const *ns,
75                                            const u_char **query,
76                                            int *querylen,
77                                            u_char *ans,
78                                            int anssiz,
79                                            int *resplen);
80
81 typedef res_sendhookact (*res_send_rhook) (const struct sockaddr_in *ns,
82                                            const u_char *query,
83                                            int querylen,
84                                            u_char *ans,
85                                            int anssiz,
86                                            int *resplen);
87
88 /*
89  * Global defines and variables for resolver stub.
90  */
91 # define MAXNS                  3       /* max # name servers we'll track */
92 # define MAXDFLSRCH             3       /* # default domain levels to try */
93 # define MAXDNSRCH              6       /* max # domains in search path */
94 # define LOCALDOMAINPARTS       2       /* min levels in name that is "local" */
95
96 # define RES_TIMEOUT            5       /* min. seconds between retries */
97 # define MAXRESOLVSORT          10      /* number of net to sort on */
98 # define RES_MAXNDOTS           15      /* should reflect bit field size */
99 # define RES_MAXRETRANS         30      /* only for resolv.conf/RES_OPTIONS */
100 # define RES_MAXRETRY           5       /* only for resolv.conf/RES_OPTIONS */
101 # define RES_DFLRETRY           2       /* Default #/tries. */
102 # define RES_MAXTIME            65535   /* Infinity, in milliseconds. */
103
104 struct __res_state {
105         int     retrans;                /* retransmition time interval */
106         int     retry;                  /* number of times to retransmit */
107         u_long  options;                /* option flags - see below. */
108         int     nscount;                /* number of name servers */
109         struct sockaddr_in
110                 nsaddr_list[MAXNS];     /* address of name server */
111 # define nsaddr nsaddr_list[0]          /* for backward compatibility */
112         u_short id;                     /* current message id */
113         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
114         char    defdname[256];          /* default domain (deprecated) */
115         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
116         unsigned ndots:4;               /* threshold for initial abs. query */
117         unsigned nsort:4;               /* number of elements in sort_list[] */
118         char    unused[3];
119         struct {
120                 struct in_addr  addr;
121                 u_int32_t       mask;
122         } sort_list[MAXRESOLVSORT];
123         res_send_qhook qhook;           /* query hook */
124         res_send_rhook rhook;           /* response hook */
125         int     res_h_errno;            /* last one set for this context */
126         int     _vcsock;                /* PRIVATE: for res_send VC i/o */
127         u_int   _flags;                 /* PRIVATE: see below */
128         union {
129                 char    pad[52];        /* On an i386 this means 512b total. */
130                 struct {
131                         u_int16_t               nscount;
132                         u_int16_t               nsmap[MAXNS];
133                         int                     nssocks[MAXNS];
134                         u_int16_t               nscount6;
135                         u_int16_t               nsinit;
136                         struct sockaddr_in6     *nsaddrs[MAXNS];
137                 } _ext;
138         } _u;
139 };
140
141 typedef struct __res_state *res_state;
142 # undef __need_res_state
143 #endif
144
145 #ifdef _RESOLV_H_
146 /*
147  * Revision information.  This is the release date in YYYYMMDD format.
148  * It can change every day so the right thing to do with it is use it
149  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
150  * compare for equality; rather, use it to determine whether your resolver
151  * is new enough to contain a certain feature.
152  */
153
154 #define __RES   19991006
155
156 /*
157  * Resolver configuration file.
158  * Normally not present, but may contain the address of the
159  * inital name server(s) to query and the domain search list.
160  */
161
162 #ifndef _PATH_RESCONF
163 #define _PATH_RESCONF        "/etc/resolv.conf"
164 #endif
165
166 struct res_sym {
167         int     number;         /* Identifying number, like T_MX */
168         char *  name;           /* Its symbolic name, like "MX" */
169         char *  humanname;      /* Its fun name, like "mail exchanger" */
170 };
171
172 /*
173  * Resolver flags (used to be discrete per-module statics ints).
174  */
175 #define RES_F_VC        0x00000001      /* socket is TCP */
176 #define RES_F_CONN      0x00000002      /* socket is connected */
177
178 /* res_findzonecut() options */
179 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
180
181 /*
182  * Resolver options (keep these in synch with res_debug.c, please)
183  */
184 #define RES_INIT        0x00000001      /* address initialized */
185 #define RES_DEBUG       0x00000002      /* print debug messages */
186 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
187 #define RES_USEVC       0x00000008      /* use virtual circuit */
188 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
189 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
190 #define RES_RECURSE     0x00000040      /* recursion desired */
191 #define RES_DEFNAMES    0x00000080      /* use default domain name */
192 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
193 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
194 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
195 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
196 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
197 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
198 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
199 #define RES_NOCHECKNAME 0x00008000      /* do not check names for sanity. */
200 #define RES_KEEPTSIG    0x00010000      /* do not strip TSIG records */
201 #define RES_BLAST       0x00020000      /* blast all recursive servers */
202
203 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
204
205 /*
206  * Resolver "pfcode" values.  Used by dig.
207  */
208 #define RES_PRF_STATS   0x00000001
209 #define RES_PRF_UPDATE  0x00000002
210 #define RES_PRF_CLASS   0x00000004
211 #define RES_PRF_CMD     0x00000008
212 #define RES_PRF_QUES    0x00000010
213 #define RES_PRF_ANS     0x00000020
214 #define RES_PRF_AUTH    0x00000040
215 #define RES_PRF_ADD     0x00000080
216 #define RES_PRF_HEAD1   0x00000100
217 #define RES_PRF_HEAD2   0x00000200
218 #define RES_PRF_TTLID   0x00000400
219 #define RES_PRF_HEADX   0x00000800
220 #define RES_PRF_QUERY   0x00001000
221 #define RES_PRF_REPLY   0x00002000
222 #define RES_PRF_INIT    0x00004000
223 /*                      0x00008000      */
224
225 /* Things involving an internal (static) resolver context. */
226 __BEGIN_DECLS
227 extern struct __res_state *__res_state(void) __attribute__ ((__const__));
228 __END_DECLS
229 #define _res (*__res_state())
230
231 #ifndef __BIND_NOSTATIC
232 #define fp_nquery               __fp_nquery
233 #define fp_query                __fp_query
234 #define hostalias               __hostalias
235 #define p_query                 __p_query
236 #define res_close               __res_close
237 #define res_init                __res_init
238 #define res_isourserver         __res_isourserver
239 #define res_mkquery             __res_mkquery
240 #define res_query               __res_query
241 #define res_querydomain         __res_querydomain
242 #define res_search              __res_search
243 #define res_send                __res_send
244
245 __BEGIN_DECLS
246 void            fp_nquery __P((const u_char *, int, FILE *));
247 void            fp_query __P((const u_char *, FILE *));
248 const char *    hostalias __P((const char *));
249 void            p_query __P((const u_char *));
250 void            res_close __P((void));
251 int             res_init __P((void));
252 int             res_isourserver __P((const struct sockaddr_in *));
253 int             res_mkquery __P((int, const char *, int, int, const u_char *,
254                                  int, const u_char *, u_char *, int));
255 int             res_query __P((const char *, int, int, u_char *, int));
256 int             res_querydomain __P((const char *, const char *, int, int,
257                                      u_char *, int));
258 int             res_search __P((const char *, int, int, u_char *, int));
259 int             res_send __P((const u_char *, int, u_char *, int));
260 __END_DECLS
261 #endif
262
263 #define b64_ntop                __b64_ntop
264 #define b64_pton                __b64_pton
265 #define dn_comp                 __dn_comp
266 #define dn_count_labels         __dn_count_labels
267 #define dn_expand               __dn_expand
268 #define dn_skipname             __dn_skipname
269 #define fp_resstat              __fp_resstat
270 #define loc_aton                __loc_aton
271 #define loc_ntoa                __loc_ntoa
272 #define p_cdname                __p_cdname
273 #define p_cdnname               __p_cdnname
274 #define p_class                 __p_class
275 #define p_fqname                __p_fqname
276 #define p_fqnname               __p_fqnname
277 #define p_option                __p_option
278 #define p_secstodate            __p_secstodate
279 #define p_section               __p_section
280 #define p_time                  __p_time
281 #define p_type                  __p_type
282 #define p_rcode                 __p_rcode
283 #define putlong                 __putlong
284 #define putshort                __putshort
285 #define res_dnok                __res_dnok
286 #define res_hnok                __res_hnok
287 #define res_hostalias           __res_hostalias
288 #define res_mailok              __res_mailok
289 #define res_nameinquery         __res_nameinquery
290 #define res_nclose              __res_nclose
291 #define res_ninit               __res_ninit
292 #define res_nmkquery            __res_nmkquery
293 #define res_npquery             __res_npquery
294 #define res_nquery              __res_nquery
295 #define res_nquerydomain        __res_nquerydomain
296 #define res_nsearch             __res_nsearch
297 #define res_nsend               __res_nsend
298 #define res_nisourserver        __res_nisourserver
299 #define res_ownok               __res_ownok
300 #define res_queriesmatch        __res_queriesmatch
301 #define res_randomid            __res_randomid
302 #define sym_ntop                __sym_ntop
303 #define sym_ntos                __sym_ntos
304 #define sym_ston                __sym_ston
305 __BEGIN_DECLS
306 int             res_hnok __P((const char *));
307 int             res_ownok __P((const char *));
308 int             res_mailok __P((const char *));
309 int             res_dnok __P((const char *));
310 int             sym_ston __P((const struct res_sym *, const char *, int *));
311 const char *    sym_ntos __P((const struct res_sym *, int, int *));
312 const char *    sym_ntop __P((const struct res_sym *, int, int *));
313 int             b64_ntop __P((u_char const *, size_t, char *, size_t));
314 int             b64_pton __P((char const *, u_char *, size_t));
315 int             loc_aton __P((const char *ascii, u_char *binary));
316 const char *    loc_ntoa __P((const u_char *binary, char *ascii));
317 int             dn_skipname __P((const u_char *, const u_char *));
318 void            putlong __P((u_int32_t, u_char *));
319 void            putshort __P((u_int16_t, u_char *));
320 const char *    p_class __P((int));
321 const char *    p_time __P((u_int32_t));
322 const char *    p_type __P((int));
323 const char *    p_rcode __P((int));
324 const u_char *  p_cdnname __P((const u_char *, const u_char *, int, FILE *));
325 const u_char *  p_cdname __P((const u_char *, const u_char *, FILE *));
326 const u_char *  p_fqnname __P((const u_char *cp, const u_char *msg,
327                                int, char *, int));
328 const u_char *  p_fqname __P((const u_char *, const u_char *, FILE *));
329 const char *    p_option __P((u_long option));
330 char *          p_secstodate __P((u_long));
331 int             dn_count_labels __P((const char *));
332 int             dn_comp __P((const char *, u_char *, int,
333                              u_char **, u_char **));
334 int             dn_expand __P((const u_char *, const u_char *, const u_char *,
335                                char *, int));
336 u_int           res_randomid __P((void));
337 int             res_nameinquery __P((const char *, int, int,
338                                      const u_char *, const u_char *));
339 int             res_queriesmatch __P((const u_char *, const u_char *,
340                                       const u_char *, const u_char *));
341 const char *    p_section __P((int section, int opcode));
342 /* Things involving a resolver context. */
343 int             res_ninit __P((res_state));
344 int             res_nisourserver __P((const res_state,
345                                       const struct sockaddr_in *));
346 void            fp_resstat __P((const res_state, FILE *));
347 void            res_npquery __P((const res_state, const u_char *, int, FILE *));
348 const char *    res_hostalias __P((const res_state, const char *,
349                                    char *, size_t));
350 int             res_nquery __P((res_state,
351                                 const char *, int, int, u_char *, int));
352 int             res_nsearch __P((res_state, const char *, int,
353                                  int, u_char *, int));
354 int             res_nquerydomain __P((res_state,
355                                       const char *, const char *, int, int,
356                                       u_char *, int));
357 int             res_nmkquery __P((res_state,
358                                   int, const char *, int, int, const u_char *,
359                                   int, const u_char *, u_char *, int));
360 int             res_nsend __P((res_state, const u_char *, int, u_char *, int));
361 void            res_nclose __P((res_state));
362 __END_DECLS
363 #endif
364
365 #endif /* !_RESOLV_H_ */