Electroneum
iter_delegpt.h File Reference
#include "util/log.h"
Include dependency graph for iter_delegpt.h:

Go to the source code of this file.

Classes

struct  delegpt
 
struct  delegpt_ns
 
struct  delegpt_addr
 

Functions

struct delegptdelegpt_create (struct regional *regional)
 
struct delegptdelegpt_copy (struct delegpt *dp, struct regional *regional)
 
int delegpt_set_name (struct delegpt *dp, struct regional *regional, uint8_t *name)
 
int delegpt_add_ns (struct delegpt *dp, struct regional *regional, uint8_t *name, uint8_t lame)
 
int delegpt_rrset_add_ns (struct delegpt *dp, struct regional *regional, struct ub_packed_rrset_key *ns_rrset, uint8_t lame)
 
int delegpt_add_target (struct delegpt *dp, struct regional *regional, uint8_t *name, size_t namelen, struct sockaddr_storage *addr, socklen_t addrlen, uint8_t bogus, uint8_t lame)
 
int delegpt_add_rrset_A (struct delegpt *dp, struct regional *regional, struct ub_packed_rrset_key *rrset, uint8_t lame)
 
int delegpt_add_rrset_AAAA (struct delegpt *dp, struct regional *regional, struct ub_packed_rrset_key *rrset, uint8_t lame)
 
int delegpt_add_rrset (struct delegpt *dp, struct regional *regional, struct ub_packed_rrset_key *rrset, uint8_t lame)
 
int delegpt_add_addr (struct delegpt *dp, struct regional *regional, struct sockaddr_storage *addr, socklen_t addrlen, uint8_t bogus, uint8_t lame, char *tls_auth_name)
 
struct delegpt_nsdelegpt_find_ns (struct delegpt *dp, uint8_t *name, size_t namelen)
 
struct delegpt_addrdelegpt_find_addr (struct delegpt *dp, struct sockaddr_storage *addr, socklen_t addrlen)
 
void delegpt_log (enum verbosity_value v, struct delegpt *dp)
 
void delegpt_count_ns (struct delegpt *dp, size_t *numns, size_t *missing)
 
void delegpt_count_addr (struct delegpt *dp, size_t *numaddr, size_t *numres, size_t *numavail)
 
void delegpt_add_unused_targets (struct delegpt *dp)
 
size_t delegpt_count_missing_targets (struct delegpt *dp)
 
size_t delegpt_count_targets (struct delegpt *dp)
 
struct delegptdelegpt_from_message (struct dns_msg *msg, struct regional *regional)
 
void delegpt_add_neg_msg (struct delegpt *dp, struct msgreply_entry *msg)
 
void delegpt_no_ipv6 (struct delegpt *dp)
 
void delegpt_no_ipv4 (struct delegpt *dp)
 
struct delegptdelegpt_create_mlc (uint8_t *name)
 
void delegpt_free_mlc (struct delegpt *dp)
 
int delegpt_set_name_mlc (struct delegpt *dp, uint8_t *name)
 
int delegpt_add_ns_mlc (struct delegpt *dp, uint8_t *name, uint8_t lame)
 
int delegpt_add_addr_mlc (struct delegpt *dp, struct sockaddr_storage *addr, socklen_t addrlen, uint8_t bogus, uint8_t lame, char *tls_auth_name)
 
int delegpt_add_target_mlc (struct delegpt *dp, uint8_t *name, size_t namelen, struct sockaddr_storage *addr, socklen_t addrlen, uint8_t bogus, uint8_t lame)
 
size_t delegpt_get_mem (struct delegpt *dp)
 

Detailed Description

This file implements the Delegation Point. It contains a list of name servers and their addresses if known.

Definition in file iter_delegpt.h.

Function Documentation

◆ delegpt_add_addr()

int delegpt_add_addr ( struct delegpt dp,
struct regional regional,
struct sockaddr_storage addr,
socklen_t  addrlen,
uint8_t  bogus,
uint8_t  lame,
char *  tls_auth_name 
)

Add address to the delegation point. No servername is associated or checked.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
addrthe address.
addrlenthe length of addr.
bogusif address is bogus.
lameif address is lame.
tls_auth_nameTLS authentication name (or NULL).
Returns
false on error.

◆ delegpt_add_addr_mlc()

int delegpt_add_addr_mlc ( struct delegpt dp,
struct sockaddr_storage addr,
socklen_t  addrlen,
uint8_t  bogus,
uint8_t  lame,
char *  tls_auth_name 
)

add an address to a malloced delegation point.

Parameters
dpmust have been created with delegpt_create_mlc.
addrthe address.
addrlenthe length of addr.
bogusif address is bogus.
lameif address is lame.
tls_auth_nameTLS authentication name (or NULL).
Returns
false on error.

◆ delegpt_add_neg_msg()

void delegpt_add_neg_msg ( struct delegpt dp,
struct msgreply_entry msg 
)

Add negative message to delegation point.

Parameters
dpdelegation point.
msgthe message added, marks off A or AAAA from an NS entry.

◆ delegpt_add_ns()

int delegpt_add_ns ( struct delegpt dp,
struct regional regional,
uint8_t name,
uint8_t  lame 
)

Add a name to the delegation point.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
namedomain name in wire format.
lamename is lame, disprefer it.
Returns
false on error.

◆ delegpt_add_ns_mlc()

int delegpt_add_ns_mlc ( struct delegpt dp,
uint8_t name,
uint8_t  lame 
)

add a name to malloced delegation point.

Parameters
dpmust have been created with delegpt_create_mlc.
namethe name to add.
lamethe name is lame, disprefer.
Returns
false on error.

◆ delegpt_add_rrset()

int delegpt_add_rrset ( struct delegpt dp,
struct regional regional,
struct ub_packed_rrset_key rrset,
uint8_t  lame 
)

Add any RRset to delegpt. Does not check for duplicates added.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
rrsetRRset to add, NS, A, AAAA.
lamerrset is lame, disprefer it.
Returns
0 on alloc error.

◆ delegpt_add_rrset_A()

int delegpt_add_rrset_A ( struct delegpt dp,
struct regional regional,
struct ub_packed_rrset_key rrset,
uint8_t  lame 
)

Add A RRset to delegpt.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
rrsetRRset A to add.
lamerrset is lame, disprefer it.
Returns
0 on alloc error.

◆ delegpt_add_rrset_AAAA()

int delegpt_add_rrset_AAAA ( struct delegpt dp,
struct regional regional,
struct ub_packed_rrset_key rrset,
uint8_t  lame 
)

Add AAAA RRset to delegpt.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
rrsetRRset AAAA to add.
lamerrset is lame, disprefer it.
Returns
0 on alloc error.

◆ delegpt_add_target()

int delegpt_add_target ( struct delegpt dp,
struct regional regional,
uint8_t name,
size_t  namelen,
struct sockaddr_storage addr,
socklen_t  addrlen,
uint8_t  bogus,
uint8_t  lame 
)

Add target address to the delegation point.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
namename for which target was found (must be in nslist). This name is marked resolved.
namelenlength of name.
addrthe address.
addrlenthe length of addr.
bogussecurity status for the address, pass true if bogus.
lameaddress is lame.
Returns
false on error.

◆ delegpt_add_target_mlc()

int delegpt_add_target_mlc ( struct delegpt dp,
uint8_t name,
size_t  namelen,
struct sockaddr_storage addr,
socklen_t  addrlen,
uint8_t  bogus,
uint8_t  lame 
)

Add target address to the delegation point.

Parameters
dpmust have been created with delegpt_create_mlc.
namename for which target was found (must be in nslist). This name is marked resolved.
namelenlength of name.
addrthe address.
addrlenthe length of addr.
bogussecurity status for the address, pass true if bogus.
lameaddress is lame.
Returns
false on error.

◆ delegpt_add_unused_targets()

void delegpt_add_unused_targets ( struct delegpt dp)

Add all usable targets to the result list.

Parameters
dpdelegation point.

◆ delegpt_copy()

struct delegpt* delegpt_copy ( struct delegpt dp,
struct regional regional 
)

Create a copy of a delegation point.

Parameters
dpdelegation point to copy.
regionalwhere to allocate it.
Returns
new delegation point or NULL on error.

◆ delegpt_count_addr()

void delegpt_count_addr ( struct delegpt dp,
size_t *  numaddr,
size_t *  numres,
size_t *  numavail 
)

count addresses, and number in result and available lists, for logging

◆ delegpt_count_missing_targets()

size_t delegpt_count_missing_targets ( struct delegpt dp)

Count number of missing targets. These are ns names with no resolved flag.

Parameters
dpdelegation point.
Returns
number of missing targets (or 0).

◆ delegpt_count_ns()

void delegpt_count_ns ( struct delegpt dp,
size_t *  numns,
size_t *  missing 
)

count NS and number missing for logging

◆ delegpt_count_targets()

size_t delegpt_count_targets ( struct delegpt dp)

count total number of targets in dp

◆ delegpt_create()

struct delegpt* delegpt_create ( struct regional regional)

Create new delegation point.

Parameters
regionalwhere to allocate it.
Returns
new delegation point or NULL on error.

◆ delegpt_create_mlc()

struct delegpt* delegpt_create_mlc ( uint8_t name)

create malloced delegation point, with the given name

Parameters
nameuncompressed wireformat of delegpt name.
Returns
NULL on alloc failure

◆ delegpt_find_addr()

struct delegpt_addr* delegpt_find_addr ( struct delegpt dp,
struct sockaddr_storage addr,
socklen_t  addrlen 
)

Find address record in total list of delegation point.

Parameters
dpdelegation point.
addraddress
addrlenlength of addr
Returns
the addr structure or NULL if not found.

◆ delegpt_find_ns()

struct delegpt_ns* delegpt_find_ns ( struct delegpt dp,
uint8_t name,
size_t  namelen 
)

Find NS record in name list of delegation point.

Parameters
dpdelegation point.
namename of nameserver to look for, uncompressed wireformat.
namelenlength of name.
Returns
the ns structure or NULL if not found.

◆ delegpt_free_mlc()

void delegpt_free_mlc ( struct delegpt dp)

free malloced delegation point.

Parameters
dpmust have been created with delegpt_create_mlc, free'd.

◆ delegpt_from_message()

struct delegpt* delegpt_from_message ( struct dns_msg msg,
struct regional regional 
)

Create new delegation point from a dns message

Note that this method does not actually test to see if the message is an actual referral. It really is just checking to see if it can construct a delegation point, so the message could be of some other type (some ANSWER messages, some CNAME messages, generally.) Note that the resulting DelegationPoint will contain targets for all "relevant" glue (i.e., address records whose ownernames match the target of one of the NS records), so if policy dictates that some glue should be discarded beyond that, discard it before calling this method. Note that this method will find "glue" in either the ADDITIONAL section or the ANSWER section.

Parameters
msgthe dns message, referral.
regionalwhere to allocate delegation point.
Returns
new delegation point or NULL on alloc error, or if the message was not appropriate.

◆ delegpt_get_mem()

size_t delegpt_get_mem ( struct delegpt dp)

get memory in use by dp

◆ delegpt_log()

void delegpt_log ( enum verbosity_value  v,
struct delegpt dp 
)

Print the delegation point to the log. For debugging.

Parameters
vverbosity value that is needed to emit to log.
dpdelegation point.

◆ delegpt_no_ipv4()

void delegpt_no_ipv4 ( struct delegpt dp)

Register the fact that there is no ipv4 and thus As are not going to be queried for or be useful.

Parameters
dpthe delegation point. Updated to reflect no ipv4.

◆ delegpt_no_ipv6()

void delegpt_no_ipv6 ( struct delegpt dp)

Register the fact that there is no ipv6 and thus AAAAs are not going to be queried for or be useful.

Parameters
dpthe delegation point. Updated to reflect no ipv6.

◆ delegpt_rrset_add_ns()

int delegpt_rrset_add_ns ( struct delegpt dp,
struct regional regional,
struct ub_packed_rrset_key ns_rrset,
uint8_t  lame 
)

Add NS rrset; calls add_ns repeatedly.

Parameters
dpdelegation point.
regionalwhere to allocate the info.
ns_rrsetNS rrset.
lamerrset is lame, disprefer it.
Returns
0 on alloc error.

◆ delegpt_set_name()

int delegpt_set_name ( struct delegpt dp,
struct regional regional,
uint8_t name 
)

Set name of delegation point.

Parameters
dpdelegation point.
regionalwhere to allocate the name copy.
namename to use.
Returns
false on error.

◆ delegpt_set_name_mlc()

int delegpt_set_name_mlc ( struct delegpt dp,
uint8_t name 
)

Set name of delegation point.

Parameters
dpdelegation point. malloced.
namename to use.
Returns
false on error.