chiark / gitweb /
changelog: Document changes in 1.6.0 and finalise version number
[adns.git] / src / adns.h
1 /*
2  * adns.h
3  * - adns user-visible API
4  */
5 /*
6  *
7  *  This file is part of adns, which is
8  *    Copyright (C) 1997-2000,2003,2006,2014-2016  Ian Jackson
9  *    Copyright (C) 1999-2000,2003,2006 Tony Finch
10  *    Copyright (C) 1991 Massachusetts Institute of Technology
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; either version 3, or (at your option)
15  *  any later version.
16  *  
17  *  This program is distributed in the hope that it will be useful,
18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  *  GNU General Public License for more details.
21  *
22  * 
23  *  For the benefit of certain LGPL'd `omnibus' software which
24  *  provides a uniform interface to various things including adns, I
25  *  make the following additional licence.  I do this because the GPL
26  *  would otherwise force either the omnibus software to be GPL'd or
27  *  the adns-using part to be distributed separately.
28  *  
29  *  So: you may also redistribute and/or modify adns.h (but only the
30  *  public header file adns.h and not any other part of adns) under the
31  *  terms of the GNU Library General Public License as published by the
32  *  Free Software Foundation; either version 2 of the License, or (at
33  *  your option) any later version.
34  *  
35  *  Note that adns itself is GPL'd.  Authors of adns-using applications
36  *  with GPL-incompatible licences, and people who distribute adns with
37  *  applications where the whole distribution is not GPL'd, are still
38  *  likely to be in violation of the GPL.  Anyone who wants to do this
39  *  should contact Ian Jackson.  Please note that to avoid encouraging
40  *  people to infringe the GPL as it applies to the body of adns, Ian
41  *  thinks that if you take advantage of the special exception to
42  *  redistribute just adns.h under the LGPL, you should retain this
43  *  paragraph in its place in the appropriate copyright statements.
44  *
45  *
46  *  You should have received a copy of the GNU General Public License,
47  *  or the GNU Library General Public License, as appropriate, along
48  *  with this program; if not, write to the Free Software Foundation.
49  *
50  */
51
52 #ifndef ADNS_H_INCLUDED
53 #define ADNS_H_INCLUDED
54
55 #include <stdio.h>
56 #include <stdarg.h>
57
58 #include <sys/types.h>
59 #include <sys/socket.h>
60 #include <netinet/in.h>
61 #include <sys/time.h>
62 #include <unistd.h>
63 #include <net/if.h>
64
65 #ifdef __cplusplus
66 extern "C" { /* I really dislike this - iwj. */
67 #endif
68
69 /* Whether to support address families other than IPv4 in responses which use
70  * the `adns_rr_addr' structure.  This is a source-compatibility issue: old
71  * clients may not expect to find address families other than AF_INET in
72  * their query results.  There's a separate binary compatibility issue to do
73  * with the size of the `adns_rr_addr' structure, but we'll assume you can
74  * cope with that because you have this header file.  Define
75  * `ADNS_FEATURE_IPV4ONLY' if you only want to see AF_INET addresses by
76  * default, or `ADNS_FEATURE_MANYAF' to allow multiple address families; the
77  * default is currently to stick with AF_INET only, but this is likely to
78  * change in a later release of ADNS.  Note that any adns_qf_want_... flags
79  * in your query are observed: this setting affects only the default address
80  * families.
81  */
82 #if !defined(ADNS_FEATURE_IPV4ONLY) && !defined(ADNS_FEATURE_MANYAF)
83 #  define ADNS_FEATURE_IPV4ONLY
84 #elif defined(ADNS_FEATURE_IPV4ONLY) && defined(ADNS_FEATURE_MANYAF)
85 #  error "Feature flags ADNS_FEATURE_IPV4ONLY and ..._MANYAF are incompatible"
86 #endif
87
88 /* All struct in_addr anywhere in adns are in NETWORK byte order. */
89
90 typedef struct adns__state *adns_state;
91 typedef struct adns__query *adns_query;
92
93 typedef enum { /* In general, or together the desired flags: */
94  adns_if_none=        0x0000,/* no flags.  nicer than 0 for some compilers */
95  adns_if_noenv=       0x0001,/* do not look at environment */
96  adns_if_noerrprint=  0x0002,/* never print to stderr (_debug overrides) */
97  adns_if_noserverwarn=0x0004,/* do not warn to stderr about duff servers etc */
98  adns_if_debug=       0x0008,/* enable all output to stderr plus debug msgs */
99  adns_if_logpid=      0x0080,/* include pid in diagnostic output */
100  adns_if_noautosys=   0x0010,/* do not make syscalls at every opportunity */
101  adns_if_eintr=       0x0020,/* allow _wait and _synchronous to return EINTR */
102  adns_if_nosigpipe=   0x0040,/* applic has SIGPIPE ignored, do not protect */
103  adns_if_monotonic=   0x0080,/* enable if you can; see adns_processtimeouts  */
104  adns_if_checkc_entex=0x0100,/* consistency checks on entry/exit to adns fns */
105  adns_if_checkc_freq= 0x0300,/* consistency checks very frequently (slow!) */
106
107  adns_if_permit_ipv4= 0x0400,/* allow _addr queries to return IPv4 addresses  */
108  adns_if_permit_ipv6= 0x0800,/* allow _addr queries to return IPv6 addresses */
109  adns_if_afmask=      0x0c00,
110    /* These are policy flags, and overridden by the adns_af:... option in
111     * resolv.conf.  If the adns_qf_want_... query flags are incompatible with
112     * these settings (in the sense that no address families are permitted at
113     * all) then the query flags take precedence; otherwise only records which
114     * satisfy all of the stated requirements are allowed.
115     */
116  adns__if_sizeforce= 0x7fff,
117 } adns_initflags;
118
119 typedef enum { /* In general, or together the desired flags: */
120  adns_qf_none=           0x00000000,/* no flags */
121  adns_qf_search=         0x00000001,/* use the searchlist */
122  adns_qf_usevc=          0x00000002,/* use a virtual circuit (TCP conn) */
123  adns_qf_owner=          0x00000004,/* fill in the owner field in the answer */
124  adns_qf_quoteok_query=  0x00000010,/* allow special chars in query domain */
125  adns_qf_quoteok_cname=  0x00000000,/*  ... in CNAME we go via (now default) */
126  adns_qf_quoteok_anshost=0x00000040,/*  ... in things supposedly hostnames */
127  adns_qf_quotefail_cname=0x00000080,/* refuse if quote-req chars in CNAME we go via */
128  adns_qf_cname_loose=    0x00000100,/* allow refs to CNAMEs - without, get _s_cname */
129  adns_qf_cname_strict=   0x00010000,/* forbid CNAME refs (default, currently) */
130  adns_qf_cname_forbid=   0x00000200,/* don't follow CNAMEs, instead give _s_cname */
131
132  adns_qf_want_ipv4=      0x00000400,/* try to return IPv4 addresses */
133  adns_qf_want_ipv6=      0x00000800,/* try to return IPv6 addresses */
134  adns_qf_want_allaf=     0x00000c00,/* all the above flag bits */
135    /* Without any of the _qf_want_... flags, _qtf_deref queries try to return
136     * all address families permitted by _if_permit_... (as overridden by the
137     * `adns_af:...'  configuration option).  Set flags to restrict the
138     * returned address families to the ones selected.
139     */
140  adns_qf_ipv6_mapv4=     0x00001000,/*  ... return IPv4 addresses as v6-mapped */
141
142  adns_qf_addrlit_scope_forbid=0x00002000,/* forbid %<scope> in IPv6 literals */
143  adns_qf_addrlit_scope_numeric=0x00004000,/* %<scope> may only be numeric */
144  adns_qf_addrlit_ipv4_quadonly=0x00008000,/* reject non-dotted-quad ipv4 */
145
146  adns__qf_internalmask=  0x0ff00000,
147  adns__qf_sizeforce=     0x7fffffff
148 } adns_queryflags;
149
150 typedef enum {
151  adns_rrt_typemask=  0x0ffff,
152  adns_rrt_reprmask= 0xffffff,
153  adns__qtf_deref_bit=0x10000,/* internal version of ..._deref below */
154  adns__qtf_mail822=  0x20000,/* return mailboxes in RFC822 rcpt field fmt   */
155
156  adns__qtf_bigaddr=0x1000000,/* use the new larger sockaddr union */
157  adns__qtf_manyaf= 0x2000000,/* permitted to return multiple address families */
158
159  adns__qtf_deref=    adns__qtf_deref_bit|adns__qtf_bigaddr
160 #ifdef ADNS_FEATURE_MANYAF
161                      |adns__qtf_manyaf
162 #endif
163                             ,/* dereference domains; perhaps get extra data */
164
165  adns_r_unknown=     0x40000,
166    /* To use this, ask for records of type   <rr-type-code>|adns_r_unknown.
167     * adns will not process the RDATA - you'll get adns_rr_byteblocks,
168     * where the int is the length and the unsigned char* points to the
169     * data.  String representation of the RR data (by adns_rrinfo) is as in
170     * RFC3597.  adns_rr_info will not return the type name in *rrtname_r
171     * (due to memory management problems); *fmtname_r will be set to
172     * "unknown".
173     *
174     * Do not specify adns_r_unknown along with a known RR type which
175     * requires domain name uncompression (see RFC3597 s4); domain names
176     * will not be uncompressed and the resulting data would be useless.
177     * Asking for meta-RR types via adns_r_unknown will not work properly
178     * either and may make adns complain about server misbehaviour, so don't
179     * do that.
180     *
181     * Don't forget adns_qf_quoteok if that's what you want. */
182
183  adns_r_none=             0,
184                      
185  adns_r_a=                1,
186                      
187  adns_r_ns_raw=           2,
188  adns_r_ns=                  adns_r_ns_raw|adns__qtf_deref,
189                      
190  adns_r_cname=            5,
191                      
192  adns_r_soa_raw=          6,
193  adns_r_soa=                 adns_r_soa_raw|adns__qtf_mail822, 
194                      
195  adns_r_ptr_raw=         12, /* do not mind PTR with wrong or missing addr */
196  adns_r_ptr=                 adns_r_ptr_raw|adns__qtf_deref,
197                      
198  adns_r_hinfo=           13,  
199                      
200  adns_r_mx_raw=          15,
201  adns_r_mx=                  adns_r_mx_raw|adns__qtf_deref,
202                      
203  adns_r_txt=             16,
204                      
205  adns_r_rp_raw=          17,
206  adns_r_rp=                  adns_r_rp_raw|adns__qtf_mail822,
207
208  adns_r_aaaa=            28,
209
210  /* For SRV records, query domain without _qf_quoteok_query must look
211   * as expected from SRV RFC with hostname-like Name.  _With_
212   * _quoteok_query, any query domain is allowed. */
213  adns_r_srv_raw=         33,
214  adns_r_srv=                 adns_r_srv_raw|adns__qtf_deref,
215                      
216  adns_r_addr=                adns_r_a|adns__qtf_deref,
217
218  adns__rrt_sizeforce= 0x7fffffff,
219  
220 } adns_rrtype;
221
222 /*
223  * In queries without qf_quoteok_*, all domains must have standard
224  * legal syntax, or you get adns_s_querydomainvalid (if the query
225  * domain contains bad characters) or adns_s_answerdomaininvalid (if
226  * the answer contains bad characters).
227  * 
228  * In queries _with_ qf_quoteok_*, domains in the query or response
229  * may contain any characters, quoted according to RFC1035 5.1.  On
230  * input to adns, the char* is a pointer to the interior of a "
231  * delimited string, except that " may appear in it unquoted.  On
232  * output, the char* is a pointer to a string which would be legal
233  * either inside or outside " delimiters; any character which isn't
234  * legal in a hostname (ie alphanumeric or hyphen) or one of _ / +
235  * (the three other punctuation characters commonly abused in domain
236  * names) will be quoted, as \X if it is a printing ASCII character or
237  * \DDD otherwise.
238  *
239  * If the query goes via a CNAME then the canonical name (ie, the
240  * thing that the CNAME record refers to) is usually allowed to
241  * contain any characters, which will be quoted as above.  With
242  * adns_qf_quotefail_cname you get adns_s_answerdomaininvalid when
243  * this happens.  (This is a change from version 0.4 and earlier, in
244  * which failing the query was the default, and you had to say
245  * adns_qf_quoteok_cname to avoid this; that flag is now deprecated.)
246  *
247  * In version 0.4 and earlier, asking for _raw records containing
248  * mailboxes without specifying _qf_quoteok_anshost was silly.  This
249  * is no longer the case.  In this version only parts of responses
250  * that are actually supposed to be hostnames will be refused by
251  * default if quote-requiring characters are found.
252  */
253
254 /*
255  * If you ask for an RR which contains domains which are actually
256  * encoded mailboxes, and don't ask for the _raw version, then adns
257  * returns the mailbox formatted suitably for an RFC822 recipient
258  * header field.  The particular format used is that if the mailbox
259  * requires quoting according to the rules in RFC822 then the
260  * local-part is quoted in double quotes, which end at the next
261  * unescaped double quote (\ is the escape char, and is doubled, and
262  * is used to escape only \ and ").  If the local-part is legal
263  * without quoting according to RFC822, it is presented as-is.  In any
264  * case the local-part is followed by an @ and the domain.  The domain
265  * will not contain any characters not legal in hostnames.
266  *
267  * Unquoted local-parts may contain any printing 7-bit ASCII
268  * except the punctuation characters ( ) < > @ , ; : \ " [ ]
269  * I.e. they may contain alphanumerics, and the following
270  * punctuation characters:  ! # % ^ & * - _ = + { } .
271  *
272  * adns will reject local parts containing control characters (byte
273  * values 0-31, 127-159, and 255) - these appear to be legal according
274  * to RFC822 (at least 0-127) but are clearly a bad idea.  RFC1035
275  * syntax does not make any distinction between a single RFC822
276  * quoted-string containing full stops, and a series of quoted-strings
277  * separated by full stops; adns will return anything that isn't all
278  * valid atoms as a single quoted-string.  RFC822 does not allow
279  * high-bit-set characters at all, but adns does allow them in
280  * local-parts, treating them as needing quoting.
281  *
282  * If you ask for the domain with _raw then _no_ checking is done
283  * (even on the host part, regardless of adns_qf_quoteok_anshost), and
284  * you just get the domain name in master file format.
285  *
286  * If no mailbox is supplied the returned string will be `.' in either
287  * case.
288  */
289
290 typedef enum {
291  adns_s_ok,
292
293  /* locally induced errors */
294  adns_s_nomemory,
295  adns_s_unknownrrtype,
296  adns_s_systemfail,
297
298  adns_s_max_localfail= 29,
299  
300  /* remotely induced errors, detected locally */
301  adns_s_timeout,
302  adns_s_allservfail,
303  adns_s_norecurse,
304  adns_s_invalidresponse,
305  adns_s_unknownformat,
306
307  adns_s_max_remotefail= 59,
308  
309  /* remotely induced errors, reported by remote server to us */
310  adns_s_rcodeservfail,
311  adns_s_rcodeformaterror,
312  adns_s_rcodenotimplemented,
313  adns_s_rcoderefused,
314  adns_s_rcodeunknown,
315
316  adns_s_max_tempfail= 99,
317
318  /* remote configuration errors */
319  adns_s_inconsistent, /* PTR gives domain whose addr is missing or mismatch */
320  adns_s_prohibitedcname, /* CNAME, but eg A expected (not if _qf_cname_loose) */
321  adns_s_answerdomaininvalid,
322  adns_s_answerdomaintoolong,
323  adns_s_invaliddata,
324  
325  adns_s_max_misconfig= 199,
326
327  /* permanent problems with the query */
328  adns_s_querydomainwrong,
329  adns_s_querydomaininvalid,
330  adns_s_querydomaintoolong,
331  
332  adns_s_max_misquery= 299,
333
334  /* permanent errors */
335  adns_s_nxdomain,
336  adns_s_nodata,
337
338  adns_s_max_permfail= 499
339  
340 } adns_status;
341
342 typedef union {
343   struct sockaddr sa;
344   struct sockaddr_in inet;
345 } adns_sockaddr_v4only;
346
347 typedef union {
348   struct sockaddr sa;
349   struct sockaddr_in inet;
350   struct sockaddr_in6 inet6;
351 } adns_sockaddr;
352
353 typedef struct {
354   int len;
355   adns_sockaddr addr;
356 } adns_rr_addr;
357
358 typedef struct {
359   /* the old v4-only structure; handy if you have complicated binary
360    * compatibility problems. */
361   int len;
362   adns_sockaddr_v4only addr;
363 } adns_rr_addr_v4only;
364
365 typedef struct {
366   char *host;
367   adns_status astatus;
368   int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */
369   adns_rr_addr *addrs;
370 } adns_rr_hostaddr;
371
372 typedef struct {
373   char *(array[2]);
374 } adns_rr_strpair;
375
376 typedef struct {
377   int i;
378   adns_rr_hostaddr ha;
379 } adns_rr_inthostaddr;
380
381 typedef struct {
382   /* Used both for mx_raw, in which case i is the preference and str
383    * the domain, and for txt, in which case each entry has i for the
384    * `text' length, and str for the data (which will have had an extra
385    * nul appended so that if it was plain text it is now a
386    * null-terminated string).
387    */
388   int i;
389   char *str;
390 } adns_rr_intstr;
391
392 typedef struct {
393   adns_rr_intstr array[2];
394 } adns_rr_intstrpair;
395
396 typedef struct {
397   char *mname, *rname;
398   unsigned long serial, refresh, retry, expire, minimum;
399 } adns_rr_soa;
400
401 typedef struct {
402   int priority, weight, port;
403   char *host;
404 } adns_rr_srvraw;
405
406 typedef struct {
407   int priority, weight, port;
408   adns_rr_hostaddr ha;
409 } adns_rr_srvha;
410
411 typedef struct {
412   int len;
413   unsigned char *data;
414 } adns_rr_byteblock;
415
416 typedef struct {
417   adns_status status;
418   char *cname; /* always NULL if query was for CNAME records */
419   char *owner; /* only set if req'd in query flags; maybe 0 on error anyway */
420   adns_rrtype type; /* guaranteed to be same as in query */
421   time_t expires;/*abs time.  def only if _s_ok, nxdomain or nodata. NOT TTL!*/
422   int nrrs, rrsz; /* nrrs is 0 if an error occurs */
423   union {
424     void *untyped;
425     unsigned char *bytes;
426     char *(*str);                    /* ns_raw, cname, ptr, ptr_raw */
427     adns_rr_intstr *(*manyistr);     /* txt (list strs ends with i=-1, str=0)*/
428     adns_rr_addr *addr;              /* addr */
429     struct in_addr *inaddr;          /* a */
430     struct in6_addr *in6addr;        /* aaaa */
431     adns_rr_hostaddr *hostaddr;      /* ns */
432     adns_rr_intstrpair *intstrpair;  /* hinfo */
433     adns_rr_strpair *strpair;        /* rp, rp_raw */
434     adns_rr_inthostaddr *inthostaddr;/* mx */
435     adns_rr_intstr *intstr;          /* mx_raw */
436     adns_rr_soa *soa;                /* soa, soa_raw */
437     adns_rr_srvraw *srvraw;          /* srv_raw */
438     adns_rr_srvha *srvha;/* srv */
439     adns_rr_byteblock *byteblock;    /* ...|unknown */
440   } rrs;
441 } adns_answer;
442
443 /* Memory management:
444  *  adns_state and adns_query are actually pointers to malloc'd state;
445  *  On submission questions are copied, including the owner domain;
446  *  Answers are malloc'd as a single piece of memory; pointers in the
447  *  answer struct point into further memory in the answer.
448  * query_io:
449  *  Must always be non-null pointer;
450  *  If *query_io is 0 to start with then any query may be returned;
451  *  If *query_io is !0 adns_query then only that query may be returned.
452  *  If the call is successful, *query_io, *answer_r, and *context_r
453  *  will all be set.
454  * Errors:
455  *  Return values are 0 or an errno value.
456  *
457  *  For _init, _init_strcfg, _submit and _synchronous, system errors
458  *  (eg, failure to create sockets, malloc failure, etc.) return errno
459  *  values.  EINVAL from _init et al means the configuration file
460  *  is erroneous and cannot be parsed.
461  * 
462  *  For _wait and _check failures are reported in the answer
463  *  structure, and only 0, ESRCH or (for _check) EAGAIN is
464  *  returned: if no (appropriate) requests are done adns_check returns
465  *  EAGAIN; if no (appropriate) requests are outstanding both
466  *  adns_query and adns_wait return ESRCH.
467  *
468  *  Additionally, _wait can return EINTR if you set adns_if_eintr.
469  *
470  *  All other errors (nameserver failure, timed out connections, &c)
471  *  are returned in the status field of the answer.  After a
472  *  successful _wait or _check, if status is nonzero then nrrs will be
473  *  0, otherwise it will be >0.  type will always be the type
474  *  requested.
475  */
476
477 /* Threads:
478  *  adns does not use any static modifiable state, so it
479  *   is safe to call adns_init several times and then use the
480  *   resulting adns_states concurrently.
481  *  However, it is NOT safe to make simultaneous calls into
482  *   adns using the same adns_state; a single adns_state must be used
483  *   only by one thread at a time.  You can solve this problem by
484  *   having one adns_state per thread, or if that isn't feasible, you
485  *   could maintain a pool of adns_states.  Unfortunately neither of
486  *   these approaches has optimal performance.
487  */
488
489 /*
490  * Use of time:
491  *
492  * adns needs to manipulate timeouts.  For API compatibility reasons
493  * (adns predates clock_gettime) the default is to use wall clock time
494  * from gettimeofday.  This will malfunction if the system clock is
495  * not suitably stable.  To avoid this, you should set
496  *   adns_if_monotonic
497  *
498  * If you specify adns_if_monotonic then all `now' values passed to
499  * adns must be from clock_gettime(CLOCK_MONOTONIC).  clock_gettime
500  * returns a struct timespec; you must convert it to a struct timeval
501  * by dividing the nsec by 1000 to make usec, rounding down.
502  */
503
504 int adns_init(adns_state *newstate_r, adns_initflags flags,
505               FILE *diagfile /*0=>stderr*/);
506
507 int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags,
508                      FILE *diagfile /*0=>discard*/, const char *configtext);
509
510 typedef void adns_logcallbackfn(adns_state ads, void *logfndata,
511                                 const char *fmt, va_list al);
512   /* Will be called perhaps several times for each message; when the
513    * message is complete, the string implied by fmt and al will end in
514    * a newline.  Log messages start with `adns debug:' or `adns
515    * warning:' or `adns:' (for errors), or `adns debug [PID]:'
516    * etc. if adns_if_logpid is set. */
517
518 int adns_init_logfn(adns_state *newstate_r, adns_initflags flags,
519                     const char *configtext /*0=>use default config files*/,
520                     adns_logcallbackfn *logfn /*0=>logfndata is a FILE* */,
521                     void *logfndata /*0 with logfn==0 => discard*/);
522
523 /* Configuration:
524  *  adns_init reads /etc/resolv.conf, which is expected to be (broadly
525  *  speaking) in the format expected by libresolv, and then
526  *  /etc/resolv-adns.conf if it exists.  adns_init_strcfg is instead
527  *  passed a string which is interpreted as if it were the contents of
528  *  resolv.conf or resolv-adns.conf.  In general, configuration which
529  *  is set later overrides any that is set earlier.
530  *
531  * Standard directives understood in resolv[-adns].conf:
532  * 
533  *  nameserver <address>
534  *   Must be followed by the IP address of a nameserver.  Several
535  *   nameservers may be specified, and they will be tried in the order
536  *   found.  There is a compiled in limit, currently 5, on the number
537  *   of nameservers.  (libresolv supports only 3 nameservers.)
538  *
539  *  search <domain> ...
540  *   Specifies the search list for queries which specify
541  *   adns_qf_search.  This is a list of domains to append to the query
542  *   domain.  The query domain will be tried as-is either before all
543  *   of these or after them, depending on the ndots option setting
544  *   (see below).
545  *
546  *  domain <domain>
547  *   This is present only for backward compatibility with obsolete
548  *   versions of libresolv.  It should not be used, and is interpreted
549  *   by adns as if it were `search' - note that this is subtly
550  *   different to libresolv's interpretation of this directive.
551  *
552  *  sortlist <addr>/<mask> ...
553  *   Should be followed by a sequence of IP-address and netmask pairs,
554  *   separated by spaces.  They may be specified as
555  *   eg. 172.30.206.0/24 or 172.30.206.0/255.255.255.0.  Currently up
556  *   to 15 pairs may be specified (but note that libresolv only
557  *   supports up to 10).
558  *
559  *  options
560  *   Should followed by one or more options, separated by spaces.
561  *   Each option consists of an option name, followed by optionally
562  *   a colon and a value.  Options are listed below.
563  *
564  * Non-standard directives understood in resolv[-adns].conf:
565  *
566  *  clearnameservers
567  *   Clears the list of nameservers, so that further nameserver lines
568  *   start again from the beginning.
569  *
570  *  include <filename>
571  *   The specified file will be read.
572  *
573  * Additionally, adns will ignore lines in resolv[-adns].conf which
574  * start with a #.
575  *
576  * Standard options understood:
577  *
578  *  debug
579  *   Enables debugging output from the resolver, which will be written
580  *   to stderr.
581  *
582  *  ndots:<count>
583  *   Affects whether queries with adns_qf_search will be tried first
584  *   without adding domains from the searchlist, or whether the bare
585  *   query domain will be tried last.  Queries which contain at least
586  *   <count> dots will be tried bare first.  The default is 1.
587  *
588  * Non-standard options understood:
589  *
590  *  adns_checkc:none
591  *  adns_checkc:entex
592  *  adns_checkc:freq
593  *   Changes the consistency checking frequency; this overrides the
594  *   setting of adns_if_check_entex, adns_if_check_freq, or neither,
595  *   in the flags passed to adns_init.
596  *
597  *  adns_af:{ipv4,ipv6},...  adns_af:any
598  *   Determines which address families ADNS looks up (either as an
599  *   adns_r_addr query, or when dereferencing an answer yielding hostnames
600  *   (e.g., adns_r_mx).  The argument is a comma-separated list: only the
601  *   address families listed will be looked up.  The default is `any'.
602  *   Lookups occur (logically) concurrently; use the `sortlist' directive to
603  *   control the relative order of addresses in answers.  This option
604  *   overrides the corresponding init flags (covered by adns_if_afmask).
605  *
606  *  adns_ignoreunkcfg
607  *   Ignore unknown options and configuration directives, rather than
608  *   logging them.  To be effective, appear in the configuration
609  *   before the unknown options.  ADNS_RES_OPTIONS is generally early
610  *   enough.
611  * 
612  * There are a number of environment variables which can modify the
613  * behaviour of adns.  They take effect only if adns_init is used, and
614  * the caller of adns_init can disable them using adns_if_noenv.  In
615  * each case there is both a FOO and an ADNS_FOO; the latter is
616  * interpreted later so that it can override the former.  Unless
617  * otherwise stated, environment variables are interpreted after
618  * resolv[-adns].conf are read, in the order they are listed here.
619  *
620  *  RES_CONF, ADNS_RES_CONF
621  *   A filename, whose contets are in the format of resolv.conf.
622  *
623  *  RES_CONF_TEXT, ADNS_RES_CONF_TEXT
624  *   A string in the format of resolv.conf.
625  *
626  *  RES_OPTIONS, ADNS_RES_OPTIONS
627  *   These are parsed as if they appeared in the `options' line of a
628  *   resolv.conf.  In addition to being parsed at this point in the
629  *   sequence, they are also parsed at the very beginning before
630  *   resolv.conf or any other environment variables are read, so that
631  *   any debug option can affect the processing of the configuration.
632  *
633  *  LOCALDOMAIN, ADNS_LOCALDOMAIN
634  *   These are interpreted as if their contents appeared in a `search'
635  *   line in resolv.conf.
636  */
637
638 int adns_synchronous(adns_state ads,
639                      const char *owner,
640                      adns_rrtype type,
641                      adns_queryflags flags,
642                      adns_answer **answer_r);
643
644 /* NB: if you set adns_if_noautosys then _submit and _check do not
645  * make any system calls; you must use some of the asynch-io event
646  * processing functions to actually get things to happen.
647  */
648
649 int adns_submit(adns_state ads,
650                 const char *owner,
651                 adns_rrtype type,
652                 adns_queryflags flags,
653                 void *context,
654                 adns_query *query_r);
655
656 /* The owner should be quoted in master file format. */
657
658 int adns_check(adns_state ads,
659                adns_query *query_io,
660                adns_answer **answer_r,
661                void **context_r);
662
663 int adns_wait(adns_state ads,
664               adns_query *query_io,
665               adns_answer **answer_r,
666               void **context_r);
667
668 /* same as adns_wait but uses poll(2) internally */
669 int adns_wait_poll(adns_state ads,
670                    adns_query *query_io,
671                    adns_answer **answer_r,
672                    void **context_r);
673
674 void adns_cancel(adns_query query);
675
676 /* The adns_query you get back from _submit is valid (ie, can be
677  * legitimately passed into adns functions) until it is returned by
678  * adns_check or adns_wait, or passed to adns_cancel.  After that it
679  * must not be used.  You can rely on it not being reused until the
680  * first adns_submit or _transact call using the same adns_state after
681  * it became invalid, so you may compare it for equality with other
682  * query handles until you next call _query or _transact.
683  *
684  * _submit and _synchronous return ENOSYS if they don't understand the
685  * query type.
686  */
687
688 int adns_submit_reverse(adns_state ads,
689                         const struct sockaddr *addr,
690                         adns_rrtype type,
691                         adns_queryflags flags,
692                         void *context,
693                         adns_query *query_r);
694 /* type must be _r_ptr or _r_ptr_raw.  _qf_search is ignored.
695  * addr->sa_family must be AF_INET or you get ENOSYS.
696  */
697
698 int adns_submit_reverse_any(adns_state ads,
699                             const struct sockaddr *addr,
700                             const char *rzone,
701                             adns_rrtype type,
702                             adns_queryflags flags,
703                             void *context,
704                             adns_query *query_r);
705 /* For RBL-style reverse `zone's; look up
706  *   <reversed-address>.<zone>
707  * Any type is allowed.  _qf_search is ignored.
708  * addr->sa_family must be AF_INET or you get ENOSYS.
709  */
710
711 void adns_finish(adns_state ads);
712 /* You may call this even if you have queries outstanding;
713  * they will be cancelled.
714  */
715
716 #define ADNS_ADDR2TEXT_BUFLEN                                   \
717   (INET6_ADDRSTRLEN + 1/*%*/                                    \
718   + ((IF_NAMESIZE-1) > 9 ? (IF_NAMESIZE-1) : 9/*uint32*/)       \
719   + 1/* nul; included in IF_NAMESIZE */)
720
721 int adns_text2addr(const char *text, uint16_t port, adns_queryflags flags,
722                    struct sockaddr *sa_r,
723                    socklen_t *salen_io /* updated iff OK or ENOSPC */);
724 int adns_addr2text(const struct sockaddr *sa, adns_queryflags flags,
725                    char *buffer, int *buflen_io /* updated ONLY on ENOSPC */,
726                    int *port_r /* may be 0 */);
727   /*
728    * port is always in host byte order and is simply copied to and
729    * from the appropriate sockaddr field (byteswapped as necessary).
730    *
731    * The only flags supported are adns_qf_addrlit_...
732    *
733    * Error return values are:
734    *
735    *  ENOSPC    Output buffer is too small.  Can only happen if
736    *            *buflen_io < ADNS_ADDR2TEXT_BUFLEN or
737    *            *salen_io < sizeof(adns_sockaddr).  On return,
738    *            *buflen_io or *salen_io has been updated by adns.
739    *
740    *  EINVAL    text has invalid syntax.
741    *
742    *            text represents an address family not supported by
743    *            this version of adns.
744    *
745    *            Scoped address supplied (text contained "%" or
746    *            sin6_scope_id nonzero) but caller specified
747    *            adns_qf_addrlit_scope_forbid.
748    *
749    *            Scope name (rather than number) supplied in text but
750    *            caller specified adns_qf_addrlit_scope_numeric.
751    *
752    *  EAFNOSUPPORT   sa->sa_family is not supported (addr2text only).
753    *
754    *  ENOSYS    Unsupported flags set.
755    *
756    * Only if neither adns_qf_addrlit_scope_forbid nor
757    * adns_qf_addrlit_scope_numeric are set:
758    *
759    *  ENOSYS    Scope name supplied in text but IPv6 address part of
760    *            sockaddr is not a link local address.
761    *
762    *  ENXIO     Scope name supplied in text but if_nametoindex
763    *            said it wasn't a valid local interface name.
764    *
765    *  EIO       Scoped address supplied but if_nametoindex failed
766    *            in an unexpected way; adns has printed a message to
767    *            stderr.
768    *
769    *  any other   if_nametoindex failed in a more-or-less expected way.
770    */
771
772 void adns_forallqueries_begin(adns_state ads);
773 adns_query adns_forallqueries_next(adns_state ads, void **context_r);
774 /* Iterator functions, which you can use to loop over the outstanding
775  * (submitted but not yet successfuly checked/waited) queries.
776  *
777  * You can only have one iteration going at once.  You may call _begin
778  * at any time; after that, an iteration will be in progress.  You may
779  * only call _next when an iteration is in progress - anything else
780  * may coredump.  The iteration remains in progress until _next
781  * returns 0, indicating that all the queries have been walked over,
782  * or ANY other adns function is called with the same adns_state (or a
783  * query in the same adns_state).  There is no need to explicitly
784  * finish an iteration.
785  *
786  * context_r may be 0.  *context_r may not be set when _next returns 0.
787  */
788
789 void adns_checkconsistency(adns_state ads, adns_query qu);
790 /* Checks the consistency of adns's internal data structures.
791  * If any error is found, the program will abort().
792  * You may pass 0 for qu; if you pass non-null then additional checks
793  * are done to make sure that qu is a valid query.
794  */
795
796 /*
797  * Example expected/legal calling sequence for submit/check/wait:
798  *  adns_init
799  *  adns_submit 1
800  *  adns_submit 2
801  *  adns_submit 3
802  *  adns_wait 1
803  *  adns_check 3 -> EAGAIN
804  *  adns_wait 2
805  *  adns_wait 3
806  *  ....
807  *  adns_finish
808  */
809
810 /*
811  * Entrypoints for generic asynch io:
812  * (these entrypoints are not very useful except in combination with *
813  * some of the other I/O model calls which can tell you which fds to
814  * be interested in):
815  *
816  * Note that any adns call may cause adns to open and close fds, so
817  * you must call beforeselect or beforepoll again just before
818  * blocking, or you may not have an up-to-date list of it's fds.
819  */
820
821 int adns_processany(adns_state ads);
822 /* Gives adns flow-of-control for a bit.  This will never block, and
823  * can be used with any threading/asynch-io model.  If some error
824  * occurred which might cause an event loop to spin then the errno
825  * value is returned.
826  */
827
828 int adns_processreadable(adns_state ads, int fd, const struct timeval *now);
829 int adns_processwriteable(adns_state ads, int fd, const struct timeval *now);
830 int adns_processexceptional(adns_state ads, int fd, const struct timeval *now);
831 /* Gives adns flow-of-control so that it can process incoming data
832  * from, or send outgoing data via, fd.  Very like _processany.  If it
833  * returns zero then fd will no longer be readable or writeable
834  * (unless of course more data has arrived since).  adns will _only_
835  * use that fd and only in the manner specified, regardless of whether
836  * adns_if_noautosys was specified.
837  *
838  * now is as for adns_processtimeouts.
839  *
840  * adns_processexceptional should be called when select(2) reports an
841  * exceptional condition, or poll(2) reports POLLPRI.
842  *
843  * It is fine to call _processreabable or _processwriteable when the
844  * fd is not ready, or with an fd that doesn't belong to adns; it will
845  * then just return 0.
846  *
847  * If some error occurred which might prevent an event loop to spin
848  * then the errno value is returned.
849  */
850
851 void adns_processtimeouts(adns_state ads, const struct timeval *now);
852 /* Gives adns flow-of-control so that it can process any timeouts
853  * which might have happened.  Very like _processreadable/writeable.
854  *
855  * now may be 0; if it isn't, *now must be the current time from
856  * gettimeofday, or iff adns_if_monotonic it must be converted
857  * from the results of clock_gettime(CLOCK_MONOTONIC) (with the
858  * timespec.tv_nsec rounded down to make timeval.tv_usec).
859  */
860
861 void adns_firsttimeout(adns_state ads,
862                        struct timeval **tv_mod, struct timeval *tv_buf,
863                        struct timeval now);
864 /* Asks adns when it would first like the opportunity to time
865  * something out.
866  *
867  * now must be the current time, as for adns_processtimeouts.
868  * 
869  * If tv_mod points to 0 then tv_buf must be non-null, and
870  * _firsttimeout will fill in *tv_buf with the time until the first
871  * timeout, and make *tv_mod point to tv_buf.  If adns doesn't have
872  * anything that might need timing out it will leave *tv_mod as 0.
873  *
874  * If *tv_mod is not 0 then tv_buf is not used.  adns will update
875  * *tv_mod if it has any earlier timeout, and leave it alone if it
876  * doesn't.
877  *
878  * This call will not actually do any I/O, or change the fds that adns
879  * is using.  It always succeeds and never blocks.
880  */
881
882 void adns_globalsystemfailure(adns_state ads);
883 /* If serious problem(s) happen which globally affect your ability to
884  * interact properly with adns, or adns's ability to function
885  * properly, you or adns can call this function.
886  *
887  * All currently outstanding queries will be made to fail with
888  * adns_s_systemfail, and adns will close any stream sockets it has
889  * open.
890  *
891  * This is used by adns, for example, if gettimeofday() or
892  * clock_gettime fails.  Without this the program's event loop might
893  * start to spin !
894  *
895  * This call will never block.
896  */
897
898 /*
899  * Entrypoints for select-loop based asynch io:
900  */
901
902 void adns_beforeselect(adns_state ads, int *maxfd, fd_set *readfds,
903                        fd_set *writefds, fd_set *exceptfds,
904                        struct timeval **tv_mod, struct timeval *tv_buf,
905                        const struct timeval *now);
906 /* Find out file descriptors adns is interested in, and when it would
907  * like the opportunity to time something out.  If you do not plan to
908  * block then tv_mod may be 0.  Otherwise, tv_mod and tv_buf are as
909  * for adns_processtimeouts.  readfds, writefds, exceptfds and maxfd_io may
910  * not be 0.
911  *
912  * now is as for adns_processtimeouts.
913  *
914  * If tv_mod is 0 on entry then this will never actually do any I/O,
915  * or change the fds that adns is using or the timeouts it wants.  In
916  * any case it won't block, and it will set the timeout to zero if a
917  * query finishes in _beforeselect.
918  */
919
920 void adns_afterselect(adns_state ads, int maxfd, const fd_set *readfds,
921                       const fd_set *writefds, const fd_set *exceptfds,
922                       const struct timeval *now);
923 /* Gives adns flow-of-control for a bit; intended for use after
924  * select.  This is just a fancy way of calling adns_processreadable/
925  * writeable/timeouts as appropriate, as if select had returned the
926  * data being passed.  Always succeeds.
927  *
928  * now is as for adns_processtimeouts.
929  */
930
931 /*
932  * Example calling sequence:
933  *
934  *  adns_init _noautosys
935  *  loop {
936  *   adns_beforeselect
937  *   select
938  *   adns_afterselect
939  *   ...
940  *   adns_submit / adns_check
941  *   ...
942  *  }
943  */
944
945 /*
946  * Entrypoints for poll-loop based asynch io:
947  */
948
949 struct pollfd;
950 /* In case your system doesn't have it or you forgot to include
951  * <sys/poll.h>, to stop the following declarations from causing
952  * problems.  If your system doesn't have poll then the following
953  * entrypoints will not be defined in libadns.  Sorry !
954  */
955
956 int adns_beforepoll(adns_state ads, struct pollfd *fds,
957                     int *nfds_io, int *timeout_io,
958                     const struct timeval *now);
959 /* Finds out which fd's adns is interested in, and when it would like
960  * to be able to time things out.  This is in a form suitable for use
961  * with poll(2).
962  * 
963  * On entry, usually fds should point to at least *nfds_io structs.
964  * adns will fill up to that many structs will information for poll,
965  * and record in *nfds_io how many structs it filled.  If it wants to
966  * listen for more structs then *nfds_io will be set to the number
967  * required and _beforepoll will return ERANGE.
968  *
969  * You may call _beforepoll with fds==0 and *nfds_io 0, in which case
970  * adns will fill in the number of fds that it might be interested in
971  * in *nfds_io, and always return either 0 (if it is not interested in
972  * any fds) or ERANGE (if it is).
973  *
974  * NOTE that (unless now is 0) adns may acquire additional fds
975  * from one call to the next, so you must put adns_beforepoll in a
976  * loop, rather than assuming that the second call (with the buffer
977  * size requested by the first) will not return ERANGE.
978  *
979  * adns only ever sets POLLIN, POLLOUT and POLLPRI in its pollfd
980  * structs, and only ever looks at those bits.  POLLPRI is required to
981  * detect TCP Urgent Data (which should not be used by a DNS server)
982  * so that adns can know that the TCP stream is now useless.
983  *
984  * In any case, *timeout_io should be a timeout value as for poll(2),
985  * which adns will modify downwards as required.  If the caller does
986  * not plan to block then *timeout_io should be 0 on entry, or
987  * alternatively, timeout_io may be 0.  (Alternatively, the caller may
988  * use _beforeselect with timeout_io==0 to find out about file
989  * descriptors, and use _firsttimeout is used to find out when adns
990  * might want to time something out.)
991  *
992  * now is as for adns_processtimeouts.
993  *
994  * adns_beforepoll will return 0 on success, and will not fail for any
995  * reason other than the fds buffer being too small (ERANGE).
996  *
997  * This call will never actually do any I/O.  If you supply the
998  * current time it will not change the fds that adns is using or the
999  * timeouts it wants.
1000  *
1001  * In any case this call won't block.
1002  */
1003
1004 #define ADNS_POLLFDS_RECOMMENDED 3
1005 /* If you allocate an fds buf with at least RECOMMENDED entries then
1006  * you are unlikely to need to enlarge it.  You are recommended to do
1007  * so if it's convenient.  However, you must be prepared for adns to
1008  * require more space than this.
1009  */
1010
1011 void adns_afterpoll(adns_state ads, const struct pollfd *fds, int nfds,
1012                     const struct timeval *now);
1013 /* Gives adns flow-of-control for a bit; intended for use after
1014  * poll(2).  fds and nfds should be the results from poll().  pollfd
1015  * structs mentioning fds not belonging to adns will be ignored.
1016  *
1017  * now is as for adns_processtimeouts.
1018  */
1019
1020
1021 adns_status adns_rr_info(adns_rrtype type,
1022                          const char **rrtname_r, const char **fmtname_r,
1023                          int *len_r,
1024                          const void *datap, char **data_r);
1025 /*
1026  * Get information about a query type, or convert reply data to a
1027  * textual form.  type must be specified, and the official name of the
1028  * corresponding RR type will be returned in *rrtname_r, and
1029  * information about the processing style in *fmtname_r.  The length
1030  * of the table entry in an answer for that type will be returned in
1031  * in *len_r.  Any or all of rrtname_r, fmtname_r and len_r may be 0.
1032  * If fmtname_r is non-null then *fmtname_r may be null on return,
1033  * indicating that no special processing is involved.
1034  *
1035  * data_r be must be non-null iff datap is.  In this case *data_r will
1036  * be set to point to a string pointing to a representation of the RR
1037  * data in master file format.  (The owner name, timeout, class and
1038  * type will not be present - only the data part of the RR.)  The
1039  * memory will have been obtained from malloc() and must be freed by
1040  * the caller.
1041  *
1042  * Usually this routine will succeed.  Possible errors include:
1043  *  adns_s_nomemory
1044  *  adns_s_rrtypeunknown
1045  *  adns_s_invaliddata (*datap contained garbage)
1046  * If an error occurs then no memory has been allocated,
1047  * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined.
1048  *
1049  * There are some adns-invented data formats which are not official
1050  * master file formats.  These include:
1051  *
1052  * Mailboxes if __qtf_mail822: these are just included as-is.
1053  *
1054  * Addresses (adns_rr_addr): these may be of pretty much any type.
1055  * The representation is in two parts: first, a word for the address
1056  * family (ie, in AF_XXX, the XXX), and then one or more items for the
1057  * address itself, depending on the format.  For an IPv4 address the
1058  * syntax is INET followed by the dotted quad (from inet_ntoa).
1059  * Currently only IPv4 is supported.
1060  *
1061  * Text strings (as in adns_rr_txt) appear inside double quotes, and
1062  * use \" and \\ to represent " and \, and \xHH to represent
1063  * characters not in the range 32-126.
1064  *
1065  * Hostname with addresses (adns_rr_hostaddr): this consists of the
1066  * hostname, as usual, followed by the adns_status value, as an
1067  * abbreviation, and then a descriptive string (encoded as if it were
1068  * a piece of text), for the address lookup, followed by zero or more
1069  * addresses enclosed in ( and ).  If the result was a temporary
1070  * failure, then a single ?  appears instead of the ( ).  If the
1071  * result was a permanent failure then an empty pair of parentheses
1072  * appears (which a space in between).  For example, one of the NS
1073  * records for greenend.org.uk comes out like
1074  *  ns.chiark.greenend.org.uk ok "OK" ( INET 195.224.76.132 )
1075  * an MX referring to a nonexistent host might come out like:
1076  *  50 sun2.nsfnet-relay.ac.uk nxdomain "No such domain" ( )
1077  * and if nameserver information is not available you might get:
1078  *  dns2.spong.dyn.ml.org timeout "DNS query timed out" ?
1079  */
1080
1081 const char *adns_strerror(adns_status st);
1082 const char *adns_errabbrev(adns_status st);
1083 const char *adns_errtypeabbrev(adns_status st);
1084 /* Like strerror but for adns_status values.  adns_errabbrev returns
1085  * the abbreviation of the error - eg, for adns_s_timeout it returns
1086  * "timeout".  adns_errtypeabbrev returns the abbreviation of the
1087  * error class: ie, for values up to adns_s_max_XXX it will return the
1088  * string XXX.
1089  *
1090  * If you call these functions with status values not actually
1091  * returned from other functions in the same adns library, the
1092  * returned information may be NULL.  (You are also guaranteed
1093  * that the return value will not be NULL for values in the
1094  * adns_status enum, *except* for adns_s_max_XXXX.)
1095  */
1096
1097 #ifdef __cplusplus
1098 } /* end of extern "C" */
1099 #endif
1100 #endif