… | |
… | |
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.452; |
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>). |
… | |
… | |
240 | write data and will install a watcher that will write this data to the |
240 | write data and will install a watcher that will write this data to the |
241 | socket. No errors will be reported (this mostly matches how the operating |
241 | socket. No errors will be reported (this mostly matches how the operating |
242 | system treats outstanding data at socket close time). |
242 | system treats outstanding data at socket close time). |
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. |
245 | yet. This data will be lost. Calling the C<stoptls> method in time might |
|
|
246 | help. |
|
|
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>). |
246 | |
255 | |
247 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
256 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | |
257 | |
249 | When this parameter is given, it enables TLS (SSL) mode, that means |
258 | When this parameter is given, it enables TLS (SSL) mode, that means |
250 | AnyEvent will start a TLS handshake as soon as the conenction has been |
259 | AnyEvent will start a TLS handshake as soon as the conenction has been |
251 | established and will transparently encrypt/decrypt data afterwards. |
260 | established and will transparently encrypt/decrypt data afterwards. |
|
|
261 | |
|
|
262 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
|
|
263 | appropriate error message. |
252 | |
264 | |
253 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
265 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
254 | automatically when you try to create a TLS handle): this module doesn't |
266 | automatically when you try to create a TLS handle): this module doesn't |
255 | have a dependency on that module, so if your module requires it, you have |
267 | have a dependency on that module, so if your module requires it, you have |
256 | to add the dependency yourself. |
268 | to add the dependency yourself. |
… | |
… | |
260 | mode. |
272 | mode. |
261 | |
273 | |
262 | You can also provide your own TLS connection object, but you have |
274 | You can also provide your own TLS connection object, but you have |
263 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
275 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
264 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
276 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
265 | AnyEvent::Handle. |
277 | AnyEvent::Handle. Also, this module will take ownership of this connection |
|
|
278 | object. |
|
|
279 | |
|
|
280 | At some future point, AnyEvent::Handle might switch to another TLS |
|
|
281 | implementation, then the option to use your own session object will go |
|
|
282 | away. |
|
|
283 | |
|
|
284 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
285 | passing in the wrong integer will lead to certain crash. This most often |
|
|
286 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
287 | segmentation fault. |
266 | |
288 | |
267 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
289 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
268 | |
290 | |
269 | =item tls_ctx => $ssl_ctx |
291 | =item tls_ctx => $anyevent_tls |
270 | |
292 | |
271 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
293 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
272 | (unless a connection object was specified directly). If this parameter is |
294 | (unless a connection object was specified directly). If this parameter is |
273 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
295 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
296 | |
|
|
297 | Instead of an object, you can also specify a hash reference with C<< key |
|
|
298 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
|
|
299 | new TLS context object. |
|
|
300 | |
|
|
301 | =item on_starttls => $cb->($handle, $success[, $error_message]) |
|
|
302 | |
|
|
303 | This callback will be invoked when the TLS/SSL handshake has finished. If |
|
|
304 | C<$success> is true, then the TLS handshake succeeded, otherwise it failed |
|
|
305 | (C<on_stoptls> will not be called in this case). |
|
|
306 | |
|
|
307 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
308 | callback, even when the handshake was not successful. |
|
|
309 | |
|
|
310 | TLS handshake failures will not cause C<on_error> to be invoked when this |
|
|
311 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
|
|
312 | |
|
|
313 | Without this callback, handshake failures lead to C<on_error> being |
|
|
314 | called, as normal. |
|
|
315 | |
|
|
316 | Note that you cannot call C<starttls> right again in this callback. If you |
|
|
317 | need to do that, start an zero-second timer instead whose callback can |
|
|
318 | then call C<< ->starttls >> again. |
|
|
319 | |
|
|
320 | =item on_stoptls => $cb->($handle) |
|
|
321 | |
|
|
322 | When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is |
|
|
323 | set, then it will be invoked after freeing the TLS session. If it is not, |
|
|
324 | then a TLS shutdown condition will be treated like a normal EOF condition |
|
|
325 | on the handle. |
|
|
326 | |
|
|
327 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
328 | callback. |
|
|
329 | |
|
|
330 | This callback will only be called on TLS shutdowns, not when the |
|
|
331 | underlying handle signals EOF. |
274 | |
332 | |
275 | =item json => JSON or JSON::XS object |
333 | =item json => JSON or JSON::XS object |
276 | |
334 | |
277 | This is the json coder object used by the C<json> read and write types. |
335 | This is the json coder object used by the C<json> read and write types. |
278 | |
336 | |
… | |
… | |
281 | texts. |
339 | texts. |
282 | |
340 | |
283 | Note that you are responsible to depend on the JSON module if you want to |
341 | Note that you are responsible to depend on the JSON module if you want to |
284 | use this functionality, as AnyEvent does not have a dependency itself. |
342 | use this functionality, as AnyEvent does not have a dependency itself. |
285 | |
343 | |
286 | =item filter_r => $cb |
|
|
287 | |
|
|
288 | =item filter_w => $cb |
|
|
289 | |
|
|
290 | These exist, but are undocumented at this time. (They are used internally |
|
|
291 | by the TLS code). |
|
|
292 | |
|
|
293 | =back |
344 | =back |
294 | |
345 | |
295 | =cut |
346 | =cut |
296 | |
347 | |
297 | sub new { |
348 | sub new { |
298 | my $class = shift; |
349 | my $class = shift; |
299 | |
|
|
300 | my $self = bless { @_ }, $class; |
350 | my $self = bless { @_ }, $class; |
301 | |
351 | |
302 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
352 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
303 | |
353 | |
304 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
354 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
305 | |
|
|
306 | if ($self->{tls}) { |
|
|
307 | require Net::SSLeay; |
|
|
308 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
|
|
309 | } |
|
|
310 | |
355 | |
311 | $self->{_activity} = AnyEvent->now; |
356 | $self->{_activity} = AnyEvent->now; |
312 | $self->_timeout; |
357 | $self->_timeout; |
313 | |
358 | |
314 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
|
|
315 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
359 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
360 | |
|
|
361 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
|
|
362 | if $self->{tls}; |
|
|
363 | |
|
|
364 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
316 | |
365 | |
317 | $self->start_read |
366 | $self->start_read |
318 | if $self->{on_read}; |
367 | if $self->{on_read}; |
319 | |
368 | |
320 | $self |
369 | $self->{fh} && $self |
321 | } |
370 | } |
322 | |
371 | |
323 | sub _shutdown { |
372 | sub _shutdown { |
324 | my ($self) = @_; |
373 | my ($self) = @_; |
325 | |
374 | |
326 | delete $self->{_tw}; |
375 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
327 | delete $self->{_rw}; |
376 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
328 | delete $self->{_ww}; |
|
|
329 | delete $self->{fh}; |
|
|
330 | |
377 | |
331 | $self->stoptls; |
378 | &_freetls; |
332 | |
|
|
333 | delete $self->{on_read}; |
|
|
334 | delete $self->{_queue}; |
|
|
335 | } |
379 | } |
336 | |
380 | |
337 | sub _error { |
381 | sub _error { |
338 | my ($self, $errno, $fatal) = @_; |
382 | my ($self, $errno, $fatal, $message) = @_; |
339 | |
383 | |
340 | $self->_shutdown |
384 | $self->_shutdown |
341 | if $fatal; |
385 | if $fatal; |
342 | |
386 | |
343 | $! = $errno; |
387 | $! = $errno; |
|
|
388 | $message ||= "$!"; |
344 | |
389 | |
345 | if ($self->{on_error}) { |
390 | if ($self->{on_error}) { |
346 | $self->{on_error}($self, $fatal); |
391 | $self->{on_error}($self, $fatal, $message); |
347 | } else { |
392 | } elsif ($self->{fh}) { |
348 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
393 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
349 | } |
394 | } |
350 | } |
395 | } |
351 | |
396 | |
352 | =item $fh = $handle->fh |
397 | =item $fh = $handle->fh |
353 | |
398 | |
… | |
… | |
390 | } |
435 | } |
391 | |
436 | |
392 | =item $handle->autocork ($boolean) |
437 | =item $handle->autocork ($boolean) |
393 | |
438 | |
394 | Enables or disables the current autocork behaviour (see C<autocork> |
439 | Enables or disables the current autocork behaviour (see C<autocork> |
395 | constructor argument). |
440 | constructor argument). Changes will only take effect on the next write. |
396 | |
441 | |
397 | =cut |
442 | =cut |
|
|
443 | |
|
|
444 | sub autocork { |
|
|
445 | $_[0]{autocork} = $_[1]; |
|
|
446 | } |
398 | |
447 | |
399 | =item $handle->no_delay ($boolean) |
448 | =item $handle->no_delay ($boolean) |
400 | |
449 | |
401 | Enables or disables the C<no_delay> setting (see constructor argument of |
450 | Enables or disables the C<no_delay> setting (see constructor argument of |
402 | the same name for details). |
451 | the same name for details). |
… | |
… | |
408 | |
457 | |
409 | eval { |
458 | eval { |
410 | local $SIG{__DIE__}; |
459 | local $SIG{__DIE__}; |
411 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
460 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
412 | }; |
461 | }; |
|
|
462 | } |
|
|
463 | |
|
|
464 | =item $handle->on_starttls ($cb) |
|
|
465 | |
|
|
466 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
|
|
467 | |
|
|
468 | =cut |
|
|
469 | |
|
|
470 | sub on_starttls { |
|
|
471 | $_[0]{on_starttls} = $_[1]; |
|
|
472 | } |
|
|
473 | |
|
|
474 | =item $handle->on_stoptls ($cb) |
|
|
475 | |
|
|
476 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
|
|
477 | |
|
|
478 | =cut |
|
|
479 | |
|
|
480 | sub on_starttls { |
|
|
481 | $_[0]{on_stoptls} = $_[1]; |
413 | } |
482 | } |
414 | |
483 | |
415 | ############################################################################# |
484 | ############################################################################# |
416 | |
485 | |
417 | =item $handle->timeout ($seconds) |
486 | =item $handle->timeout ($seconds) |
… | |
… | |
495 | my ($self, $cb) = @_; |
564 | my ($self, $cb) = @_; |
496 | |
565 | |
497 | $self->{on_drain} = $cb; |
566 | $self->{on_drain} = $cb; |
498 | |
567 | |
499 | $cb->($self) |
568 | $cb->($self) |
500 | if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
569 | if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}); |
501 | } |
570 | } |
502 | |
571 | |
503 | =item $handle->push_write ($data) |
572 | =item $handle->push_write ($data) |
504 | |
573 | |
505 | Queues the given scalar to be written. You can push as much data as you |
574 | Queues the given scalar to be written. You can push as much data as you |
… | |
… | |
522 | substr $self->{wbuf}, 0, $len, ""; |
591 | substr $self->{wbuf}, 0, $len, ""; |
523 | |
592 | |
524 | $self->{_activity} = AnyEvent->now; |
593 | $self->{_activity} = AnyEvent->now; |
525 | |
594 | |
526 | $self->{on_drain}($self) |
595 | $self->{on_drain}($self) |
527 | if $self->{low_water_mark} >= length $self->{wbuf} |
596 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
528 | && $self->{on_drain}; |
597 | && $self->{on_drain}; |
529 | |
598 | |
530 | delete $self->{_ww} unless length $self->{wbuf}; |
599 | delete $self->{_ww} unless length $self->{wbuf}; |
531 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
600 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
532 | $self->_error ($!, 1); |
601 | $self->_error ($!, 1); |
… | |
… | |
556 | |
625 | |
557 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
626 | @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") |
558 | ->($self, @_); |
627 | ->($self, @_); |
559 | } |
628 | } |
560 | |
629 | |
561 | if ($self->{filter_w}) { |
630 | if ($self->{tls}) { |
562 | $self->{filter_w}($self, \$_[0]); |
631 | $self->{_tls_wbuf} .= $_[0]; |
|
|
632 | |
|
|
633 | &_dotls ($self); |
563 | } else { |
634 | } else { |
564 | $self->{wbuf} .= $_[0]; |
635 | $self->{wbuf} .= $_[0]; |
565 | $self->_drain_wbuf; |
636 | $self->_drain_wbuf; |
566 | } |
637 | } |
567 | } |
638 | } |
… | |
… | |
584 | =cut |
655 | =cut |
585 | |
656 | |
586 | register_write_type netstring => sub { |
657 | register_write_type netstring => sub { |
587 | my ($self, $string) = @_; |
658 | my ($self, $string) = @_; |
588 | |
659 | |
589 | sprintf "%d:%s,", (length $string), $string |
660 | (length $string) . ":$string," |
590 | }; |
661 | }; |
591 | |
662 | |
592 | =item packstring => $format, $data |
663 | =item packstring => $format, $data |
593 | |
664 | |
594 | An octet string prefixed with an encoded length. The encoding C<$format> |
665 | An octet string prefixed with an encoded length. The encoding C<$format> |
… | |
… | |
659 | |
730 | |
660 | pack "w/a*", Storable::nfreeze ($ref) |
731 | pack "w/a*", Storable::nfreeze ($ref) |
661 | }; |
732 | }; |
662 | |
733 | |
663 | =back |
734 | =back |
|
|
735 | |
|
|
736 | =item $handle->push_shutdown |
|
|
737 | |
|
|
738 | Sometimes you know you want to close the socket after writing your data |
|
|
739 | before it was actually written. One way to do that is to replace your |
|
|
740 | C<on_drain> handler by a callback that shuts down the socket (and set |
|
|
741 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
|
|
742 | replaces the C<on_drain> callback with: |
|
|
743 | |
|
|
744 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
|
|
745 | |
|
|
746 | This simply shuts down the write side and signals an EOF condition to the |
|
|
747 | the peer. |
|
|
748 | |
|
|
749 | You can rely on the normal read queue and C<on_eof> handling |
|
|
750 | afterwards. This is the cleanest way to close a connection. |
|
|
751 | |
|
|
752 | =cut |
|
|
753 | |
|
|
754 | sub push_shutdown { |
|
|
755 | my ($self) = @_; |
|
|
756 | |
|
|
757 | delete $self->{low_water_mark}; |
|
|
758 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
|
|
759 | } |
664 | |
760 | |
665 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
761 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
666 | |
762 | |
667 | This function (not method) lets you add your own types to C<push_write>. |
763 | This function (not method) lets you add your own types to C<push_write>. |
668 | Whenever the given C<type> is used, C<push_write> will invoke the code |
764 | Whenever the given C<type> is used, C<push_write> will invoke the code |
… | |
… | |
772 | ) { |
868 | ) { |
773 | $self->_error (&Errno::ENOSPC, 1), return; |
869 | $self->_error (&Errno::ENOSPC, 1), return; |
774 | } |
870 | } |
775 | |
871 | |
776 | while () { |
872 | while () { |
|
|
873 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
874 | # we are draining the buffer, and this can only happen with TLS. |
|
|
875 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
|
|
876 | |
777 | my $len = length $self->{rbuf}; |
877 | my $len = length $self->{rbuf}; |
778 | |
878 | |
779 | if (my $cb = shift @{ $self->{_queue} }) { |
879 | if (my $cb = shift @{ $self->{_queue} }) { |
780 | unless ($cb->($self)) { |
880 | unless ($cb->($self)) { |
781 | if ($self->{_eof}) { |
881 | if ($self->{_eof}) { |
… | |
… | |
803 | |
903 | |
804 | last; # more data might arrive |
904 | last; # more data might arrive |
805 | } |
905 | } |
806 | } else { |
906 | } else { |
807 | # read side becomes idle |
907 | # read side becomes idle |
808 | delete $self->{_rw}; |
908 | delete $self->{_rw} unless $self->{tls}; |
809 | last; |
909 | last; |
810 | } |
910 | } |
811 | } |
911 | } |
812 | |
912 | |
813 | if ($self->{_eof}) { |
913 | if ($self->{_eof}) { |
814 | if ($self->{on_eof}) { |
914 | if ($self->{on_eof}) { |
815 | $self->{on_eof}($self) |
915 | $self->{on_eof}($self) |
816 | } else { |
916 | } else { |
817 | $self->_error (0, 1); |
917 | $self->_error (0, 1, "Unexpected end-of-file"); |
818 | } |
918 | } |
819 | } |
919 | } |
820 | |
920 | |
821 | # may need to restart read watcher |
921 | # may need to restart read watcher |
822 | unless ($self->{_rw}) { |
922 | unless ($self->{_rw}) { |
… | |
… | |
842 | |
942 | |
843 | =item $handle->rbuf |
943 | =item $handle->rbuf |
844 | |
944 | |
845 | Returns the read buffer (as a modifiable lvalue). |
945 | Returns the read buffer (as a modifiable lvalue). |
846 | |
946 | |
847 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
947 | You can access the read buffer directly as the C<< ->{rbuf} >> |
848 | you want. |
948 | member, if you want. However, the only operation allowed on the |
|
|
949 | read buffer (apart from looking at it) is removing data from its |
|
|
950 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
951 | lead to hard-to-track-down bugs. |
849 | |
952 | |
850 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
953 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
851 | C<push_read> or C<unshift_read> methods are used. The other read methods |
954 | C<push_read> or C<unshift_read> methods are used. The other read methods |
852 | automatically manage the read buffer. |
955 | automatically manage the read buffer. |
853 | |
956 | |
… | |
… | |
1108 | An octet string prefixed with an encoded length. The encoding C<$format> |
1211 | An octet string prefixed with an encoded length. The encoding C<$format> |
1109 | uses the same format as a Perl C<pack> format, but must specify a single |
1212 | uses the same format as a Perl C<pack> format, but must specify a single |
1110 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1213 | integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an |
1111 | optional C<!>, C<< < >> or C<< > >> modifier). |
1214 | optional C<!>, C<< < >> or C<< > >> modifier). |
1112 | |
1215 | |
1113 | DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. |
1216 | For example, DNS over TCP uses a prefix of C<n> (2 octet network order), |
|
|
1217 | EPP uses a prefix of C<N> (4 octtes). |
1114 | |
1218 | |
1115 | Example: read a block of data prefixed by its length in BER-encoded |
1219 | Example: read a block of data prefixed by its length in BER-encoded |
1116 | format (very efficient). |
1220 | format (very efficient). |
1117 | |
1221 | |
1118 | $handle->push_read (packstring => "w", sub { |
1222 | $handle->push_read (packstring => "w", sub { |
… | |
… | |
1148 | } |
1252 | } |
1149 | }; |
1253 | }; |
1150 | |
1254 | |
1151 | =item json => $cb->($handle, $hash_or_arrayref) |
1255 | =item json => $cb->($handle, $hash_or_arrayref) |
1152 | |
1256 | |
1153 | Reads a JSON object or array, decodes it and passes it to the callback. |
1257 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1258 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1154 | |
1259 | |
1155 | If a C<json> object was passed to the constructor, then that will be used |
1260 | If a C<json> object was passed to the constructor, then that will be used |
1156 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1261 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1157 | |
1262 | |
1158 | This read type uses the incremental parser available with JSON version |
1263 | This read type uses the incremental parser available with JSON version |
… | |
… | |
1167 | =cut |
1272 | =cut |
1168 | |
1273 | |
1169 | register_read_type json => sub { |
1274 | register_read_type json => sub { |
1170 | my ($self, $cb) = @_; |
1275 | my ($self, $cb) = @_; |
1171 | |
1276 | |
1172 | require JSON; |
1277 | my $json = $self->{json} ||= |
|
|
1278 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1279 | || do { require JSON; JSON->new->utf8 }; |
1173 | |
1280 | |
1174 | my $data; |
1281 | my $data; |
1175 | my $rbuf = \$self->{rbuf}; |
1282 | my $rbuf = \$self->{rbuf}; |
1176 | |
1283 | |
1177 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1178 | |
|
|
1179 | sub { |
1284 | sub { |
1180 | my $ref = $json->incr_parse ($self->{rbuf}); |
1285 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1181 | |
1286 | |
1182 | if ($ref) { |
1287 | if ($ref) { |
1183 | $self->{rbuf} = $json->incr_text; |
1288 | $self->{rbuf} = $json->incr_text; |
1184 | $json->incr_text = ""; |
1289 | $json->incr_text = ""; |
1185 | $cb->($self, $ref); |
1290 | $cb->($self, $ref); |
1186 | |
1291 | |
1187 | 1 |
1292 | 1 |
|
|
1293 | } elsif ($@) { |
|
|
1294 | # error case |
|
|
1295 | $json->incr_skip; |
|
|
1296 | |
|
|
1297 | $self->{rbuf} = $json->incr_text; |
|
|
1298 | $json->incr_text = ""; |
|
|
1299 | |
|
|
1300 | $self->_error (&Errno::EBADMSG); |
|
|
1301 | |
|
|
1302 | () |
1188 | } else { |
1303 | } else { |
1189 | $self->{rbuf} = ""; |
1304 | $self->{rbuf} = ""; |
|
|
1305 | |
1190 | () |
1306 | () |
1191 | } |
1307 | } |
1192 | } |
1308 | } |
1193 | }; |
1309 | }; |
1194 | |
1310 | |
… | |
… | |
1271 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1387 | Note that AnyEvent::Handle will automatically C<start_read> for you when |
1272 | you change the C<on_read> callback or push/unshift a read callback, and it |
1388 | you change the C<on_read> callback or push/unshift a read callback, and it |
1273 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1389 | will automatically C<stop_read> for you when neither C<on_read> is set nor |
1274 | there are any read requests in the queue. |
1390 | there are any read requests in the queue. |
1275 | |
1391 | |
|
|
1392 | These methods will have no effect when in TLS mode (as TLS doesn't support |
|
|
1393 | half-duplex connections). |
|
|
1394 | |
1276 | =cut |
1395 | =cut |
1277 | |
1396 | |
1278 | sub stop_read { |
1397 | sub stop_read { |
1279 | my ($self) = @_; |
1398 | my ($self) = @_; |
1280 | |
1399 | |
1281 | delete $self->{_rw}; |
1400 | delete $self->{_rw} unless $self->{tls}; |
1282 | } |
1401 | } |
1283 | |
1402 | |
1284 | sub start_read { |
1403 | sub start_read { |
1285 | my ($self) = @_; |
1404 | my ($self) = @_; |
1286 | |
1405 | |
1287 | unless ($self->{_rw} || $self->{_eof}) { |
1406 | unless ($self->{_rw} || $self->{_eof}) { |
1288 | Scalar::Util::weaken $self; |
1407 | Scalar::Util::weaken $self; |
1289 | |
1408 | |
1290 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1409 | $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
1291 | my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
1410 | my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); |
1292 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1411 | my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
1293 | |
1412 | |
1294 | if ($len > 0) { |
1413 | if ($len > 0) { |
1295 | $self->{_activity} = AnyEvent->now; |
1414 | $self->{_activity} = AnyEvent->now; |
1296 | |
1415 | |
1297 | $self->{filter_r} |
1416 | if ($self->{tls}) { |
1298 | ? $self->{filter_r}($self, $rbuf) |
1417 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1299 | : $self->{_in_drain} || $self->_drain_rbuf; |
1418 | |
|
|
1419 | &_dotls ($self); |
|
|
1420 | } else { |
|
|
1421 | $self->_drain_rbuf unless $self->{_in_drain}; |
|
|
1422 | } |
1300 | |
1423 | |
1301 | } elsif (defined $len) { |
1424 | } elsif (defined $len) { |
1302 | delete $self->{_rw}; |
1425 | delete $self->{_rw}; |
1303 | $self->{_eof} = 1; |
1426 | $self->{_eof} = 1; |
1304 | $self->_drain_rbuf unless $self->{_in_drain}; |
1427 | $self->_drain_rbuf unless $self->{_in_drain}; |
… | |
… | |
1308 | } |
1431 | } |
1309 | }); |
1432 | }); |
1310 | } |
1433 | } |
1311 | } |
1434 | } |
1312 | |
1435 | |
|
|
1436 | our $ERROR_SYSCALL; |
|
|
1437 | our $ERROR_WANT_READ; |
|
|
1438 | |
|
|
1439 | sub _tls_error { |
|
|
1440 | my ($self, $err) = @_; |
|
|
1441 | |
|
|
1442 | return $self->_error ($!, 1) |
|
|
1443 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
|
|
1444 | |
|
|
1445 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
|
|
1446 | |
|
|
1447 | # reduce error string to look less scary |
|
|
1448 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
|
|
1449 | |
|
|
1450 | if ($self->{_on_starttls}) { |
|
|
1451 | (delete $self->{_on_starttls})->($self, undef, $err); |
|
|
1452 | &_freetls; |
|
|
1453 | } else { |
|
|
1454 | &_freetls; |
|
|
1455 | $self->_error (&Errno::EPROTO, 1, $err); |
|
|
1456 | } |
|
|
1457 | } |
|
|
1458 | |
|
|
1459 | # poll the write BIO and send the data if applicable |
|
|
1460 | # also decode read data if possible |
|
|
1461 | # this is basiclaly our TLS state machine |
|
|
1462 | # more efficient implementations are possible with openssl, |
|
|
1463 | # but not with the buggy and incomplete Net::SSLeay. |
1313 | sub _dotls { |
1464 | sub _dotls { |
1314 | my ($self) = @_; |
1465 | my ($self) = @_; |
1315 | |
1466 | |
1316 | my $buf; |
1467 | my $tmp; |
1317 | |
1468 | |
1318 | if (length $self->{_tls_wbuf}) { |
1469 | if (length $self->{_tls_wbuf}) { |
1319 | while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1470 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1320 | substr $self->{_tls_wbuf}, 0, $len, ""; |
1471 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1321 | } |
1472 | } |
1322 | } |
|
|
1323 | |
1473 | |
|
|
1474 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
1475 | return $self->_tls_error ($tmp) |
|
|
1476 | if $tmp != $ERROR_WANT_READ |
|
|
1477 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1478 | } |
|
|
1479 | |
1324 | while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { |
1480 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1325 | unless (length $buf) { |
1481 | unless (length $tmp) { |
|
|
1482 | $self->{_on_starttls} |
|
|
1483 | and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ??? |
|
|
1484 | &_freetls; |
|
|
1485 | |
|
|
1486 | if ($self->{on_stoptls}) { |
|
|
1487 | $self->{on_stoptls}($self); |
|
|
1488 | return; |
|
|
1489 | } else { |
1326 | # let's treat SSL-eof as we treat normal EOF |
1490 | # let's treat SSL-eof as we treat normal EOF |
1327 | delete $self->{_rw}; |
1491 | delete $self->{_rw}; |
1328 | $self->{_eof} = 1; |
1492 | $self->{_eof} = 1; |
|
|
1493 | } |
1329 | } |
1494 | } |
1330 | |
1495 | |
1331 | $self->{rbuf} .= $buf; |
1496 | $self->{_tls_rbuf} .= $tmp; |
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
1497 | $self->_drain_rbuf unless $self->{_in_drain}; |
1333 | |
|
|
1334 | $self->{tls} or return; # tls could have gone away |
1498 | $self->{tls} or return; # tls session might have gone away in callback |
1335 | } |
1499 | } |
1336 | |
1500 | |
1337 | my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
1501 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1338 | |
|
|
1339 | if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1340 | if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1341 | return $self->_error ($!, 1); |
1502 | return $self->_tls_error ($tmp) |
1342 | } elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
1503 | if $tmp != $ERROR_WANT_READ |
1343 | return $self->_error (&Errno::EIO, 1); |
1504 | && ($tmp != $ERROR_SYSCALL || $!); |
1344 | } |
|
|
1345 | |
1505 | |
1346 | # all others are fine for our purposes |
|
|
1347 | } |
|
|
1348 | |
|
|
1349 | if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1506 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1350 | $self->{wbuf} .= $buf; |
1507 | $self->{wbuf} .= $tmp; |
1351 | $self->_drain_wbuf; |
1508 | $self->_drain_wbuf; |
1352 | } |
1509 | } |
|
|
1510 | |
|
|
1511 | $self->{_on_starttls} |
|
|
1512 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
|
|
1513 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1353 | } |
1514 | } |
1354 | |
1515 | |
1355 | =item $handle->starttls ($tls[, $tls_ctx]) |
1516 | =item $handle->starttls ($tls[, $tls_ctx]) |
1356 | |
1517 | |
1357 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1518 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
… | |
… | |
1359 | C<starttls>. |
1520 | C<starttls>. |
1360 | |
1521 | |
1361 | The first argument is the same as the C<tls> constructor argument (either |
1522 | The first argument is the same as the C<tls> constructor argument (either |
1362 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1523 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1363 | |
1524 | |
1364 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1525 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1365 | used when AnyEvent::Handle has to create its own TLS connection object. |
1526 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1527 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1528 | construct a new context. |
1366 | |
1529 | |
1367 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1530 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1368 | call and can be used or changed to your liking. Note that the handshake |
1531 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1369 | might have already started when this function returns. |
1532 | changed to your liking. Note that the handshake might have already started |
|
|
1533 | when this function returns. |
1370 | |
1534 | |
|
|
1535 | If it an error to start a TLS handshake more than once per |
|
|
1536 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
|
|
1537 | |
1371 | =cut |
1538 | =cut |
|
|
1539 | |
|
|
1540 | our %TLS_CACHE; #TODO not yet documented, should we? |
1372 | |
1541 | |
1373 | sub starttls { |
1542 | sub starttls { |
1374 | my ($self, $ssl, $ctx) = @_; |
1543 | my ($self, $ssl, $ctx) = @_; |
1375 | |
1544 | |
1376 | $self->stoptls; |
1545 | require Net::SSLeay; |
1377 | |
1546 | |
1378 | if ($ssl eq "accept") { |
1547 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1379 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1548 | if $self->{tls}; |
1380 | Net::SSLeay::set_accept_state ($ssl); |
1549 | |
1381 | } elsif ($ssl eq "connect") { |
1550 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1382 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1551 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1383 | Net::SSLeay::set_connect_state ($ssl); |
1552 | |
|
|
1553 | $ctx ||= $self->{tls_ctx}; |
|
|
1554 | |
|
|
1555 | if ("HASH" eq ref $ctx) { |
|
|
1556 | require AnyEvent::TLS; |
|
|
1557 | |
|
|
1558 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1559 | |
|
|
1560 | if ($ctx->{cache}) { |
|
|
1561 | my $key = $ctx+0; |
|
|
1562 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
|
|
1563 | } else { |
|
|
1564 | $ctx = new AnyEvent::TLS %$ctx; |
|
|
1565 | } |
|
|
1566 | } |
1384 | } |
1567 | |
1385 | |
1568 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1386 | $self->{tls} = $ssl; |
1569 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1387 | |
1570 | |
1388 | # basically, this is deep magic (because SSL_read should have the same issues) |
1571 | # basically, this is deep magic (because SSL_read should have the same issues) |
1389 | # but the openssl maintainers basically said: "trust us, it just works". |
1572 | # but the openssl maintainers basically said: "trust us, it just works". |
1390 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1573 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1391 | # and mismaintained ssleay-module doesn't even offer them). |
1574 | # and mismaintained ssleay-module doesn't even offer them). |
1392 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1575 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
1393 | # |
1576 | # |
1394 | # in short: this is a mess. |
1577 | # in short: this is a mess. |
1395 | # |
1578 | # |
1396 | # note that we do not try to kepe the length constant between writes as we are required to do. |
1579 | # note that we do not try to keep the length constant between writes as we are required to do. |
1397 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1580 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1398 | # and we drive openssl fully in blocking mode here. |
1581 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
|
|
1582 | # have identity issues in that area. |
1399 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1583 | # Net::SSLeay::CTX_set_mode ($ssl, |
1400 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1584 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1401 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1585 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1586 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
1402 | |
1587 | |
1403 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1588 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1404 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1589 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1405 | |
1590 | |
1406 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1591 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1407 | |
1592 | |
1408 | $self->{filter_w} = sub { |
1593 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
1409 | $_[0]{_tls_wbuf} .= ${$_[1]}; |
1594 | if $self->{on_starttls}; |
1410 | &_dotls; |
|
|
1411 | }; |
|
|
1412 | $self->{filter_r} = sub { |
|
|
1413 | Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]}); |
|
|
1414 | &_dotls; |
|
|
1415 | }; |
|
|
1416 | |
1595 | |
1417 | &_dotls; # need to trigger the initial negotiation exchange |
1596 | &_dotls; # need to trigger the initial handshake |
|
|
1597 | $self->start_read; # make sure we actually do read |
1418 | } |
1598 | } |
1419 | |
1599 | |
1420 | =item $handle->stoptls |
1600 | =item $handle->stoptls |
1421 | |
1601 | |
1422 | Destroys the SSL connection, if any. Partial read or write data will be |
1602 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1423 | lost. |
1603 | sending a close notify to the other side, but since OpenSSL doesn't |
|
|
1604 | support non-blocking shut downs, it is not possible to re-use the stream |
|
|
1605 | afterwards. |
1424 | |
1606 | |
1425 | =cut |
1607 | =cut |
1426 | |
1608 | |
1427 | sub stoptls { |
1609 | sub stoptls { |
1428 | my ($self) = @_; |
1610 | my ($self) = @_; |
1429 | |
1611 | |
1430 | Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
1612 | if ($self->{tls}) { |
|
|
1613 | Net::SSLeay::shutdown ($self->{tls}); |
1431 | |
1614 | |
1432 | delete $self->{_rbio}; |
1615 | &_dotls; |
1433 | delete $self->{_wbio}; |
1616 | |
1434 | delete $self->{_tls_wbuf}; |
1617 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1435 | delete $self->{filter_r}; |
1618 | # # we, we... have to use openssl :/#d# |
1436 | delete $self->{filter_w}; |
1619 | # &_freetls;#d# |
|
|
1620 | } |
|
|
1621 | } |
|
|
1622 | |
|
|
1623 | sub _freetls { |
|
|
1624 | my ($self) = @_; |
|
|
1625 | |
|
|
1626 | return unless $self->{tls}; |
|
|
1627 | |
|
|
1628 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
|
|
1629 | |
|
|
1630 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1437 | } |
1631 | } |
1438 | |
1632 | |
1439 | sub DESTROY { |
1633 | sub DESTROY { |
1440 | my $self = shift; |
1634 | my ($self) = @_; |
1441 | |
1635 | |
1442 | $self->stoptls; |
1636 | &_freetls; |
1443 | |
1637 | |
1444 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1638 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1445 | |
1639 | |
1446 | if ($linger && length $self->{wbuf}) { |
1640 | if ($linger && length $self->{wbuf}) { |
1447 | my $fh = delete $self->{fh}; |
1641 | my $fh = delete $self->{fh}; |
… | |
… | |
1462 | @linger = (); |
1656 | @linger = (); |
1463 | }); |
1657 | }); |
1464 | } |
1658 | } |
1465 | } |
1659 | } |
1466 | |
1660 | |
|
|
1661 | =item $handle->destroy |
|
|
1662 | |
|
|
1663 | Shuts down the handle object as much as possible - this call ensures that |
|
|
1664 | no further callbacks will be invoked and as many resources as possible |
|
|
1665 | will be freed. You must not call any methods on the object afterwards. |
|
|
1666 | |
|
|
1667 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1668 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1669 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1670 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1671 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1672 | that case. |
|
|
1673 | |
|
|
1674 | The handle might still linger in the background and write out remaining |
|
|
1675 | data, as specified by the C<linger> option, however. |
|
|
1676 | |
|
|
1677 | =cut |
|
|
1678 | |
|
|
1679 | sub destroy { |
|
|
1680 | my ($self) = @_; |
|
|
1681 | |
|
|
1682 | $self->DESTROY; |
|
|
1683 | %$self = (); |
|
|
1684 | } |
|
|
1685 | |
1467 | =item AnyEvent::Handle::TLS_CTX |
1686 | =item AnyEvent::Handle::TLS_CTX |
1468 | |
1687 | |
1469 | This function creates and returns the Net::SSLeay::CTX object used by |
1688 | This function creates and returns the AnyEvent::TLS object used by default |
1470 | default for TLS mode. |
1689 | for TLS mode. |
1471 | |
1690 | |
1472 | The context is created like this: |
1691 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1473 | |
|
|
1474 | Net::SSLeay::load_error_strings; |
|
|
1475 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1476 | Net::SSLeay::randomize; |
|
|
1477 | |
|
|
1478 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1479 | |
|
|
1480 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1481 | |
1692 | |
1482 | =cut |
1693 | =cut |
1483 | |
1694 | |
1484 | our $TLS_CTX; |
1695 | our $TLS_CTX; |
1485 | |
1696 | |
1486 | sub TLS_CTX() { |
1697 | sub TLS_CTX() { |
1487 | $TLS_CTX || do { |
1698 | $TLS_CTX ||= do { |
1488 | require Net::SSLeay; |
1699 | require AnyEvent::TLS; |
1489 | |
1700 | |
1490 | Net::SSLeay::load_error_strings (); |
1701 | new AnyEvent::TLS |
1491 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1492 | Net::SSLeay::randomize (); |
|
|
1493 | |
|
|
1494 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1495 | |
|
|
1496 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1497 | |
|
|
1498 | $TLS_CTX |
|
|
1499 | } |
1702 | } |
1500 | } |
1703 | } |
1501 | |
1704 | |
1502 | =back |
1705 | =back |
|
|
1706 | |
|
|
1707 | |
|
|
1708 | =head1 NONFREQUENTLY ASKED QUESTIONS |
|
|
1709 | |
|
|
1710 | =over 4 |
|
|
1711 | |
|
|
1712 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1713 | still get further invocations! |
|
|
1714 | |
|
|
1715 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1716 | read or write callbacks. |
|
|
1717 | |
|
|
1718 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1719 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1720 | ->destroy >> method. |
|
|
1721 | |
|
|
1722 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1723 | reading? |
|
|
1724 | |
|
|
1725 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1726 | communication channels, one for each direction. Or put differently. The |
|
|
1727 | read and write directions are not independent of each other: you cannot |
|
|
1728 | write data unless you are also prepared to read, and vice versa. |
|
|
1729 | |
|
|
1730 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1731 | callback invocations when you are not expecting any read data - the reason |
|
|
1732 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1733 | |
|
|
1734 | During the connection, you have to make sure that you always have a |
|
|
1735 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1736 | connection (or when you no longer want to use it) you can call the |
|
|
1737 | C<destroy> method. |
|
|
1738 | |
|
|
1739 | =item How do I read data until the other side closes the connection? |
|
|
1740 | |
|
|
1741 | If you just want to read your data into a perl scalar, the easiest way |
|
|
1742 | to achieve this is by setting an C<on_read> callback that does nothing, |
|
|
1743 | clearing the C<on_eof> callback and in the C<on_error> callback, the data |
|
|
1744 | will be in C<$_[0]{rbuf}>: |
|
|
1745 | |
|
|
1746 | $handle->on_read (sub { }); |
|
|
1747 | $handle->on_eof (undef); |
|
|
1748 | $handle->on_error (sub { |
|
|
1749 | my $data = delete $_[0]{rbuf}; |
|
|
1750 | undef $handle; |
|
|
1751 | }); |
|
|
1752 | |
|
|
1753 | The reason to use C<on_error> is that TCP connections, due to latencies |
|
|
1754 | and packets loss, might get closed quite violently with an error, when in |
|
|
1755 | fact, all data has been received. |
|
|
1756 | |
|
|
1757 | It is usually better to use acknowledgements when transferring data, |
|
|
1758 | to make sure the other side hasn't just died and you got the data |
|
|
1759 | intact. This is also one reason why so many internet protocols have an |
|
|
1760 | explicit QUIT command. |
|
|
1761 | |
|
|
1762 | =item I don't want to destroy the handle too early - how do I wait until |
|
|
1763 | all data has been written? |
|
|
1764 | |
|
|
1765 | After writing your last bits of data, set the C<on_drain> callback |
|
|
1766 | and destroy the handle in there - with the default setting of |
|
|
1767 | C<low_water_mark> this will be called precisely when all data has been |
|
|
1768 | written to the socket: |
|
|
1769 | |
|
|
1770 | $handle->push_write (...); |
|
|
1771 | $handle->on_drain (sub { |
|
|
1772 | warn "all data submitted to the kernel\n"; |
|
|
1773 | undef $handle; |
|
|
1774 | }); |
|
|
1775 | |
|
|
1776 | If you just want to queue some data and then signal EOF to the other side, |
|
|
1777 | consider using C<< ->push_shutdown >> instead. |
|
|
1778 | |
|
|
1779 | =item I want to contact a TLS/SSL server, I don't care about security. |
|
|
1780 | |
|
|
1781 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
|
|
1782 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
|
|
1783 | parameter: |
|
|
1784 | |
|
|
1785 | my $handle = new AnyEvent::Handle |
|
|
1786 | fh => $fh, |
|
|
1787 | tls => "connect", |
|
|
1788 | on_error => sub { ... }; |
|
|
1789 | |
|
|
1790 | $handle->push_write (...); |
|
|
1791 | |
|
|
1792 | =item I want to contact a TLS/SSL server, I do care about security. |
|
|
1793 | |
|
|
1794 | Then you #x##TODO# |
|
|
1795 | |
|
|
1796 | |
|
|
1797 | |
|
|
1798 | =back |
|
|
1799 | |
1503 | |
1800 | |
1504 | =head1 SUBCLASSING AnyEvent::Handle |
1801 | =head1 SUBCLASSING AnyEvent::Handle |
1505 | |
1802 | |
1506 | In many cases, you might want to subclass AnyEvent::Handle. |
1803 | In many cases, you might want to subclass AnyEvent::Handle. |
1507 | |
1804 | |