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