ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/DNS.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/DNS.pm (file contents):
Revision 1.3 by root, Fri May 23 03:20:53 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 10:23:50 2008 UTC

2 2
3AnyEvent::DNS - fully asynchronous DNS resolution 3AnyEvent::DNS - fully asynchronous DNS resolution
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::DNS; 7 use AnyEvent::DNS;
8
9 my $cv = AnyEvent->condvar;
10 AnyEvent::DNS::a "www.google.de", $cv;
11 # ... later
12 my @addrs = $cv->recv;
8 13
9=head1 DESCRIPTION 14=head1 DESCRIPTION
10 15
11This module offers both a number of DNS convenience functions as well 16This module offers both a number of DNS convenience functions as well
12as a fully asynchronous and high-performance pure-perl stub resolver. 17as a fully asynchronous and high-performance pure-perl stub resolver.
13 18
19The stub resolver supports DNS over IPv4 and IPv6, UDP and TCP, optional
20EDNS0 support for up to 4kiB datagrams and automatically falls back to
21virtual circuit mode for large responses.
22
14=head2 CONVENIENCE FUNCTIONS 23=head2 CONVENIENCE FUNCTIONS
15
16# none yet
17 24
18=over 4 25=over 4
19 26
20=cut 27=cut
21 28
22package AnyEvent::DNS; 29package AnyEvent::DNS;
23 30
24no warnings; 31no warnings;
25use strict; 32use strict;
26 33
34use Socket qw(AF_INET SOCK_DGRAM SOCK_STREAM);
35
27use AnyEvent::Util (); 36use AnyEvent ();
37use AnyEvent::Handle ();
38use AnyEvent::Util qw(AF_INET6);
39
40our $VERSION = 4.14;
41
42our @DNS_FALLBACK = (v208.67.220.220, v208.67.222.222);
43
44=item AnyEvent::DNS::a $domain, $cb->(@addrs)
45
46Tries to resolve the given domain to IPv4 address(es).
47
48=item AnyEvent::DNS::aaaa $domain, $cb->(@addrs)
49
50Tries to resolve the given domain to IPv6 address(es).
51
52=item AnyEvent::DNS::mx $domain, $cb->(@hostnames)
53
54Tries to resolve the given domain into a sorted (lower preference value
55first) list of domain names.
56
57=item AnyEvent::DNS::ns $domain, $cb->(@hostnames)
58
59Tries to resolve the given domain name into a list of name servers.
60
61=item AnyEvent::DNS::txt $domain, $cb->(@hostnames)
62
63Tries to resolve the given domain name into a list of text records.
64
65=item AnyEvent::DNS::srv $service, $proto, $domain, $cb->(@srv_rr)
66
67Tries to resolve the given service, protocol and domain name into a list
68of service records.
69
70Each C<$srv_rr> is an array reference with the following contents:
71C<[$priority, $weight, $transport, $target]>.
72
73They will be sorted with lowest priority first, then randomly
74distributed by weight as per RFC 2782.
75
76Example:
77
78 AnyEvent::DNS::srv "sip", "udp", "schmorp.de", sub { ...
79 # @_ = ( [10, 10, 5060, "sip1.schmorp.de" ] )
80
81=item AnyEvent::DNS::ptr $domain, $cb->(@hostnames)
82
83Tries to make a PTR lookup on the given domain. See C<reverse_lookup>
84and C<reverse_verify> if you want to resolve an IP address to a hostname
85instead.
86
87=item AnyEvent::DNS::any $domain, $cb->(@rrs)
88
89Tries to resolve the given domain and passes all resource records found to
90the callback.
91
92=item AnyEvent::DNS::reverse_lookup $ipv4_or_6, $cb->(@hostnames)
93
94Tries to reverse-resolve the given IPv4 or IPv6 address (in textual form)
95into it's hostname(s). Handles V4MAPPED and V4COMPAT IPv6 addresses
96transparently.
97
98=item AnyEvent::DNS::reverse_verify $ipv4_or_6, $cb->(@hostnames)
99
100The same as C<reverse_lookup>, but does forward-lookups to verify that
101the resolved hostnames indeed point to the address, which makes spoofing
102harder.
103
104If you want to resolve an address into a hostname, this is the preferred
105method: The DNS records could still change, but at least this function
106verified that the hostname, at one point in the past, pointed at the IP
107address you originally resolved.
108
109Example:
110
111 AnyEvent::DNS::ptr "2001:500:2f::f", sub { print shift };
112 # => f.root-servers.net
113
114=cut
115
116sub MAX_PKT() { 4096 } # max packet size we advertise and accept
117
118sub DOMAIN_PORT() { 53 } # if this changes drop me a note
119
120sub resolver;
121
122sub a($$) {
123 my ($domain, $cb) = @_;
124
125 resolver->resolve ($domain => "a", sub {
126 $cb->(map $_->[3], @_);
127 });
128}
129
130sub aaaa($$) {
131 my ($domain, $cb) = @_;
132
133 resolver->resolve ($domain => "aaaa", sub {
134 $cb->(map $_->[3], @_);
135 });
136}
137
138sub mx($$) {
139 my ($domain, $cb) = @_;
140
141 resolver->resolve ($domain => "mx", sub {
142 $cb->(map $_->[4], sort { $a->[3] <=> $b->[3] } @_);
143 });
144}
145
146sub ns($$) {
147 my ($domain, $cb) = @_;
148
149 resolver->resolve ($domain => "ns", sub {
150 $cb->(map $_->[3], @_);
151 });
152}
153
154sub txt($$) {
155 my ($domain, $cb) = @_;
156
157 resolver->resolve ($domain => "txt", sub {
158 $cb->(map $_->[3], @_);
159 });
160}
161
162sub srv($$$$) {
163 my ($service, $proto, $domain, $cb) = @_;
164
165 # todo, ask for any and check glue records
166 resolver->resolve ("_$service._$proto.$domain" => "srv", sub {
167 my @res;
168
169 # classify by priority
170 my %pri;
171 push @{ $pri{$_->[3]} }, [ @$_[3,4,5,6] ]
172 for @_;
173
174 # order by priority
175 for my $pri (sort { $a <=> $b } keys %pri) {
176 # order by weight
177 my @rr = sort { $a->[1] <=> $b->[1] } @{ delete $pri{$pri} };
178
179 my $sum; $sum += $_->[1] for @rr;
180
181 while (@rr) {
182 my $w = int rand $sum + 1;
183 for (0 .. $#rr) {
184 if (($w -= $rr[$_][1]) <= 0) {
185 $sum -= $rr[$_][1];
186 push @res, splice @rr, $_, 1, ();
187 last;
188 }
189 }
190 }
191 }
192
193 $cb->(@res);
194 });
195}
196
197sub ptr($$) {
198 my ($domain, $cb) = @_;
199
200 resolver->resolve ($domain => "ptr", sub {
201 $cb->(map $_->[3], @_);
202 });
203}
204
205sub any($$) {
206 my ($domain, $cb) = @_;
207
208 resolver->resolve ($domain => "*", $cb);
209}
210
211# convert textual ip address into reverse lookup form
212sub _munge_ptr($) {
213 my $ipn = $_[0]
214 or return;
215
216 my $ptr;
217
218 my $af = AnyEvent::Socket::address_family ($ipn);
219
220 if ($af == AF_INET6) {
221 $ipn = substr $ipn, 0, 16; # anticipate future expansion
222
223 # handle v4mapped and v4compat
224 if ($ipn =~ s/^\x00{10}(?:\xff\xff|\x00\x00)//) {
225 $af = AF_INET;
226 } else {
227 $ptr = join ".", (reverse split //, unpack "H32", $ipn), "ip6.arpa.";
228 }
229 }
230
231 if ($af == AF_INET) {
232 $ptr = join ".", (reverse unpack "C4", $ipn), "in-addr.arpa.";
233 }
234
235 $ptr
236}
237
238sub reverse_lookup($$) {
239 my ($ip, $cb) = @_;
240
241 $ip = _munge_ptr AnyEvent::Socket::parse_address ($ip)
242 or return $cb->();
243
244 resolver->resolve ($ip => "ptr", sub {
245 $cb->(map $_->[3], @_);
246 });
247}
248
249sub reverse_verify($$) {
250 my ($ip, $cb) = @_;
251
252 my $ipn = AnyEvent::Socket::parse_address ($ip)
253 or return $cb->();
254
255 my $af = AnyEvent::Socket::address_family ($ipn);
256
257 my @res;
258 my $cnt;
259
260 my $ptr = _munge_ptr $ipn
261 or return $cb->();
262
263 $ip = AnyEvent::Socket::format_address ($ipn); # normalise into the same form
264
265 ptr $ptr, sub {
266 for my $name (@_) {
267 ++$cnt;
268
269 # () around AF_INET to work around bug in 5.8
270 resolver->resolve ("$name." => ($af == (AF_INET) ? "a" : "aaaa"), sub {
271 for (@_) {
272 push @res, $name
273 if $_->[3] eq $ip;
274 }
275 $cb->(@res) unless --$cnt;
276 });
277 }
278
279 $cb->() unless $cnt;
280 };
281}
282
283#################################################################################
28 284
29=back 285=back
30 286
31=head2 DNS EN-/DECODING FUNCTIONS 287=head2 LOW-LEVEL DNS EN-/DECODING FUNCTIONS
32 288
33=over 4 289=over 4
34 290
291=item $AnyEvent::DNS::EDNS0
292
293This variable decides whether dns_pack automatically enables EDNS0
294support. By default, this is disabled (C<0>), unless overridden by
295C<$ENV{PERL_ANYEVENT_EDNS0}>, but when set to C<1>, AnyEvent::DNS will use
296EDNS0 in all requests.
297
35=cut 298=cut
299
300our $EDNS0 = $ENV{PERL_ANYEVENT_EDNS0} * 1; # set to 1 to enable (partial) edns0
36 301
37our %opcode_id = ( 302our %opcode_id = (
38 query => 0, 303 query => 0,
39 iquery => 1, 304 iquery => 1,
40 status => 2, 305 status => 2,
306 notify => 4,
307 update => 5,
41 map +($_ => $_), 3..15 308 map +($_ => $_), 3, 6..15
42); 309);
43 310
44our %opcode_str = reverse %opcode_id; 311our %opcode_str = reverse %opcode_id;
45 312
46our %rcode_id = ( 313our %rcode_id = (
47 ok => 0, 314 noerror => 0,
48 formerr => 1, 315 formerr => 1,
49 servfail => 2, 316 servfail => 2,
50 nxdomain => 3, 317 nxdomain => 3,
51 notimp => 4, 318 notimp => 4,
52 refused => 5, 319 refused => 5,
320 yxdomain => 6, # Name Exists when it should not [RFC 2136]
321 yxrrset => 7, # RR Set Exists when it should not [RFC 2136]
322 nxrrset => 8, # RR Set that should exist does not [RFC 2136]
323 notauth => 9, # Server Not Authoritative for zone [RFC 2136]
324 notzone => 10, # Name not contained in zone [RFC 2136]
325# EDNS0 16 BADVERS Bad OPT Version [RFC 2671]
326# EDNS0 16 BADSIG TSIG Signature Failure [RFC 2845]
327# EDNS0 17 BADKEY Key not recognized [RFC 2845]
328# EDNS0 18 BADTIME Signature out of time window [RFC 2845]
329# EDNS0 19 BADMODE Bad TKEY Mode [RFC 2930]
330# EDNS0 20 BADNAME Duplicate key name [RFC 2930]
331# EDNS0 21 BADALG Algorithm not supported [RFC 2930]
53 map +($_ => $_), 6..15 332 map +($_ => $_), 11..15
54); 333);
55 334
56our %rcode_str = reverse %rcode_id; 335our %rcode_str = reverse %rcode_id;
57 336
58our %type_id = ( 337our %type_id = (
72 minfo => 14, 351 minfo => 14,
73 mx => 15, 352 mx => 15,
74 txt => 16, 353 txt => 16,
75 aaaa => 28, 354 aaaa => 28,
76 srv => 33, 355 srv => 33,
356 naptr => 35, # rfc2915
357 opt => 41,
358 spf => 99,
359 tkey => 249,
360 tsig => 250,
361 ixfr => 251,
77 axfr => 252, 362 axfr => 252,
78 mailb => 253, 363 mailb => 253,
79 "*" => 255, 364 "*" => 255,
80); 365);
81 366
82our %type_str = reverse %type_id; 367our %type_str = reverse %type_id;
83 368
84our %class_id = ( 369our %class_id = (
85 in => 1, 370 in => 1,
86 ch => 3, 371 ch => 3,
87 hs => 4, 372 hs => 4,
373 none => 254,
88 "*" => 255, 374 "*" => 255,
89); 375);
90 376
91our %class_str = reverse %class_id; 377our %class_str = reverse %class_id;
92 378
93# names MUST have a trailing dot
94sub _enc_qname($) { 379sub _enc_name($) {
95 pack "(C/a)*", (split /\./, shift), "" 380 pack "(C/a*)*", (split /\./, shift), ""
96} 381}
97 382
98sub _enc_qd() { 383sub _enc_qd() {
99 (_enc_qname $_->[0]) . pack "nn", 384 (_enc_name $_->[0]) . pack "nn",
100 ($_->[1] > 0 ? $_->[1] : $type_id {$_->[1]}), 385 ($_->[1] > 0 ? $_->[1] : $type_id {$_->[1]}),
101 ($_->[2] > 0 ? $_->[2] : $class_id{$_->[2] || "in"}) 386 ($_->[2] > 0 ? $_->[2] : $class_id{$_->[2] || "in"})
102} 387}
103 388
104sub _enc_rr() { 389sub _enc_rr() {
105 die "encoding of resource records is not supported"; 390 die "encoding of resource records is not supported";
106} 391}
107 392
108=item $pkt = AnyEvent::DNS::dns_pack $dns 393=item $pkt = AnyEvent::DNS::dns_pack $dns
109 394
110Packs a perl data structure into a DNS packet. Reading RFC1034 is strongly 395Packs a perl data structure into a DNS packet. Reading RFC 1035 is strongly
111recommended, then everything will be totally clear. Or maybe not. 396recommended, then everything will be totally clear. Or maybe not.
112 397
113Resource records are not yet encodable. 398Resource records are not yet encodable.
114 399
115Examples: 400Examples:
116 401
117 # very simple request, using lots of default values: 402 # very simple request, using lots of default values:
118 { rd => 1, qd => [ [ "host.domain", "a"] ] } 403 { rd => 1, qd => [ [ "host.domain", "a"] ] }
119 404
120 # more complex example, showing how flags etc. are named: 405 # more complex example, showing how flags etc. are named:
121 406
122 { 407 {
123 id => 10000, 408 id => 10000,
124 op => "query", 409 op => "query",
125 rc => "nxdomain", 410 rc => "nxdomain",
126 411
127 # flags 412 # flags
128 qr => 1, 413 qr => 1,
129 aa => 0, 414 aa => 0,
130 tc => 0, 415 tc => 0,
131 rd => 0, 416 rd => 0,
132 ra => 0, 417 ra => 0,
133 418 ad => 0,
419 cd => 0,
420
134 qd => [@rr], # query section 421 qd => [@rr], # query section
135 an => [@rr], # answer section 422 an => [@rr], # answer section
136 ns => [@rr], # authority section 423 ns => [@rr], # authority section
137 ar => [@rr], # additional records section 424 ar => [@rr], # additional records section
138 } 425 }
139 426
140=cut 427=cut
141 428
142sub dns_pack($) { 429sub dns_pack($) {
143 my ($req) = @_; 430 my ($req) = @_;
144 431
145 pack "nn nnnn a* a* a* a*", 432 pack "nn nnnn a* a* a* a* a*",
146 $req->{id}, 433 $req->{id},
147 434
148 ! !$req->{qr} * 0x8000 435 ! !$req->{qr} * 0x8000
149 + $opcode_id{$req->{op}} * 0x0800 436 + $opcode_id{$req->{op}} * 0x0800
150 + ! !$req->{aa} * 0x0400 437 + ! !$req->{aa} * 0x0400
151 + ! !$req->{tc} * 0x0200 438 + ! !$req->{tc} * 0x0200
152 + ! !$req->{rd} * 0x0100 439 + ! !$req->{rd} * 0x0100
153 + ! !$req->{ra} * 0x0080 440 + ! !$req->{ra} * 0x0080
441 + ! !$req->{ad} * 0x0020
442 + ! !$req->{cd} * 0x0010
154 + $rcode_id{$req->{rc}} * 0x0001, 443 + $rcode_id{$req->{rc}} * 0x0001,
155 444
156 scalar @{ $req->{qd} || [] }, 445 scalar @{ $req->{qd} || [] },
157 scalar @{ $req->{an} || [] }, 446 scalar @{ $req->{an} || [] },
158 scalar @{ $req->{ns} || [] }, 447 scalar @{ $req->{ns} || [] },
159 scalar @{ $req->{ar} || [] }, 448 $EDNS0 + scalar @{ $req->{ar} || [] }, # EDNS0 option included here
160 449
161 (join "", map _enc_qd, @{ $req->{qd} || [] }), 450 (join "", map _enc_qd, @{ $req->{qd} || [] }),
162 (join "", map _enc_rr, @{ $req->{an} || [] }), 451 (join "", map _enc_rr, @{ $req->{an} || [] }),
163 (join "", map _enc_rr, @{ $req->{ns} || [] }), 452 (join "", map _enc_rr, @{ $req->{ns} || [] }),
164 (join "", map _enc_rr, @{ $req->{ar} || [] }); 453 (join "", map _enc_rr, @{ $req->{ar} || [] }),
454
455 ($EDNS0 ? pack "C nnNn", 0, 41, MAX_PKT, 0, 0 : "") # EDNS0 option
165} 456}
166 457
167our $ofs; 458our $ofs;
168our $pkt; 459our $pkt;
169 460
170# bitches 461# bitches
171sub _dec_qname { 462sub _dec_name {
172 my @res; 463 my @res;
173 my $redir; 464 my $redir;
174 my $ptr = $ofs; 465 my $ptr = $ofs;
175 my $cnt; 466 my $cnt;
176 467
177 while () { 468 while () {
178 return undef if ++$cnt >= 256; # to avoid DoS attacks 469 return undef if ++$cnt >= 256; # to avoid DoS attacks
179 470
180 my $len = ord substr $pkt, $ptr++, 1; 471 my $len = ord substr $pkt, $ptr++, 1;
181 472
182 if ($len & 0xc0) { 473 if ($len >= 0xc0) {
183 $ptr++; 474 $ptr++;
184 $ofs = $ptr if $ptr > $ofs; 475 $ofs = $ptr if $ptr > $ofs;
185 $ptr = (unpack "n", substr $pkt, $ptr - 2, 2) & 0x3fff; 476 $ptr = (unpack "n", substr $pkt, $ptr - 2, 2) & 0x3fff;
186 } elsif ($len) { 477 } elsif ($len) {
187 push @res, substr $pkt, $ptr, $len; 478 push @res, substr $pkt, $ptr, $len;
192 } 483 }
193 } 484 }
194} 485}
195 486
196sub _dec_qd { 487sub _dec_qd {
197 my $qname = _dec_qname; 488 my $qname = _dec_name;
198 my ($qt, $qc) = unpack "nn", substr $pkt, $ofs; $ofs += 4; 489 my ($qt, $qc) = unpack "nn", substr $pkt, $ofs; $ofs += 4;
199 [$qname, $type_str{$qt} || $qt, $class_str{$qc} || $qc] 490 [$qname, $type_str{$qt} || $qt, $class_str{$qc} || $qc]
200} 491}
201 492
202our %dec_rr = ( 493our %dec_rr = (
203 1 => sub { Socket::inet_ntoa $_ }, # a 494 1 => sub { join ".", unpack "C4", $_ }, # a
204 2 => sub { local $ofs = $ofs - length; _dec_qname }, # ns 495 2 => sub { local $ofs = $ofs - length; _dec_name }, # ns
205 5 => sub { local $ofs = $ofs - length; _dec_qname }, # cname 496 5 => sub { local $ofs = $ofs - length; _dec_name }, # cname
206 6 => sub { 497 6 => sub {
207 local $ofs = $ofs - length; 498 local $ofs = $ofs - length;
208 my $mname = _dec_qname; 499 my $mname = _dec_name;
209 my $rname = _dec_qname; 500 my $rname = _dec_name;
210 ($mname, $rname, unpack "NNNNN", substr $pkt, $ofs) 501 ($mname, $rname, unpack "NNNNN", substr $pkt, $ofs)
211 }, # soa 502 }, # soa
212 11 => sub { ((Socket::inet_aton substr $_, 0, 4), unpack "C a*", substr $_, 4) }, # wks 503 11 => sub { ((join ".", unpack "C4", $_), unpack "C a*", substr $_, 4) }, # wks
213 12 => sub { local $ofs = $ofs - length; _dec_qname }, # ptr 504 12 => sub { local $ofs = $ofs - length; _dec_name }, # ptr
214 13 => sub { unpack "C/a C/a", $_ }, 505 13 => sub { unpack "C/a* C/a*", $_ }, # hinfo
215 15 => sub { local $ofs = $ofs + 2 - length; ((unpack "n", $_), _dec_qname) }, # mx 506 15 => sub { local $ofs = $ofs + 2 - length; ((unpack "n", $_), _dec_name) }, # mx
216 16 => sub { unpack "C/a", $_ }, # txt 507 16 => sub { unpack "(C/a*)*", $_ }, # txt
217 28 => sub { sprintf "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x", unpack "n8" }, # aaaa 508 28 => sub { AnyEvent::Socket::format_address ($_) }, # aaaa
218 33 => sub { local $ofs = $ofs + 6 - length; ((unpack "nnn", $_), _dec_qname) }, # srv 509 33 => sub { local $ofs = $ofs + 6 - length; ((unpack "nnn", $_), _dec_name) }, # srv
510 35 => sub { # naptr
511 # requires perl 5.10, sorry
512 my ($order, $preference, $flags, $service, $regexp, $offset) = unpack "nn C/a* C/a* C/a* .", $_;
513 local $ofs = $ofs + $offset - length;
514 ($order, $preference, $flags, $service, $regexp, _dec_name)
515 },
516 99 => sub { unpack "(C/a*)*", $_ }, # spf
219); 517);
220 518
221sub _dec_rr { 519sub _dec_rr {
222 my $qname = _dec_qname; 520 my $name = _dec_name;
223 521
224 my ($rt, $rc, $ttl, $rdlen) = unpack "nn N n", substr $pkt, $ofs; $ofs += 10; 522 my ($rt, $rc, $ttl, $rdlen) = unpack "nn N n", substr $pkt, $ofs; $ofs += 10;
225 local $_ = substr $pkt, $ofs, $rdlen; $ofs += $rdlen; 523 local $_ = substr $pkt, $ofs, $rdlen; $ofs += $rdlen;
226 524
227 [ 525 [
228 $qname, 526 $name,
229 $type_str{$rt} || $rt, 527 $type_str{$rt} || $rt,
230 $class_str{$rc} || $rc, 528 $class_str{$rc} || $rc,
231 ($dec_rr{$rt} || sub { $_ })->(), 529 ($dec_rr{$rt} || sub { $_ })->(),
232 ] 530 ]
233} 531}
236 534
237Unpacks a DNS packet into a perl data structure. 535Unpacks a DNS packet into a perl data structure.
238 536
239Examples: 537Examples:
240 538
241 # a non-successful reply 539 # an unsuccessful reply
242 { 540 {
243 'qd' => [ 541 'qd' => [
244 [ 'ruth.plan9.de.mach.uni-karlsruhe.de', '*', 'in' ] 542 [ 'ruth.plan9.de.mach.uni-karlsruhe.de', '*', 'in' ]
245 ], 543 ],
246 'rc' => 'nxdomain', 544 'rc' => 'nxdomain',
247 'ar' => [], 545 'ar' => [],
248 'ns' => [ 546 'ns' => [
249 [ 547 [
250 'uni-karlsruhe.de', 548 'uni-karlsruhe.de',
251 'soa', 549 'soa',
252 'in', 550 'in',
253 'netserv.rz.uni-karlsruhe.de', 551 'netserv.rz.uni-karlsruhe.de',
254 'hostmaster.rz.uni-karlsruhe.de', 552 'hostmaster.rz.uni-karlsruhe.de',
255 2008052201, 553 2008052201, 10800, 1800, 2592000, 86400
256 10800,
257 1800,
258 2592000,
259 86400
260 ] 554 ]
261 ], 555 ],
262 'tc' => '', 556 'tc' => '',
263 'ra' => 1, 557 'ra' => 1,
264 'qr' => 1, 558 'qr' => 1,
265 'id' => 45915, 559 'id' => 45915,
266 'aa' => '', 560 'aa' => '',
267 'an' => [], 561 'an' => [],
268 'rd' => 1, 562 'rd' => 1,
269 'op' => 'query' 563 'op' => 'query'
270 } 564 }
271 565
272 # a successful reply 566 # a successful reply
273 567
274 { 568 {
275 'qd' => [ [ 'www.google.de', 'a', 'in' ] ], 569 'qd' => [ [ 'www.google.de', 'a', 'in' ] ],
276 'rc' => 0, 570 'rc' => 0,
277 'ar' => [ 571 'ar' => [
278 [ 'a.l.google.com', 'a', 'in', '209.85.139.9' ], 572 [ 'a.l.google.com', 'a', 'in', '209.85.139.9' ],
279 [ 'b.l.google.com', 'a', 'in', '64.233.179.9' ], 573 [ 'b.l.google.com', 'a', 'in', '64.233.179.9' ],
280 [ 'c.l.google.com', 'a', 'in', '64.233.161.9' ], 574 [ 'c.l.google.com', 'a', 'in', '64.233.161.9' ],
281 ], 575 ],
282 'ns' => [ 576 'ns' => [
283 [ 'l.google.com', 'ns', 'in', 'a.l.google.com' ], 577 [ 'l.google.com', 'ns', 'in', 'a.l.google.com' ],
284 [ 'l.google.com', 'ns', 'in', 'b.l.google.com' ], 578 [ 'l.google.com', 'ns', 'in', 'b.l.google.com' ],
285 ], 579 ],
286 'tc' => '', 580 'tc' => '',
287 'ra' => 1, 581 'ra' => 1,
288 'qr' => 1, 582 'qr' => 1,
289 'id' => 64265, 583 'id' => 64265,
290 'aa' => '', 584 'aa' => '',
291 'an' => [ 585 'an' => [
292 [ 'www.google.de', 'cname', 'in', 'www.google.com' ], 586 [ 'www.google.de', 'cname', 'in', 'www.google.com' ],
293 [ 'www.google.com', 'cname', 'in', 'www.l.google.com' ], 587 [ 'www.google.com', 'cname', 'in', 'www.l.google.com' ],
294 [ 'www.l.google.com', 'a', 'in', '66.249.93.104' ], 588 [ 'www.l.google.com', 'a', 'in', '66.249.93.104' ],
295 [ 'www.l.google.com', 'a', 'in', '66.249.93.147' ], 589 [ 'www.l.google.com', 'a', 'in', '66.249.93.147' ],
296 ], 590 ],
297 'rd' => 1, 591 'rd' => 1,
298 'op' => 0 592 'op' => 0
299 } 593 }
300 594
301=cut 595=cut
302 596
303sub dns_unpack($) { 597sub dns_unpack($) {
304 local $pkt = shift; 598 local $pkt = shift;
312 qr => ! ! ($flags & 0x8000), 606 qr => ! ! ($flags & 0x8000),
313 aa => ! ! ($flags & 0x0400), 607 aa => ! ! ($flags & 0x0400),
314 tc => ! ! ($flags & 0x0200), 608 tc => ! ! ($flags & 0x0200),
315 rd => ! ! ($flags & 0x0100), 609 rd => ! ! ($flags & 0x0100),
316 ra => ! ! ($flags & 0x0080), 610 ra => ! ! ($flags & 0x0080),
611 ad => ! ! ($flags & 0x0020),
612 cd => ! ! ($flags & 0x0010),
317 op => $opcode_str{($flags & 0x001e) >> 11}, 613 op => $opcode_str{($flags & 0x001e) >> 11},
318 rc => $rcode_str{($flags & 0x000f)}, 614 rc => $rcode_str{($flags & 0x000f)},
319 615
320 qd => [map _dec_qd, 1 .. $qd], 616 qd => [map _dec_qd, 1 .. $qd],
321 an => [map _dec_rr, 1 .. $an], 617 an => [map _dec_rr, 1 .. $an],
328 624
329=back 625=back
330 626
331=head2 THE AnyEvent::DNS RESOLVER CLASS 627=head2 THE AnyEvent::DNS RESOLVER CLASS
332 628
333This is the class which deos the actual protocol work. 629This is the class which does the actual protocol work.
334 630
335=over 4 631=over 4
336 632
337=cut 633=cut
338 634
358our $RESOLVER; 654our $RESOLVER;
359 655
360sub resolver() { 656sub resolver() {
361 $RESOLVER || do { 657 $RESOLVER || do {
362 $RESOLVER = new AnyEvent::DNS; 658 $RESOLVER = new AnyEvent::DNS;
363 $RESOLVER->load_resolv_conf; 659 $RESOLVER->os_config;
364 $RESOLVER 660 $RESOLVER
365 } 661 }
366} 662}
367 663
368=item $resolver = new AnyEvent::DNS key => value... 664=item $resolver = new AnyEvent::DNS key => value...
369 665
370Creates and returns a new resolver. It only supports UDP, so make sure 666Creates and returns a new resolver.
371your answer sections fit into a DNS packet.
372 667
373The following options are supported: 668The following options are supported:
374 669
375=over 4 670=over 4
376 671
377=item server => [...] 672=item server => [...]
378 673
379A list of server addressses (default C<v127.0.0.1>) in network format (4 674A list of server addresses (default: C<v127.0.0.1>) in network format
380octets for IPv4, 16 octets for IPv6 - not yet supported). 675(i.e. as returned by C<AnyEvent::Socket::parse_address> - both IPv4 and
676IPv6 are supported).
381 677
382=item timeout => [...] 678=item timeout => [...]
383 679
384A list of timeouts to use (also determines the number of retries). To make 680A list of timeouts to use (also determines the number of retries). To make
385three retries with individual time-outs of 2, 5 and 5 seconds, use C<[2, 681three retries with individual time-outs of 2, 5 and 5 seconds, use C<[2,
394The number of dots (default: C<1>) that a name must have so that the resolver 690The number of dots (default: C<1>) that a name must have so that the resolver
395tries to resolve the name without any suffixes first. 691tries to resolve the name without any suffixes first.
396 692
397=item max_outstanding => $integer 693=item max_outstanding => $integer
398 694
399Most name servers do not handle many parallel requests very well. This option 695Most name servers do not handle many parallel requests very well. This
400limits the numbe rof outstanding requests to C<$n> (default: C<10>), that means 696option limits the number of outstanding requests to C<$integer>
401if you request more than this many requests, then the additional requests will be queued 697(default: C<10>), that means if you request more than this many requests,
402until some other requests have been resolved. 698then the additional requests will be queued until some other requests have
699been resolved.
700
701=item reuse => $seconds
702
703The number of seconds (default: C<300>) that a query id cannot be re-used
704after a timeout. If there was no time-out then query ids can be reused
705immediately.
403 706
404=back 707=back
405 708
406=cut 709=cut
407 710
408sub new { 711sub new {
409 my ($class, %arg) = @_; 712 my ($class, %arg) = @_;
410 713
411 socket my $fh, &Socket::AF_INET, &Socket::SOCK_DGRAM, 0
412 or Carp::croak "socket: $!";
413
414 AnyEvent::Util::fh_nonblocking $fh, 1;
415
416 my $self = bless { 714 my $self = bless {
417 server => [v127.0.0.1], 715 server => [],
418 timeout => [2, 5, 5], 716 timeout => [2, 5, 5],
419 search => [], 717 search => [],
420 ndots => 1, 718 ndots => 1,
421 max_outstanding => 10, 719 max_outstanding => 10,
422 reuse => 300, # reuse id's after 5 minutes only, if possible 720 reuse => 300,
423 %arg, 721 %arg,
424 fh => $fh,
425 reuse_q => [], 722 reuse_q => [],
426 }, $class; 723 }, $class;
427 724
428 # search should default to gethostname's domain 725 # search should default to gethostname's domain
429 # but perl lacks a good posix module 726 # but perl lacks a good posix module
430 727
728 # try to create an ipv4 and an ipv6 socket
729 # only fail when we cannot create either
730 my $got_socket;
731
431 Scalar::Util::weaken (my $wself = $self); 732 Scalar::Util::weaken (my $wself = $self);
733
734 if (socket my $fh4, AF_INET , &Socket::SOCK_DGRAM, 0) {
735 ++$got_socket;
736
737 AnyEvent::Util::fh_nonblocking $fh4, 1;
738 $self->{fh4} = $fh4;
432 $self->{rw} = AnyEvent->io (fh => $fh, poll => "r", cb => sub { $wself->_recv }); 739 $self->{rw4} = AnyEvent->io (fh => $fh4, poll => "r", cb => sub {
740 if (my $peer = recv $fh4, my $pkt, MAX_PKT, 0) {
741 $wself->_recv ($pkt, $peer);
742 }
743 });
744 }
745
746 if (AF_INET6 && socket my $fh6, AF_INET6, &Socket::SOCK_DGRAM, 0) {
747 ++$got_socket;
748
749 $self->{fh6} = $fh6;
750 AnyEvent::Util::fh_nonblocking $fh6, 1;
751 $self->{rw6} = AnyEvent->io (fh => $fh6, poll => "r", cb => sub {
752 if (my $peer = recv $fh6, my $pkt, MAX_PKT, 0) {
753 $wself->_recv ($pkt, $peer);
754 }
755 });
756 }
757
758 $got_socket
759 or Carp::croak "unable to create either an IPv4 or an IPv6 socket";
433 760
434 $self->_compile; 761 $self->_compile;
435 762
436 $self 763 $self
437} 764}
438 765
439=item $resolver->parse_resolv_conv ($string) 766=item $resolver->parse_resolv_conv ($string)
440 767
441Parses the given string a sif it were a F<resolv.conf> file. The following 768Parses the given string as if it were a F<resolv.conf> file. The following
442directives are supported: 769directives are supported (but not necessarily implemented).
443 770
444C<#>-style comments, C<nameserver>, C<domain>, C<search>, C<sortlist>, 771C<#>-style comments, C<nameserver>, C<domain>, C<search>, C<sortlist>,
445C<options> (C<timeout>, C<attempts>, C<ndots>). 772C<options> (C<timeout>, C<attempts>, C<ndots>).
446 773
447Everything else is silently ignored. 774Everything else is silently ignored.
459 for (split /\n/, $resolvconf) { 786 for (split /\n/, $resolvconf) {
460 if (/^\s*#/) { 787 if (/^\s*#/) {
461 # comment 788 # comment
462 } elsif (/^\s*nameserver\s+(\S+)\s*$/i) { 789 } elsif (/^\s*nameserver\s+(\S+)\s*$/i) {
463 my $ip = $1; 790 my $ip = $1;
464 if (AnyEvent::Util::dotted_quad $ip) { 791 if (my $ipn = AnyEvent::Socket::parse_address ($ip)) {
465 push @{ $self->{server} }, AnyEvent::Util::socket_inet_aton $ip; 792 push @{ $self->{server} }, $ipn;
466 } else { 793 } else {
467 warn "nameserver $ip invalid and ignored\n"; 794 warn "nameserver $ip invalid and ignored\n";
468 } 795 }
469 } elsif (/^\s*domain\s+(\S*)\s+$/i) { 796 } elsif (/^\s*domain\s+(\S*)\s+$/i) {
470 $self->{search} = [$1]; 797 $self->{search} = [$1];
491 if $attempts; 818 if $attempts;
492 819
493 $self->_compile; 820 $self->_compile;
494} 821}
495 822
496=item $resolver->load_resolv_conf 823=item $resolver->os_config
497 824
498Tries to load and parse F</etc/resolv.conf>. If there will ever be windows 825Tries so load and parse F</etc/resolv.conf> on portable operating systems. Tries various
499support, then this function will do the right thing under windows, too. 826egregious hacks on windows to force the DNS servers and searchlist out of the system.
500 827
501=cut 828=cut
502 829
503sub load_resolv_conf { 830sub os_config {
504 my ($self) = @_; 831 my ($self) = @_;
505 832
833 $self->{server} = [];
834 $self->{search} = [];
835
836 if (AnyEvent::WIN32 || $^O =~ /cygwin/i) {
837 no strict 'refs';
838
839 # there are many options to find the current nameservers etc. on windows
840 # all of them don't work consistently:
841 # - the registry thing needs separate code on win32 native vs. cygwin
842 # - the registry layout differs between windows versions
843 # - calling windows api functions doesn't work on cygwin
844 # - ipconfig uses locale-specific messages
845
846 # we use ipconfig parsing because, despite all its brokenness,
847 # it seems most stable in practise.
848 # for good measure, we append a fallback nameserver to our list.
849
850 if (open my $fh, "ipconfig /all |") {
851 # parsing strategy: we go through the output and look for
852 # :-lines with DNS in them. everything in those is regarded as
853 # either a nameserver (if it parses as an ip address), or a suffix
854 # (all else).
855
856 my $dns;
857 while (<$fh>) {
858 if (s/^\s.*\bdns\b.*://i) {
859 $dns = 1;
860 } elsif (/^\S/ || /^\s[^:]{16,}: /) {
861 $dns = 0;
862 }
863 if ($dns && /^\s*(\S+)\s*$/) {
864 my $s = $1;
865 $s =~ s/%\d+(?!\S)//; # get rid of ipv6 scope id
866 if (my $ipn = AnyEvent::Socket::parse_address ($s)) {
867 push @{ $self->{server} }, $ipn;
868 } else {
869 push @{ $self->{search} }, $s;
870 }
871 }
872 }
873
874 # always add one fallback server
875 push @{ $self->{server} }, $DNS_FALLBACK[rand @DNS_FALLBACK];
876
877 $self->_compile;
878 }
879 } else {
880 # try resolv.conf everywhere
881
506 open my $fh, "</etc/resolv.conf" 882 if (open my $fh, "</etc/resolv.conf") {
507 or return;
508
509 local $/; 883 local $/;
510 $self->parse_resolv_conf (<$fh>); 884 $self->parse_resolv_conf (<$fh>);
885 }
886 }
887}
888
889=item $resolver->timeout ($timeout, ...)
890
891Sets the timeout values. See the C<timeout> constructor argument (and note
892that this method uses the values itself, not an array-reference).
893
894=cut
895
896sub timeout {
897 my ($self, @timeout) = @_;
898
899 $self->{timeout} = \@timeout;
900 $self->_compile;
901}
902
903=item $resolver->max_outstanding ($nrequests)
904
905Sets the maximum number of outstanding requests to C<$nrequests>. See the
906C<max_outstanding> constructor argument.
907
908=cut
909
910sub max_outstanding {
911 my ($self, $max) = @_;
912
913 $self->{max_outstanding} = $max;
914 $self->_scheduler;
511} 915}
512 916
513sub _compile { 917sub _compile {
514 my $self = shift; 918 my $self = shift;
919
920 my %search; $self->{search} = [grep 0 < length, grep !$search{$_}++, @{ $self->{search} }];
921 my %server; $self->{server} = [grep 0 < length, grep !$server{$_}++, @{ $self->{server} }];
922
923 unless (@{ $self->{server} }) {
924 # use 127.0.0.1 by default, and one opendns nameserver as fallback
925 $self->{server} = [v127.0.0.1, $DNS_FALLBACK[rand @DNS_FALLBACK]];
926 }
515 927
516 my @retry; 928 my @retry;
517 929
518 for my $timeout (@{ $self->{timeout} }) { 930 for my $timeout (@{ $self->{timeout} }) {
519 for my $server (@{ $self->{server} }) { 931 for my $server (@{ $self->{server} }) {
522 } 934 }
523 935
524 $self->{retry} = \@retry; 936 $self->{retry} = \@retry;
525} 937}
526 938
939sub _feed {
940 my ($self, $res) = @_;
941
942 $res = dns_unpack $res
943 or return;
944
945 my $id = $self->{id}{$res->{id}};
946
947 return unless ref $id;
948
949 $NOW = time;
950 $id->[1]->($res);
951}
952
527sub _recv { 953sub _recv {
528 my ($self) = @_; 954 my ($self, $pkt, $peer) = @_;
529 955
530 while (my $peer = recv $self->{fh}, my $res, 1024, 0) { 956 # we ignore errors (often one gets port unreachable, but there is
957 # no good way to take advantage of that.
958
531 my ($port, $host) = Socket::unpack_sockaddr_in $peer; 959 my ($port, $host) = AnyEvent::Socket::unpack_sockaddr ($peer);
532 960
533 return unless $port == 53 && grep $_ eq $host, @{ $self->{server} }; 961 return unless $port == 53 && grep $_ eq $host, @{ $self->{server} };
534 962
535 $res = dns_unpack $res 963 $self->_feed ($pkt);
536 or return;
537
538 my $id = $self->{id}{$res->{id}};
539
540 return unless ref $id;
541
542 $NOW = time;
543 $id->[1]->($res);
544 }
545} 964}
546 965
966sub _free_id {
967 my ($self, $id, $timeout) = @_;
968
969 if ($timeout) {
970 # we need to block the id for a while
971 $self->{id}{$id} = 1;
972 push @{ $self->{reuse_q} }, [$NOW + $self->{reuse}, $id];
973 } else {
974 # we can quickly recycle the id
975 delete $self->{id}{$id};
976 }
977
978 --$self->{outstanding};
979 $self->_scheduler;
980}
981
982# execute a single request, involves sending it with timeouts to multiple servers
547sub _exec { 983sub _exec {
548 my ($self, $req, $retry) = @_; 984 my ($self, $req) = @_;
549 985
986 my $retry; # of retries
987 my $do_retry;
988
989 $do_retry = sub {
550 if (my $retry_cfg = $self->{retry}[$retry]) { 990 my $retry_cfg = $self->{retry}[$retry++]
991 or do {
992 # failure
993 $self->_free_id ($req->[2], $retry > 1);
994 undef $do_retry; return $req->[1]->();
995 };
996
551 my ($server, $timeout) = @$retry_cfg; 997 my ($server, $timeout) = @$retry_cfg;
552 998
553 $self->{id}{$req->[2]} = [AnyEvent->timer (after => $timeout, cb => sub { 999 $self->{id}{$req->[2]} = [AnyEvent->timer (after => $timeout, cb => sub {
554 $NOW = time; 1000 $NOW = time;
555 1001
556 # timeout, try next 1002 # timeout, try next
557 $self->_exec ($req, $retry + 1); 1003 &$do_retry;
558 }), sub { 1004 }), sub {
559 my ($res) = @_; 1005 my ($res) = @_;
560 1006
1007 if ($res->{tc}) {
1008 # success, but truncated, so use tcp
1009 AnyEvent::Socket::tcp_connect (AnyEvent::Socket::format_address ($server), DOMAIN_PORT, sub {
1010 return unless $do_retry; # some other request could have invalidated us already
1011
1012 my ($fh) = @_
1013 or return &$do_retry;
1014
1015 my $handle; $handle = new AnyEvent::Handle
1016 fh => $fh,
1017 timeout => $timeout,
1018 on_error => sub {
1019 undef $handle;
1020 return unless $do_retry; # some other request could have invalidated us already
1021 # failure, try next
1022 &$do_retry;
1023 };
1024
1025 $handle->push_write (pack "n/a", $req->[0]);
1026 $handle->push_read (chunk => 2, sub {
1027 $handle->unshift_read (chunk => (unpack "n", $_[1]), sub {
1028 undef $handle;
1029 $self->_feed ($_[1]);
1030 });
1031 });
1032
1033 }, sub { $timeout });
1034
1035 } else {
561 # success 1036 # success
562 $self->{id}{$req->[2]} = 1; 1037 $self->_free_id ($req->[2], $retry > 1);
563 push @{ $self->{reuse_q} }, [$NOW + $self->{reuse}, $req->[2]]; 1038 undef $do_retry; return $req->[1]->($res);
564 --$self->{outstanding}; 1039 }
565 $self->_scheduler;
566
567 $req->[1]->($res);
568 }]; 1040 }];
1041
1042 my $sa = AnyEvent::Socket::pack_sockaddr (DOMAIN_PORT, $server);
569 1043
570 send $self->{fh}, $req->[0], 0, Socket::pack_sockaddr_in 53, $server; 1044 my $fh = AF_INET == Socket::sockaddr_family ($sa)
571 } else { 1045 ? $self->{fh4} : $self->{fh6}
572 # failure 1046 or return &$do_retry;
573 $self->{id}{$req->[2]} = 1;
574 push @{ $self->{reuse_q} }, [$NOW + $self->{reuse}, $req->[2]];
575 --$self->{outstanding};
576 $self->_scheduler;
577 1047
578 $req->[1]->(); 1048 send $fh, $req->[0], 0, $sa;
579 } 1049 };
1050
1051 &$do_retry;
580} 1052}
581 1053
582sub _scheduler { 1054sub _scheduler {
583 my ($self) = @_; 1055 my ($self) = @_;
584 1056
1057 no strict 'refs';
1058
585 $NOW = time; 1059 $NOW = time;
586 1060
587 # first clear id reuse queue 1061 # first clear id reuse queue
588 delete $self->{id}{ (shift @{ $self->{reuse_q} })->[1] } 1062 delete $self->{id}{ (shift @{ $self->{reuse_q} })->[1] }
589 while @{ $self->{reuse_q} } && $self->{reuse_q}[0] <= $NOW; 1063 while @{ $self->{reuse_q} } && $self->{reuse_q}[0][0] <= $NOW;
590 1064
591 while ($self->{outstanding} < $self->{max_outstanding}) { 1065 while ($self->{outstanding} < $self->{max_outstanding}) {
592 my $req = shift @{ $self->{queue} } 1066
1067 if (@{ $self->{reuse_q} } >= 30000) {
1068 # we ran out of ID's, wait a bit
1069 $self->{reuse_to} ||= AnyEvent->timer (after => $self->{reuse_q}[0][0] - $NOW, cb => sub {
1070 delete $self->{reuse_to};
1071 $self->_scheduler;
1072 });
593 or last; 1073 last;
594
595 while () {
596 $req->[2] = int rand 65536;
597 last unless exists $self->{id}{$req->[2]};
598 } 1074 }
599 1075
1076 if (my $req = shift @{ $self->{queue} }) {
1077 # found a request in the queue, execute it
1078 while () {
1079 $req->[2] = int rand 65536;
1080 last unless exists $self->{id}{$req->[2]};
1081 }
1082
1083 ++$self->{outstanding};
600 $self->{id}{$req->[2]} = 1; 1084 $self->{id}{$req->[2]} = 1;
601 substr $req->[0], 0, 2, pack "n", $req->[2]; 1085 substr $req->[0], 0, 2, pack "n", $req->[2];
602 1086
603 ++$self->{outstanding};
604 $self->_exec ($req, 0); 1087 $self->_exec ($req);
1088
1089 } elsif (my $cb = shift @{ $self->{wait} }) {
1090 # found a wait_for_slot callback, call that one first
1091 $cb->($self);
1092
1093 } else {
1094 # nothing to do, just exit
1095 last;
1096 }
605 } 1097 }
606} 1098}
607 1099
608=item $resolver->request ($req, $cb->($res)) 1100=item $resolver->request ($req, $cb->($res))
609 1101
1102This is the main low-level workhorse for sending DNS requests.
1103
610Sends a single request (a hash-ref formated as specified for 1104This function sends a single request (a hash-ref formated as specified
611C<dns_pack>) to the configured nameservers including 1105for C<dns_pack>) to the configured nameservers in turn until it gets a
1106response. It handles timeouts, retries and automatically falls back to
1107virtual circuit mode (TCP) when it receives a truncated reply.
1108
612retries. Calls the callback with the decoded response packet if a reply 1109Calls the callback with the decoded response packet if a reply was
613was received, or no arguments on timeout. 1110received, or no arguments in case none of the servers answered.
614 1111
615=cut 1112=cut
616 1113
617sub request($$) { 1114sub request($$) {
618 my ($self, $req, $cb) = @_; 1115 my ($self, $req, $cb) = @_;
621 $self->_scheduler; 1118 $self->_scheduler;
622} 1119}
623 1120
624=item $resolver->resolve ($qname, $qtype, %options, $cb->($rcode, @rr)) 1121=item $resolver->resolve ($qname, $qtype, %options, $cb->($rcode, @rr))
625 1122
626Queries the DNS for the given domain name C<$qname> of type C<$qtype> (a 1123Queries the DNS for the given domain name C<$qname> of type C<$qtype>.
627qtype of "*" is supported and means "any"). 1124
1125A C<$qtype> is either a numerical query type (e.g. C<1> for A records) or
1126a lowercase name (you have to look at the source to see which aliases are
1127supported, but all types from RFC 1035, C<aaaa>, C<srv>, C<spf> and a few
1128more are known to this module). A C<$qtype> of "*" is supported and means
1129"any" record type.
628 1130
629The callback will be invoked with a list of matching result records or 1131The callback will be invoked with a list of matching result records or
630none on any error or if the name could not be found. 1132none on any error or if the name could not be found.
631 1133
632CNAME chains (although illegal) are followed up to a length of 8. 1134CNAME chains (although illegal) are followed up to a length of 10.
633 1135
1136The callback will be invoked with an result code in string form (noerror,
1137formerr, servfail, nxdomain, notimp, refused and so on), or numerical
1138form if the result code is not supported. The remaining arguments are
1139arraryefs of the form C<[$name, $type, $class, @data>], where C<$name> is
1140the domain name, C<$type> a type string or number, C<$class> a class name
1141and @data is resource-record-dependent data. For C<a> records, this will
1142be the textual IPv4 addresses, for C<ns> or C<cname> records this will be
1143a domain name, for C<txt> records these are all the strings and so on.
1144
1145All types mentioned in RFC 1035, C<aaaa>, C<srv>, C<naptr> and C<spf> are
1146decoded. All resource records not known to this module will have
1147the raw C<rdata> field as fourth entry.
1148
634Note that this resolver is just a stub resolver: it requires a nameserver 1149Note that this resolver is just a stub resolver: it requires a name server
635supporting recursive queries, will not do any recursive queries itself and 1150supporting recursive queries, will not do any recursive queries itself and
636is not secure when used against an untrusted name server. 1151is not secure when used against an untrusted name server.
637 1152
638The following options are supported: 1153The following options are supported:
639 1154
641 1156
642=item search => [$suffix...] 1157=item search => [$suffix...]
643 1158
644Use the given search list (which might be empty), by appending each one 1159Use the given search list (which might be empty), by appending each one
645in turn to the C<$qname>. If this option is missing then the configured 1160in turn to the C<$qname>. If this option is missing then the configured
646C<ndots> and C<search> define its value. If the C<$qname> ends in a dot, 1161C<ndots> and C<search> values define its value (depending on C<ndots>, the
647then the searchlist will be ignored. 1162empty suffix will be prepended or appended to that C<search> value). If
1163the C<$qname> ends in a dot, then the searchlist will be ignored.
648 1164
649=item accept => [$type...] 1165=item accept => [$type...]
650 1166
651Lists the acceptable result types: only result types in this set will be 1167Lists the acceptable result types: only result types in this set will be
652accepted and returned. The default includes the C<$qtype> and nothing 1168accepted and returned. The default includes the C<$qtype> and nothing
653else. 1169else. If this list includes C<cname>, then CNAME-chains will not be
1170followed (because you asked for the CNAME record).
654 1171
655=item class => "class" 1172=item class => "class"
656 1173
657Specify the query class ("in" for internet, "ch" for chaosnet and "hs" for 1174Specify the query class ("in" for internet, "ch" for chaosnet and "hs" for
658hesiod are the only ones making sense). The default is "in", of course. 1175hesiod are the only ones making sense). The default is "in", of course.
659 1176
660=back 1177=back
661 1178
662Examples: 1179Examples:
663 1180
664 $res->resolve ("ruth.plan9.de", "a", sub { 1181 # full example, you can paste this into perl:
665 warn Dumper [@_]; 1182 use Data::Dumper;
666 }); 1183 use AnyEvent::DNS;
1184 AnyEvent::DNS::resolver->resolve (
1185 "google.com", "*", my $cv = AnyEvent->condvar);
1186 warn Dumper [$cv->recv];
667 1187
1188 # shortened result:
668 [ 1189 # [
1190 # [ 'google.com', 'soa', 'in', 'ns1.google.com', 'dns-admin.google.com',
1191 # 2008052701, 7200, 1800, 1209600, 300 ],
669 [ 1192 # [
670 'ruth.schmorp.de', 1193 # 'google.com', 'txt', 'in',
671 'a', 1194 # 'v=spf1 include:_netblocks.google.com ~all'
672 'in', 1195 # ],
673 '129.13.162.95' 1196 # [ 'google.com', 'a', 'in', '64.233.187.99' ],
1197 # [ 'google.com', 'mx', 'in', 10, 'smtp2.google.com' ],
1198 # [ 'google.com', 'ns', 'in', 'ns2.google.com' ],
674 ] 1199 # ]
1200
1201 # resolve a records:
1202 $res->resolve ("ruth.plan9.de", "a", sub { warn Dumper [@_] });
1203
1204 # result:
1205 # [
1206 # [ 'ruth.schmorp.de', 'a', 'in', '129.13.162.95' ]
675 ] 1207 # ]
676 1208
1209 # resolve any records, but return only a and aaaa records:
677 $res->resolve ("test1.laendle", "*", 1210 $res->resolve ("test1.laendle", "*",
678 accept => ["a", "aaaa"], 1211 accept => ["a", "aaaa"],
679 sub { 1212 sub {
680 warn Dumper [@_]; 1213 warn Dumper [@_];
681 } 1214 }
682 ); 1215 );
683 1216
684 [ 1217 # result:
685 [ 1218 # [
686 'test1.laendle', 1219 # [ 'test1.laendle', 'a', 'in', '10.0.0.255' ],
687 'a', 1220 # [ 'test1.laendle', 'aaaa', 'in', '3ffe:1900:4545:0002:0240:0000:0000:f7e1' ]
688 'in',
689 '10.0.0.255'
690 ],
691 [
692 'test1.laendle',
693 'aaaa',
694 'in',
695 '3ffe:1900:4545:0002:0240:0000:0000:f7e1'
696 ] 1221 # ]
697 ]
698 1222
699=cut 1223=cut
700 1224
701sub resolve($%) { 1225sub resolve($%) {
702 my $cb = pop; 1226 my $cb = pop;
715 my %atype = $opt{accept} 1239 my %atype = $opt{accept}
716 ? map +($_ => 1), @{ $opt{accept} } 1240 ? map +($_ => 1), @{ $opt{accept} }
717 : ($qtype => 1); 1241 : ($qtype => 1);
718 1242
719 # advance in searchlist 1243 # advance in searchlist
720 my $do_search; $do_search = sub { 1244 my ($do_search, $do_req);
1245
1246 $do_search = sub {
721 @search 1247 @search
722 or return $cb->(); 1248 or (undef $do_search), (undef $do_req), return $cb->();
723 1249
724 (my $name = "$qname." . shift @search) =~ s/\.$//; 1250 (my $name = lc "$qname." . shift @search) =~ s/\.$//;
725 my $depth = 2; 1251 my $depth = 10;
726 1252
727 # advance in cname-chain 1253 # advance in cname-chain
728 my $do_req; $do_req = sub { 1254 $do_req = sub {
729 $self->request ({ 1255 $self->request ({
730 rd => 1, 1256 rd => 1,
731 qd => [[$name, $qtype, $class]], 1257 qd => [[$name, $qtype, $class]],
732 }, sub { 1258 }, sub {
733 my ($res) = @_ 1259 my ($res) = @_
735 1261
736 my $cname; 1262 my $cname;
737 1263
738 while () { 1264 while () {
739 # results found? 1265 # results found?
740 my @rr = grep $_->[0] eq $name && ($atype{"*"} || $atype{$_->[1]}), @{ $res->{an} }; 1266 my @rr = grep $name eq lc $_->[0] && ($atype{"*"} || $atype{$_->[1]}), @{ $res->{an} };
741 1267
742 return $cb->(@rr) 1268 (undef $do_search), (undef $do_req), return $cb->(@rr)
743 if @rr; 1269 if @rr;
744 1270
745 # see if there is a cname we can follow 1271 # see if there is a cname we can follow
746 my @rr = grep $_->[0] eq $name && $_->[1] eq "cname", @{ $res->{an} }; 1272 my @rr = grep $name eq lc $_->[0] && $_->[1] eq "cname", @{ $res->{an} };
747 1273
748 if (@rr) { 1274 if (@rr) {
749 $depth-- 1275 $depth--
750 or return $do_search->(); # cname chain too long 1276 or return $do_search->(); # cname chain too long
751 1277
768 }; 1294 };
769 1295
770 $do_search->(); 1296 $do_search->();
771} 1297}
772 1298
1299=item $resolver->wait_for_slot ($cb->($resolver))
1300
1301Wait until a free request slot is available and call the callback with the
1302resolver object.
1303
1304A request slot is used each time a request is actually sent to the
1305nameservers: There are never more than C<max_outstanding> of them.
1306
1307Although you can submit more requests (they will simply be queued until
1308a request slot becomes available), sometimes, usually for rate-limiting
1309purposes, it is useful to instead wait for a slot before generating the
1310request (or simply to know when the request load is low enough so one can
1311submit requests again).
1312
1313This is what this method does: The callback will be called when submitting
1314a DNS request will not result in that request being queued. The callback
1315may or may not generate any requests in response.
1316
1317Note that the callback will only be invoked when the request queue is
1318empty, so this does not play well if somebody else keeps the request queue
1319full at all times.
1320
1321=cut
1322
1323sub wait_for_slot {
1324 my ($self, $cb) = @_;
1325
1326 push @{ $self->{wait} }, $cb;
1327 $self->_scheduler;
1328}
1329
1330use AnyEvent::Socket (); # circular dependency, so do not import anything and do it at the end
1331
7731; 13321;
774 1333
775=back 1334=back
776 1335
777=head1 AUTHOR 1336=head1 AUTHOR
778 1337
779 Marc Lehmann <schmorp@schmorp.de> 1338 Marc Lehmann <schmorp@schmorp.de>
780 http://home.schmorp.de/ 1339 http://home.schmorp.de/
781 1340
782=cut 1341=cut
783 1342

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines