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