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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.117 by root, Tue Feb 10 14:22:59 2009 UTC vs.
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC

1package AnyEvent::Handle; 1package AnyEvent::Handle;
2 2
3no warnings;
4use strict qw(subs vars);
5
6use AnyEvent ();
7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util (); 3use Scalar::Util ();
9use Carp (); 4use Carp ();
10use Fcntl ();
11use Errno qw(EAGAIN EINTR); 5use Errno qw(EAGAIN EINTR);
12 6
7use AnyEvent (); BEGIN { AnyEvent::common_sense }
8use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
13=head1 NAME 10=head1 NAME
14 11
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 12AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 13
17=cut 14=cut
18 15
19our $VERSION = 4.331; 16our $VERSION = 4.86;
20 17
21=head1 SYNOPSIS 18=head1 SYNOPSIS
22 19
23 use AnyEvent; 20 use AnyEvent;
24 use AnyEvent::Handle; 21 use AnyEvent::Handle;
25 22
26 my $cv = AnyEvent->condvar; 23 my $cv = AnyEvent->condvar;
27 24
28 my $handle = 25 my $hdl; $hdl = new AnyEvent::Handle
29 AnyEvent::Handle->new (
30 fh => \*STDIN, 26 fh => \*STDIN,
31 on_eof => sub { 27 on_error => sub {
28 my ($hdl, $fatal, $msg) = @_;
29 warn "got error $msg\n";
30 $hdl->destroy;
32 $cv->send; 31 $cv->send;
33 },
34 ); 32 );
35 33
36 # send some request line 34 # send some request line
37 $handle->push_write ("getinfo\015\012"); 35 $hdl->push_write ("getinfo\015\012");
38 36
39 # read the response line 37 # read the response line
40 $handle->push_read (line => sub { 38 $hdl->push_read (line => sub {
41 my ($handle, $line) = @_; 39 my ($hdl, $line) = @_;
42 warn "read line <$line>\n"; 40 warn "got line <$line>\n";
43 $cv->send; 41 $cv->send;
44 }); 42 });
45 43
46 $cv->recv; 44 $cv->recv;
47 45
63 61
64=head1 METHODS 62=head1 METHODS
65 63
66=over 4 64=over 4
67 65
68=item B<new (%args)> 66=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69 67
70The constructor supports these arguments (all as key => value pairs). 68The constructor supports these arguments (all as C<< key => value >> pairs).
71 69
72=over 4 70=over 4
73 71
74=item fh => $filehandle [MANDATORY] 72=item fh => $filehandle [MANDATORY]
75 73
74#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75
76The filehandle this L<AnyEvent::Handle> object will operate on. 76The filehandle this L<AnyEvent::Handle> object will operate on.
77
78NOTE: The filehandle will be set to non-blocking mode (using 77NOTE: The filehandle will be set to non-blocking mode (using
79C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in 78C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80that mode. 79that mode.
81 80
81#=item connect => [$host, $service]
82#
83# You have to specify either this parameter, or C<connect>, below.
84#Try to connect to the specified host and service (port), using
85#C<AnyEvent::Socket::tcp_connect>.
86#
87#When this
88
82=item on_eof => $cb->($handle) 89=item on_eof => $cb->($handle)
83 90
84Set the callback to be called when an end-of-file condition is detected, 91Set the callback to be called when an end-of-file condition is detected,
85i.e. in the case of a socket, when the other side has closed the 92i.e. in the case of a socket, when the other side has closed the
86connection cleanly. 93connection cleanly, and there are no outstanding read requests in the
94queue (if there are read requests, then an EOF counts as an unexpected
95connection close and will be flagged as an error).
87 96
88For sockets, this just means that the other side has stopped sending data, 97For sockets, this just means that the other side has stopped sending data,
89you can still try to write data, and, in fact, one can return from the EOF 98you can still try to write data, and, in fact, one can return from the EOF
90callback and continue writing data, as only the read part has been shut 99callback and continue writing data, as only the read part has been shut
91down. 100down.
92 101
93While not mandatory, it is I<highly> recommended to set an EOF callback,
94otherwise you might end up with a closed socket while you are still
95waiting for data.
96
97If an EOF condition has been detected but no C<on_eof> callback has been 102If an EOF condition has been detected but no C<on_eof> callback has been
98set, then a fatal error will be raised with C<$!> set to <0>. 103set, then a fatal error will be raised with C<$!> set to <0>.
99 104
100=item on_error => $cb->($handle, $fatal) 105=item on_error => $cb->($handle, $fatal, $message)
101 106
102This is the error callback, which is called when, well, some error 107This is the error callback, which is called when, well, some error
103occured, such as not being able to resolve the hostname, failure to 108occured, such as not being able to resolve the hostname, failure to
104connect or a read error. 109connect or a read error.
105 110
106Some errors are fatal (which is indicated by C<$fatal> being true). On 111Some errors are fatal (which is indicated by C<$fatal> being true). On
107fatal errors the handle object will be shut down and will not be usable 112fatal errors the handle object will be destroyed (by a call to C<< ->
108(but you are free to look at the current C<< ->rbuf >>). Examples of fatal 113destroy >>) after invoking the error callback (which means you are free to
109errors are an EOF condition with active (but unsatisifable) read watchers 114examine the handle object). Examples of fatal errors are an EOF condition
110(C<EPIPE>) or I/O errors. 115with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
116
117AnyEvent::Handle tries to find an appropriate error code for you to check
118against, but in some cases (TLS errors), this does not work well. It is
119recommended to always output the C<$message> argument in human-readable
120error messages (it's usually the same as C<"$!">).
111 121
112Non-fatal errors can be retried by simply returning, but it is recommended 122Non-fatal errors can be retried by simply returning, but it is recommended
113to simply ignore this parameter and instead abondon the handle object 123to simply ignore this parameter and instead abondon the handle object
114when this callback is invoked. Examples of non-fatal errors are timeouts 124when this callback is invoked. Examples of non-fatal errors are timeouts
115C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 125C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116 126
117On callback entrance, the value of C<$!> contains the operating system 127On callback entrance, the value of C<$!> contains the operating system
118error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 128error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
129C<EPROTO>).
119 130
120While not mandatory, it is I<highly> recommended to set this callback, as 131While not mandatory, it is I<highly> recommended to set this callback, as
121you will not be notified of errors otherwise. The default simply calls 132you will not be notified of errors otherwise. The default simply calls
122C<croak>. 133C<croak>.
123 134
127and no read request is in the queue (unlike read queue callbacks, this 138and no read request is in the queue (unlike read queue callbacks, this
128callback will only be called when at least one octet of data is in the 139callback will only be called when at least one octet of data is in the
129read buffer). 140read buffer).
130 141
131To access (and remove data from) the read buffer, use the C<< ->rbuf >> 142To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132method or access the C<$handle->{rbuf}> member directly. Note that you 143method or access the C<< $handle->{rbuf} >> member directly. Note that you
133must not enlarge or modify the read buffer, you can only remove data at 144must not enlarge or modify the read buffer, you can only remove data at
134the beginning from it. 145the beginning from it.
135 146
136When an EOF condition is detected then AnyEvent::Handle will first try to 147When an EOF condition is detected then AnyEvent::Handle will first try to
137feed all the remaining data to the queued callbacks and C<on_read> before 148feed all the remaining data to the queued callbacks and C<on_read> before
138calling the C<on_eof> callback. If no progress can be made, then a fatal 149calling the C<on_eof> callback. If no progress can be made, then a fatal
139error will be raised (with C<$!> set to C<EPIPE>). 150error will be raised (with C<$!> set to C<EPIPE>).
151
152Note that, unlike requests in the read queue, an C<on_read> callback
153doesn't mean you I<require> some data: if there is an EOF and there
154are outstanding read requests then an error will be flagged. With an
155C<on_read> callback, the C<on_eof> callback will be invoked.
140 156
141=item on_drain => $cb->($handle) 157=item on_drain => $cb->($handle)
142 158
143This sets the callback that is called when the write buffer becomes empty 159This sets the callback that is called when the write buffer becomes empty
144(or when the callback is set and the buffer is empty already). 160(or when the callback is set and the buffer is empty already).
237 253
238This will not work for partial TLS data that could not be encoded 254This will not work for partial TLS data that could not be encoded
239yet. This data will be lost. Calling the C<stoptls> method in time might 255yet. This data will be lost. Calling the C<stoptls> method in time might
240help. 256help.
241 257
258=item peername => $string
259
260A string used to identify the remote site - usually the DNS hostname
261(I<not> IDN!) used to create the connection, rarely the IP address.
262
263Apart from being useful in error messages, this string is also used in TLS
264peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
265verification will be skipped when C<peername> is not specified or
266C<undef>.
267
242=item tls => "accept" | "connect" | Net::SSLeay::SSL object 268=item tls => "accept" | "connect" | Net::SSLeay::SSL object
243 269
244When this parameter is given, it enables TLS (SSL) mode, that means 270When this parameter is given, it enables TLS (SSL) mode, that means
245AnyEvent will start a TLS handshake as soon as the conenction has been 271AnyEvent will start a TLS handshake as soon as the conenction has been
246established and will transparently encrypt/decrypt data afterwards. 272established and will transparently encrypt/decrypt data afterwards.
273
274All TLS protocol errors will be signalled as C<EPROTO>, with an
275appropriate error message.
247 276
248TLS mode requires Net::SSLeay to be installed (it will be loaded 277TLS mode requires Net::SSLeay to be installed (it will be loaded
249automatically when you try to create a TLS handle): this module doesn't 278automatically when you try to create a TLS handle): this module doesn't
250have a dependency on that module, so if your module requires it, you have 279have a dependency on that module, so if your module requires it, you have
251to add the dependency yourself. 280to add the dependency yourself.
255mode. 284mode.
256 285
257You can also provide your own TLS connection object, but you have 286You can also provide your own TLS connection object, but you have
258to make sure that you call either C<Net::SSLeay::set_connect_state> 287to make sure that you call either C<Net::SSLeay::set_connect_state>
259or C<Net::SSLeay::set_accept_state> on it before you pass it to 288or C<Net::SSLeay::set_accept_state> on it before you pass it to
260AnyEvent::Handle. 289AnyEvent::Handle. Also, this module will take ownership of this connection
290object.
291
292At some future point, AnyEvent::Handle might switch to another TLS
293implementation, then the option to use your own session object will go
294away.
261 295
262B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 296B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263passing in the wrong integer will lead to certain crash. This most often 297passing in the wrong integer will lead to certain crash. This most often
264happens when one uses a stylish C<< tls => 1 >> and is surprised about the 298happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265segmentation fault. 299segmentation fault.
266 300
267See the C<< ->starttls >> method for when need to start TLS negotiation later. 301See the C<< ->starttls >> method for when need to start TLS negotiation later.
268 302
269=item tls_ctx => $ssl_ctx 303=item tls_ctx => $anyevent_tls
270 304
271Use the given C<Net::SSLeay::CTX> object to create the new TLS connection 305Use the given C<AnyEvent::TLS> object to create the new TLS connection
272(unless a connection object was specified directly). If this parameter is 306(unless a connection object was specified directly). If this parameter is
273missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 307missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
308
309Instead of an object, you can also specify a hash reference with C<< key
310=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
311new TLS context object.
312
313=item on_starttls => $cb->($handle, $success[, $error_message])
314
315This callback will be invoked when the TLS/SSL handshake has finished. If
316C<$success> is true, then the TLS handshake succeeded, otherwise it failed
317(C<on_stoptls> will not be called in this case).
318
319The session in C<< $handle->{tls} >> can still be examined in this
320callback, even when the handshake was not successful.
321
322TLS handshake failures will not cause C<on_error> to be invoked when this
323callback is in effect, instead, the error message will be passed to C<on_starttls>.
324
325Without this callback, handshake failures lead to C<on_error> being
326called, as normal.
327
328Note that you cannot call C<starttls> right again in this callback. If you
329need to do that, start an zero-second timer instead whose callback can
330then call C<< ->starttls >> again.
331
332=item on_stoptls => $cb->($handle)
333
334When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
335set, then it will be invoked after freeing the TLS session. If it is not,
336then a TLS shutdown condition will be treated like a normal EOF condition
337on the handle.
338
339The session in C<< $handle->{tls} >> can still be examined in this
340callback.
341
342This callback will only be called on TLS shutdowns, not when the
343underlying handle signals EOF.
274 344
275=item json => JSON or JSON::XS object 345=item json => JSON or JSON::XS object
276 346
277This is the json coder object used by the C<json> read and write types. 347This is the json coder object used by the C<json> read and write types.
278 348
287 357
288=cut 358=cut
289 359
290sub new { 360sub new {
291 my $class = shift; 361 my $class = shift;
292
293 my $self = bless { @_ }, $class; 362 my $self = bless { @_ }, $class;
294 363
295 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 364 $self->{fh} or Carp::croak "mandatory argument fh is missing";
296 365
297 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 366 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
367
368 $self->{_activity} = AnyEvent->now;
369 $self->_timeout;
370
371 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
298 372
299 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 373 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300 if $self->{tls}; 374 if $self->{tls};
301 375
302 $self->{_activity} = AnyEvent->now;
303 $self->_timeout;
304
305 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; 376 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307 377
308 $self->start_read 378 $self->start_read
309 if $self->{on_read}; 379 if $self->{on_read};
310 380
311 $self 381 $self->{fh} && $self
312} 382}
313 383
314sub _shutdown { 384#sub _shutdown {
315 my ($self) = @_; 385# my ($self) = @_;
316 386#
317 delete $self->{_tw}; 387# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
318 delete $self->{_rw}; 388# $self->{_eof} = 1; # tell starttls et. al to stop trying
319 delete $self->{_ww}; 389#
320 delete $self->{fh};
321
322 &_freetls; 390# &_freetls;
323 391#}
324 delete $self->{on_read};
325 delete $self->{_queue};
326}
327 392
328sub _error { 393sub _error {
329 my ($self, $errno, $fatal) = @_; 394 my ($self, $errno, $fatal, $message) = @_;
330
331 $self->_shutdown
332 if $fatal;
333 395
334 $! = $errno; 396 $! = $errno;
397 $message ||= "$!";
335 398
336 if ($self->{on_error}) { 399 if ($self->{on_error}) {
337 $self->{on_error}($self, $fatal); 400 $self->{on_error}($self, $fatal, $message);
401 $self->destroy if $fatal;
338 } elsif ($self->{fh}) { 402 } elsif ($self->{fh}) {
403 $self->destroy;
339 Carp::croak "AnyEvent::Handle uncaught error: $!"; 404 Carp::croak "AnyEvent::Handle uncaught error: $message";
340 } 405 }
341} 406}
342 407
343=item $fh = $handle->fh 408=item $fh = $handle->fh
344 409
405 local $SIG{__DIE__}; 470 local $SIG{__DIE__};
406 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; 471 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
407 }; 472 };
408} 473}
409 474
475=item $handle->on_starttls ($cb)
476
477Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
478
479=cut
480
481sub on_starttls {
482 $_[0]{on_starttls} = $_[1];
483}
484
485=item $handle->on_stoptls ($cb)
486
487Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
488
489=cut
490
491sub on_starttls {
492 $_[0]{on_stoptls} = $_[1];
493}
494
410############################################################################# 495#############################################################################
411 496
412=item $handle->timeout ($seconds) 497=item $handle->timeout ($seconds)
413 498
414Configures (or disables) the inactivity timeout. 499Configures (or disables) the inactivity timeout.
438 $self->{_activity} = $NOW; 523 $self->{_activity} = $NOW;
439 524
440 if ($self->{on_timeout}) { 525 if ($self->{on_timeout}) {
441 $self->{on_timeout}($self); 526 $self->{on_timeout}($self);
442 } else { 527 } else {
443 $self->_error (&Errno::ETIMEDOUT); 528 $self->_error (Errno::ETIMEDOUT);
444 } 529 }
445 530
446 # callback could have changed timeout value, optimise 531 # callback could have changed timeout value, optimise
447 return unless $self->{timeout}; 532 return unless $self->{timeout};
448 533
511 Scalar::Util::weaken $self; 596 Scalar::Util::weaken $self;
512 597
513 my $cb = sub { 598 my $cb = sub {
514 my $len = syswrite $self->{fh}, $self->{wbuf}; 599 my $len = syswrite $self->{fh}, $self->{wbuf};
515 600
516 if ($len >= 0) { 601 if (defined $len) {
517 substr $self->{wbuf}, 0, $len, ""; 602 substr $self->{wbuf}, 0, $len, "";
518 603
519 $self->{_activity} = AnyEvent->now; 604 $self->{_activity} = AnyEvent->now;
520 605
521 $self->{on_drain}($self) 606 $self->{on_drain}($self)
656 741
657 pack "w/a*", Storable::nfreeze ($ref) 742 pack "w/a*", Storable::nfreeze ($ref)
658}; 743};
659 744
660=back 745=back
746
747=item $handle->push_shutdown
748
749Sometimes you know you want to close the socket after writing your data
750before it was actually written. One way to do that is to replace your
751C<on_drain> handler by a callback that shuts down the socket (and set
752C<low_water_mark> to C<0>). This method is a shorthand for just that, and
753replaces the C<on_drain> callback with:
754
755 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
756
757This simply shuts down the write side and signals an EOF condition to the
758the peer.
759
760You can rely on the normal read queue and C<on_eof> handling
761afterwards. This is the cleanest way to close a connection.
762
763=cut
764
765sub push_shutdown {
766 my ($self) = @_;
767
768 delete $self->{low_water_mark};
769 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
770}
661 771
662=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 772=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
663 773
664This function (not method) lets you add your own types to C<push_write>. 774This function (not method) lets you add your own types to C<push_write>.
665Whenever the given C<type> is used, C<push_write> will invoke the code 775Whenever the given C<type> is used, C<push_write> will invoke the code
765 875
766 if ( 876 if (
767 defined $self->{rbuf_max} 877 defined $self->{rbuf_max}
768 && $self->{rbuf_max} < length $self->{rbuf} 878 && $self->{rbuf_max} < length $self->{rbuf}
769 ) { 879 ) {
770 $self->_error (&Errno::ENOSPC, 1), return; 880 $self->_error (Errno::ENOSPC, 1), return;
771 } 881 }
772 882
773 while () { 883 while () {
774 # we need to use a separate tls read buffer, as we must not receive data while 884 # we need to use a separate tls read buffer, as we must not receive data while
775 # we are draining the buffer, and this can only happen with TLS. 885 # we are draining the buffer, and this can only happen with TLS.
779 889
780 if (my $cb = shift @{ $self->{_queue} }) { 890 if (my $cb = shift @{ $self->{_queue} }) {
781 unless ($cb->($self)) { 891 unless ($cb->($self)) {
782 if ($self->{_eof}) { 892 if ($self->{_eof}) {
783 # no progress can be made (not enough data and no data forthcoming) 893 # no progress can be made (not enough data and no data forthcoming)
784 $self->_error (&Errno::EPIPE, 1), return; 894 $self->_error (Errno::EPIPE, 1), return;
785 } 895 }
786 896
787 unshift @{ $self->{_queue} }, $cb; 897 unshift @{ $self->{_queue} }, $cb;
788 last; 898 last;
789 } 899 }
797 && !@{ $self->{_queue} } # and the queue is still empty 907 && !@{ $self->{_queue} } # and the queue is still empty
798 && $self->{on_read} # but we still have on_read 908 && $self->{on_read} # but we still have on_read
799 ) { 909 ) {
800 # no further data will arrive 910 # no further data will arrive
801 # so no progress can be made 911 # so no progress can be made
802 $self->_error (&Errno::EPIPE, 1), return 912 $self->_error (Errno::EPIPE, 1), return
803 if $self->{_eof}; 913 if $self->{_eof};
804 914
805 last; # more data might arrive 915 last; # more data might arrive
806 } 916 }
807 } else { 917 } else {
813 923
814 if ($self->{_eof}) { 924 if ($self->{_eof}) {
815 if ($self->{on_eof}) { 925 if ($self->{on_eof}) {
816 $self->{on_eof}($self) 926 $self->{on_eof}($self)
817 } else { 927 } else {
818 $self->_error (0, 1); 928 $self->_error (0, 1, "Unexpected end-of-file");
819 } 929 }
820 } 930 }
821 931
822 # may need to restart read watcher 932 # may need to restart read watcher
823 unless ($self->{_rw}) { 933 unless ($self->{_rw}) {
1057 return 1; 1167 return 1;
1058 } 1168 }
1059 1169
1060 # reject 1170 # reject
1061 if ($reject && $$rbuf =~ $reject) { 1171 if ($reject && $$rbuf =~ $reject) {
1062 $self->_error (&Errno::EBADMSG); 1172 $self->_error (Errno::EBADMSG);
1063 } 1173 }
1064 1174
1065 # skip 1175 # skip
1066 if ($skip && $$rbuf =~ $skip) { 1176 if ($skip && $$rbuf =~ $skip) {
1067 $data .= substr $$rbuf, 0, $+[0], ""; 1177 $data .= substr $$rbuf, 0, $+[0], "";
1083 my ($self, $cb) = @_; 1193 my ($self, $cb) = @_;
1084 1194
1085 sub { 1195 sub {
1086 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1196 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1087 if ($_[0]{rbuf} =~ /[^0-9]/) { 1197 if ($_[0]{rbuf} =~ /[^0-9]/) {
1088 $self->_error (&Errno::EBADMSG); 1198 $self->_error (Errno::EBADMSG);
1089 } 1199 }
1090 return; 1200 return;
1091 } 1201 }
1092 1202
1093 my $len = $1; 1203 my $len = $1;
1096 my $string = $_[1]; 1206 my $string = $_[1];
1097 $_[0]->unshift_read (chunk => 1, sub { 1207 $_[0]->unshift_read (chunk => 1, sub {
1098 if ($_[1] eq ",") { 1208 if ($_[1] eq ",") {
1099 $cb->($_[0], $string); 1209 $cb->($_[0], $string);
1100 } else { 1210 } else {
1101 $self->_error (&Errno::EBADMSG); 1211 $self->_error (Errno::EBADMSG);
1102 } 1212 }
1103 }); 1213 });
1104 }); 1214 });
1105 1215
1106 1 1216 1
1173=cut 1283=cut
1174 1284
1175register_read_type json => sub { 1285register_read_type json => sub {
1176 my ($self, $cb) = @_; 1286 my ($self, $cb) = @_;
1177 1287
1178 require JSON; 1288 my $json = $self->{json} ||=
1289 eval { require JSON::XS; JSON::XS->new->utf8 }
1290 || do { require JSON; JSON->new->utf8 };
1179 1291
1180 my $data; 1292 my $data;
1181 my $rbuf = \$self->{rbuf}; 1293 my $rbuf = \$self->{rbuf};
1182
1183 my $json = $self->{json} ||= JSON->new->utf8;
1184 1294
1185 sub { 1295 sub {
1186 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1296 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187 1297
1188 if ($ref) { 1298 if ($ref) {
1196 $json->incr_skip; 1306 $json->incr_skip;
1197 1307
1198 $self->{rbuf} = $json->incr_text; 1308 $self->{rbuf} = $json->incr_text;
1199 $json->incr_text = ""; 1309 $json->incr_text = "";
1200 1310
1201 $self->_error (&Errno::EBADMSG); 1311 $self->_error (Errno::EBADMSG);
1202 1312
1203 () 1313 ()
1204 } else { 1314 } else {
1205 $self->{rbuf} = ""; 1315 $self->{rbuf} = "";
1206 1316
1243 # read remaining chunk 1353 # read remaining chunk
1244 $_[0]->unshift_read (chunk => $len, sub { 1354 $_[0]->unshift_read (chunk => $len, sub {
1245 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1355 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246 $cb->($_[0], $ref); 1356 $cb->($_[0], $ref);
1247 } else { 1357 } else {
1248 $self->_error (&Errno::EBADMSG); 1358 $self->_error (Errno::EBADMSG);
1249 } 1359 }
1250 }); 1360 });
1251 } 1361 }
1252 1362
1253 1 1363 1
1332 } 1442 }
1333 }); 1443 });
1334 } 1444 }
1335} 1445}
1336 1446
1447our $ERROR_SYSCALL;
1448our $ERROR_WANT_READ;
1449
1450sub _tls_error {
1451 my ($self, $err) = @_;
1452
1453 return $self->_error ($!, 1)
1454 if $err == Net::SSLeay::ERROR_SYSCALL ();
1455
1456 my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1457
1458 # reduce error string to look less scary
1459 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1460
1461 if ($self->{_on_starttls}) {
1462 (delete $self->{_on_starttls})->($self, undef, $err);
1463 &_freetls;
1464 } else {
1465 &_freetls;
1466 $self->_error (Errno::EPROTO, 1, $err);
1467 }
1468}
1469
1337# poll the write BIO and send the data if applicable 1470# poll the write BIO and send the data if applicable
1471# also decode read data if possible
1472# this is basiclaly our TLS state machine
1473# more efficient implementations are possible with openssl,
1474# but not with the buggy and incomplete Net::SSLeay.
1338sub _dotls { 1475sub _dotls {
1339 my ($self) = @_; 1476 my ($self) = @_;
1340 1477
1341 my $tmp; 1478 my $tmp;
1342 1479
1343 if (length $self->{_tls_wbuf}) { 1480 if (length $self->{_tls_wbuf}) {
1344 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1481 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345 substr $self->{_tls_wbuf}, 0, $tmp, ""; 1482 substr $self->{_tls_wbuf}, 0, $tmp, "";
1346 } 1483 }
1484
1485 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1486 return $self->_tls_error ($tmp)
1487 if $tmp != $ERROR_WANT_READ
1488 && ($tmp != $ERROR_SYSCALL || $!);
1347 } 1489 }
1348 1490
1349 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { 1491 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350 unless (length $tmp) { 1492 unless (length $tmp) {
1351 # let's treat SSL-eof as we treat normal EOF 1493 $self->{_on_starttls}
1352 delete $self->{_rw}; 1494 and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353 $self->{_eof} = 1;
1354 &_freetls; 1495 &_freetls;
1496
1497 if ($self->{on_stoptls}) {
1498 $self->{on_stoptls}($self);
1499 return;
1500 } else {
1501 # let's treat SSL-eof as we treat normal EOF
1502 delete $self->{_rw};
1503 $self->{_eof} = 1;
1504 }
1355 } 1505 }
1356 1506
1357 $self->{_tls_rbuf} .= $tmp; 1507 $self->{_tls_rbuf} .= $tmp;
1358 $self->_drain_rbuf unless $self->{_in_drain}; 1508 $self->_drain_rbuf unless $self->{_in_drain};
1359 $self->{tls} or return; # tls session might have gone away in callback 1509 $self->{tls} or return; # tls session might have gone away in callback
1360 } 1510 }
1361 1511
1362 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1512 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1363
1364 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1365 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1366 return $self->_error ($!, 1); 1513 return $self->_tls_error ($tmp)
1367 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { 1514 if $tmp != $ERROR_WANT_READ
1368 return $self->_error (&Errno::EIO, 1); 1515 && ($tmp != $ERROR_SYSCALL || $!);
1369 }
1370
1371 # all other errors are fine for our purposes
1372 }
1373 1516
1374 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1517 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375 $self->{wbuf} .= $tmp; 1518 $self->{wbuf} .= $tmp;
1376 $self->_drain_wbuf; 1519 $self->_drain_wbuf;
1377 } 1520 }
1521
1522 $self->{_on_starttls}
1523 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1524 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1378} 1525}
1379 1526
1380=item $handle->starttls ($tls[, $tls_ctx]) 1527=item $handle->starttls ($tls[, $tls_ctx])
1381 1528
1382Instead of starting TLS negotiation immediately when the AnyEvent::Handle 1529Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1383object is created, you can also do that at a later time by calling 1530object is created, you can also do that at a later time by calling
1384C<starttls>. 1531C<starttls>.
1385 1532
1533Starting TLS is currently an asynchronous operation - when you push some
1534write data and then call C<< ->starttls >> then TLS negotiation will start
1535immediately, after which the queued write data is then sent.
1536
1386The first argument is the same as the C<tls> constructor argument (either 1537The first argument is the same as the C<tls> constructor argument (either
1387C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1538C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388 1539
1389The second argument is the optional C<Net::SSLeay::CTX> object that is 1540The second argument is the optional C<AnyEvent::TLS> object that is used
1390used when AnyEvent::Handle has to create its own TLS connection object. 1541when AnyEvent::Handle has to create its own TLS connection object, or
1542a hash reference with C<< key => value >> pairs that will be used to
1543construct a new context.
1391 1544
1392The TLS connection object will end up in C<< $handle->{tls} >> after this 1545The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1393call and can be used or changed to your liking. Note that the handshake 1546context in C<< $handle->{tls_ctx} >> after this call and can be used or
1394might have already started when this function returns. 1547changed to your liking. Note that the handshake might have already started
1548when this function returns.
1395 1549
1396If it an error to start a TLS handshake more than once per 1550If it an error to start a TLS handshake more than once per
1397AnyEvent::Handle object (this is due to bugs in OpenSSL). 1551AnyEvent::Handle object (this is due to bugs in OpenSSL).
1398 1552
1399=cut 1553=cut
1400 1554
1555our %TLS_CACHE; #TODO not yet documented, should we?
1556
1401sub starttls { 1557sub starttls {
1402 my ($self, $ssl, $ctx) = @_; 1558 my ($self, $ssl, $ctx) = @_;
1403 1559
1404 require Net::SSLeay; 1560 require Net::SSLeay;
1405 1561
1406 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" 1562 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1407 if $self->{tls}; 1563 if $self->{tls};
1564
1565 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1566 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1567
1568 $ctx ||= $self->{tls_ctx};
1569
1570 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1571
1572 if ("HASH" eq ref $ctx) {
1573 require AnyEvent::TLS;
1574
1575 if ($ctx->{cache}) {
1576 my $key = $ctx+0;
1577 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1578 } else {
1579 $ctx = new AnyEvent::TLS %$ctx;
1580 }
1581 }
1408 1582
1409 if ($ssl eq "accept") { 1583 $self->{tls_ctx} = $ctx || TLS_CTX ();
1410 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1584 $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1411 Net::SSLeay::set_accept_state ($ssl);
1412 } elsif ($ssl eq "connect") {
1413 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1414 Net::SSLeay::set_connect_state ($ssl);
1415 }
1416
1417 $self->{tls} = $ssl;
1418 1585
1419 # basically, this is deep magic (because SSL_read should have the same issues) 1586 # basically, this is deep magic (because SSL_read should have the same issues)
1420 # but the openssl maintainers basically said: "trust us, it just works". 1587 # but the openssl maintainers basically said: "trust us, it just works".
1421 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1588 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422 # and mismaintained ssleay-module doesn't even offer them). 1589 # and mismaintained ssleay-module doesn't even offer them).
1426 # 1593 #
1427 # note that we do not try to keep the length constant between writes as we are required to do. 1594 # note that we do not try to keep the length constant between writes as we are required to do.
1428 # we assume that most (but not all) of this insanity only applies to non-blocking cases, 1595 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1429 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to 1596 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1430 # have identity issues in that area. 1597 # have identity issues in that area.
1431 Net::SSLeay::CTX_set_mode ($self->{tls}, 1598# Net::SSLeay::CTX_set_mode ($ssl,
1432 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1599# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1433 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1600# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1601 Net::SSLeay::CTX_set_mode ($ssl, 1|2);
1434 1602
1435 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1603 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1604 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437 1605
1438 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1606 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1607
1608 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1609 if $self->{on_starttls};
1439 1610
1440 &_dotls; # need to trigger the initial handshake 1611 &_dotls; # need to trigger the initial handshake
1441 $self->start_read; # make sure we actually do read 1612 $self->start_read; # make sure we actually do read
1442} 1613}
1443 1614
1456 if ($self->{tls}) { 1627 if ($self->{tls}) {
1457 Net::SSLeay::shutdown ($self->{tls}); 1628 Net::SSLeay::shutdown ($self->{tls});
1458 1629
1459 &_dotls; 1630 &_dotls;
1460 1631
1461 # we don't give a shit. no, we do, but we can't. no... 1632# # we don't give a shit. no, we do, but we can't. no...#d#
1462 # we, we... have to use openssl :/ 1633# # we, we... have to use openssl :/#d#
1463 &_freetls; 1634# &_freetls;#d#
1464 } 1635 }
1465} 1636}
1466 1637
1467sub _freetls { 1638sub _freetls {
1468 my ($self) = @_; 1639 my ($self) = @_;
1469 1640
1470 return unless $self->{tls}; 1641 return unless $self->{tls};
1471 1642
1472 Net::SSLeay::free (delete $self->{tls}); 1643 $self->{tls_ctx}->_put_session (delete $self->{tls});
1473 1644
1474 delete @$self{qw(_rbio _wbio _tls_wbuf)}; 1645 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475} 1646}
1476 1647
1477sub DESTROY { 1648sub DESTROY {
1478 my $self = shift; 1649 my ($self) = @_;
1479 1650
1480 &_freetls; 1651 &_freetls;
1481 1652
1482 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1653 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1483 1654
1484 if ($linger && length $self->{wbuf}) { 1655 if ($linger && length $self->{wbuf} && $self->{fh}) {
1485 my $fh = delete $self->{fh}; 1656 my $fh = delete $self->{fh};
1486 my $wbuf = delete $self->{wbuf}; 1657 my $wbuf = delete $self->{wbuf};
1487 1658
1488 my @linger; 1659 my @linger;
1489 1660
1503} 1674}
1504 1675
1505=item $handle->destroy 1676=item $handle->destroy
1506 1677
1507Shuts down the handle object as much as possible - this call ensures that 1678Shuts down the handle object as much as possible - this call ensures that
1508no further callbacks will be invoked and resources will be freed as much 1679no further callbacks will be invoked and as many resources as possible
1509as possible. You must not call any methods on the object afterwards. 1680will be freed. You must not call any methods on the object afterwards.
1510 1681
1511Normally, you can just "forget" any references to an AnyEvent::Handle 1682Normally, you can just "forget" any references to an AnyEvent::Handle
1512object and it will simply shut down. This works in fatal error and EOF 1683object and it will simply shut down. This works in fatal error and EOF
1513callbacks, as well as code outside. It does I<NOT> work in a read or write 1684callbacks, as well as code outside. It does I<NOT> work in a read or write
1514callback, so when you want to destroy the AnyEvent::Handle object from 1685callback, so when you want to destroy the AnyEvent::Handle object from
1515within such an callback. You I<MUST> call C<< ->destroy >> explicitly in 1686within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1516that case. 1687that case.
1517 1688
1689Destroying the handle object in this way has the advantage that callbacks
1690will be removed as well, so if those are the only reference holders (as
1691is common), then one doesn't need to do anything special to break any
1692reference cycles.
1693
1518The handle might still linger in the background and write out remaining 1694The handle might still linger in the background and write out remaining
1519data, as specified by the C<linger> option, however. 1695data, as specified by the C<linger> option, however.
1520 1696
1521=cut 1697=cut
1522 1698
1527 %$self = (); 1703 %$self = ();
1528} 1704}
1529 1705
1530=item AnyEvent::Handle::TLS_CTX 1706=item AnyEvent::Handle::TLS_CTX
1531 1707
1532This function creates and returns the Net::SSLeay::CTX object used by 1708This function creates and returns the AnyEvent::TLS object used by default
1533default for TLS mode. 1709for TLS mode.
1534 1710
1535The context is created like this: 1711The context is created by calling L<AnyEvent::TLS> without any arguments.
1536
1537 Net::SSLeay::load_error_strings;
1538 Net::SSLeay::SSLeay_add_ssl_algorithms;
1539 Net::SSLeay::randomize;
1540
1541 my $CTX = Net::SSLeay::CTX_new;
1542
1543 Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1544 1712
1545=cut 1713=cut
1546 1714
1547our $TLS_CTX; 1715our $TLS_CTX;
1548 1716
1549sub TLS_CTX() { 1717sub TLS_CTX() {
1550 $TLS_CTX || do { 1718 $TLS_CTX ||= do {
1551 require Net::SSLeay; 1719 require AnyEvent::TLS;
1552 1720
1553 Net::SSLeay::load_error_strings (); 1721 new AnyEvent::TLS
1554 Net::SSLeay::SSLeay_add_ssl_algorithms ();
1555 Net::SSLeay::randomize ();
1556
1557 $TLS_CTX = Net::SSLeay::CTX_new ();
1558
1559 Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1560
1561 $TLS_CTX
1562 } 1722 }
1563} 1723}
1564 1724
1565=back 1725=back
1566 1726
1605 1765
1606 $handle->on_read (sub { }); 1766 $handle->on_read (sub { });
1607 $handle->on_eof (undef); 1767 $handle->on_eof (undef);
1608 $handle->on_error (sub { 1768 $handle->on_error (sub {
1609 my $data = delete $_[0]{rbuf}; 1769 my $data = delete $_[0]{rbuf};
1610 undef $handle;
1611 }); 1770 });
1612 1771
1613The reason to use C<on_error> is that TCP connections, due to latencies 1772The reason to use C<on_error> is that TCP connections, due to latencies
1614and packets loss, might get closed quite violently with an error, when in 1773and packets loss, might get closed quite violently with an error, when in
1615fact, all data has been received. 1774fact, all data has been received.
1631 $handle->on_drain (sub { 1790 $handle->on_drain (sub {
1632 warn "all data submitted to the kernel\n"; 1791 warn "all data submitted to the kernel\n";
1633 undef $handle; 1792 undef $handle;
1634 }); 1793 });
1635 1794
1795If you just want to queue some data and then signal EOF to the other side,
1796consider using C<< ->push_shutdown >> instead.
1797
1798=item I want to contact a TLS/SSL server, I don't care about security.
1799
1800If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1801simply connect to it and then create the AnyEvent::Handle with the C<tls>
1802parameter:
1803
1804 tcp_connect $host, $port, sub {
1805 my ($fh) = @_;
1806
1807 my $handle = new AnyEvent::Handle
1808 fh => $fh,
1809 tls => "connect",
1810 on_error => sub { ... };
1811
1812 $handle->push_write (...);
1813 };
1814
1815=item I want to contact a TLS/SSL server, I do care about security.
1816
1817Then you should additionally enable certificate verification, including
1818peername verification, if the protocol you use supports it (see
1819L<AnyEvent::TLS>, C<verify_peername>).
1820
1821E.g. for HTTPS:
1822
1823 tcp_connect $host, $port, sub {
1824 my ($fh) = @_;
1825
1826 my $handle = new AnyEvent::Handle
1827 fh => $fh,
1828 peername => $host,
1829 tls => "connect",
1830 tls_ctx => { verify => 1, verify_peername => "https" },
1831 ...
1832
1833Note that you must specify the hostname you connected to (or whatever
1834"peername" the protocol needs) as the C<peername> argument, otherwise no
1835peername verification will be done.
1836
1837The above will use the system-dependent default set of trusted CA
1838certificates. If you want to check against a specific CA, add the
1839C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1840
1841 tls_ctx => {
1842 verify => 1,
1843 verify_peername => "https",
1844 ca_file => "my-ca-cert.pem",
1845 },
1846
1847=item I want to create a TLS/SSL server, how do I do that?
1848
1849Well, you first need to get a server certificate and key. You have
1850three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1851self-signed certificate (cheap. check the search engine of your choice,
1852there are many tutorials on the net) or c) make your own CA (tinyca2 is a
1853nice program for that purpose).
1854
1855Then create a file with your private key (in PEM format, see
1856L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
1857file should then look like this:
1858
1859 -----BEGIN RSA PRIVATE KEY-----
1860 ...header data
1861 ... lots of base64'y-stuff
1862 -----END RSA PRIVATE KEY-----
1863
1864 -----BEGIN CERTIFICATE-----
1865 ... lots of base64'y-stuff
1866 -----END CERTIFICATE-----
1867
1868The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
1869specify this file as C<cert_file>:
1870
1871 tcp_server undef, $port, sub {
1872 my ($fh) = @_;
1873
1874 my $handle = new AnyEvent::Handle
1875 fh => $fh,
1876 tls => "accept",
1877 tls_ctx => { cert_file => "my-server-keycert.pem" },
1878 ...
1879
1880When you have intermediate CA certificates that your clients might not
1881know about, just append them to the C<cert_file>.
1882
1636=back 1883=back
1637 1884
1638 1885
1639=head1 SUBCLASSING AnyEvent::Handle 1886=head1 SUBCLASSING AnyEvent::Handle
1640 1887

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines