Data Structures | Defines | Typedefs | Functions
resolver.h File Reference

Defines the ldns_resolver structure, a stub resolver that can send queries and parse answers. More...

Go to the source code of this file.

Data Structures

struct  ldns_struct_resolver
 DNS stub resolver structure. More...

Defines

#define LDNS_RESOLV_CONF   "/etc/resolv.conf"
 Default location of the resolv.conf file.
#define LDNS_RESOLV_HOSTS   "/etc/hosts"
 Default location of the hosts file.
#define LDNS_RESOLV_KEYWORD   -1
#define LDNS_RESOLV_DEFDOMAIN   0
#define LDNS_RESOLV_NAMESERVER   1
#define LDNS_RESOLV_SEARCH   2
#define LDNS_RESOLV_SORTLIST   3
#define LDNS_RESOLV_OPTIONS   4
#define LDNS_RESOLV_ANCHOR   5
#define LDNS_RESOLV_KEYWORDS   6
#define LDNS_RESOLV_INETANY   0
#define LDNS_RESOLV_INET   1
#define LDNS_RESOLV_INET6   2
#define LDNS_RESOLV_RTT_INF   0
#define LDNS_RESOLV_RTT_MIN   1

Typedefs

typedef struct ldns_struct_resolver ldns_resolver

Functions

uint16_t ldns_resolver_port (const ldns_resolver *r)
 Get the port the resolver should use.
bool ldns_resolver_recursive (const ldns_resolver *r)
 Is the resolver set to recurse.
bool ldns_resolver_debug (const ldns_resolver *r)
 Get the debug status of the resolver.
uint8_t ldns_resolver_retry (const ldns_resolver *r)
 Get the number of retries.
uint8_t ldns_resolver_retrans (const ldns_resolver *r)
 Get the retransmit interval.
bool ldns_resolver_fallback (const ldns_resolver *r)
 Get the truncation fallback status.
uint8_t ldns_resolver_ip6 (const ldns_resolver *r)
 Does the resolver use ip6 or ip4.
uint16_t ldns_resolver_edns_udp_size (const ldns_resolver *r)
 Get the resolver's udp size.
bool ldns_resolver_usevc (const ldns_resolver *r)
 Does the resolver use tcp or udp.
bool ldns_resolver_fail (const ldns_resolver *r)
 Does the resolver only try the first nameserver.
bool ldns_resolver_defnames (const ldns_resolver *r)
 Does the resolver apply default domain name.
bool ldns_resolver_dnsrch (const ldns_resolver *r)
 Does the resolver apply search list.
bool ldns_resolver_dnssec (const ldns_resolver *r)
 Does the resolver do DNSSEC.
bool ldns_resolver_dnssec_cd (const ldns_resolver *r)
 Does the resolver set the CD bit.
ldns_rr_listldns_resolver_dnssec_anchors (const ldns_resolver *r)
 Get the resolver's DNSSEC anchors.
bool ldns_resolver_igntc (const ldns_resolver *r)
 Does the resolver ignore the TC bit (truncated)
bool ldns_resolver_random (const ldns_resolver *r)
 Does the resolver randomize the nameserver before usage.
size_t ldns_resolver_nameserver_count (const ldns_resolver *r)
 How many nameserver are configured in the resolver.
ldns_rdfldns_resolver_domain (const ldns_resolver *r)
 What is the default dname to add to relative queries.
struct timeval ldns_resolver_timeout (const ldns_resolver *r)
 What is the timeout on socket connections.
ldns_rdf ** ldns_resolver_searchlist (const ldns_resolver *r)
 What is the searchlist as used by the resolver.
ldns_rdf ** ldns_resolver_nameservers (const ldns_resolver *r)
 Return the configured nameserver ip address.
size_t * ldns_resolver_rtt (const ldns_resolver *r)
 Return the used round trip times for the nameservers.
size_t ldns_resolver_nameserver_rtt (const ldns_resolver *r, size_t pos)
 Return the used round trip time for a specific nameserver.
char * ldns_resolver_tsig_keyname (const ldns_resolver *r)
 Return the tsig keyname as used by the nameserver.
char * ldns_resolver_tsig_algorithm (const ldns_resolver *r)
 Return the tsig algorithm as used by the nameserver.
char * ldns_resolver_tsig_keydata (const ldns_resolver *r)
 Return the tsig keydata as used by the nameserver.
ldns_rdfldns_resolver_pop_nameserver (ldns_resolver *r)
 pop the last nameserver from the resolver.
size_t ldns_resolver_searchlist_count (const ldns_resolver *r)
 Return the resolver's searchlist count.
void ldns_resolver_set_port (ldns_resolver *r, uint16_t p)
 Set the port the resolver should use.
void ldns_resolver_set_recursive (ldns_resolver *r, bool b)
 Set the resolver recursion.
void ldns_resolver_set_debug (ldns_resolver *r, bool b)
 Set the resolver debugging.
void ldns_resolver_incr_nameserver_count (ldns_resolver *r)
 Incremental the resolver's nameserver count.
void ldns_resolver_dec_nameserver_count (ldns_resolver *r)
 Decrement the resolver's nameserver count.
void ldns_resolver_set_nameserver_count (ldns_resolver *r, size_t c)
 Set the resolver's nameserver count directly.
void ldns_resolver_set_nameservers (ldns_resolver *r, ldns_rdf **rd)
 Set the resolver's nameserver count directly by using an rdf list.
void ldns_resolver_set_domain (ldns_resolver *r, ldns_rdf *rd)
 Set the resolver's default domain.
void ldns_resolver_set_timeout (ldns_resolver *r, struct timeval timeout)
 Set the resolver's socket time out when talking to remote hosts.
void ldns_resolver_push_searchlist (ldns_resolver *r, ldns_rdf *rd)
 Push a new rd to the resolver's searchlist.
void ldns_resolver_set_defnames (ldns_resolver *r, bool b)
 Whether the resolver uses the name set with _set_domain.
void ldns_resolver_set_usevc (ldns_resolver *r, bool b)
 Whether the resolver uses a virtual circuit (TCP)
void ldns_resolver_set_dnsrch (ldns_resolver *r, bool b)
 Whether the resolver uses the searchlist.
void ldns_resolver_set_dnssec (ldns_resolver *r, bool b)
 Whether the resolver uses DNSSEC.
void ldns_resolver_set_dnssec_cd (ldns_resolver *r, bool b)
 Whether the resolver uses the checking disable bit.
void ldns_resolver_set_dnssec_anchors (ldns_resolver *r, ldns_rr_list *l)
 Set the resolver's DNSSEC anchor list directly.
ldns_status ldns_resolver_push_dnssec_anchor (ldns_resolver *r, ldns_rr *rr)
 Push a new trust anchor to the resolver.
void ldns_resolver_set_retrans (ldns_resolver *r, uint8_t re)
 Set the resolver retrans timeout (in seconds)
void ldns_resolver_set_fallback (ldns_resolver *r, bool fallback)
 Set whether the resolvers truncation fallback mechanism is used when ldns_resolver_query() is called.
void ldns_resolver_set_retry (ldns_resolver *r, uint8_t re)
 Set the resolver retry interval (in seconds)
void ldns_resolver_set_ip6 (ldns_resolver *r, uint8_t i)
 Whether the resolver uses ip6.
void ldns_resolver_set_fail (ldns_resolver *r, bool b)
 Whether or not to fail after one failed query.
void ldns_resolver_set_igntc (ldns_resolver *r, bool b)
 Whether or not to ignore the TC bit.
void ldns_resolver_set_edns_udp_size (ldns_resolver *r, uint16_t s)
 Set maximum udp size.
void ldns_resolver_set_tsig_keyname (ldns_resolver *r, char *tsig_keyname)
 Set the tsig key name.
void ldns_resolver_set_tsig_algorithm (ldns_resolver *r, char *tsig_algorithm)
 Set the tsig algorithm.
void ldns_resolver_set_tsig_keydata (ldns_resolver *r, char *tsig_keydata)
 Set the tsig key data.
void ldns_resolver_set_rtt (ldns_resolver *r, size_t *rtt)
 Set round trip time for all nameservers.
void ldns_resolver_set_nameserver_rtt (ldns_resolver *r, size_t pos, size_t value)
 Set round trip time for a specific nameserver.
void ldns_resolver_set_random (ldns_resolver *r, bool b)
 Should the nameserver list be randomized before each use.
ldns_status ldns_resolver_push_nameserver (ldns_resolver *r, ldns_rdf *n)
 Push a new nameserver to the resolver.
ldns_status ldns_resolver_push_nameserver_rr (ldns_resolver *r, ldns_rr *rr)
 Push a new nameserver to the resolver.
ldns_status ldns_resolver_push_nameserver_rr_list (ldns_resolver *r, ldns_rr_list *rrlist)
 Push a new nameserver rr_list to the resolver.
ldns_pktldns_resolver_search (const ldns_resolver *r, const ldns_rdf *rdf, ldns_rr_type t, ldns_rr_class c, uint16_t flags)
 Send the query for using the resolver and take the search list into account The search algorithm is as follows: If the name is absolute, try it as-is, otherwise apply the search list.
ldns_status ldns_resolver_prepare_query_pkt (ldns_pkt **q, ldns_resolver *r, const ldns_rdf *name, ldns_rr_type t, ldns_rr_class c, uint16_t f)
 Form a query packet from a resolver and name/type/class combo.
ldns_status ldns_resolver_send (ldns_pkt **answer, ldns_resolver *r, const ldns_rdf *name, ldns_rr_type t, ldns_rr_class c, uint16_t flags)
 Send the query for name as-is.
ldns_status ldns_resolver_send_pkt (ldns_pkt **answer, ldns_resolver *r, ldns_pkt *query_pkt)
 Send the given packet to a nameserver.
ldns_pktldns_resolver_query (const ldns_resolver *r, const ldns_rdf *name, ldns_rr_type t, ldns_rr_class c, uint16_t flags)
 Send a query to a nameserver.
ldns_resolverldns_resolver_new (void)
 Create a new resolver structure.
ldns_status ldns_resolver_new_frm_fp (ldns_resolver **r, FILE *fp)
 Create a resolver structure from a file like /etc/resolv.conf.
ldns_status ldns_resolver_new_frm_fp_l (ldns_resolver **r, FILE *fp, int *line_nr)
 Create a resolver structure from a file like /etc/resolv.conf.
ldns_status ldns_resolver_new_frm_file (ldns_resolver **r, const char *filename)
 Configure a resolver by means of a resolv.conf file The file may be NULL in which case there will be looked the RESOLV_CONF (defaults to /etc/resolv.conf.
void ldns_resolver_free (ldns_resolver *res)
 Frees the allocated space for this resolver.
void ldns_resolver_deep_free (ldns_resolver *res)
 Frees the allocated space for this resolver and all it's data.
ldns_rrldns_axfr_next (ldns_resolver *resolver)
 Get the next stream of RRs in a AXFR.
bool ldns_axfr_complete (const ldns_resolver *resolver)
 Returns true if the axfr transfer has completed (i.e.
ldns_pktldns_axfr_last_pkt (const ldns_resolver *res)
 Returns a pointer to the last ldns_pkt that was sent by the server in the AXFR transfer uasable for instance to get the error code on failure.
void ldns_resolver_nameservers_randomize (ldns_resolver *r)
 Randomize the nameserver list in the resolver.
bool ldns_resolver_trusted_key (const ldns_resolver *r, ldns_rr_list *keys, ldns_rr_list *trusted_keys)
 Returns true if at least one of the provided keys is a trust anchor.

Detailed Description

Defines the ldns_resolver structure, a stub resolver that can send queries and parse answers.

Definition in file resolver.h.


Define Documentation

#define LDNS_RESOLV_CONF   "/etc/resolv.conf"

Default location of the resolv.conf file.

Definition at line 36 of file resolver.h.

#define LDNS_RESOLV_HOSTS   "/etc/hosts"

Default location of the hosts file.

Definition at line 38 of file resolver.h.

#define LDNS_RESOLV_KEYWORD   -1

Definition at line 40 of file resolver.h.

#define LDNS_RESOLV_DEFDOMAIN   0

Definition at line 41 of file resolver.h.

#define LDNS_RESOLV_NAMESERVER   1

Definition at line 42 of file resolver.h.

#define LDNS_RESOLV_SEARCH   2

Definition at line 43 of file resolver.h.

#define LDNS_RESOLV_SORTLIST   3

Definition at line 44 of file resolver.h.

#define LDNS_RESOLV_OPTIONS   4

Definition at line 45 of file resolver.h.

#define LDNS_RESOLV_ANCHOR   5

Definition at line 46 of file resolver.h.

#define LDNS_RESOLV_KEYWORDS   6

Definition at line 47 of file resolver.h.

#define LDNS_RESOLV_INETANY   0

Definition at line 49 of file resolver.h.

#define LDNS_RESOLV_INET   1

Definition at line 50 of file resolver.h.

#define LDNS_RESOLV_INET6   2

Definition at line 51 of file resolver.h.

#define LDNS_RESOLV_RTT_INF   0

Definition at line 53 of file resolver.h.

#define LDNS_RESOLV_RTT_MIN   1

Definition at line 54 of file resolver.h.


Typedef Documentation

Definition at line 142 of file resolver.h.


Function Documentation

uint16_t ldns_resolver_port ( const ldns_resolver r)

Get the port the resolver should use.

Parameters:
[in]rthe resolver
Returns:
the port number

Definition at line 24 of file resolver.c.

References ldns_struct_resolver::_port.

bool ldns_resolver_recursive ( const ldns_resolver r)

Is the resolver set to recurse.

Parameters:
[in]rthe resolver
Returns:
true if so, otherwise false

Definition at line 60 of file resolver.c.

References ldns_struct_resolver::_recursive.

bool ldns_resolver_debug ( const ldns_resolver r)

Get the debug status of the resolver.

Parameters:
[in]rthe resolver
Returns:
true if so, otherwise false

Definition at line 66 of file resolver.c.

References ldns_struct_resolver::_debug.

uint8_t ldns_resolver_retry ( const ldns_resolver r)

Get the number of retries.

Parameters:
[in]rthe resolver
Returns:
the number of retries

Definition at line 36 of file resolver.c.

References ldns_struct_resolver::_retry.

uint8_t ldns_resolver_retrans ( const ldns_resolver r)

Get the retransmit interval.

Parameters:
[in]rthe resolver
Returns:
the retransmit interval

Definition at line 42 of file resolver.c.

References ldns_struct_resolver::_retrans.

bool ldns_resolver_fallback ( const ldns_resolver r)

Get the truncation fallback status.

Parameters:
[in]rthe resolver
Returns:
whether the truncation fallback mechanism is used

Definition at line 48 of file resolver.c.

References ldns_struct_resolver::_fallback.

uint8_t ldns_resolver_ip6 ( const ldns_resolver r)

Does the resolver use ip6 or ip4.

Parameters:
[in]rthe resolver
Returns:
0: both, 1: ip4, 2:ip6

Definition at line 54 of file resolver.c.

References ldns_struct_resolver::_ip6.

uint16_t ldns_resolver_edns_udp_size ( const ldns_resolver r)

Get the resolver's udp size.

Parameters:
[in]rthe resolver
Returns:
the udp mesg size

Definition at line 30 of file resolver.c.

References ldns_struct_resolver::_edns_udp_size.

bool ldns_resolver_usevc ( const ldns_resolver r)

Does the resolver use tcp or udp.

Parameters:
[in]rthe resolver
Returns:
true: tcp, false: udp

Definition at line 165 of file resolver.c.

References ldns_struct_resolver::_usevc.

bool ldns_resolver_fail ( const ldns_resolver r)

Does the resolver only try the first nameserver.

Parameters:
[in]rthe resolver
Returns:
true: yes, fail, false: no, try the others

Definition at line 78 of file resolver.c.

References ldns_struct_resolver::_fail.

bool ldns_resolver_defnames ( const ldns_resolver r)

Does the resolver apply default domain name.

Parameters:
[in]rthe resolver
Returns:
true: yes, false: no

Definition at line 84 of file resolver.c.

References ldns_struct_resolver::_defnames.

bool ldns_resolver_dnsrch ( const ldns_resolver r)

Does the resolver apply search list.

Parameters:
[in]rthe resolver
Returns:
true: yes, false: no

Definition at line 72 of file resolver.c.

References ldns_struct_resolver::_dnsrch.

bool ldns_resolver_dnssec ( const ldns_resolver r)

Does the resolver do DNSSEC.

Parameters:
[in]rthe resolver
Returns:
true: yes, false: no

Definition at line 114 of file resolver.c.

References ldns_struct_resolver::_dnssec.

bool ldns_resolver_dnssec_cd ( const ldns_resolver r)

Does the resolver set the CD bit.

Parameters:
[in]rthe resolver
Returns:
true: yes, false: no

Definition at line 120 of file resolver.c.

References ldns_struct_resolver::_dnssec_cd.

ldns_rr_list* ldns_resolver_dnssec_anchors ( const ldns_resolver r)

Get the resolver's DNSSEC anchors.

Parameters:
[in]rthe resolver
Returns:
an rr_list containg trusted DNSSEC anchors

Definition at line 126 of file resolver.c.

References ldns_struct_resolver::_dnssec_anchors.

bool ldns_resolver_igntc ( const ldns_resolver r)

Does the resolver ignore the TC bit (truncated)

Parameters:
[in]rthe resolver
Returns:
true: yes, false: no

Definition at line 159 of file resolver.c.

References ldns_struct_resolver::_igntc.

bool ldns_resolver_random ( const ldns_resolver r)

Does the resolver randomize the nameserver before usage.

Parameters:
[in]rthe resolver
Returns:
true: yes, false: no

Definition at line 219 of file resolver.c.

References ldns_struct_resolver::_random.

size_t ldns_resolver_nameserver_count ( const ldns_resolver r)

How many nameserver are configured in the resolver.

Parameters:
[in]rthe resolver
Returns:
number of nameservers

Definition at line 108 of file resolver.c.

References ldns_struct_resolver::_nameserver_count.

ldns_rdf* ldns_resolver_domain ( const ldns_resolver r)

What is the default dname to add to relative queries.

Parameters:
[in]rthe resolver
Returns:
the dname which is added

Definition at line 90 of file resolver.c.

References ldns_struct_resolver::_domain.

struct timeval ldns_resolver_timeout ( const ldns_resolver r) [read]

What is the timeout on socket connections.

Parameters:
[in]rthe resolver
Returns:
the timeout as struct timeval

Definition at line 195 of file resolver.c.

ldns_rdf** ldns_resolver_searchlist ( const ldns_resolver r)

What is the searchlist as used by the resolver.

Parameters:
[in]rthe resolver
Returns:
a ldns_rdf pointer to a list of the addresses

Definition at line 96 of file resolver.c.

References ldns_struct_resolver::_searchlist.

ldns_rdf** ldns_resolver_nameservers ( const ldns_resolver r)

Return the configured nameserver ip address.

Parameters:
[in]rthe resolver
Returns:
a ldns_rdf pointer to a list of the addresses

Definition at line 102 of file resolver.c.

References ldns_struct_resolver::_nameservers.

size_t* ldns_resolver_rtt ( const ldns_resolver r)

Return the used round trip times for the nameservers.

Parameters:
[in]rthe resolver
Returns:
a size_t* pointer to the list. yet)

Definition at line 171 of file resolver.c.

References ldns_struct_resolver::_rtt.

size_t ldns_resolver_nameserver_rtt ( const ldns_resolver r,
size_t  pos 
)

Return the used round trip time for a specific nameserver.

Parameters:
[in]rthe resolver
[in]posthe index to the nameserver
Returns:
the rrt, 0: infinite, >0: undefined (as of * yet)

Definition at line 177 of file resolver.c.

References ldns_resolver_rtt(), and ldns_resolver_nameserver_count().

char* ldns_resolver_tsig_keyname ( const ldns_resolver r)

Return the tsig keyname as used by the nameserver.

Parameters:
[in]rthe resolver
Returns:
the name used.

Definition at line 201 of file resolver.c.

References ldns_struct_resolver::_tsig_keyname.

char* ldns_resolver_tsig_algorithm ( const ldns_resolver r)

Return the tsig algorithm as used by the nameserver.

Parameters:
[in]rthe resolver
Returns:
the algorithm used.

Definition at line 207 of file resolver.c.

References ldns_struct_resolver::_tsig_algorithm.

char* ldns_resolver_tsig_keydata ( const ldns_resolver r)

Return the tsig keydata as used by the nameserver.

Parameters:
[in]rthe resolver
Returns:
the keydata used.

Definition at line 213 of file resolver.c.

References ldns_struct_resolver::_tsig_keydata.

ldns_rdf* ldns_resolver_pop_nameserver ( ldns_resolver r)

pop the last nameserver from the resolver.

Parameters:
[in]rthe resolver
Returns:
the popped address or NULL if empty

Definition at line 238 of file resolver.c.

References ldns_resolver_nameserver_count(), ldns_resolver_nameservers(), ldns_resolver_rtt(), LDNS_XREALLOC, ldns_resolver_set_nameservers(), ldns_resolver_set_rtt(), and ldns_resolver_dec_nameserver_count().

size_t ldns_resolver_searchlist_count ( const ldns_resolver r)

Return the resolver's searchlist count.

Parameters:
[in]rthe resolver
Returns:
the searchlist count

Definition at line 225 of file resolver.c.

References ldns_struct_resolver::_searchlist_count.

void ldns_resolver_set_port ( ldns_resolver r,
uint16_t  p 
)

Set the port the resolver should use.

Parameters:
[in]rthe resolver
[in]pthe port number

Definition at line 232 of file resolver.c.

References ldns_struct_resolver::_port.

void ldns_resolver_set_recursive ( ldns_resolver r,
bool  b 
)

Set the resolver recursion.

Parameters:
[in]rthe resolver
[in]btrue: set to recurse, false: unset

Definition at line 360 of file resolver.c.

References ldns_struct_resolver::_recursive.

void ldns_resolver_set_debug ( ldns_resolver r,
bool  b 
)

Set the resolver debugging.

Parameters:
[in]rthe resolver
[in]btrue: debug on: false debug off

Definition at line 413 of file resolver.c.

References ldns_struct_resolver::_debug.

void ldns_resolver_incr_nameserver_count ( ldns_resolver r)

Incremental the resolver's nameserver count.

Parameters:
[in]rthe resolver

Definition at line 502 of file resolver.c.

References ldns_resolver_nameserver_count(), and ldns_resolver_set_nameserver_count().

void ldns_resolver_dec_nameserver_count ( ldns_resolver r)

Decrement the resolver's nameserver count.

Parameters:
[in]rthe resolver

Definition at line 511 of file resolver.c.

References ldns_resolver_nameserver_count(), and ldns_resolver_set_nameserver_count().

void ldns_resolver_set_nameserver_count ( ldns_resolver r,
size_t  c 
)

Set the resolver's nameserver count directly.

Parameters:
[in]rthe resolver
[in]cthe nameserver count

Definition at line 437 of file resolver.c.

References ldns_struct_resolver::_nameserver_count.

void ldns_resolver_set_nameservers ( ldns_resolver r,
ldns_rdf **  rd 
)

Set the resolver's nameserver count directly by using an rdf list.

Parameters:
[in]rthe resolver
[in]rdthe resolver addresses

Definition at line 467 of file resolver.c.

References ldns_struct_resolver::_nameservers.

void ldns_resolver_set_domain ( ldns_resolver r,
ldns_rdf rd 
)

Set the resolver's default domain.

This gets appended when no absolute name is given

Parameters:
[in]rthe resolver
[in]rdthe name to append

Definition at line 524 of file resolver.c.

References ldns_struct_resolver::_domain.

void ldns_resolver_set_timeout ( ldns_resolver r,
struct timeval  timeout 
)

Set the resolver's socket time out when talking to remote hosts.

Parameters:
[in]rthe resolver
[in]timeoutthe timeout to use

Definition at line 530 of file resolver.c.

References ldns_struct_resolver::_timeout.

void ldns_resolver_push_searchlist ( ldns_resolver r,
ldns_rdf rd 
)

Push a new rd to the resolver's searchlist.

Parameters:
[in]rthe resolver
[in]rdto push

Definition at line 537 of file resolver.c.

References ldns_rdf_get_type(), LDNS_RDF_TYPE_DNAME, ldns_resolver_searchlist_count(), ldns_resolver_searchlist(), LDNS_XREALLOC, ldns_struct_resolver::_searchlist, ldns_rdf_clone(), and ldns_resolver_set_searchlist_count().

void ldns_resolver_set_defnames ( ldns_resolver r,
bool  b 
)

Whether the resolver uses the name set with _set_domain.

Parameters:
[in]rthe resolver
[in]btrue: use the defaults, false: don't use them

Definition at line 473 of file resolver.c.

References ldns_struct_resolver::_defnames.

void ldns_resolver_set_usevc ( ldns_resolver r,
bool  b 
)

Whether the resolver uses a virtual circuit (TCP)

Parameters:
[in]rthe resolver
[in]btrue: use TCP, false: don't use TCP

Definition at line 407 of file resolver.c.

References ldns_struct_resolver::_usevc.

void ldns_resolver_set_dnsrch ( ldns_resolver r,
bool  b 
)

Whether the resolver uses the searchlist.

Parameters:
[in]rthe resolver
[in]btrue: use the list, false: don't use the list

Definition at line 443 of file resolver.c.

References ldns_struct_resolver::_dnsrch.

void ldns_resolver_set_dnssec ( ldns_resolver r,
bool  b 
)

Whether the resolver uses DNSSEC.

Parameters:
[in]rthe resolver
[in]btrue: use DNSSEC, false: don't use DNSSEC

Definition at line 366 of file resolver.c.

References ldns_struct_resolver::_dnssec.

void ldns_resolver_set_dnssec_cd ( ldns_resolver r,
bool  b 
)

Whether the resolver uses the checking disable bit.

Parameters:
[in]rthe resolver
[in]btrue: enable , false: don't use TCP

Definition at line 372 of file resolver.c.

References ldns_struct_resolver::_dnssec_cd.

void ldns_resolver_set_dnssec_anchors ( ldns_resolver r,
ldns_rr_list l 
)

Set the resolver's DNSSEC anchor list directly.

RRs should be of type DS or DNSKEY.

Parameters:
[in]rthe resolver
[in]lthe list of RRs to use as trust anchors

Definition at line 378 of file resolver.c.

References ldns_struct_resolver::_dnssec_anchors.

ldns_status ldns_resolver_push_dnssec_anchor ( ldns_resolver r,
ldns_rr rr 
)

Push a new trust anchor to the resolver.

It must be a DS or DNSKEY rr

Parameters:
[in]rthe resolver.
[in]rrthe RR to add as a trust anchor.
Returns:
a status

Definition at line 384 of file resolver.c.

References ldns_rr_get_type(), LDNS_RR_TYPE_DNSKEY, LDNS_STATUS_ERR, ldns_resolver_dnssec_anchors(), ldns_rr_list_new(), ldns_resolver_set_dnssec_anchors(), ldns_rr_list_push_rr(), ldns_rr_clone(), and LDNS_STATUS_OK.

void ldns_resolver_set_retrans ( ldns_resolver r,
uint8_t  re 
)

Set the resolver retrans timeout (in seconds)

Parameters:
[in]rthe resolver
[in]rethe retransmission interval in seconds

Definition at line 455 of file resolver.c.

References ldns_struct_resolver::_retrans.

void ldns_resolver_set_fallback ( ldns_resolver r,
bool  fallback 
)

Set whether the resolvers truncation fallback mechanism is used when ldns_resolver_query() is called.

Parameters:
[in]rthe resolver
[in]fallbackwhether to use the fallback mechanism

Definition at line 461 of file resolver.c.

References ldns_struct_resolver::_fallback.

void ldns_resolver_set_retry ( ldns_resolver r,
uint8_t  re 
)

Set the resolver retry interval (in seconds)

Parameters:
[in]rthe resolver
[in]rethe retry interval

Definition at line 449 of file resolver.c.

References ldns_struct_resolver::_retry.

void ldns_resolver_set_ip6 ( ldns_resolver r,
uint8_t  i 
)

Whether the resolver uses ip6.

Parameters:
[in]rthe resolver
[in]i0: no pref, 1: ip4, 2: ip6

Definition at line 419 of file resolver.c.

References ldns_struct_resolver::_ip6.

void ldns_resolver_set_fail ( ldns_resolver r,
bool  b 
)

Whether or not to fail after one failed query.

Parameters:
[in]rthe resolver
[in]btrue: yes fail, false: continue with next nameserver

Definition at line 425 of file resolver.c.

References ldns_struct_resolver::_fail.

void ldns_resolver_set_igntc ( ldns_resolver r,
bool  b 
)

Whether or not to ignore the TC bit.

Parameters:
[in]rthe resolver
[in]btrue: yes ignore, false: don't ignore

Definition at line 401 of file resolver.c.

References ldns_struct_resolver::_igntc.

void ldns_resolver_set_edns_udp_size ( ldns_resolver r,
uint16_t  s 
)

Set maximum udp size.

Parameters:
[in]rthe resolver
[in]sthe udp max size

Definition at line 354 of file resolver.c.

References ldns_struct_resolver::_edns_udp_size.

void ldns_resolver_set_tsig_keyname ( ldns_resolver r,
char *  tsig_keyname 
)

Set the tsig key name.

Parameters:
[in]rthe resolver
[in]tsig_keynamethe tsig key name

Definition at line 559 of file resolver.c.

References LDNS_FREE, and ldns_struct_resolver::_tsig_keyname.

void ldns_resolver_set_tsig_algorithm ( ldns_resolver r,
char *  tsig_algorithm 
)

Set the tsig algorithm.

Parameters:
[in]rthe resolver
[in]tsig_algorithmthe tsig algorithm

Definition at line 566 of file resolver.c.

References LDNS_FREE, and ldns_struct_resolver::_tsig_algorithm.

void ldns_resolver_set_tsig_keydata ( ldns_resolver r,
char *  tsig_keydata 
)

Set the tsig key data.

Parameters:
[in]rthe resolver
[in]tsig_keydatathe key data

Definition at line 573 of file resolver.c.

References LDNS_FREE, and ldns_struct_resolver::_tsig_keydata.

void ldns_resolver_set_rtt ( ldns_resolver r,
size_t *  rtt 
)

Set round trip time for all nameservers.

Note this currently differentiates between: unreachable and reachable.

Parameters:
[in]rthe resolver
[in]rtta list with the times

Definition at line 479 of file resolver.c.

References ldns_struct_resolver::_rtt.

void ldns_resolver_set_nameserver_rtt ( ldns_resolver r,
size_t  pos,
size_t  value 
)

Set round trip time for a specific nameserver.

Note this currently differentiates between: unreachable and reachable.

Parameters:
[in]rthe resolver
[in]posthe nameserver position
[in]valuethe rtt

Definition at line 485 of file resolver.c.

References ldns_resolver_rtt(), and ldns_resolver_nameserver_count().

void ldns_resolver_set_random ( ldns_resolver r,
bool  b 
)

Should the nameserver list be randomized before each use.

Parameters:
[in]rthe resolver
[in]b,:true: randomize, false: don't

Definition at line 580 of file resolver.c.

References ldns_struct_resolver::_random.

ldns_status ldns_resolver_push_nameserver ( ldns_resolver r,
ldns_rdf n 
)

Push a new nameserver to the resolver.

It must be an IP address v4 or v6.

Parameters:
[in]rthe resolver
[in]nthe ip address
Returns:
ldns_status a status

Definition at line 269 of file resolver.c.

References ldns_rdf_get_type(), LDNS_RDF_TYPE_A, LDNS_RDF_TYPE_AAAA, LDNS_STATUS_ERR, ldns_resolver_nameserver_count(), ldns_resolver_nameservers(), ldns_resolver_rtt(), LDNS_XMALLOC, LDNS_XREALLOC, LDNS_STATUS_MEM_ERR, ldns_resolver_set_nameservers(), ldns_rdf_clone(), LDNS_RESOLV_RTT_MIN, ldns_resolver_incr_nameserver_count(), ldns_resolver_set_rtt(), and LDNS_STATUS_OK.

ldns_status ldns_resolver_push_nameserver_rr ( ldns_resolver r,
ldns_rr rr 
)

Push a new nameserver to the resolver.

It must be an A or AAAA RR record type

Parameters:
[in]rthe resolver
[in]rrthe resource record
Returns:
ldns_status a status

Definition at line 316 of file resolver.c.

References ldns_rr_get_type(), LDNS_RR_TYPE_A, LDNS_RR_TYPE_AAAA, LDNS_STATUS_ERR, ldns_rr_rdf(), and ldns_resolver_push_nameserver().

ldns_status ldns_resolver_push_nameserver_rr_list ( ldns_resolver r,
ldns_rr_list rrlist 
)

Push a new nameserver rr_list to the resolver.

Parameters:
[in]rthe resolver
[in]rrlistthe rr_list to push
Returns:
ldns_status a status

Definition at line 332 of file resolver.c.

References LDNS_STATUS_OK, ldns_rr_list_rr_count(), ldns_rr_list_rr(), ldns_resolver_push_nameserver_rr(), and LDNS_STATUS_ERR.

ldns_pkt* ldns_resolver_search ( const ldns_resolver r,
const ldns_rdf rdf,
ldns_rr_type  t,
ldns_rr_class  c,
uint16_t  flags 
)

Send the query for using the resolver and take the search list into account The search algorithm is as follows: If the name is absolute, try it as-is, otherwise apply the search list.

Parameters:
[in]*roperate using this resolver
[in]*rdfquery for this name
[in]tquery for this type (may be 0, defaults to A)
[in]cquery for this class (may be 0, default to IN)
[in]flagsthe query flags
Returns:
ldns_pkt* a packet with the reply from the nameserver

Definition at line 946 of file resolver.c.

References ldns_rdf2str(), ldns_dname_str_absolute(), ldns_resolver_query(), ldns_resolver_dnsrch(), ldns_resolver_searchlist(), ldns_resolver_searchlist_count(), ldns_dname_cat_clone(), ldns_rdf_free(), ldns_pkt_get_rcode(), LDNS_RCODE_NOERROR, and ldns_pkt_free().

ldns_status ldns_resolver_prepare_query_pkt ( ldns_pkt **  q,
ldns_resolver r,
const ldns_rdf name,
ldns_rr_type  t,
ldns_rr_class  c,
uint16_t  f 
)

Form a query packet from a resolver and name/type/class combo.

Parameters:
[out]**qa pointer to a ldns_pkt pointer (initialized by this function)
[in]*roperate using this resolver
[in]*namequery for this name
[in]tquery for this type (may be 0, defaults to A)
[in]cquery for this class (may be 0, default to IN)
[in]fthe query flags
Returns:
ldns_pkt* a packet with the reply from the nameserver

Definition at line 1119 of file resolver.c.

References ldns_pkt_query_new(), ldns_rdf_clone(), LDNS_STATUS_ERR, ldns_resolver_dnssec(), ldns_resolver_edns_udp_size(), ldns_resolver_set_edns_udp_size(), ldns_pkt_set_edns_do(), ldns_resolver_dnssec_cd(), LDNS_CD, ldns_pkt_set_cd(), ldns_pkt_set_edns_udp_size(), ldns_pkt_set_timestamp(), ldns_resolver_debug(), ldns_pkt_print(), ldns_pkt_id(), ldns_pkt_set_random_id(), and LDNS_STATUS_OK.

ldns_status ldns_resolver_send ( ldns_pkt **  answer,
ldns_resolver r,
const ldns_rdf name,
ldns_rr_type  t,
ldns_rr_class  c,
uint16_t  flags 
)

Send the query for name as-is.

Parameters:
[out]**answera pointer to a ldns_pkt pointer (initialized by this function)
[in]*roperate using this resolver
[in]*namequery for this name
[in]tquery for this type (may be 0, defaults to A)
[in]cquery for this class (may be 0, default to IN)
[in]flagsthe query flags
Returns:
ldns_pkt* a packet with the reply from the nameserver

Definition at line 1168 of file resolver.c.

References LDNS_RR_TYPE_A, LDNS_RR_CLASS_IN, ldns_resolver_nameserver_count(), LDNS_STATUS_RES_NO_NS, ldns_rdf_get_type(), LDNS_RDF_TYPE_DNAME, LDNS_STATUS_RES_QUERY, ldns_resolver_prepare_query_pkt(), LDNS_STATUS_OK, ldns_resolver_tsig_keyname(), ldns_resolver_tsig_keydata(), ldns_pkt_tsig_sign(), ldns_resolver_tsig_algorithm(), LDNS_STATUS_CRYPTO_TSIG_ERR, ldns_resolver_send_pkt(), and ldns_pkt_free().

ldns_status ldns_resolver_send_pkt ( ldns_pkt **  answer,
ldns_resolver r,
ldns_pkt query_pkt 
)

Send the given packet to a nameserver.

Parameters:
[out]**answera pointer to a ldns_pkt pointer (initialized by this function)
[in]*roperate using this resolver
[in]*query_pktquery

Definition at line 1063 of file resolver.c.

References LDNS_STATUS_OK, ldns_send(), ldns_pkt_free(), ldns_resolver_usevc(), ldns_resolver_fallback(), ldns_pkt_tc(), ldns_pkt_edns_udp_size(), ldns_pkt_set_edns_udp_size(), and ldns_resolver_set_usevc().

ldns_pkt* ldns_resolver_query ( const ldns_resolver r,
const ldns_rdf name,
ldns_rr_type  t,
ldns_rr_class  c,
uint16_t  flags 
)

Send a query to a nameserver.

Parameters:
[in]*roperate using this resolver
[in]*namequery for this name
[in]*tquery for this type (may be 0, defaults to A)
[in]*cquery for this class (may be 0, default to IN)
[in]flagsthe query flags
Returns:
ldns_pkt* a packet with the reply from the nameserver if _defnames is true the default domain will be added

Definition at line 982 of file resolver.c.

References ldns_resolver_defnames(), ldns_resolver_send(), LDNS_STATUS_OK, ldns_pkt_free(), ldns_resolver_domain(), ldns_dname_cat_clone(), and ldns_rdf_free().

ldns_resolver* ldns_resolver_new ( void  )
ldns_status ldns_resolver_new_frm_fp ( ldns_resolver **  r,
FILE *  fp 
)

Create a resolver structure from a file like /etc/resolv.conf.

Parameters:
[out]rthe new resolver
[in]fpfile pointer to create new resolver from if NULL use /etc/resolv.conf
Returns:
LDNS_STATUS_OK or the error

Definition at line 644 of file resolver.c.

References ldns_resolver_new_frm_fp_l().

ldns_status ldns_resolver_new_frm_fp_l ( ldns_resolver **  r,
FILE *  fp,
int *  line_nr 
)
ldns_status ldns_resolver_new_frm_file ( ldns_resolver **  r,
const char *  filename 
)

Configure a resolver by means of a resolv.conf file The file may be NULL in which case there will be looked the RESOLV_CONF (defaults to /etc/resolv.conf.

Parameters:
[out]rthe new resolver
[in]filenamethe filename to use
Returns:
LDNS_STATUS_OK or the error

Definition at line 865 of file resolver.c.

References LDNS_RESOLV_CONF, LDNS_STATUS_FILE_ERR, ldns_resolver_new_frm_fp(), LDNS_STATUS_OK, and LDNS_STATUS_NULL.

void ldns_resolver_free ( ldns_resolver res)

Frees the allocated space for this resolver.

Only frees the resolver pionter! You should probably be using _deep_free.

Parameters:
resresolver to free

Definition at line 895 of file resolver.c.

References LDNS_FREE.

void ldns_resolver_deep_free ( ldns_resolver res)
ldns_rr* ldns_axfr_next ( ldns_resolver resolver)

Get the next stream of RRs in a AXFR.

Parameters:
[in]resolverthe resolver to use. First ldns_axfr_start() must be called
Returns:
ldns_rr the next RR from the AXFR stream After you get this returned RR (not NULL: on error), then check if ldns_axfr_complete() is true to see if the zone transfer has completed.

Definition at line 1233 of file resolver.c.

References ldns_struct_resolver::_socket, ldns_struct_resolver::_cur_axfr_pkt, ldns_struct_resolver::_axfr_i, ldns_pkt_ancount(), ldns_pkt_free(), ldns_axfr_next(), ldns_rr_clone(), ldns_rr_list_rr(), ldns_pkt_answer(), ldns_rr_get_type(), LDNS_RR_TYPE_SOA, ldns_struct_resolver::_axfr_soa_count, ldns_tcp_read_wire(), ldns_wire2pkt(), LDNS_STATUS_OK, ldns_get_errorstr_by_id(), ldns_pkt_get_rcode(), ldns_lookup_by_id(), ldns_rcodes, and ldns_struct_lookup_table::name.

bool ldns_axfr_complete ( const ldns_resolver resolver)

Returns true if the axfr transfer has completed (i.e.

2 SOA RRs and no errors were encountered

Parameters:
[in]resolverthe resolver that is used
Returns:
bool true if axfr transfer was completed without error

Definition at line 1319 of file resolver.c.

References ldns_struct_resolver::_axfr_soa_count.

ldns_pkt* ldns_axfr_last_pkt ( const ldns_resolver res)

Returns a pointer to the last ldns_pkt that was sent by the server in the AXFR transfer uasable for instance to get the error code on failure.

Parameters:
[in]resthe resolver that was used in the axfr transfer
Returns:
ldns_pkt the last packet sent

Definition at line 1326 of file resolver.c.

References ldns_struct_resolver::_cur_axfr_pkt.

void ldns_resolver_nameservers_randomize ( ldns_resolver r)

Randomize the nameserver list in the resolver.

Parameters:
[in]rthe resolver

Definition at line 1333 of file resolver.c.

References ldns_resolver_nameservers(), ldns_resolver_nameserver_count(), ldns_get_random(), and ldns_resolver_set_nameservers().

bool ldns_resolver_trusted_key ( const ldns_resolver r,
ldns_rr_list keys,
ldns_rr_list trusted_keys 
)

Returns true if at least one of the provided keys is a trust anchor.

Parameters:
[in]rthe current resolver
[in]keysthe keyset to check
[out]trusted_keysthe subset of trusted keys in the 'keys' rrset
Returns:
true if at least one of the provided keys is a configured trust anchor

Definition at line 132 of file resolver.c.

References ldns_resolver_dnssec_anchors(), ldns_rr_list_rr_count(), ldns_rr_list_rr(), ldns_rr_list_contains_rr(), and ldns_rr_list_push_rr().