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.37 by root, Thu May 29 00:30:15 2008 UTC vs.
Revision 1.74 by root, Thu Aug 21 18:45:16 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 8
9 my $cv = AnyEvent->condvar; 9 my $cv = AnyEvent->condvar;
10 AnyEvent::DNS::a "www.google.de", $cv; 10 AnyEvent::DNS::a "www.google.de", $cv;
11 # ... later 11 # ... later
12 my @addrs = $cv->recv; 12 my @addrs = $cv->recv;
13 13
14=head1 DESCRIPTION 14=head1 DESCRIPTION
15 15
16This module offers both a number of DNS convenience functions as well 16This module offers both a number of DNS convenience functions as well
17as a fully asynchronous and high-performance pure-perl stub resolver. 17as a fully asynchronous and high-performance pure-perl stub resolver.
18 18
19The stub resolver supports DNS over UDP, optional EDNS0 support for up to 19The stub resolver supports DNS over IPv4 and IPv6, UDP and TCP, optional
204kiB datagrams and automatically falls back to virtual circuit mode for 20EDNS0 support for up to 4kiB datagrams and automatically falls back to
21large responses. 21virtual circuit mode for large responses.
22 22
23=head2 CONVENIENCE FUNCTIONS 23=head2 CONVENIENCE FUNCTIONS
24 24
25=over 4 25=over 4
26 26
35 35
36use AnyEvent (); 36use AnyEvent ();
37use AnyEvent::Handle (); 37use AnyEvent::Handle ();
38use AnyEvent::Util qw(AF_INET6); 38use AnyEvent::Util qw(AF_INET6);
39 39
40our $VERSION = 4.232;
41
40our @DNS_FALLBACK = (v208.67.220.220, v208.67.222.222); 42our @DNS_FALLBACK = (v208.67.220.220, v208.67.222.222);
41 43
42=item AnyEvent::DNS::a $domain, $cb->(@addrs) 44=item AnyEvent::DNS::a $domain, $cb->(@addrs)
43 45
44Tries to resolve the given domain to IPv4 address(es). 46Tries to resolve the given domain to IPv4 address(es).
63=item AnyEvent::DNS::srv $service, $proto, $domain, $cb->(@srv_rr) 65=item AnyEvent::DNS::srv $service, $proto, $domain, $cb->(@srv_rr)
64 66
65Tries to resolve the given service, protocol and domain name into a list 67Tries to resolve the given service, protocol and domain name into a list
66of service records. 68of service records.
67 69
68Each srv_rr is an array reference with the following contents: 70Each C<$srv_rr> is an array reference with the following contents:
69C<[$priority, $weight, $transport, $target]>. 71C<[$priority, $weight, $transport, $target]>.
70 72
71They will be sorted with lowest priority, highest weight first (TODO: 73They will be sorted with lowest priority first, then randomly
72should use the RFC algorithm to reorder same-priority records for weight). 74distributed by weight as per RFC 2782.
73 75
74Example: 76Example:
75 77
76 AnyEvent::DNS::srv "sip", "udp", "schmorp.de", sub { ... 78 AnyEvent::DNS::srv "sip", "udp", "schmorp.de", sub { ...
77 # @_ = ( [10, 10, 5060, "sip1.schmorp.de" ] ) 79 # @_ = ( [10, 10, 5060, "sip1.schmorp.de" ] )
78 80
79=item AnyEvent::DNS::ptr $ipv4_or_6, $cb->(@hostnames) 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)
80 93
81Tries to reverse-resolve the given IPv4 or IPv6 address (in textual form) 94Tries to reverse-resolve the given IPv4 or IPv6 address (in textual form)
82into it's hostname(s). 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.
83 108
84Example: 109Example:
85 110
86 AnyEvent::DNS::ptr "2001:500:2f::f", sub { print shift }; 111 AnyEvent::DNS::ptr "2001:500:2f::f", sub { print shift };
87 # => f.root-servers.net 112 # => f.root-servers.net
88 113
89=item AnyEvent::DNS::any $domain, $cb->(@rrs)
90
91Tries to resolve the given domain and passes all resource records found to
92the callback.
93
94=cut 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
95 119
96sub resolver; 120sub resolver;
97 121
98sub a($$) { 122sub a($$) {
99 my ($domain, $cb) = @_; 123 my ($domain, $cb) = @_;
138sub srv($$$$) { 162sub srv($$$$) {
139 my ($service, $proto, $domain, $cb) = @_; 163 my ($service, $proto, $domain, $cb) = @_;
140 164
141 # todo, ask for any and check glue records 165 # todo, ask for any and check glue records
142 resolver->resolve ("_$service._$proto.$domain" => "srv", sub { 166 resolver->resolve ("_$service._$proto.$domain" => "srv", sub {
143 $cb->(map [@$_[3,4,5,6]], sort { $a->[3] <=> $b->[3] || $b->[4] <=> $a->[4] } @_); 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);
144 }); 194 });
145} 195}
146 196
147sub ptr($$) { 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($$) {
148 my ($ip, $cb) = @_; 239 my ($ip, $cb) = @_;
149 240
150 $ip = AnyEvent::Socket::parse_address ($ip) 241 $ip = _munge_ptr AnyEvent::Socket::parse_address ($ip)
151 or return $cb->(); 242 or return $cb->();
152
153 my $af = AnyEvent::Socket::address_family ($ip);
154
155 if ($af == AF_INET) {
156 $ip = join ".", (reverse split /\./, $ip), "in-addr.arpa.";
157 } elsif ($af == AF_INET6) {
158 $ip = join ".", (reverse split //, unpack "H*", $ip), "ip6.arpa.";
159 } else {
160 return $cb->();
161 }
162 243
163 resolver->resolve ($ip => "ptr", sub { 244 resolver->resolve ($ip => "ptr", sub {
164 $cb->(map $_->[3], @_); 245 $cb->(map $_->[3], @_);
165 }); 246 });
166} 247}
167 248
168sub any($$) { 249sub reverse_verify($$) {
169 my ($domain, $cb) = @_; 250 my ($ip, $cb) = @_;
251
252 my $ipn = AnyEvent::Socket::parse_address ($ip)
253 or return $cb->();
170 254
171 resolver->resolve ($domain => "*", $cb); 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 };
172} 281}
173 282
174################################################################################# 283#################################################################################
175 284
176=back 285=back
181 290
182=item $AnyEvent::DNS::EDNS0 291=item $AnyEvent::DNS::EDNS0
183 292
184This variable decides whether dns_pack automatically enables EDNS0 293This variable decides whether dns_pack automatically enables EDNS0
185support. By default, this is disabled (C<0>), unless overridden by 294support. By default, this is disabled (C<0>), unless overridden by
186C<$ENV{PERL_ANYEVENT_EDNS0>), but when set to C<1>, AnyEvent::DNS will use 295C<$ENV{PERL_ANYEVENT_EDNS0}>, but when set to C<1>, AnyEvent::DNS will use
187EDNS0 in all requests. 296EDNS0 in all requests.
188 297
189=cut 298=cut
190 299
191our $EDNS0 = $ENV{PERL_ANYEVENT_EDNS0} * 1; # set to 1 to enable (partial) edns0 300our $EDNS0 = $ENV{PERL_ANYEVENT_EDNS0} * 1; # set to 1 to enable (partial) edns0
242 minfo => 14, 351 minfo => 14,
243 mx => 15, 352 mx => 15,
244 txt => 16, 353 txt => 16,
245 aaaa => 28, 354 aaaa => 28,
246 srv => 33, 355 srv => 33,
356 naptr => 35, # rfc2915
247 opt => 41, 357 opt => 41,
248 spf => 99, 358 spf => 99,
249 tkey => 249, 359 tkey => 249,
250 tsig => 250, 360 tsig => 250,
251 ixfr => 251, 361 ixfr => 251,
264 "*" => 255, 374 "*" => 255,
265); 375);
266 376
267our %class_str = reverse %class_id; 377our %class_str = reverse %class_id;
268 378
269# names MUST have a trailing dot
270sub _enc_name($) { 379sub _enc_name($) {
271 pack "(C/a*)*", (split /\./, shift), "" 380 pack "(C/a*)*", (split /\./, shift), ""
272} 381}
273 382
274sub _enc_qd() { 383sub _enc_qd() {
281 die "encoding of resource records is not supported"; 390 die "encoding of resource records is not supported";
282} 391}
283 392
284=item $pkt = AnyEvent::DNS::dns_pack $dns 393=item $pkt = AnyEvent::DNS::dns_pack $dns
285 394
286Packs 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
287recommended, then everything will be totally clear. Or maybe not. 396recommended, then everything will be totally clear. Or maybe not.
288 397
289Resource records are not yet encodable. 398Resource records are not yet encodable.
290 399
291Examples: 400Examples:
292 401
293 # very simple request, using lots of default values: 402 # very simple request, using lots of default values:
294 { rd => 1, qd => [ [ "host.domain", "a"] ] } 403 { rd => 1, qd => [ [ "host.domain", "a"] ] }
295 404
296 # more complex example, showing how flags etc. are named: 405 # more complex example, showing how flags etc. are named:
297 406
298 { 407 {
299 id => 10000, 408 id => 10000,
300 op => "query", 409 op => "query",
301 rc => "nxdomain", 410 rc => "nxdomain",
302 411
303 # flags 412 # flags
304 qr => 1, 413 qr => 1,
305 aa => 0, 414 aa => 0,
306 tc => 0, 415 tc => 0,
307 rd => 0, 416 rd => 0,
308 ra => 0, 417 ra => 0,
309 ad => 0, 418 ad => 0,
310 cd => 0, 419 cd => 0,
311 420
312 qd => [@rr], # query section 421 qd => [@rr], # query section
313 an => [@rr], # answer section 422 an => [@rr], # answer section
314 ns => [@rr], # authority section 423 ns => [@rr], # authority section
315 ar => [@rr], # additional records section 424 ar => [@rr], # additional records section
316 } 425 }
317 426
318=cut 427=cut
319 428
320sub dns_pack($) { 429sub dns_pack($) {
321 my ($req) = @_; 430 my ($req) = @_;
334 + $rcode_id{$req->{rc}} * 0x0001, 443 + $rcode_id{$req->{rc}} * 0x0001,
335 444
336 scalar @{ $req->{qd} || [] }, 445 scalar @{ $req->{qd} || [] },
337 scalar @{ $req->{an} || [] }, 446 scalar @{ $req->{an} || [] },
338 scalar @{ $req->{ns} || [] }, 447 scalar @{ $req->{ns} || [] },
339 $EDNS0 + scalar @{ $req->{ar} || [] }, # include EDNS0 option here 448 $EDNS0 + scalar @{ $req->{ar} || [] }, # EDNS0 option included here
340 449
341 (join "", map _enc_qd, @{ $req->{qd} || [] }), 450 (join "", map _enc_qd, @{ $req->{qd} || [] }),
342 (join "", map _enc_rr, @{ $req->{an} || [] }), 451 (join "", map _enc_rr, @{ $req->{an} || [] }),
343 (join "", map _enc_rr, @{ $req->{ns} || [] }), 452 (join "", map _enc_rr, @{ $req->{ns} || [] }),
344 (join "", map _enc_rr, @{ $req->{ar} || [] }), 453 (join "", map _enc_rr, @{ $req->{ar} || [] }),
345 454
346 ($EDNS0 ? pack "C nnNn", 0, 41, 4096, 0, 0 : "") # EDNS0, 4kiB udp payload size 455 ($EDNS0 ? pack "C nnNn", 0, 41, MAX_PKT, 0, 0 : "") # EDNS0 option
347} 456}
348 457
349our $ofs; 458our $ofs;
350our $pkt; 459our $pkt;
351 460
396 13 => sub { unpack "C/a* C/a*", $_ }, # hinfo 505 13 => sub { unpack "C/a* C/a*", $_ }, # hinfo
397 15 => sub { local $ofs = $ofs + 2 - length; ((unpack "n", $_), _dec_name) }, # mx 506 15 => sub { local $ofs = $ofs + 2 - length; ((unpack "n", $_), _dec_name) }, # mx
398 16 => sub { unpack "(C/a*)*", $_ }, # txt 507 16 => sub { unpack "(C/a*)*", $_ }, # txt
399 28 => sub { AnyEvent::Socket::format_address ($_) }, # aaaa 508 28 => sub { AnyEvent::Socket::format_address ($_) }, # aaaa
400 33 => sub { local $ofs = $ofs + 6 - length; ((unpack "nnn", $_), _dec_name) }, # 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 },
401 99 => sub { unpack "(C/a*)*", $_ }, # spf 516 99 => sub { unpack "(C/a*)*", $_ }, # spf
402); 517);
403 518
404sub _dec_rr { 519sub _dec_rr {
405 my $name = _dec_name; 520 my $name = _dec_name;
419 534
420Unpacks a DNS packet into a perl data structure. 535Unpacks a DNS packet into a perl data structure.
421 536
422Examples: 537Examples:
423 538
424 # an unsuccessful reply 539 # an unsuccessful reply
425 { 540 {
426 'qd' => [ 541 'qd' => [
427 [ 'ruth.plan9.de.mach.uni-karlsruhe.de', '*', 'in' ] 542 [ 'ruth.plan9.de.mach.uni-karlsruhe.de', '*', 'in' ]
428 ], 543 ],
429 'rc' => 'nxdomain', 544 'rc' => 'nxdomain',
430 'ar' => [], 545 'ar' => [],
431 'ns' => [ 546 'ns' => [
432 [ 547 [
433 'uni-karlsruhe.de', 548 'uni-karlsruhe.de',
434 'soa', 549 'soa',
435 'in', 550 'in',
436 'netserv.rz.uni-karlsruhe.de', 551 'netserv.rz.uni-karlsruhe.de',
437 'hostmaster.rz.uni-karlsruhe.de', 552 'hostmaster.rz.uni-karlsruhe.de',
438 2008052201, 10800, 1800, 2592000, 86400 553 2008052201, 10800, 1800, 2592000, 86400
439 ] 554 ]
440 ], 555 ],
441 'tc' => '', 556 'tc' => '',
442 'ra' => 1, 557 'ra' => 1,
443 'qr' => 1, 558 'qr' => 1,
444 'id' => 45915, 559 'id' => 45915,
445 'aa' => '', 560 'aa' => '',
446 'an' => [], 561 'an' => [],
447 'rd' => 1, 562 'rd' => 1,
448 'op' => 'query' 563 'op' => 'query'
449 } 564 }
450 565
451 # a successful reply 566 # a successful reply
452 567
453 { 568 {
454 'qd' => [ [ 'www.google.de', 'a', 'in' ] ], 569 'qd' => [ [ 'www.google.de', 'a', 'in' ] ],
455 'rc' => 0, 570 'rc' => 0,
456 'ar' => [ 571 'ar' => [
457 [ 'a.l.google.com', 'a', 'in', '209.85.139.9' ], 572 [ 'a.l.google.com', 'a', 'in', '209.85.139.9' ],
458 [ 'b.l.google.com', 'a', 'in', '64.233.179.9' ], 573 [ 'b.l.google.com', 'a', 'in', '64.233.179.9' ],
459 [ 'c.l.google.com', 'a', 'in', '64.233.161.9' ], 574 [ 'c.l.google.com', 'a', 'in', '64.233.161.9' ],
460 ], 575 ],
461 'ns' => [ 576 'ns' => [
462 [ 'l.google.com', 'ns', 'in', 'a.l.google.com' ], 577 [ 'l.google.com', 'ns', 'in', 'a.l.google.com' ],
463 [ 'l.google.com', 'ns', 'in', 'b.l.google.com' ], 578 [ 'l.google.com', 'ns', 'in', 'b.l.google.com' ],
464 ], 579 ],
465 'tc' => '', 580 'tc' => '',
466 'ra' => 1, 581 'ra' => 1,
467 'qr' => 1, 582 'qr' => 1,
468 'id' => 64265, 583 'id' => 64265,
469 'aa' => '', 584 'aa' => '',
470 'an' => [ 585 'an' => [
471 [ 'www.google.de', 'cname', 'in', 'www.google.com' ], 586 [ 'www.google.de', 'cname', 'in', 'www.google.com' ],
472 [ 'www.google.com', 'cname', 'in', 'www.l.google.com' ], 587 [ 'www.google.com', 'cname', 'in', 'www.l.google.com' ],
473 [ 'www.l.google.com', 'a', 'in', '66.249.93.104' ], 588 [ 'www.l.google.com', 'a', 'in', '66.249.93.104' ],
474 [ 'www.l.google.com', 'a', 'in', '66.249.93.147' ], 589 [ 'www.l.google.com', 'a', 'in', '66.249.93.147' ],
475 ], 590 ],
476 'rd' => 1, 591 'rd' => 1,
477 'op' => 0 592 'op' => 0
478 } 593 }
479 594
480=cut 595=cut
481 596
482sub dns_unpack($) { 597sub dns_unpack($) {
483 local $pkt = shift; 598 local $pkt = shift;
554 669
555=over 4 670=over 4
556 671
557=item server => [...] 672=item server => [...]
558 673
559A list of server addresses (default: C<v127.0.0.1>) in network format (4 674A list of server addresses (default: C<v127.0.0.1>) in network format
560octets 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).
561 677
562=item timeout => [...] 678=item timeout => [...]
563 679
564A 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
565three 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,
574The 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
575tries to resolve the name without any suffixes first. 691tries to resolve the name without any suffixes first.
576 692
577=item max_outstanding => $integer 693=item max_outstanding => $integer
578 694
579Most name servers do not handle many parallel requests very well. This option 695Most name servers do not handle many parallel requests very well. This
580limits the number of outstanding requests to C<$n> (default: C<10>), that means 696option limits the number of outstanding requests to C<$integer>
581if 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,
582until some other requests have been resolved. 698then the additional requests will be queued until some other requests have
699been resolved.
583 700
584=item reuse => $seconds 701=item reuse => $seconds
585 702
586The number of seconds (default: C<300>) that a query id cannot be re-used 703The number of seconds (default: C<300>) that a query id cannot be re-used
587after a timeout. If there as no time-out then query id's can be reused 704after a timeout. If there was no time-out then query ids can be reused
588immediately. 705immediately.
589 706
590=back 707=back
591 708
592=cut 709=cut
593 710
594sub new { 711sub new {
595 my ($class, %arg) = @_; 712 my ($class, %arg) = @_;
596
597 socket my $fh, AF_INET, &Socket::SOCK_DGRAM, 0
598 or Carp::croak "socket: $!";
599
600 AnyEvent::Util::fh_nonblocking $fh, 1;
601 713
602 my $self = bless { 714 my $self = bless {
603 server => [], 715 server => [],
604 timeout => [2, 5, 5], 716 timeout => [2, 5, 5],
605 search => [], 717 search => [],
606 ndots => 1, 718 ndots => 1,
607 max_outstanding => 10, 719 max_outstanding => 10,
608 reuse => 300, # reuse id's after 5 minutes only, if possible 720 reuse => 300,
609 %arg, 721 %arg,
610 fh => $fh,
611 reuse_q => [], 722 reuse_q => [],
612 }, $class; 723 }, $class;
613 724
614 # search should default to gethostname's domain 725 # search should default to gethostname's domain
615 # but perl lacks a good posix module 726 # but perl lacks a good posix module
616 727
728 # try to create an ipv4 and an ipv6 socket
729 # only fail when we cannot create either
730 my $got_socket;
731
617 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;
618 $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";
619 760
620 $self->_compile; 761 $self->_compile;
621 762
622 $self 763 $self
623} 764}
700 # - the registry thing needs separate code on win32 native vs. cygwin 841 # - the registry thing needs separate code on win32 native vs. cygwin
701 # - the registry layout differs between windows versions 842 # - the registry layout differs between windows versions
702 # - calling windows api functions doesn't work on cygwin 843 # - calling windows api functions doesn't work on cygwin
703 # - ipconfig uses locale-specific messages 844 # - ipconfig uses locale-specific messages
704 845
705 # we use ipconfig parsing because, despite all it's brokenness, 846 # we use ipconfig parsing because, despite all its brokenness,
706 # it seems most stable in practise. 847 # it seems most stable in practise.
707 # for good measure, we append a fallback nameserver to our list. 848 # for good measure, we append a fallback nameserver to our list.
708 849
709 if (open my $fh, "ipconfig /all |") { 850 if (open my $fh, "ipconfig /all |") {
710 # parsing strategy: we go through the output and look for 851 # parsing strategy: we go through the output and look for
719 } elsif (/^\S/ || /^\s[^:]{16,}: /) { 860 } elsif (/^\S/ || /^\s[^:]{16,}: /) {
720 $dns = 0; 861 $dns = 0;
721 } 862 }
722 if ($dns && /^\s*(\S+)\s*$/) { 863 if ($dns && /^\s*(\S+)\s*$/) {
723 my $s = $1; 864 my $s = $1;
724 $s =~ s/%\d+(?!\S)//; # get rid of scope id 865 $s =~ s/%\d+(?!\S)//; # get rid of ipv6 scope id
725 if (my $ipn = AnyEvent::Socket::parse_address ($s)) { 866 if (my $ipn = AnyEvent::Socket::parse_address ($s)) {
726 push @{ $self->{server} }, $ipn; 867 push @{ $self->{server} }, $ipn;
727 } else { 868 } else {
728 push @{ $self->{search} }, $s; 869 push @{ $self->{search} }, $s;
729 } 870 }
743 $self->parse_resolv_conf (<$fh>); 884 $self->parse_resolv_conf (<$fh>);
744 } 885 }
745 } 886 }
746} 887}
747 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;
915}
916
748sub _compile { 917sub _compile {
749 my $self = shift; 918 my $self = shift;
750 919
751 # we currently throw away all ipv6 nameservers, we do not yet support those
752
753 my %search; $self->{search} = [grep 0 < length, grep !$search{$_}++, @{ $self->{search} }]; 920 my %search; $self->{search} = [grep 0 < length, grep !$search{$_}++, @{ $self->{search} }];
754 my %server; $self->{server} = [grep 4 == length, grep !$server{$_}++, @{ $self->{server} }]; 921 my %server; $self->{server} = [grep 0 < length, grep !$server{$_}++, @{ $self->{server} }];
755 922
756 unless (@{ $self->{server} }) { 923 unless (@{ $self->{server} }) {
757 # use 127.0.0.1 by default, and one opendns nameserver as fallback 924 # use 127.0.0.1 by default, and one opendns nameserver as fallback
758 $self->{server} = [v127.0.0.1, $DNS_FALLBACK[rand @DNS_FALLBACK]]; 925 $self->{server} = [v127.0.0.1, $DNS_FALLBACK[rand @DNS_FALLBACK]];
759 } 926 }
782 $NOW = time; 949 $NOW = time;
783 $id->[1]->($res); 950 $id->[1]->($res);
784} 951}
785 952
786sub _recv { 953sub _recv {
787 my ($self) = @_; 954 my ($self, $pkt, $peer) = @_;
788 955
789 # we ignore errors (often one gets port unreachable, but there is 956 # we ignore errors (often one gets port unreachable, but there is
790 # no good way to take advantage of that. 957 # no good way to take advantage of that.
791 while (my $peer = recv $self->{fh}, my $res, 4096, 0) { 958
792 my ($port, $host) = AnyEvent::Socket::unpack_sockaddr ($peer); 959 my ($port, $host) = AnyEvent::Socket::unpack_sockaddr ($peer);
793 960
794 return unless $port == 53 && grep $_ eq $host, @{ $self->{server} }; 961 return unless $port == 53 && grep $_ eq $host, @{ $self->{server} };
795 962
796 $self->_feed ($res); 963 $self->_feed ($pkt);
797 }
798} 964}
799 965
800sub _free_id { 966sub _free_id {
801 my ($self, $id, $timeout) = @_; 967 my ($self, $id, $timeout) = @_;
802 968
832 998
833 $self->{id}{$req->[2]} = [AnyEvent->timer (after => $timeout, cb => sub { 999 $self->{id}{$req->[2]} = [AnyEvent->timer (after => $timeout, cb => sub {
834 $NOW = time; 1000 $NOW = time;
835 1001
836 # timeout, try next 1002 # timeout, try next
837 &$do_retry; 1003 &$do_retry if $do_retry;
838 }), sub { 1004 }), sub {
839 my ($res) = @_; 1005 my ($res) = @_;
840 1006
841 if ($res->{tc}) { 1007 if ($res->{tc}) {
842 # success, but truncated, so use tcp 1008 # success, but truncated, so use tcp
843 AnyEvent::Socket::tcp_connect ((Socket::inet_ntoa $server), 53, sub { 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
844 my ($fh) = @_ 1012 my ($fh) = @_
845 or return &$do_retry; 1013 or return &$do_retry;
846 1014
847 my $handle = new AnyEvent::Handle 1015 my $handle; $handle = new AnyEvent::Handle
848 fh => $fh, 1016 fh => $fh,
1017 timeout => $timeout,
849 on_error => sub { 1018 on_error => sub {
1019 undef $handle;
1020 return unless $do_retry; # some other request could have invalidated us already
850 # failure, try next 1021 # failure, try next
851 &$do_retry; 1022 &$do_retry;
852 }; 1023 };
853 1024
854 $handle->push_write (pack "n/a", $req->[0]); 1025 $handle->push_write (pack "n/a", $req->[0]);
855 $handle->push_read (chunk => 2, sub { 1026 $handle->push_read (chunk => 2, sub {
856 $handle->unshift_read (chunk => (unpack "n", $_[1]), sub { 1027 $handle->unshift_read (chunk => (unpack "n", $_[1]), sub {
1028 undef $handle;
857 $self->_feed ($_[1]); 1029 $self->_feed ($_[1]);
858 }); 1030 });
859 }); 1031 });
860 shutdown $fh, 1;
861 1032
862 }, sub { $timeout }); 1033 }, sub { $timeout });
863 1034
864 } else { 1035 } else {
865 # success 1036 # success
866 $self->_free_id ($req->[2], $retry > 1); 1037 $self->_free_id ($req->[2], $retry > 1);
867 undef $do_retry; return $req->[1]->($res); 1038 undef $do_retry; return $req->[1]->($res);
868 } 1039 }
869 }]; 1040 }];
1041
1042 my $sa = AnyEvent::Socket::pack_sockaddr (DOMAIN_PORT, $server);
870 1043
871 send $self->{fh}, $req->[0], 0, AnyEvent::Socket::pack_sockaddr (53, $server); 1044 my $fh = AF_INET == Socket::sockaddr_family ($sa)
1045 ? $self->{fh4} : $self->{fh6}
1046 or return &$do_retry;
1047
1048 send $fh, $req->[0], 0, $sa;
872 }; 1049 };
873 1050
874 &$do_retry; 1051 &$do_retry;
875} 1052}
876 1053
877sub _scheduler { 1054sub _scheduler {
878 my ($self) = @_; 1055 my ($self) = @_;
1056
1057 no strict 'refs';
879 1058
880 $NOW = time; 1059 $NOW = time;
881 1060
882 # first clear id reuse queue 1061 # first clear id reuse queue
883 delete $self->{id}{ (shift @{ $self->{reuse_q} })->[1] } 1062 delete $self->{id}{ (shift @{ $self->{reuse_q} })->[1] }
892 $self->_scheduler; 1071 $self->_scheduler;
893 }); 1072 });
894 last; 1073 last;
895 } 1074 }
896 1075
897 my $req = shift @{ $self->{queue} } 1076 if (my $req = shift @{ $self->{queue} }) {
898 or last; 1077 # found a request in the queue, execute it
899
900 while () { 1078 while () {
901 $req->[2] = int rand 65536; 1079 $req->[2] = int rand 65536;
902 last unless exists $self->{id}{$req->[2]}; 1080 last unless exists $self->{id}{$req->[2]};
1081 }
1082
1083 ++$self->{outstanding};
1084 $self->{id}{$req->[2]} = 1;
1085 substr $req->[0], 0, 2, pack "n", $req->[2];
1086
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;
903 } 1096 }
904
905 ++$self->{outstanding};
906 $self->{id}{$req->[2]} = 1;
907 substr $req->[0], 0, 2, pack "n", $req->[2];
908
909 $self->_exec ($req);
910 } 1097 }
911} 1098}
912 1099
913=item $resolver->request ($req, $cb->($res)) 1100=item $resolver->request ($req, $cb->($res))
914 1101
1102This is the main low-level workhorse for sending DNS requests.
1103
915Sends a single request (a hash-ref formated as specified for 1104This function sends a single request (a hash-ref formated as specified
916C<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
917retries. Calls the callback with the decoded response packet if a reply 1109Calls the callback with the decoded response packet if a reply was
918was received, or no arguments on timeout. 1110received, or no arguments in case none of the servers answered.
919 1111
920=cut 1112=cut
921 1113
922sub request($$) { 1114sub request($$) {
923 my ($self, $req, $cb) = @_; 1115 my ($self, $req, $cb) = @_;
926 $self->_scheduler; 1118 $self->_scheduler;
927} 1119}
928 1120
929=item $resolver->resolve ($qname, $qtype, %options, $cb->($rcode, @rr)) 1121=item $resolver->resolve ($qname, $qtype, %options, $cb->($rcode, @rr))
930 1122
931Queries 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>.
932qtype 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.
933 1130
934The 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
935none on any error or if the name could not be found. 1132none on any error or if the name could not be found.
936 1133
937CNAME chains (although illegal) are followed up to a length of 8. 1134CNAME chains (although illegal) are followed up to a length of 10.
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.
938 1148
939Note that this resolver is just a stub resolver: it requires a name server 1149Note that this resolver is just a stub resolver: it requires a name server
940supporting recursive queries, will not do any recursive queries itself and 1150supporting recursive queries, will not do any recursive queries itself and
941is not secure when used against an untrusted name server. 1151is not secure when used against an untrusted name server.
942 1152
946 1156
947=item search => [$suffix...] 1157=item search => [$suffix...]
948 1158
949Use 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
950in 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
951C<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
952then 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.
953 1164
954=item accept => [$type...] 1165=item accept => [$type...]
955 1166
956Lists 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
957accepted and returned. The default includes the C<$qtype> and nothing 1168accepted and returned. The default includes the C<$qtype> and nothing
958else. 1169else. If this list includes C<cname>, then CNAME-chains will not be
1170followed (because you asked for the CNAME record).
959 1171
960=item class => "class" 1172=item class => "class"
961 1173
962Specify 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
963hesiod 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.
964 1176
965=back 1177=back
966 1178
967Examples: 1179Examples:
968 1180
969 $res->resolve ("ruth.plan9.de", "a", sub { 1181 # full example, you can paste this into perl:
970 warn Dumper [@_]; 1182 use Data::Dumper;
971 }); 1183 use AnyEvent::DNS;
1184 AnyEvent::DNS::resolver->resolve (
1185 "google.com", "*", my $cv = AnyEvent->condvar);
1186 warn Dumper [$cv->recv];
972 1187
1188 # shortened result:
973 [ 1189 # [
1190 # [ 'google.com', 'soa', 'in', 'ns1.google.com', 'dns-admin.google.com',
1191 # 2008052701, 7200, 1800, 1209600, 300 ],
974 [ 1192 # [
975 'ruth.schmorp.de', 1193 # 'google.com', 'txt', 'in',
976 'a', 1194 # 'v=spf1 include:_netblocks.google.com ~all'
977 'in', 1195 # ],
978 '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' ],
979 ] 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' ]
980 ] 1207 # ]
981 1208
1209 # resolve any records, but return only a and aaaa records:
982 $res->resolve ("test1.laendle", "*", 1210 $res->resolve ("test1.laendle", "*",
983 accept => ["a", "aaaa"], 1211 accept => ["a", "aaaa"],
984 sub { 1212 sub {
985 warn Dumper [@_]; 1213 warn Dumper [@_];
986 } 1214 }
987 ); 1215 );
988 1216
989 [ 1217 # result:
990 [ 1218 # [
991 'test1.laendle', 1219 # [ 'test1.laendle', 'a', 'in', '10.0.0.255' ],
992 'a', 1220 # [ 'test1.laendle', 'aaaa', 'in', '3ffe:1900:4545:0002:0240:0000:0000:f7e1' ]
993 'in',
994 '10.0.0.255'
995 ],
996 [
997 'test1.laendle',
998 'aaaa',
999 'in',
1000 '3ffe:1900:4545:0002:0240:0000:0000:f7e1'
1001 ] 1221 # ]
1002 ]
1003 1222
1004=cut 1223=cut
1005 1224
1006sub resolve($%) { 1225sub resolve($%) {
1007 my $cb = pop; 1226 my $cb = pop;
1027 $do_search = sub { 1246 $do_search = sub {
1028 @search 1247 @search
1029 or (undef $do_search), (undef $do_req), return $cb->(); 1248 or (undef $do_search), (undef $do_req), return $cb->();
1030 1249
1031 (my $name = lc "$qname." . shift @search) =~ s/\.$//; 1250 (my $name = lc "$qname." . shift @search) =~ s/\.$//;
1032 my $depth = 2; 1251 my $depth = 10;
1033 1252
1034 # advance in cname-chain 1253 # advance in cname-chain
1035 $do_req = sub { 1254 $do_req = sub {
1036 $self->request ({ 1255 $self->request ({
1037 rd => 1, 1256 rd => 1,
1075 }; 1294 };
1076 1295
1077 $do_search->(); 1296 $do_search->();
1078} 1297}
1079 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
1080use AnyEvent::Socket (); # circular dependency, so do not import anything and do it at the end 1330use AnyEvent::Socket (); # circular dependency, so do not import anything and do it at the end
1081 1331
10821; 13321;
1083 1333
1084=back 1334=back
1085 1335
1086=head1 AUTHOR 1336=head1 AUTHOR
1087 1337
1088 Marc Lehmann <schmorp@schmorp.de> 1338 Marc Lehmann <schmorp@schmorp.de>
1089 http://home.schmorp.de/ 1339 http://home.schmorp.de/
1090 1340
1091=cut 1341=cut
1092 1342

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines