… | |
… | |
14 | |
14 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
16 | |
17 | =cut |
17 | =cut |
18 | |
18 | |
19 | our $VERSION = 4.3; |
19 | our $VERSION = 4.8; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
27 | |
27 | |
28 | my $handle = |
28 | my $handle = |
29 | AnyEvent::Handle->new ( |
29 | AnyEvent::Handle->new ( |
30 | fh => \*STDIN, |
30 | fh => \*STDIN, |
31 | on_eof => sub { |
31 | on_eof => sub { |
32 | $cv->broadcast; |
32 | $cv->send; |
33 | }, |
33 | }, |
34 | ); |
34 | ); |
35 | |
35 | |
36 | # send some request line |
36 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
37 | $handle->push_write ("getinfo\015\012"); |
… | |
… | |
59 | treatment of characters applies to this module as well. |
59 | treatment of characters applies to this module as well. |
60 | |
60 | |
61 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
62 | argument. |
63 | |
63 | |
64 | =head2 SIGPIPE is not handled by this module |
|
|
65 | |
|
|
66 | SIGPIPE is not handled by this module, so one of the practical |
|
|
67 | requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} = |
|
|
68 | 'IGNORE'>). At least, this is highly recommend in a networked program: If |
|
|
69 | you use AnyEvent::Handle in a filter program (like sort), exiting on |
|
|
70 | SIGPIPE is probably the right thing to do. |
|
|
71 | |
|
|
72 | =head1 METHODS |
64 | =head1 METHODS |
73 | |
65 | |
74 | =over 4 |
66 | =over 4 |
75 | |
67 | |
76 | =item B<new (%args)> |
68 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
77 | |
69 | |
78 | The constructor supports these arguments (all as key => value pairs). |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
79 | |
71 | |
80 | =over 4 |
72 | =over 4 |
81 | |
73 | |
82 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
83 | |
75 | |
… | |
… | |
92 | Set the callback to be called when an end-of-file condition is detected, |
84 | Set the callback to be called when an end-of-file condition is detected, |
93 | i.e. in the case of a socket, when the other side has closed the |
85 | i.e. in the case of a socket, when the other side has closed the |
94 | connection cleanly. |
86 | connection cleanly. |
95 | |
87 | |
96 | For sockets, this just means that the other side has stopped sending data, |
88 | For sockets, this just means that the other side has stopped sending data, |
97 | you can still try to write data, and, in fact, one can return from the eof |
89 | you can still try to write data, and, in fact, one can return from the EOF |
98 | callback and continue writing data, as only the read part has been shut |
90 | callback and continue writing data, as only the read part has been shut |
99 | down. |
91 | down. |
100 | |
92 | |
101 | While not mandatory, it is I<highly> recommended to set an eof callback, |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
102 | otherwise you might end up with a closed socket while you are still |
94 | otherwise you might end up with a closed socket while you are still |
103 | waiting for data. |
95 | waiting for data. |
104 | |
96 | |
105 | If an EOF condition has been detected but no C<on_eof> callback has been |
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
106 | set, then a fatal error will be raised with C<$!> set to <0>. |
98 | set, then a fatal error will be raised with C<$!> set to <0>. |
107 | |
99 | |
108 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal, $message) |
109 | |
101 | |
110 | This is the error callback, which is called when, well, some error |
102 | This is the error callback, which is called when, well, some error |
111 | occured, such as not being able to resolve the hostname, failure to |
103 | occured, such as not being able to resolve the hostname, failure to |
112 | connect or a read error. |
104 | connect or a read error. |
113 | |
105 | |
… | |
… | |
115 | fatal errors the handle object will be shut down and will not be usable |
107 | fatal errors the handle object will be shut down and will not be usable |
116 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
117 | errors are an EOF condition with active (but unsatisifable) read watchers |
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
118 | (C<EPIPE>) or I/O errors. |
110 | (C<EPIPE>) or I/O errors. |
119 | |
111 | |
|
|
112 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
113 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
114 | recommended to always output the C<$message> argument in human-readable |
|
|
115 | error messages (it's usually the same as C<"$!">). |
|
|
116 | |
120 | Non-fatal errors can be retried by simply returning, but it is recommended |
117 | Non-fatal errors can be retried by simply returning, but it is recommended |
121 | to simply ignore this parameter and instead abondon the handle object |
118 | to simply ignore this parameter and instead abondon the handle object |
122 | when this callback is invoked. Examples of non-fatal errors are timeouts |
119 | when this callback is invoked. Examples of non-fatal errors are timeouts |
123 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
120 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
124 | |
121 | |
125 | On callback entrance, the value of C<$!> contains the operating system |
122 | On callback entrance, the value of C<$!> contains the operating system |
126 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
123 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
124 | C<EPROTO>). |
127 | |
125 | |
128 | While not mandatory, it is I<highly> recommended to set this callback, as |
126 | While not mandatory, it is I<highly> recommended to set this callback, as |
129 | you will not be notified of errors otherwise. The default simply calls |
127 | you will not be notified of errors otherwise. The default simply calls |
130 | C<croak>. |
128 | C<croak>. |
131 | |
129 | |
… | |
… | |
135 | and no read request is in the queue (unlike read queue callbacks, this |
133 | and no read request is in the queue (unlike read queue callbacks, this |
136 | callback will only be called when at least one octet of data is in the |
134 | callback will only be called when at least one octet of data is in the |
137 | read buffer). |
135 | read buffer). |
138 | |
136 | |
139 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
137 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
140 | method or access the C<$handle->{rbuf}> member directly. |
138 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
139 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
140 | the beginning from it. |
141 | |
141 | |
142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
142 | When an EOF condition is detected then AnyEvent::Handle will first try to |
143 | feed all the remaining data to the queued callbacks and C<on_read> before |
143 | feed all the remaining data to the queued callbacks and C<on_read> before |
144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
144 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
145 | error will be raised (with C<$!> set to C<EPIPE>). |
145 | error will be raised (with C<$!> set to C<EPIPE>). |
… | |
… | |
243 | |
243 | |
244 | This will not work for partial TLS data that could not be encoded |
244 | This will not work for partial TLS data that could not be encoded |
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
246 | help. |
246 | help. |
247 | |
247 | |
|
|
248 | =item peername => $string |
|
|
249 | |
|
|
250 | A string used to identify the remote site - usually the DNS hostname |
|
|
251 | (I<not> IDN!) used to create the connection, rarely the IP address. |
|
|
252 | |
|
|
253 | Apart from being useful in error messages, this string is also used in TLS |
|
|
254 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
|
|
255 | verification will be skipped when C<peername> is not specified or |
|
|
256 | C<undef>. |
|
|
257 | |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
258 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
249 | |
259 | |
250 | When this parameter is given, it enables TLS (SSL) mode, that means |
260 | When this parameter is given, it enables TLS (SSL) mode, that means |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
261 | AnyEvent will start a TLS handshake as soon as the conenction has been |
252 | established and will transparently encrypt/decrypt data afterwards. |
262 | established and will transparently encrypt/decrypt data afterwards. |
|
|
263 | |
|
|
264 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
|
|
265 | appropriate error message. |
253 | |
266 | |
254 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
267 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
255 | automatically when you try to create a TLS handle): this module doesn't |
268 | automatically when you try to create a TLS handle): this module doesn't |
256 | have a dependency on that module, so if your module requires it, you have |
269 | have a dependency on that module, so if your module requires it, you have |
257 | to add the dependency yourself. |
270 | to add the dependency yourself. |
… | |
… | |
261 | mode. |
274 | mode. |
262 | |
275 | |
263 | You can also provide your own TLS connection object, but you have |
276 | You can also provide your own TLS connection object, but you have |
264 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
277 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
278 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
266 | AnyEvent::Handle. |
279 | AnyEvent::Handle. Also, this module will take ownership of this connection |
|
|
280 | object. |
|
|
281 | |
|
|
282 | At some future point, AnyEvent::Handle might switch to another TLS |
|
|
283 | implementation, then the option to use your own session object will go |
|
|
284 | away. |
|
|
285 | |
|
|
286 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
287 | passing in the wrong integer will lead to certain crash. This most often |
|
|
288 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
289 | segmentation fault. |
267 | |
290 | |
268 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
291 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
269 | |
292 | |
270 | =item tls_ctx => $ssl_ctx |
293 | =item tls_ctx => $anyevent_tls |
271 | |
294 | |
272 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
295 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
273 | (unless a connection object was specified directly). If this parameter is |
296 | (unless a connection object was specified directly). If this parameter is |
274 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
297 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
298 | |
|
|
299 | Instead of an object, you can also specify a hash reference with C<< key |
|
|
300 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
|
|
301 | new TLS context object. |
|
|
302 | |
|
|
303 | =item on_starttls => $cb->($handle, $success[, $error_message]) |
|
|
304 | |
|
|
305 | This callback will be invoked when the TLS/SSL handshake has finished. If |
|
|
306 | C<$success> is true, then the TLS handshake succeeded, otherwise it failed |
|
|
307 | (C<on_stoptls> will not be called in this case). |
|
|
308 | |
|
|
309 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
310 | callback, even when the handshake was not successful. |
|
|
311 | |
|
|
312 | TLS handshake failures will not cause C<on_error> to be invoked when this |
|
|
313 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
|
|
314 | |
|
|
315 | Without this callback, handshake failures lead to C<on_error> being |
|
|
316 | called, as normal. |
|
|
317 | |
|
|
318 | Note that you cannot call C<starttls> right again in this callback. If you |
|
|
319 | need to do that, start an zero-second timer instead whose callback can |
|
|
320 | then call C<< ->starttls >> again. |
|
|
321 | |
|
|
322 | =item on_stoptls => $cb->($handle) |
|
|
323 | |
|
|
324 | When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is |
|
|
325 | set, then it will be invoked after freeing the TLS session. If it is not, |
|
|
326 | then a TLS shutdown condition will be treated like a normal EOF condition |
|
|
327 | on the handle. |
|
|
328 | |
|
|
329 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
330 | callback. |
|
|
331 | |
|
|
332 | This callback will only be called on TLS shutdowns, not when the |
|
|
333 | underlying handle signals EOF. |
275 | |
334 | |
276 | =item json => JSON or JSON::XS object |
335 | =item json => JSON or JSON::XS object |
277 | |
336 | |
278 | This is the json coder object used by the C<json> read and write types. |
337 | This is the json coder object used by the C<json> read and write types. |
279 | |
338 | |
… | |
… | |
288 | |
347 | |
289 | =cut |
348 | =cut |
290 | |
349 | |
291 | sub new { |
350 | sub new { |
292 | my $class = shift; |
351 | my $class = shift; |
293 | |
|
|
294 | my $self = bless { @_ }, $class; |
352 | my $self = bless { @_ }, $class; |
295 | |
353 | |
296 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
354 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
297 | |
355 | |
298 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
356 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
|
|
357 | |
|
|
358 | $self->{_activity} = AnyEvent->now; |
|
|
359 | $self->_timeout; |
|
|
360 | |
|
|
361 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
299 | |
362 | |
300 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
363 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
301 | if $self->{tls}; |
364 | if $self->{tls}; |
302 | |
365 | |
303 | $self->{_activity} = AnyEvent->now; |
|
|
304 | $self->_timeout; |
|
|
305 | |
|
|
306 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
366 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
307 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
308 | |
367 | |
309 | $self->start_read |
368 | $self->start_read |
310 | if $self->{on_read}; |
369 | if $self->{on_read}; |
311 | |
370 | |
312 | $self |
371 | $self->{fh} && $self |
313 | } |
372 | } |
314 | |
373 | |
315 | sub _shutdown { |
374 | sub _shutdown { |
316 | my ($self) = @_; |
375 | my ($self) = @_; |
317 | |
376 | |
318 | delete $self->{_tw}; |
377 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
319 | delete $self->{_rw}; |
378 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
320 | delete $self->{_ww}; |
|
|
321 | delete $self->{fh}; |
|
|
322 | |
379 | |
323 | &_freetls; |
380 | &_freetls; |
324 | |
|
|
325 | delete $self->{on_read}; |
|
|
326 | delete $self->{_queue}; |
|
|
327 | } |
381 | } |
328 | |
382 | |
329 | sub _error { |
383 | sub _error { |
330 | my ($self, $errno, $fatal) = @_; |
384 | my ($self, $errno, $fatal, $message) = @_; |
331 | |
385 | |
332 | $self->_shutdown |
386 | $self->_shutdown |
333 | if $fatal; |
387 | if $fatal; |
334 | |
388 | |
335 | $! = $errno; |
389 | $! = $errno; |
|
|
390 | $message ||= "$!"; |
336 | |
391 | |
337 | if ($self->{on_error}) { |
392 | if ($self->{on_error}) { |
338 | $self->{on_error}($self, $fatal); |
393 | $self->{on_error}($self, $fatal, $message); |
339 | } else { |
394 | } elsif ($self->{fh}) { |
340 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
395 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
341 | } |
396 | } |
342 | } |
397 | } |
343 | |
398 | |
344 | =item $fh = $handle->fh |
399 | =item $fh = $handle->fh |
345 | |
400 | |
… | |
… | |
382 | } |
437 | } |
383 | |
438 | |
384 | =item $handle->autocork ($boolean) |
439 | =item $handle->autocork ($boolean) |
385 | |
440 | |
386 | Enables or disables the current autocork behaviour (see C<autocork> |
441 | Enables or disables the current autocork behaviour (see C<autocork> |
387 | constructor argument). |
442 | constructor argument). Changes will only take effect on the next write. |
388 | |
443 | |
389 | =cut |
444 | =cut |
|
|
445 | |
|
|
446 | sub autocork { |
|
|
447 | $_[0]{autocork} = $_[1]; |
|
|
448 | } |
390 | |
449 | |
391 | =item $handle->no_delay ($boolean) |
450 | =item $handle->no_delay ($boolean) |
392 | |
451 | |
393 | Enables or disables the C<no_delay> setting (see constructor argument of |
452 | Enables or disables the C<no_delay> setting (see constructor argument of |
394 | the same name for details). |
453 | the same name for details). |
… | |
… | |
400 | |
459 | |
401 | eval { |
460 | eval { |
402 | local $SIG{__DIE__}; |
461 | local $SIG{__DIE__}; |
403 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
462 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
404 | }; |
463 | }; |
|
|
464 | } |
|
|
465 | |
|
|
466 | =item $handle->on_starttls ($cb) |
|
|
467 | |
|
|
468 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
|
|
469 | |
|
|
470 | =cut |
|
|
471 | |
|
|
472 | sub on_starttls { |
|
|
473 | $_[0]{on_starttls} = $_[1]; |
|
|
474 | } |
|
|
475 | |
|
|
476 | =item $handle->on_stoptls ($cb) |
|
|
477 | |
|
|
478 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
|
|
479 | |
|
|
480 | =cut |
|
|
481 | |
|
|
482 | sub on_starttls { |
|
|
483 | $_[0]{on_stoptls} = $_[1]; |
405 | } |
484 | } |
406 | |
485 | |
407 | ############################################################################# |
486 | ############################################################################# |
408 | |
487 | |
409 | =item $handle->timeout ($seconds) |
488 | =item $handle->timeout ($seconds) |
… | |
… | |
653 | |
732 | |
654 | pack "w/a*", Storable::nfreeze ($ref) |
733 | pack "w/a*", Storable::nfreeze ($ref) |
655 | }; |
734 | }; |
656 | |
735 | |
657 | =back |
736 | =back |
|
|
737 | |
|
|
738 | =item $handle->push_shutdown |
|
|
739 | |
|
|
740 | Sometimes you know you want to close the socket after writing your data |
|
|
741 | before it was actually written. One way to do that is to replace your |
|
|
742 | C<on_drain> handler by a callback that shuts down the socket (and set |
|
|
743 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
|
|
744 | replaces the C<on_drain> callback with: |
|
|
745 | |
|
|
746 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
|
|
747 | |
|
|
748 | This simply shuts down the write side and signals an EOF condition to the |
|
|
749 | the peer. |
|
|
750 | |
|
|
751 | You can rely on the normal read queue and C<on_eof> handling |
|
|
752 | afterwards. This is the cleanest way to close a connection. |
|
|
753 | |
|
|
754 | =cut |
|
|
755 | |
|
|
756 | sub push_shutdown { |
|
|
757 | my ($self) = @_; |
|
|
758 | |
|
|
759 | delete $self->{low_water_mark}; |
|
|
760 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
|
|
761 | } |
658 | |
762 | |
659 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
763 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
660 | |
764 | |
661 | This function (not method) lets you add your own types to C<push_write>. |
765 | This function (not method) lets you add your own types to C<push_write>. |
662 | Whenever the given C<type> is used, C<push_write> will invoke the code |
766 | Whenever the given C<type> is used, C<push_write> will invoke the code |
… | |
… | |
766 | ) { |
870 | ) { |
767 | $self->_error (&Errno::ENOSPC, 1), return; |
871 | $self->_error (&Errno::ENOSPC, 1), return; |
768 | } |
872 | } |
769 | |
873 | |
770 | while () { |
874 | while () { |
|
|
875 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
876 | # we are draining the buffer, and this can only happen with TLS. |
|
|
877 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
|
|
878 | |
771 | my $len = length $self->{rbuf}; |
879 | my $len = length $self->{rbuf}; |
772 | |
880 | |
773 | if (my $cb = shift @{ $self->{_queue} }) { |
881 | if (my $cb = shift @{ $self->{_queue} }) { |
774 | unless ($cb->($self)) { |
882 | unless ($cb->($self)) { |
775 | if ($self->{_eof}) { |
883 | if ($self->{_eof}) { |
… | |
… | |
806 | |
914 | |
807 | if ($self->{_eof}) { |
915 | if ($self->{_eof}) { |
808 | if ($self->{on_eof}) { |
916 | if ($self->{on_eof}) { |
809 | $self->{on_eof}($self) |
917 | $self->{on_eof}($self) |
810 | } else { |
918 | } else { |
811 | $self->_error (0, 1); |
919 | $self->_error (0, 1, "Unexpected end-of-file"); |
812 | } |
920 | } |
813 | } |
921 | } |
814 | |
922 | |
815 | # may need to restart read watcher |
923 | # may need to restart read watcher |
816 | unless ($self->{_rw}) { |
924 | unless ($self->{_rw}) { |
… | |
… | |
836 | |
944 | |
837 | =item $handle->rbuf |
945 | =item $handle->rbuf |
838 | |
946 | |
839 | Returns the read buffer (as a modifiable lvalue). |
947 | Returns the read buffer (as a modifiable lvalue). |
840 | |
948 | |
841 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
949 | You can access the read buffer directly as the C<< ->{rbuf} >> |
842 | you want. |
950 | member, if you want. However, the only operation allowed on the |
|
|
951 | read buffer (apart from looking at it) is removing data from its |
|
|
952 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
953 | lead to hard-to-track-down bugs. |
843 | |
954 | |
844 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
955 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
845 | C<push_read> or C<unshift_read> methods are used. The other read methods |
956 | C<push_read> or C<unshift_read> methods are used. The other read methods |
846 | automatically manage the read buffer. |
957 | automatically manage the read buffer. |
847 | |
958 | |
… | |
… | |
1143 | } |
1254 | } |
1144 | }; |
1255 | }; |
1145 | |
1256 | |
1146 | =item json => $cb->($handle, $hash_or_arrayref) |
1257 | =item json => $cb->($handle, $hash_or_arrayref) |
1147 | |
1258 | |
1148 | Reads a JSON object or array, decodes it and passes it to the callback. |
1259 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1260 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1149 | |
1261 | |
1150 | If a C<json> object was passed to the constructor, then that will be used |
1262 | If a C<json> object was passed to the constructor, then that will be used |
1151 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1263 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1152 | |
1264 | |
1153 | This read type uses the incremental parser available with JSON version |
1265 | This read type uses the incremental parser available with JSON version |
… | |
… | |
1162 | =cut |
1274 | =cut |
1163 | |
1275 | |
1164 | register_read_type json => sub { |
1276 | register_read_type json => sub { |
1165 | my ($self, $cb) = @_; |
1277 | my ($self, $cb) = @_; |
1166 | |
1278 | |
1167 | require JSON; |
1279 | my $json = $self->{json} ||= |
|
|
1280 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1281 | || do { require JSON; JSON->new->utf8 }; |
1168 | |
1282 | |
1169 | my $data; |
1283 | my $data; |
1170 | my $rbuf = \$self->{rbuf}; |
1284 | my $rbuf = \$self->{rbuf}; |
1171 | |
1285 | |
1172 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1173 | |
|
|
1174 | sub { |
1286 | sub { |
1175 | my $ref = $json->incr_parse ($self->{rbuf}); |
1287 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1176 | |
1288 | |
1177 | if ($ref) { |
1289 | if ($ref) { |
1178 | $self->{rbuf} = $json->incr_text; |
1290 | $self->{rbuf} = $json->incr_text; |
1179 | $json->incr_text = ""; |
1291 | $json->incr_text = ""; |
1180 | $cb->($self, $ref); |
1292 | $cb->($self, $ref); |
1181 | |
1293 | |
1182 | 1 |
1294 | 1 |
|
|
1295 | } elsif ($@) { |
|
|
1296 | # error case |
|
|
1297 | $json->incr_skip; |
|
|
1298 | |
|
|
1299 | $self->{rbuf} = $json->incr_text; |
|
|
1300 | $json->incr_text = ""; |
|
|
1301 | |
|
|
1302 | $self->_error (&Errno::EBADMSG); |
|
|
1303 | |
|
|
1304 | () |
1183 | } else { |
1305 | } else { |
1184 | $self->{rbuf} = ""; |
1306 | $self->{rbuf} = ""; |
|
|
1307 | |
1185 | () |
1308 | () |
1186 | } |
1309 | } |
1187 | } |
1310 | } |
1188 | }; |
1311 | }; |
1189 | |
1312 | |
… | |
… | |
1310 | } |
1433 | } |
1311 | }); |
1434 | }); |
1312 | } |
1435 | } |
1313 | } |
1436 | } |
1314 | |
1437 | |
|
|
1438 | our $ERROR_SYSCALL; |
|
|
1439 | our $ERROR_WANT_READ; |
|
|
1440 | |
|
|
1441 | sub _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 | |
1315 | # 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. |
1316 | sub _dotls { |
1466 | sub _dotls { |
1317 | my ($self) = @_; |
1467 | my ($self) = @_; |
1318 | |
1468 | |
1319 | my $tmp; |
1469 | my $tmp; |
1320 | |
1470 | |
1321 | if (length $self->{_tls_wbuf}) { |
1471 | if (length $self->{_tls_wbuf}) { |
1322 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1472 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1323 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1473 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1324 | } |
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 || $!); |
1325 | } |
1480 | } |
1326 | |
1481 | |
1327 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1482 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1328 | unless (length $tmp) { |
1483 | unless (length $tmp) { |
1329 | # let's treat SSL-eof as we treat normal EOF |
1484 | $self->{_on_starttls} |
1330 | delete $self->{_rw}; |
1485 | and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ??? |
1331 | $self->{_eof} = 1; |
|
|
1332 | &_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 | } |
1333 | } |
1496 | } |
1334 | |
1497 | |
1335 | $self->{rbuf} .= $tmp; |
1498 | $self->{_tls_rbuf} .= $tmp; |
1336 | $self->_drain_rbuf unless $self->{_in_drain}; |
1499 | $self->_drain_rbuf unless $self->{_in_drain}; |
1337 | $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 |
1338 | } |
1501 | } |
1339 | |
1502 | |
1340 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1503 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1341 | |
|
|
1342 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1343 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1344 | return $self->_error ($!, 1); |
1504 | return $self->_tls_error ($tmp) |
1345 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1505 | if $tmp != $ERROR_WANT_READ |
1346 | return $self->_error (&Errno::EIO, 1); |
1506 | && ($tmp != $ERROR_SYSCALL || $!); |
1347 | } |
|
|
1348 | |
|
|
1349 | # all other errors are fine for our purposes |
|
|
1350 | } |
|
|
1351 | |
1507 | |
1352 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1508 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1353 | $self->{wbuf} .= $tmp; |
1509 | $self->{wbuf} .= $tmp; |
1354 | $self->_drain_wbuf; |
1510 | $self->_drain_wbuf; |
1355 | } |
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"); |
1356 | } |
1516 | } |
1357 | |
1517 | |
1358 | =item $handle->starttls ($tls[, $tls_ctx]) |
1518 | =item $handle->starttls ($tls[, $tls_ctx]) |
1359 | |
1519 | |
1360 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1520 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1362 | C<starttls>. |
1522 | C<starttls>. |
1363 | |
1523 | |
1364 | The first argument is the same as the C<tls> constructor argument (either |
1524 | The first argument is the same as the C<tls> constructor argument (either |
1365 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1525 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1366 | |
1526 | |
1367 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1527 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1368 | used when AnyEvent::Handle has to create its own TLS connection object. |
1528 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1529 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1530 | construct a new context. |
1369 | |
1531 | |
1370 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1532 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1371 | call and can be used or changed to your liking. Note that the handshake |
1533 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1372 | might have already started when this function returns. |
1534 | changed to your liking. Note that the handshake might have already started |
|
|
1535 | when this function returns. |
1373 | |
1536 | |
1374 | If it an error to start a TLS handshake more than once per |
1537 | If it an error to start a TLS handshake more than once per |
1375 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1538 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1376 | |
1539 | |
1377 | =cut |
1540 | =cut |
1378 | |
1541 | |
|
|
1542 | our %TLS_CACHE; #TODO not yet documented, should we? |
|
|
1543 | |
1379 | sub starttls { |
1544 | sub starttls { |
1380 | my ($self, $ssl, $ctx) = @_; |
1545 | my ($self, $ssl, $ctx) = @_; |
1381 | |
1546 | |
1382 | require Net::SSLeay; |
1547 | require Net::SSLeay; |
1383 | |
1548 | |
1384 | 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" |
1385 | 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 | } |
1386 | |
1569 | |
1387 | if ($ssl eq "accept") { |
1570 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1388 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1571 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1389 | Net::SSLeay::set_accept_state ($ssl); |
|
|
1390 | } elsif ($ssl eq "connect") { |
|
|
1391 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
1392 | Net::SSLeay::set_connect_state ($ssl); |
|
|
1393 | } |
|
|
1394 | |
|
|
1395 | $self->{tls} = $ssl; |
|
|
1396 | |
1572 | |
1397 | # 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) |
1398 | # but the openssl maintainers basically said: "trust us, it just works". |
1574 | # but the openssl maintainers basically said: "trust us, it just works". |
1399 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1575 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1400 | # and mismaintained ssleay-module doesn't even offer them). |
1576 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1404 | # |
1580 | # |
1405 | # 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. |
1406 | # 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, |
1407 | # 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 |
1408 | # have identity issues in that area. |
1584 | # have identity issues in that area. |
1409 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1585 | # Net::SSLeay::CTX_set_mode ($ssl, |
1410 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1586 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1411 | | (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); |
1412 | |
1589 | |
1413 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1590 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1414 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1591 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1415 | |
1592 | |
1416 | 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}; |
1417 | |
1597 | |
1418 | &_dotls; # need to trigger the initial handshake |
1598 | &_dotls; # need to trigger the initial handshake |
1419 | $self->start_read; # make sure we actually do read |
1599 | $self->start_read; # make sure we actually do read |
1420 | } |
1600 | } |
1421 | |
1601 | |
… | |
… | |
1434 | if ($self->{tls}) { |
1614 | if ($self->{tls}) { |
1435 | Net::SSLeay::shutdown ($self->{tls}); |
1615 | Net::SSLeay::shutdown ($self->{tls}); |
1436 | |
1616 | |
1437 | &_dotls; |
1617 | &_dotls; |
1438 | |
1618 | |
1439 | # 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# |
1440 | # we, we... have to use openssl :/ |
1620 | # # we, we... have to use openssl :/#d# |
1441 | &_freetls; |
1621 | # &_freetls;#d# |
1442 | } |
1622 | } |
1443 | } |
1623 | } |
1444 | |
1624 | |
1445 | sub _freetls { |
1625 | sub _freetls { |
1446 | my ($self) = @_; |
1626 | my ($self) = @_; |
1447 | |
1627 | |
1448 | return unless $self->{tls}; |
1628 | return unless $self->{tls}; |
1449 | |
1629 | |
1450 | Net::SSLeay::free (delete $self->{tls}); |
1630 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
1451 | |
1631 | |
1452 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1632 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1453 | } |
1633 | } |
1454 | |
1634 | |
1455 | sub DESTROY { |
1635 | sub DESTROY { |
1456 | my $self = shift; |
1636 | my ($self) = @_; |
1457 | |
1637 | |
1458 | &_freetls; |
1638 | &_freetls; |
1459 | |
1639 | |
1460 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1640 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1461 | |
1641 | |
… | |
… | |
1478 | @linger = (); |
1658 | @linger = (); |
1479 | }); |
1659 | }); |
1480 | } |
1660 | } |
1481 | } |
1661 | } |
1482 | |
1662 | |
|
|
1663 | =item $handle->destroy |
|
|
1664 | |
|
|
1665 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1666 | no further callbacks will be invoked and as many resources as possible |
|
|
1667 | will be freed. You must not call any methods on the object afterwards. |
|
|
1668 | |
|
|
1669 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1670 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1671 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1672 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1673 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1674 | that case. |
|
|
1675 | |
|
|
1676 | The handle might still linger in the background and write out remaining |
|
|
1677 | data, as specified by the C<linger> option, however. |
|
|
1678 | |
|
|
1679 | =cut |
|
|
1680 | |
|
|
1681 | sub destroy { |
|
|
1682 | my ($self) = @_; |
|
|
1683 | |
|
|
1684 | $self->DESTROY; |
|
|
1685 | %$self = (); |
|
|
1686 | } |
|
|
1687 | |
1483 | =item AnyEvent::Handle::TLS_CTX |
1688 | =item AnyEvent::Handle::TLS_CTX |
1484 | |
1689 | |
1485 | This function creates and returns the Net::SSLeay::CTX object used by |
1690 | This function creates and returns the AnyEvent::TLS object used by default |
1486 | default for TLS mode. |
1691 | for TLS mode. |
1487 | |
1692 | |
1488 | The context is created like this: |
1693 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1489 | |
|
|
1490 | Net::SSLeay::load_error_strings; |
|
|
1491 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1492 | Net::SSLeay::randomize; |
|
|
1493 | |
|
|
1494 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1495 | |
|
|
1496 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1497 | |
1694 | |
1498 | =cut |
1695 | =cut |
1499 | |
1696 | |
1500 | our $TLS_CTX; |
1697 | our $TLS_CTX; |
1501 | |
1698 | |
1502 | sub TLS_CTX() { |
1699 | sub TLS_CTX() { |
1503 | $TLS_CTX || do { |
1700 | $TLS_CTX ||= do { |
1504 | require Net::SSLeay; |
1701 | require AnyEvent::TLS; |
1505 | |
1702 | |
1506 | Net::SSLeay::load_error_strings (); |
1703 | new AnyEvent::TLS |
1507 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1508 | Net::SSLeay::randomize (); |
|
|
1509 | |
|
|
1510 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1511 | |
|
|
1512 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1513 | |
|
|
1514 | $TLS_CTX |
|
|
1515 | } |
1704 | } |
1516 | } |
1705 | } |
1517 | |
1706 | |
1518 | =back |
1707 | =back |
1519 | |
1708 | |
1520 | |
1709 | |
1521 | =head1 NONFREQUENTLY ASKED QUESTIONS |
1710 | =head1 NONFREQUENTLY ASKED QUESTIONS |
1522 | |
1711 | |
1523 | =over 4 |
1712 | =over 4 |
|
|
1713 | |
|
|
1714 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1715 | still get further invocations! |
|
|
1716 | |
|
|
1717 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1718 | read or write callbacks. |
|
|
1719 | |
|
|
1720 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1721 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1722 | ->destroy >> method. |
|
|
1723 | |
|
|
1724 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1725 | reading? |
|
|
1726 | |
|
|
1727 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1728 | communication channels, one for each direction. Or put differently. The |
|
|
1729 | read and write directions are not independent of each other: you cannot |
|
|
1730 | write data unless you are also prepared to read, and vice versa. |
|
|
1731 | |
|
|
1732 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1733 | callback invocations when you are not expecting any read data - the reason |
|
|
1734 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1735 | |
|
|
1736 | During the connection, you have to make sure that you always have a |
|
|
1737 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1738 | connection (or when you no longer want to use it) you can call the |
|
|
1739 | C<destroy> method. |
1524 | |
1740 | |
1525 | =item How do I read data until the other side closes the connection? |
1741 | =item How do I read data until the other side closes the connection? |
1526 | |
1742 | |
1527 | If you just want to read your data into a perl scalar, the easiest way |
1743 | If you just want to read your data into a perl scalar, the easiest way |
1528 | to achieve this is by setting an C<on_read> callback that does nothing, |
1744 | to achieve this is by setting an C<on_read> callback that does nothing, |
… | |
… | |
1538 | |
1754 | |
1539 | The reason to use C<on_error> is that TCP connections, due to latencies |
1755 | The reason to use C<on_error> is that TCP connections, due to latencies |
1540 | and packets loss, might get closed quite violently with an error, when in |
1756 | and packets loss, might get closed quite violently with an error, when in |
1541 | fact, all data has been received. |
1757 | fact, all data has been received. |
1542 | |
1758 | |
1543 | It is usually better to use acknowledgements when transfering data, |
1759 | It is usually better to use acknowledgements when transferring data, |
1544 | to make sure the other side hasn't just died and you got the data |
1760 | to make sure the other side hasn't just died and you got the data |
1545 | intact. This is also one reason why so many internet protocols have an |
1761 | intact. This is also one reason why so many internet protocols have an |
1546 | explicit QUIT command. |
1762 | explicit QUIT command. |
1547 | |
|
|
1548 | |
1763 | |
1549 | =item I don't want to destroy the handle too early - how do I wait until |
1764 | =item I don't want to destroy the handle too early - how do I wait until |
1550 | all data has been written? |
1765 | all data has been written? |
1551 | |
1766 | |
1552 | After writing your last bits of data, set the C<on_drain> callback |
1767 | After writing your last bits of data, set the C<on_drain> callback |
… | |
… | |
1558 | $handle->on_drain (sub { |
1773 | $handle->on_drain (sub { |
1559 | warn "all data submitted to the kernel\n"; |
1774 | warn "all data submitted to the kernel\n"; |
1560 | undef $handle; |
1775 | undef $handle; |
1561 | }); |
1776 | }); |
1562 | |
1777 | |
|
|
1778 | If you just want to queue some data and then signal EOF to the other side, |
|
|
1779 | consider using C<< ->push_shutdown >> instead. |
|
|
1780 | |
|
|
1781 | =item I want to contact a TLS/SSL server, I don't care about security. |
|
|
1782 | |
|
|
1783 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
|
|
1784 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
|
|
1785 | parameter: |
|
|
1786 | |
|
|
1787 | tcp_connect $host, $port, sub { |
|
|
1788 | my ($fh) = @_; |
|
|
1789 | |
|
|
1790 | my $handle = new AnyEvent::Handle |
|
|
1791 | fh => $fh, |
|
|
1792 | tls => "connect", |
|
|
1793 | on_error => sub { ... }; |
|
|
1794 | |
|
|
1795 | $handle->push_write (...); |
|
|
1796 | }; |
|
|
1797 | |
|
|
1798 | =item I want to contact a TLS/SSL server, I do care about security. |
|
|
1799 | |
|
|
1800 | Then you should additionally enable certificate verification, including |
|
|
1801 | peername verification, if the protocol you use supports it (see |
|
|
1802 | L<AnyEvent::TLS>, C<verify_peername>). |
|
|
1803 | |
|
|
1804 | E.g. for HTTPS: |
|
|
1805 | |
|
|
1806 | tcp_connect $host, $port, sub { |
|
|
1807 | my ($fh) = @_; |
|
|
1808 | |
|
|
1809 | my $handle = new AnyEvent::Handle |
|
|
1810 | fh => $fh, |
|
|
1811 | peername => $host, |
|
|
1812 | tls => "connect", |
|
|
1813 | tls_ctx => { verify => 1, verify_peername => "https" }, |
|
|
1814 | ... |
|
|
1815 | |
|
|
1816 | Note that you must specify the hostname you connected to (or whatever |
|
|
1817 | "peername" the protocol needs) as the C<peername> argument, otherwise no |
|
|
1818 | peername verification will be done. |
|
|
1819 | |
|
|
1820 | The above will use the system-dependent default set of trusted CA |
|
|
1821 | certificates. If you want to check against a specific CA, add the |
|
|
1822 | C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>: |
|
|
1823 | |
|
|
1824 | tls_ctx => { |
|
|
1825 | verify => 1, |
|
|
1826 | verify_peername => "https", |
|
|
1827 | ca_file => "my-ca-cert.pem", |
|
|
1828 | }, |
|
|
1829 | |
|
|
1830 | =item I want to create a TLS/SSL server, how do I do that? |
|
|
1831 | |
|
|
1832 | Well, you first need to get a server certificate and key. You have |
|
|
1833 | three options: a) ask a CA (buy one, use cacert.org etc.) b) create a |
|
|
1834 | self-signed certificate (cheap. check the search engine of your choice, |
|
|
1835 | there are many tutorials on the net) or c) make your own CA (tinyca2 is a |
|
|
1836 | nice program for that purpose). |
|
|
1837 | |
|
|
1838 | Then create a file with your private key (in PEM format, see |
|
|
1839 | L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The |
|
|
1840 | file should then look like this: |
|
|
1841 | |
|
|
1842 | -----BEGIN RSA PRIVATE KEY----- |
|
|
1843 | ...header data |
|
|
1844 | ... lots of base64'y-stuff |
|
|
1845 | -----END RSA PRIVATE KEY----- |
|
|
1846 | |
|
|
1847 | -----BEGIN CERTIFICATE----- |
|
|
1848 | ... lots of base64'y-stuff |
|
|
1849 | -----END CERTIFICATE----- |
|
|
1850 | |
|
|
1851 | The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then |
|
|
1852 | specify this file as C<cert_file>: |
|
|
1853 | |
|
|
1854 | tcp_server undef, $port, sub { |
|
|
1855 | my ($fh) = @_; |
|
|
1856 | |
|
|
1857 | my $handle = new AnyEvent::Handle |
|
|
1858 | fh => $fh, |
|
|
1859 | tls => "accept", |
|
|
1860 | tls_ctx => { cert_file => "my-server-keycert.pem" }, |
|
|
1861 | ... |
|
|
1862 | |
|
|
1863 | When you have intermediate CA certificates that your clients might not |
|
|
1864 | know about, just append them to the C<cert_file>. |
|
|
1865 | |
1563 | =back |
1866 | =back |
1564 | |
1867 | |
1565 | |
1868 | |
1566 | =head1 SUBCLASSING AnyEvent::Handle |
1869 | =head1 SUBCLASSING AnyEvent::Handle |
1567 | |
1870 | |