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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.35 by root, Wed May 28 21:23:41 2008 UTC vs.
Revision 1.60 by root, Thu Aug 21 18:45:16 2008 UTC

… …
2 2
3AnyEvent::Socket - useful IPv4 and IPv6 stuff. 3AnyEvent::Socket - useful IPv4 and IPv6 stuff.
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::Socket; 7 use AnyEvent::Socket;
8 8
9 tcp_connect "gameserver.deliantra.net", 13327, sub { 9 tcp_connect "gameserver.deliantra.net", 13327, sub {
10 my ($fh) = @_ 10 my ($fh) = @_
11 or die "gameserver.deliantra.net connect failed: $!"; 11 or die "gameserver.deliantra.net connect failed: $!";
12 12
13 # enjoy your filehandle 13 # enjoy your filehandle
14 }; 14 };
15 15
16 # a simple tcp server 16 # a simple tcp server
17 tcp_server undef, 8888, sub { 17 tcp_server undef, 8888, sub {
18 my ($fh, $host, $port) = @_; 18 my ($fh, $host, $port) = @_;
19 19
20 syswrite $fh, "The internet is full, $host:$port. Go away!\015\012"; 20 syswrite $fh, "The internet is full, $host:$port. Go away!\015\012";
21 }; 21 };
22 22
23=head1 DESCRIPTION 23=head1 DESCRIPTION
24 24
25This module implements various utility functions for handling internet 25This module implements various utility functions for handling internet
26protocol addresses and sockets, in an as transparent and simple way as 26protocol addresses and sockets, in an as transparent and simple way as
… …
47use AnyEvent::DNS (); 47use AnyEvent::DNS ();
48 48
49use base 'Exporter'; 49use base 'Exporter';
50 50
51our @EXPORT = qw( 51our @EXPORT = qw(
52 parse_hostport
52 parse_ipv4 parse_ipv6 53 parse_ipv4 parse_ipv6
53 parse_ip parse_address 54 parse_ip parse_address
54 format_ip format_address 55 format_ip format_address
55 address_family 56 address_family
56 inet_aton 57 inet_aton
57 tcp_server 58 tcp_server
58 tcp_connect 59 tcp_connect
59); 60);
60 61
61our $VERSION = '1.0'; 62our $VERSION = 4.232;
62 63
63=item $ipn = parse_ipv4 $dotted_quad 64=item $ipn = parse_ipv4 $dotted_quad
64 65
65Tries to parse the given dotted quad IPv4 address and return it in 66Tries to parse the given dotted quad IPv4 address and return it in
66octet form (or undef when it isn't in a parsable format). Supports all 67octet form (or undef when it isn't in a parsable format). Supports all
… …
78 79
79 # check leading parts against range 80 # check leading parts against range
80 return undef if grep $_ >= 256, @_[0 .. @_ - 2]; 81 return undef if grep $_ >= 256, @_[0 .. @_ - 2];
81 82
82 # check trailing part against range 83 # check trailing part against range
83 return undef if $_[-1] >= 1 << (8 * (4 - $#_)); 84 return undef if $_[-1] >= 2 ** (8 * (4 - $#_));
84 85
85 pack "N", (pop) 86 pack "N", (pop)
86 + ($_[0] << 24) 87 + ($_[0] << 24)
87 + ($_[1] << 16) 88 + ($_[1] << 16)
88 + ($_[2] << 8); 89 + ($_[2] << 8);
… …
153 154
154If the C<$text> is C<unix/>, then this function returns a special token 155If the C<$text> is C<unix/>, then this function returns a special token
155recognised by the other functions in this module to mean "UNIX domain 156recognised by the other functions in this module to mean "UNIX domain
156socket". 157socket".
157 158
159=item $text = AnyEvent::Socket::aton $ipn
160
161Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but
162I<without> name resolution).
163
158=cut 164=cut
159 165
160sub parse_address($) { 166sub parse_address($) {
161 &parse_ipv4 || &parse_ipv6 || &parse_unix 167 &parse_ipv4 || &parse_ipv6 || &parse_unix
162} 168}
163 169
164*parse_ip =\&parse_address; #d# 170*aton = \&parse_address;
171
172=item ($host, $service) = parse_hostport $string[, $default_service]
173
174Splitting a string of the form C<hostname:port> is a common
175problem. Unfortunately, just splitting on the colon makes it hard to
176specify IPv6 addresses and doesn't support the less common but well
177standardised C<[ip literal]> syntax.
178
179This function tries to do this job in a better way, it supports the
180following formats, where C<port> can be a numerical port number of a
181service name, or a C<name=port> string, and the C< port> and C<:port>
182parts are optional. Also, everywhere where an IP address is supported
183a hostname or unix domain socket address is also supported (see
184C<parse_unix>).
185
186 hostname:port e.g. "www.linux.org", "www.x.de:443", "www.x.de:https=443"
187 ipv4:port e.g. "198.182.196.56", "127.1:22"
188 ipv6 e.g. "::1", "affe::1"
189 [ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"
190 [ipv4or6] port e.g. "[127.0.0.1]", "[www.x.org] 17"
191 ipv4or6 port e.g. "::1 443", "10.0.0.1 smtp"
192
193It also supports defaulting the service name in a simple way by using
194C<$default_service> if no service was detected. If neither a service was
195detected nor a default was specified, then this function returns the
196empty list. The same happens when a parse error weas detected, such as a
197hostname with a colon in it (the function is rather conservative, though).
198
199Example:
200
201 print join ",", parse_hostport "localhost:443";
202 # => "localhost,443"
203
204 print join ",", parse_hostport "localhost", "https";
205 # => "localhost,https"
206
207 print join ",", parse_hostport "[::1]";
208 # => "," (empty list)
209
210=cut
211
212sub parse_hostport($;$) {
213 my ($host, $port);
214
215 for ("$_[0]") { # work on a copy, just in case, and also reset pos
216
217 # parse host, special cases: "ipv6" or "ipv6 port"
218 unless (
219 ($host) = /^\s* ([0-9a-fA-F:]*:[0-9a-fA-F:]*:[0-9a-fA-F\.:]*)/xgc
220 and parse_ipv6 $host
221 ) {
222 /^\s*/xgc;
223
224 if (/^ \[ ([^\[\]]+) \]/xgc) {
225 $host = $1;
226 } elsif (/^ ([^\[\]:\ ]+) /xgc) {
227 $host = $1;
228 } else {
229 return;
230 }
231 }
232
233 # parse port
234 if (/\G (?:\s+|:) ([^:[:space:]]+) \s*$/xgc) {
235 $port = $1;
236 } elsif (/\G\s*$/gc && length $_[1]) {
237 $port = $_[1];
238 } else {
239 return;
240 }
241 }
242
243 # hostnames must not contain :'s
244 return if $host =~ /:/ && !parse_ipv6 $host;
245
246 ($host, $port)
247}
165 248
166=item $sa_family = address_family $ipn 249=item $sa_family = address_family $ipn
167 250
168Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :) 251Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :)
169of the given host address in network format. 252of the given host address in network format.
… …
188This function works similarly to C<inet_ntop AF_INET || AF_INET6, ...>, 271This function works similarly to C<inet_ntop AF_INET || AF_INET6, ...>,
189except it automatically detects the address type. 272except it automatically detects the address type.
190 273
191Returns C<undef> if it cannot detect the type. 274Returns C<undef> if it cannot detect the type.
192 275
276=item $text = AnyEvent::Socket::ntoa $ipn
277
278Same as format_address, but not exported (think C<inet_ntoa>).
279
193=cut 280=cut
194 281
195sub format_address; 282sub format_address;
196sub format_address($) { 283sub format_address($) {
197 my $af = address_family $_[0]; 284 my $af = address_family $_[0];
198 if ($af == AF_INET) { 285 if ($af == AF_INET) {
199 return join ".", unpack "C4", $_[0] 286 return join ".", unpack "C4", $_[0]
200 } elsif ($af == AF_INET6) { 287 } elsif ($af == AF_INET6) {
288 if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) {
289 return "::";
290 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) {
291 return "::1";
201 if (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) { 292 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) {
202 # v4compatible 293 # v4compatible
203 return "::" . format_address substr $_[0], 12; 294 return "::" . format_address substr $_[0], 12;
204 } elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) { 295 } elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) {
205 # v4mapped 296 # v4mapped
206 return "::ffff:" . format_address substr $_[0], 12; 297 return "::ffff:" . format_address substr $_[0], 12;
… …
208 # v4translated 299 # v4translated
209 return "::ffff:0:" . format_address substr $_[0], 12; 300 return "::ffff:0:" . format_address substr $_[0], 12;
210 } else { 301 } else {
211 my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0]; 302 my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
212 303
304 # this is rather sucky, I admit
213 $ip =~ s/^0:(?:0:)*(0$)?/::/ 305 $ip =~ s/^0:(?:0:)*(0$)?/::/
214 or $ip =~ s/(:0)+$/::/ 306 or $ip =~ s/(:0){7}$/::/ or $ip =~ s/(:0){7}/:/
215 or $ip =~ s/(:0)+/:/; 307 or $ip =~ s/(:0){6}$/::/ or $ip =~ s/(:0){6}/:/
308 or $ip =~ s/(:0){5}$/::/ or $ip =~ s/(:0){5}/:/
309 or $ip =~ s/(:0){4}$/::/ or $ip =~ s/(:0){4}/:/
310 or $ip =~ s/(:0){3}$/::/ or $ip =~ s/(:0){3}/:/
311 or $ip =~ s/(:0){2}$/::/ or $ip =~ s/(:0){2}/:/
312 or $ip =~ s/(:0){1}$/::/ or $ip =~ s/(:0){1}/:/;
216 return $ip 313 return $ip
217 } 314 }
218 } elsif ($af == AF_UNIX) { 315 } elsif ($af == AF_UNIX) {
219 return "unix/" 316 return "unix/"
220 } else { 317 } else {
221 return undef 318 return undef
222 } 319 }
223} 320}
224 321
225*format_ip = \&format_address; 322*ntoa = \&format_address;
226 323
227=item inet_aton $name_or_address, $cb->(@addresses) 324=item inet_aton $name_or_address, $cb->(@addresses)
228 325
229Works similarly to its Socket counterpart, except that it uses a 326Works similarly to its Socket counterpart, except that it uses a
230callback. Also, if a host has only an IPv6 address, this might be passed 327callback. Also, if a host has only an IPv6 address, this might be passed
… …
262 359
263# check for broken platforms with extra field in sockaddr structure 360# check for broken platforms with extra field in sockaddr structure
264# kind of a rfc vs. bsd issue, as usual (ok, normally it's a 361# kind of a rfc vs. bsd issue, as usual (ok, normally it's a
265# unix vs. bsd issue, a iso C vs. bsd issue or simply a 362# unix vs. bsd issue, a iso C vs. bsd issue or simply a
266# correctness vs. bsd issue. 363# correctness vs. bsd issue.
267my $pack_family = 0x55 == Socket::sockaddr_family "\x55\x55" 364my $pack_family = (0x55 == Socket::sockaddr_family "\x55\x55")
268 ? "xC" : "S"; 365 ? "xC" : "S";
269 366
270=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host 367=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host
271 368
272Pack the given port/host combination into a binary sockaddr 369Pack the given port/host combination into a binary sockaddr
… …
364 461
365 resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... }; 462 resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };
366 463
367=cut 464=cut
368 465
466# microsoft can't even get getprotobyname working (the etc/protocols file
467# gets lost fairly often on windows), so we have to hardcode some common
468# protocol numbers ourselves.
469our %PROTO_BYNAME;
470
471$PROTO_BYNAME{tcp} = &Socket::IPPROTO_TCP if defined &Socket::IPPROTO_TCP;
472$PROTO_BYNAME{udp} = &Socket::IPPROTO_UDP if defined &Socket::IPPROTO_UDP;
473$PROTO_BYNAME{icmp} = &Socket::IPPROTO_ICMP if defined &Socket::IPPROTO_ICMP;
474
369sub resolve_sockaddr($$$$$$) { 475sub resolve_sockaddr($$$$$$) {
370 my ($node, $service, $proto, $family, $type, $cb) = @_; 476 my ($node, $service, $proto, $family, $type, $cb) = @_;
371 477
372 if ($node eq "unix/") { 478 if ($node eq "unix/") {
373 return $cb->() if $family || !/^\//; # no can do 479 return $cb->() if $family || !/^\//; # no can do
… …
389 $family ||= 6 unless $AnyEvent::PROTOCOL{ipv4}; 495 $family ||= 6 unless $AnyEvent::PROTOCOL{ipv4};
390 496
391 $proto ||= "tcp"; 497 $proto ||= "tcp";
392 $type ||= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM; 498 $type ||= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;
393 499
394 my $proton = (getprotobyname $proto)[2] 500 my $proton = $PROTO_BYNAME{lc $proto} || (getprotobyname $proto)[2]
395 or Carp::croak "$proto: protocol unknown"; 501 or Carp::croak "$proto: protocol unknown";
396 502
397 my $port; 503 my $port;
398 504
399 if ($service =~ /^(\S+)=(\d+)$/) { 505 if ($service =~ /^(\S+)=(\d+)$/) {
… …
424 $cv->begin; 530 $cv->begin;
425 for my $idx (0 .. $#target) { 531 for my $idx (0 .. $#target) {
426 my ($node, $port) = @{ $target[$idx] }; 532 my ($node, $port) = @{ $target[$idx] };
427 533
428 if (my $noden = parse_address $node) { 534 if (my $noden = parse_address $node) {
535 my $af = address_family $noden;
536
429 if (4 == length $noden && $family != 6) { 537 if ($af == AF_INET && $family != 6) {
430 push @res, [$idx, "ipv4", [AF_INET, $type, $proton, 538 push @res, [$idx, "ipv4", [AF_INET, $type, $proton,
431 pack_sockaddr $port, $noden]] 539 pack_sockaddr $port, $noden]]
432 } 540 }
433 541
434 if (16 == length $noden && $family != 4) { 542 if ($af == AF_INET6 && $family != 4) {
435 push @res, [$idx, "ipv6", [AF_INET6, $type, $proton, 543 push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
436 pack_sockaddr $port, $noden]] 544 pack_sockaddr $port, $noden]]
437 } 545 }
438 } else { 546 } else {
439 # ipv4 547 # ipv4
440 if ($family != 6) { 548 if ($family != 6) {
441 $cv->begin; 549 $cv->begin;
442 a $node, sub { 550 AnyEvent::DNS::a $node, sub {
443 push @res, [$idx, "ipv4", [AF_INET, $type, $proton, 551 push @res, [$idx, "ipv4", [AF_INET, $type, $proton,
444 pack_sockaddr $port, parse_ipv4 $_]] 552 pack_sockaddr $port, parse_ipv4 $_]]
445 for @_; 553 for @_;
446 $cv->end; 554 $cv->end;
447 }; 555 };
448 } 556 }
449 557
450 # ipv6 558 # ipv6
451 if ($family != 4) { 559 if ($family != 4) {
452 $cv->begin; 560 $cv->begin;
453 aaaa $node, sub { 561 AnyEvent::DNS::aaaa $node, sub {
454 push @res, [$idx, "ipv6", [AF_INET6, $type, $proton, 562 push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
455 pack_sockaddr $port, parse_ipv6 $_]] 563 pack_sockaddr $port, parse_ipv6 $_]]
456 for @_; 564 for @_;
457 $cv->end; 565 $cv->end;
458 }; 566 };
… …
465 # try srv records, if applicable 573 # try srv records, if applicable
466 if ($node eq "localhost") { 574 if ($node eq "localhost") {
467 @target = (["127.0.0.1", $port], ["::1", $port]); 575 @target = (["127.0.0.1", $port], ["::1", $port]);
468 &$resolve; 576 &$resolve;
469 } elsif (defined $service && !parse_address $node) { 577 } elsif (defined $service && !parse_address $node) {
470 srv $service, $proto, $node, sub { 578 AnyEvent::DNS::srv $service, $proto, $node, sub {
471 my (@srv) = @_; 579 my (@srv) = @_;
472 580
473 # no srv records, continue traditionally 581 # no srv records, continue traditionally
474 @srv 582 @srv
475 or return &$resolve; 583 or return &$resolve;
476 584
477 # only srv record has "." => abort 585 # the only srv record has "." ("" here) => abort
478 $srv[0][2] ne "." || $#srv 586 $srv[0][2] ne "" || $#srv
479 or return $cb->(); 587 or return $cb->();
480 588
481 # use srv records then 589 # use srv records then
482 @target = map ["$_->[3].", $_->[2]], 590 @target = map ["$_->[3].", $_->[2]],
483 grep $_->[3] ne ".", 591 grep $_->[3] ne ".",
… …
548lessen the impact of this windows bug, a default timeout of 30 seconds 656lessen the impact of this windows bug, a default timeout of 30 seconds
549will be imposed on windows. Cygwin is not affected. 657will be imposed on windows. Cygwin is not affected.
550 658
551Simple Example: connect to localhost on port 22. 659Simple Example: connect to localhost on port 22.
552 660
553 tcp_connect localhost => 22, sub { 661 tcp_connect localhost => 22, sub {
554 my $fh = shift 662 my $fh = shift
555 or die "unable to connect: $!"; 663 or die "unable to connect: $!";
556 # do something 664 # do something
557 }; 665 };
558 666
559Complex Example: connect to www.google.com on port 80 and make a simple 667Complex Example: connect to www.google.com on port 80 and make a simple
560GET request without much error handling. Also limit the connection timeout 668GET request without much error handling. Also limit the connection timeout
561to 15 seconds. 669to 15 seconds.
562 670
… …
691Create and bind a stream socket to the given host, and port, set the 799Create and bind a stream socket to the given host, and port, set the
692SO_REUSEADDR flag (if applicable) and call C<listen>. Unlike the name 800SO_REUSEADDR flag (if applicable) and call C<listen>. Unlike the name
693implies, this function can also bind on UNIX domain sockets. 801implies, this function can also bind on UNIX domain sockets.
694 802
695For internet sockets, C<$host> must be an IPv4 or IPv6 address (or 803For internet sockets, C<$host> must be an IPv4 or IPv6 address (or
696C<undef>, in which case it binds either to C<0> or to C<::>, depending on 804C<undef>, in which case it binds either to C<0> or to C<::>, depending
697whether IPv4 or IPv6 is the preferred protocol). 805on whether IPv4 or IPv6 is the preferred protocol, and maybe to both in
806future versions, as applicable).
698 807
699To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6 808To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6
700wildcard address, use C<::>. 809wildcard address, use C<::>.
701 810
702The port is specified by C<$service>, which must be either a service name or 811The port is specified by C<$service>, which must be either a service name or
… …
726address and port number of the local socket endpoint as second and third 835address and port number of the local socket endpoint as second and third
727arguments. 836arguments.
728 837
729It should return the length of the listen queue (or C<0> for the default). 838It should return the length of the listen queue (or C<0> for the default).
730 839
840Note to IPv6 users: RFC-compliant behaviour for IPv6 sockets listening on
841C<::> is to bind to both IPv6 and IPv4 addresses by default on dual-stack
842hosts. Unfortunately, only GNU/Linux seems to implement this properly, so
843if you want both IPv4 and IPv6 listening sockets you should create the
844IPv6 socket first and then attempt to bind on the IPv4 socket, but ignore
845any C<EADDRINUSE> errors.
846
731Example: bind on some TCP port on the local machine and tell each client 847Example: bind on some TCP port on the local machine and tell each client
732to go away. 848to go away.
733 849
734 tcp_server undef, undef, sub { 850 tcp_server undef, undef, sub {
735 my ($fh, $host, $port) = @_; 851 my ($fh, $host, $port) = @_;
… …
754 870
755 my $af = address_family $ipn; 871 my $af = address_family $ipn;
756 872
757 my %state; 873 my %state;
758 874
875 # win32 perl is too stupid to get this right :/
876 Carp::croak "tcp_server/socket: address family not supported"
877 if AnyEvent::WIN32 && $af == AF_UNIX;
878
759 socket $state{fh}, $af, SOCK_STREAM, 0 879 socket $state{fh}, $af, SOCK_STREAM, 0
760 or Carp::croak "socket: $!"; 880 or Carp::croak "tcp_server/socket: $!";
761 881
762 if ($af == AF_INET || $af == AF_INET6) { 882 if ($af == AF_INET || $af == AF_INET6) {
763 setsockopt $state{fh}, SOL_SOCKET, SO_REUSEADDR, 1 883 setsockopt $state{fh}, SOL_SOCKET, SO_REUSEADDR, 1
764 or Carp::croak "so_reuseaddr: $!" 884 or Carp::croak "tcp_server/so_reuseaddr: $!"
765 unless !AnyEvent::WIN32; # work around windows bug 885 unless AnyEvent::WIN32; # work around windows bug
766 886
767 unless ($service =~ /^\d*$/) { 887 unless ($service =~ /^\d*$/) {
768 $service = (getservbyname $service, "tcp")[2] 888 $service = (getservbyname $service, "tcp")[2]
769 or Carp::croak "$service: service unknown" 889 or Carp::croak "$service: service unknown"
770 } 890 }
… …
791 911
792 $state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub { 912 $state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub {
793 # this closure keeps $state alive 913 # this closure keeps $state alive
794 while (my $peer = accept my $fh, $state{fh}) { 914 while (my $peer = accept my $fh, $state{fh}) {
795 fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not 915 fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not
916
796 my ($service, $host) = unpack_sockaddr $peer; 917 my ($service, $host) = unpack_sockaddr $peer;
797 $accept->($fh, format_address $host, $service); 918 $accept->($fh, format_address $host, $service);
798 } 919 }
799 }); 920 });
800 921
… …
805 926
8061; 9271;
807 928
808=back 929=back
809 930
931=head1 SECURITY CONSIDERATIONS
932
933This module is quite powerful, with with power comes the ability to abuse
934as well: If you accept "hostnames" and ports from untrusted sources,
935then note that this can be abused to delete files (host=C<unix/>). This
936is not really a problem with this module, however, as blindly accepting
937any address and protocol and trying to bind a server or connect to it is
938harmful in general.
939
810=head1 AUTHOR 940=head1 AUTHOR
811 941
812 Marc Lehmann <schmorp@schmorp.de> 942 Marc Lehmann <schmorp@schmorp.de>
813 http://home.schmorp.de/ 943 http://home.schmorp.de/
814 944

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines