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