Functions
val_anchor.c File Reference

This file contains storage for the trust anchors for the validator. More...

#include "config.h"
#include <ctype.h>
#include "validator/val_anchor.h"
#include "validator/val_sigcrypt.h"
#include "validator/autotrust.h"
#include "util/data/packed_rrset.h"
#include "util/data/dname.h"
#include "util/log.h"
#include "util/net_help.h"
#include "util/config_file.h"
#include "util/as112.h"
#include "sldns/sbuffer.h"
#include "sldns/rrdef.h"
#include "sldns/str2wire.h"

Functions

int anchor_cmp (const void *k1, const void *k2)
 compare two trust anchors
 
struct val_anchorsanchors_create (void)
 Create trust anchor storage. More...
 
static void assembled_rrset_delete (struct ub_packed_rrset_key *pkey)
 delete assembled rrset
 
static void anchors_delfunc (rbnode_type *elem, void *ATTR_UNUSED(arg))
 destroy locks in tree and delete autotrust anchors
 
void anchors_delete (struct val_anchors *anchors)
 Delete trust anchor storage. More...
 
void anchors_init_parents_locked (struct val_anchors *anchors)
 Recalculate parent pointers. More...
 
static void init_parents (struct val_anchors *anchors)
 initialise parent pointers in the tree
 
struct trust_anchoranchor_find (struct val_anchors *anchors, uint8_t *name, int namelabs, size_t namelen, uint16_t dclass)
 Find a trust anchor. More...
 
static struct trust_anchoranchor_new_ta (struct val_anchors *anchors, uint8_t *name, int namelabs, size_t namelen, uint16_t dclass, int lockit)
 create new trust anchor object
 
static struct ta_keyanchor_find_key (struct trust_anchor *ta, uint8_t *rdata, size_t rdata_len, uint16_t type)
 find trustanchor key by exact data match
 
static struct ta_keyanchor_new_ta_key (uint8_t *rdata, size_t rdata_len, uint16_t type)
 create new trustanchor key
 
static struct trust_anchoranchor_store_new_key (struct val_anchors *anchors, uint8_t *name, uint16_t type, uint16_t dclass, uint8_t *rdata, size_t rdata_len)
 This routine adds a new RR to a trust anchor. More...
 
static struct trust_anchoranchor_store_new_rr (struct val_anchors *anchors, uint8_t *rr, size_t rl, size_t dl)
 Add new RR. More...
 
static struct trust_anchoranchor_insert_insecure (struct val_anchors *anchors, const char *str)
 Insert insecure anchor. More...
 
struct trust_anchoranchor_store_str (struct val_anchors *anchors, sldns_buffer *buffer, const char *str)
 Store one string as trust anchor RR. More...
 
static struct trust_anchoranchor_read_file (struct val_anchors *anchors, sldns_buffer *buffer, const char *fname, int onlyone)
 Read a file with trust anchors. More...
 
static void skip_to_eol (FILE *in)
 skip file to end of line
 
static int is_bind_special (int c)
 true for special characters in bind configs
 
static int readkeyword_bindfile (FILE *in, sldns_buffer *buf, int *line, int comments)
 Read a keyword skipping bind comments; spaces, specials, restkeywords. More...
 
static int skip_to_special (FILE *in, sldns_buffer *buf, int *line, int spec)
 skip through file to { or ;
 
static int process_bind_contents (struct val_anchors *anchors, sldns_buffer *buf, int *line, FILE *in)
 read contents of trusted-keys{ ... More...
 
static int anchor_read_bind_file (struct val_anchors *anchors, sldns_buffer *buffer, const char *fname)
 Read a BIND9 like file with trust anchors in named.conf format. More...
 
static int anchor_read_bind_file_wild (struct val_anchors *anchors, sldns_buffer *buffer, const char *pat)
 Read a BIND9 like files with trust anchors in named.conf format. More...
 
static struct ub_packed_rrset_keyassemble_it (struct trust_anchor *ta, size_t num, uint16_t type)
 Assemble an rrset structure for the type. More...
 
static int anchors_assemble (struct trust_anchor *ta)
 Assemble structures for the trust DS and DNSKEY rrsets. More...
 
static size_t anchors_ds_unsupported (struct trust_anchor *ta)
 Check DS algos for support, warn if not. More...
 
static size_t anchors_dnskey_unsupported (struct trust_anchor *ta)
 Check DNSKEY algos for support, warn if not. More...
 
static int anchors_assemble_rrsets (struct val_anchors *anchors)
 Assemble the rrsets in the anchors, ready for use by validator. More...
 
int anchors_apply_cfg (struct val_anchors *anchors, struct config_file *cfg)
 Process trust anchor config. More...
 
struct trust_anchoranchors_lookup (struct val_anchors *anchors, uint8_t *qname, size_t qname_len, uint16_t qclass)
 Given a qname/qclass combination, find the trust anchor closest above it. More...
 
size_t anchors_get_mem (struct val_anchors *anchors)
 Get memory in use by the trust anchor storage. More...
 
int anchors_add_insecure (struct val_anchors *anchors, uint16_t c, uint8_t *nm)
 Add insecure point trust anchor. More...
 
void anchors_delete_insecure (struct val_anchors *anchors, uint16_t c, uint8_t *nm)
 Delete insecure point trust anchor. More...
 
static int keytag_compare (const void *x, const void *y)
 compare two keytags, return -1, 0 or 1
 
size_t anchor_list_keytags (struct trust_anchor *ta, uint16_t *list, size_t num)
 Get a list of keytags for the trust anchor. More...
 

Detailed Description

This file contains storage for the trust anchors for the validator.

Function Documentation

◆ anchors_create()

struct val_anchors* anchors_create ( void  )

Create trust anchor storage.

Returns
new storage or NULL on error.

References anchor_cmp(), anchors_delete(), val_anchors::autr, autr_global_create(), val_anchors::lock, rbtree_create(), and val_anchors::tree.

Referenced by anchors_test(), and val_apply_cfg().

◆ anchors_delete()

void anchors_delete ( struct val_anchors anchors)

Delete trust anchor storage.

Parameters
anchorsto delete.

References anchors_delfunc(), val_anchors::autr, autr_global_delete(), val_anchors::lock, traverse_postorder(), and val_anchors::tree.

Referenced by anchors_create(), anchors_test(), and val_deinit().

◆ anchors_init_parents_locked()

void anchors_init_parents_locked ( struct val_anchors anchors)

Recalculate parent pointers.

The caller must hold the lock on the anchors structure (say after removing an item from the rbtree). Caller must not hold any locks on trust anchors. After the call is complete the parent pointers are updated and an item just removed is no longer referenced in parent pointers.

Parameters
anchorsthe structure to update.

References trust_anchor::dclass, dname_lab_cmp(), trust_anchor::lock, trust_anchor::name, trust_anchor::namelabs, trust_anchor::node, trust_anchor::parent, RBTREE_FOR, and val_anchors::tree.

Referenced by anchors_add_insecure(), anchors_delete_insecure(), and init_parents().

◆ anchor_find()

struct trust_anchor* anchor_find ( struct val_anchors anchors,
uint8_t *  name,
int  namelabs,
size_t  namelen,
uint16_t  dclass 
)

Find a trust anchor.

Exact matching.

Parameters
anchorsanchor storage.
namename of trust anchor (wireformat)
namelabslabels in name
namelenlength of name
dclassclass of trust anchor
Returns
NULL if not found. The anchor is locked.

References trust_anchor::dclass, rbnode_type::key, val_anchors::lock, trust_anchor::name, trust_anchor::namelabs, trust_anchor::namelen, trust_anchor::node, rbtree_search(), and val_anchors::tree.

Referenced by do_list_forwards(), do_list_stubs(), find_add_tp(), iter_indicates_dnssec(), and process_prime_response().

◆ anchor_store_new_key()

static struct trust_anchor* anchor_store_new_key ( struct val_anchors anchors,
uint8_t *  name,
uint16_t  type,
uint16_t  dclass,
uint8_t *  rdata,
size_t  rdata_len 
)
static

This routine adds a new RR to a trust anchor.

The trust anchor may not exist yet, and is created if not. The RR can be DS or DNSKEY. This routine will also remove duplicates; storing them only once.

Parameters
anchorsanchor storage.
namename of trust anchor (wireformat)
typetype or RR
dclassclass of RR
rdatardata wireformat, starting with rdlength. If NULL, nothing is stored, but an entry is created.
rdata_lenlength of rdata including rdlength.
Returns
: NULL on error, else the trust anchor.

References dname_count_size_labels(), LDNS_RR_TYPE_DS, trust_anchor::namelabs, and trust_anchor::namelen.

Referenced by anchor_insert_insecure(), and anchor_store_new_rr().

◆ anchor_store_new_rr()

static struct trust_anchor* anchor_store_new_rr ( struct val_anchors anchors,
uint8_t *  rr,
size_t  rl,
size_t  dl 
)
static

Add new RR.

It converts ldns RR to wire format.

Parameters
anchorsanchor storage.
rrthe wirerr.
rllength of rr.
dllength of dname.
Returns
NULL on error, else the trust anchor.

References anchor_store_new_key(), log_nametypeclass(), sldns_wirerr_get_class(), sldns_wirerr_get_rdatalen(), sldns_wirerr_get_rdatawl(), sldns_wirerr_get_type(), and VERB_QUERY.

◆ anchor_insert_insecure()

static struct trust_anchor* anchor_insert_insecure ( struct val_anchors anchors,
const char *  str 
)
static

Insert insecure anchor.

Parameters
anchorsanchor storage.
strthe domain name.
Returns
NULL on error, Else last trust anchor point

References anchor_store_new_key(), LDNS_RR_CLASS_IN, LDNS_RR_TYPE_DS, log_err(), and sldns_str2wire_dname().

Referenced by anchors_apply_cfg().

◆ anchor_store_str()

struct trust_anchor* anchor_store_str ( struct val_anchors anchors,
struct sldns_buffer buffer,
const char *  str 
)

Store one string as trust anchor RR.

Parameters
anchorsanchor storage.
bufferparsing buffer, to generate the RR wireformat in.
strstring.
Returns
NULL on error.

References log_err(), sldns_buffer_begin(), sldns_buffer_capacity(), and sldns_str2wire_rr_buf().

Referenced by anchors_apply_cfg(), process_bind_contents(), test_anchor_one(), and test_anchors().

◆ anchor_read_file()

static struct trust_anchor* anchor_read_file ( struct val_anchors anchors,
sldns_buffer buffer,
const char *  fname,
int  onlyone 
)
static

Read a file with trust anchors.

Parameters
anchorsanchor storage.
bufferparsing buffer.
fnamestring.
onlyoneonly one trust anchor allowed in file.
Returns
NULL on error. Else last trust-anchor point.

References sldns_file_parse_state::default_ttl, sldns_file_parse_state::lineno, log_err(), sldns_buffer_begin(), sldns_buffer_capacity(), and sldns_fp2wire_rr_buf().

Referenced by anchors_apply_cfg().

◆ readkeyword_bindfile()

static int readkeyword_bindfile ( FILE *  in,
sldns_buffer buf,
int *  line,
int  comments 
)
static

Read a keyword skipping bind comments; spaces, specials, restkeywords.

The file is split into the following tokens:

  • special characters, on their own, rdlen=1, { } doublequote ;
  • whitespace becomes a single ' ' or tab. Newlines become spaces.
  • other words ('keywords')
  • comments are skipped if desired / / C++ style comment to end of line

    to end of line

/ * C style comment * /

Parameters
infile to read from.
bufbuffer, what is read is stored after current buffer position. Space is left in the buffer to write a terminating 0.
lineline number is increased per line, for error reports.
commentsif 0, comments are not possible and become text. if 1, comments are skipped entirely. In BIND files, this is when reading quoted strings, for example " base 64 text with / / in there "
Returns
the number of character written to the buffer. 0 on end of file.

References is_bind_special(), skip_to_eol(), sldns_buffer_position(), sldns_buffer_read_u8_at(), sldns_buffer_remaining(), and sldns_buffer_skip().

Referenced by anchor_read_bind_file(), process_bind_contents(), and skip_to_special().

◆ process_bind_contents()

static int process_bind_contents ( struct val_anchors anchors,
sldns_buffer buf,
int *  line,
FILE *  in 
)
static

read contents of trusted-keys{ ...

; clauses and insert keys into storage.

Parameters
anchorswhere to store keys
bufbuffer to use
lineline number in file
infile to read from.
Returns
0 on error.

References anchor_store_str(), log_err(), readkeyword_bindfile(), sldns_buffer_begin(), sldns_buffer_clear(), sldns_buffer_current(), sldns_buffer_position(), sldns_buffer_remaining(), sldns_buffer_skip(), sldns_buffer_write(), and sldns_buffer_write_u8().

Referenced by anchor_read_bind_file().

◆ anchor_read_bind_file()

static int anchor_read_bind_file ( struct val_anchors anchors,
sldns_buffer buffer,
const char *  fname 
)
static

Read a BIND9 like file with trust anchors in named.conf format.

Parameters
anchorsanchor storage.
bufferparsing buffer.
fnamestring.
Returns
false on error.

References log_err(), process_bind_contents(), readkeyword_bindfile(), skip_to_special(), sldns_buffer_begin(), sldns_buffer_clear(), VERB_QUERY, and verbose().

Referenced by anchor_read_bind_file_wild().

◆ anchor_read_bind_file_wild()

static int anchor_read_bind_file_wild ( struct val_anchors anchors,
sldns_buffer buffer,
const char *  pat 
)
static

Read a BIND9 like files with trust anchors in named.conf format.

Performs wildcard processing of name.

Parameters
anchorsanchor storage.
bufferparsing buffer.
patpattern string. (can be wildcarded)
Returns
false on error.

References anchor_read_bind_file(), log_err(), VERB_QUERY, and verbose().

Referenced by anchors_apply_cfg().

◆ assemble_it()

static struct ub_packed_rrset_key* assemble_it ( struct trust_anchor ta,
size_t  num,
uint16_t  type 
)
static

◆ anchors_assemble()

static int anchors_assemble ( struct trust_anchor ta)
static

Assemble structures for the trust DS and DNSKEY rrsets.

Parameters
tatrust anchor
Returns
: false on error.

References assemble_it(), trust_anchor::dnskey_rrset, trust_anchor::ds_rrset, LDNS_RR_TYPE_DS, trust_anchor::numDNSKEY, and trust_anchor::numDS.

Referenced by anchors_assemble_rrsets().

◆ anchors_ds_unsupported()

static size_t anchors_ds_unsupported ( struct trust_anchor ta)
static

Check DS algos for support, warn if not.

Parameters
tatrust anchor
Returns
number of DS anchors with unsupported algorithms.

References ds_digest_algo_is_supported(), ds_key_algo_is_supported(), trust_anchor::ds_rrset, and trust_anchor::numDS.

Referenced by anchors_assemble_rrsets().

◆ anchors_dnskey_unsupported()

static size_t anchors_dnskey_unsupported ( struct trust_anchor ta)
static

Check DNSKEY algos for support, warn if not.

Parameters
tatrust anchor
Returns
number of DNSKEY anchors with unsupported algorithms.

References dnskey_algo_is_supported(), trust_anchor::dnskey_rrset, and trust_anchor::numDNSKEY.

Referenced by anchors_assemble_rrsets().

◆ anchors_assemble_rrsets()

static int anchors_assemble_rrsets ( struct val_anchors anchors)
static

◆ anchors_apply_cfg()

int anchors_apply_cfg ( struct val_anchors anchors,
struct config_file cfg 
)

◆ anchors_lookup()

struct trust_anchor* anchors_lookup ( struct val_anchors anchors,
uint8_t *  qname,
size_t  qname_len,
uint16_t  qclass 
)

Given a qname/qclass combination, find the trust anchor closest above it.

Or return NULL if none exists.

Parameters
anchorsstruct anchor storage
qnamequery name, uncompressed wireformat.
qname_lenlength of qname.
qclassclass to query for.
Returns
the trust anchor or NULL if none is found. The anchor is locked.

References trust_anchor::dclass, dname_count_labels(), dname_lab_cmp(), rbnode_type::key, val_anchors::lock, trust_anchor::lock, trust_anchor::name, trust_anchor::namelabs, trust_anchor::namelen, trust_anchor::node, trust_anchor::parent, rbtree_find_less_equal(), and val_anchors::tree.

Referenced by check_no_anchor(), iter_indicates_dnssec_fwd(), test_anchor_empty(), test_anchor_one(), and test_anchors().

◆ anchors_get_mem()

size_t anchors_get_mem ( struct val_anchors anchors)

Get memory in use by the trust anchor storage.

Parameters
anchorsanchor storage.
Returns
memory in use in bytes.

References trust_anchor::namelen, RBTREE_FOR, and val_anchors::tree.

◆ anchors_add_insecure()

int anchors_add_insecure ( struct val_anchors anchors,
uint16_t  c,
uint8_t *  nm 
)

Add insecure point trust anchor.

For external use (locks and init_parents)

Parameters
anchorsanchor storage.
cclass.
nmname of insecure trust point.
Returns
false on alloc failure.

References anchor_new_ta(), anchors_init_parents_locked(), trust_anchor::dclass, dname_count_size_labels(), rbnode_type::key, val_anchors::lock, log_err(), trust_anchor::name, trust_anchor::namelabs, trust_anchor::namelen, trust_anchor::node, rbtree_search(), and val_anchors::tree.

Referenced by do_insecure_add().

◆ anchors_delete_insecure()

void anchors_delete_insecure ( struct val_anchors anchors,
uint16_t  c,
uint8_t *  nm 
)

Delete insecure point trust anchor.

Does not remove if no such point. For external use (locks and init_parents)

Parameters
anchorsanchor storage.
cclass.
nmname of insecure trust point.

References anchors_delfunc(), anchors_init_parents_locked(), trust_anchor::autr, trust_anchor::dclass, dname_count_size_labels(), rbnode_type::key, trust_anchor::keylist, val_anchors::lock, trust_anchor::lock, trust_anchor::name, trust_anchor::namelabs, trust_anchor::namelen, trust_anchor::node, trust_anchor::numDNSKEY, trust_anchor::numDS, rbtree_delete(), rbtree_search(), and val_anchors::tree.

Referenced by do_insecure_remove().

◆ anchor_list_keytags()

size_t anchor_list_keytags ( struct trust_anchor ta,
uint16_t *  list,
size_t  num 
)

Get a list of keytags for the trust anchor.

Zero tags for insecure points.

Parameters
tatrust anchor (locked by caller).
listarray of uint16_t.
numlength of array.
Returns
number of keytags filled into array. If total number of keytags is bigger than the array, it is truncated at num. On errors, less keytags are filled in. The array is sorted.

References packed_rrset_data::count, lruhash_entry::data, dnskey_calc_keytag(), trust_anchor::dnskey_rrset, ds_get_keytag(), trust_anchor::ds_rrset, ub_packed_rrset_key::entry, keytag_compare(), trust_anchor::numDNSKEY, and trust_anchor::numDS.