… | |
… | |
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.351; |
19 | our $VERSION = 4.45; |
20 | |
20 | |
21 | =head1 SYNOPSIS |
21 | =head1 SYNOPSIS |
22 | |
22 | |
23 | use AnyEvent; |
23 | use AnyEvent; |
24 | use AnyEvent::Handle; |
24 | use AnyEvent::Handle; |
… | |
… | |
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 | |
… | |
… | |
237 | |
237 | |
238 | This will not work for partial TLS data that could not be encoded |
238 | This will not work for partial TLS data that could not be encoded |
239 | yet. This data will be lost. Calling the C<stoptls> method in time might |
239 | yet. This data will be lost. Calling the C<stoptls> method in time might |
240 | help. |
240 | help. |
241 | |
241 | |
|
|
242 | =item common_name => $string |
|
|
243 | |
|
|
244 | The common name used by some verification methods (most notably SSL/TLS) |
|
|
245 | associated with this connection. Usually this is the remote hostname used |
|
|
246 | to connect, but can be almost anything. |
|
|
247 | |
242 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
248 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
243 | |
249 | |
244 | When this parameter is given, it enables TLS (SSL) mode, that means |
250 | When this parameter is given, it enables TLS (SSL) mode, that means |
245 | AnyEvent will start a TLS handshake as soon as the conenction has been |
251 | AnyEvent will start a TLS handshake as soon as the conenction has been |
246 | established and will transparently encrypt/decrypt data afterwards. |
252 | established and will transparently encrypt/decrypt data afterwards. |
… | |
… | |
255 | mode. |
261 | mode. |
256 | |
262 | |
257 | You can also provide your own TLS connection object, but you have |
263 | You can also provide your own TLS connection object, but you have |
258 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
264 | to make sure that you call either C<Net::SSLeay::set_connect_state> |
259 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
265 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
260 | AnyEvent::Handle. |
266 | AnyEvent::Handle. Also, this module will take ownership of this connection |
|
|
267 | object. |
|
|
268 | |
|
|
269 | At some future point, AnyEvent::Handle might switch to another TLS |
|
|
270 | implementation, then the option to use your own session object will go |
|
|
271 | away. |
261 | |
272 | |
262 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
273 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
263 | passing in the wrong integer will lead to certain crash. This most often |
274 | passing in the wrong integer will lead to certain crash. This most often |
264 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
275 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
265 | segmentation fault. |
276 | segmentation fault. |
266 | |
277 | |
267 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
278 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
268 | |
279 | |
269 | =item tls_ctx => $ssl_ctx |
280 | =item tls_ctx => $anyevent_tls |
270 | |
281 | |
271 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
282 | 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 |
283 | (unless a connection object was specified directly). If this parameter is |
273 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
284 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
285 | |
|
|
286 | Instead of an object, you can also specify a hash reference with C<< key |
|
|
287 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
|
|
288 | new TLS context object. |
274 | |
289 | |
275 | =item json => JSON or JSON::XS object |
290 | =item json => JSON or JSON::XS object |
276 | |
291 | |
277 | This is the json coder object used by the C<json> read and write types. |
292 | This is the json coder object used by the C<json> read and write types. |
278 | |
293 | |
… | |
… | |
287 | |
302 | |
288 | =cut |
303 | =cut |
289 | |
304 | |
290 | sub new { |
305 | sub new { |
291 | my $class = shift; |
306 | my $class = shift; |
292 | |
|
|
293 | my $self = bless { @_ }, $class; |
307 | my $self = bless { @_ }, $class; |
294 | |
308 | |
295 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
309 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
296 | |
310 | |
297 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
311 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
|
|
312 | |
|
|
313 | $self->{_activity} = AnyEvent->now; |
|
|
314 | $self->_timeout; |
|
|
315 | |
|
|
316 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
298 | |
317 | |
299 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
318 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
300 | if $self->{tls}; |
319 | if $self->{tls}; |
301 | |
320 | |
302 | $self->{_activity} = AnyEvent->now; |
|
|
303 | $self->_timeout; |
|
|
304 | |
|
|
305 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
321 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
306 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
307 | |
322 | |
308 | $self->start_read |
323 | $self->start_read |
309 | if $self->{on_read}; |
324 | if $self->{on_read}; |
310 | |
325 | |
311 | $self |
326 | $self->{fh} && $self |
312 | } |
327 | } |
313 | |
328 | |
314 | sub _shutdown { |
329 | sub _shutdown { |
315 | my ($self) = @_; |
330 | my ($self) = @_; |
316 | |
331 | |
317 | delete $self->{_tw}; |
332 | delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
318 | delete $self->{_rw}; |
333 | $self->{_eof} = 1; # tell starttls et. al to stop trying |
319 | delete $self->{_ww}; |
|
|
320 | delete $self->{fh}; |
|
|
321 | |
334 | |
322 | &_freetls; |
335 | &_freetls; |
323 | |
|
|
324 | delete $self->{on_read}; |
|
|
325 | delete $self->{_queue}; |
|
|
326 | } |
336 | } |
327 | |
337 | |
328 | sub _error { |
338 | sub _error { |
329 | my ($self, $errno, $fatal) = @_; |
339 | my ($self, $errno, $fatal) = @_; |
330 | |
340 | |
… | |
… | |
1384 | C<starttls>. |
1394 | C<starttls>. |
1385 | |
1395 | |
1386 | The first argument is the same as the C<tls> constructor argument (either |
1396 | The first argument is the same as the C<tls> constructor argument (either |
1387 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1397 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1388 | |
1398 | |
1389 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1399 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1390 | used when AnyEvent::Handle has to create its own TLS connection object. |
1400 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1401 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1402 | construct a new context. |
1391 | |
1403 | |
1392 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1404 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1393 | call and can be used or changed to your liking. Note that the handshake |
1405 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1394 | might have already started when this function returns. |
1406 | changed to your liking. Note that the handshake might have already started |
|
|
1407 | when this function returns. |
1395 | |
1408 | |
1396 | If it an error to start a TLS handshake more than once per |
1409 | If it an error to start a TLS handshake more than once per |
1397 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1410 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1398 | |
1411 | |
1399 | =cut |
1412 | =cut |
… | |
… | |
1403 | |
1416 | |
1404 | require Net::SSLeay; |
1417 | require Net::SSLeay; |
1405 | |
1418 | |
1406 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1419 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1407 | if $self->{tls}; |
1420 | if $self->{tls}; |
|
|
1421 | |
|
|
1422 | $ctx ||= $self->{tls_ctx}; |
|
|
1423 | |
|
|
1424 | if ("HASH" eq ref $ctx) { |
|
|
1425 | require AnyEvent::TLS; |
|
|
1426 | |
|
|
1427 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context |
|
|
1428 | $ctx = new AnyEvent::TLS %$ctx; |
|
|
1429 | } |
1408 | |
1430 | |
1409 | if ($ssl eq "accept") { |
1431 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1410 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1432 | $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self); |
1411 | Net::SSLeay::set_accept_state ($ssl); |
|
|
1412 | } elsif ($ssl eq "connect") { |
|
|
1413 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
1414 | Net::SSLeay::set_connect_state ($ssl); |
|
|
1415 | } |
|
|
1416 | |
|
|
1417 | $self->{tls} = $ssl; |
|
|
1418 | |
1433 | |
1419 | # basically, this is deep magic (because SSL_read should have the same issues) |
1434 | # basically, this is deep magic (because SSL_read should have the same issues) |
1420 | # but the openssl maintainers basically said: "trust us, it just works". |
1435 | # but the openssl maintainers basically said: "trust us, it just works". |
1421 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1436 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1422 | # and mismaintained ssleay-module doesn't even offer them). |
1437 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1426 | # |
1441 | # |
1427 | # note that we do not try to keep the length constant between writes as we are required to do. |
1442 | # note that we do not try to keep the length constant between writes as we are required to do. |
1428 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1443 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1429 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1444 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1430 | # have identity issues in that area. |
1445 | # have identity issues in that area. |
1431 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1446 | # Net::SSLeay::CTX_set_mode ($ssl, |
1432 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1447 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1433 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1448 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1449 | Net::SSLeay::CTX_set_mode ($ssl, 1|2); |
1434 | |
1450 | |
1435 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1451 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1436 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1452 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1437 | |
1453 | |
1438 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1454 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
… | |
… | |
1467 | sub _freetls { |
1483 | sub _freetls { |
1468 | my ($self) = @_; |
1484 | my ($self) = @_; |
1469 | |
1485 | |
1470 | return unless $self->{tls}; |
1486 | return unless $self->{tls}; |
1471 | |
1487 | |
1472 | Net::SSLeay::free (delete $self->{tls}); |
1488 | $self->{tls_ctx}->_put_session (delete $self->{tls}); |
1473 | |
1489 | |
1474 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1490 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1475 | } |
1491 | } |
1476 | |
1492 | |
1477 | sub DESTROY { |
1493 | sub DESTROY { |
… | |
… | |
1527 | %$self = (); |
1543 | %$self = (); |
1528 | } |
1544 | } |
1529 | |
1545 | |
1530 | =item AnyEvent::Handle::TLS_CTX |
1546 | =item AnyEvent::Handle::TLS_CTX |
1531 | |
1547 | |
1532 | This function creates and returns the Net::SSLeay::CTX object used by |
1548 | This function creates and returns the AnyEvent::TLS object used by default |
1533 | default for TLS mode. |
1549 | for TLS mode. |
1534 | |
1550 | |
1535 | The context is created like this: |
1551 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1536 | |
|
|
1537 | Net::SSLeay::load_error_strings; |
|
|
1538 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1539 | Net::SSLeay::randomize; |
|
|
1540 | |
|
|
1541 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1542 | |
|
|
1543 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1544 | |
1552 | |
1545 | =cut |
1553 | =cut |
1546 | |
1554 | |
1547 | our $TLS_CTX; |
1555 | our $TLS_CTX; |
1548 | |
1556 | |
1549 | sub TLS_CTX() { |
1557 | sub TLS_CTX() { |
1550 | $TLS_CTX || do { |
1558 | $TLS_CTX ||= do { |
1551 | require Net::SSLeay; |
1559 | require AnyEvent::TLS; |
1552 | |
1560 | |
1553 | Net::SSLeay::load_error_strings (); |
1561 | new AnyEvent::TLS |
1554 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1555 | Net::SSLeay::randomize (); |
|
|
1556 | |
|
|
1557 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1558 | |
|
|
1559 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1560 | |
|
|
1561 | $TLS_CTX |
|
|
1562 | } |
1562 | } |
1563 | } |
1563 | } |
1564 | |
1564 | |
1565 | =back |
1565 | =back |
1566 | |
1566 | |