resolver.h

Go to the documentation of this file.
00001 /*
00002  * resolver.h
00003  *
00004  * DNS Resolver definitions
00005  *
00006  * a Net::DNS like library for C
00007  *
00008  * (c) NLnet Labs, 2005-2006
00009  *
00010  * See the file LICENSE for the license
00011  */
00012 
00020 #ifndef LDNS_RESOLVER_H
00021 #define LDNS_RESOLVER_H
00022 
00023 #include <ldns/error.h>
00024 #include <ldns/common.h>
00025 #include <ldns/rr.h>
00026 #include <ldns/tsig.h>
00027 #include <ldns/rdata.h>
00028 #include <ldns/packet.h>
00029 #include <sys/time.h>
00030 
00032 #define LDNS_RESOLV_CONF        "/etc/resolv.conf"
00033 
00034 #define LDNS_RESOLV_HOSTS       "/etc/hosts"
00035 
00036 #define LDNS_RESOLV_KEYWORD     -1      
00037 #define LDNS_RESOLV_DEFDOMAIN   0
00038 #define LDNS_RESOLV_NAMESERVER  1
00039 #define LDNS_RESOLV_SEARCH      2
00040 #define LDNS_RESOLV_SORTLIST    3
00041 #define LDNS_RESOLV_OPTIONS     4
00042 #define LDNS_RESOLV_ANCHOR      5
00043 #define LDNS_RESOLV_KEYWORDS    6
00044 
00045 #define LDNS_RESOLV_INETANY             0
00046 #define LDNS_RESOLV_INET                1
00047 #define LDNS_RESOLV_INET6               2
00048 
00049 #define LDNS_RESOLV_RTT_INF             0       /* infinity */
00050 #define LDNS_RESOLV_RTT_MIN             1       /* reachable */
00051 
00055 struct ldns_struct_resolver
00056 {
00058         uint16_t _port;
00059 
00061         ldns_rdf **_nameservers; 
00063         size_t _nameserver_count; /* how many do we have */
00064 
00066         size_t *_rtt;
00067 
00069         bool _recursive;
00070 
00072         bool _debug;
00073         
00075         ldns_rdf *_domain; 
00076 
00078         ldns_rdf **_searchlist;
00079 
00081         size_t _searchlist_count;
00082 
00084         uint8_t _retry;
00086         uint8_t _retrans;
00087 
00089         bool _dnssec;
00091         bool _dnssec_cd;
00093         ldns_rr_list * _dnssec_anchors;
00095         bool _usevc;
00097         bool _igntc;
00099         uint8_t _ip6;
00101         bool _defnames;
00103         bool _dnsrch;
00105         struct timeval _timeout;
00107         bool _fail;
00109         bool _random;
00111         int _socket;
00115         int _axfr_soa_count;
00116         /* when axfring we get complete packets from the server
00117            but we want to give the caller 1 rr at a time, so
00118            keep the current pkt */
00120         ldns_pkt *_cur_axfr_pkt;
00122         uint16_t _axfr_i;
00123         /* EDNS0 available buffer size */
00124         uint16_t _edns_udp_size;
00125         
00126         /* Optional tsig key for signing queries,
00127         outgoing messages are signed if and only if both are set
00128         */
00130         char *_tsig_keyname;
00132         char *_tsig_keydata;
00134         char *_tsig_algorithm;
00135 };
00136 typedef struct ldns_struct_resolver ldns_resolver;
00137 
00138 /* prototypes */
00139 /* read access functions */
00140 
00146 uint16_t ldns_resolver_port(const ldns_resolver *r);
00147 
00153 bool ldns_resolver_recursive(const ldns_resolver *r);
00154 
00160 bool ldns_resolver_debug(const ldns_resolver *r);
00161 
00167 uint8_t ldns_resolver_retry(const ldns_resolver *r);
00168 
00174 uint8_t ldns_resolver_retrans(const ldns_resolver *r);
00175 
00181 uint8_t ldns_resolver_ip6(const ldns_resolver *r);
00182 
00188 uint16_t ldns_resolver_edns_udp_size(const ldns_resolver *r);
00194 bool ldns_resolver_usevc(const ldns_resolver *r);
00200 bool ldns_resolver_fail(const ldns_resolver *r);
00206 bool ldns_resolver_dnssec(const ldns_resolver *r);
00212 bool ldns_resolver_dnssec_cd(const ldns_resolver *r);
00218 ldns_rr_list * ldns_resolver_dnssec_anchors(const ldns_resolver *r);
00224 bool ldns_resolver_igntc(const ldns_resolver *r);
00230 bool ldns_resolver_random(const ldns_resolver *r);
00236 size_t ldns_resolver_nameserver_count(const ldns_resolver *r);
00242 ldns_rdf *ldns_resolver_domain(const ldns_resolver *r);
00248 struct timeval ldns_resolver_timeout(const ldns_resolver *r);
00254 ldns_rdf** ldns_resolver_searchlist(const ldns_resolver *r);
00260 ldns_rdf** ldns_resolver_nameservers(const ldns_resolver *r);
00267 size_t * ldns_resolver_rtt(const ldns_resolver *r);
00274 size_t ldns_resolver_nameserver_rtt(const ldns_resolver *r, size_t pos);
00280 char *ldns_resolver_tsig_keyname(const ldns_resolver *r);
00286 char *ldns_resolver_tsig_algorithm(const ldns_resolver *r);
00292 char *ldns_resolver_tsig_keydata(const ldns_resolver *r);
00298 ldns_rdf* ldns_resolver_pop_nameserver(ldns_resolver *r);
00299 
00305 size_t ldns_resolver_searchlist_count(const ldns_resolver *r);
00306 
00307 /* write access function */
00313 void ldns_resolver_set_port(ldns_resolver *r, uint16_t p);
00314 
00320 void ldns_resolver_set_recursive(ldns_resolver *r, bool b);
00321 
00327 void ldns_resolver_set_debug(ldns_resolver *r, bool b);
00328 
00333 void ldns_resolver_incr_nameserver_count(ldns_resolver *r);
00334 
00339 void ldns_resolver_dec_nameserver_count(ldns_resolver *r);
00340 
00347 void ldns_resolver_set_nameserver_rrlist(ldns_resolver *r, ldns_rr_list *ns);
00348 
00354 void ldns_resolver_set_nameserver_count(ldns_resolver *r, size_t c);
00355 
00361 void ldns_resolver_set_nameservers(ldns_resolver *r, ldns_rdf **rd);
00362 
00369 void ldns_resolver_set_domain(ldns_resolver *r, ldns_rdf *rd);
00370 
00376 void ldns_resolver_set_timeout(ldns_resolver *r, struct timeval timeout);
00377 
00383 void ldns_resolver_push_searchlist(ldns_resolver *r, ldns_rdf *rd);
00384 
00390 void ldns_resolver_set_defnames(ldns_resolver *r, bool b);
00391 
00397 void ldns_resolver_set_usevc(ldns_resolver *r, bool b);
00398 
00404 void ldns_resolver_set_dnsrch(ldns_resolver *r, bool b);
00405 
00411 void ldns_resolver_set_dnssec(ldns_resolver *r, bool b);
00412 
00418 void ldns_resolver_set_dnssec_cd(ldns_resolver *r, bool b);
00424 void ldns_resolver_set_dnssec_anchors(ldns_resolver *r, ldns_rr_list * l);
00425 
00432 ldns_status ldns_resolver_push_dnssec_anchor(ldns_resolver *r, ldns_rr *rr);
00433 
00439 void ldns_resolver_set_retrans(ldns_resolver *r, uint8_t re);
00440 
00446 void ldns_resolver_set_retry(ldns_resolver *r, uint8_t re);
00447 
00453 void ldns_resolver_set_ip6(ldns_resolver *r, uint8_t i);
00454 
00460 void ldns_resolver_set_fail(ldns_resolver *r, bool b);
00461 
00467 void ldns_resolver_set_igntc(ldns_resolver *r, bool b);
00468 
00474 void ldns_resolver_set_edns_udp_size(ldns_resolver *r, uint16_t s);
00475 
00481 void ldns_resolver_set_tsig_keyname(ldns_resolver *r, char *tsig_keyname);
00482 
00488 void ldns_resolver_set_tsig_algorithm(ldns_resolver *r, char *tsig_algorithm);
00489 
00495 void ldns_resolver_set_tsig_keydata(ldns_resolver *r, char *tsig_keydata);
00496 
00503 void ldns_resolver_set_rtt(ldns_resolver *r, size_t *rtt);
00504 
00512 void ldns_resolver_set_nameserver_rtt(ldns_resolver *r, size_t pos, size_t value);
00513 
00519 void ldns_resolver_set_random(ldns_resolver *r, bool b);
00520 
00528 ldns_status ldns_resolver_push_nameserver(ldns_resolver *r, ldns_rdf *n);
00529 
00537 ldns_status ldns_resolver_push_nameserver_rr(ldns_resolver *r, ldns_rr *rr);
00538 
00545 ldns_status ldns_resolver_push_nameserver_rr_list(ldns_resolver *r, ldns_rr_list *rrlist);
00546 
00558 ldns_pkt* ldns_resolver_search(const ldns_resolver *r, const ldns_rdf *rdf, ldns_rr_type t, ldns_rr_class c, uint16_t flags);
00559 
00570 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);
00571 
00582 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);
00583 
00590 ldns_status ldns_resolver_send_pkt(ldns_pkt **answer, const ldns_resolver *r, const ldns_pkt *query_pkt);
00591 
00602 ldns_pkt* ldns_resolver_query(const ldns_resolver *r, const ldns_rdf *name, ldns_rr_type type, ldns_rr_class class, uint16_t flags);
00603 
00604 
00609 ldns_resolver* ldns_resolver_new(void);
00610 
00618 ldns_status ldns_resolver_new_frm_fp(ldns_resolver **r, FILE *fp);
00619 
00628 ldns_status ldns_resolver_new_frm_fp_l(ldns_resolver **r, FILE *fp, int *line_nr);
00629 
00638 ldns_status ldns_resolver_new_frm_file(ldns_resolver **r, const char *filename);
00639 
00644 void ldns_resolver_free(ldns_resolver *res);
00645 
00650 void ldns_resolver_deep_free(ldns_resolver *res);
00651 
00658 ldns_rr* ldns_axfr_next(ldns_resolver *resolver);
00659 
00665 bool ldns_axfr_complete(const ldns_resolver *resolver);
00666 
00673 ldns_pkt *ldns_axfr_last_pkt(const ldns_resolver *res);
00674 
00679 void ldns_resolver_nameservers_randomize(ldns_resolver *r);
00680 
00688 bool ldns_resolver_trusted_key(const ldns_resolver *r, ldns_rr_list * keys, ldns_rr_list * trusted_keys);
00689 
00690 #endif  /* LDNS_RESOLVER_H */

Generated on Fri Sep 19 13:35:25 2008 for ldns by  doxygen 1.5.5