Commit | Line | Data |
---|---|---|
98db6da3 | 1 | /* |
2 | * internal.h | |
3 | * - declarations of private objects with external linkage (adns__*) | |
4 | * - definitons of internal macros | |
5 | * - comments regarding library data structures | |
6 | */ | |
7 | /* | |
39f45e7e | 8 | * This file is part of adns, which is |
9 | * Copyright (C) 1997-2000,2003,2006 Ian Jackson | |
10 | * Copyright (C) 1999-2000,2003,2006 Tony Finch | |
11 | * Copyright (C) 1991 Massachusetts Institute of Technology | |
12 | * (See the file INSTALL for full details.) | |
d0a057ac | 13 | * |
98db6da3 | 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. | |
d0a057ac | 18 | * |
98db6da3 | 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. | |
d0a057ac | 23 | * |
98db6da3 | 24 | * You should have received a copy of the GNU General Public License |
25 | * along with this program; if not, write to the Free Software Foundation, | |
d0a057ac | 26 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
98db6da3 | 27 | */ |
dfdbb32c | 28 | |
29 | #ifndef ADNS_INTERNAL_H_INCLUDED | |
30 | #define ADNS_INTERNAL_H_INCLUDED | |
31 | ||
b6953d1b | 32 | #include "config.h" |
d05cc330 | 33 | typedef unsigned char byte; |
34 | ||
35 | #include <stdarg.h> | |
36 | #include <assert.h> | |
37 | #include <unistd.h> | |
87e46054 | 38 | #include <signal.h> |
74c94831 | 39 | #include <errno.h> |
0872e289 | 40 | #include <string.h> |
cebf6f2b | 41 | #include <stdlib.h> |
d05cc330 | 42 | |
dfdbb32c | 43 | #include <sys/time.h> |
44 | ||
5f8085b7 | 45 | #define ADNS_FEATURE_MANYAF |
dfdbb32c | 46 | #include "adns.h" |
ab898cf4 | 47 | #include "dlist.h" |
dfdbb32c | 48 | |
09aee00b | 49 | #ifdef ADNS_REGRESS_TEST |
50 | # include "hredirect.h" | |
51 | #endif | |
52 | ||
dfdbb32c | 53 | /* Configuration and constants */ |
54 | ||
55 | #define MAXSERVERS 5 | |
8c3aa944 | 56 | #define MAXSORTLIST 15 |
59fbb06a | 57 | #define UDPMAXRETRIES 15 |
dfdbb32c | 58 | #define UDPRETRYMS 2000 |
d0a057ac | 59 | #define TCPWAITMS 30000 |
60 | #define TCPCONNMS 14000 | |
61 | #define TCPIDLEMS 30000 | |
2c7b101b | 62 | #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */ |
54ed1d64 | 63 | |
5c596e4d | 64 | #define DNS_PORT 53 |
54ed1d64 | 65 | #define DNS_MAXUDP 512 |
3d75057b | 66 | #define DNS_MAXLABEL 63 |
54ed1d64 | 67 | #define DNS_MAXDOMAIN 255 |
68 | #define DNS_HDRSIZE 12 | |
7e6a84a1 | 69 | #define DNS_IDOFFSET 0 |
54ed1d64 | 70 | #define DNS_CLASS_IN 1 |
dfdbb32c | 71 | |
cd1bde2f | 72 | #define DNS_INADDR_ARPA "in-addr", "arpa" |
8a53cf7f | 73 | #define DNS_IP6_ARPA "ip6", "arpa" |
cd1bde2f | 74 | |
62e2764d | 75 | #define MAX_ADDRSTRLEN 64 |
88518143 | 76 | |
705b9b15 MW |
77 | #define STRINGIFY(x) REALLY_STRINGIFY(x) |
78 | #define REALLY_STRINGIFY(x) #x | |
79 | ||
74c94831 | 80 | #define MAX_POLLFDS ADNS_POLLFDS_RECOMMENDED |
81 | ||
1389dc72 | 82 | typedef enum { |
83 | cc_user, | |
84 | cc_entex, | |
85 | cc_freq | |
86 | } consistency_checks; | |
87 | ||
5c596e4d | 88 | typedef enum { |
89 | rcode_noerror, | |
90 | rcode_formaterror, | |
91 | rcode_servfail, | |
92 | rcode_nxdomain, | |
93 | rcode_notimp, | |
94 | rcode_refused | |
95 | } dns_rcode; | |
96 | ||
5f8085b7 | 97 | enum { |
0aa4a357 | 98 | adns__qf_addr_answer= 0x01000000,/* addr query received an answer */ |
96818a13 | 99 | adns__qf_addr_cname = 0x02000000 /* addr subquery performed on cname */ |
5f8085b7 MW |
100 | }; |
101 | ||
dfdbb32c | 102 | /* Shared data structures */ |
103 | ||
d05cc330 | 104 | typedef union { |
dfdbb32c | 105 | adns_status status; |
106 | char *cp; | |
107 | adns_rrtype type; | |
d05cc330 | 108 | int i; |
dfdbb32c | 109 | struct in_addr ia; |
110 | unsigned long ul; | |
d05cc330 | 111 | } rr_align; |
112 | ||
113 | typedef struct { | |
114 | int used, avail; | |
115 | byte *buf; | |
116 | } vbuf; | |
117 | ||
a1d2d0ed | 118 | typedef struct { |
26eb6bdc | 119 | adns_state ads; |
a1d2d0ed | 120 | adns_query qu; |
26eb6bdc | 121 | int serv; |
a1d2d0ed | 122 | const byte *dgram; |
26eb6bdc | 123 | int dglen, nsstart, nscount, arcount; |
ba1ddf08 | 124 | struct timeval now; |
a1d2d0ed | 125 | } parseinfo; |
126 | ||
9136cf0c MW |
127 | union gen_addr { |
128 | struct in_addr v4; | |
129 | struct in6_addr v6; | |
130 | }; | |
131 | ||
3540caec | 132 | union checklabel_state { |
e4007092 MW |
133 | struct { |
134 | #define PTR_NDOMAIN 2 | |
135 | unsigned domainmap; /* which domains are still live */ | |
136 | byte ipv[PTR_NDOMAIN][32]; /* address components so far */ | |
137 | } ptr; | |
3540caec MW |
138 | }; |
139 | ||
9136cf0c MW |
140 | typedef struct { |
141 | int af; | |
142 | int width; | |
143 | int delim; | |
8a53cf7f MW |
144 | int nrevcomp; |
145 | int revcompwd; | |
146 | adns_rrtype rrtype; | |
bcfd6f13 | 147 | const void *(*sockaddr_to_inaddr)(const struct sockaddr *sa); |
705b9b15 MW |
148 | int (*sockaddr_equalp)(const struct sockaddr *sa, |
149 | const struct sockaddr *sb); | |
9136cf0c MW |
150 | void (*prefix_mask)(int len, union gen_addr *a); |
151 | int (*guess_len)(const union gen_addr *a); | |
152 | int (*matchp)(const union gen_addr *addr, | |
153 | const union gen_addr *base, const union gen_addr *mask); | |
8a53cf7f MW |
154 | int (*rev_parsecomp)(const char *p, size_t n); |
155 | void (*rev_mkaddr)(union gen_addr *addr, const byte *ipv); | |
705b9b15 | 156 | char *(*rev_mkname)(const struct sockaddr *sa, char *buf); |
9136cf0c MW |
157 | } afinfo; |
158 | ||
8a53cf7f MW |
159 | struct afinfo_addr { const afinfo *ai; union gen_addr addr; }; |
160 | ||
3540caec MW |
161 | typedef struct { |
162 | void *ext; | |
163 | void (*callback)(adns_query parent, adns_query child); | |
164 | ||
165 | union { | |
3540caec MW |
166 | adns_rr_hostaddr *hostaddr; |
167 | } pinfo; /* state for use by parent's callback function */ | |
168 | ||
169 | union { | |
e4007092 MW |
170 | struct { |
171 | struct afinfo_addr addr; | |
172 | } ptr; | |
3540caec MW |
173 | struct { |
174 | unsigned want, have; | |
175 | } addr; | |
176 | } tinfo; /* type-specific state for the query itself: zero-init if you | |
177 | * don't know better. */ | |
178 | ||
179 | } qcontext; | |
180 | ||
bddb4c18 | 181 | typedef struct typeinfo { |
7d0aaee4 | 182 | adns_rrtype typekey; |
1e9efa71 | 183 | const char *rrtname; |
184 | const char *fmtname; | |
5c596e4d | 185 | int rrsz; |
965c9782 | 186 | |
1e9efa71 | 187 | void (*makefinal)(adns_query qu, void *data); |
188 | /* Change memory management of *data. | |
189 | * Previously, used alloc_interim, now use alloc_final. | |
190 | */ | |
191 | ||
192 | adns_status (*convstring)(vbuf *vb, const void *data); | |
193 | /* Converts the RR data to a string representation in vbuf. | |
194 | * vbuf will be appended to (it must have been initialised), | |
195 | * and will not be null-terminated by convstring. | |
196 | */ | |
197 | ||
9c344a42 | 198 | adns_status (*parse)(const parseinfo *pai, int cbyte, |
199 | int max, void *store_r); | |
7f702335 | 200 | /* Parse one RR, in dgram of length dglen, starting at cbyte and |
201 | * extending until at most max. | |
202 | * | |
203 | * The RR should be stored at *store_r, of length qu->typei->rrsz. | |
204 | * | |
205 | * If there is an overrun which might indicate truncation, it should set | |
206 | * *rdstart to -1; otherwise it may set it to anything else positive. | |
f318f883 | 207 | * |
a1d2d0ed | 208 | * nsstart is the offset of the authority section. |
965c9782 | 209 | */ |
f2ad23ee | 210 | |
9c344a42 | 211 | int (*diff_needswap)(adns_state ads,const void *datap_a,const void *datap_b); |
f318f883 | 212 | /* Returns !0 if RR a should be strictly after RR b in the sort order, |
f2ad23ee | 213 | * 0 otherwise. Must not fail. |
214 | */ | |
bddb4c18 | 215 | |
3540caec MW |
216 | adns_status (*checklabel)(adns_state ads, adns_queryflags flags, |
217 | union checklabel_state *css, qcontext *ctx, | |
218 | int labnum, const char *label, int lablen); | |
219 | /* Check a label from the query domain string. The label is not | |
220 | * necessarily null-terminated. The query has not yet been constructed, | |
221 | * and this hook can refuse its submission by returning a nonzero status. | |
222 | * State can be stored in *css between calls, and useful information can be | |
223 | * stashed in ctx->tinfo, to be stored with the query (e.g., it will be | |
224 | * available to the parse hook). This hook can detect a first call because | |
225 | * labnum is zero, and a final call because lablen is zero. | |
226 | */ | |
bddb4c18 | 227 | |
375c6c48 | 228 | void (*postsort)(adns_state ads, void *array, int nrrs, |
59d05d1c | 229 | const struct typeinfo *typei); |
230 | /* Called immediately after the RRs have been sorted, and may rearrange | |
231 | * them. (This is really for the benefit of SRV's bizarre weighting | |
232 | * stuff.) May be 0 to mean nothing needs to be done. | |
233 | */ | |
5f8085b7 | 234 | |
e1d31292 MW |
235 | int (*getrrsz)(adns_rrtype type); |
236 | /* Return the output resource-record element size; if this is null, then | |
237 | * the rrsz member can be used. | |
238 | */ | |
239 | ||
5f8085b7 MW |
240 | void (*query_send)(adns_query qu, struct timeval now); |
241 | /* Send the query to nameservers, and hook it into the appropriate queue. | |
242 | * Normal behaviour is to call adns__query_send, but this can be overridden | |
243 | * for special effects. | |
244 | */ | |
8312a1c2 | 245 | } typeinfo; |
246 | ||
3540caec MW |
247 | adns_status adns__ckl_hostname(adns_state ads, adns_queryflags flags, |
248 | union checklabel_state *css, | |
249 | qcontext *ctx, int labnum, | |
250 | const char *label, int lablen); | |
251 | /* implemented in query.c, used by types.c as default | |
252 | * and as part of implementation for some fancier types */ | |
bddb4c18 | 253 | |
965c9782 | 254 | typedef struct allocnode { |
bc01473e | 255 | struct allocnode *next, *back; |
5f8085b7 | 256 | size_t sz; |
965c9782 | 257 | } allocnode; |
258 | ||
259 | union maxalign { | |
260 | byte d[1]; | |
261 | struct in_addr ia; | |
262 | long l; | |
263 | void *p; | |
264 | void (*fp)(void); | |
265 | union maxalign *up; | |
266 | } data; | |
267 | ||
dfdbb32c | 268 | struct adns__query { |
11c8bf9b | 269 | adns_state ads; |
d0a057ac | 270 | enum { query_tosend, query_tcpw, query_childw, query_done } state; |
d05cc330 | 271 | adns_query back, next, parent; |
dfdbb32c | 272 | struct { adns_query head, tail; } children; |
273 | struct { adns_query back, next; } siblings; | |
bc01473e | 274 | struct { allocnode *head, *tail; } allocations; |
1be24aef | 275 | int interim_allocd, preserved_allocd; |
ae41e040 | 276 | void *final_allocspace; |
8f2aa812 | 277 | |
8312a1c2 | 278 | const typeinfo *typei; |
f2ad23ee | 279 | byte *query_dgram; |
965c9782 | 280 | int query_dglen; |
d0a057ac | 281 | |
965c9782 | 282 | vbuf vb; |
283 | /* General-purpose messing-about buffer. | |
284 | * Wherever a `big' interface is crossed, this may be corrupted/changed | |
285 | * unless otherwise specified. | |
286 | */ | |
287 | ||
288 | adns_answer *answer; | |
289 | /* This is allocated when a query is submitted, to avoid being unable | |
290 | * to relate errors to queries if we run out of memory. During | |
291 | * query processing status, rrs is 0. cname is set if | |
292 | * we found a cname (this corresponds to cname_dgram in the query | |
293 | * structure). type is set from the word go. nrrs and rrs | |
294 | * are set together, when we find how many rrs there are. | |
b2988d3e | 295 | * owner is set during querying unless we're doing searchlist, |
296 | * in which case it is set only when we find an answer. | |
965c9782 | 297 | */ |
d0a057ac | 298 | |
7f702335 | 299 | byte *cname_dgram; |
300 | int cname_dglen, cname_begin; | |
11c8bf9b | 301 | /* If non-0, has been allocated using . */ |
11f553d9 | 302 | |
303 | vbuf search_vb; | |
304 | int search_origlen, search_pos, search_doneabs; | |
305 | /* Used by the searching algorithm. The query domain in textual form | |
306 | * is copied into the vbuf, and _origlen set to its length. Then | |
307 | * we walk the searchlist, if we want to. _pos says where we are | |
308 | * (next entry to try), and _doneabs says whether we've done the | |
7e6a84a1 | 309 | * absolute query yet (0=not yet, 1=done, -1=must do straight away, |
310 | * but not done yet). If flags doesn't have adns_qf_search then | |
11f553d9 | 311 | * the vbuf is initialised but empty and everything else is zero. |
11f553d9 | 312 | */ |
d0a057ac | 313 | |
314 | int id, flags, retries; | |
d05cc330 | 315 | int udpnextserver; |
d0a057ac | 316 | unsigned long udpsent; /* bitmap indexed by server */ |
dfdbb32c | 317 | struct timeval timeout; |
2c7b101b | 318 | time_t expires; /* Earliest expiry time of any record we used. */ |
cd1bde2f | 319 | |
320 | qcontext ctx; | |
96e79df5 | 321 | |
dfdbb32c | 322 | /* Possible states: |
96e79df5 | 323 | * |
1389dc72 | 324 | * state Queue child id nextudpserver udpsent tcpfailed |
d0a057ac | 325 | * |
24d52b13 | 326 | * tosend NONE null >=0 0 zero zero |
d0a057ac | 327 | * tosend udpw null >=0 any nonzero zero |
24d52b13 | 328 | * tosend NONE null >=0 any nonzero zero |
d0a057ac | 329 | * |
330 | * tcpw tcpw null >=0 irrelevant any any | |
331 | * | |
965c9782 | 332 | * child childw set >=0 irrelevant irrelevant irrelevant |
d861b9b7 | 333 | * child NONE null >=0 irrelevant irrelevant irrelevant |
965c9782 | 334 | * done output null -1 irrelevant irrelevant irrelevant |
96e79df5 | 335 | * |
d861b9b7 | 336 | * Queries are only not on a queue when they are actually being processed. |
d0a057ac | 337 | * Queries in state tcpw/tcpw have been sent (or are in the to-send buffer) |
338 | * iff the tcp connection is in state server_ok. | |
d861b9b7 | 339 | * |
96e79df5 | 340 | * +------------------------+ |
d0a057ac | 341 | * START -----> | tosend/NONE | |
96e79df5 | 342 | * +------------------------+ |
343 | * / |\ \ | |
344 | * too big for UDP / UDP timeout \ \ send via UDP | |
d0a057ac | 345 | * send via TCP / more retries \ \ |
346 | * when conn'd / desired \ \ | |
347 | * | | | | |
348 | * v | v | |
349 | * +-----------+ +-------------+ | |
350 | * | tcpw/tcpw | ________ | tosend/udpw | | |
351 | * +-----------+ \ +-------------+ | |
352 | * | | | UDP timeout | | | |
353 | * | | | no more | | | |
354 | * | | | retries | | | |
355 | * \ | TCP died | desired | | | |
356 | * \ \ no more | | | | |
357 | * \ \ servers | TCP / | | |
358 | * \ \ to try | timeout / | | |
359 | * got \ \ v |_ | got | |
96e79df5 | 360 | * reply \ _| +------------------+ / reply |
361 | * \ | done/output FAIL | / | |
362 | * \ +------------------+ / | |
363 | * \ / | |
364 | * _| |_ | |
365 | * (..... got reply ....) | |
366 | * / \ | |
367 | * need child query/ies / \ no child query | |
368 | * / \ | |
369 | * |_ _| | |
d0a057ac | 370 | * +---------------+ +----------------+ |
371 | * | childw/childw | ----------------> | done/output OK | | |
372 | * +---------------+ children done +----------------+ | |
dfdbb32c | 373 | */ |
374 | }; | |
375 | ||
d0a057ac | 376 | struct query_queue { adns_query head, tail; }; |
377 | ||
705b9b15 MW |
378 | #define MAXUDP 2 |
379 | ||
dfdbb32c | 380 | struct adns__state { |
dfdbb32c | 381 | adns_initflags iflags; |
86ea5e62 | 382 | adns_logcallbackfn *logfn; |
383 | void *logfndata; | |
d6b271ae | 384 | int configerrno; |
d0a057ac | 385 | struct query_queue udpw, tcpw, childw, output; |
8f2aa812 | 386 | adns_query forallnext; |
705b9b15 MW |
387 | int nextid, tcpsocket; |
388 | struct udpsocket { const afinfo *ai; int fd; } udpsocket[MAXUDP]; | |
389 | int nudp; | |
965c9782 | 390 | vbuf tcpsend, tcprecv; |
ab898cf4 | 391 | int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip; |
d0a057ac | 392 | enum adns__tcpstate { |
393 | server_disconnected, server_connecting, | |
394 | server_ok, server_broken | |
395 | } tcpstate; | |
dfdbb32c | 396 | struct timeval tcptimeout; |
8744cce8 | 397 | /* This will have tv_sec==0 if it is not valid. It will always be |
398 | * valid if tcpstate _connecting. When _ok, it will be nonzero if | |
399 | * we are idle (ie, tcpw queue is empty), in which case it is the | |
400 | * absolute time when we will close the connection. | |
d0a057ac | 401 | */ |
87e46054 | 402 | struct sigaction stdsigpipe; |
403 | sigset_t stdsigmask; | |
74c94831 | 404 | struct pollfd pollfds_buf[MAX_POLLFDS]; |
705b9b15 | 405 | adns_rr_addr servers[MAXSERVERS]; |
8c3aa944 | 406 | struct sortlist { |
9136cf0c MW |
407 | const afinfo *ai; |
408 | union gen_addr base, mask; | |
8c3aa944 | 409 | } sortlist[MAXSORTLIST]; |
11f553d9 | 410 | char **searchlist; |
375c6c48 | 411 | unsigned short rand48xsubi[3]; |
dfdbb32c | 412 | }; |
413 | ||
9136cf0c MW |
414 | /* From addrfam.c: */ |
415 | ||
416 | extern const afinfo adns__inet_afinfo, adns__inet6_afinfo; | |
417 | ||
dfdbb32c | 418 | /* From setup.c: */ |
419 | ||
98db6da3 | 420 | int adns__setnonblock(adns_state ads, int fd); /* => errno value */ |
421 | ||
422 | /* From general.c: */ | |
423 | ||
62e2764d MW |
424 | const char *adns__sockaddr_ntoa(struct sockaddr *sa, size_t n, char *buf); |
425 | /* Buffer must be at least MAX_ADDRSTRLEN bytes long. */ | |
426 | ||
86ea5e62 | 427 | void adns__vlprintf(adns_state ads, const char *fmt, va_list al); |
428 | void adns__lprintf(adns_state ads, const char *fmt, | |
429 | ...) PRINTFFORMAT(2,3); | |
430 | ||
d05cc330 | 431 | void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent, |
ae41e040 | 432 | int serv, adns_query qu, const char *fmt, va_list al); |
7f702335 | 433 | |
434 | void adns__debug(adns_state ads, int serv, adns_query qu, | |
ae41e040 | 435 | const char *fmt, ...) PRINTFFORMAT(4,5); |
7f702335 | 436 | void adns__warn(adns_state ads, int serv, adns_query qu, |
ae41e040 | 437 | const char *fmt, ...) PRINTFFORMAT(4,5); |
7f702335 | 438 | void adns__diag(adns_state ads, int serv, adns_query qu, |
ae41e040 | 439 | const char *fmt, ...) PRINTFFORMAT(4,5); |
dfdbb32c | 440 | |
d05cc330 | 441 | int adns__vbuf_ensure(vbuf *vb, int want); |
9c344a42 | 442 | int adns__vbuf_appendstr(vbuf *vb, const char *data); /* doesn't include nul */ |
d05cc330 | 443 | int adns__vbuf_append(vbuf *vb, const byte *data, int len); |
96e79df5 | 444 | /* 1=>success, 0=>realloc failed */ |
d05cc330 | 445 | void adns__vbuf_appendq(vbuf *vb, const byte *data, int len); |
446 | void adns__vbuf_init(vbuf *vb); | |
965c9782 | 447 | void adns__vbuf_free(vbuf *vb); |
d05cc330 | 448 | |
cd363ffd | 449 | const char *adns__diag_domain(adns_state ads, int serv, adns_query qu, |
9c344a42 | 450 | vbuf *vb, |
451 | const byte *dgram, int dglen, int cbyte); | |
98db6da3 | 452 | /* Unpicks a domain in a datagram and returns a string suitable for |
453 | * printing it as. Never fails - if an error occurs, it will | |
454 | * return some kind of string describing the error. | |
455 | * | |
11c8bf9b | 456 | * serv may be -1 and qu may be 0. vb must have been initialised, |
98db6da3 | 457 | * and will be left in an arbitrary consistent state. |
458 | * | |
459 | * Returns either vb->buf, or a pointer to a string literal. Do not modify | |
460 | * vb before using the return value. | |
461 | */ | |
d0a057ac | 462 | |
f318f883 | 463 | void adns__isort(void *array, int nobjs, int sz, void *tempbuf, |
8c3aa944 | 464 | int (*needswap)(void *context, const void *a, const void *b), |
465 | void *context); | |
f318f883 | 466 | /* Does an insertion sort of array which must contain nobjs objects |
467 | * each sz bytes long. tempbuf must point to a buffer at least | |
468 | * sz bytes long. needswap should return !0 if a>b (strictly, ie | |
469 | * wrong order) 0 if a<=b (ie, order is fine). | |
470 | */ | |
87e46054 | 471 | |
472 | void adns__sigpipe_protect(adns_state); | |
473 | void adns__sigpipe_unprotect(adns_state); | |
474 | /* If SIGPIPE protection is not disabled, will block all signals except | |
475 | * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN. (And then restore.) | |
476 | * Each call to _protect must be followed by a call to _unprotect before | |
a225dda5 | 477 | * any significant amount of code gets to run, since the old signal mask |
478 | * is stored in the adns structure. | |
87e46054 | 479 | */ |
480 | ||
98db6da3 | 481 | /* From transmit.c: */ |
96e79df5 | 482 | |
11c8bf9b | 483 | adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r, |
484 | const char *owner, int ol, | |
7d0aaee4 | 485 | const typeinfo *typei, adns_rrtype type, |
486 | adns_queryflags flags); | |
7e6a84a1 | 487 | /* Assembles a query packet in vb. A new id is allocated and returned. |
488 | */ | |
98db6da3 | 489 | |
f2ad23ee | 490 | adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r, |
9c344a42 | 491 | const byte *qd_dgram, int qd_dglen, |
492 | int qd_begin, | |
f2ad23ee | 493 | adns_rrtype type, adns_queryflags flags); |
494 | /* Same as adns__mkquery, but takes the owner domain from an existing datagram. | |
495 | * That domain must be correct and untruncated. | |
496 | */ | |
497 | ||
d0a057ac | 498 | void adns__querysend_tcp(adns_query qu, struct timeval now); |
499 | /* Query must be in state tcpw/tcpw; it will be sent if possible and | |
500 | * no further processing can be done on it for now. The connection | |
501 | * might be broken, but no reconnect will be attempted. | |
98db6da3 | 502 | */ |
503 | ||
24d52b13 | 504 | void adns__query_send(adns_query qu, struct timeval now); |
505 | /* Query must be in state tosend/NONE; it will be moved to a new state, | |
98db6da3 | 506 | * and no further processing can be done on it for now. |
9c344a42 | 507 | * (Resulting state is one of udp/timew, tcpwait/timew (if server not |
508 | * connected), tcpsent/timew, child/childw or done/output.) | |
24d52b13 | 509 | * __query_send may decide to use either UDP or TCP depending whether |
510 | * _qf_usevc is set (or has become set) and whether the query is too | |
511 | * large. | |
98db6da3 | 512 | */ |
513 | ||
514 | /* From query.c: */ | |
dfdbb32c | 515 | |
7e6a84a1 | 516 | adns_status adns__internal_submit(adns_state ads, adns_query *query_r, |
5f8085b7 MW |
517 | const typeinfo *typei, adns_rrtype, |
518 | vbuf *qumsg_vb, int id, | |
7e6a84a1 | 519 | adns_queryflags flags, struct timeval now, |
3540caec | 520 | qcontext *ctx); |
965c9782 | 521 | /* Submits a query (for internal use, called during external submits). |
522 | * | |
523 | * The new query is returned in *query_r, or we return adns_s_nomemory. | |
524 | * | |
ae41e040 | 525 | * The query datagram should already have been assembled in qumsg_vb; |
526 | * the memory for it is _taken over_ by this routine whether it | |
527 | * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb). | |
965c9782 | 528 | * |
bcfd6f13 MW |
529 | * If adns__qf_nosend is set in flags, then the query is not sent: doing |
530 | * whatever is necessary to send the query and link it onto the appropriate | |
531 | * queue is left as the caller's responsibility. | |
532 | * | |
ba1ddf08 | 533 | * *ctx is copied byte-for-byte into the query. |
d861b9b7 | 534 | * |
535 | * When the child query is done, ctx->callback will be called. The | |
536 | * child will already have been taken off both the global list of | |
537 | * queries in ads and the list of children in the parent. The child | |
538 | * will be freed when the callback returns. The parent will have been | |
cb32030b | 539 | * taken off the global childw queue. |
540 | * | |
541 | * The callback should either call adns__query_done, if it is | |
542 | * complete, or adns__query_fail, if an error has occurred, in which | |
543 | * case the other children (if any) will be cancelled. If the parent | |
544 | * has more unfinished children (or has just submitted more) then the | |
545 | * callback may choose to wait for them - it must then put the parent | |
546 | * back on the childw queue. | |
965c9782 | 547 | */ |
548 | ||
7e6a84a1 | 549 | void adns__search_next(adns_state ads, adns_query qu, struct timeval now); |
550 | /* Walks down the searchlist for a query with adns_qf_search. | |
551 | * The query should have just had a negative response, or not had | |
552 | * any queries sent yet, and should not be on any queue. | |
553 | * The query_dgram if any will be freed and forgotten and a new | |
554 | * one constructed from the search_* members of the query. | |
555 | * | |
556 | * Cannot fail (in case of error, calls adns__query_fail). | |
557 | */ | |
558 | ||
965c9782 | 559 | void *adns__alloc_interim(adns_query qu, size_t sz); |
1be24aef | 560 | void *adns__alloc_preserved(adns_query qu, size_t sz); |
965c9782 | 561 | /* Allocates some memory, and records which query it came from |
562 | * and how much there was. | |
563 | * | |
1be24aef | 564 | * If an error occurs in the query, all the memory from _interim is |
565 | * simply freed. If the query succeeds, one large buffer will be made | |
566 | * which is big enough for all these allocations, and then | |
567 | * adns__alloc_final will get memory from this buffer. | |
965c9782 | 568 | * |
f2ad23ee | 569 | * _alloc_interim can fail (and return 0). |
570 | * The caller must ensure that the query is failed. | |
f47cdeec | 571 | * |
1be24aef | 572 | * The memory from _preserved is is kept and transferred into the |
573 | * larger buffer - unless we run out of memory, in which case it too | |
574 | * is freed. When you use _preserved you have to add code to the | |
575 | * x_nomem error exit case in adns__makefinal_query to clear out the | |
576 | * pointers you made to those allocations, because that's when they're | |
577 | * thrown away; you should also make a note in the declaration of | |
578 | * those pointer variables, to note that they are _preserved rather | |
579 | * than _interim. If they're in the answer, note it here: | |
580 | * answer->cname and answer->owner are _preserved. | |
965c9782 | 581 | */ |
582 | ||
96818a13 | 583 | void adns__transfer_interim(adns_query from, adns_query to, void *block); |
bc01473e | 584 | /* Transfers an interim allocation from one query to another, so that |
585 | * the `to' query will have room for the data when we get to makefinal | |
586 | * and so that the free will happen when the `to' query is freed | |
587 | * rather than the `from' query. | |
588 | * | |
589 | * It is legal to call adns__transfer_interim with a null pointer; this | |
590 | * has no effect. | |
2c7b101b | 591 | * |
592 | * _transfer_interim also ensures that the expiry time of the `to' query | |
593 | * is no later than that of the `from' query, so that child queries' | |
594 | * TTLs get inherited by their parents. | |
bc01473e | 595 | */ |
596 | ||
5f8085b7 MW |
597 | void adns__free_interim(adns_query qu, void *p); |
598 | /* Forget about a block allocated by adns__alloc_interim. | |
599 | */ | |
600 | ||
11c8bf9b | 601 | void *adns__alloc_mine(adns_query qu, size_t sz); |
602 | /* Like _interim, but does not record the length for later | |
603 | * copying into the answer. This just ensures that the memory | |
604 | * will be freed when we're done with the query. | |
605 | */ | |
606 | ||
965c9782 | 607 | void *adns__alloc_final(adns_query qu, size_t sz); |
f47cdeec | 608 | /* Cannot fail, and cannot return 0. |
965c9782 | 609 | */ |
dfdbb32c | 610 | |
ae41e040 | 611 | void adns__makefinal_block(adns_query qu, void **blpp, size_t sz); |
612 | void adns__makefinal_str(adns_query qu, char **strp); | |
613 | ||
1be24aef | 614 | void adns__reset_preserved(adns_query qu); |
615 | /* Resets all of the memory management stuff etc. to take account of | |
616 | * only the _preserved stuff from _alloc_preserved. Used when we find | |
617 | * an error somewhere and want to just report the error (with perhaps | |
618 | * CNAME, owner, etc. info), and also when we're halfway through RRs | |
619 | * in a datagram and discover that we need to retry the query. | |
ae41e040 | 620 | */ |
98db6da3 | 621 | |
11c8bf9b | 622 | void adns__query_done(adns_query qu); |
623 | void adns__query_fail(adns_query qu, adns_status stat); | |
5f8085b7 | 624 | void adns__cancel_children(adns_query qu); |
d0a057ac | 625 | |
d05cc330 | 626 | /* From reply.c: */ |
627 | ||
5c596e4d | 628 | void adns__procdgram(adns_state ads, const byte *dgram, int len, |
c84b7355 | 629 | int serv, int viatcp, struct timeval now); |
a225dda5 | 630 | /* This function is allowed to cause new datagrams to be constructed |
631 | * and sent, or even new queries to be started. However, | |
632 | * query-sending functions are not allowed to call any general event | |
633 | * loop functions in case they accidentally call this. | |
d0a057ac | 634 | * |
635 | * Ie, receiving functions may call sending functions. | |
636 | * Sending functions may NOT call receiving functions. | |
a225dda5 | 637 | */ |
5c596e4d | 638 | |
639 | /* From types.c: */ | |
640 | ||
641 | const typeinfo *adns__findtype(adns_rrtype type); | |
642 | ||
643 | /* From parse.c: */ | |
644 | ||
403fa0e0 | 645 | typedef struct { |
ae41e040 | 646 | adns_state ads; |
11c8bf9b | 647 | adns_query qu; |
ae41e040 | 648 | int serv; |
403fa0e0 | 649 | const byte *dgram; |
650 | int dglen, max, cbyte, namelen; | |
11c8bf9b | 651 | int *dmend_r; |
403fa0e0 | 652 | } findlabel_state; |
653 | ||
11c8bf9b | 654 | void adns__findlabel_start(findlabel_state *fls, adns_state ads, |
655 | int serv, adns_query qu, | |
403fa0e0 | 656 | const byte *dgram, int dglen, int max, |
657 | int dmbegin, int *dmend_rlater); | |
658 | /* Finds labels in a domain in a datagram. | |
659 | * | |
660 | * Call this routine first. | |
11c8bf9b | 661 | * dmend_rlater may be null. ads (and of course fls) may not be. |
662 | * serv may be -1, qu may be null - they are for error reporting. | |
403fa0e0 | 663 | */ |
664 | ||
9c344a42 | 665 | adns_status adns__findlabel_next(findlabel_state *fls, |
666 | int *lablen_r, int *labstart_r); | |
403fa0e0 | 667 | /* Then, call this one repeatedly. |
668 | * | |
669 | * It will return adns_s_ok if all is well, and tell you the length | |
670 | * and start of successive labels. labstart_r may be null, but | |
671 | * lablen_r must not be. | |
672 | * | |
673 | * After the last label, it will return with *lablen_r zero. | |
674 | * Do not then call it again; instead, just throw away the findlabel_state. | |
675 | * | |
676 | * *dmend_rlater will have been set to point to the next part of | |
677 | * the datagram after the label (or after the uncompressed part, | |
678 | * if compression was used). *namelen_rlater will have been set | |
679 | * to the length of the domain name (total length of labels plus | |
680 | * 1 for each intervening dot). | |
681 | * | |
682 | * If the datagram appears to be truncated, *lablen_r will be -1. | |
683 | * *dmend_rlater, *labstart_r and *namelen_r may contain garbage. | |
684 | * Do not call _next again. | |
685 | * | |
686 | * There may also be errors, in which case *dmend_rlater, | |
687 | * *namelen_rlater, *lablen_r and *labstart_r may contain garbage. | |
688 | * Do not then call findlabel_next again. | |
689 | */ | |
690 | ||
cd363ffd | 691 | typedef enum { |
692 | pdf_quoteok= 0x001 | |
693 | } parsedomain_flags; | |
694 | ||
11c8bf9b | 695 | adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu, |
cd363ffd | 696 | vbuf *vb, parsedomain_flags flags, |
9c344a42 | 697 | const byte *dgram, int dglen, int *cbyte_io, |
698 | int max); | |
403fa0e0 | 699 | /* vb must already have been initialised; it will be reset if necessary. |
700 | * If there is truncation, vb->used will be set to 0; otherwise | |
701 | * (if there is no error) vb will be null-terminated. | |
702 | * If there is an error vb and *cbyte_io may be left indeterminate. | |
11c8bf9b | 703 | * |
704 | * serv may be -1 and qu may be 0 - they are used for error reporting only. | |
403fa0e0 | 705 | */ |
706 | ||
6f2c243f | 707 | adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads, |
9c344a42 | 708 | adns_query qu, vbuf *vb, |
709 | parsedomain_flags flags, | |
6f2c243f | 710 | const byte *dgram); |
711 | /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state, | |
712 | * for continuing an existing domain or some such of some kind. Also, unlike | |
713 | * _parse_domain, the domain data will be appended to vb, rather than replacing | |
714 | * the existing contents. | |
715 | */ | |
716 | ||
11c8bf9b | 717 | adns_status adns__findrr(adns_query qu, int serv, |
403fa0e0 | 718 | const byte *dgram, int dglen, int *cbyte_io, |
2c7b101b | 719 | int *type_r, int *class_r, unsigned long *ttl_r, |
720 | int *rdlen_r, int *rdstart_r, | |
11c8bf9b | 721 | int *ownermatchedquery_r); |
a1d2d0ed | 722 | /* Finds the extent and some of the contents of an RR in a datagram |
723 | * and does some checks. The datagram is *dgram, length dglen, and | |
724 | * the RR starts at *cbyte_io (which is updated afterwards to point | |
725 | * to the end of the RR). | |
726 | * | |
2c7b101b | 727 | * The type, class, TTL and RRdata length and start are returned iff |
728 | * the corresponding pointer variables are not null. type_r, class_r | |
729 | * and ttl_r may not be null. The TTL will be capped. | |
a1d2d0ed | 730 | * |
731 | * If ownermatchedquery_r != 0 then the owner domain of this | |
732 | * RR will be compared with that in the query (or, if the query | |
733 | * has gone to a CNAME lookup, with the canonical name). | |
734 | * In this case, *ownermatchedquery_r will be set to 0 or 1. | |
735 | * The query datagram (or CNAME datagram) MUST be valid and not truncated. | |
736 | * | |
737 | * If there is truncation then *type_r will be set to -1 and | |
738 | * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be | |
739 | * undefined. | |
740 | * | |
741 | * qu must obviously be non-null. | |
742 | * | |
743 | * If an error is returned then *type_r will be undefined too. | |
744 | */ | |
745 | ||
26eb6bdc | 746 | adns_status adns__findrr_anychk(adns_query qu, int serv, |
747 | const byte *dgram, int dglen, int *cbyte_io, | |
9c344a42 | 748 | int *type_r, int *class_r, |
749 | unsigned long *ttl_r, | |
2c7b101b | 750 | int *rdlen_r, int *rdstart_r, |
9c344a42 | 751 | const byte *eo_dgram, int eo_dglen, |
752 | int eo_cbyte, int *eo_matched_r); | |
a1d2d0ed | 753 | /* Like adns__findrr_checked, except that the datagram and |
754 | * owner to compare with can be specified explicitly. | |
755 | * | |
756 | * If the caller thinks they know what the owner of the RR ought to | |
757 | * be they can pass in details in eo_*: this is another (or perhaps | |
758 | * the same datagram), and a pointer to where the putative owner | |
759 | * starts in that datagram. In this case *eo_matched_r will be set | |
760 | * to 1 if the datagram matched or 0 if it did not. Either | |
761 | * both eo_dgram and eo_matched_r must both be non-null, or they | |
762 | * must both be null (in which case eo_dglen and eo_cbyte will be ignored). | |
763 | * The eo datagram and contained owner domain MUST be valid and | |
764 | * untruncated. | |
765 | */ | |
5c596e4d | 766 | |
9c344a42 | 767 | void adns__update_expires(adns_query qu, unsigned long ttl, |
768 | struct timeval now); | |
2c7b101b | 769 | /* Updates the `expires' field in the query, so that it doesn't exceed |
770 | * now + ttl. | |
771 | */ | |
772 | ||
403fa0e0 | 773 | int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len); |
71324651 | 774 | |
775 | /* From event.c: */ | |
d05cc330 | 776 | |
71324651 | 777 | void adns__tcp_broken(adns_state ads, const char *what, const char *why); |
d0a057ac | 778 | /* what and why may be both 0, or both non-0. */ |
779 | ||
d05cc330 | 780 | void adns__tcp_tryconnect(adns_state ads, struct timeval now); |
98db6da3 | 781 | |
d05cc330 | 782 | void adns__autosys(adns_state ads, struct timeval now); |
ab898cf4 | 783 | /* Make all the system calls we want to if the application wants us to. |
784 | * Must not be called from within adns internal processing functions, | |
785 | * lest we end up in recursive descent ! | |
786 | */ | |
dfdbb32c | 787 | |
74c94831 | 788 | void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io, |
789 | struct timeval *tv_buf); | |
d0a057ac | 790 | |
74c94831 | 791 | int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]); |
792 | void adns__fdevents(adns_state ads, | |
793 | const struct pollfd *pollfds, int npollfds, | |
794 | int maxfd, const fd_set *readfds, | |
795 | const fd_set *writefds, const fd_set *exceptfds, | |
796 | struct timeval now, int *r_r); | |
ef20fccf | 797 | int adns__internal_check(adns_state ads, |
798 | adns_query *query_io, | |
799 | adns_answer **answer, | |
800 | void **context_r); | |
74c94831 | 801 | |
d0a057ac | 802 | void adns__timeouts(adns_state ads, int act, |
803 | struct timeval **tv_io, struct timeval *tvbuf, | |
804 | struct timeval now); | |
805 | /* If act is !0, then this will also deal with the TCP connection | |
806 | * if previous events broke it or require it to be connected. | |
807 | */ | |
808 | ||
1389dc72 | 809 | /* From check.c: */ |
810 | ||
2ac463bf | 811 | void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc); |
1389dc72 | 812 | |
dfdbb32c | 813 | /* Useful static inline functions: */ |
814 | ||
9c344a42 | 815 | static inline int ctype_whitespace(int c) { |
816 | return c==' ' || c=='\n' || c=='\t'; | |
817 | } | |
dfdbb32c | 818 | static inline int ctype_digit(int c) { return c>='0' && c<='9'; } |
5c596e4d | 819 | static inline int ctype_alpha(int c) { |
c2875680 | 820 | return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'); |
5c596e4d | 821 | } |
9c344a42 | 822 | static inline int ctype_822special(int c) { |
823 | return strchr("()<>@,;:\\\".[]",c) != 0; | |
824 | } | |
996e3b68 | 825 | static inline int ctype_domainunquoted(int c) { |
826 | return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0); | |
827 | } | |
dfdbb32c | 828 | |
74c94831 | 829 | static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; } |
830 | ||
dfdbb32c | 831 | /* Useful macros */ |
832 | ||
9c344a42 | 833 | #define MEM_ROUND(sz) \ |
834 | (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \ | |
965c9782 | 835 | * sizeof(union maxalign) ) |
836 | ||
1e9efa71 | 837 | #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff) |
5c596e4d | 838 | #define GET_B(cb,tv) ((tv)= GETIL_B((cb))) |
9c344a42 | 839 | #define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv)) |
840 | #define GET_L(cb,tv) ( (tv)=0, \ | |
841 | (tv)|=(GETIL_B((cb))<<24), \ | |
842 | (tv)|=(GETIL_B((cb))<<16), \ | |
843 | (tv)|=(GETIL_B((cb))<<8), \ | |
844 | (tv)|=GETIL_B(cb), \ | |
2c7b101b | 845 | (tv) ) |
5c596e4d | 846 | |
dfdbb32c | 847 | #endif |