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.153 by root, Fri Jul 17 23:12:20 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.83;
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
81 79
82=item on_eof => $cb->($handle) 80=item on_eof => $cb->($handle)
83 81
84Set the callback to be called when an end-of-file condition is detected, 82Set 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 83i.e. in the case of a socket, when the other side has closed the
86connection cleanly. 84connection cleanly, and there are no outstanding read requests in the
85queue (if there are read requests, then an EOF counts as an unexpected
86connection close and will be flagged as an error).
87 87
88For sockets, this just means that the other side has stopped sending data, 88For 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 89you 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 90callback and continue writing data, as only the read part has been shut
91down. 91down.
92 92
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 93If 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>. 94set, then a fatal error will be raised with C<$!> set to <0>.
99 95
100=item on_error => $cb->($handle, $fatal) 96=item on_error => $cb->($handle, $fatal, $message)
101 97
102This is the error callback, which is called when, well, some error 98This is the error callback, which is called when, well, some error
103occured, such as not being able to resolve the hostname, failure to 99occured, such as not being able to resolve the hostname, failure to
104connect or a read error. 100connect or a read error.
105 101
106Some errors are fatal (which is indicated by C<$fatal> being true). On 102Some 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 103fatal 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 104destroy >>) after invoking the error callback (which means you are free to
109errors are an EOF condition with active (but unsatisifable) read watchers 105examine the handle object). Examples of fatal errors are an EOF condition
110(C<EPIPE>) or I/O errors. 106with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
107
108AnyEvent::Handle tries to find an appropriate error code for you to check
109against, but in some cases (TLS errors), this does not work well. It is
110recommended to always output the C<$message> argument in human-readable
111error messages (it's usually the same as C<"$!">).
111 112
112Non-fatal errors can be retried by simply returning, but it is recommended 113Non-fatal errors can be retried by simply returning, but it is recommended
113to simply ignore this parameter and instead abondon the handle object 114to simply ignore this parameter and instead abondon the handle object
114when this callback is invoked. Examples of non-fatal errors are timeouts 115when this callback is invoked. Examples of non-fatal errors are timeouts
115C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 116C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116 117
117On callback entrance, the value of C<$!> contains the operating system 118On callback entrance, the value of C<$!> contains the operating system
118error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 119error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
120C<EPROTO>).
119 121
120While not mandatory, it is I<highly> recommended to set this callback, as 122While not mandatory, it is I<highly> recommended to set this callback, as
121you will not be notified of errors otherwise. The default simply calls 123you will not be notified of errors otherwise. The default simply calls
122C<croak>. 124C<croak>.
123 125
127and no read request is in the queue (unlike read queue callbacks, this 129and 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 130callback will only be called when at least one octet of data is in the
129read buffer). 131read buffer).
130 132
131To access (and remove data from) the read buffer, use the C<< ->rbuf >> 133To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132method or access the C<$handle->{rbuf}> member directly. Note that you 134method 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 135must not enlarge or modify the read buffer, you can only remove data at
134the beginning from it. 136the beginning from it.
135 137
136When an EOF condition is detected then AnyEvent::Handle will first try to 138When 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 139feed 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 140calling the C<on_eof> callback. If no progress can be made, then a fatal
139error will be raised (with C<$!> set to C<EPIPE>). 141error will be raised (with C<$!> set to C<EPIPE>).
142
143Note that, unlike requests in the read queue, an C<on_read> callback
144doesn't mean you I<require> some data: if there is an EOF and there
145are outstanding read requests then an error will be flagged. With an
146C<on_read> callback, the C<on_eof> callback will be invoked.
140 147
141=item on_drain => $cb->($handle) 148=item on_drain => $cb->($handle)
142 149
143This sets the callback that is called when the write buffer becomes empty 150This 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). 151(or when the callback is set and the buffer is empty already).
237 244
238This will not work for partial TLS data that could not be encoded 245This 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 246yet. This data will be lost. Calling the C<stoptls> method in time might
240help. 247help.
241 248
249=item peername => $string
250
251A string used to identify the remote site - usually the DNS hostname
252(I<not> IDN!) used to create the connection, rarely the IP address.
253
254Apart from being useful in error messages, this string is also used in TLS
255peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
256verification will be skipped when C<peername> is not specified or
257C<undef>.
258
242=item tls => "accept" | "connect" | Net::SSLeay::SSL object 259=item tls => "accept" | "connect" | Net::SSLeay::SSL object
243 260
244When this parameter is given, it enables TLS (SSL) mode, that means 261When this parameter is given, it enables TLS (SSL) mode, that means
245AnyEvent will start a TLS handshake as soon as the conenction has been 262AnyEvent will start a TLS handshake as soon as the conenction has been
246established and will transparently encrypt/decrypt data afterwards. 263established and will transparently encrypt/decrypt data afterwards.
264
265All TLS protocol errors will be signalled as C<EPROTO>, with an
266appropriate error message.
247 267
248TLS mode requires Net::SSLeay to be installed (it will be loaded 268TLS mode requires Net::SSLeay to be installed (it will be loaded
249automatically when you try to create a TLS handle): this module doesn't 269automatically 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 270have a dependency on that module, so if your module requires it, you have
251to add the dependency yourself. 271to add the dependency yourself.
255mode. 275mode.
256 276
257You can also provide your own TLS connection object, but you have 277You can also provide your own TLS connection object, but you have
258to make sure that you call either C<Net::SSLeay::set_connect_state> 278to 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 279or C<Net::SSLeay::set_accept_state> on it before you pass it to
260AnyEvent::Handle. 280AnyEvent::Handle. Also, this module will take ownership of this connection
281object.
282
283At some future point, AnyEvent::Handle might switch to another TLS
284implementation, then the option to use your own session object will go
285away.
261 286
262B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 287B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263passing in the wrong integer will lead to certain crash. This most often 288passing 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 289happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265segmentation fault. 290segmentation fault.
266 291
267See the C<< ->starttls >> method for when need to start TLS negotiation later. 292See the C<< ->starttls >> method for when need to start TLS negotiation later.
268 293
269=item tls_ctx => $ssl_ctx 294=item tls_ctx => $anyevent_tls
270 295
271Use the given C<Net::SSLeay::CTX> object to create the new TLS connection 296Use the given C<AnyEvent::TLS> object to create the new TLS connection
272(unless a connection object was specified directly). If this parameter is 297(unless a connection object was specified directly). If this parameter is
273missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 298missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
299
300Instead of an object, you can also specify a hash reference with C<< key
301=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
302new TLS context object.
303
304=item on_starttls => $cb->($handle, $success[, $error_message])
305
306This callback will be invoked when the TLS/SSL handshake has finished. If
307C<$success> is true, then the TLS handshake succeeded, otherwise it failed
308(C<on_stoptls> will not be called in this case).
309
310The session in C<< $handle->{tls} >> can still be examined in this
311callback, even when the handshake was not successful.
312
313TLS handshake failures will not cause C<on_error> to be invoked when this
314callback is in effect, instead, the error message will be passed to C<on_starttls>.
315
316Without this callback, handshake failures lead to C<on_error> being
317called, as normal.
318
319Note that you cannot call C<starttls> right again in this callback. If you
320need to do that, start an zero-second timer instead whose callback can
321then call C<< ->starttls >> again.
322
323=item on_stoptls => $cb->($handle)
324
325When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
326set, then it will be invoked after freeing the TLS session. If it is not,
327then a TLS shutdown condition will be treated like a normal EOF condition
328on the handle.
329
330The session in C<< $handle->{tls} >> can still be examined in this
331callback.
332
333This callback will only be called on TLS shutdowns, not when the
334underlying handle signals EOF.
274 335
275=item json => JSON or JSON::XS object 336=item json => JSON or JSON::XS object
276 337
277This is the json coder object used by the C<json> read and write types. 338This is the json coder object used by the C<json> read and write types.
278 339
287 348
288=cut 349=cut
289 350
290sub new { 351sub new {
291 my $class = shift; 352 my $class = shift;
292
293 my $self = bless { @_ }, $class; 353 my $self = bless { @_ }, $class;
294 354
295 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 355 $self->{fh} or Carp::croak "mandatory argument fh is missing";
296 356
297 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 357 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
358
359 $self->{_activity} = AnyEvent->now;
360 $self->_timeout;
361
362 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
298 363
299 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 364 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300 if $self->{tls}; 365 if $self->{tls};
301 366
302 $self->{_activity} = AnyEvent->now;
303 $self->_timeout;
304
305 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; 367 $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 368
308 $self->start_read 369 $self->start_read
309 if $self->{on_read}; 370 if $self->{on_read};
310 371
311 $self 372 $self->{fh} && $self
312} 373}
313 374
314sub _shutdown { 375#sub _shutdown {
315 my ($self) = @_; 376# my ($self) = @_;
316 377#
317 delete $self->{_tw}; 378# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
318 delete $self->{_rw}; 379# $self->{_eof} = 1; # tell starttls et. al to stop trying
319 delete $self->{_ww}; 380#
320 delete $self->{fh};
321
322 &_freetls; 381# &_freetls;
323 382#}
324 delete $self->{on_read};
325 delete $self->{_queue};
326}
327 383
328sub _error { 384sub _error {
329 my ($self, $errno, $fatal) = @_; 385 my ($self, $errno, $fatal, $message) = @_;
330
331 $self->_shutdown
332 if $fatal;
333 386
334 $! = $errno; 387 $! = $errno;
388 $message ||= "$!";
335 389
336 if ($self->{on_error}) { 390 if ($self->{on_error}) {
337 $self->{on_error}($self, $fatal); 391 $self->{on_error}($self, $fatal, $message);
392 $self->destroy if $fatal;
338 } elsif ($self->{fh}) { 393 } elsif ($self->{fh}) {
394 $self->destroy;
339 Carp::croak "AnyEvent::Handle uncaught error: $!"; 395 Carp::croak "AnyEvent::Handle uncaught error: $message";
340 } 396 }
341} 397}
342 398
343=item $fh = $handle->fh 399=item $fh = $handle->fh
344 400
405 local $SIG{__DIE__}; 461 local $SIG{__DIE__};
406 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; 462 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
407 }; 463 };
408} 464}
409 465
466=item $handle->on_starttls ($cb)
467
468Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
469
470=cut
471
472sub on_starttls {
473 $_[0]{on_starttls} = $_[1];
474}
475
476=item $handle->on_stoptls ($cb)
477
478Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
479
480=cut
481
482sub on_starttls {
483 $_[0]{on_stoptls} = $_[1];
484}
485
410############################################################################# 486#############################################################################
411 487
412=item $handle->timeout ($seconds) 488=item $handle->timeout ($seconds)
413 489
414Configures (or disables) the inactivity timeout. 490Configures (or disables) the inactivity timeout.
438 $self->{_activity} = $NOW; 514 $self->{_activity} = $NOW;
439 515
440 if ($self->{on_timeout}) { 516 if ($self->{on_timeout}) {
441 $self->{on_timeout}($self); 517 $self->{on_timeout}($self);
442 } else { 518 } else {
443 $self->_error (&Errno::ETIMEDOUT); 519 $self->_error (Errno::ETIMEDOUT);
444 } 520 }
445 521
446 # callback could have changed timeout value, optimise 522 # callback could have changed timeout value, optimise
447 return unless $self->{timeout}; 523 return unless $self->{timeout};
448 524
511 Scalar::Util::weaken $self; 587 Scalar::Util::weaken $self;
512 588
513 my $cb = sub { 589 my $cb = sub {
514 my $len = syswrite $self->{fh}, $self->{wbuf}; 590 my $len = syswrite $self->{fh}, $self->{wbuf};
515 591
516 if ($len >= 0) { 592 if (defined $len) {
517 substr $self->{wbuf}, 0, $len, ""; 593 substr $self->{wbuf}, 0, $len, "";
518 594
519 $self->{_activity} = AnyEvent->now; 595 $self->{_activity} = AnyEvent->now;
520 596
521 $self->{on_drain}($self) 597 $self->{on_drain}($self)
656 732
657 pack "w/a*", Storable::nfreeze ($ref) 733 pack "w/a*", Storable::nfreeze ($ref)
658}; 734};
659 735
660=back 736=back
737
738=item $handle->push_shutdown
739
740Sometimes you know you want to close the socket after writing your data
741before it was actually written. One way to do that is to replace your
742C<on_drain> handler by a callback that shuts down the socket (and set
743C<low_water_mark> to C<0>). This method is a shorthand for just that, and
744replaces the C<on_drain> callback with:
745
746 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
747
748This simply shuts down the write side and signals an EOF condition to the
749the peer.
750
751You can rely on the normal read queue and C<on_eof> handling
752afterwards. This is the cleanest way to close a connection.
753
754=cut
755
756sub push_shutdown {
757 my ($self) = @_;
758
759 delete $self->{low_water_mark};
760 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
761}
661 762
662=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 763=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
663 764
664This function (not method) lets you add your own types to C<push_write>. 765This 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 766Whenever the given C<type> is used, C<push_write> will invoke the code
765 866
766 if ( 867 if (
767 defined $self->{rbuf_max} 868 defined $self->{rbuf_max}
768 && $self->{rbuf_max} < length $self->{rbuf} 869 && $self->{rbuf_max} < length $self->{rbuf}
769 ) { 870 ) {
770 $self->_error (&Errno::ENOSPC, 1), return; 871 $self->_error (Errno::ENOSPC, 1), return;
771 } 872 }
772 873
773 while () { 874 while () {
774 # we need to use a separate tls read buffer, as we must not receive data while 875 # 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. 876 # we are draining the buffer, and this can only happen with TLS.
779 880
780 if (my $cb = shift @{ $self->{_queue} }) { 881 if (my $cb = shift @{ $self->{_queue} }) {
781 unless ($cb->($self)) { 882 unless ($cb->($self)) {
782 if ($self->{_eof}) { 883 if ($self->{_eof}) {
783 # no progress can be made (not enough data and no data forthcoming) 884 # no progress can be made (not enough data and no data forthcoming)
784 $self->_error (&Errno::EPIPE, 1), return; 885 $self->_error (Errno::EPIPE, 1), return;
785 } 886 }
786 887
787 unshift @{ $self->{_queue} }, $cb; 888 unshift @{ $self->{_queue} }, $cb;
788 last; 889 last;
789 } 890 }
797 && !@{ $self->{_queue} } # and the queue is still empty 898 && !@{ $self->{_queue} } # and the queue is still empty
798 && $self->{on_read} # but we still have on_read 899 && $self->{on_read} # but we still have on_read
799 ) { 900 ) {
800 # no further data will arrive 901 # no further data will arrive
801 # so no progress can be made 902 # so no progress can be made
802 $self->_error (&Errno::EPIPE, 1), return 903 $self->_error (Errno::EPIPE, 1), return
803 if $self->{_eof}; 904 if $self->{_eof};
804 905
805 last; # more data might arrive 906 last; # more data might arrive
806 } 907 }
807 } else { 908 } else {
813 914
814 if ($self->{_eof}) { 915 if ($self->{_eof}) {
815 if ($self->{on_eof}) { 916 if ($self->{on_eof}) {
816 $self->{on_eof}($self) 917 $self->{on_eof}($self)
817 } else { 918 } else {
818 $self->_error (0, 1); 919 $self->_error (0, 1, "Unexpected end-of-file");
819 } 920 }
820 } 921 }
821 922
822 # may need to restart read watcher 923 # may need to restart read watcher
823 unless ($self->{_rw}) { 924 unless ($self->{_rw}) {
1057 return 1; 1158 return 1;
1058 } 1159 }
1059 1160
1060 # reject 1161 # reject
1061 if ($reject && $$rbuf =~ $reject) { 1162 if ($reject && $$rbuf =~ $reject) {
1062 $self->_error (&Errno::EBADMSG); 1163 $self->_error (Errno::EBADMSG);
1063 } 1164 }
1064 1165
1065 # skip 1166 # skip
1066 if ($skip && $$rbuf =~ $skip) { 1167 if ($skip && $$rbuf =~ $skip) {
1067 $data .= substr $$rbuf, 0, $+[0], ""; 1168 $data .= substr $$rbuf, 0, $+[0], "";
1083 my ($self, $cb) = @_; 1184 my ($self, $cb) = @_;
1084 1185
1085 sub { 1186 sub {
1086 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { 1187 unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1087 if ($_[0]{rbuf} =~ /[^0-9]/) { 1188 if ($_[0]{rbuf} =~ /[^0-9]/) {
1088 $self->_error (&Errno::EBADMSG); 1189 $self->_error (Errno::EBADMSG);
1089 } 1190 }
1090 return; 1191 return;
1091 } 1192 }
1092 1193
1093 my $len = $1; 1194 my $len = $1;
1096 my $string = $_[1]; 1197 my $string = $_[1];
1097 $_[0]->unshift_read (chunk => 1, sub { 1198 $_[0]->unshift_read (chunk => 1, sub {
1098 if ($_[1] eq ",") { 1199 if ($_[1] eq ",") {
1099 $cb->($_[0], $string); 1200 $cb->($_[0], $string);
1100 } else { 1201 } else {
1101 $self->_error (&Errno::EBADMSG); 1202 $self->_error (Errno::EBADMSG);
1102 } 1203 }
1103 }); 1204 });
1104 }); 1205 });
1105 1206
1106 1 1207 1
1173=cut 1274=cut
1174 1275
1175register_read_type json => sub { 1276register_read_type json => sub {
1176 my ($self, $cb) = @_; 1277 my ($self, $cb) = @_;
1177 1278
1178 require JSON; 1279 my $json = $self->{json} ||=
1280 eval { require JSON::XS; JSON::XS->new->utf8 }
1281 || do { require JSON; JSON->new->utf8 };
1179 1282
1180 my $data; 1283 my $data;
1181 my $rbuf = \$self->{rbuf}; 1284 my $rbuf = \$self->{rbuf};
1182
1183 my $json = $self->{json} ||= JSON->new->utf8;
1184 1285
1185 sub { 1286 sub {
1186 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1287 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187 1288
1188 if ($ref) { 1289 if ($ref) {
1196 $json->incr_skip; 1297 $json->incr_skip;
1197 1298
1198 $self->{rbuf} = $json->incr_text; 1299 $self->{rbuf} = $json->incr_text;
1199 $json->incr_text = ""; 1300 $json->incr_text = "";
1200 1301
1201 $self->_error (&Errno::EBADMSG); 1302 $self->_error (Errno::EBADMSG);
1202 1303
1203 () 1304 ()
1204 } else { 1305 } else {
1205 $self->{rbuf} = ""; 1306 $self->{rbuf} = "";
1206 1307
1243 # read remaining chunk 1344 # read remaining chunk
1244 $_[0]->unshift_read (chunk => $len, sub { 1345 $_[0]->unshift_read (chunk => $len, sub {
1245 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1346 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246 $cb->($_[0], $ref); 1347 $cb->($_[0], $ref);
1247 } else { 1348 } else {
1248 $self->_error (&Errno::EBADMSG); 1349 $self->_error (Errno::EBADMSG);
1249 } 1350 }
1250 }); 1351 });
1251 } 1352 }
1252 1353
1253 1 1354 1
1332 } 1433 }
1333 }); 1434 });
1334 } 1435 }
1335} 1436}
1336 1437
1438our $ERROR_SYSCALL;
1439our $ERROR_WANT_READ;
1440
1441sub _tls_error {
1442 my ($self, $err) = @_;
1443
1444 return $self->_error ($!, 1)
1445 if $err == Net::SSLeay::ERROR_SYSCALL ();
1446
1447 my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1448
1449 # reduce error string to look less scary
1450 $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1451
1452 if ($self->{_on_starttls}) {
1453 (delete $self->{_on_starttls})->($self, undef, $err);
1454 &_freetls;
1455 } else {
1456 &_freetls;
1457 $self->_error (Errno::EPROTO, 1, $err);
1458 }
1459}
1460
1337# poll the write BIO and send the data if applicable 1461# poll the write BIO and send the data if applicable
1462# also decode read data if possible
1463# this is basiclaly our TLS state machine
1464# more efficient implementations are possible with openssl,
1465# but not with the buggy and incomplete Net::SSLeay.
1338sub _dotls { 1466sub _dotls {
1339 my ($self) = @_; 1467 my ($self) = @_;
1340 1468
1341 my $tmp; 1469 my $tmp;
1342 1470
1343 if (length $self->{_tls_wbuf}) { 1471 if (length $self->{_tls_wbuf}) {
1344 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1472 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345 substr $self->{_tls_wbuf}, 0, $tmp, ""; 1473 substr $self->{_tls_wbuf}, 0, $tmp, "";
1346 } 1474 }
1475
1476 $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1477 return $self->_tls_error ($tmp)
1478 if $tmp != $ERROR_WANT_READ
1479 && ($tmp != $ERROR_SYSCALL || $!);
1347 } 1480 }
1348 1481
1349 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { 1482 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350 unless (length $tmp) { 1483 unless (length $tmp) {
1351 # let's treat SSL-eof as we treat normal EOF 1484 $self->{_on_starttls}
1352 delete $self->{_rw}; 1485 and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353 $self->{_eof} = 1;
1354 &_freetls; 1486 &_freetls;
1487
1488 if ($self->{on_stoptls}) {
1489 $self->{on_stoptls}($self);
1490 return;
1491 } else {
1492 # let's treat SSL-eof as we treat normal EOF
1493 delete $self->{_rw};
1494 $self->{_eof} = 1;
1495 }
1355 } 1496 }
1356 1497
1357 $self->{_tls_rbuf} .= $tmp; 1498 $self->{_tls_rbuf} .= $tmp;
1358 $self->_drain_rbuf unless $self->{_in_drain}; 1499 $self->_drain_rbuf unless $self->{_in_drain};
1359 $self->{tls} or return; # tls session might have gone away in callback 1500 $self->{tls} or return; # tls session might have gone away in callback
1360 } 1501 }
1361 1502
1362 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1503 $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); 1504 return $self->_tls_error ($tmp)
1367 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { 1505 if $tmp != $ERROR_WANT_READ
1368 return $self->_error (&Errno::EIO, 1); 1506 && ($tmp != $ERROR_SYSCALL || $!);
1369 }
1370
1371 # all other errors are fine for our purposes
1372 }
1373 1507
1374 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1508 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375 $self->{wbuf} .= $tmp; 1509 $self->{wbuf} .= $tmp;
1376 $self->_drain_wbuf; 1510 $self->_drain_wbuf;
1377 } 1511 }
1512
1513 $self->{_on_starttls}
1514 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1515 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1378} 1516}
1379 1517
1380=item $handle->starttls ($tls[, $tls_ctx]) 1518=item $handle->starttls ($tls[, $tls_ctx])
1381 1519
1382Instead of starting TLS negotiation immediately when the AnyEvent::Handle 1520Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1384C<starttls>. 1522C<starttls>.
1385 1523
1386The first argument is the same as the C<tls> constructor argument (either 1524The first argument is the same as the C<tls> constructor argument (either
1387C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1525C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388 1526
1389The second argument is the optional C<Net::SSLeay::CTX> object that is 1527The second argument is the optional C<AnyEvent::TLS> object that is used
1390used when AnyEvent::Handle has to create its own TLS connection object. 1528when AnyEvent::Handle has to create its own TLS connection object, or
1529a hash reference with C<< key => value >> pairs that will be used to
1530construct a new context.
1391 1531
1392The TLS connection object will end up in C<< $handle->{tls} >> after this 1532The 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 1533context in C<< $handle->{tls_ctx} >> after this call and can be used or
1394might have already started when this function returns. 1534changed to your liking. Note that the handshake might have already started
1535when this function returns.
1395 1536
1396If it an error to start a TLS handshake more than once per 1537If it an error to start a TLS handshake more than once per
1397AnyEvent::Handle object (this is due to bugs in OpenSSL). 1538AnyEvent::Handle object (this is due to bugs in OpenSSL).
1398 1539
1399=cut 1540=cut
1400 1541
1542our %TLS_CACHE; #TODO not yet documented, should we?
1543
1401sub starttls { 1544sub starttls {
1402 my ($self, $ssl, $ctx) = @_; 1545 my ($self, $ssl, $ctx) = @_;
1403 1546
1404 require Net::SSLeay; 1547 require Net::SSLeay;
1405 1548
1406 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" 1549 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1407 if $self->{tls}; 1550 if $self->{tls};
1551
1552 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554
1555 $ctx ||= $self->{tls_ctx};
1556
1557 if ("HASH" eq ref $ctx) {
1558 require AnyEvent::TLS;
1559
1560 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561
1562 if ($ctx->{cache}) {
1563 my $key = $ctx+0;
1564 $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1565 } else {
1566 $ctx = new AnyEvent::TLS %$ctx;
1567 }
1568 }
1408 1569
1409 if ($ssl eq "accept") { 1570 $self->{tls_ctx} = $ctx || TLS_CTX ();
1410 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1571 $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 1572
1419 # basically, this is deep magic (because SSL_read should have the same issues) 1573 # 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". 1574 # but the openssl maintainers basically said: "trust us, it just works".
1421 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1575 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422 # and mismaintained ssleay-module doesn't even offer them). 1576 # and mismaintained ssleay-module doesn't even offer them).
1426 # 1580 #
1427 # note that we do not try to keep the length constant between writes as we are required to do. 1581 # 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, 1582 # 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 1583 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1430 # have identity issues in that area. 1584 # have identity issues in that area.
1431 Net::SSLeay::CTX_set_mode ($self->{tls}, 1585# Net::SSLeay::CTX_set_mode ($ssl,
1432 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1586# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1433 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1587# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1588 Net::SSLeay::CTX_set_mode ($ssl, 1|2);
1434 1589
1435 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1590 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1591 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437 1592
1438 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1593 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1594
1595 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596 if $self->{on_starttls};
1439 1597
1440 &_dotls; # need to trigger the initial handshake 1598 &_dotls; # need to trigger the initial handshake
1441 $self->start_read; # make sure we actually do read 1599 $self->start_read; # make sure we actually do read
1442} 1600}
1443 1601
1456 if ($self->{tls}) { 1614 if ($self->{tls}) {
1457 Net::SSLeay::shutdown ($self->{tls}); 1615 Net::SSLeay::shutdown ($self->{tls});
1458 1616
1459 &_dotls; 1617 &_dotls;
1460 1618
1461 # we don't give a shit. no, we do, but we can't. no... 1619# # we don't give a shit. no, we do, but we can't. no...#d#
1462 # we, we... have to use openssl :/ 1620# # we, we... have to use openssl :/#d#
1463 &_freetls; 1621# &_freetls;#d#
1464 } 1622 }
1465} 1623}
1466 1624
1467sub _freetls { 1625sub _freetls {
1468 my ($self) = @_; 1626 my ($self) = @_;
1469 1627
1470 return unless $self->{tls}; 1628 return unless $self->{tls};
1471 1629
1472 Net::SSLeay::free (delete $self->{tls}); 1630 $self->{tls_ctx}->_put_session (delete $self->{tls});
1473 1631
1474 delete @$self{qw(_rbio _wbio _tls_wbuf)}; 1632 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475} 1633}
1476 1634
1477sub DESTROY { 1635sub DESTROY {
1478 my $self = shift; 1636 my ($self) = @_;
1479 1637
1480 &_freetls; 1638 &_freetls;
1481 1639
1482 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1640 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1483 1641
1503} 1661}
1504 1662
1505=item $handle->destroy 1663=item $handle->destroy
1506 1664
1507Shuts down the handle object as much as possible - this call ensures that 1665Shuts 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 1666no further callbacks will be invoked and as many resources as possible
1509as possible. You must not call any methods on the object afterwards. 1667will be freed. You must not call any methods on the object afterwards.
1510 1668
1511Normally, you can just "forget" any references to an AnyEvent::Handle 1669Normally, you can just "forget" any references to an AnyEvent::Handle
1512object and it will simply shut down. This works in fatal error and EOF 1670object 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 1671callbacks, 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 1672callback, so when you want to destroy the AnyEvent::Handle object from
1515within such an callback. You I<MUST> call C<< ->destroy >> explicitly in 1673within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1516that case. 1674that case.
1517 1675
1676Destroying the handle object in this way has the advantage that callbacks
1677will be removed as well, so if those are the only reference holders (as
1678is common), then one doesn't need to do anything special to break any
1679reference cycles.
1680
1518The handle might still linger in the background and write out remaining 1681The handle might still linger in the background and write out remaining
1519data, as specified by the C<linger> option, however. 1682data, as specified by the C<linger> option, however.
1520 1683
1521=cut 1684=cut
1522 1685
1527 %$self = (); 1690 %$self = ();
1528} 1691}
1529 1692
1530=item AnyEvent::Handle::TLS_CTX 1693=item AnyEvent::Handle::TLS_CTX
1531 1694
1532This function creates and returns the Net::SSLeay::CTX object used by 1695This function creates and returns the AnyEvent::TLS object used by default
1533default for TLS mode. 1696for TLS mode.
1534 1697
1535The context is created like this: 1698The 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 1699
1545=cut 1700=cut
1546 1701
1547our $TLS_CTX; 1702our $TLS_CTX;
1548 1703
1549sub TLS_CTX() { 1704sub TLS_CTX() {
1550 $TLS_CTX || do { 1705 $TLS_CTX ||= do {
1551 require Net::SSLeay; 1706 require AnyEvent::TLS;
1552 1707
1553 Net::SSLeay::load_error_strings (); 1708 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 } 1709 }
1563} 1710}
1564 1711
1565=back 1712=back
1566 1713
1605 1752
1606 $handle->on_read (sub { }); 1753 $handle->on_read (sub { });
1607 $handle->on_eof (undef); 1754 $handle->on_eof (undef);
1608 $handle->on_error (sub { 1755 $handle->on_error (sub {
1609 my $data = delete $_[0]{rbuf}; 1756 my $data = delete $_[0]{rbuf};
1610 undef $handle;
1611 }); 1757 });
1612 1758
1613The reason to use C<on_error> is that TCP connections, due to latencies 1759The 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 1760and packets loss, might get closed quite violently with an error, when in
1615fact, all data has been received. 1761fact, all data has been received.
1631 $handle->on_drain (sub { 1777 $handle->on_drain (sub {
1632 warn "all data submitted to the kernel\n"; 1778 warn "all data submitted to the kernel\n";
1633 undef $handle; 1779 undef $handle;
1634 }); 1780 });
1635 1781
1782If you just want to queue some data and then signal EOF to the other side,
1783consider using C<< ->push_shutdown >> instead.
1784
1785=item I want to contact a TLS/SSL server, I don't care about security.
1786
1787If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1788simply connect to it and then create the AnyEvent::Handle with the C<tls>
1789parameter:
1790
1791 tcp_connect $host, $port, sub {
1792 my ($fh) = @_;
1793
1794 my $handle = new AnyEvent::Handle
1795 fh => $fh,
1796 tls => "connect",
1797 on_error => sub { ... };
1798
1799 $handle->push_write (...);
1800 };
1801
1802=item I want to contact a TLS/SSL server, I do care about security.
1803
1804Then you should additionally enable certificate verification, including
1805peername verification, if the protocol you use supports it (see
1806L<AnyEvent::TLS>, C<verify_peername>).
1807
1808E.g. for HTTPS:
1809
1810 tcp_connect $host, $port, sub {
1811 my ($fh) = @_;
1812
1813 my $handle = new AnyEvent::Handle
1814 fh => $fh,
1815 peername => $host,
1816 tls => "connect",
1817 tls_ctx => { verify => 1, verify_peername => "https" },
1818 ...
1819
1820Note that you must specify the hostname you connected to (or whatever
1821"peername" the protocol needs) as the C<peername> argument, otherwise no
1822peername verification will be done.
1823
1824The above will use the system-dependent default set of trusted CA
1825certificates. If you want to check against a specific CA, add the
1826C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1827
1828 tls_ctx => {
1829 verify => 1,
1830 verify_peername => "https",
1831 ca_file => "my-ca-cert.pem",
1832 },
1833
1834=item I want to create a TLS/SSL server, how do I do that?
1835
1836Well, you first need to get a server certificate and key. You have
1837three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1838self-signed certificate (cheap. check the search engine of your choice,
1839there are many tutorials on the net) or c) make your own CA (tinyca2 is a
1840nice program for that purpose).
1841
1842Then create a file with your private key (in PEM format, see
1843L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
1844file should then look like this:
1845
1846 -----BEGIN RSA PRIVATE KEY-----
1847 ...header data
1848 ... lots of base64'y-stuff
1849 -----END RSA PRIVATE KEY-----
1850
1851 -----BEGIN CERTIFICATE-----
1852 ... lots of base64'y-stuff
1853 -----END CERTIFICATE-----
1854
1855The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
1856specify this file as C<cert_file>:
1857
1858 tcp_server undef, $port, sub {
1859 my ($fh) = @_;
1860
1861 my $handle = new AnyEvent::Handle
1862 fh => $fh,
1863 tls => "accept",
1864 tls_ctx => { cert_file => "my-server-keycert.pem" },
1865 ...
1866
1867When you have intermediate CA certificates that your clients might not
1868know about, just append them to the C<cert_file>.
1869
1636=back 1870=back
1637 1871
1638 1872
1639=head1 SUBCLASSING AnyEvent::Handle 1873=head1 SUBCLASSING AnyEvent::Handle
1640 1874

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines