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