… | |
… | |
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"); |
… | |
… | |
63 | |
63 | |
64 | =head1 METHODS |
64 | =head1 METHODS |
65 | |
65 | |
66 | =over 4 |
66 | =over 4 |
67 | |
67 | |
68 | =item B<new (%args)> |
68 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
69 | |
69 | |
70 | The constructor supports these arguments (all as key => value pairs). |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
71 | |
71 | |
72 | =over 4 |
72 | =over 4 |
73 | |
73 | |
74 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [MANDATORY] |
75 | |
75 | |
… | |
… | |
84 | 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, |
85 | 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 |
86 | connection cleanly. |
86 | connection cleanly. |
87 | |
87 | |
88 | 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, |
89 | 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 |
90 | 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 |
91 | down. |
91 | down. |
92 | |
92 | |
93 | 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, |
94 | 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 |
95 | waiting for data. |
95 | waiting for data. |
96 | |
96 | |
97 | 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 |
98 | 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>. |
99 | |
99 | |
100 | =item on_error => $cb->($handle, $fatal) |
100 | =item on_error => $cb->($handle, $fatal, $message) |
101 | |
101 | |
102 | 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 |
103 | 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 |
104 | connect or a read error. |
104 | connect or a read error. |
105 | |
105 | |
… | |
… | |
107 | 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 |
108 | (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 |
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
110 | (C<EPIPE>) or I/O errors. |
110 | (C<EPIPE>) or I/O errors. |
111 | |
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 | |
112 | 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 |
113 | to simply ignore this parameter and instead abondon the handle object |
118 | to simply ignore this parameter and instead abondon the handle object |
114 | 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 |
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
120 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
116 | |
121 | |
117 | On callback entrance, the value of C<$!> contains the operating system |
122 | On callback entrance, the value of C<$!> contains the operating system |
118 | 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>). |
119 | |
125 | |
120 | 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 |
121 | 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 |
122 | C<croak>. |
128 | C<croak>. |
123 | |
129 | |
… | |
… | |
127 | 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 |
128 | 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 |
129 | read buffer). |
135 | read buffer). |
130 | |
136 | |
131 | 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 >> |
132 | 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. |
133 | |
141 | |
134 | 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 |
135 | 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 |
136 | 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 |
137 | error will be raised (with C<$!> set to C<EPIPE>). |
145 | error will be raised (with C<$!> set to C<EPIPE>). |
… | |
… | |
235 | |
243 | |
236 | 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 |
237 | 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 |
238 | help. |
246 | help. |
239 | |
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 | common name verification (see C<verify_cn> in L<AnyEvent::TLS>). |
|
|
255 | |
240 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
256 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
241 | |
257 | |
242 | 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 |
243 | 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 |
244 | 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. |
245 | |
264 | |
246 | 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 |
247 | 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 |
248 | 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 |
249 | to add the dependency yourself. |
268 | to add the dependency yourself. |
… | |
… | |
253 | mode. |
272 | mode. |
254 | |
273 | |
255 | 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 |
256 | 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> |
257 | 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 |
258 | 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. |
259 | |
288 | |
260 | 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. |
261 | |
290 | |
262 | =item tls_ctx => $ssl_ctx |
291 | =item tls_ctx => $anyevent_tls |
263 | |
292 | |
264 | 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 |
265 | (unless a connection object was specified directly). If this parameter is |
294 | (unless a connection object was specified directly). If this parameter is |
266 | 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. |
267 | |
300 | |
268 | =item json => JSON or JSON::XS object |
301 | =item json => JSON or JSON::XS object |
269 | |
302 | |
270 | This is the json coder object used by the C<json> read and write types. |
303 | This is the json coder object used by the C<json> read and write types. |
271 | |
304 | |
… | |
… | |
280 | |
313 | |
281 | =cut |
314 | =cut |
282 | |
315 | |
283 | sub new { |
316 | sub new { |
284 | my $class = shift; |
317 | my $class = shift; |
285 | |
|
|
286 | my $self = bless { @_ }, $class; |
318 | my $self = bless { @_ }, $class; |
287 | |
319 | |
288 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
320 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
289 | |
321 | |
290 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
322 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
|
|
323 | |
|
|
324 | $self->{_activity} = AnyEvent->now; |
|
|
325 | $self->_timeout; |
|
|
326 | |
|
|
327 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
291 | |
328 | |
292 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
329 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
293 | if $self->{tls}; |
330 | if $self->{tls}; |
294 | |
331 | |
295 | $self->{_activity} = AnyEvent->now; |
|
|
296 | $self->_timeout; |
|
|
297 | |
|
|
298 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
332 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
299 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
300 | |
333 | |
301 | $self->start_read |
334 | $self->start_read |
302 | if $self->{on_read}; |
335 | if $self->{on_read}; |
303 | |
336 | |
304 | $self |
337 | $self->{fh} && $self |
305 | } |
338 | } |
306 | |
339 | |
307 | sub _shutdown { |
340 | sub _shutdown { |
308 | my ($self) = @_; |
341 | my ($self) = @_; |
309 | |
342 | |
310 | delete $self->{_tw}; |
343 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
311 | delete $self->{_rw}; |
344 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
312 | delete $self->{_ww}; |
|
|
313 | delete $self->{fh}; |
|
|
314 | |
345 | |
315 | &_freetls; |
346 | &_freetls; |
316 | |
|
|
317 | delete $self->{on_read}; |
|
|
318 | delete $self->{_queue}; |
|
|
319 | } |
347 | } |
320 | |
348 | |
321 | sub _error { |
349 | sub _error { |
322 | my ($self, $errno, $fatal) = @_; |
350 | my ($self, $errno, $fatal, $message) = @_; |
323 | |
351 | |
324 | $self->_shutdown |
352 | $self->_shutdown |
325 | if $fatal; |
353 | if $fatal; |
326 | |
354 | |
327 | $! = $errno; |
355 | $! = $errno; |
|
|
356 | $message ||= "$!"; |
328 | |
357 | |
329 | if ($self->{on_error}) { |
358 | if ($self->{on_error}) { |
330 | $self->{on_error}($self, $fatal); |
359 | $self->{on_error}($self, $fatal, $message); |
331 | } elsif ($self->{fh}) { |
360 | } elsif ($self->{fh}) { |
332 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
361 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
333 | } |
362 | } |
334 | } |
363 | } |
335 | |
364 | |
336 | =item $fh = $handle->fh |
365 | =item $fh = $handle->fh |
337 | |
366 | |
… | |
… | |
374 | } |
403 | } |
375 | |
404 | |
376 | =item $handle->autocork ($boolean) |
405 | =item $handle->autocork ($boolean) |
377 | |
406 | |
378 | Enables or disables the current autocork behaviour (see C<autocork> |
407 | Enables or disables the current autocork behaviour (see C<autocork> |
379 | constructor argument). |
408 | constructor argument). Changes will only take effect on the next write. |
380 | |
409 | |
381 | =cut |
410 | =cut |
|
|
411 | |
|
|
412 | sub autocork { |
|
|
413 | $_[0]{autocork} = $_[1]; |
|
|
414 | } |
382 | |
415 | |
383 | =item $handle->no_delay ($boolean) |
416 | =item $handle->no_delay ($boolean) |
384 | |
417 | |
385 | Enables or disables the C<no_delay> setting (see constructor argument of |
418 | Enables or disables the C<no_delay> setting (see constructor argument of |
386 | the same name for details). |
419 | the same name for details). |
… | |
… | |
645 | |
678 | |
646 | pack "w/a*", Storable::nfreeze ($ref) |
679 | pack "w/a*", Storable::nfreeze ($ref) |
647 | }; |
680 | }; |
648 | |
681 | |
649 | =back |
682 | =back |
|
|
683 | |
|
|
684 | =item $handle->push_shutdown |
|
|
685 | |
|
|
686 | Sometimes you know you want to close the socket after writing your data |
|
|
687 | before it was actually written. One way to do that is to replace your |
|
|
688 | C<on_drain> handler by a callback that shuts down the socket. This method |
|
|
689 | is a shorthand for just that, and replaces the C<on_drain> callback with: |
|
|
690 | |
|
|
691 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
|
|
692 | |
|
|
693 | This simply shuts down the write side and signals an EOF condition to the |
|
|
694 | the peer. |
|
|
695 | |
|
|
696 | You can rely on the normal read queue and C<on_eof> handling |
|
|
697 | afterwards. This is the cleanest way to close a connection. |
|
|
698 | |
|
|
699 | =cut |
|
|
700 | |
|
|
701 | sub push_shutdown { |
|
|
702 | $_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 }; |
|
|
703 | } |
650 | |
704 | |
651 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
705 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
652 | |
706 | |
653 | This function (not method) lets you add your own types to C<push_write>. |
707 | This function (not method) lets you add your own types to C<push_write>. |
654 | Whenever the given C<type> is used, C<push_write> will invoke the code |
708 | Whenever the given C<type> is used, C<push_write> will invoke the code |
… | |
… | |
758 | ) { |
812 | ) { |
759 | $self->_error (&Errno::ENOSPC, 1), return; |
813 | $self->_error (&Errno::ENOSPC, 1), return; |
760 | } |
814 | } |
761 | |
815 | |
762 | while () { |
816 | while () { |
|
|
817 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
818 | # we are draining the buffer, and this can only happen with TLS. |
|
|
819 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
|
|
820 | |
763 | my $len = length $self->{rbuf}; |
821 | my $len = length $self->{rbuf}; |
764 | |
822 | |
765 | if (my $cb = shift @{ $self->{_queue} }) { |
823 | if (my $cb = shift @{ $self->{_queue} }) { |
766 | unless ($cb->($self)) { |
824 | unless ($cb->($self)) { |
767 | if ($self->{_eof}) { |
825 | if ($self->{_eof}) { |
… | |
… | |
828 | |
886 | |
829 | =item $handle->rbuf |
887 | =item $handle->rbuf |
830 | |
888 | |
831 | Returns the read buffer (as a modifiable lvalue). |
889 | Returns the read buffer (as a modifiable lvalue). |
832 | |
890 | |
833 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
891 | You can access the read buffer directly as the C<< ->{rbuf} >> |
834 | you want. |
892 | member, if you want. However, the only operation allowed on the |
|
|
893 | read buffer (apart from looking at it) is removing data from its |
|
|
894 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
895 | lead to hard-to-track-down bugs. |
835 | |
896 | |
836 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
897 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
837 | C<push_read> or C<unshift_read> methods are used. The other read methods |
898 | C<push_read> or C<unshift_read> methods are used. The other read methods |
838 | automatically manage the read buffer. |
899 | automatically manage the read buffer. |
839 | |
900 | |
… | |
… | |
1135 | } |
1196 | } |
1136 | }; |
1197 | }; |
1137 | |
1198 | |
1138 | =item json => $cb->($handle, $hash_or_arrayref) |
1199 | =item json => $cb->($handle, $hash_or_arrayref) |
1139 | |
1200 | |
1140 | Reads a JSON object or array, decodes it and passes it to the callback. |
1201 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1202 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1141 | |
1203 | |
1142 | If a C<json> object was passed to the constructor, then that will be used |
1204 | If a C<json> object was passed to the constructor, then that will be used |
1143 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1205 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1144 | |
1206 | |
1145 | This read type uses the incremental parser available with JSON version |
1207 | This read type uses the incremental parser available with JSON version |
… | |
… | |
1154 | =cut |
1216 | =cut |
1155 | |
1217 | |
1156 | register_read_type json => sub { |
1218 | register_read_type json => sub { |
1157 | my ($self, $cb) = @_; |
1219 | my ($self, $cb) = @_; |
1158 | |
1220 | |
1159 | require JSON; |
1221 | my $json = $self->{json} ||= |
|
|
1222 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1223 | || do { require JSON; JSON->new->utf8 }; |
1160 | |
1224 | |
1161 | my $data; |
1225 | my $data; |
1162 | my $rbuf = \$self->{rbuf}; |
1226 | my $rbuf = \$self->{rbuf}; |
1163 | |
1227 | |
1164 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1165 | |
|
|
1166 | sub { |
1228 | sub { |
1167 | my $ref = $json->incr_parse ($self->{rbuf}); |
1229 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1168 | |
1230 | |
1169 | if ($ref) { |
1231 | if ($ref) { |
1170 | $self->{rbuf} = $json->incr_text; |
1232 | $self->{rbuf} = $json->incr_text; |
1171 | $json->incr_text = ""; |
1233 | $json->incr_text = ""; |
1172 | $cb->($self, $ref); |
1234 | $cb->($self, $ref); |
1173 | |
1235 | |
1174 | 1 |
1236 | 1 |
|
|
1237 | } elsif ($@) { |
|
|
1238 | # error case |
|
|
1239 | $json->incr_skip; |
|
|
1240 | |
|
|
1241 | $self->{rbuf} = $json->incr_text; |
|
|
1242 | $json->incr_text = ""; |
|
|
1243 | |
|
|
1244 | $self->_error (&Errno::EBADMSG); |
|
|
1245 | |
|
|
1246 | () |
1175 | } else { |
1247 | } else { |
1176 | $self->{rbuf} = ""; |
1248 | $self->{rbuf} = ""; |
|
|
1249 | |
1177 | () |
1250 | () |
1178 | } |
1251 | } |
1179 | } |
1252 | } |
1180 | }; |
1253 | }; |
1181 | |
1254 | |
… | |
… | |
1302 | } |
1375 | } |
1303 | }); |
1376 | }); |
1304 | } |
1377 | } |
1305 | } |
1378 | } |
1306 | |
1379 | |
|
|
1380 | our $ERROR_SYSCALL; |
|
|
1381 | our $ERROR_WANT_READ; |
|
|
1382 | our $ERROR_ZERO_RETURN; |
|
|
1383 | |
|
|
1384 | sub _tls_error { |
|
|
1385 | my ($self, $err) = @_; |
|
|
1386 | |
|
|
1387 | return $self->_error ($!, 1) |
|
|
1388 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
|
|
1389 | |
|
|
1390 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
|
|
1391 | |
|
|
1392 | # reduce error string to look less scary |
|
|
1393 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
|
|
1394 | |
|
|
1395 | $self->_error (&Errno::EPROTO, 1, $err); |
|
|
1396 | } |
|
|
1397 | |
1307 | # poll the write BIO and send the data if applicable |
1398 | # poll the write BIO and send the data if applicable |
|
|
1399 | # also decode read data if possible |
|
|
1400 | # this is basiclaly our TLS state machine |
|
|
1401 | # more efficient implementations are possible with openssl, |
|
|
1402 | # but not with the buggy and incomplete Net::SSLeay. |
1308 | sub _dotls { |
1403 | sub _dotls { |
1309 | my ($self) = @_; |
1404 | my ($self) = @_; |
1310 | |
1405 | |
1311 | my $tmp; |
1406 | my $tmp; |
1312 | |
1407 | |
1313 | if (length $self->{_tls_wbuf}) { |
1408 | if (length $self->{_tls_wbuf}) { |
1314 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1409 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1315 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1410 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1316 | } |
1411 | } |
|
|
1412 | |
|
|
1413 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
1414 | return $self->_tls_error ($tmp) |
|
|
1415 | if $tmp != $ERROR_WANT_READ |
|
|
1416 | && ($tmp != $ERROR_SYSCALL || $!) |
|
|
1417 | && $tmp != $ERROR_ZERO_RETURN; |
1317 | } |
1418 | } |
1318 | |
1419 | |
1319 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1420 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1320 | unless (length $tmp) { |
1421 | unless (length $tmp) { |
1321 | # let's treat SSL-eof as we treat normal EOF |
1422 | # let's treat SSL-eof as we treat normal EOF |
1322 | delete $self->{_rw}; |
1423 | delete $self->{_rw}; |
1323 | $self->{_eof} = 1; |
1424 | $self->{_eof} = 1; |
1324 | &_freetls; |
1425 | &_freetls; |
1325 | } |
1426 | } |
1326 | |
1427 | |
1327 | $self->{rbuf} .= $tmp; |
1428 | $self->{_tls_rbuf} .= $tmp; |
1328 | $self->_drain_rbuf unless $self->{_in_drain}; |
1429 | $self->_drain_rbuf unless $self->{_in_drain}; |
1329 | $self->{tls} or return; # tls session might have gone away in callback |
1430 | $self->{tls} or return; # tls session might have gone away in callback |
1330 | } |
1431 | } |
1331 | |
1432 | |
1332 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1433 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1333 | |
|
|
1334 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1335 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1336 | return $self->_error ($!, 1); |
1434 | return $self->_tls_error ($tmp) |
1337 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1435 | if $tmp != $ERROR_WANT_READ |
1338 | return $self->_error (&Errno::EIO, 1); |
1436 | && ($tmp != $ERROR_SYSCALL || $!) |
1339 | } |
1437 | && $tmp != $ERROR_ZERO_RETURN; |
1340 | |
|
|
1341 | # all other errors are fine for our purposes |
|
|
1342 | } |
|
|
1343 | |
1438 | |
1344 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1439 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1345 | $self->{wbuf} .= $tmp; |
1440 | $self->{wbuf} .= $tmp; |
1346 | $self->_drain_wbuf; |
1441 | $self->_drain_wbuf; |
1347 | } |
1442 | } |
… | |
… | |
1354 | C<starttls>. |
1449 | C<starttls>. |
1355 | |
1450 | |
1356 | The first argument is the same as the C<tls> constructor argument (either |
1451 | The first argument is the same as the C<tls> constructor argument (either |
1357 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1452 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1358 | |
1453 | |
1359 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1454 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1360 | used when AnyEvent::Handle has to create its own TLS connection object. |
1455 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1456 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1457 | construct a new context. |
1361 | |
1458 | |
1362 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1459 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1363 | call and can be used or changed to your liking. Note that the handshake |
1460 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1364 | might have already started when this function returns. |
1461 | changed to your liking. Note that the handshake might have already started |
|
|
1462 | when this function returns. |
1365 | |
1463 | |
1366 | If it an error to start a TLS handshake more than once per |
1464 | If it an error to start a TLS handshake more than once per |
1367 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1465 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1368 | |
1466 | |
1369 | =cut |
1467 | =cut |
1370 | |
1468 | |
|
|
1469 | our %TLS_CACHE; #TODO not yet documented, should we? |
|
|
1470 | |
1371 | sub starttls { |
1471 | sub starttls { |
1372 | my ($self, $ssl, $ctx) = @_; |
1472 | my ($self, $ssl, $ctx) = @_; |
1373 | |
1473 | |
1374 | require Net::SSLeay; |
1474 | require Net::SSLeay; |
1375 | |
1475 | |
1376 | Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object" |
1476 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1377 | if $self->{tls}; |
1477 | if $self->{tls}; |
|
|
1478 | |
|
|
1479 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
|
|
1480 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
|
|
1481 | $ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN (); |
|
|
1482 | |
|
|
1483 | $ctx ||= $self->{tls_ctx}; |
|
|
1484 | |
|
|
1485 | if ("HASH" eq ref $ctx) { |
|
|
1486 | require AnyEvent::TLS; |
|
|
1487 | |
|
|
1488 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1489 | |
|
|
1490 | if ($ctx->{cache}) { |
|
|
1491 | my $key = $ctx+0; |
|
|
1492 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
|
|
1493 | } else { |
|
|
1494 | $ctx = new AnyEvent::TLS %$ctx; |
|
|
1495 | } |
|
|
1496 | } |
1378 | |
1497 | |
1379 | if ($ssl eq "accept") { |
1498 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1380 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1499 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername}); |
1381 | Net::SSLeay::set_accept_state ($ssl); |
|
|
1382 | } elsif ($ssl eq "connect") { |
|
|
1383 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
1384 | Net::SSLeay::set_connect_state ($ssl); |
|
|
1385 | } |
|
|
1386 | |
|
|
1387 | $self->{tls} = $ssl; |
|
|
1388 | |
1500 | |
1389 | # basically, this is deep magic (because SSL_read should have the same issues) |
1501 | # basically, this is deep magic (because SSL_read should have the same issues) |
1390 | # but the openssl maintainers basically said: "trust us, it just works". |
1502 | # but the openssl maintainers basically said: "trust us, it just works". |
1391 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1503 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1392 | # and mismaintained ssleay-module doesn't even offer them). |
1504 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1396 | # |
1508 | # |
1397 | # note that we do not try to keep the length constant between writes as we are required to do. |
1509 | # note that we do not try to keep the length constant between writes as we are required to do. |
1398 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1510 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1399 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1511 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1400 | # have identity issues in that area. |
1512 | # have identity issues in that area. |
1401 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1513 | # Net::SSLeay::CTX_set_mode ($ssl, |
1402 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1514 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1403 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1515 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1516 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
1404 | |
1517 | |
1405 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1518 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1406 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1519 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1407 | |
1520 | |
1408 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1521 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
… | |
… | |
1437 | sub _freetls { |
1550 | sub _freetls { |
1438 | my ($self) = @_; |
1551 | my ($self) = @_; |
1439 | |
1552 | |
1440 | return unless $self->{tls}; |
1553 | return unless $self->{tls}; |
1441 | |
1554 | |
1442 | Net::SSLeay::free (delete $self->{tls}); |
1555 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
1443 | |
1556 | |
1444 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1557 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1445 | } |
1558 | } |
1446 | |
1559 | |
1447 | sub DESTROY { |
1560 | sub DESTROY { |
1448 | my $self = shift; |
1561 | my ($self) = @_; |
1449 | |
1562 | |
1450 | &_freetls; |
1563 | &_freetls; |
1451 | |
1564 | |
1452 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1565 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1453 | |
1566 | |
… | |
… | |
1472 | } |
1585 | } |
1473 | } |
1586 | } |
1474 | |
1587 | |
1475 | =item $handle->destroy |
1588 | =item $handle->destroy |
1476 | |
1589 | |
1477 | Shut's down the handle object as much as possible - this call ensures that |
1590 | Shuts down the handle object as much as possible - this call ensures that |
1478 | no further callbacks will be invoked and resources will be freed as much |
1591 | no further callbacks will be invoked and resources will be freed as much |
1479 | as possible. You must not call any methods on the object afterwards. |
1592 | as possible. You must not call any methods on the object afterwards. |
1480 | |
1593 | |
|
|
1594 | Normally, you can just "forget" any references to an AnyEvent::Handle |
|
|
1595 | object and it will simply shut down. This works in fatal error and EOF |
|
|
1596 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
|
|
1597 | callback, so when you want to destroy the AnyEvent::Handle object from |
|
|
1598 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
|
|
1599 | that case. |
|
|
1600 | |
1481 | The handle might still linger in the background and write out remaining |
1601 | The handle might still linger in the background and write out remaining |
1482 | data, as specified by the C<linger> option, however. |
1602 | data, as specified by the C<linger> option, however. |
1483 | |
1603 | |
1484 | =cut |
1604 | =cut |
1485 | |
1605 | |
… | |
… | |
1490 | %$self = (); |
1610 | %$self = (); |
1491 | } |
1611 | } |
1492 | |
1612 | |
1493 | =item AnyEvent::Handle::TLS_CTX |
1613 | =item AnyEvent::Handle::TLS_CTX |
1494 | |
1614 | |
1495 | This function creates and returns the Net::SSLeay::CTX object used by |
1615 | This function creates and returns the AnyEvent::TLS object used by default |
1496 | default for TLS mode. |
1616 | for TLS mode. |
1497 | |
1617 | |
1498 | The context is created like this: |
1618 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1499 | |
|
|
1500 | Net::SSLeay::load_error_strings; |
|
|
1501 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1502 | Net::SSLeay::randomize; |
|
|
1503 | |
|
|
1504 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1505 | |
|
|
1506 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1507 | |
1619 | |
1508 | =cut |
1620 | =cut |
1509 | |
1621 | |
1510 | our $TLS_CTX; |
1622 | our $TLS_CTX; |
1511 | |
1623 | |
1512 | sub TLS_CTX() { |
1624 | sub TLS_CTX() { |
1513 | $TLS_CTX || do { |
1625 | $TLS_CTX ||= do { |
1514 | require Net::SSLeay; |
1626 | require AnyEvent::TLS; |
1515 | |
1627 | |
1516 | Net::SSLeay::load_error_strings (); |
1628 | new AnyEvent::TLS |
1517 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1518 | Net::SSLeay::randomize (); |
|
|
1519 | |
|
|
1520 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1521 | |
|
|
1522 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1523 | |
|
|
1524 | $TLS_CTX |
|
|
1525 | } |
1629 | } |
1526 | } |
1630 | } |
1527 | |
1631 | |
1528 | =back |
1632 | =back |
1529 | |
1633 | |
1530 | |
1634 | |
1531 | =head1 NONFREQUENTLY ASKED QUESTIONS |
1635 | =head1 NONFREQUENTLY ASKED QUESTIONS |
1532 | |
1636 | |
1533 | =over 4 |
1637 | =over 4 |
|
|
1638 | |
|
|
1639 | =item I C<undef> the AnyEvent::Handle reference inside my callback and |
|
|
1640 | still get further invocations! |
|
|
1641 | |
|
|
1642 | That's because AnyEvent::Handle keeps a reference to itself when handling |
|
|
1643 | read or write callbacks. |
|
|
1644 | |
|
|
1645 | It is only safe to "forget" the reference inside EOF or error callbacks, |
|
|
1646 | from within all other callbacks, you need to explicitly call the C<< |
|
|
1647 | ->destroy >> method. |
|
|
1648 | |
|
|
1649 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1650 | reading? |
|
|
1651 | |
|
|
1652 | Unlike, say, TCP, TLS connections do not consist of two independent |
|
|
1653 | communication channels, one for each direction. Or put differently. The |
|
|
1654 | read and write directions are not independent of each other: you cannot |
|
|
1655 | write data unless you are also prepared to read, and vice versa. |
|
|
1656 | |
|
|
1657 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1658 | callback invocations when you are not expecting any read data - the reason |
|
|
1659 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1660 | |
|
|
1661 | During the connection, you have to make sure that you always have a |
|
|
1662 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1663 | connection (or when you no longer want to use it) you can call the |
|
|
1664 | C<destroy> method. |
1534 | |
1665 | |
1535 | =item How do I read data until the other side closes the connection? |
1666 | =item How do I read data until the other side closes the connection? |
1536 | |
1667 | |
1537 | If you just want to read your data into a perl scalar, the easiest way |
1668 | If you just want to read your data into a perl scalar, the easiest way |
1538 | to achieve this is by setting an C<on_read> callback that does nothing, |
1669 | to achieve this is by setting an C<on_read> callback that does nothing, |
… | |
… | |
1548 | |
1679 | |
1549 | The reason to use C<on_error> is that TCP connections, due to latencies |
1680 | The reason to use C<on_error> is that TCP connections, due to latencies |
1550 | and packets loss, might get closed quite violently with an error, when in |
1681 | and packets loss, might get closed quite violently with an error, when in |
1551 | fact, all data has been received. |
1682 | fact, all data has been received. |
1552 | |
1683 | |
1553 | It is usually better to use acknowledgements when transfering data, |
1684 | It is usually better to use acknowledgements when transferring data, |
1554 | to make sure the other side hasn't just died and you got the data |
1685 | to make sure the other side hasn't just died and you got the data |
1555 | intact. This is also one reason why so many internet protocols have an |
1686 | intact. This is also one reason why so many internet protocols have an |
1556 | explicit QUIT command. |
1687 | explicit QUIT command. |
1557 | |
|
|
1558 | |
1688 | |
1559 | =item I don't want to destroy the handle too early - how do I wait until |
1689 | =item I don't want to destroy the handle too early - how do I wait until |
1560 | all data has been written? |
1690 | all data has been written? |
1561 | |
1691 | |
1562 | After writing your last bits of data, set the C<on_drain> callback |
1692 | After writing your last bits of data, set the C<on_drain> callback |
… | |
… | |
1568 | $handle->on_drain (sub { |
1698 | $handle->on_drain (sub { |
1569 | warn "all data submitted to the kernel\n"; |
1699 | warn "all data submitted to the kernel\n"; |
1570 | undef $handle; |
1700 | undef $handle; |
1571 | }); |
1701 | }); |
1572 | |
1702 | |
1573 | =item I get different callback invocations in TLS mode/Why can't I pause |
|
|
1574 | reading? |
|
|
1575 | |
|
|
1576 | Unlike, say, TCP, TLS conenctions do not consist of two independent |
|
|
1577 | communication channels, one for each direction. Or put differently. the |
|
|
1578 | read and write directions are not independent of each other: you cannot |
|
|
1579 | write data unless you are also prepared to read, and vice versa. |
|
|
1580 | |
|
|
1581 | This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> |
|
|
1582 | callback invocations when you are not expecting any read data - the reason |
|
|
1583 | is that AnyEvent::Handle always reads in TLS mode. |
|
|
1584 | |
|
|
1585 | During the connection, you have to make sure that you always have a |
|
|
1586 | non-empty read-queue, or an C<on_read> watcher. At the end of the |
|
|
1587 | connection (or when you no longer want to use it) you can call the |
|
|
1588 | C<destroy> method. |
|
|
1589 | |
|
|
1590 | =back |
1703 | =back |
1591 | |
1704 | |
1592 | |
1705 | |
1593 | =head1 SUBCLASSING AnyEvent::Handle |
1706 | =head1 SUBCLASSING AnyEvent::Handle |
1594 | |
1707 | |