chiark / gitweb /
Add fixme.
[adns] / src / adns.h
CommitLineData
5bb95567 1/*
2 * Copyright (C)1998 Ian Jackson.
3 * This version provided for review and comment only.
4 *
11c8bf9b 5 * $Id: adns.h,v 1.23 1998/11/08 16:16:09 ian Exp $
98db6da3 6 */
7/*
8 * This file is part of adns, which is Copyright (C) 1997, 1998 Ian Jackson
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2, or (at your option)
13 * any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
5bb95567 23 */
5db99a2e 24
25#ifndef ADNS_H_INCLUDED
26#define ADNS_H_INCLUDED
27
d05cc330 28#include <stdio.h>
29
e7afa27f 30#include <sys/socket.h>
31#include <netinet/in.h>
32
33typedef struct adns__state *adns_state;
34typedef struct adns__query *adns_query;
5db99a2e 35
36typedef enum {
dfdbb32c 37 adns_if_noenv= 0x0001, /* do not look at environment */
38 adns_if_noerrprint= 0x0002, /* never print output to stderr (_debug overrides) */
39 adns_if_noserverwarn= 0x0004, /* do not warn to stderr about duff nameservers etc */
96e79df5 40 adns_if_debug= 0x0008, /* enable all output to stderr plus debug msgs */
dfdbb32c 41 adns_if_noautosys= 0x0010, /* do not make syscalls at every opportunity */
5db99a2e 42} adns_initflags;
43
44typedef enum {
96e79df5 45 adns_qf_search= 0x0001, /* use the searchlist */
46 adns_qf_usevc= 0x0002, /* use a virtual circuit (TCP connection) */
47 adns_qf_anyquote= 0x0004,
48 adns_qf_loosecname= 0x0008, /* allow refs to CNAMEs - without, get _s_cname */
49 adns_qf_nocname= 0x0010, /* don't follow CNAMEs, instead give _s_cname */
5db99a2e 50} adns_queryflags;
51
52typedef enum {
31d3a9d0 53 adns__rrt_typemask= 0x0ffff,
96e79df5 54 adns__qtf_deref= 0x10000, /* dereference domains and perhaps produce extra data */
55 adns__qtf_mail822= 0x20000, /* make mailboxes be in RFC822 rcpt field format */
56 adns__qtf_masterfmt= 0x80000, /* convert RRs to master file format, return as str */
57
31d3a9d0 58 adns_r_none= 0,
96e79df5 59
31d3a9d0 60 adns_r_a= 1,
d05cc330 61 adns_r_a_mf= adns_r_a|adns__qtf_masterfmt,
96e79df5 62
31d3a9d0 63 adns_r_ns_raw= 2,
64 adns_r_ns= adns_r_ns_raw|adns__qtf_deref,
d05cc330 65 adns_r_ns_mf= adns_r_ns_raw|adns__qtf_masterfmt,
96e79df5 66
31d3a9d0 67 adns_r_cname= 5,
d05cc330 68 adns_r_cname_mf= adns_r_cname|adns__qtf_masterfmt,
96e79df5 69
31d3a9d0 70 adns_r_soa_raw= 6,
96e79df5 71 adns_r_soa= adns_r_soa_raw|adns__qtf_mail822,
d05cc330 72 adns_r_soa_mf= adns_r_soa_raw|adns__qtf_masterfmt,
96e79df5 73
31d3a9d0 74 adns_r_null= 10,
d05cc330 75 adns_r_null_mf= adns_r_null|adns__qtf_masterfmt,
96e79df5 76
31d3a9d0 77 adns_r_ptr_raw= 12,
78 adns_r_ptr= adns_r_ptr_raw|adns__qtf_deref,
d05cc330 79 adns_r_ptr_mf= adns_r_ptr_raw|adns__qtf_masterfmt,
96e79df5 80
31d3a9d0 81 adns_r_hinfo= 13,
d05cc330 82 adns_r_hinfo_mf= adns_r_hinfo|adns__qtf_masterfmt,
96e79df5 83
31d3a9d0 84 adns_r_mx_raw= 15,
85 adns_r_mx= adns_r_mx_raw|adns__qtf_deref,
d05cc330 86 adns_r_mx_mf= adns_r_mx_raw|adns__qtf_masterfmt,
96e79df5 87
31d3a9d0 88 adns_r_txt= 16,
d05cc330 89 adns_r_txt_mf= adns_r_txt|adns__qtf_masterfmt,
96e79df5 90
31d3a9d0 91 adns_r_rp_raw= 17,
d05cc330 92 adns_r_rp= adns_r_rp_raw|adns__qtf_mail822,
93 adns_r_rp_mf= adns_r_rp_raw|adns__qtf_masterfmt
96e79df5 94
5db99a2e 95} adns_rrtype;
96
e7afa27f 97/* In queries without qtf_anyquote, all domains must have standard
98 * legal syntax. In queries _with_ qtf_anyquote, domains in the query
99 * or response may contain any characters, quoted according to
100 * RFC1035 5.1. On input to adns, the char* is a pointer to the
101 * interior of a " delimited string, except that " may appear in it,
102 * and on output, the char* is a pointer to a string which would be
103 * legal either inside or outside " delimiters, and any characters
104 * not usually legal in domain names will be quoted as \X
105 * (if the character is 33-126 except \ and ") or \DDD.
106 *
96e79df5 107 * _qtf_anyquote is ignored for _mf queries.
108 *
109 * Do not ask for _raw records containing mailboxes without
110 * specifying _qf_anyquote.
e7afa27f 111 */
112
5db99a2e 113typedef enum {
114 adns_s_ok,
dfdbb32c 115 adns_s_timeout,
31d3a9d0 116 adns_s_nolocalmem,
48cb0b4b 117 adns_s_allservfail,
8312a1c2 118 adns_s_servfail,
54ed1d64 119 adns_s_notimplemented,
120 adns_s_refused,
121 adns_s_reasonunknown,
168e26fe 122 adns_s_norecurse,
123 adns_s_serverfaulty,
54ed1d64 124 adns_s_unknownreply,
68b7fc5f 125 adns_s_invaliddata,
54ed1d64 126 adns_s_max_tempfail= 99,
dfdbb32c 127 adns_s_inconsistent, /* PTR gives domain whose A does not match */
96e79df5 128 adns_s_cname, /* CNAME found where data eg A expected (not if _qf_loosecname) */
54ed1d64 129 /* fixme: implement _s_cname */
130 adns_s_max_remotemisconfig= 199,
5db99a2e 131 adns_s_nxdomain,
8312a1c2 132 adns_s_nodata,
133 adns_s_invaliddomain,
134 adns_s_domaintoolong,
5db99a2e 135} adns_status;
136
6927715a 137typedef struct {
138 char *dm;
139 adns_status astatus;
140 int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */
141 struct in_addr *addrs;
d05cc330 142} adns_rr_dmaddr;
143
144typedef struct {
145 char *a, *b;
146} adns_rr_strpair;
147
148typedef struct {
149 int i;
150 adns_rr_dmaddr dmaddr;
151} adns_rr_intdmaddr;
152
153typedef struct {
154 int i;
155 char *str;
156} adns_rr_intstr;
157
158typedef struct {
159 char *ns0, *rp;
160 unsigned long serial, refresh, retry, expire, minimum;
161} adns_rr_soa;
6927715a 162
5617a135 163typedef struct {
5db99a2e 164 adns_status status;
165 char *cname; /* always NULL if query was for CNAME records */
166 adns_rrtype type;
965c9782 167 int nrrs, rrsz;
5db99a2e 168 union {
965c9782 169 void *untyped;
170 unsigned char *bytes;
d05cc330 171 char *(*str); /* ns_raw, cname, ptr, ptr_raw, txt, <any>_mf */
5c596e4d 172 struct in_addr *inaddr; /* a */
d05cc330 173 adns_rr_dmaddr *dmaddr; /* ns */
174 adns_rr_strpair *strpair; /* hinfo, rp, rp_raw */
175 adns_rr_intdmaddr *intdmaddr; /* mx */
176 adns_rr_intstr *intstr; /* mx_raw */
177 adns_rr_soa *soa; /* soa, soa_raw */
5db99a2e 178 /* NULL is empty */
179 } rrs;
5617a135 180} adns_answer;
5db99a2e 181
182/* Memory management:
183 * adns_state and adns_query are actually pointers to malloc'd state;
184 * On submission questions are copied, including the owner domain;
d05cc330 185 * Answers are malloc'd as a single piece of memory; pointers in the
186 * answer struct point into further memory in the answer.
5db99a2e 187 * query_io:
188 * Must always be non-null pointer;
189 * If *query_io is 0 to start with then any query may be returned;
190 * If *query_io is !0 adns_query then only that query may be returned.
9be46d86 191 * If the call is successful, *query_io, *answer_r, and *context_r
192 * will all be set.
5db99a2e 193 * Errors:
194 * Return values are 0 or an errno value;
195 * Seriously fatal system errors (eg, failure to create sockets,
196 * malloc failure, etc.) return errno values;
197 * Other errors (nameserver failure, timed out connections, &c)
198 * are returned in the status field of the answer. If status is
199 * nonzero then nrrs will be 0, otherwise it will be >0.
200 * type will always be the type requested;
5617a135 201 * If no (appropriate) requests are done adns_check returns EWOULDBLOCK;
202 * If no (appropriate) requests are outstanding adns_query and adns_wait return ESRCH;
5db99a2e 203 */
204
dfdbb32c 205int adns_init(adns_state *newstate_r, adns_initflags flags, FILE *diagfile/*0=>stderr*/);
5db99a2e 206
207int adns_synchronous(adns_state ads,
208 const char *owner,
209 adns_rrtype type,
ebd44fbe 210 adns_queryflags flags,
9ab4dfce 211 adns_answer **answer_r);
ebd44fbe 212/* Will not return EINTR. */
5617a135 213
214/* NB: if you set adns_if_noautosys then _submit and _check do not
215 * make any system calls; you must use adns_callback (possibly after
216 * adns_interest) to actually get things to happen.
217 */
5db99a2e 218
219int adns_submit(adns_state ads,
220 const char *owner,
221 adns_rrtype type,
ebd44fbe 222 adns_queryflags flags,
5db99a2e 223 void *context,
e7afa27f 224 adns_query *query_r);
5db99a2e 225
e7afa27f 226int adns_check(adns_state ads,
5db99a2e 227 adns_query *query_io,
9ab4dfce 228 adns_answer **answer_r,
229 void **context_r);
5db99a2e 230
231int adns_wait(adns_state ads,
232 adns_query *query_io,
9ab4dfce 233 adns_answer **answer_r,
234 void **context_r);
ebd44fbe 235/* Might return EINTR - if so, try again */
5db99a2e 236
11c8bf9b 237void adns_cancel(adns_query query);
5db99a2e 238
239int adns_finish(adns_state);
98db6da3 240/* You may call this even if you have queries outstanding;
241 * they will be cancelled.
242 */
5db99a2e 243
5617a135 244int adns_callback(adns_state, int maxfd, const fd_set *readfds, const fd_set *writefds,
245 const fd_set *exceptfds);
246/* Gives adns flow-of-control for a bit. This will never block.
247 * If maxfd == -1 then adns will check (make nonblocking system calls on)
248 * all of its own filedescriptors; otherwise it will only use those
249 * < maxfd and specified in the fd_set's, as if select had returned them.
250 * Other fd's may be in the fd_sets, and will be ignored.
251 * _callback returns how many adns fd's were in the various sets, so
252 * you can tell if your select handling code has missed something and is going awol.
d05cc330 253 *
254 * May also return -1 if a critical syscall failed, setting errno.
e7afa27f 255 */
256
5617a135 257void adns_interest(adns_state, int *maxfd_io, fd_set *readfds_io,
258 fd_set *writefds_io, fd_set *exceptfds_io,
259 struct timeval **tv_mod, struct timeval *tv_buf);
260/* Find out file descriptors adns is interested in, and when it
261 * would like the opportunity to time something out. If you do not plan to
262 * block then tv_mod may be 0. Otherwise, tv_mod may point to 0 meaning
263 * you have no timeout of your own, in which case tv_buf must be non-null and
264 * _interest may fill it in and set *tv_mod=tv_buf.
265 * readfds, writefds, exceptfds and maxfd may not be 0.
e7afa27f 266 */
5db99a2e 267
268/* Example expected/legal calling sequences:
269 * adns_init
270 * adns_submit 1
271 * adns_submit 2
272 * adns_submit 3
273 * adns_wait 1
e7afa27f 274 * adns_check 3 -> EWOULDBLOCK
5db99a2e 275 * adns_wait 2
276 * adns_wait 3
277 * ....
278 * adns_finish
279 *
5617a135 280 * adns_init _noautosys
5db99a2e 281 * loop {
5db99a2e 282 * adns_interest
283 * select
284 * adns_callback
5617a135 285 * ...
286 * adns_submit / adns_check
287 * ...
5db99a2e 288 * }
289 */
290
7f702335 291const char *adns_strerror(adns_status st);
292
5db99a2e 293#endif