* - comments regarding library data structures
*/
/*
- * This file is part of adns, which is
- * Copyright (C) 1997-2000,2003,2006 Ian Jackson
- * Copyright (C) 1999-2000,2003,2006 Tony Finch
- * Copyright (C) 1991 Massachusetts Institute of Technology
- * (See the file INSTALL for full details.)
+ * This file is part of adns, which is Copyright Ian Jackson
+ * and contributors (see the file INSTALL for full details).
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
+ * the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * along with this program; if not, write to the Free Software Foundation.
*/
#ifndef ADNS_INTERNAL_H_INCLUDED
#include <errno.h>
#include <string.h>
#include <stdlib.h>
+#include <stdbool.h>
#include <sys/time.h>
+#define ADNS_FEATURE_MANYAF
#include "adns.h"
#include "dlist.h"
/* Configuration and constants */
-#define MAXSERVERS 5
+#define MAXSERVERS 5 /* do not increase beyond no. of bits in `unsigned'! */
#define MAXSORTLIST 15
#define UDPMAXRETRIES 15
#define UDPRETRYMS 2000
#define DNS_IDOFFSET 0
#define DNS_CLASS_IN 1
-#define DNS_INADDR_ARPA "in-addr", "arpa"
-
#define MAX_POLLFDS ADNS_POLLFDS_RECOMMENDED
/* Some preprocessor hackery */
typedef enum {
cc_user,
- cc_entex,
+ cc_enter,
+ cc_exit,
cc_freq
} consistency_checks;
rcode_refused
} dns_rcode;
+enum {
+ adns__qf_addr_answer= 0x01000000,/* addr query received an answer */
+ adns__qf_addr_cname = 0x02000000 /* addr subquery performed on cname */
+};
+
/* Shared data structures */
typedef struct {
struct timeval now;
} parseinfo;
+#define MAXREVLABELS 34 /* keep in sync with addrfam! */
+struct revparse_state {
+ uint16_t labstart[MAXREVLABELS];
+ uint8_t lablen[MAXREVLABELS];
+};
+
union checklabel_state {
- struct { byte ipv[4]; } ptr;
+ struct revparse_state ptr;
};
typedef struct {
union {
struct {
- struct in_addr addr;
+ adns_rrtype rev_rrtype;
+ adns_sockaddr addr;
} ptr;
+ struct {
+ unsigned want, have;
+ } addr;
} tinfo; /* type-specific state for the query itself: zero-init if you
* don't know better. */
* Previously, used alloc_interim, now use alloc_final.
*/
- adns_status (*convstring)(vbuf *vb, const void *data);
+ adns_status (*convstring)(vbuf *vb, adns_rrtype, const void *data);
/* Converts the RR data to a string representation in vbuf.
* vbuf will be appended to (it must have been initialised),
* and will not be null-terminated by convstring.
adns_status (*checklabel)(adns_state ads, adns_queryflags flags,
union checklabel_state *cls, qcontext *ctx,
- int labnum, const char *label, int lablen);
+ int labnum, const char *dgram,
+ int labstart, int lablen);
/* Check a label from the query domain string. The label is not
* necessarily null-terminated. The hook can refuse the query's submission
* by returning a nonzero status. State can be stored in *cls between
* because lablen is zero.
*/
- void (*postsort)(adns_state ads, void *array, int nrrs,int rrsz,
+ void (*postsort)(adns_state ads, void *array, int nrrs, int rrsz,
const struct typeinfo *typei);
/* Called immediately after the RRs have been sorted, and may rearrange
* them. (This is really for the benefit of SRV's bizarre weighting
/* Return the output resource-record element size; if this is null, then
* the rrsz member can be used.
*/
+
+ void (*query_send)(adns_query qu, struct timeval now);
+ /* Send the query to nameservers, and hook it into the appropriate queue.
+ * Normal behaviour is to call adns__query_send, but this can be overridden
+ * for special effects.
+ */
} typeinfo;
adns_status adns__ckl_hostname(adns_state ads, adns_queryflags flags,
union checklabel_state *cls,
qcontext *ctx, int labnum,
- const char *label, int lablen);
+ const char *dgram, int labstart, int lablen);
/* implemented in query.c, used by types.c as default
* and as part of implementation for some fancier types
* doesn't require any state */
typedef struct allocnode {
struct allocnode *next, *back;
+ size_t sz;
} allocnode;
union maxalign {
void *p;
void (*fp)(void);
union maxalign *up;
-} data;
+};
struct adns__query {
adns_state ads;
int id, flags, retries;
int udpnextserver;
unsigned long udpsent; /* bitmap indexed by server */
- struct timeval timeout;
+ int timeout_ms;
+ struct timeval timeout_started;
time_t expires; /* Earliest expiry time of any record we used. */
qcontext ctx;
* Queries in state tcpw/tcpw have been sent (or are in the to-send buffer)
* iff the tcp connection is in state server_ok.
*
+ * Internal queries (from adns__submit_internal) end up on intdone
+ * instead of output, and the callbacks are made on the way out of
+ * adns, to avoid reentrancy hazards.
+ *
* +------------------------+
* START -----> | tosend/NONE |
* +------------------------+
struct query_queue { adns_query head, tail; };
+#define MAXUDP 2
+
struct adns__state {
adns_initflags iflags;
adns_logcallbackfn *logfn;
void *logfndata;
int configerrno;
- struct query_queue udpw, tcpw, childw, output;
+ struct query_queue udpw, tcpw, childw, output, intdone;
adns_query forallnext;
- int nextid, udpsocket, tcpsocket;
+ unsigned nextid;
+ int tcpsocket;
+ struct udpsocket { int af; int fd; } udpsockets[MAXUDP];
+ int nudpsockets;
vbuf tcpsend, tcprecv;
int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
enum adns__tcpstate {
struct sigaction stdsigpipe;
sigset_t stdsigmask;
struct pollfd pollfds_buf[MAX_POLLFDS];
- struct server {
- struct in_addr addr;
- } servers[MAXSERVERS];
+ adns_rr_addr servers[MAXSERVERS];
struct sortlist {
- struct in_addr base, mask;
+ adns_sockaddr base, mask;
} sortlist[MAXSORTLIST];
char **searchlist;
+ unsigned config_report_unknown:1;
unsigned short rand48xsubi[3];
};
+/* From addrfam.c: */
+
+extern int adns__addrs_equal_raw(const struct sockaddr *a,
+ int bf, const void *b);
+/* Returns nonzero a's family is bf and a's protocol address field
+ * refers to the same protocol address as that stored at ba.
+ */
+
+extern int adns__addrs_equal(const adns_sockaddr *a,
+ const adns_sockaddr *b);
+/* Returns nonzero if the two refer to the same protocol address
+ * (disregarding port, IPv6 scope, etc).
+ */
+
+extern int adns__sockaddrs_equal(const struct sockaddr *sa,
+ const struct sockaddr *sb);
+/* Return nonzero if the two socket addresses are equal (in all significant
+ * respects).
+ */
+
+extern int adns__addr_width(int af);
+/* Return the width of addresses of family af, in bits. */
+
+extern void adns__prefix_mask(adns_sockaddr *sa, int len);
+/* Stores in sa's protocol address field an address mask for address
+ * family af, whose first len bits are set and the remainder are
+ * clear. On entry, sa's af field must be set. This is what you want
+ * for converting a prefix length into a netmask.
+ */
+
+extern int adns__guess_prefix_length(const adns_sockaddr *addr);
+/* Given a network base address, guess the appropriate prefix length based on
+ * the appropriate rules for the address family (e.g., for IPv4, this uses
+ * the old address classes).
+ */
+
+extern int adns__addr_matches(int af, const void *addr,
+ const adns_sockaddr *base,
+ const adns_sockaddr *mask);
+/* Return nonzero if the protocol address specified by af and addr
+ * lies within the network specified by base and mask.
+ */
+
+extern void adns__addr_inject(const void *a, adns_sockaddr *sa);
+/* Injects the protocol address *a into the socket adress sa. Assumes
+ * that sa->sa_family is already set correctly.
+ */
+
+extern const void *adns__sockaddr_addr(const struct sockaddr *sa);
+/* Returns the address of the protocol address field in sa.
+ */
+
+char *adns__sockaddr_ntoa(const struct sockaddr *sa, char *buf);
+/* Converts sa to a string, and writes it to buf, which must be at
+ * least ADNS_ADDR2TEXT_BUFLEN bytes long (unchecked). Returns buf;
+ * can't fail.
+ */
+
+extern int adns__make_reverse_domain(const struct sockaddr *sa,
+ const char *zone,
+ char **buf_io, size_t bufsz,
+ char **buf_free_r);
+/* Construct a reverse domain string, given a socket address and a parent
+ * zone. If zone is null, then use the standard reverse-lookup zone for the
+ * address family. If the length of the resulting string is no larger than
+ * bufsz, then the result is stored starting at *buf_io; otherwise a new
+ * buffer is allocated is used, and a pointer to it is stored in both *buf_io
+ * and *buf_free_r (the latter of which should be null on entry). If
+ * something goes wrong, then an errno value is returned: ENOSYS if the
+ * address family of sa isn't recognized, or ENOMEM if the attempt to
+ * allocate an output buffer failed.
+ */
+
+extern bool adns__revparse_label(struct revparse_state *rps, int labnum,
+ const char *dgram,
+ int labstart, int lablen);
+/* Parse a label in a reverse-domain name, given its index labnum (starting
+ * from zero), a pointer to its contents (which need not be null-terminated),
+ * and its length. The state in *rps is initialized implicitly when labnum
+ * is zero.
+ *
+ * Returns 1 if the parse is proceeding successfully, 0 if the domain
+ * name is definitely invalid and the parse must be abandoned.
+ */
+
+extern bool adns__revparse_done(struct revparse_state *rps,
+ const char *dgram, int nlabels,
+ adns_rrtype *rrtype_r, adns_sockaddr *addr_r);
+/* Finishes parsing a reverse-domain name, given the total number of
+ * labels in the name. On success, fills in the af and protocol
+ * address in *addr_r, and the forward query type in *rrtype_r
+ * (because that turns out to be useful). Returns 1 if the parse
+ * was successful.
+ */
+
/* From setup.c: */
int adns__setnonblock(adns_state ads, int fd); /* => errno value */
* might be broken, but no reconnect will be attempted.
*/
+struct udpsocket *adns__udpsocket_by_af(adns_state ads, int af);
+/* Find the UDP socket structure in ads which has the given address family.
+ * Return null if there isn't one.
+ *
+ * This is used during initialization, so ads is only partially filled in.
+ * The requirements are that nudp is set, and that udpsocket[i].af are
+ * defined for 0<=i<nudp.
+ */
+
void adns__query_send(adns_query qu, struct timeval now);
/* Query must be in state tosend/NONE; it will be moved to a new state,
* and no further processing can be done on it for now.
/* From query.c: */
adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
+ adns_query parent,
const typeinfo *typei, adns_rrtype type,
vbuf *qumsg_vb, int id,
adns_queryflags flags, struct timeval now,
* answer->cname and answer->owner are _preserved.
*/
-void adns__transfer_interim(adns_query from, adns_query to,
- void *block, size_t sz);
+void adns__transfer_interim(adns_query from, adns_query to, void *block);
/* Transfers an interim allocation from one query to another, so that
* the `to' query will have room for the data when we get to makefinal
* and so that the free will happen when the `to' query is freed
* TTLs get inherited by their parents.
*/
+void adns__free_interim(adns_query qu, void *p);
+/* Forget about a block allocated by adns__alloc_interim.
+ */
+
void *adns__alloc_mine(adns_query qu, size_t sz);
/* Like _interim, but does not record the length for later
* copying into the answer. This just ensures that the memory
* in a datagram and discover that we need to retry the query.
*/
+void adns__cancel(adns_query qu);
void adns__query_done(adns_query qu);
-void adns__query_fail(adns_query qu, adns_status stat);
+void adns__query_fail(adns_query qu, adns_status st);
+void adns__cancel_children(adns_query qu);
+
+void adns__returning(adns_state ads, adns_query qu);
+/* Must be called before returning from adns any time that we have
+ * progressed (including made, finished or destroyed) queries.
+ *
+ * Might reenter adns via internal query callbacks, so
+ * external-faciing functions which call adns__returning should
+ * normally be avoided in internal code. */
+
+void adns__intdone_process(adns_state ads);
/* From reply.c: */
* now + ttl.
*/
-int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
+bool adns__labels_equal(const byte *a, int al, const byte *b, int bl);
/* From event.c: */
* lest we end up in recursive descent !
*/
+static inline void
+adns__timeout_set(adns_query qu, struct timeval now, long ms)
+ { qu->timeout_ms= ms; qu->timeout_started= now; }
+
+static inline void
+adns__timeout_clear(adns_query qu)
+ { qu->timeout_ms= 0; timerclear(&qu->timeout_started); }
+
+
+int adns__gettimeofday(adns_state ads, struct timeval *tv_buf);
+
void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
struct timeval *tv_buf);
+/* Call with care - might reentrantly cause queries to be completed! */
int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]);
void adns__fdevents(adns_state ads,
static inline int ctype_alpha(int c) {
return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
}
+static inline int ctype_toupper(int c) {
+ return ctype_alpha(c) ? (c & ~32) : c;
+}
static inline int ctype_822special(int c) {
return strchr("()<>@,;:\\\".[]",c) != 0;
}
(( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
* sizeof(union maxalign) )
-#define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
+#define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ffu)
#define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
#define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
#define GET_L(cb,tv) ( (tv)=0, \