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.20 by root, Sun May 25 01:05:27 2008 UTC vs.
Revision 1.114 by root, Fri Aug 21 11:59:25 2009 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
33 33
34=cut 34=cut
35 35
36package AnyEvent::Socket; 36package AnyEvent::Socket;
37 37
38no warnings;
39use strict;
40
41use Carp (); 38use Carp ();
42use Errno (); 39use Errno ();
43use Socket (); 40use Socket qw(AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM SOL_SOCKET SO_REUSEADDR);
44 41
45use AnyEvent (); 42use AnyEvent (); BEGIN { AnyEvent::common_sense }
46use AnyEvent::Util qw(guard fh_nonblocking); 43use AnyEvent::Util qw(guard fh_nonblocking AF_INET6);
47use AnyEvent::DNS (); 44use AnyEvent::DNS ();
48 45
49use base 'Exporter'; 46use base 'Exporter';
50 47
51our @EXPORT = qw(parse_ipv4 parse_ipv6 parse_ip format_ip inet_aton tcp_server tcp_connect); 48our @EXPORT = qw(
49 getprotobyname
50 parse_hostport format_hostport
51 parse_ipv4 parse_ipv6
52 parse_ip parse_address
53 format_ipv4 format_ipv6
54 format_ip format_address
55 address_family
56 inet_aton
57 tcp_server
58 tcp_connect
59);
52 60
53our $VERSION = '1.0'; 61our $VERSION = $AnyEvent::VERSION;
62
63# used in cases where we may return immediately but want the
64# caller to do stuff first
65sub _postpone {
66 my ($cb, @args) = (@_, $!);
67
68 my $w; $w = AE::timer 0, 0, sub {
69 undef $w;
70 $! = pop @args;
71 $cb->(@args);
72 };
73}
54 74
55=item $ipn = parse_ipv4 $dotted_quad 75=item $ipn = parse_ipv4 $dotted_quad
56 76
57Tries to parse the given dotted quad IPv4 address and return it in 77Tries to parse the given dotted quad IPv4 address and return it in
58octet form (or undef when it isn't in a parsable format). Supports all 78octet form (or undef when it isn't in a parsable format). Supports all
70 90
71 # check leading parts against range 91 # check leading parts against range
72 return undef if grep $_ >= 256, @_[0 .. @_ - 2]; 92 return undef if grep $_ >= 256, @_[0 .. @_ - 2];
73 93
74 # check trailing part against range 94 # check trailing part against range
75 return undef if $_[-1] >= 1 << (8 * (4 - $#_)); 95 return undef if $_[-1] >= 2 ** (8 * (4 - $#_));
76 96
77 pack "N", (pop) 97 pack "N", (pop)
78 + ($_[0] << 24) 98 + ($_[0] << 24)
79 + ($_[1] << 16) 99 + ($_[1] << 16)
80 + ($_[2] << 8); 100 + ($_[2] << 8);
84 104
85Tries to parse the given IPv6 address and return it in 105Tries to parse the given IPv6 address and return it in
86octet form (or undef when it isn't in a parsable format). 106octet form (or undef when it isn't in a parsable format).
87 107
88Should support all forms specified by RFC 2373 (and additionally all IPv4 108Should support all forms specified by RFC 2373 (and additionally all IPv4
89forms supported by parse_ipv4). 109forms supported by parse_ipv4). Note that scope-id's are not supported
110(and will not parse).
90 111
91This function works similarly to C<inet_pton AF_INET6, ...>. 112This function works similarly to C<inet_pton AF_INET6, ...>.
92 113
93=cut 114=cut
94 115
127 148
128 # and done 149 # and done
129 pack "n*", map hex, @h, @t 150 pack "n*", map hex, @h, @t
130} 151}
131 152
132=item $ipn = parse_ip $text 153sub parse_unix($) {
154 $_[0] eq "unix/"
155 ? pack "S", AF_UNIX
156 : undef
133 157
158}
159
160=item $ipn = parse_address $ip
161
134Combines C<parse_ipv4> and C<parse_ipv6> in one function. 162Combines C<parse_ipv4> and C<parse_ipv6> in one function. The address
163here refers to the host address (not socket address) in network form
164(binary).
135 165
136=cut 166If the C<$text> is C<unix/>, then this function returns a special token
167recognised by the other functions in this module to mean "UNIX domain
168socket".
137 169
170If the C<$text> to parse is a mapped IPv4 in IPv6 address (:ffff::<ipv4>),
171then it will be treated as an IPv4 address. If you don't want that, you
172have to call C<parse_ipv4> and/or C<parse_ipv6> manually.
173
174=item $ipn = AnyEvent::Socket::aton $ip
175
176Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but
177I<without> name resolution).
178
179=cut
180
138sub parse_ip($) { 181sub parse_address($) {
139 &parse_ipv4 || &parse_ipv6 182 for (&parse_ipv6) {
183 if ($_) {
184 s/^\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff//;
185 return $_;
186 } else {
187 return &parse_ipv4 || &parse_unix
188 }
189 }
140} 190}
141 191
192*aton = \&parse_address;
193
194=item ($name, $aliases, $proto) = getprotobyname $name
195
196Works like the builtin function of the same name, except it tries hard to
197work even on broken platforms (well, that's windows), where getprotobyname
198is traditionally very unreliable.
199
200=cut
201
202# microsoft can't even get getprotobyname working (the etc/protocols file
203# gets lost fairly often on windows), so we have to hardcode some common
204# protocol numbers ourselves.
205our %PROTO_BYNAME;
206
207$PROTO_BYNAME{tcp} = Socket::IPPROTO_TCP () if defined &Socket::IPPROTO_TCP;
208$PROTO_BYNAME{udp} = Socket::IPPROTO_UDP () if defined &Socket::IPPROTO_UDP;
209$PROTO_BYNAME{icmp} = Socket::IPPROTO_ICMP() if defined &Socket::IPPROTO_ICMP;
210
211sub getprotobyname($) {
212 my $name = lc shift;
213
214 defined (my $proton = $PROTO_BYNAME{$name} || (getprotobyname $name)[2])
215 or return;
216
217 ($name, uc $name, $proton)
218}
219
220=item ($host, $service) = parse_hostport $string[, $default_service]
221
222Splitting a string of the form C<hostname:port> is a common
223problem. Unfortunately, just splitting on the colon makes it hard to
224specify IPv6 addresses and doesn't support the less common but well
225standardised C<[ip literal]> syntax.
226
227This function tries to do this job in a better way, it supports the
228following formats, where C<port> can be a numerical port number of a
229service name, or a C<name=port> string, and the C< port> and C<:port>
230parts are optional. Also, everywhere where an IP address is supported
231a hostname or unix domain socket address is also supported (see
232C<parse_unix>).
233
234 hostname:port e.g. "www.linux.org", "www.x.de:443", "www.x.de:https=443"
235 ipv4:port e.g. "198.182.196.56", "127.1:22"
236 ipv6 e.g. "::1", "affe::1"
237 [ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"
238 [ipv4or6] port e.g. "[127.0.0.1]", "[www.x.org] 17"
239 ipv4or6 port e.g. "::1 443", "10.0.0.1 smtp"
240
241It also supports defaulting the service name in a simple way by using
242C<$default_service> if no service was detected. If neither a service was
243detected nor a default was specified, then this function returns the
244empty list. The same happens when a parse error was detected, such as a
245hostname with a colon in it (the function is rather conservative, though).
246
247Example:
248
249 print join ",", parse_hostport "localhost:443";
250 # => "localhost,443"
251
252 print join ",", parse_hostport "localhost", "https";
253 # => "localhost,https"
254
255 print join ",", parse_hostport "[::1]";
256 # => "," (empty list)
257
258=cut
259
260sub parse_hostport($;$) {
261 my ($host, $port);
262
263 for ("$_[0]") { # work on a copy, just in case, and also reset pos
264
265 # parse host, special cases: "ipv6" or "ipv6 port"
266 unless (
267 ($host) = /^\s* ([0-9a-fA-F:]*:[0-9a-fA-F:]*:[0-9a-fA-F\.:]*)/xgc
268 and parse_ipv6 $host
269 ) {
270 /^\s*/xgc;
271
272 if (/^ \[ ([^\[\]]+) \]/xgc) {
273 $host = $1;
274 } elsif (/^ ([^\[\]:\ ]+) /xgc) {
275 $host = $1;
276 } else {
277 return;
278 }
279 }
280
281 # parse port
282 if (/\G (?:\s+|:) ([^:[:space:]]+) \s*$/xgc) {
283 $port = $1;
284 } elsif (/\G\s*$/gc && length $_[1]) {
285 $port = $_[1];
286 } else {
287 return;
288 }
289 }
290
291 # hostnames must not contain :'s
292 return if $host =~ /:/ && !parse_ipv6 $host;
293
294 ($host, $port)
295}
296
297=item $string = format_hostport $host, $port
298
299Takes a host (in textual form) and a port and formats in unambigiously in
300a way that C<parse_hostport> can parse it again. C<$port> can be C<undef>.
301
302=cut
303
304sub format_hostport($;$) {
305 my ($host, $port) = @_;
306
307 $port = ":$port" if length $port;
308 $host = "[$host]" if $host =~ /:/;
309
310 "$host$port"
311}
312
313=item $sa_family = address_family $ipn
314
315Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :)
316of the given host address in network format.
317
318=cut
319
320sub address_family($) {
321 4 == length $_[0]
322 ? AF_INET
323 : 16 == length $_[0]
324 ? AF_INET6
325 : unpack "S", $_[0]
326}
327
142=item $text = format_ip $ipn 328=item $text = format_ipv4 $ipn
143 329
144Takes either an IPv4 address (4 octets) or and IPv6 address (16 octets) 330Expects a four octet string representing a binary IPv4 address and returns
331its textual format. Rarely used, see C<format_address> for a nicer
332interface.
333
334=item $text = format_ipv6 $ipn
335
336Expects a sixteen octet string representing a binary IPv6 address and
337returns its textual format. Rarely used, see C<format_address> for a
338nicer interface.
339
340=item $text = format_address $ipn
341
342Covnvert a host address in network format (e.g. 4 octets for IPv4 or 16
145and converts it into textual form. 343octets for IPv6) and convert it into textual form.
344
345Returns C<unix/> for UNIX domain sockets.
146 346
147This function works similarly to C<inet_ntop AF_INET || AF_INET6, ...>, 347This function works similarly to C<inet_ntop AF_INET || AF_INET6, ...>,
148except it automatically detects the address type. 348except it automatically detects the address type.
149 349
150=cut 350Returns C<undef> if it cannot detect the type.
151 351
152sub format_ip; 352If the C<$ipn> is a mapped IPv4 in IPv6 address (:ffff::<ipv4>), then just
353the contained IPv4 address will be returned. If you do not want that, you
354have to call C<format_ipv6> manually.
355
356=item $text = AnyEvent::Socket::ntoa $ipn
357
358Same as format_address, but not exported (think C<inet_ntoa>).
359
360=cut
361
153sub format_ip($) { 362sub format_ipv4($) {
154 if (4 == length $_[0]) {
155 return join ".", unpack "C4", $_[0] 363 join ".", unpack "C4", $_[0]
156 } elsif (16 == length $_[0]) { 364}
365
366sub format_ipv6($) {
367 if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) {
368 return "::";
369 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) {
370 return "::1";
371 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) {
372 # v4compatible
373 return "::" . format_ipv4 substr $_[0], 12;
157 if (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) { 374 } elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) {
158 # v4mapped 375 # v4mapped
159 return "::ffff:" . format_ip substr $_[0], 12; 376 return "::ffff:" . format_ipv4 substr $_[0], 12;
377 } elsif (v0.0.0.0.0.0.0.0.255.255.0.0 eq substr $_[0], 0, 12) {
378 # v4translated
379 return "::ffff:0:" . format_ipv4 substr $_[0], 12;
160 } else { 380 } else {
161 my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0]; 381 my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
162 382
383 # this is rather sucky, I admit
163 $ip =~ s/^0:(?:0:)*/::/ 384 $ip =~ s/^0:(?:0:)*(0$)?/::/
164 or $ip =~ s/(:0)+$/::/ 385 or $ip =~ s/(:0){7}$/::/ or $ip =~ s/(:0){7}/:/
165 or $ip =~ s/(:0)+/:/; 386 or $ip =~ s/(:0){6}$/::/ or $ip =~ s/(:0){6}/:/
387 or $ip =~ s/(:0){5}$/::/ or $ip =~ s/(:0){5}/:/
388 or $ip =~ s/(:0){4}$/::/ or $ip =~ s/(:0){4}/:/
389 or $ip =~ s/(:0){3}$/::/ or $ip =~ s/(:0){3}/:/
390 or $ip =~ s/(:0){2}$/::/ or $ip =~ s/(:0){2}/:/
391 or $ip =~ s/(:0){1}$/::/ or $ip =~ s/(:0){1}/:/;
166 return $ip 392 return $ip
167 } 393 }
394}
395
396sub format_address($) {
397 my $af = address_family $_[0];
398 if ($af == AF_INET) {
399 return &format_ipv4;
400 } elsif ($af == AF_INET6) {
401 return (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12)
402 ? format_ipv4 substr $_[0], 12
403 : &format_ipv6;
404 } elsif ($af == AF_UNIX) {
405 return "unix/"
168 } else { 406 } else {
169 return undef 407 return undef
170 } 408 }
171} 409}
410
411*ntoa = \&format_address;
172 412
173=item inet_aton $name_or_address, $cb->(@addresses) 413=item inet_aton $name_or_address, $cb->(@addresses)
174 414
175Works similarly to its Socket counterpart, except that it uses a 415Works similarly to its Socket counterpart, except that it uses a
176callback. Also, if a host has only an IPv6 address, this might be passed 416callback. Also, if a host has only an IPv6 address, this might be passed
177to the callback instead (use the length to detect this - 4 for IPv4, 16 417to the callback instead (use the length to detect this - 4 for IPv4, 16
178for IPv6). 418for IPv6).
179 419
180Unlike the L<Socket> function of the same name, you can get multiple IPv4 420Unlike the L<Socket> function of the same name, you can get multiple IPv4
181and IPv6 addresses as result. 421and IPv6 addresses as result (and maybe even other adrdess types).
182 422
183=cut 423=cut
184 424
185sub inet_aton { 425sub inet_aton {
186 my ($name, $cb) = @_; 426 my ($name, $cb) = @_;
204 } 444 }
205 }); 445 });
206 } 446 }
207} 447}
208 448
449BEGIN {
450 *sockaddr_family = $Socket::VERSION >= 1.75
451 ? \&Socket::sockaddr_family
452 : # for 5.6.x, we need to do something much more horrible
453 (Socket::pack_sockaddr_in 0x5555, "\x55\x55\x55\x55"
454 | eval { Socket::pack_sockaddr_un "U" }) =~ /^\x00/
455 ? sub { unpack "xC", $_[0] }
456 : sub { unpack "S" , $_[0] };
457}
458
459# check for broken platforms with extra field in sockaddr structure
460# kind of a rfc vs. bsd issue, as usual (ok, normally it's a
461# unix vs. bsd issue, a iso C vs. bsd issue or simply a
462# correctness vs. bsd issue.)
463my $pack_family = 0x55 == sockaddr_family ("\x55\x55")
464 ? "xC" : "S";
465
209=item $sa = AnyEvent::Socket::pack_sockaddr $port, $host 466=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host
210 467
211Pack the given port/host combination into a binary sockaddr structure. Handles 468Pack the given port/host combination into a binary sockaddr
212both IPv4 and IPv6 host addresses. 469structure. Handles both IPv4 and IPv6 host addresses, as well as UNIX
470domain sockets (C<$host> == C<unix/> and C<$service> == absolute
471pathname).
213 472
214=cut 473=cut
215 474
216sub pack_sockaddr($$) { 475sub pack_sockaddr($$) {
217 if (4 == length $_[1]) { 476 my $af = address_family $_[1];
477
478 if ($af == AF_INET) {
218 Socket::pack_sockaddr_in $_[0], $_[1] 479 Socket::pack_sockaddr_in $_[0], $_[1]
219 } elsif (16 == length $_[1]) { 480 } elsif ($af == AF_INET6) {
220 pack "SnL a16 L", 481 pack "$pack_family nL a16 L",
221 &AnyEvent::Util::AF_INET6, 482 AF_INET6,
222 $_[0], # port 483 $_[0], # port
223 0, # flowinfo 484 0, # flowinfo
224 $_[1], # addr 485 $_[1], # addr
225 0 # scope id 486 0 # scope id
487 } elsif ($af == AF_UNIX) {
488 Socket::pack_sockaddr_un $_[0]
226 } else { 489 } else {
227 Carp::croak "pack_sockaddr: invalid host"; 490 Carp::croak "pack_sockaddr: invalid host";
228 } 491 }
229} 492}
230 493
231=item ($port, $host) = AnyEvent::Socket::unpack_sockaddr $sa 494=item ($service, $host) = AnyEvent::Socket::unpack_sockaddr $sa
232 495
233Unpack the given binary sockaddr structure (as used by bind, getpeername 496Unpack the given binary sockaddr structure (as used by bind, getpeername
234etc.) into a C<$port, $host> combination. 497etc.) into a C<$service, $host> combination.
235 498
236Handles both IPv4 and IPv6 sockaddr structures. 499For IPv4 and IPv6, C<$service> is the port number and C<$host> the host
500address in network format (binary).
237 501
502For UNIX domain sockets, C<$service> is the absolute pathname and C<$host>
503is a special token that is understood by the other functions in this
504module (C<format_address> converts it to C<unix/>).
505
238=cut 506=cut
507
508# perl contains a bug (imho) where it requires that the kernel always returns
509# sockaddr_un structures of maximum length (which is not, AFAICS, required
510# by any standard). try to 0-pad structures for the benefit of those platforms.
511
512my $sa_un_zero = eval { Socket::pack_sockaddr_un "" }; $sa_un_zero ^= $sa_un_zero;
239 513
240sub unpack_sockaddr($) { 514sub unpack_sockaddr($) {
241 my $af = unpack "S", $_[0]; 515 my $af = sockaddr_family $_[0];
242 516
243 if ($af == &Socket::AF_INET) { 517 if ($af == AF_INET) {
244 Socket::unpack_sockaddr_in $_[0] 518 Socket::unpack_sockaddr_in $_[0]
245 } elsif ($af == &AnyEvent::Util::AF_INET6) { 519 } elsif ($af == AF_INET6) {
246 (unpack "SnL a16 L")[1, 3] 520 unpack "x2 n x4 a16", $_[0]
521 } elsif ($af == AF_UNIX) {
522 ((Socket::unpack_sockaddr_un $_[0] ^ $sa_un_zero), pack "S", AF_UNIX)
247 } else { 523 } else {
248 Carp::croak "unpack_sockaddr: unsupported protocol family $af"; 524 Carp::croak "unpack_sockaddr: unsupported protocol family $af";
249 } 525 }
250} 526}
251 527
252sub _tcp_port($) { 528=item resolve_sockaddr $node, $service, $proto, $family, $type, $cb->([$family, $type, $proto, $sockaddr], ...)
253 $_[0] =~ /^(\d*)$/ and return $1*1;
254 529
255 (getservbyname $_[0], "tcp")[2] 530Tries to resolve the given nodename and service name into protocol families
531and sockaddr structures usable to connect to this node and service in a
532protocol-independent way. It works remotely similar to the getaddrinfo
533posix function.
534
535For internet addresses, C<$node> is either an IPv4 or IPv6 address or an
536internet hostname, and C<$service> is either a service name (port name
537from F</etc/services>) or a numerical port number. If both C<$node> and
538C<$service> are names, then SRV records will be consulted to find the real
539service, otherwise they will be used as-is. If you know that the service
540name is not in your services database, then you can specify the service in
541the format C<name=port> (e.g. C<http=80>).
542
543For UNIX domain sockets, C<$node> must be the string C<unix/> and
544C<$service> must be the absolute pathname of the socket. In this case,
545C<$proto> will be ignored.
546
547C<$proto> must be a protocol name, currently C<tcp>, C<udp> or
548C<sctp>. The default is currently C<tcp>, but in the future, this function
549might try to use other protocols such as C<sctp>, depending on the socket
550type and any SRV records it might find.
551
552C<$family> must be either C<0> (meaning any protocol is OK), C<4> (use
553only IPv4) or C<6> (use only IPv6). The default is influenced by
554C<$ENV{PERL_ANYEVENT_PROTOCOLS}>.
555
556C<$type> must be C<SOCK_STREAM>, C<SOCK_DGRAM> or C<SOCK_SEQPACKET> (or
557C<undef> in which case it gets automatically chosen to be C<SOCK_STREAM>
558unless C<$proto> is C<udp>).
559
560The callback will receive zero or more array references that contain
561C<$family, $type, $proto> for use in C<socket> and a binary
562C<$sockaddr> for use in C<connect> (or C<bind>).
563
564The application should try these in the order given.
565
566Example:
567
568 resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };
569
570=cut
571
572sub resolve_sockaddr($$$$$$) {
573 my ($node, $service, $proto, $family, $type, $cb) = @_;
574
575 if ($node eq "unix/") {
576 return $cb->() if $family || $service !~ /^\//; # no can do
577
578 return $cb->([AF_UNIX, defined $type ? $type : SOCK_STREAM, 0, Socket::pack_sockaddr_un $service]);
579 }
580
581 unless (AF_INET6) {
582 $family != 6
583 or return $cb->();
584
585 $family = 4;
586 }
587
588 $cb->() if $family == 4 && !$AnyEvent::PROTOCOL{ipv4};
589 $cb->() if $family == 6 && !$AnyEvent::PROTOCOL{ipv6};
590
591 $family ||= 4 unless $AnyEvent::PROTOCOL{ipv6};
592 $family ||= 6 unless $AnyEvent::PROTOCOL{ipv4};
593
594 $proto ||= "tcp";
595 $type ||= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;
596
597 my $proton = getprotobyname $proto
256 or Carp::croak "$_[0]: service unknown" 598 or Carp::croak "$proto: protocol unknown";
599
600 my $port;
601
602 if ($service =~ /^(\S+)=(\d+)$/) {
603 ($service, $port) = ($1, $2);
604 } elsif ($service =~ /^\d+$/) {
605 ($service, $port) = (undef, $service);
606 } else {
607 $port = (getservbyname $service, $proto)[2]
608 or Carp::croak "$service/$proto: service unknown";
609 }
610
611 my @target = [$node, $port];
612
613 # resolve a records / provide sockaddr structures
614 my $resolve = sub {
615 my @res;
616 my $cv = AE::cv {
617 $cb->(
618 map $_->[2],
619 sort {
620 $AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}
621 or $a->[0] <=> $b->[0]
622 }
623 @res
624 )
625 };
626
627 $cv->begin;
628 for my $idx (0 .. $#target) {
629 my ($node, $port) = @{ $target[$idx] };
630
631 if (my $noden = parse_address $node) {
632 my $af = address_family $noden;
633
634 if ($af == AF_INET && $family != 6) {
635 push @res, [$idx, "ipv4", [AF_INET, $type, $proton,
636 pack_sockaddr $port, $noden]]
637 }
638
639 if ($af == AF_INET6 && $family != 4) {
640 push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
641 pack_sockaddr $port, $noden]]
642 }
643 } else {
644 # ipv4
645 if ($family != 6) {
646 $cv->begin;
647 AnyEvent::DNS::a $node, sub {
648 push @res, [$idx, "ipv4", [AF_INET, $type, $proton,
649 pack_sockaddr $port, parse_ipv4 $_]]
650 for @_;
651 $cv->end;
652 };
653 }
654
655 # ipv6
656 if ($family != 4) {
657 $cv->begin;
658 AnyEvent::DNS::aaaa $node, sub {
659 push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
660 pack_sockaddr $port, parse_ipv6 $_]]
661 for @_;
662 $cv->end;
663 };
664 }
665 }
666 }
667 $cv->end;
668 };
669
670 # try srv records, if applicable
671 if ($node eq "localhost") {
672 @target = (["127.0.0.1", $port], ["::1", $port]);
673 &$resolve;
674 } elsif (defined $service && !parse_address $node) {
675 AnyEvent::DNS::srv $service, $proto, $node, sub {
676 my (@srv) = @_;
677
678 # no srv records, continue traditionally
679 @srv
680 or return &$resolve;
681
682 # the only srv record has "." ("" here) => abort
683 $srv[0][2] ne "" || $#srv
684 or return $cb->();
685
686 # use srv records then
687 @target = map ["$_->[3].", $_->[2]],
688 grep $_->[3] ne ".",
689 @srv;
690
691 &$resolve;
692 };
693 } else {
694 &$resolve;
695 }
257} 696}
258 697
259=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb] 698=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]
260 699
261This is a convenience function that creates a TCP socket and makes a 100% 700This is a convenience function that creates a TCP socket and makes a 100%
262non-blocking connect to the given C<$host> (which can be a hostname or a 701non-blocking connect to the given C<$host> (which can be a hostname or
702a textual IP address, or the string C<unix/> for UNIX domain sockets)
263textual IP address) and C<$service> (which can be a numeric port number or 703and C<$service> (which can be a numeric port number or a service name,
264a service name, or a C<servicename=portnumber> string). 704or a C<servicename=portnumber> string, or the pathname to a UNIX domain
705socket).
265 706
266If both C<$host> and C<$port> are names, then this function will use SRV 707If both C<$host> and C<$port> are names, then this function will use SRV
267records to locate the real target(s). 708records to locate the real target(s).
268 709
269In either case, it will create a list of target hosts (e.g. for multihomed 710In either case, it will create a list of target hosts (e.g. for multihomed
270hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to 711hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to
271each in turn. 712each in turn.
272 713
273If the connect is successful, then the C<$connect_cb> will be invoked with 714After the connection is established, then the C<$connect_cb> will be
274the socket file handle (in non-blocking mode) as first and the peer host 715invoked with the socket file handle (in non-blocking mode) as first and
275(as a textual IP address) and peer port as second and third arguments, 716the peer host (as a textual IP address) and peer port as second and third
276respectively. The fourth argument is a code reference that you can call 717arguments, respectively. The fourth argument is a code reference that you
277if, for some reason, you don't like this connection, which will cause 718can call if, for some reason, you don't like this connection, which will
278C<tcp_connect> to try the next one (or call your callback without any 719cause C<tcp_connect> to try the next one (or call your callback without
279arguments if there are no more connections). In most cases, you can simply 720any arguments if there are no more connections). In most cases, you can
280ignore this argument. 721simply ignore this argument.
281 722
282 $cb->($filehandle, $host, $port, $retry) 723 $cb->($filehandle, $host, $port, $retry)
283 724
284If the connect is unsuccessful, then the C<$connect_cb> will be invoked 725If the connect is unsuccessful, then the C<$connect_cb> will be invoked
285without any arguments and C<$!> will be set appropriately (with C<ENXIO> 726without any arguments and C<$!> will be set appropriately (with C<ENXIO>
286indicating a DNS resolution failure). 727indicating a DNS resolution failure).
728
729The callback will I<never> be invoked before C<tcp_connect> returns, even
730if C<tcp_connect> was able to connect immediately (e.g. on unix domain
731sockets).
287 732
288The file handle is perfect for being plugged into L<AnyEvent::Handle>, but 733The file handle is perfect for being plugged into L<AnyEvent::Handle>, but
289can be used as a normal perl file handle as well. 734can be used as a normal perl file handle as well.
290 735
291Unless called in void context, C<tcp_connect> returns a guard object that 736Unless called in void context, C<tcp_connect> returns a guard object that
301timeout is to be used). 746timeout is to be used).
302 747
303Note that the socket could be either a IPv4 TCP socket or an IPv6 TCP 748Note that the socket could be either a IPv4 TCP socket or an IPv6 TCP
304socket (although only IPv4 is currently supported by this module). 749socket (although only IPv4 is currently supported by this module).
305 750
751Note to the poor Microsoft Windows users: Windows (of course) doesn't
752correctly signal connection errors, so unless your event library works
753around this, failed connections will simply hang. The only event libraries
754that handle this condition correctly are L<EV> and L<Glib>. Additionally,
755AnyEvent works around this bug with L<Event> and in its pure-perl
756backend. All other libraries cannot correctly handle this condition. To
757lessen the impact of this windows bug, a default timeout of 30 seconds
758will be imposed on windows. Cygwin is not affected.
759
306Simple Example: connect to localhost on port 22. 760Simple Example: connect to localhost on port 22.
307 761
308 tcp_connect localhost => 22, sub { 762 tcp_connect localhost => 22, sub {
309 my $fh = shift 763 my $fh = shift
310 or die "unable to connect: $!"; 764 or die "unable to connect: $!";
311 # do something 765 # do something
312 }; 766 };
313 767
314Complex Example: connect to www.google.com on port 80 and make a simple 768Complex Example: connect to www.google.com on port 80 and make a simple
315GET request without much error handling. Also limit the connection timeout 769GET request without much error handling. Also limit the connection timeout
316to 15 seconds. 770to 15 seconds.
317 771
321 or die "unable to connect: $!"; 775 or die "unable to connect: $!";
322 776
323 my $handle; # avoid direct assignment so on_eof has it in scope. 777 my $handle; # avoid direct assignment so on_eof has it in scope.
324 $handle = new AnyEvent::Handle 778 $handle = new AnyEvent::Handle
325 fh => $fh, 779 fh => $fh,
780 on_error => sub {
781 warn "error $_[2]\n";
782 $_[0]->destroy;
783 },
326 on_eof => sub { 784 on_eof => sub {
327 undef $handle; # keep it alive till eof 785 $handle->destroy; # destroy handle
328 warn "done.\n"; 786 warn "done.\n";
329 }; 787 };
330 788
331 $handle->push_write ("GET / HTTP/1.0\015\012\015\012"); 789 $handle->push_write ("GET / HTTP/1.0\015\012\015\012");
332 790
333 $handle->push_read_line ("\015\012\015\012", sub { 791 $handle->push_read (line => "\015\012\015\012", sub {
334 my ($handle, $line) = @_; 792 my ($handle, $line) = @_;
335 793
336 # print response header 794 # print response header
337 print "HEADER\n$line\n\nBODY\n"; 795 print "HEADER\n$line\n\nBODY\n";
338 796
347 # could call $fh->bind etc. here 805 # could call $fh->bind etc. here
348 806
349 15 807 15
350 }; 808 };
351 809
810Example: connect to a UNIX domain socket.
811
812 tcp_connect "unix/", "/tmp/.X11-unix/X0", sub {
813 ...
814 }
815
352=cut 816=cut
353 817
354sub tcp_connect($$$;$) { 818sub tcp_connect($$$;$) {
355 my ($host, $port, $connect, $prepare) = @_; 819 my ($host, $port, $connect, $prepare) = @_;
356 820
357 # see http://cr.yp.to/docs/connect.html for some background 821 # see http://cr.yp.to/docs/connect.html for some background
822 # also http://advogato.org/article/672.html
358 823
359 my %state = ( fh => undef ); 824 my %state = ( fh => undef );
360 825
361 # name resolution 826 # name/service to type/sockaddr resolution
362 AnyEvent::DNS::addr $host, $port, 0, 0, 0, sub { 827 resolve_sockaddr $host, $port, 0, 0, undef, sub {
363 my @target = @_; 828 my @target = @_;
364 829
365 $state{next} = sub { 830 $state{next} = sub {
366 return unless exists $state{fh}; 831 return unless exists $state{fh};
367 832
368 my $target = shift @target 833 my $target = shift @target
369 or do { 834 or return (%state = (), _postpone $connect);
370 %state = ();
371 return $connect->();
372 };
373 835
374 my ($domain, $type, $proto, $sockaddr) = @$target; 836 my ($domain, $type, $proto, $sockaddr) = @$target;
375 837
376 # socket creation 838 # socket creation
377 socket $state{fh}, $domain, $type, $proto 839 socket $state{fh}, $domain, $type, $proto
378 or return $state{next}(); 840 or return $state{next}();
379 841
380 fh_nonblocking $state{fh}, 1; 842 fh_nonblocking $state{fh}, 1;
381 843
382 # prepare and optional timeout
383 if ($prepare) {
384 my $timeout = $prepare->($state{fh}); 844 my $timeout = $prepare && $prepare->($state{fh});
385 845
846 $timeout ||= 30 if AnyEvent::WIN32;
847
386 $state{to} = AnyEvent->timer (after => $timeout, cb => sub { 848 $state{to} = AE::timer $timeout, 0, sub {
387 $! = &Errno::ETIMEDOUT; 849 $! = Errno::ETIMEDOUT;
388 $state{next}(); 850 $state{next}();
389 }) if $timeout; 851 } if $timeout;
852
853 # now connect
854 if (
855 (connect $state{fh}, $sockaddr)
856 || ($! == Errno::EINPROGRESS # POSIX
857 || $! == Errno::EWOULDBLOCK
858 # WSAEINPROGRESS intentionally not checked - it means something else entirely
859 || $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
860 || $! == AnyEvent::Util::WSAEWOULDBLOCK)
390 } 861 ) {
391 862 $state{ww} = AE::io $state{fh}, 1, sub {
392 # called when the connect was successful, which,
393 # in theory, could be the case immediately (but never is in practise)
394 my $connected = sub {
395 delete $state{ww};
396 delete $state{to};
397
398 # we are connected, or maybe there was an error 863 # we are connected, or maybe there was an error
399 if (my $sin = getpeername $state{fh}) { 864 if (my $sin = getpeername $state{fh}) {
400 my ($port, $host) = unpack_sockaddr $sin; 865 my ($port, $host) = unpack_sockaddr $sin;
401 866
867 delete $state{ww}; delete $state{to};
868
402 my $guard = guard { 869 my $guard = guard { %state = () };
403 %state = ();
404 };
405 870
406 $connect->($state{fh}, format_ip $host, $port, sub { 871 $connect->(delete $state{fh}, format_address $host, $port, sub {
407 $guard->cancel; 872 $guard->cancel;
873 $state{next}();
874 });
875 } else {
876 # dummy read to fetch real error code
877 sysread $state{fh}, my $buf, 1 if $! == Errno::ENOTCONN;
878
879 return if $! == Errno::EAGAIN; # skip spurious wake-ups
880
881 delete $state{ww}; delete $state{to};
882
408 $state{next}(); 883 $state{next}();
409 }); 884 }
410 } else {
411 # dummy read to fetch real error code
412 sysread $state{fh}, my $buf, 1 if $! == &Errno::ENOTCONN;
413 $state{next}();
414 } 885 };
415 };
416
417 # now connect
418 if (connect $state{fh}, $sockaddr) {
419 $connected->();
420 } elsif ($! == &Errno::EINPROGRESS || $! == &Errno::EWOULDBLOCK) { # EINPROGRESS is POSIX
421 $state{ww} = AnyEvent->io (fh => $state{fh}, poll => 'w', cb => $connected);
422 } else { 886 } else {
423 %state = (); 887 $state{next}();
424 $connect->();
425 } 888 }
426 }; 889 };
427 890
428 $! = &Errno::ENXIO; 891 $! = Errno::ENXIO;
429 $state{next}(); 892 $state{next}();
430 }; 893 };
431 894
432 defined wantarray && guard { %state = () } 895 defined wantarray && guard { %state = () }
433} 896}
434 897
435=item $guard = tcp_server $host, $port, $accept_cb[, $prepare_cb] 898=item $guard = tcp_server $host, $service, $accept_cb[, $prepare_cb]
436 899
437Create and bind a TCP socket to the given host (any IPv4 host if undef, 900Create and bind a stream socket to the given host, and port, set the
438otherwise it must be an IPv4 or IPv6 address) and port (service name or 901SO_REUSEADDR flag (if applicable) and call C<listen>. Unlike the name
439numeric port number, or an ephemeral port if given as zero or undef), set 902implies, this function can also bind on UNIX domain sockets.
440the SO_REUSEADDR flag and call C<listen>.
441 903
904For internet sockets, C<$host> must be an IPv4 or IPv6 address (or
905C<undef>, in which case it binds either to C<0> or to C<::>, depending
906on whether IPv4 or IPv6 is the preferred protocol, and maybe to both in
907future versions, as applicable).
908
909To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6
910wildcard address, use C<::>.
911
912The port is specified by C<$service>, which must be either a service name or
913a numeric port number (or C<0> or C<undef>, in which case an ephemeral
914port will be used).
915
916For UNIX domain sockets, C<$host> must be C<unix/> and C<$service> must be
917the absolute pathname of the socket. This function will try to C<unlink>
918the socket before it tries to bind to it. See SECURITY CONSIDERATIONS,
919below.
920
442For each new connection that could be C<accept>ed, call the C<$accept_cb> 921For each new connection that could be C<accept>ed, call the C<<
443with the file handle (in non-blocking mode) as first and the peer host and 922$accept_cb->($fh, $host, $port) >> with the file handle (in non-blocking
444port as second and third arguments (see C<tcp_connect> for details). 923mode) as first and the peer host and port as second and third arguments
924(see C<tcp_connect> for details).
445 925
446Croaks on any errors. 926Croaks on any errors it can detect before the listen.
447 927
448If called in non-void context, then this function returns a guard object 928If called in non-void context, then this function returns a guard object
449whose lifetime it tied to the TCP server: If the object gets destroyed, 929whose lifetime it tied to the TCP server: If the object gets destroyed,
450the server will be stopped (but existing accepted connections will 930the server will be stopped (but existing accepted connections will
451continue). 931continue).
452 932
453If you need more control over the listening socket, you can provide a 933If you need more control over the listening socket, you can provide a
454C<$prepare_cb>, which is called just before the C<listen ()> call, with 934C<< $prepare_cb->($fh, $host, $port) >>, which is called just before the
455the listen file handle as first argument. 935C<listen ()> call, with the listen file handle as first argument, and IP
936address and port number of the local socket endpoint as second and third
937arguments.
456 938
457It should return the length of the listen queue (or C<0> for the default). 939It should return the length of the listen queue (or C<0> for the default).
458 940
941Note to IPv6 users: RFC-compliant behaviour for IPv6 sockets listening on
942C<::> is to bind to both IPv6 and IPv4 addresses by default on dual-stack
943hosts. Unfortunately, only GNU/Linux seems to implement this properly, so
944if you want both IPv4 and IPv6 listening sockets you should create the
945IPv6 socket first and then attempt to bind on the IPv4 socket, but ignore
946any C<EADDRINUSE> errors.
947
459Example: bind on TCP port 8888 on the local machine and tell each client 948Example: bind on some TCP port on the local machine and tell each client
460to go away. 949to go away.
461 950
462 tcp_server undef, 8888, sub { 951 tcp_server undef, undef, sub {
463 my ($fh, $host, $port) = @_; 952 my ($fh, $host, $port) = @_;
464 953
465 syswrite $fh, "The internet is full, $host:$port. Go away!\015\012"; 954 syswrite $fh, "The internet is full, $host:$port. Go away!\015\012";
955 }, sub {
956 my ($fh, $thishost, $thisport) = @_;
957 warn "bound to $thishost, port $thisport\n";
466 }; 958 };
467 959
960Example: bind a server on a unix domain socket.
961
962 tcp_server "unix/", "/tmp/mydir/mysocket", sub {
963 my ($fh) = @_;
964 };
965
468=cut 966=cut
469 967
470sub tcp_server($$$;$) { 968sub tcp_server($$$;$) {
471 my ($host, $port, $accept, $prepare) = @_; 969 my ($host, $service, $accept, $prepare) = @_;
970
971 $host = $AnyEvent::PROTOCOL{ipv4} < $AnyEvent::PROTOCOL{ipv6} && AF_INET6
972 ? "::" : "0"
973 unless defined $host;
974
975 my $ipn = parse_address $host
976 or Carp::croak "AnyEvent::Socket::tcp_server: cannot parse '$host' as host address";
977
978 my $af = address_family $ipn;
472 979
473 my %state; 980 my %state;
474 981
475 socket $state{fh}, &Socket::AF_INET, &Socket::SOCK_STREAM, 0 982 # win32 perl is too stupid to get this right :/
983 Carp::croak "tcp_server/socket: address family not supported"
984 if AnyEvent::WIN32 && $af == AF_UNIX;
985
986 socket $state{fh}, $af, SOCK_STREAM, 0
476 or Carp::croak "socket: $!"; 987 or Carp::croak "tcp_server/socket: $!";
477 988
989 if ($af == AF_INET || $af == AF_INET6) {
478 setsockopt $state{fh}, &Socket::SOL_SOCKET, &Socket::SO_REUSEADDR, 1 990 setsockopt $state{fh}, SOL_SOCKET, SO_REUSEADDR, 1
479 or Carp::croak "so_reuseaddr: $!"; 991 or Carp::croak "tcp_server/so_reuseaddr: $!"
992 unless AnyEvent::WIN32; # work around windows bug
480 993
481 bind $state{fh}, Socket::pack_sockaddr_in _tcp_port $port, parse_ip ($host || "0.0.0.0") 994 unless ($service =~ /^\d*$/) {
995 $service = (getservbyname $service, "tcp")[2]
996 or Carp::croak "$service: service unknown"
997 }
998 } elsif ($af == AF_UNIX) {
999 unlink $service;
1000 }
1001
1002 bind $state{fh}, pack_sockaddr $service, $ipn
482 or Carp::croak "bind: $!"; 1003 or Carp::croak "bind: $!";
483 1004
484 fh_nonblocking $state{fh}, 1; 1005 fh_nonblocking $state{fh}, 1;
485 1006
486 my $len = ($prepare && $prepare->($state{fh})) || 128; 1007 my $len;
1008
1009 if ($prepare) {
1010 my ($service, $host) = unpack_sockaddr getsockname $state{fh};
1011 $len = $prepare && $prepare->($state{fh}, format_address $host, $service);
1012 }
1013
1014 $len ||= 128;
487 1015
488 listen $state{fh}, $len 1016 listen $state{fh}, $len
489 or Carp::croak "listen: $!"; 1017 or Carp::croak "listen: $!";
490 1018
491 $state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub { 1019 $state{aw} = AE::io $state{fh}, 0, sub {
492 # this closure keeps $state alive 1020 # this closure keeps $state alive
493 while (my $peer = accept my $fh, $state{fh}) { 1021 while (my $peer = accept my $fh, $state{fh}) {
494 fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not 1022 fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not
1023
495 my ($port, $host) = Socket::unpack_sockaddr_in $peer; 1024 my ($service, $host) = unpack_sockaddr $peer;
496 $accept->($fh, (Socket::inet_ntoa $host), $port); 1025 $accept->($fh, format_address $host, $service);
497 } 1026 }
498 }); 1027 };
499 1028
500 defined wantarray 1029 defined wantarray
501 ? guard { %state = () } # clear fh and watcher, which breaks the circular dependency 1030 ? guard { %state = () } # clear fh and watcher, which breaks the circular dependency
502 : () 1031 : ()
503} 1032}
504 1033
5051; 10341;
506 1035
507=back 1036=back
508 1037
1038=head1 SECURITY CONSIDERATIONS
1039
1040This module is quite powerful, with with power comes the ability to abuse
1041as well: If you accept "hostnames" and ports from untrusted sources,
1042then note that this can be abused to delete files (host=C<unix/>). This
1043is not really a problem with this module, however, as blindly accepting
1044any address and protocol and trying to bind a server or connect to it is
1045harmful in general.
1046
509=head1 AUTHOR 1047=head1 AUTHOR
510 1048
511 Marc Lehmann <schmorp@schmorp.de> 1049 Marc Lehmann <schmorp@schmorp.de>
512 http://home.schmorp.de/ 1050 http://home.schmorp.de/
513 1051

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines