File: rbldnsd.h

package info (click to toggle)
rbldnsd 0.998b~pre1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 744 kB
  • ctags: 1,132
  • sloc: ansic: 8,212; python: 549; sh: 502; makefile: 249; awk: 33
file content (462 lines) | stat: -rw-r--r-- 16,086 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
/* common rbldnsd #include header
 */

#include <stdarg.h>
#include <sys/types.h>
#include <stdio.h>
#include "config.h"
#include "ip4addr.h"
#include "ip6addr.h"
#include "dns.h"
#include "mempool.h"

#if !defined(__GNUC__) && !defined(__attribute__)
# define __attribute__(x)
#endif
#ifndef PRINTFLIKE
# define PRINTFLIKE(fmtp, ap) __attribute__((format(printf,fmtp,ap)))
#endif
#ifndef UNUSED
# define UNUSED __attribute__((unused))
#endif
#ifndef NORETURN
# define NORETURN __attribute__((noreturn))
#endif

extern char *progname; /* limited to 32 chars */
extern int logto;
#define LOGTO_STDOUT 0x01
#define LOGTO_STDERR 0x02
#define LOGTO_SYSLOG 0x04
void PRINTFLIKE(2,3) NORETURN error(int errnum, const char *fmt, ...);

struct zone;
struct dataset;
struct dsdata;
struct dsctx;
struct sockaddr;

struct dnspacket {		/* private structure */
  unsigned char p_buf[DNS_EDNS0_MAXPACKET]; /* packet buffer */
  unsigned char *p_endp;	/* end of packet buffer */
  unsigned char *p_cur;		/* current pointer */
  unsigned char *p_sans;	/* start of answers */
  const char *p_substrr;	/* for always-listed queries */
  const struct dataset *p_substds;
  const struct sockaddr *p_peer;/* address of the requesting client */
  unsigned p_peerlen;
};

struct dnsquery {	/* q */
  unsigned q_type;			/* query RR type */
  unsigned q_class;			/* query class */
  unsigned char q_dn[DNS_MAXDN];	/* original query DN, lowercased */
  unsigned q_dnlen;			/* length of q_dn */
  unsigned q_dnlab;			/* number of labels in q_dn */
  unsigned char *q_lptr[DNS_MAXLABELS];	/* pointers to labels */
};

struct dnsqinfo {	/* qi */
  unsigned char *const *qi_dnlptr;
  const unsigned char *qi_dn;		/* cached query DN */
  unsigned qi_tflag;			/* query RR type flag (NSQUERY_XX) */
  unsigned qi_dnlen0;			/* length of qi_dn - 1 */
  unsigned qi_dnlab;			/* number of labels in q_dn */
  int qi_ip4valid;			/* true if qi_ip4 is valid */
  int qi_ip6valid;			/* true if qi_ip6 is valid */
  ip4addr_t qi_ip4;			/* parsed IP4 address */
  ip6oct_t qi_ip6[IP6ADDR_FULL];	/* parsed IP6 address */
};

#define PACK32(b,n) ((b)[0]=(n)>>24,(b)[1]=(n)>>16,(b)[2]=(n)>>8,(b)[3]=(n))
#define PACK32S(b,n) (*b++=(n)>>24,*b++=(n)>>16,*b++=(n)>>8,*b++=n)
#define PACK16(b,n) ((b)[0]=(n)>>8,(b)[1]=(unsigned char)(n))
#define PACK16S(b,n) (*b++=(n)>>8,*b++=(unsigned char)(n))

unsigned unpack32(const unsigned char nb[4]);

#define ISSPACE(c) ((c) == ' ' || (c) == '\t')
#define ISCOMMENT(c) ((c) == '#' || (c) == ';')
#define SKIPSPACE(s) while(ISSPACE(*s)) ++s

char *parse_uint32(char *s, unsigned *np);
char *parse_uint32_nb(char *s, unsigned char nb[4]);
char *parse_time(char *s, unsigned *tp);
char *parse_time_nb(char *s, unsigned char nb[4]);
char *parse_ttl(char *s, unsigned *ttlp, unsigned defttl);
char *parse_timestamp(char *s, time_t *tsp);
char *parse_dn(char *s, unsigned char *dn, unsigned *dnlenp);
/* parse line in form :ip:text into rr
 * where first 4 bytes is ip in network byte order.
 * Note this routine uses 4 bytes BEFORE str (it's safe to call it after
 * readdslines() */
int parse_a_txt(char *str, const char **rrp, const char *def_rr,
                struct dsctx *dsc);
char *firstword_lc(char *line, const char *word_lc);

typedef void ds_startfn_t(struct dataset *ds);
typedef int ds_linefn_t(struct dataset *ds, char *line, struct dsctx *dsc);
typedef void ds_finishfn_t(struct dataset *ds, struct dsctx *dsc);
typedef void ds_resetfn_t(struct dsdata *dsd, int freeall);
typedef int
ds_queryfn_t(const struct dataset *ds, const struct dnsqinfo *qi,
             struct dnspacket *pkt);
#ifdef NO_MASTER_DUMP
typedef void ds_dumpfn_t(void);
#define _master_dump_body(n) static void n(void) {}
#else
typedef void
ds_dumpfn_t(const struct dataset *ds, const unsigned char *odn, FILE *f);
#define _master_dump_body(n)
#endif

#define NSQUERY_OTHER	0
#define NSQUERY_SOA	(1u<<0)
#define NSQUERY_NS	(1u<<1)
#define NSQUERY_A	(1u<<2)
#define NSQUERY_MX	(1u<<3)
#define NSQUERY_TXT	(1u<<4)
#define NSQUERY_ANY	0xffffu

/* special cases for ACLs */
#define NSQUERY_IGNORE	0x010000u
#define NSQUERY_REFUSE	0x020000u
#define NSQUERY_EMPTY	0x040000u
#define NSQUERY_ALWAYS	0x080000u

/* result flags from dataset queryfn */
#define NSQUERY_FOUND	0x01
#define NSQUERY_ADDPEER	0x02

struct dstype {	/* dst */
  const char *dst_name;		/* name of the type */
  unsigned dst_flags;		/* how to pass arguments to queryfn */
  unsigned dst_size;		/* size of struct dataset */
  ds_resetfn_t *dst_resetfn;	/* routine to release ds internal data */
  ds_startfn_t *dst_startfn;	/* routine called at start of every file */
  ds_linefn_t *dst_linefn;	/* routine to parse input line */
  ds_finishfn_t *dst_finishfn;	/* finish loading */
  ds_queryfn_t *dst_queryfn;	/* routine to perform query */
  ds_dumpfn_t *dst_dumpfn;	/* dump zone in BIND format */
  const char *dst_descr;    	/* short description of a ds type */
};

/* dst_flags */
#define DSTF_IP4REV	0x01	/* ip4 set */
#define DSTF_IP6REV	0x02	/* ip6 set */
#define DSTF_SPECIAL	0x08	/* special ds: non-recursive */

#define declaredstype(t) extern const struct dstype dataset_##t##_type
#define definedstype(t, flags, descr) \
 static ds_resetfn_t ds_##t##_reset; \
 static ds_startfn_t ds_##t##_start; \
 static ds_linefn_t ds_##t##_line; \
 static ds_finishfn_t ds_##t##_finish; \
 static ds_queryfn_t ds_##t##_query; \
 static ds_dumpfn_t ds_##t##_dump; \
 _master_dump_body(ds_##t##_dump) \
 const struct dstype dataset_##t##_type = { \
   #t /* name */, flags, sizeof(struct dsdata), \
   ds_##t##_reset, ds_##t##_start, ds_##t##_line, ds_##t##_finish, \
   ds_##t##_query, ds_##t##_dump, \
   descr }

declaredstype(ip4set);
declaredstype(ip4tset);
declaredstype(ip4trie);
declaredstype(ip6tset);
declaredstype(ip6trie);
declaredstype(dnset);
declaredstype(dnhash);
declaredstype(generic);
declaredstype(combined);
declaredstype(acl);

#define dstype(type) (&dataset_##type##_type)
#define isdstype(dst, type)	((dst) == dstype(type))

extern const struct dstype *ds_types[];

/*
 * Each zone is composed of a set of datasets.
 * There is a global list of datasets, each
 * with a timestamp etc.
 * Each zonedata is composed of a list of files.
 */

struct dsfile {	/* dsf */
  time_t dsf_stamp;		/* last timestamp of this file */
  off_t  dsf_size;		/* last size of this file */
  struct dsfile *dsf_next;	/* next file in list */
  const char *dsf_name;		/* name of this file */
};

struct dssoa { /* dssoa */
  unsigned dssoa_ttl;			/* TTL value */
  const unsigned char *dssoa_odn;	/* origin DN */
  const unsigned char *dssoa_pdn;	/* person DN */
  unsigned dssoa_serial;		/* SOA serial # */
  unsigned char dssoa_n[16];		/* refresh, retry, expire, minttl */
};

struct dsns { /* dsns, nameserver */
  struct dsns *dsns_next;		/* next nameserver in list */
  unsigned char dsns_dn[1];		/* nameserver DN, varlen */
};

struct dataset {	/* ds */
  const struct dstype *ds_type;	/* type of this data */
  struct dsdata *ds_dsd;		/* type-specific data */
  time_t ds_stamp;			/* timestamp */
  time_t ds_expires;			/* when the dataset expires if any */
  const char *ds_spec;			/* original specification */
  struct dsfile *ds_dsf;		/* list of files for this data */
  struct dssoa *ds_dssoa;		/* SOA record */
  struct dsns *ds_dsns;			/* list of nameservers */
  unsigned ds_nsttl;			/* TTL for NS records */
#ifndef INCOMPAT_0_99
  int ds_nsflags;
#define DSF_NEWNS  0x01			/* new-style NS on one line */
#define DSF_NSWARN 0x02			/* warned about new-style NS */
#endif
  unsigned ds_ttl;			/* default ttl for a dataset */
  char *ds_subst[11];			/* substitution variables */
#define SUBST_BASE_TEMPLATE	10
  struct mempool *ds_mp;		/* memory pool for data */
  struct dataset *ds_next;		/* next in global list */
};

struct dslist {	/* dsl */
  struct dataset *dsl_ds;
  ds_queryfn_t *dsl_queryfn;	/* cached dsl_ds->ds_type->dst_queryfn */
  struct dslist *dsl_next;
};

struct zonesoa;
struct zonens;

#ifndef NO_STATS
#if !defined(NO_STDINT_H)
typedef uint64_t dnscnt_t;
#define PRI_DNSCNT PRIu64
#elif SIZEOF_LONG < 8 && defined(SIZEOF_LONG_LONG)
typedef unsigned long long dnscnt_t;
#define PRI_DNSCNT "llu"
#else
typedef unsigned long dnscnt_t;
#define PRI_DNSCNT "lu"
#endif
struct dnsstats {
  dnscnt_t b_in, b_out;		/* number of bytes: in, out */
  dnscnt_t q_ok, q_nxd, q_err;	/* number of requests: OK, NXDOMAIN, ERROR */
};
extern struct dnsstats gstats;	/* global statistics counters */
#endif /* NO_STATS */

#define MAX_NS 32

struct zone {	/* zone, list of zones */
  unsigned z_stamp;			/* timestamp, 0 if not loaded */
  time_t z_expires;			/* when the zone expires if any */
  unsigned char z_dn[DNS_MAXDN+1];	/* zone domain name */
  unsigned z_dnlen;			/* length of z_dn */
  unsigned z_dnlab;			/* number of dn labels */
  unsigned z_dstflags;			/* flags of all datasets */
  struct dslist *z_dsl;			/* list of datasets */
  struct dslist **z_dslp;		/* last z_dsl in list */
  struct dataset *z_dsacl;		/* zone ACL */
  /* SOA record */
  const struct dssoa *z_dssoa;		/* original SOA from a dataset */
  struct zonesoa *z_zsoa;		/* pre-packed SOA record */
  const unsigned char *z_nsdna[MAX_NS];	/* array of nameserver DNs */
  unsigned z_nns;			/* number of NSes in z_dsnsa[] */
  unsigned z_nsttl;			/* ttl for NS records */
  unsigned z_cns;			/* current NS in rotation */
  unsigned z_nglue;			/* number of glue records */
  struct zonens *z_zns;			/* pre-packed NS records */
#ifndef NO_STATS
  struct dnsstats z_stats;		/* statistic counters */
  struct dnsstats z_pstats;		/* for stats monitoring: prev values */
#endif
#ifndef NO_DSO
  void *z_hookdata;			/* data ptr for hooks */
#endif
  struct zone *z_next;			/* next in list */
};

void init_zones_caches(struct zone *zonelist);
int update_zone_soa(struct zone *zone, const struct dssoa *dssoa);
int update_zone_ns(struct zone *zone, const struct dsns *dsns, unsigned ttl,
                   const struct zone *zonelist);

/* parse query and construct a reply to it, return len of answer or 0 */
int replypacket(struct dnspacket *p, unsigned qlen, struct zone *zone);
const struct zone *
findqzone(const struct zone *zonelist,
          unsigned dnlen, unsigned dnlab, unsigned char *const *const dnlptr,
          struct dnsqinfo *qi);

/* log a reply */
void logreply(const struct dnspacket *pkt, FILE *flog, int flushlog);

/* details of DNS packet structure are in rbldnsd_packet.c */

/* add a record into answer section */
void addrr_a_txt(struct dnspacket *pkt, unsigned qtflag,
                 const char *rr, const char *subst,
                 const struct dataset *ds);
void addrr_any(struct dnspacket *pkt, unsigned dtp,
               const void *data, unsigned dsz, unsigned ttl);

#define check_query_overwrites(qi) \
  if ((qi)->qi_tflag & NSQUERY_EMPTY)  return 0; \
  if ((qi)->qi_tflag & NSQUERY_ALWAYS) return NSQUERY_ADDPEER

int ds_acl_query(const struct dataset *ds, struct dnspacket *pkt);

#ifndef NO_MASTER_DUMP
void dump_a_txt(const char *name, const char *rr,
                const char *subst, const struct dataset *ds, FILE *f);
void dump_ip4range(ip4addr_t a, ip4addr_t b, const char *rr,
		   const struct dataset *ds, FILE *f);
void dump_ip4(ip4addr_t a, const char *rr, const struct dataset *ds, FILE *f);
void dumpzone(const struct zone *z, FILE *f);
void dump_ip6(const ip6oct_t *addr, unsigned wild_nibbles, const char *rr,
              const struct dataset *ds, FILE *f);
void dump_ip6range(const ip6oct_t *beg, const ip6oct_t *end, const char *rr,
                   const struct dataset *ds, FILE *f);
#endif
#define TXTBUFSIZ 260
int txtsubst(char txtbuf[TXTBUFSIZ], const char *template,
	     const char *sub0, const struct dataset *ds);

struct zone *addzone(struct zone *zonelist, const char *spec);
void connectdataset(struct zone *zone,
                    struct dataset *ds,
                    struct dslist *dsl);
struct zone *newzone(struct zone **zonelist,
                     unsigned char *dn, unsigned dnlen,
                     struct mempool *mp);
struct dataset *nextdataset2reload(struct dataset *ds);
int loaddataset(struct dataset *ds);

struct dsctx {
  struct dataset *dsc_ds;	/* currently loading dataset */
  struct dataset *dsc_subset;	/* currently loading subset (combined) */
  const char *dsc_fname;	/* currently loading file name */
  int dsc_lineno;		/* current line number */
  int dsc_warns;		/* number of warnings so far */
  unsigned dsc_ip4maxrange;	/* max IP4 range allowed */
};

void PRINTFLIKE(3,4) dslog(int level, struct dsctx *dsc, const char *fmt, ...);
void PRINTFLIKE(2,3) dswarn(struct dsctx *dsc, const char *fmt, ...);
void PRINTFLIKE(2,3) dsloaded(struct dsctx *dsc, const char *fmt, ...);
void PRINTFLIKE(3,4)
zlog(int level, const struct zone *zone, const char *fmt, ...);

/* from rbldnsd_combined.c, special routine used inside ds_special() */
int ds_combined_newset(struct dataset *ds, char *line, struct dsctx *dsc);

extern unsigned def_ttl, min_ttl, max_ttl;
extern const char def_rr[5];
extern int accept_in_cidr;
extern int nouncompress;
extern struct dataset *g_dsacl;	/* global acl */

extern const char *show_version; /* version.bind CH TXT */

void oom(void);
char *emalloc(size_t size);
char *ezalloc(size_t size); /* zero-fill */
char *erealloc(void *ptr, size_t size);
char *estrdup(const char *str);
char *ememdup(const void *buf, unsigned size);

#define tmalloc(type) ((type*)emalloc(sizeof(type)))
#define tzalloc(type) ((type*)ezalloc(sizeof(type)))
#define trealloc(type,ptr,n) ((type*)erealloc((ptr),(n)*(sizeof(type))))

int vssprintf(char *buf, int bufsz, const char *fmt, va_list ap);
int PRINTFLIKE(3, 4) ssprintf(char *buf, int bufsz, const char *fmt, ...);

/* a helper to shrink an array */
/* some malloc implementations may return NULL on realloc()
 * even if newsize is smaller than current size, so deal with
 * this here.  Note that if realloc() fails, we're under memory
 * pressure here, so next reload will probably hit ENOMEM anyway...
 */
#define SHRINK_ARRAY(type, arr, needed, allocated)	\
  if ((allocated) > (needed)) {				\
     type *_temp = trealloc(type, (arr), (needed));	\
     if (_temp) {					\
       (arr) = _temp; (allocated) = (needed);		\
     }							\
  }

/* a helper macro to remove dups from a sorted array */

#define REMOVE_DUPS(type, arr, num, eq)	\
{ register type *_p, *_e, *_t;		\
  _p = arr; _t = _p + num - 1;		\
  while(_p < _t)			\
    if (!(eq((_p[0]), (_p[1])))) ++_p;	\
    else {				\
      ++_t; _e = _p + 1;		\
      do				\
        if (eq((*_p), (*_e))) ++_e;	\
        else *++_p = *_e++;		\
      while (_e < _t);			\
      num = _p + 1 - arr;		\
      break;				\
    }					\
}

/* helper macro to test whenever two given RRs (A and TXT) are equal,
 * provided that arr is zero, this is an exclusion entry.
 *  if arr is zero, we're treating them equal.
 *   else compare pointers
 *   else memcmp first 4 (A) bytes and strcmp rest (TXT)
 */
#define rrs_equal(a, b) \
  (!(a).rr \
   || (a).rr == (b).rr \
   || (memcmp((a).rr, (b).rr, 4) == 0 \
       && strcmp((a).rr + 4, (b).rr + 4) == 0 \
      ) \
  )

/* hooks from a DSO extensions */
#ifndef NO_DSO

/* prototype for init routine */
int rbldnsd_extension_init(char *arg, struct zone *zonelist);

/* return true/false depending whenever hook needs to be reloaded */
extern int (*hook_reload_check)(const struct zone *zonelist);

/* perform actual reload, after all zones has been reloaded. */
extern int (*hook_reload)(struct zone *zonelist);

/* check whenever this query is allowed for this client:
 *  * 0 = ok, <0 = drop the packet, >0 = refuse */
extern int (*hook_query_access)
  (const struct sockaddr *requestor,
   const struct zone *zone,
   const struct dnsqinfo *qinfo);

/* notice result of the OK query */
extern int (*hook_query_result)
  (const struct sockaddr *requestor,
   const struct zone *zone,
   const struct dnsqinfo *qinfo,
   int positive);

#define call_hook(name, args)	\
	(hook_##name ? hook_##name args : 0)

#else	/* dummy "functions" */

#define call_hook(name, args) 0

#endif