resolver.h
Go to the documentation of this file.
1/*
2 * resolver.h
3 *
4 * DNS Resolver definitions
5 *
6 * a Net::DNS like library for C
7 *
8 * (c) NLnet Labs, 2005-2006
9 *
10 * See the file LICENSE for the license
11 */
12
20#ifndef LDNS_RESOLVER_H
21#define LDNS_RESOLVER_H
22
23#include <ldns/error.h>
24#include <ldns/common.h>
25#include <ldns/rr.h>
26#include <ldns/tsig.h>
27#include <ldns/rdata.h>
28#include <ldns/packet.h>
29#include <sys/time.h>
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
36#define LDNS_RESOLV_CONF "/etc/resolv.conf"
38#define LDNS_RESOLV_HOSTS "/etc/hosts"
39
40#define LDNS_RESOLV_KEYWORD -1
41#define LDNS_RESOLV_DEFDOMAIN 0
42#define LDNS_RESOLV_NAMESERVER 1
43#define LDNS_RESOLV_SEARCH 2
44#define LDNS_RESOLV_SORTLIST 3
45#define LDNS_RESOLV_OPTIONS 4
46#define LDNS_RESOLV_ANCHOR 5
47#define LDNS_RESOLV_KEYWORDS 6
48
49#define LDNS_RESOLV_INETANY 0
50#define LDNS_RESOLV_INET 1
51#define LDNS_RESOLV_INET6 2
52
53#define LDNS_RESOLV_RTT_INF 0 /* infinity */
54#define LDNS_RESOLV_RTT_MIN 1 /* reachable */
55
60{
62 uint16_t _port;
63
67 size_t _nameserver_count; /* how many do we have */
68
70 size_t *_rtt;
71
74
76 bool _debug;
77
80
83
86
88 uint8_t _retry;
90 uint8_t _retrans;
93
95 bool _dnssec;
101 bool _usevc;
103 bool _igntc;
105 uint8_t _ip6;
111 struct timeval _timeout;
113 bool _fail;
122 /* when axfring we get complete packets from the server
123 but we want to give the caller 1 rr at a time, so
124 keep the current pkt */
128 uint16_t _axfr_i;
129 /* EDNS0 available buffer size */
131 /* serial for IXFR */
132 uint32_t _serial;
133
134 /* Optional tsig key for signing queries,
135 outgoing messages are signed if and only if both are set
136 */
143
146};
148
149/* prototypes */
150/* read access functions */
151
157uint16_t ldns_resolver_port(const ldns_resolver *r);
158
165
172
179
185uint8_t ldns_resolver_retry(const ldns_resolver *r);
186
192uint8_t ldns_resolver_retrans(const ldns_resolver *r);
193
200
206uint8_t ldns_resolver_ip6(const ldns_resolver *r);
207
225bool ldns_resolver_fail(const ldns_resolver *r);
285struct timeval ldns_resolver_timeout(const ldns_resolver *r);
304size_t * ldns_resolver_rtt(const ldns_resolver *r);
311size_t ldns_resolver_nameserver_rtt(const ldns_resolver *r, size_t pos);
318const char *ldns_resolver_tsig_keyname(const ldns_resolver *r);
325const char *ldns_resolver_tsig_algorithm(const ldns_resolver *r);
332const char *ldns_resolver_tsig_keydata(const ldns_resolver *r);
339
346
347/* write access function */
353void ldns_resolver_set_port(ldns_resolver *r, uint16_t p);
354
361
368
375
381
387
394
401
409
415void ldns_resolver_set_timeout(ldns_resolver *r, struct timeval timeout);
416
423
430
437
444
451
464
472
478void ldns_resolver_set_retrans(ldns_resolver *r, uint8_t re);
479
486void ldns_resolver_set_fallback(ldns_resolver *r, bool fallback);
487
494void ldns_resolver_set_retry(ldns_resolver *r, uint8_t re);
495
501void ldns_resolver_set_ip6(ldns_resolver *r, uint8_t i);
502
509
516
523
529void ldns_resolver_set_tsig_keyname(ldns_resolver *r, const char *tsig_keyname);
530
536void ldns_resolver_set_tsig_algorithm(ldns_resolver *r, const char *tsig_algorithm);
537
543void ldns_resolver_set_tsig_keydata(ldns_resolver *r, const char *tsig_keydata);
544
551void ldns_resolver_set_rtt(ldns_resolver *r, size_t *rtt);
552
560void ldns_resolver_set_nameserver_rtt(ldns_resolver *r, size_t pos, size_t value);
561
568
577
586
594
607ldns_pkt* ldns_resolver_search(const ldns_resolver *r, const ldns_rdf *rdf, ldns_rr_type t, ldns_rr_class c, uint16_t flags);
608
609
624
637
649ldns_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);
650
658
672
673
687ldns_pkt* ldns_resolver_query(const ldns_resolver *r, const ldns_rdf *name, ldns_rr_type t, ldns_rr_class c, uint16_t flags);
688
689
695
702
711
720ldns_status ldns_resolver_new_frm_fp_l(ldns_resolver **r, FILE *fp, int *line_nr);
721
730ldns_status ldns_resolver_new_frm_file(ldns_resolver **r, const char *filename);
731
737
743
753
758void ldns_axfr_abort(ldns_resolver *resolver);
759
765bool ldns_axfr_complete(const ldns_resolver *resolver);
766
774
780void ldns_resolver_set_ixfr_serial(ldns_resolver *r, uint32_t serial);
781
788
794
802bool ldns_resolver_trusted_key(const ldns_resolver *r, ldns_rr_list * keys, ldns_rr_list * trusted_keys);
803
804#ifdef __cplusplus
805}
806#endif
807
808#endif /* LDNS_RESOLVER_H */
Common definitions for LDNS.
Defines error numbers and functions to translate those to a readable string.
enum ldns_enum_status ldns_status
Definition error.h:148
Contains the definition of ldns_pkt and its parts, as well as functions to manipulate those.
Defines ldns_rdf and functions to manipulate those.
void ldns_resolver_set_edns_udp_size(ldns_resolver *r, uint16_t s)
Set maximum udp size.
Definition resolver.c:373
void ldns_resolver_set_retrans(ldns_resolver *r, uint8_t re)
Set the resolver retrans timeout (in seconds)
Definition resolver.c:476
size_t * ldns_resolver_rtt(const ldns_resolver *r)
Return the used round trip times for the nameservers.
Definition resolver.c:177
ldns_status ldns_resolver_push_nameserver_rr_list(ldns_resolver *r, const ldns_rr_list *rrlist)
Push a new nameserver rr_list to the resolver.
Definition resolver.c:351
ldns_rr_list * ldns_resolver_dnssec_anchors(const ldns_resolver *r)
Get the resolver's DNSSEC anchors.
Definition resolver.c:132
void ldns_resolver_set_tsig_algorithm(ldns_resolver *r, const char *tsig_algorithm)
Set the tsig algorithm.
Definition resolver.c:587
void ldns_resolver_set_fail(ldns_resolver *r, signed char b)
Whether or not to fail after one failed query.
Definition resolver.c:446
const char * ldns_resolver_tsig_keydata(const ldns_resolver *r)
Return the tsig keydata as used by the nameserver.
Definition resolver.c:219
void ldns_resolver_set_timeout(ldns_resolver *r, struct timeval timeout)
Set the resolver's socket time out when talking to remote hosts.
Definition resolver.c:551
void ldns_resolver_set_retry(ldns_resolver *r, uint8_t re)
Set the number of times a resolver should retry a nameserver before the next one is tried.
Definition resolver.c:470
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.
Definition resolver.c:1229
void ldns_resolver_set_tsig_keydata(ldns_resolver *r, const char *tsig_keydata)
Set the tsig key data.
Definition resolver.c:594
void ldns_resolver_set_dnssec_anchors(ldns_resolver *r, ldns_rr_list *l)
Set the resolver's DNSSEC anchor list directly.
Definition resolver.c:397
ldns_rr * ldns_axfr_next(ldns_resolver *resolver)
Get the next stream of RRs in a AXFR.
Definition resolver.c:1407
signed char ldns_resolver_dnssec_cd(const ldns_resolver *r)
Does the resolver set the CD bit.
Definition resolver.c:126
signed char ldns_resolver_fail(const ldns_resolver *r)
Does the resolver only try the first nameserver.
Definition resolver.c:84
ldns_rdf ** ldns_resolver_searchlist(const ldns_resolver *r)
What is the searchlist as used by the resolver.
Definition resolver.c:102
void ldns_resolver_set_dnsrch(ldns_resolver *r, signed char b)
Whether the resolver uses the searchlist.
Definition resolver.c:464
void ldns_resolver_set_nameserver_rtt(ldns_resolver *r, size_t pos, size_t value)
Set round trip time for a specific nameserver.
Definition resolver.c:506
signed char ldns_axfr_complete(const ldns_resolver *resolver)
Returns true if the axfr transfer has completed (i.e.
Definition resolver.c:1514
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.
Definition resolver.c:765
signed char ldns_resolver_recursive(const ldns_resolver *r)
Is the resolver set to recurse.
Definition resolver.c:66
size_t ldns_resolver_searchlist_count(const ldns_resolver *r)
Return the resolver's searchlist count.
Definition resolver.c:231
const char * ldns_resolver_tsig_keyname(const ldns_resolver *r)
Return the tsig keyname as used by the nameserver.
Definition resolver.c:207
signed char ldns_resolver_dnsrch(const ldns_resolver *r)
Does the resolver apply search list.
Definition resolver.c:78
void ldns_resolver_set_ip6(ldns_resolver *r, uint8_t i)
Whether the resolver uses ip6.
Definition resolver.c:440
signed char ldns_resolver_fallback(const ldns_resolver *r)
Get the truncation fallback status.
Definition resolver.c:54
void ldns_resolver_set_fallback(ldns_resolver *r, signed char fallback)
Set whether the resolvers truncation fallback mechanism is used when ldns_resolver_query() is called.
Definition resolver.c:482
size_t ldns_resolver_nameserver_count(const ldns_resolver *r)
How many nameserver are configured in the resolver.
Definition resolver.c:114
void ldns_resolver_free(ldns_resolver *res)
Frees the allocated space for this resolver.
Definition resolver.c:998
ldns_resolver * ldns_resolver_clone(ldns_resolver *r)
Clone a resolver.
Definition resolver.c:665
ldns_rdf ** ldns_resolver_nameservers(const ldns_resolver *r)
Return the configured nameserver ip address.
Definition resolver.c:108
void ldns_resolver_set_rtt(ldns_resolver *r, size_t *rtt)
Set round trip time for all nameservers.
Definition resolver.c:500
void ldns_resolver_dec_nameserver_count(ldns_resolver *r)
Decrement the resolver's nameserver count.
Definition resolver.c:532
ldns_status ldns_resolver_query_status(ldns_pkt **pkt, ldns_resolver *r, const ldns_rdf *name, ldns_rr_type t, ldns_rr_class c, uint16_t flags)
Send a query to a nameserver.
Definition resolver.c:1108
void ldns_resolver_set_ixfr_serial(ldns_resolver *r, uint32_t serial)
Get the serial for requesting IXFR.
Definition resolver.c:1527
uint8_t ldns_resolver_retrans(const ldns_resolver *r)
Get the retransmit interval.
Definition resolver.c:48
ldns_rdf * ldns_resolver_domain(const ldns_resolver *r)
What is the default dname to add to relative queries.
Definition resolver.c:96
void ldns_resolver_set_port(ldns_resolver *r, uint16_t p)
Set the port the resolver should use.
Definition resolver.c:238
size_t ldns_resolver_nameserver_rtt(const ldns_resolver *r, size_t pos)
Return the used round trip time for a specific nameserver.
Definition resolver.c:183
void ldns_resolver_nameservers_randomize(ldns_resolver *r)
Randomize the nameserver list in the resolver.
Definition resolver.c:1541
uint32_t ldns_resolver_get_ixfr_serial(const ldns_resolver *res)
Get the serial for requesting IXFR.
Definition resolver.c:1533
ldns_resolver * ldns_resolver_new(void)
Create a new resolver structure.
Definition resolver.c:608
signed char ldns_resolver_defnames(const ldns_resolver *r)
Does the resolver apply default domain name.
Definition resolver.c:90
uint16_t ldns_resolver_edns_udp_size(const ldns_resolver *r)
Get the resolver's udp size.
Definition resolver.c:36
void ldns_resolver_set_debug(ldns_resolver *r, signed char b)
Set the resolver debugging.
Definition resolver.c:434
void ldns_resolver_set_nameserver_count(ldns_resolver *r, size_t c)
Set the resolver's nameserver count directly.
Definition resolver.c:458
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 a...
Definition resolver.c:1095
signed char 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.
Definition resolver.c:138
signed char ldns_resolver_dnssec(const ldns_resolver *r)
Does the resolver do DNSSEC.
Definition resolver.c:120
struct timeval ldns_resolver_timeout(const ldns_resolver *r)
What is the timeout on socket connections.
Definition resolver.c:201
ldns_status ldns_resolver_push_nameserver(ldns_resolver *r, const ldns_rdf *n)
Push a new nameserver to the resolver.
Definition resolver.c:288
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 usable for in...
Definition resolver.c:1521
uint8_t ldns_resolver_ip6(const ldns_resolver *r)
Does the resolver use ip6 or ip4.
Definition resolver.c:60
signed char ldns_resolver_random(const ldns_resolver *r)
Does the resolver randomize the nameserver before usage.
Definition resolver.c:225
void ldns_resolver_set_nameservers(ldns_resolver *r, ldns_rdf **rd)
Set the resolver's nameserver count directly by using an rdf list.
Definition resolver.c:488
ldns_status ldns_resolver_push_dnssec_anchor(ldns_resolver *r, ldns_rr *rr)
Push a new trust anchor to the resolver.
Definition resolver.c:403
void ldns_resolver_set_source(ldns_resolver *r, ldns_rdf *s)
Set the source rdf (address) the resolver should use.
Definition resolver.c:244
uint8_t ldns_resolver_retry(const ldns_resolver *r)
Get the number of retries.
Definition resolver.c:42
ldns_rdf * ldns_resolver_source(const ldns_resolver *r)
Get the source address the resolver should use.
Definition resolver.c:30
void ldns_axfr_abort(ldns_resolver *resolver)
Abort a transfer that is in progress.
Definition resolver.c:1499
void ldns_resolver_set_defnames(ldns_resolver *r, signed char b)
Whether the resolver uses the name set with _set_domain.
Definition resolver.c:494
ldns_status ldns_resolver_push_nameserver_rr(ldns_resolver *r, const ldns_rr *rr)
Push a new nameserver to the resolver.
Definition resolver.c:335
void ldns_resolver_incr_nameserver_count(ldns_resolver *r)
Incremental the resolver's nameserver count.
Definition resolver.c:523
void ldns_resolver_set_domain(ldns_resolver *r, ldns_rdf *rd)
Set the resolver's default domain.
Definition resolver.c:545
ldns_rdf * ldns_resolver_pop_nameserver(ldns_resolver *r)
pop the last nameserver from the resolver.
Definition resolver.c:250
ldns_status ldns_resolver_search_status(ldns_pkt **pkt, 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 a...
Definition resolver.c:1051
void ldns_resolver_set_usevc(ldns_resolver *r, signed char b)
Whether the resolver uses a virtual circuit (TCP)
Definition resolver.c:428
signed char ldns_resolver_usevc(const ldns_resolver *r)
Does the resolver use tcp or udp.
Definition resolver.c:171
void ldns_resolver_set_tsig_keyname(ldns_resolver *r, const char *tsig_keyname)
Set the tsig key name.
Definition resolver.c:580
void ldns_resolver_set_dnssec(ldns_resolver *r, signed char b)
Whether the resolver uses DNSSEC.
Definition resolver.c:385
signed char ldns_resolver_igntc(const ldns_resolver *r)
Does the resolver ignore the TC bit (truncated)
Definition resolver.c:165
void ldns_resolver_set_random(ldns_resolver *r, signed char b)
Should the nameserver list be randomized before each use.
Definition resolver.c:601
const char * ldns_resolver_tsig_algorithm(const ldns_resolver *r)
Return the tsig algorithm as used by the nameserver.
Definition resolver.c:213
uint16_t ldns_resolver_port(const ldns_resolver *r)
Get the port the resolver should use.
Definition resolver.c:24
signed char ldns_resolver_debug(const ldns_resolver *r)
Get the debug status of the resolver.
Definition resolver.c:72
void ldns_resolver_push_searchlist(ldns_resolver *r, ldns_rdf *rd)
Push a new rd to the resolver's searchlist.
Definition resolver.c:558
void ldns_resolver_set_recursive(ldns_resolver *r, signed char b)
Set the resolver recursion.
Definition resolver.c:379
void ldns_resolver_set_igntc(ldns_resolver *r, signed char b)
Whether or not to ignore the TC bit.
Definition resolver.c:422
ldns_status ldns_resolver_new_frm_fp(ldns_resolver **r, FILE *fp)
Create a resolver structure from a file like /etc/resolv.conf.
Definition resolver.c:759
ldns_status ldns_resolver_send_pkt(ldns_pkt **answer, ldns_resolver *r, ldns_pkt *query_pkt)
Send the given packet to a nameserver.
Definition resolver.c:1171
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.
Definition resolver.c:1340
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.
Definition resolver.c:1129
void ldns_resolver_set_dnssec_cd(ldns_resolver *r, signed char b)
Whether the resolver uses the checking disable bit.
Definition resolver.c:391
void ldns_resolver_deep_free(ldns_resolver *res)
Frees the allocated space for this resolver and all it's data.
Definition resolver.c:1004
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 ...
Definition resolver.c:967
Contains the definition of ldns_rr and functions to manipulate those.
enum ldns_enum_rr_type ldns_rr_type
Definition rr.h:251
enum ldns_enum_rr_class ldns_rr_class
Definition rr.h:61
DNS packet.
Definition packet.h:235
Resource record data field.
Definition rdata.h:197
DNS stub resolver structure.
Definition resolver.h:60
ldns_pkt * _cur_axfr_pkt
Packet currently handled when doing part of an AXFR.
Definition resolver.h:126
int _socket
Keep some things to make AXFR possible.
Definition resolver.h:117
uint16_t _axfr_i
Counter for within the AXFR packets.
Definition resolver.h:128
char * _tsig_keyname
Name of the key to use with TSIG, if _tsig_keyname and _tsig_keydata both contain values,...
Definition resolver.h:138
uint8_t _retrans
Time to wait before retrying.
Definition resolver.h:90
signed char _fallback
Use new fallback mechanism (try EDNS, then do TCP)
Definition resolver.h:92
ldns_rdf * _source
Source address to query from.
Definition resolver.h:145
signed char _dnssec
Whether to do DNSSEC.
Definition resolver.h:95
uint16_t _edns_udp_size
Definition resolver.h:130
signed char _recursive
Whether or not to be recursive.
Definition resolver.h:73
signed char _dnsrch
If true apply the search list.
Definition resolver.h:109
signed char _usevc
Whether to use tcp or udp (tcp if the value is true)
Definition resolver.h:101
signed char _defnames
If true append the default domain.
Definition resolver.h:107
ldns_rr_list * _dnssec_anchors
Optional trust anchors for complete DNSSEC validation.
Definition resolver.h:99
size_t _nameserver_count
Number of nameservers in _nameservers.
Definition resolver.h:67
ldns_rdf ** _searchlist
Searchlist array, add the names in this array if a query cannot be found.
Definition resolver.h:82
signed char _igntc
Whether to ignore the tc bit.
Definition resolver.h:103
uint8_t _ip6
Whether to use ip6: 0->does not matter, 1 is IPv4, 2 is IPv6.
Definition resolver.h:105
ldns_rdf ** _nameservers
Array of nameservers to query (IP addresses or dnames)
Definition resolver.h:65
char * _tsig_keydata
Secret key data to use with TSIG, if _tsig_keyname and _tsig_keydata both contain values,...
Definition resolver.h:140
size_t * _rtt
Round trip time; 0 -> infinity.
Definition resolver.h:70
signed char _fail
Only try the first nameserver, and return with an error directly if it fails.
Definition resolver.h:113
char * _tsig_algorithm
TSIG signing algorithm.
Definition resolver.h:142
int _axfr_soa_count
Count the number of LDNS_RR_TYPE_SOA RRs we have seen so far (the second one signifies the end of the...
Definition resolver.h:121
signed char _dnssec_cd
Whether to set the CD bit on DNSSEC requests.
Definition resolver.h:97
size_t _searchlist_count
Number of entries in the searchlist array.
Definition resolver.h:85
struct timeval _timeout
Timeout for socket connections.
Definition resolver.h:111
signed char _debug
Print debug information.
Definition resolver.h:76
signed char _random
Randomly choose a nameserver.
Definition resolver.h:115
uint8_t _retry
Number of times to retry before giving up.
Definition resolver.h:88
ldns_rdf * _domain
Default domain to add to non fully qualified domain names.
Definition resolver.h:79
uint16_t _port
Port to send queries to.
Definition resolver.h:62
List or Set of Resource Records.
Definition rr.h:346
Resource Record.
Definition rr.h:318
Defines functions for TSIG usage.