5628df75 |
1 | /* |
18d49d56 |
2 | * adns.h |
3 | * - adns user-visible API (single-threaded, without any locking) |
4 | */ |
5 | /* |
d942707d |
6 | * |
7 | * This file is |
8 | * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk> |
9 | * |
10 | * It is part of adns, which is |
11 | * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk> |
12 | * Copyright (C) 1999 Tony Finch <dot@dotat.at> |
e576be50 |
13 | * |
14 | * This program is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU General Public License as published by |
16 | * the Free Software Foundation; either version 2, or (at your option) |
17 | * any later version. |
18 | * |
19 | * This program is distributed in the hope that it will be useful, |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
22 | * GNU General Public License for more details. |
d942707d |
23 | * |
24 | * |
25 | * For the benefit of certain LGPL'd `omnibus' software which provides |
26 | * a uniform interface to various things including adns, I make the |
27 | * following additional licence. I do this because the GPL would |
28 | * otherwise force either the omnibus software to be GPL'd or for the |
29 | * adns-using part to be distributed separately. |
30 | * |
31 | * So, you may also redistribute and/or modify adns.h (but only the |
32 | * public header file adns.h and not any other part of adns) under the |
33 | * terms of the GNU Library General Public License as published by the |
34 | * Free Software Foundation; either version 2 of the License, or (at |
35 | * your option) any later version. |
e576be50 |
36 | * |
d942707d |
37 | * Note that adns itself is GPL'd. Authors of adns-using applications |
38 | * with GPL-incompatible licences, and people who distribute adns with |
39 | * applications where the whole distribution is not GPL'd, are still |
40 | * likely to be in violation of the GPL. Anyone who wants to do this |
41 | * should contact Ian Jackson. Please note that to avoid encouraging |
42 | * people to infringe the GPL as it applies the body of adns, I think |
43 | * that if you take advantage of the special exception to redistribute |
44 | * just adns.h under the LGPL, you should retain this paragraph in its |
45 | * place in the appropriate copyright statements. |
46 | * |
47 | * |
48 | * You should have received a copy of the GNU General Public License, |
49 | * or the GNU Library General Public License, as appropriate, along |
50 | * with this program; if not, write to the Free Software Foundation, |
a719a4be |
51 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
52 | * |
d942707d |
53 | * |
a719a4be |
54 | * $Id$ |
e576be50 |
55 | */ |
a17d3a1d |
56 | |
57 | #ifndef ADNS_H_INCLUDED |
58 | #define ADNS_H_INCLUDED |
02b47faa |
59 | #ifdef __cplusplus |
60 | extern "C" { /* I really dislike this - iwj. */ |
61 | #endif |
a17d3a1d |
62 | |
4353a5c4 |
63 | #include <stdio.h> |
64 | |
964344fc |
65 | #include <sys/socket.h> |
66 | #include <netinet/in.h> |
636b69b1 |
67 | #include <sys/types.h> |
68 | #include <sys/time.h> |
69 | #include <unistd.h> |
964344fc |
70 | |
09957b1c |
71 | /* All struct in_addr anywhere in adns are in NETWORK byte order. */ |
72 | |
964344fc |
73 | typedef struct adns__state *adns_state; |
74 | typedef struct adns__query *adns_query; |
a17d3a1d |
75 | |
76 | typedef enum { |
37e28fde |
77 | adns_if_noenv= 0x0001, /* do not look at environment */ |
78 | adns_if_noerrprint= 0x0002, /* never print output to stderr (_debug overrides) */ |
79 | adns_if_noserverwarn= 0x0004, /* do not warn to stderr about duff nameservers etc */ |
ddfda861 |
80 | adns_if_debug= 0x0008, /* enable all output to stderr plus debug msgs */ |
5f67bb7b |
81 | adns_if_logpid= 0x0080, /* include pid in diagnostic output */ |
37e28fde |
82 | adns_if_noautosys= 0x0010, /* do not make syscalls at every opportunity */ |
88372443 |
83 | adns_if_eintr= 0x0020, /* allow _wait and _synchronous to return EINTR */ |
ac868fa8 |
84 | adns_if_nosigpipe= 0x0040, /* applic has SIGPIPE set to SIG_IGN, do not protect */ |
3e2e5fab |
85 | adns_if_checkc_entex= 0x0100, /* do consistency checks on entry/exit to adns funcs */ |
0aa7cba0 |
86 | adns_if_checkc_freq= 0x0300 /* do consistency checks very frequently (slow!) */ |
a17d3a1d |
87 | } adns_initflags; |
88 | |
89 | typedef enum { |
b365d68a |
90 | adns_qf_search= 0x00000001, /* use the searchlist */ |
91 | adns_qf_usevc= 0x00000002, /* use a virtual circuit (TCP connection) */ |
92 | adns_qf_owner= 0x00000004, /* fill in the owner field in the answer */ |
93 | adns_qf_quoteok_query= 0x00000010, /* allow quote-requiring chars in query domain */ |
94 | adns_qf_quoteok_cname= 0x00000000, /* allow ... in CNAME we go via - now default */ |
95 | adns_qf_quoteok_anshost= 0x00000040, /* allow ... in things supposed to be hostnames */ |
96 | adns_qf_quotefail_cname= 0x00000080, /* refuse if quote-req chars in CNAME we go via */ |
97 | adns_qf_cname_loose= 0x00000100, /* allow refs to CNAMEs - without, get _s_cname */ |
98 | adns_qf_cname_forbid= 0x00000200, /* don't follow CNAMEs, instead give _s_cname */ |
99 | adns__qf_internalmask= 0x0ff00000 |
a17d3a1d |
100 | } adns_queryflags; |
101 | |
102 | typedef enum { |
350d37d9 |
103 | adns__rrt_typemask= 0x0ffff, |
ddfda861 |
104 | adns__qtf_deref= 0x10000, /* dereference domains and perhaps produce extra data */ |
105 | adns__qtf_mail822= 0x20000, /* make mailboxes be in RFC822 rcpt field format */ |
ddfda861 |
106 | |
350d37d9 |
107 | adns_r_none= 0, |
ddfda861 |
108 | |
350d37d9 |
109 | adns_r_a= 1, |
ddfda861 |
110 | |
350d37d9 |
111 | adns_r_ns_raw= 2, |
112 | adns_r_ns= adns_r_ns_raw|adns__qtf_deref, |
ddfda861 |
113 | |
350d37d9 |
114 | adns_r_cname= 5, |
ddfda861 |
115 | |
350d37d9 |
116 | adns_r_soa_raw= 6, |
ddfda861 |
117 | adns_r_soa= adns_r_soa_raw|adns__qtf_mail822, |
ddfda861 |
118 | |
350d37d9 |
119 | adns_r_ptr_raw= 12, |
120 | adns_r_ptr= adns_r_ptr_raw|adns__qtf_deref, |
ddfda861 |
121 | |
350d37d9 |
122 | adns_r_hinfo= 13, |
ddfda861 |
123 | |
350d37d9 |
124 | adns_r_mx_raw= 15, |
125 | adns_r_mx= adns_r_mx_raw|adns__qtf_deref, |
ddfda861 |
126 | |
350d37d9 |
127 | adns_r_txt= 16, |
ddfda861 |
128 | |
350d37d9 |
129 | adns_r_rp_raw= 17, |
4353a5c4 |
130 | adns_r_rp= adns_r_rp_raw|adns__qtf_mail822, |
828d89bd |
131 | |
132 | adns_r_addr= adns_r_a|adns__qtf_deref |
ddfda861 |
133 | |
a17d3a1d |
134 | } adns_rrtype; |
135 | |
b365d68a |
136 | /* |
137 | * In queries without qf_quoteok_*, all domains must have standard |
138 | * legal syntax, or you get adns_s_querydomainvalid (if the query |
139 | * domain contains bad characters) or adns_s_answerdomaininvalid (if |
140 | * the answer contains bad characters). |
141 | * |
142 | * In queries _with_ qf_quoteok_*, domains in the query or response |
143 | * may contain any characters, quoted according to RFC1035 5.1. On |
144 | * input to adns, the char* is a pointer to the interior of a " |
145 | * delimited string, except that " may appear in it, and on output, |
9da4a044 |
146 | * the char* is a pointer to a string which would be legal either |
147 | * inside or outside " delimiters, and any characters not usually |
148 | * legal in domain names will be quoted as \X (if the character is |
149 | * 33-126 except \ and ") or \DDD. |
964344fc |
150 | * |
b365d68a |
151 | * If the query goes via a CNAME then the canonical name (ie, the |
152 | * thing that the CNAME record refers to) is usually allowed to |
153 | * contain any characters, which will be quoted as above. With |
154 | * adns_qf_quotefail_cname you get adns_s_answerdomaininvalid when |
155 | * this happens. (This is a change from version 0.4 and earlier, in |
156 | * which failing the query was the default, and you had to say |
157 | * adns_qf_quoteok_cname to avoid this; that flag is now deprecated.) |
158 | * |
159 | * In version 0.4 and earlier, asking for _raw records containing |
160 | * mailboxes without specifying _qf_quoteok_anshost was silly. This |
161 | * is no longer the case. In this version only parts of responses |
162 | * that are actually supposed to be hostnames will be refused by |
163 | * default if quote-requiring characters are found. |
164 | */ |
165 | |
166 | /* |
167 | * If you ask for an RR which contains domains which are actually |
168 | * encoded mailboxes, and don't ask for the _raw version, then adns |
169 | * returns the mailbox formatted suitably for an RFC822 recipient |
170 | * header field. The particular format used is that if the mailbox |
171 | * requires quoting according to the rules in RFC822 then the |
172 | * local-part is quoted in double quotes, which end at the next |
173 | * unescaped double quote. (\ is the escape char, and is doubled, and |
174 | * is used to escape only \ and ".) Otherwise the local-part is |
175 | * presented as-is. In any case this is followed by an @ and the |
176 | * domain. The domain will not contain any characters not legal in |
177 | * hostnames. adns will protect the application from local parts |
178 | * containing control characters - these appear to be legal according |
179 | * to RFC822 but are clearly a bad idea. |
180 | * |
181 | * If you ask for the domain with _raw then _no_ checking is done |
182 | * (even on the host part, regardless of adns_qf_quoteok_anshost), and |
183 | * you just get the domain name in master file format. |
184 | * |
185 | * If no mailbox is supplied the returned string will be `.' in either |
186 | * caswe. |
964344fc |
187 | */ |
188 | |
a17d3a1d |
189 | typedef enum { |
190 | adns_s_ok, |
ea1e31e3 |
191 | |
192 | /* locally induced errors */ |
193 | adns_s_nomemory, |
194 | adns_s_unknownrrtype, |
620c146d |
195 | adns_s_systemfail, |
196 | |
197 | adns_s_max_localfail= 29, |
ea1e31e3 |
198 | |
199 | /* remotely induced errors, detected locally */ |
37e28fde |
200 | adns_s_timeout, |
4bec51a4 |
201 | adns_s_allservfail, |
ec477b9e |
202 | adns_s_norecurse, |
ea1e31e3 |
203 | adns_s_invalidresponse, |
204 | adns_s_unknownformat, |
620c146d |
205 | |
206 | adns_s_max_remotefail= 59, |
ea1e31e3 |
207 | |
208 | /* remotely induced errors, reported by remote server to us */ |
209 | adns_s_rcodeservfail, |
210 | adns_s_rcodeformaterror, |
211 | adns_s_rcodenotimplemented, |
212 | adns_s_rcoderefused, |
213 | adns_s_rcodeunknown, |
620c146d |
214 | |
b9de380c |
215 | adns_s_max_tempfail= 99, |
ea1e31e3 |
216 | |
217 | /* remote configuration errors */ |
218 | adns_s_inconsistent, /* PTR gives domain whose A does not exist and match */ |
219 | adns_s_prohibitedcname, /* CNAME found where eg A expected (not if _qf_loosecname) */ |
220 | adns_s_answerdomaininvalid, |
221 | adns_s_answerdomaintoolong, |
222 | adns_s_invaliddata, |
223 | |
224 | adns_s_max_misconfig= 199, |
225 | |
ea1e31e3 |
226 | /* permanent problems with the query */ |
227 | adns_s_querydomainwrong, |
228 | adns_s_querydomaininvalid, |
229 | adns_s_querydomaintoolong, |
230 | |
231 | adns_s_max_misquery= 299, |
232 | |
233 | /* permanent errors */ |
a17d3a1d |
234 | adns_s_nxdomain, |
226c5eef |
235 | adns_s_nodata, |
236 | |
237 | adns_s_max_permfail= 499 |
ea1e31e3 |
238 | |
a17d3a1d |
239 | } adns_status; |
240 | |
e8c505a5 |
241 | typedef struct { |
828d89bd |
242 | int len; |
243 | union { |
244 | struct sockaddr sa; |
245 | struct sockaddr_in inet; |
246 | } addr; |
551ff40f |
247 | } adns_rr_addr; |
828d89bd |
248 | |
249 | typedef struct { |
1dfe95d8 |
250 | char *host; |
84fe28db |
251 | adns_status astatus; |
252 | int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */ |
551ff40f |
253 | adns_rr_addr *addrs; |
c7836bc9 |
254 | } adns_rr_hostaddr; |
4353a5c4 |
255 | |
256 | typedef struct { |
9ec44266 |
257 | char *(array[2]); |
4353a5c4 |
258 | } adns_rr_strpair; |
259 | |
260 | typedef struct { |
261 | int i; |
1dfe95d8 |
262 | adns_rr_hostaddr ha; |
c7836bc9 |
263 | } adns_rr_inthostaddr; |
4353a5c4 |
264 | |
265 | typedef struct { |
e062dcae |
266 | /* Used both for mx_raw, in which case i is the preference and str the domain, |
267 | * and for txt, in which case each entry has i for the `text' length, |
268 | * and str for the data (which will have had an extra nul appended |
269 | * so that if it was plain text it is now a null-terminated string). |
270 | */ |
4353a5c4 |
271 | int i; |
272 | char *str; |
273 | } adns_rr_intstr; |
274 | |
275 | typedef struct { |
9ec44266 |
276 | adns_rr_intstr array[2]; |
277 | } adns_rr_intstrpair; |
278 | |
279 | typedef struct { |
280 | char *mname, *rname; |
4353a5c4 |
281 | unsigned long serial, refresh, retry, expire, minimum; |
282 | } adns_rr_soa; |
84fe28db |
283 | |
284 | typedef struct { |
a17d3a1d |
285 | adns_status status; |
286 | char *cname; /* always NULL if query was for CNAME records */ |
4b2c4f8a |
287 | char *owner; /* only set if requested in query flags, and may be 0 on error anyway */ |
86e7b8d9 |
288 | adns_rrtype type; /* guaranteed to be same as in query */ |
73dba56e |
289 | time_t expires; /* expiry time, defined only if _s_ok, nxdomain or nodata. NOT TTL! */ |
b365d68a |
290 | int nrrs, rrsz; /* nrrs is 0 if an error occurs */ |
a17d3a1d |
291 | union { |
8e5b0abb |
292 | void *untyped; |
293 | unsigned char *bytes; |
c7836bc9 |
294 | char *(*str); /* ns_raw, cname, ptr, ptr_raw */ |
295 | adns_rr_intstr *(*manyistr); /* txt (list of strings ends with i=-1, str=0) */ |
551ff40f |
296 | adns_rr_addr *addr; /* addr */ |
c7836bc9 |
297 | struct in_addr *inaddr; /* a */ |
298 | adns_rr_hostaddr *hostaddr; /* ns */ |
9ec44266 |
299 | adns_rr_intstrpair *intstrpair; /* hinfo */ |
300 | adns_rr_strpair *strpair; /* rp, rp_raw */ |
c7836bc9 |
301 | adns_rr_inthostaddr *inthostaddr; /* mx */ |
302 | adns_rr_intstr *intstr; /* mx_raw */ |
303 | adns_rr_soa *soa; /* soa, soa_raw */ |
a17d3a1d |
304 | } rrs; |
e8c505a5 |
305 | } adns_answer; |
a17d3a1d |
306 | |
307 | /* Memory management: |
308 | * adns_state and adns_query are actually pointers to malloc'd state; |
309 | * On submission questions are copied, including the owner domain; |
4353a5c4 |
310 | * Answers are malloc'd as a single piece of memory; pointers in the |
311 | * answer struct point into further memory in the answer. |
a17d3a1d |
312 | * query_io: |
313 | * Must always be non-null pointer; |
314 | * If *query_io is 0 to start with then any query may be returned; |
315 | * If *query_io is !0 adns_query then only that query may be returned. |
d3eea642 |
316 | * If the call is successful, *query_io, *answer_r, and *context_r |
317 | * will all be set. |
a17d3a1d |
318 | * Errors: |
620c146d |
319 | * Return values are 0 or an errno value. |
320 | * |
321 | * For _init, _init_strcfg, _submit and _synchronous, system errors |
322 | * (eg, failure to create sockets, malloc failure, etc.) return errno |
323 | * values. |
324 | * |
325 | * For _wait and _check failures are reported in the answer |
226c5eef |
326 | * structure, and only 0, ESRCH or (for _check) EAGAIN is |
620c146d |
327 | * returned: if no (appropriate) requests are done adns_check returns |
226c5eef |
328 | * EAGAIN; if no (appropriate) requests are outstanding both |
620c146d |
329 | * adns_query and adns_wait return ESRCH. |
330 | * |
331 | * Additionally, _wait can return EINTR if you set adns_if_eintr. |
332 | * |
333 | * All other errors (nameserver failure, timed out connections, &c) |
334 | * are returned in the status field of the answer. After a |
335 | * successful _wait or _check, if status is nonzero then nrrs will be |
336 | * 0, otherwise it will be >0. type will always be the type |
337 | * requested. |
a17d3a1d |
338 | */ |
339 | |
e563872a |
340 | int adns_init(adns_state *newstate_r, adns_initflags flags, |
36369543 |
341 | FILE *diagfile /*0=>stderr*/); |
342 | |
e563872a |
343 | int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags, |
36369543 |
344 | FILE *diagfile /*0=>discard*/, const char *configtext); |
c8c7c813 |
345 | |
346 | /* Configuration: |
347 | * adns_init reads /etc/resolv.conf, which is expected to be (broadly |
fb7fbb66 |
348 | * speaking) in the format expected by libresolv, and then |
349 | * /etc/resolv-adns.conf if it exists. adns_init_strcfg is instead |
350 | * passed a string which is interpreted as if it were the contents of |
351 | * resolv.conf or resolv-adns.conf. In general, configuration which |
352 | * is set later overrides any that is set earlier. |
c8c7c813 |
353 | * |
fb7fbb66 |
354 | * Standard directives understood in resolv[-adns].conf: |
c8c7c813 |
355 | * |
356 | * nameserver <address> |
357 | * Must be followed by the IP address of a nameserver. Several |
358 | * nameservers may be specified, and they will be tried in the order |
359 | * found. There is a compiled in limit, currently 5, on the number |
360 | * of nameservers. (libresolv supports only 3 nameservers.) |
361 | * |
362 | * search <domain> ... |
363 | * Specifies the search list for queries which specify |
364 | * adns_qf_search. This is a list of domains to append to the query |
365 | * domain. The query domain will be tried as-is either before all |
366 | * of these or after them, depending on the ndots option setting |
367 | * (see below). |
368 | * |
369 | * domain <domain> |
370 | * This is present only for backward compatibility with obsolete |
371 | * versions of libresolv. It should not be used, and is interpreted |
372 | * by adns as if it were `search' - note that this is subtly |
373 | * different to libresolv's interpretation of this directive. |
374 | * |
375 | * sortlist <addr>/<mask> ... |
376 | * Should be followed by a sequence of IP-address and netmask pairs, |
377 | * separated by spaces. They may be specified as |
378 | * eg. 172.30.206.0/24 or 172.30.206.0/255.255.255.0. Currently up |
379 | * to 15 pairs may be specified (but note that libresolv only |
380 | * supports up to 10). |
381 | * |
382 | * options |
383 | * Should followed by one or more options, separated by spaces. |
384 | * Each option consists of an option name, followed by optionally |
385 | * a colon and a value. Options are listed below. |
386 | * |
fb7fbb66 |
387 | * Non-standard directives understood in resolv[-adns].conf: |
c8c7c813 |
388 | * |
389 | * clearnameservers |
390 | * Clears the list of nameservers, so that further nameserver lines |
391 | * start again from the beginning. |
392 | * |
393 | * include <filename> |
394 | * The specified file will be read. |
395 | * |
fb7fbb66 |
396 | * Additionally, adns will ignore lines in resolv[-adns].conf which |
397 | * start with a #. |
c8c7c813 |
398 | * |
399 | * Standard options understood: |
400 | * |
401 | * debug |
402 | * Enables debugging output from the resolver, which will be written |
403 | * to stderr. |
404 | * |
405 | * ndots:<count> |
406 | * Affects whether queries with adns_qf_search will be tried first |
407 | * without adding domains from the searchlist, or whether the bare |
408 | * query domain will be tried last. Queries which contain at least |
409 | * <count> dots will be tried bare first. The default is 1. |
410 | * |
411 | * Non-standard options understood: |
412 | * |
413 | * adns_checkc:none |
414 | * adns_checkc:entex |
415 | * adns_checkc:freq |
416 | * Changes the consistency checking frequency; this overrides the |
417 | * setting of adns_if_check_entex, adns_if_check_freq, or neither, |
418 | * in the flags passed to adns_init. |
419 | * |
420 | * There are a number of environment variables which can modify the |
421 | * behaviour of adns. They take effect only if adns_init is used, and |
422 | * the caller of adns_init can disable them using adns_if_noenv. In |
423 | * each case there is both a FOO and an ADNS_FOO; the latter is |
424 | * interpreted later so that it can override the former. Unless |
425 | * otherwise stated, environment variables are interpreted after |
fb7fbb66 |
426 | * resolv[-adns].conf are read, in the order they are listed here. |
c8c7c813 |
427 | * |
428 | * RES_CONF, ADNS_RES_CONF |
429 | * A filename, whose contets are in the format of resolv.conf. |
430 | * |
431 | * RES_CONF_TEXT, ADNS_RES_CONF_TEXT |
432 | * A string in the format of resolv.conf. |
433 | * |
434 | * RES_OPTIONS, ADNS_RES_OPTIONS |
435 | * These are parsed as if they appeared in the `options' line of a |
436 | * resolv.conf. In addition to being parsed at this point in the |
437 | * sequence, they are also parsed at the very beginning before |
438 | * resolv.conf or any other environment variables are read, so that |
439 | * any debug option can affect the processing of the configuration. |
440 | * |
441 | * LOCALDOMAIN, ADNS_LOCALDOMAIN |
442 | * These are interpreted as if their contents appeared in a `search' |
443 | * line in resolv.conf. |
444 | */ |
a17d3a1d |
445 | |
446 | int adns_synchronous(adns_state ads, |
447 | const char *owner, |
448 | adns_rrtype type, |
e563872a |
449 | adns_queryflags flags, |
9d95094c |
450 | adns_answer **answer_r); |
e8c505a5 |
451 | |
452 | /* NB: if you set adns_if_noautosys then _submit and _check do not |
620c146d |
453 | * make any system calls; you must use some of the asynch-io event |
454 | * processing functions to actually get things to happen. |
e8c505a5 |
455 | */ |
a17d3a1d |
456 | |
457 | int adns_submit(adns_state ads, |
458 | const char *owner, |
459 | adns_rrtype type, |
e563872a |
460 | adns_queryflags flags, |
a17d3a1d |
461 | void *context, |
964344fc |
462 | adns_query *query_r); |
a17d3a1d |
463 | |
3ccea6ee |
464 | /* The owner should be quoted in master file format. */ |
465 | |
964344fc |
466 | int adns_check(adns_state ads, |
a17d3a1d |
467 | adns_query *query_io, |
9d95094c |
468 | adns_answer **answer_r, |
469 | void **context_r); |
a17d3a1d |
470 | |
471 | int adns_wait(adns_state ads, |
472 | adns_query *query_io, |
9d95094c |
473 | adns_answer **answer_r, |
474 | void **context_r); |
a17d3a1d |
475 | |
940356bd |
476 | /* same as adns_wait but uses poll(2) internally */ |
477 | int adns_wait_poll(adns_state ads, |
478 | adns_query *query_io, |
479 | adns_answer **answer_r, |
480 | void **context_r); |
481 | |
3955725c |
482 | void adns_cancel(adns_query query); |
a17d3a1d |
483 | |
620c146d |
484 | /* The adns_query you get back from _submit is valid (ie, can be |
485 | * legitimately passed into adns functions) until it is returned by |
486 | * adns_check or adns_wait, or passed to adns_cancel. After that it |
487 | * must not be used. You can rely on it not being reused until the |
488 | * first adns_submit or _transact call using the same adns_state after |
489 | * it became invalid, so you may compare it for equality with other |
490 | * query handles until you next call _query or _transact. |
636b69b1 |
491 | * |
492 | * _submit and _synchronous return ENOSYS if they don't understand the |
493 | * query type. |
e576be50 |
494 | */ |
a17d3a1d |
495 | |
b365d68a |
496 | int adns_submit_reverse(adns_state ads, |
497 | const struct sockaddr *addr, |
498 | adns_rrtype type, |
e563872a |
499 | adns_queryflags flags, |
b365d68a |
500 | void *context, |
501 | adns_query *query_r); |
d7449548 |
502 | /* type must be _r_ptr or _r_ptr_raw. _qf_search is ignored. |
503 | * addr->sa_family must be AF_INET or you get ENOSYS. |
504 | */ |
b365d68a |
505 | |
620c146d |
506 | void adns_finish(adns_state ads); |
e576be50 |
507 | /* You may call this even if you have queries outstanding; |
508 | * they will be cancelled. |
509 | */ |
a17d3a1d |
510 | |
964344fc |
511 | |
958ad1f0 |
512 | void adns_forallqueries_begin(adns_state ads); |
8ce38e76 |
513 | adns_query adns_forallqueries_next(adns_state ads, void **context_r); |
620c146d |
514 | /* Iterator functions, which you can use to loop over the outstanding |
958ad1f0 |
515 | * (submitted but not yet successfuly checked/waited) queries. |
a8768e80 |
516 | * |
958ad1f0 |
517 | * You can only have one iteration going at once. You may call _begin |
518 | * at any time; after that, an iteration will be in progress. You may |
519 | * only call _next when an iteration is in progress - anything else |
520 | * may coredump. The iteration remains in progress until _next |
521 | * returns 0, indicating that all the queries have been walked over, |
522 | * or ANY other adns function is called with the same adns_state (or a |
523 | * query in the same adns_state). There is no need to explicitly |
524 | * finish an iteration. |
525 | * |
8ce38e76 |
526 | * context_r may be 0. *context_r may not be set when _next returns 0. |
964344fc |
527 | */ |
a17d3a1d |
528 | |
28de6442 |
529 | void adns_checkconsistency(adns_state ads, adns_query qu); |
3e2e5fab |
530 | /* Checks the consistency of adns's internal data structures. |
531 | * If any error is found, the program will abort(). |
28de6442 |
532 | * You may pass 0 for qu; if you pass non-null then additional checks |
533 | * are done to make sure that qu is a valid query. |
3e2e5fab |
534 | */ |
535 | |
620c146d |
536 | /* |
537 | * Example expected/legal calling sequence for submit/check/wait: |
a17d3a1d |
538 | * adns_init |
539 | * adns_submit 1 |
540 | * adns_submit 2 |
541 | * adns_submit 3 |
542 | * adns_wait 1 |
226c5eef |
543 | * adns_check 3 -> EAGAIN |
a17d3a1d |
544 | * adns_wait 2 |
545 | * adns_wait 3 |
546 | * .... |
547 | * adns_finish |
620c146d |
548 | */ |
549 | |
550 | /* |
551 | * Entrypoints for generic asynch io: |
552 | * (these entrypoints are not very useful except in combination with * |
553 | * some of the other I/O model calls which can tell you which fds to |
554 | * be interested in): |
555 | * |
556 | * Note that any adns call may cause adns to open and close fds, so |
557 | * you must call beforeselect or beforepoll again just before |
558 | * blocking, or you may not have an up-to-date list of it's fds. |
559 | */ |
560 | |
561 | int adns_processany(adns_state ads); |
562 | /* Gives adns flow-of-control for a bit. This will never block, and |
563 | * can be used with any threading/asynch-io model. If some error |
564 | * occurred which might cause an event loop to spin then the errno |
565 | * value is returned. |
566 | */ |
567 | |
568 | int adns_processreadable(adns_state ads, int fd, const struct timeval *now); |
569 | int adns_processwriteable(adns_state ads, int fd, const struct timeval *now); |
570 | int adns_processexceptional(adns_state ads, int fd, const struct timeval *now); |
571 | /* Gives adns flow-of-control so that it can process incoming data |
572 | * from, or send outgoing data via, fd. Very like _processany. If it |
573 | * returns zero then fd will no longer be readable or writeable |
574 | * (unless of course more data has arrived since). adns will _only_ |
0a106d94 |
575 | * use that fd and only in the manner specified, regardless of whether |
620c146d |
576 | * adns_if_noautosys was specified. |
577 | * |
578 | * adns_processexceptional should be called when select(2) reports an |
579 | * exceptional condition, or poll(2) reports POLLPRI. |
580 | * |
581 | * It is fine to call _processreabable or _processwriteable when the |
582 | * fd is not ready, or with an fd that doesn't belong to adns; it will |
583 | * then just return 0. |
584 | * |
585 | * If some error occurred which might prevent an event loop to spin |
586 | * then the errno value is returned. |
587 | */ |
588 | |
589 | void adns_processtimeouts(adns_state ads, const struct timeval *now); |
590 | /* Gives adns flow-of-control so that it can process any timeouts |
591 | * which might have happened. Very like _processreadable/writeable. |
592 | * |
593 | * now may be 0; if it isn't, *now must be the current time, recently |
594 | * obtained from gettimeofday. |
595 | */ |
596 | |
597 | void adns_firsttimeout(adns_state ads, |
598 | struct timeval **tv_mod, struct timeval *tv_buf, |
599 | struct timeval now); |
600 | /* Asks adns when it would first like the opportunity to time |
601 | * something out. now must be the current time, from gettimeofday. |
602 | * |
603 | * If tv_mod points to 0 then tv_buf must be non-null, and |
604 | * _firsttimeout will fill in *tv_buf with the time until the first |
605 | * timeout, and make *tv_mod point to tv_buf. If adns doesn't have |
606 | * anything that might need timing out it will leave *tv_mod as 0. |
607 | * |
608 | * If *tv_mod is not 0 then tv_buf is not used. adns will update |
609 | * *tv_mod if it has any earlier timeout, and leave it alone if it |
610 | * doesn't. |
611 | * |
612 | * This call will not actually do any I/O, or change the fds that adns |
613 | * is using. It always succeeds and never blocks. |
614 | */ |
615 | |
616 | void adns_globalsystemfailure(adns_state ads); |
617 | /* If serious problem(s) happen which globally affect your ability to |
618 | * interact properly with adns, or adns's ability to function |
619 | * properly, you or adns can call this function. |
620 | * |
621 | * All currently outstanding queries will be made to fail with |
622 | * adns_s_systemfail, and adns will close any stream sockets it has |
623 | * open. |
624 | * |
625 | * This is used by adns, for example, if gettimeofday() fails. |
626 | * Without this the program's event loop might start to spin ! |
627 | * |
628 | * This call will never block. |
629 | */ |
630 | |
631 | /* |
632 | * Entrypoints for select-loop based asynch io: |
633 | */ |
634 | |
635 | void adns_beforeselect(adns_state ads, int *maxfd, fd_set *readfds, |
636 | fd_set *writefds, fd_set *exceptfds, |
637 | struct timeval **tv_mod, struct timeval *tv_buf, |
638 | const struct timeval *now); |
639 | /* Find out file descriptors adns is interested in, and when it would |
640 | * like the opportunity to time something out. If you do not plan to |
641 | * block then tv_mod may be 0. Otherwise, tv_mod and tv_buf are as |
642 | * for adns_firsttimeout. readfds, writefds, exceptfds and maxfd_io may |
643 | * not be 0. |
644 | * |
645 | * If *now is not 0 then this will never actually do any I/O, or |
646 | * change the fds that adns is using or the timeouts it wants. In any |
647 | * case it won't block. |
648 | */ |
649 | |
650 | void adns_afterselect(adns_state ads, int maxfd, const fd_set *readfds, |
651 | const fd_set *writefds, const fd_set *exceptfds, |
652 | const struct timeval *now); |
653 | /* Gives adns flow-of-control for a bit; intended for use after |
654 | * select. This is just a fancy way of calling adns_processreadable/ |
655 | * writeable/timeouts as appropriate, as if select had returned the |
656 | * data being passed. Always succeeds. |
657 | */ |
658 | |
659 | /* |
660 | * Example calling sequence: |
a17d3a1d |
661 | * |
e8c505a5 |
662 | * adns_init _noautosys |
a17d3a1d |
663 | * loop { |
620c146d |
664 | * adns_beforeselect |
a17d3a1d |
665 | * select |
620c146d |
666 | * adns_afterselect |
e8c505a5 |
667 | * ... |
668 | * adns_submit / adns_check |
669 | * ... |
a17d3a1d |
670 | * } |
671 | */ |
672 | |
620c146d |
673 | /* |
674 | * Entrypoints for poll-loop based asynch io: |
675 | */ |
676 | |
677 | struct pollfd; |
678 | /* In case your system doesn't have it or you forgot to include |
679 | * <sys/poll.h>, to stop the following declarations from causing |
680 | * problems. If your system doesn't have poll then the following |
681 | * entrypoints will not be defined in libadns. Sorry ! |
682 | */ |
683 | |
684 | int adns_beforepoll(adns_state ads, struct pollfd *fds, int *nfds_io, int *timeout_io, |
685 | const struct timeval *now); |
686 | /* Finds out which fd's adns is interested in, and when it would like |
687 | * to be able to time things out. This is in a form suitable for use |
688 | * with poll(2). |
689 | * |
690 | * On entry, usually fds should point to at least *nfds_io structs. |
691 | * adns will fill up to that many structs will information for poll, |
692 | * and record in *nfds_io how many structs it filled. If it wants to |
693 | * listen for more structs then *nfds_io will be set to the number |
694 | * required and _beforepoll will return ERANGE. |
695 | * |
620c146d |
696 | * You may call _beforepoll with fds==0 and *nfds_io 0, in which case |
697 | * adns will fill in the number of fds that it might be interested in |
fc6a52ae |
698 | * in *nfds_io, and always return either 0 (if it is not interested in |
699 | * any fds) or ERANGE (if it is). |
700 | * |
c912639e |
701 | * NOTE that (unless now is 0) adns may acquire additional fds |
fc6a52ae |
702 | * from one call to the next, so you must put adns_beforepoll in a |
703 | * loop, rather than assuming that the second call (with the buffer |
704 | * size requested by the first) will not return ERANGE. |
620c146d |
705 | * |
706 | * adns only ever sets POLLIN, POLLOUT and POLLPRI in its pollfd |
707 | * structs, and only ever looks at those bits. POLLPRI is required to |
fc6a52ae |
708 | * detect TCP Urgent Data (which should not be used by a DNS server) |
620c146d |
709 | * so that adns can know that the TCP stream is now useless. |
710 | * |
711 | * In any case, *timeout_io should be a timeout value as for poll(2), |
712 | * which adns will modify downwards as required. If the caller does |
fc6a52ae |
713 | * not plan to block then *timeout_io should be 0 on entry, or |
714 | * alternatively, timeout_io may be 0. (Alternatively, the caller may |
715 | * use _beforeselect with timeout_io==0 to find out about file |
716 | * descriptors, and use _firsttimeout is used to find out when adns |
717 | * might want to time something out.) |
620c146d |
718 | * |
719 | * adns_beforepoll will return 0 on success, and will not fail for any |
720 | * reason other than the fds buffer being too small (ERANGE). |
721 | * |
c912639e |
722 | * This call will never actually do any I/O. If you supply the |
723 | * current time it will not change the fds that adns is using or the |
724 | * timeouts it wants. |
725 | * |
726 | * In any case this call won't block. |
620c146d |
727 | */ |
728 | |
729 | #define ADNS_POLLFDS_RECOMMENDED 2 |
730 | /* If you allocate an fds buf with at least RECOMMENDED entries then |
731 | * you are unlikely to need to enlarge it. You are recommended to do |
732 | * so if it's convenient. However, you must be prepared for adns to |
733 | * require more space than this. |
734 | */ |
735 | |
736 | void adns_afterpoll(adns_state ads, const struct pollfd *fds, int nfds, |
737 | const struct timeval *now); |
738 | /* Gives adns flow-of-control for a bit; intended for use after |
739 | * poll(2). fds and nfds should be the results from poll(). pollfd |
740 | * structs mentioning fds not belonging to adns will be ignored. |
741 | */ |
742 | |
743 | |
86e7b8d9 |
744 | adns_status adns_rr_info(adns_rrtype type, |
745 | const char **rrtname_r, const char **fmtname_r, |
746 | int *len_r, |
747 | const void *datap, char **data_r); |
b365d68a |
748 | /* |
b365d68a |
749 | * Get information about a query type, or convert reply data to a |
750 | * textual form. type must be specified, and the official name of the |
751 | * corresponding RR type will be returned in *rrtname_r, and |
752 | * information about the processing style in *fmtname_r. The length |
753 | * of the table entry in an answer for that type will be returned in |
754 | * in *len_r. Any or all of rrtname_r, fmtname_r and len_r may be 0. |
755 | * If fmtname_r is non-null then *fmtname_r may be null on return, |
756 | * indicating that no special processing is involved. |
757 | * |
758 | * data_r be must be non-null iff datap is. In this case *data_r will |
759 | * be set to point to a string pointing to a representation of the RR |
760 | * data in master file format. (The owner name, timeout, class and |
761 | * type will not be present - only the data part of the RR.) The |
762 | * memory will have been obtained from malloc() and must be freed by |
763 | * the caller. |
86e7b8d9 |
764 | * |
765 | * Usually this routine will succeed. Possible errors include: |
766 | * adns_s_nomemory |
ea1e31e3 |
767 | * adns_s_rrtypeunknown |
86e7b8d9 |
768 | * adns_s_invaliddata (*datap contained garbage) |
769 | * If an error occurs then no memory has been allocated, |
770 | * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined. |
b365d68a |
771 | * |
772 | * There are some adns-invented data formats which are not official |
773 | * master file formats. These include: |
774 | * |
775 | * Mailboxes if __qtf_mail822: these are just included as-is. |
776 | * |
777 | * Addresses (adns_rr_addr): these may be of pretty much any type. |
778 | * The representation is in two parts: first, a word for the address |
779 | * family (ie, in AF_XXX, the XXX), and then one or more items for the |
780 | * address itself, depending on the format. For an IPv4 address the |
781 | * syntax is INET followed by the dotted quad (from inet_ntoa). |
782 | * Currently only IPv4 is supported. |
783 | * |
a6f1dc92 |
784 | * Text strings (as in adns_rr_txt) appear inside double quotes, and |
785 | * use \" and \\ to represent " and \, and \xHH to represent |
786 | * characters not in the range 32-126. |
787 | * |
b365d68a |
788 | * Hostname with addresses (adns_rr_hostaddr): this consists of the |
a6f1dc92 |
789 | * hostname, as usual, followed by the adns_status value, as an |
790 | * abbreviation, and then a descriptive string (encoded as if it were |
791 | * a piece of text), for the address lookup, followed by zero or more |
b365d68a |
792 | * addresses enclosed in ( and ). If the result was a permanent |
793 | * failure, then a single ? appears instead of the ( ). If the |
794 | * result was a temporary failure then an empty pair of parentheses |
795 | * appears (which a space in between). For example, one of the NS |
a6f1dc92 |
796 | * records for greenend.org.uk comes out like |
797 | * ns.chiark.greenend.org.uk ok "OK" ( INET 195.224.76.132 ) |
b365d68a |
798 | * an MX referring to a nonexistent host might come out like: |
a6f1dc92 |
799 | * 50 sun2.nsfnet-relay.ac.uk nxdomain "No such domain" ( ) |
b365d68a |
800 | * and if nameserver information is not available you might get: |
a6f1dc92 |
801 | * dns2.spong.dyn.ml.org timeout "DNS query timed out" ? |
86e7b8d9 |
802 | */ |
803 | |
31144a72 |
804 | const char *adns_strerror(adns_status st); |
9da4a044 |
805 | const char *adns_errabbrev(adns_status st); |
ac77ffc1 |
806 | const char *adns_errtypeabbrev(adns_status st); |
620c146d |
807 | /* Like strerror but for adns_status values. adns_errabbrev returns |
808 | * the abbreviation of the error - eg, for adns_s_timeout it returns |
ac77ffc1 |
809 | * "timeout". adns_errtypeabbrev returns the abbreviation of the |
810 | * error class: ie, for values up to adns_s_max_XXX it will return the |
811 | * string XXX. You MUST NOT call these functions with status values |
620c146d |
812 | * not returned by the same adns library. |
813 | */ |
31144a72 |
814 | |
02b47faa |
815 | #ifdef __cplusplus |
816 | } /* end of extern "C" */ |
817 | #endif |
a17d3a1d |
818 | #endif |