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