ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Handle.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC vs.
Revision 1.143 by root, Mon Jul 6 21:02:34 2009 UTC

… …
14 14
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = 4.45; 19our $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;
… …
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
70The constructor supports these arguments (all as key => value pairs). 70The 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
… …
95waiting for data. 95waiting for data.
96 96
97If an EOF condition has been detected but no C<on_eof> callback has been 97If an EOF condition has been detected but no C<on_eof> callback has been
98set, then a fatal error will be raised with C<$!> set to <0>. 98set, 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
102This is the error callback, which is called when, well, some error 102This is the error callback, which is called when, well, some error
103occured, such as not being able to resolve the hostname, failure to 103occured, such as not being able to resolve the hostname, failure to
104connect or a read error. 104connect or a read error.
105 105
… …
107fatal errors the handle object will be shut down and will not be usable 107fatal 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
109errors are an EOF condition with active (but unsatisifable) read watchers 109errors 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
112AnyEvent::Handle tries to find an appropriate error code for you to check
113against, but in some cases (TLS errors), this does not work well. It is
114recommended to always output the C<$message> argument in human-readable
115error messages (it's usually the same as C<"$!">).
116
112Non-fatal errors can be retried by simply returning, but it is recommended 117Non-fatal errors can be retried by simply returning, but it is recommended
113to simply ignore this parameter and instead abondon the handle object 118to simply ignore this parameter and instead abondon the handle object
114when this callback is invoked. Examples of non-fatal errors are timeouts 119when this callback is invoked. Examples of non-fatal errors are timeouts
115C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 120C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116 121
117On callback entrance, the value of C<$!> contains the operating system 122On callback entrance, the value of C<$!> contains the operating system
118error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 123error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124C<EPROTO>).
119 125
120While not mandatory, it is I<highly> recommended to set this callback, as 126While not mandatory, it is I<highly> recommended to set this callback, as
121you will not be notified of errors otherwise. The default simply calls 127you will not be notified of errors otherwise. The default simply calls
122C<croak>. 128C<croak>.
123 129
… …
127and no read request is in the queue (unlike read queue callbacks, this 133and no read request is in the queue (unlike read queue callbacks, this
128callback will only be called when at least one octet of data is in the 134callback will only be called when at least one octet of data is in the
129read buffer). 135read buffer).
130 136
131To access (and remove data from) the read buffer, use the C<< ->rbuf >> 137To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132method or access the C<$handle->{rbuf}> member directly. Note that you 138method or access the C<< $handle->{rbuf} >> member directly. Note that you
133must not enlarge or modify the read buffer, you can only remove data at 139must not enlarge or modify the read buffer, you can only remove data at
134the beginning from it. 140the beginning from it.
135 141
136When an EOF condition is detected then AnyEvent::Handle will first try to 142When an EOF condition is detected then AnyEvent::Handle will first try to
137feed all the remaining data to the queued callbacks and C<on_read> before 143feed all the remaining data to the queued callbacks and C<on_read> before
… …
237 243
238This will not work for partial TLS data that could not be encoded 244This will not work for partial TLS data that could not be encoded
239yet. This data will be lost. Calling the C<stoptls> method in time might 245yet. This data will be lost. Calling the C<stoptls> method in time might
240help. 246help.
241 247
248=item peername => $string
249
250A 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
253Apart from being useful in error messages, this string is also used in TLS
254peername verification (see C<verify_peername> in L<AnyEvent::TLS>).
255
242=item tls => "accept" | "connect" | Net::SSLeay::SSL object 256=item tls => "accept" | "connect" | Net::SSLeay::SSL object
243 257
244When this parameter is given, it enables TLS (SSL) mode, that means 258When this parameter is given, it enables TLS (SSL) mode, that means
245AnyEvent will start a TLS handshake as soon as the conenction has been 259AnyEvent will start a TLS handshake as soon as the conenction has been
246established and will transparently encrypt/decrypt data afterwards. 260established and will transparently encrypt/decrypt data afterwards.
261
262All TLS protocol errors will be signalled as C<EPROTO>, with an
263appropriate error message.
247 264
248TLS mode requires Net::SSLeay to be installed (it will be loaded 265TLS mode requires Net::SSLeay to be installed (it will be loaded
249automatically when you try to create a TLS handle): this module doesn't 266automatically when you try to create a TLS handle): this module doesn't
250have a dependency on that module, so if your module requires it, you have 267have a dependency on that module, so if your module requires it, you have
251to add the dependency yourself. 268to add the dependency yourself.
… …
255mode. 272mode.
256 273
257You can also provide your own TLS connection object, but you have 274You can also provide your own TLS connection object, but you have
258to make sure that you call either C<Net::SSLeay::set_connect_state> 275to make sure that you call either C<Net::SSLeay::set_connect_state>
259or C<Net::SSLeay::set_accept_state> on it before you pass it to 276or C<Net::SSLeay::set_accept_state> on it before you pass it to
260AnyEvent::Handle. 277AnyEvent::Handle. Also, this module will take ownership of this connection
278object.
279
280At some future point, AnyEvent::Handle might switch to another TLS
281implementation, then the option to use your own session object will go
282away.
261 283
262B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 284B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263passing in the wrong integer will lead to certain crash. This most often 285passing in the wrong integer will lead to certain crash. This most often
264happens when one uses a stylish C<< tls => 1 >> and is surprised about the 286happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265segmentation fault. 287segmentation fault.
266 288
267See the C<< ->starttls >> method for when need to start TLS negotiation later. 289See 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
271Use the given C<Net::SSLeay::CTX> object to create the new TLS connection 293Use 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
273missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 295missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
296
297Instead 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
299new TLS context object.
300
301=item on_starttls => $cb->($handle, $success[, $error_message])
302
303This callback will be invoked when the TLS/SSL handshake has finished. If
304C<$success> is true, then the TLS handshake succeeded, otherwise it failed
305(C<on_stoptls> will not be called in this case).
306
307The session in C<< $handle->{tls} >> can still be examined in this
308callback, even when the handshake was not successful.
309
310TLS handshake failures will not cause C<on_error> to be invoked when this
311callback is in effect, instead, the error message will be passed to C<on_starttls>.
312
313Without this callback, handshake failures lead to C<on_error> being
314called, as normal.
315
316Note that you cannot call C<starttls> right again in this callback. If you
317need to do that, start an zero-second timer instead whose callback can
318then call C<< ->starttls >> again.
319
320=item on_stoptls => $cb->($handle)
321
322When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
323set, then it will be invoked after freeing the TLS session. If it is not,
324then a TLS shutdown condition will be treated like a normal EOF condition
325on the handle.
326
327The session in C<< $handle->{tls} >> can still be examined in this
328callback.
329
330This callback will only be called on TLS shutdowns, not when the
331underlying handle signals EOF.
274 332
275=item json => JSON or JSON::XS object 333=item json => JSON or JSON::XS object
276 334
277This is the json coder object used by the C<json> read and write types. 335This is the json coder object used by the C<json> read and write types.
278 336
… …
287 345
288=cut 346=cut
289 347
290sub new { 348sub new {
291 my $class = shift; 349 my $class = shift;
292
293 my $self = bless { @_ }, $class; 350 my $self = bless { @_ }, $class;
294 351
295 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 352 $self->{fh} or Carp::croak "mandatory argument fh is missing";
296 353
297 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 354 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
355
356 $self->{_activity} = AnyEvent->now;
357 $self->_timeout;
358
359 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
298 360
299 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 361 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300 if $self->{tls}; 362 if $self->{tls};
301 363
302 $self->{_activity} = AnyEvent->now;
303 $self->_timeout;
304
305 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; 364 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307 365
308 $self->start_read 366 $self->start_read
309 if $self->{on_read}; 367 if $self->{on_read};
310 368
311 $self 369 $self->{fh} && $self
312} 370}
313 371
314sub _shutdown { 372sub _shutdown {
315 my ($self) = @_; 373 my ($self) = @_;
316 374
317 delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)}; 375 delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
376 $self->{_eof} = 1; # tell starttls et. al to stop trying
318 377
319 &_freetls; 378 &_freetls;
320} 379}
321 380
322sub _error { 381sub _error {
323 my ($self, $errno, $fatal) = @_; 382 my ($self, $errno, $fatal, $message) = @_;
324 383
325 $self->_shutdown 384 $self->_shutdown
326 if $fatal; 385 if $fatal;
327 386
328 $! = $errno; 387 $! = $errno;
388 $message ||= "$!";
329 389
330 if ($self->{on_error}) { 390 if ($self->{on_error}) {
331 $self->{on_error}($self, $fatal); 391 $self->{on_error}($self, $fatal, $message);
332 } elsif ($self->{fh}) { 392 } elsif ($self->{fh}) {
333 Carp::croak "AnyEvent::Handle uncaught error: $!"; 393 Carp::croak "AnyEvent::Handle uncaught error: $message";
334 } 394 }
335} 395}
336 396
337=item $fh = $handle->fh 397=item $fh = $handle->fh
338 398
… …
397 457
398 eval { 458 eval {
399 local $SIG{__DIE__}; 459 local $SIG{__DIE__};
400 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; 460 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
401 }; 461 };
462}
463
464=item $handle->on_starttls ($cb)
465
466Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
467
468=cut
469
470sub on_starttls {
471 $_[0]{on_starttls} = $_[1];
472}
473
474=item $handle->on_stoptls ($cb)
475
476Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
477
478=cut
479
480sub on_starttls {
481 $_[0]{on_stoptls} = $_[1];
402} 482}
403 483
404############################################################################# 484#############################################################################
405 485
406=item $handle->timeout ($seconds) 486=item $handle->timeout ($seconds)
… …
650 730
651 pack "w/a*", Storable::nfreeze ($ref) 731 pack "w/a*", Storable::nfreeze ($ref)
652}; 732};
653 733
654=back 734=back
735
736=item $handle->push_shutdown
737
738Sometimes you know you want to close the socket after writing your data
739before it was actually written. One way to do that is to replace your
740C<on_drain> handler by a callback that shuts down the socket (and set
741C<low_water_mark> to C<0>). This method is a shorthand for just that, and
742replaces the C<on_drain> callback with:
743
744 sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
745
746This simply shuts down the write side and signals an EOF condition to the
747the peer.
748
749You can rely on the normal read queue and C<on_eof> handling
750afterwards. This is the cleanest way to close a connection.
751
752=cut
753
754sub push_shutdown {
755 my ($self) = @_;
756
757 delete $self->{low_water_mark};
758 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
759}
655 760
656=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 761=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
657 762
658This function (not method) lets you add your own types to C<push_write>. 763This function (not method) lets you add your own types to C<push_write>.
659Whenever the given C<type> is used, C<push_write> will invoke the code 764Whenever the given C<type> is used, C<push_write> will invoke the code
… …
807 912
808 if ($self->{_eof}) { 913 if ($self->{_eof}) {
809 if ($self->{on_eof}) { 914 if ($self->{on_eof}) {
810 $self->{on_eof}($self) 915 $self->{on_eof}($self)
811 } else { 916 } else {
812 $self->_error (0, 1); 917 $self->_error (0, 1, "Unexpected end-of-file");
813 } 918 }
814 } 919 }
815 920
816 # may need to restart read watcher 921 # may need to restart read watcher
817 unless ($self->{_rw}) { 922 unless ($self->{_rw}) {
… …
1167=cut 1272=cut
1168 1273
1169register_read_type json => sub { 1274register_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
1177 my $json = $self->{json} ||= JSON->new->utf8;
1178 1283
1179 sub { 1284 sub {
1180 my $ref = eval { $json->incr_parse ($self->{rbuf}) }; 1285 my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181 1286
1182 if ($ref) { 1287 if ($ref) {
… …
1326 } 1431 }
1327 }); 1432 });
1328 } 1433 }
1329} 1434}
1330 1435
1436our $ERROR_SYSCALL;
1437our $ERROR_WANT_READ;
1438
1439sub _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
1331# poll the write BIO and send the data if applicable 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.
1332sub _dotls { 1464sub _dotls {
1333 my ($self) = @_; 1465 my ($self) = @_;
1334 1466
1335 my $tmp; 1467 my $tmp;
1336 1468
1337 if (length $self->{_tls_wbuf}) { 1469 if (length $self->{_tls_wbuf}) {
1338 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1470 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1339 substr $self->{_tls_wbuf}, 0, $tmp, ""; 1471 substr $self->{_tls_wbuf}, 0, $tmp, "";
1340 } 1472 }
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 || $!);
1341 } 1478 }
1342 1479
1343 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { 1480 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1344 unless (length $tmp) { 1481 unless (length $tmp) {
1345 # let's treat SSL-eof as we treat normal EOF 1482 $self->{_on_starttls}
1346 delete $self->{_rw}; 1483 and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1347 $self->{_eof} = 1;
1348 &_freetls; 1484 &_freetls;
1485
1486 if ($self->{on_stoptls}) {
1487 $self->{on_stoptls}($self);
1488 return;
1489 } else {
1490 # let's treat SSL-eof as we treat normal EOF
1491 delete $self->{_rw};
1492 $self->{_eof} = 1;
1493 }
1349 } 1494 }
1350 1495
1351 $self->{_tls_rbuf} .= $tmp; 1496 $self->{_tls_rbuf} .= $tmp;
1352 $self->_drain_rbuf unless $self->{_in_drain}; 1497 $self->_drain_rbuf unless $self->{_in_drain};
1353 $self->{tls} or return; # tls session might have gone away in callback 1498 $self->{tls} or return; # tls session might have gone away in callback
1354 } 1499 }
1355 1500
1356 $tmp = Net::SSLeay::get_error ($self->{tls}, -1); 1501 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1357
1358 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1359 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1360 return $self->_error ($!, 1); 1502 return $self->_tls_error ($tmp)
1361 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { 1503 if $tmp != $ERROR_WANT_READ
1362 return $self->_error (&Errno::EIO, 1); 1504 && ($tmp != $ERROR_SYSCALL || $!);
1363 }
1364
1365 # all other errors are fine for our purposes
1366 }
1367 1505
1368 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1506 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1369 $self->{wbuf} .= $tmp; 1507 $self->{wbuf} .= $tmp;
1370 $self->_drain_wbuf; 1508 $self->_drain_wbuf;
1371 } 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");
1372} 1514}
1373 1515
1374=item $handle->starttls ($tls[, $tls_ctx]) 1516=item $handle->starttls ($tls[, $tls_ctx])
1375 1517
1376Instead of starting TLS negotiation immediately when the AnyEvent::Handle 1518Instead of starting TLS negotiation immediately when the AnyEvent::Handle
… …
1378C<starttls>. 1520C<starttls>.
1379 1521
1380The first argument is the same as the C<tls> constructor argument (either 1522The first argument is the same as the C<tls> constructor argument (either
1381C<"connect">, C<"accept"> or an existing Net::SSLeay object). 1523C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1382 1524
1383The second argument is the optional C<Net::SSLeay::CTX> object that is 1525The second argument is the optional C<AnyEvent::TLS> object that is used
1384used when AnyEvent::Handle has to create its own TLS connection object. 1526when AnyEvent::Handle has to create its own TLS connection object, or
1527a hash reference with C<< key => value >> pairs that will be used to
1528construct a new context.
1385 1529
1386The TLS connection object will end up in C<< $handle->{tls} >> after this 1530The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1387call and can be used or changed to your liking. Note that the handshake 1531context in C<< $handle->{tls_ctx} >> after this call and can be used or
1388might have already started when this function returns. 1532changed to your liking. Note that the handshake might have already started
1533when this function returns.
1389 1534
1390If it an error to start a TLS handshake more than once per 1535If it an error to start a TLS handshake more than once per
1391AnyEvent::Handle object (this is due to bugs in OpenSSL). 1536AnyEvent::Handle object (this is due to bugs in OpenSSL).
1392 1537
1393=cut 1538=cut
1394 1539
1540our %TLS_CACHE; #TODO not yet documented, should we?
1541
1395sub starttls { 1542sub starttls {
1396 my ($self, $ssl, $ctx) = @_; 1543 my ($self, $ssl, $ctx) = @_;
1397 1544
1398 require Net::SSLeay; 1545 require Net::SSLeay;
1399 1546
1400 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" 1547 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1401 if $self->{tls}; 1548 if $self->{tls};
1549
1550 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
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 }
1402 1567
1403 if ($ssl eq "accept") { 1568 $self->{tls_ctx} = $ctx || TLS_CTX ();
1404 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1569 $self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1405 Net::SSLeay::set_accept_state ($ssl);
1406 } elsif ($ssl eq "connect") {
1407 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1408 Net::SSLeay::set_connect_state ($ssl);
1409 }
1410
1411 $self->{tls} = $ssl;
1412 1570
1413 # 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)
1414 # but the openssl maintainers basically said: "trust us, it just works". 1572 # but the openssl maintainers basically said: "trust us, it just works".
1415 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1573 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1416 # and mismaintained ssleay-module doesn't even offer them). 1574 # and mismaintained ssleay-module doesn't even offer them).
… …
1420 # 1578 #
1421 # note that we do not try to keep 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.
1422 # 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,
1423 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to 1581 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1424 # have identity issues in that area. 1582 # have identity issues in that area.
1425 Net::SSLeay::CTX_set_mode ($self->{tls}, 1583# Net::SSLeay::CTX_set_mode ($ssl,
1426 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1584# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1427 | (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);
1428 1587
1429 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1588 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1430 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1589 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1431 1590
1432 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1591 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1592
1593 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1594 if $self->{on_starttls};
1433 1595
1434 &_dotls; # need to trigger the initial handshake 1596 &_dotls; # need to trigger the initial handshake
1435 $self->start_read; # make sure we actually do read 1597 $self->start_read; # make sure we actually do read
1436} 1598}
1437 1599
… …
1450 if ($self->{tls}) { 1612 if ($self->{tls}) {
1451 Net::SSLeay::shutdown ($self->{tls}); 1613 Net::SSLeay::shutdown ($self->{tls});
1452 1614
1453 &_dotls; 1615 &_dotls;
1454 1616
1455 # we don't give a shit. no, we do, but we can't. no... 1617# # we don't give a shit. no, we do, but we can't. no...#d#
1456 # we, we... have to use openssl :/ 1618# # we, we... have to use openssl :/#d#
1457 &_freetls; 1619# &_freetls;#d#
1458 } 1620 }
1459} 1621}
1460 1622
1461sub _freetls { 1623sub _freetls {
1462 my ($self) = @_; 1624 my ($self) = @_;
1463 1625
1464 return unless $self->{tls}; 1626 return unless $self->{tls};
1465 1627
1466 Net::SSLeay::free (delete $self->{tls}); 1628 $self->{tls_ctx}->_put_session (delete $self->{tls});
1467 1629
1468 delete @$self{qw(_rbio _wbio _tls_wbuf)}; 1630 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1469} 1631}
1470 1632
1471sub DESTROY { 1633sub DESTROY {
1472 my ($self) = @_; 1634 my ($self) = @_;
1473 1635
… …
1497} 1659}
1498 1660
1499=item $handle->destroy 1661=item $handle->destroy
1500 1662
1501Shuts down the handle object as much as possible - this call ensures that 1663Shuts down the handle object as much as possible - this call ensures that
1502no further callbacks will be invoked and resources will be freed as much 1664no further callbacks will be invoked and as many resources as possible
1503as possible. You must not call any methods on the object afterwards. 1665will be freed. You must not call any methods on the object afterwards.
1504 1666
1505Normally, you can just "forget" any references to an AnyEvent::Handle 1667Normally, you can just "forget" any references to an AnyEvent::Handle
1506object and it will simply shut down. This works in fatal error and EOF 1668object and it will simply shut down. This works in fatal error and EOF
1507callbacks, as well as code outside. It does I<NOT> work in a read or write 1669callbacks, as well as code outside. It does I<NOT> work in a read or write
1508callback, so when you want to destroy the AnyEvent::Handle object from 1670callback, so when you want to destroy the AnyEvent::Handle object from
… …
1521 %$self = (); 1683 %$self = ();
1522} 1684}
1523 1685
1524=item AnyEvent::Handle::TLS_CTX 1686=item AnyEvent::Handle::TLS_CTX
1525 1687
1526This function creates and returns the Net::SSLeay::CTX object used by 1688This function creates and returns the AnyEvent::TLS object used by default
1527default for TLS mode. 1689for TLS mode.
1528 1690
1529The context is created like this: 1691The context is created by calling L<AnyEvent::TLS> without any arguments.
1530
1531 Net::SSLeay::load_error_strings;
1532 Net::SSLeay::SSLeay_add_ssl_algorithms;
1533 Net::SSLeay::randomize;
1534
1535 my $CTX = Net::SSLeay::CTX_new;
1536
1537 Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1538 1692
1539=cut 1693=cut
1540 1694
1541our $TLS_CTX; 1695our $TLS_CTX;
1542 1696
1543sub TLS_CTX() { 1697sub TLS_CTX() {
1544 $TLS_CTX || do { 1698 $TLS_CTX ||= do {
1545 require Net::SSLeay; 1699 require AnyEvent::TLS;
1546 1700
1547 Net::SSLeay::load_error_strings (); 1701 new AnyEvent::TLS
1548 Net::SSLeay::SSLeay_add_ssl_algorithms ();
1549 Net::SSLeay::randomize ();
1550
1551 $TLS_CTX = Net::SSLeay::CTX_new ();
1552
1553 Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1554
1555 $TLS_CTX
1556 } 1702 }
1557} 1703}
1558 1704
1559=back 1705=back
1560 1706
… …
1625 $handle->on_drain (sub { 1771 $handle->on_drain (sub {
1626 warn "all data submitted to the kernel\n"; 1772 warn "all data submitted to the kernel\n";
1627 undef $handle; 1773 undef $handle;
1628 }); 1774 });
1629 1775
1776If you just want to queue some data and then signal EOF to the other side,
1777consider using C<< ->push_shutdown >> instead.
1778
1779=item I want to contact a TLS/SSL server, I don't care about security.
1780
1781If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1782simply connect to it and then create the AnyEvent::Handle with the C<tls>
1783parameter:
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
1794Then you #x##TODO#
1795
1796
1797
1630=back 1798=back
1631 1799
1632 1800
1633=head1 SUBCLASSING AnyEvent::Handle 1801=head1 SUBCLASSING AnyEvent::Handle
1634 1802

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines