… | |
… | |
30 | |
30 | |
31 | $cv->recv; |
31 | $cv->recv; |
32 | |
32 | |
33 | =head1 DESCRIPTION |
33 | =head1 DESCRIPTION |
34 | |
34 | |
35 | This is a helper module to make it easier to do event-based I/O on |
35 | This is a helper module to make it easier to do event-based I/O |
36 | stream-based filehandles (sockets, pipes, and other stream things). |
36 | on stream-based filehandles (sockets, pipes, and other stream |
|
|
37 | things). Specifically, it doesn't work as expected on files, packet-based |
|
|
38 | sockets or similar things. |
37 | |
39 | |
38 | The L<AnyEvent::Intro> tutorial contains some well-documented |
40 | The L<AnyEvent::Intro> tutorial contains some well-documented |
39 | AnyEvent::Handle examples. |
41 | AnyEvent::Handle examples. |
40 | |
42 | |
41 | In the following, where the documentation refers to "bytes", it means |
43 | In the following, where the documentation refers to "bytes", it means |
… | |
… | |
53 | package AnyEvent::Handle; |
55 | package AnyEvent::Handle; |
54 | |
56 | |
55 | use Scalar::Util (); |
57 | use Scalar::Util (); |
56 | use List::Util (); |
58 | use List::Util (); |
57 | use Carp (); |
59 | use Carp (); |
58 | use Errno qw(EAGAIN EINTR); |
60 | use Errno qw(EAGAIN EWOULDBLOCK EINTR); |
59 | |
61 | |
60 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
62 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
61 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
63 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
62 | |
64 | |
63 | our $VERSION = $AnyEvent::VERSION; |
65 | our $VERSION = $AnyEvent::VERSION; |
… | |
… | |
91 | |
93 | |
92 | =item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
94 | =item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
93 | |
95 | |
94 | The filehandle this L<AnyEvent::Handle> object will operate on. |
96 | The filehandle this L<AnyEvent::Handle> object will operate on. |
95 | NOTE: The filehandle will be set to non-blocking mode (using |
97 | NOTE: The filehandle will be set to non-blocking mode (using |
96 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
98 | C<AnyEvent::fh_unblock>) by the constructor and needs to stay in |
97 | that mode. |
99 | that mode. |
98 | |
100 | |
99 | =item connect => [$host, $service] [C<fh> or C<connect> MANDATORY] |
101 | =item connect => [$host, $service] [C<fh> or C<connect> MANDATORY] |
100 | |
102 | |
101 | Try to connect to the specified host and service (port), using |
103 | Try to connect to the specified host and service (port), using |
… | |
… | |
131 | |
133 | |
132 | The peer's numeric host and port (the socket peername) are passed as |
134 | The peer's numeric host and port (the socket peername) are passed as |
133 | parameters, together with a retry callback. At the time it is called the |
135 | parameters, together with a retry callback. At the time it is called the |
134 | read and write queues, EOF status, TLS status and similar properties of |
136 | read and write queues, EOF status, TLS status and similar properties of |
135 | the handle will have been reset. |
137 | the handle will have been reset. |
136 | |
|
|
137 | It is not allowed to use the read or write queues while the handle object |
|
|
138 | is connecting. |
|
|
139 | |
138 | |
140 | If, for some reason, the handle is not acceptable, calling C<$retry> will |
139 | If, for some reason, the handle is not acceptable, calling C<$retry> will |
141 | continue with the next connection target (in case of multi-homed hosts or |
140 | continue with the next connection target (in case of multi-homed hosts or |
142 | SRV records there can be multiple connection endpoints). The C<$retry> |
141 | SRV records there can be multiple connection endpoints). The C<$retry> |
143 | callback can be invoked after the connect callback returns, i.e. one can |
142 | callback can be invoked after the connect callback returns, i.e. one can |
… | |
… | |
496 | callback. |
495 | callback. |
497 | |
496 | |
498 | This callback will only be called on TLS shutdowns, not when the |
497 | This callback will only be called on TLS shutdowns, not when the |
499 | underlying handle signals EOF. |
498 | underlying handle signals EOF. |
500 | |
499 | |
501 | =item json => JSON or JSON::XS object |
500 | =item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object |
502 | |
501 | |
503 | This is the json coder object used by the C<json> read and write types. |
502 | This is the json coder object used by the C<json> read and write types. |
504 | |
503 | |
505 | If you don't supply it, then AnyEvent::Handle will create and use a |
504 | If you don't supply it, then AnyEvent::Handle will create and use a |
506 | suitable one (on demand), which will write and expect UTF-8 encoded JSON |
505 | suitable one (on demand), which will write and expect UTF-8 encoded |
|
|
506 | JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are |
|
|
507 | guaranteed not to contain any newline character. |
|
|
508 | |
|
|
509 | For security reasons, this encoder will likely I<not> handle numbers and |
|
|
510 | strings, only arrays and objects/hashes. The reason is that originally |
|
|
511 | JSON was self-delimited, but Dougles Crockford thought it was a splendid |
|
|
512 | idea to redefine JSON incompatibly, so this is no longer true. |
|
|
513 | |
|
|
514 | For protocols that used back-to-back JSON texts, this might lead to |
|
|
515 | run-ins, where two or more JSON texts will be interpreted as one JSON |
507 | texts. |
516 | text. |
508 | |
517 | |
|
|
518 | For this reason, if the default encoder uses L<JSON::XS>, it will default |
|
|
519 | to not allowing anything but arrays and objects/hashes, at least for the |
|
|
520 | forseeable future (it will change at some point). This might or might not |
|
|
521 | be true for the L<JSON> module, so this might cause a security issue. |
|
|
522 | |
|
|
523 | If you depend on either behaviour, you should create your own json object |
|
|
524 | and pass it in explicitly. |
|
|
525 | |
|
|
526 | =item cbor => L<CBOR::XS> object |
|
|
527 | |
|
|
528 | This is the cbor coder object used by the C<cbor> read and write types. |
|
|
529 | |
|
|
530 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
531 | suitable one (on demand), which will write CBOR without using extensions, |
|
|
532 | if possible. |
|
|
533 | |
509 | Note that you are responsible to depend on the JSON module if you want to |
534 | Note that you are responsible to depend on the L<CBOR::XS> module if you |
510 | use this functionality, as AnyEvent does not have a dependency itself. |
535 | want to use this functionality, as AnyEvent does not have a dependency on |
|
|
536 | it itself. |
511 | |
537 | |
512 | =back |
538 | =back |
513 | |
539 | |
514 | =cut |
540 | =cut |
515 | |
541 | |
… | |
… | |
587 | # with AnyEvent::Handle, do them a favour. |
613 | # with AnyEvent::Handle, do them a favour. |
588 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
614 | my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE (); |
589 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
615 | Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!" |
590 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
616 | if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type; |
591 | |
617 | |
592 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
618 | AnyEvent::fh_unblock $self->{fh}; |
593 | |
619 | |
594 | $self->{_activity} = |
620 | $self->{_activity} = |
595 | $self->{_ractivity} = |
621 | $self->{_ractivity} = |
596 | $self->{_wactivity} = AE::now; |
622 | $self->{_wactivity} = AE::now; |
597 | |
623 | |
… | |
… | |
729 | $_[0]{oobinline} = $_[1]; |
755 | $_[0]{oobinline} = $_[1]; |
730 | |
756 | |
731 | eval { |
757 | eval { |
732 | local $SIG{__DIE__}; |
758 | local $SIG{__DIE__}; |
733 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
759 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1] |
734 | if $_[0]{fh}; |
|
|
735 | }; |
|
|
736 | } |
|
|
737 | |
|
|
738 | =item $handle->keepalive ($boolean) |
|
|
739 | |
|
|
740 | Enables or disables the C<keepalive> setting (see constructor argument of |
|
|
741 | the same name for details). |
|
|
742 | |
|
|
743 | =cut |
|
|
744 | |
|
|
745 | sub keepalive { |
|
|
746 | $_[0]{keepalive} = $_[1]; |
|
|
747 | |
|
|
748 | eval { |
|
|
749 | local $SIG{__DIE__}; |
|
|
750 | setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1] |
|
|
751 | if $_[0]{fh}; |
760 | if $_[0]{fh}; |
752 | }; |
761 | }; |
753 | } |
762 | } |
754 | |
763 | |
755 | =item $handle->on_starttls ($cb) |
764 | =item $handle->on_starttls ($cb) |
… | |
… | |
947 | $self->{on_drain}($self) |
956 | $self->{on_drain}($self) |
948 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
957 | if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) |
949 | && $self->{on_drain}; |
958 | && $self->{on_drain}; |
950 | |
959 | |
951 | delete $self->{_ww} unless length $self->{wbuf}; |
960 | delete $self->{_ww} unless length $self->{wbuf}; |
952 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
961 | } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) { |
953 | $self->_error ($!, 1); |
962 | $self->_error ($!, 1); |
954 | } |
963 | } |
955 | }; |
964 | }; |
956 | |
965 | |
957 | # try to write data immediately |
966 | # try to write data immediately |
… | |
… | |
1045 | |
1054 | |
1046 | Encodes the given hash or array reference into a JSON object. Unless you |
1055 | Encodes the given hash or array reference into a JSON object. Unless you |
1047 | provide your own JSON object, this means it will be encoded to JSON text |
1056 | provide your own JSON object, this means it will be encoded to JSON text |
1048 | in UTF-8. |
1057 | in UTF-8. |
1049 | |
1058 | |
|
|
1059 | The default encoder might or might not handle every type of JSON value - |
|
|
1060 | it might be limited to arrays and objects for security reasons. See the |
|
|
1061 | C<json> constructor attribute for more details. |
|
|
1062 | |
1050 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
1063 | JSON objects (and arrays) are self-delimiting, so if you only use arrays |
1051 | one end of a handle and read them at the other end without using any |
1064 | and hashes, you can write JSON at one end of a handle and read them at the |
1052 | additional framing. |
1065 | other end without using any additional framing. |
1053 | |
1066 | |
1054 | The generated JSON text is guaranteed not to contain any newlines: While |
1067 | The JSON text generated by the default encoder is guaranteed not to |
1055 | this module doesn't need delimiters after or between JSON texts to be |
1068 | contain any newlines: While this module doesn't need delimiters after or |
1056 | able to read them, many other languages depend on that. |
1069 | between JSON texts to be able to read them, many other languages depend on |
|
|
1070 | them. |
1057 | |
1071 | |
1058 | A simple RPC protocol that interoperates easily with others is to send |
1072 | A simple RPC protocol that interoperates easily with other languages is |
1059 | JSON arrays (or objects, although arrays are usually the better choice as |
1073 | to send JSON arrays (or objects, although arrays are usually the better |
1060 | they mimic how function argument passing works) and a newline after each |
1074 | choice as they mimic how function argument passing works) and a newline |
1061 | JSON text: |
1075 | after each JSON text: |
1062 | |
1076 | |
1063 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1077 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1064 | $handle->push_write ("\012"); |
1078 | $handle->push_write ("\012"); |
1065 | |
1079 | |
1066 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
1080 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
… | |
… | |
1069 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1083 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1070 | |
1084 | |
1071 | Other languages could read single lines terminated by a newline and pass |
1085 | Other languages could read single lines terminated by a newline and pass |
1072 | this line into their JSON decoder of choice. |
1086 | this line into their JSON decoder of choice. |
1073 | |
1087 | |
|
|
1088 | =item cbor => $perl_scalar |
|
|
1089 | |
|
|
1090 | Encodes the given scalar into a CBOR value. Unless you provide your own |
|
|
1091 | L<CBOR::XS> object, this means it will be encoded to a CBOR string not |
|
|
1092 | using any extensions, if possible. |
|
|
1093 | |
|
|
1094 | CBOR values are self-delimiting, so you can write CBOR at one end of |
|
|
1095 | a handle and read them at the other end without using any additional |
|
|
1096 | framing. |
|
|
1097 | |
|
|
1098 | A simple nd very very fast RPC protocol that interoperates with |
|
|
1099 | other languages is to send CBOR and receive CBOR values (arrays are |
|
|
1100 | recommended): |
|
|
1101 | |
|
|
1102 | $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever |
|
|
1103 | |
|
|
1104 | An AnyEvent::Handle receiver would simply use the C<cbor> read type: |
|
|
1105 | |
|
|
1106 | $handle->push_read (cbor => sub { my $array = $_[1]; ... }); |
|
|
1107 | |
1074 | =cut |
1108 | =cut |
1075 | |
1109 | |
1076 | sub json_coder() { |
1110 | sub json_coder() { |
1077 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1111 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1078 | || do { require JSON; JSON->new->utf8 } |
1112 | || do { require JSON::PP; JSON::PP->new->utf8 } |
1079 | } |
1113 | } |
1080 | |
1114 | |
1081 | register_write_type json => sub { |
1115 | register_write_type json => sub { |
1082 | my ($self, $ref) = @_; |
1116 | my ($self, $ref) = @_; |
1083 | |
1117 | |
1084 | my $json = $self->{json} ||= json_coder; |
1118 | ($self->{json} ||= json_coder) |
1085 | |
|
|
1086 | $json->encode ($ref) |
1119 | ->encode ($ref) |
|
|
1120 | }; |
|
|
1121 | |
|
|
1122 | sub cbor_coder() { |
|
|
1123 | require CBOR::XS; |
|
|
1124 | CBOR::XS->new |
|
|
1125 | } |
|
|
1126 | |
|
|
1127 | register_write_type cbor => sub { |
|
|
1128 | my ($self, $scalar) = @_; |
|
|
1129 | |
|
|
1130 | ($self->{cbor} ||= cbor_coder) |
|
|
1131 | ->encode ($scalar) |
1087 | }; |
1132 | }; |
1088 | |
1133 | |
1089 | =item storable => $reference |
1134 | =item storable => $reference |
1090 | |
1135 | |
1091 | Freezes the given reference using L<Storable> and writes it to the |
1136 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
1485 | |
1530 | |
1486 | register_read_type line => sub { |
1531 | register_read_type line => sub { |
1487 | my ($self, $cb, $eol) = @_; |
1532 | my ($self, $cb, $eol) = @_; |
1488 | |
1533 | |
1489 | if (@_ < 3) { |
1534 | if (@_ < 3) { |
1490 | # this is more than twice as fast as the generic code below |
1535 | # this is faster then the generic code below |
1491 | sub { |
1536 | sub { |
1492 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1537 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1538 | or return; |
1493 | |
1539 | |
|
|
1540 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
1494 | $cb->($_[0], "$1", "$2"); |
1541 | $cb->($_[0], $str, "$1"); |
1495 | 1 |
1542 | 1 |
1496 | } |
1543 | } |
1497 | } else { |
1544 | } else { |
1498 | $eol = quotemeta $eol unless ref $eol; |
1545 | $eol = quotemeta $eol unless ref $eol; |
1499 | $eol = qr|^(.*?)($eol)|s; |
1546 | $eol = qr|^(.*?)($eol)|s; |
… | |
… | |
1508 | }; |
1555 | }; |
1509 | |
1556 | |
1510 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
1557 | =item regex => $accept[, $reject[, $skip], $cb->($handle, $data) |
1511 | |
1558 | |
1512 | Makes a regex match against the regex object C<$accept> and returns |
1559 | Makes a regex match against the regex object C<$accept> and returns |
1513 | everything up to and including the match. |
1560 | everything up to and including the match. All the usual regex variables |
|
|
1561 | ($1, %+ etc.) from the regex match are available in the callback. |
1514 | |
1562 | |
1515 | Example: read a single line terminated by '\n'. |
1563 | Example: read a single line terminated by '\n'. |
1516 | |
1564 | |
1517 | $handle->push_read (regex => qr<\n>, sub { ... }); |
1565 | $handle->push_read (regex => qr<\n>, sub { ... }); |
1518 | |
1566 | |
… | |
… | |
1662 | =item json => $cb->($handle, $hash_or_arrayref) |
1710 | =item json => $cb->($handle, $hash_or_arrayref) |
1663 | |
1711 | |
1664 | Reads a JSON object or array, decodes it and passes it to the |
1712 | Reads a JSON object or array, decodes it and passes it to the |
1665 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1713 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1666 | |
1714 | |
1667 | If a C<json> object was passed to the constructor, then that will be used |
1715 | If a C<json> object was passed to the constructor, then that will be |
1668 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1716 | used for the final decode, otherwise it will create a L<JSON::XS> or |
|
|
1717 | L<JSON::PP> coder object expecting UTF-8. |
1669 | |
1718 | |
1670 | This read type uses the incremental parser available with JSON version |
1719 | This read type uses the incremental parser available with JSON version |
1671 | 2.09 (and JSON::XS version 2.2) and above. You have to provide a |
1720 | 2.09 (and JSON::XS version 2.2) and above. |
1672 | dependency on your own: this module will load the JSON module, but |
|
|
1673 | AnyEvent does not depend on it itself. |
|
|
1674 | |
1721 | |
1675 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1722 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1676 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1723 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1677 | the C<json> write type description, above, for an actual example. |
1724 | the C<json> write type description, above, for an actual example. |
1678 | |
1725 | |
… | |
… | |
1682 | my ($self, $cb) = @_; |
1729 | my ($self, $cb) = @_; |
1683 | |
1730 | |
1684 | my $json = $self->{json} ||= json_coder; |
1731 | my $json = $self->{json} ||= json_coder; |
1685 | |
1732 | |
1686 | my $data; |
1733 | my $data; |
1687 | my $rbuf = \$self->{rbuf}; |
|
|
1688 | |
1734 | |
1689 | sub { |
1735 | sub { |
1690 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1736 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1691 | |
1737 | |
1692 | if ($ref) { |
1738 | if ($ref) { |
… | |
… | |
1706 | |
1752 | |
1707 | () |
1753 | () |
1708 | } else { |
1754 | } else { |
1709 | $_[0]{rbuf} = ""; |
1755 | $_[0]{rbuf} = ""; |
1710 | |
1756 | |
|
|
1757 | () |
|
|
1758 | } |
|
|
1759 | } |
|
|
1760 | }; |
|
|
1761 | |
|
|
1762 | =item cbor => $cb->($handle, $scalar) |
|
|
1763 | |
|
|
1764 | Reads a CBOR value, decodes it and passes it to the callback. When a parse |
|
|
1765 | error occurs, an C<EBADMSG> error will be raised. |
|
|
1766 | |
|
|
1767 | If a L<CBOR::XS> object was passed to the constructor, then that will be |
|
|
1768 | used for the final decode, otherwise it will create a CBOR coder without |
|
|
1769 | enabling any options. |
|
|
1770 | |
|
|
1771 | You have to provide a dependency to L<CBOR::XS> on your own: this module |
|
|
1772 | will load the L<CBOR::XS> module, but AnyEvent does not depend on it |
|
|
1773 | itself. |
|
|
1774 | |
|
|
1775 | Since CBOR values are fully self-delimiting, the C<cbor> read and write |
|
|
1776 | types are an ideal simple RPC protocol: just exchange CBOR datagrams. See |
|
|
1777 | the C<cbor> write type description, above, for an actual example. |
|
|
1778 | |
|
|
1779 | =cut |
|
|
1780 | |
|
|
1781 | register_read_type cbor => sub { |
|
|
1782 | my ($self, $cb) = @_; |
|
|
1783 | |
|
|
1784 | my $cbor = $self->{cbor} ||= cbor_coder; |
|
|
1785 | |
|
|
1786 | my $data; |
|
|
1787 | |
|
|
1788 | sub { |
|
|
1789 | my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) }; |
|
|
1790 | |
|
|
1791 | if (@value) { |
|
|
1792 | $cb->($_[0], @value); |
|
|
1793 | |
|
|
1794 | 1 |
|
|
1795 | } elsif ($@) { |
|
|
1796 | # error case |
|
|
1797 | $cbor->incr_reset; |
|
|
1798 | |
|
|
1799 | $_[0]->_error (Errno::EBADMSG); |
|
|
1800 | |
|
|
1801 | () |
|
|
1802 | } else { |
1711 | () |
1803 | () |
1712 | } |
1804 | } |
1713 | } |
1805 | } |
1714 | }; |
1806 | }; |
1715 | |
1807 | |
… | |
… | |
1764 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
1856 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
1765 | SSL2-compatible framing is supported). |
1857 | SSL2-compatible framing is supported). |
1766 | |
1858 | |
1767 | If it detects that the input data is likely TLS, it calls the callback |
1859 | If it detects that the input data is likely TLS, it calls the callback |
1768 | with a true value for C<$detect> and the (on-wire) TLS version as second |
1860 | with a true value for C<$detect> and the (on-wire) TLS version as second |
1769 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
1861 | and third argument (C<$major> is C<3>, and C<$minor> is 0..4 for SSL |
1770 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
1862 | 3.0, TLS 1.0, 1.1, 1.2 and 1.3, respectively). If it detects the input |
1771 | be definitely not TLS, it calls the callback with a false value for |
1863 | to be definitely not TLS, it calls the callback with a false value for |
1772 | C<$detect>. |
1864 | C<$detect>. |
1773 | |
1865 | |
1774 | The callback could use this information to decide whether or not to start |
1866 | The callback could use this information to decide whether or not to start |
1775 | TLS negotiation. |
1867 | TLS negotiation. |
1776 | |
1868 | |
… | |
… | |
1786 | accomodate protocol changes. |
1878 | accomodate protocol changes. |
1787 | |
1879 | |
1788 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
1880 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
1789 | L<Net::SSLeay>). |
1881 | L<Net::SSLeay>). |
1790 | |
1882 | |
1791 | =item tls_autostart => $tls[, $tls_ctx] |
1883 | =item tls_autostart => [$tls_ctx, ]$tls |
1792 | |
1884 | |
1793 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
1885 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
1794 | to start tls by calling C<starttls> with the given arguments. |
1886 | to start tls by calling C<starttls> with the given arguments. |
1795 | |
1887 | |
1796 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
1888 | In practice, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
1797 | been configured to accept, as servers do not normally send a handshake on |
1889 | been configured to accept, as servers do not normally send a handshake on |
1798 | their own and ths cannot be detected in this way. |
1890 | their own and ths cannot be detected in this way. |
1799 | |
1891 | |
1800 | See C<tls_detect> above for more details. |
1892 | See C<tls_detect> above for more details. |
1801 | |
1893 | |
1802 | Example: give the client a chance to start TLS before accepting a text |
1894 | Example: give the client a chance to start TLS before accepting a text |
1803 | line. |
1895 | line. |
1804 | |
1896 | |
1805 | $hdl->push_read (tls_detect => "accept"); |
1897 | $hdl->push_read (tls_autostart => "accept"); |
1806 | $hdl->push_read (line => sub { |
1898 | $hdl->push_read (line => sub { |
1807 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
1899 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
1808 | }); |
1900 | }); |
1809 | |
1901 | |
1810 | =cut |
1902 | =cut |
… | |
… | |
1822 | ) { |
1914 | ) { |
1823 | return if 3 != length $1; # partial match, can't decide yet |
1915 | return if 3 != length $1; # partial match, can't decide yet |
1824 | |
1916 | |
1825 | # full match, valid TLS record |
1917 | # full match, valid TLS record |
1826 | my ($major, $minor) = unpack "CC", $1; |
1918 | my ($major, $minor) = unpack "CC", $1; |
1827 | $cb->($self, "accept", $major + $minor * 0.1); |
1919 | $cb->($self, "accept", $major, $minor); |
1828 | } else { |
1920 | } else { |
1829 | # mismatch == guaranteed not TLS |
1921 | # mismatch == guaranteed not TLS |
1830 | $cb->($self, undef); |
1922 | $cb->($self, undef); |
1831 | } |
1923 | } |
1832 | |
1924 | |
… | |
… | |
1932 | } elsif (defined $len) { |
2024 | } elsif (defined $len) { |
1933 | delete $self->{_rw}; |
2025 | delete $self->{_rw}; |
1934 | $self->{_eof} = 1; |
2026 | $self->{_eof} = 1; |
1935 | $self->_drain_rbuf; |
2027 | $self->_drain_rbuf; |
1936 | |
2028 | |
1937 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
2029 | } elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) { |
1938 | return $self->_error ($!, 1); |
2030 | return $self->_error ($!, 1); |
1939 | } |
2031 | } |
1940 | }; |
2032 | }; |
1941 | } |
2033 | } |
1942 | } |
2034 | } |
… | |
… | |
1964 | } |
2056 | } |
1965 | } |
2057 | } |
1966 | |
2058 | |
1967 | # poll the write BIO and send the data if applicable |
2059 | # poll the write BIO and send the data if applicable |
1968 | # also decode read data if possible |
2060 | # also decode read data if possible |
1969 | # this is basiclaly our TLS state machine |
2061 | # this is basically our TLS state machine |
1970 | # more efficient implementations are possible with openssl, |
2062 | # more efficient implementations are possible with openssl, |
1971 | # but not with the buggy and incomplete Net::SSLeay. |
2063 | # but not with the buggy and incomplete Net::SSLeay. |
1972 | sub _dotls { |
2064 | sub _dotls { |
1973 | my ($self) = @_; |
2065 | my ($self) = @_; |
1974 | |
2066 | |
1975 | my $tmp; |
2067 | my $tmp; |
1976 | |
2068 | |
1977 | if (length $self->{_tls_wbuf}) { |
2069 | while (length $self->{_tls_wbuf}) { |
1978 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
2070 | if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) { |
1979 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
2071 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
2072 | |
|
|
2073 | return $self->_tls_error ($tmp) |
|
|
2074 | if $tmp != $ERROR_WANT_READ |
|
|
2075 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
2076 | |
|
|
2077 | last; |
1980 | } |
2078 | } |
1981 | |
2079 | |
1982 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
2080 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1983 | return $self->_tls_error ($tmp) |
|
|
1984 | if $tmp != $ERROR_WANT_READ |
|
|
1985 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1986 | } |
2081 | } |
1987 | |
2082 | |
1988 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
2083 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1989 | unless (length $tmp) { |
2084 | unless (length $tmp) { |
1990 | $self->{_on_starttls} |
2085 | $self->{_on_starttls} |
… | |
… | |
2004 | $self->{_tls_rbuf} .= $tmp; |
2099 | $self->{_tls_rbuf} .= $tmp; |
2005 | $self->_drain_rbuf; |
2100 | $self->_drain_rbuf; |
2006 | $self->{tls} or return; # tls session might have gone away in callback |
2101 | $self->{tls} or return; # tls session might have gone away in callback |
2007 | } |
2102 | } |
2008 | |
2103 | |
2009 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
2104 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us |
2010 | return $self->_tls_error ($tmp) |
2105 | return $self->_tls_error ($tmp) |
2011 | if $tmp != $ERROR_WANT_READ |
2106 | if $tmp != $ERROR_WANT_READ |
2012 | && ($tmp != $ERROR_SYSCALL || $!); |
2107 | && ($tmp != $ERROR_SYSCALL || $!); |
2013 | |
2108 | |
2014 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
2109 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
… | |
… | |
2098 | $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); |
2193 | $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); |
2099 | |
2194 | |
2100 | # basically, this is deep magic (because SSL_read should have the same issues) |
2195 | # basically, this is deep magic (because SSL_read should have the same issues) |
2101 | # but the openssl maintainers basically said: "trust us, it just works". |
2196 | # but the openssl maintainers basically said: "trust us, it just works". |
2102 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
2197 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
2103 | # and mismaintained ssleay-module doesn't even offer them). |
2198 | # and mismaintained ssleay-module didn't offer them for a decade or so). |
2104 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
2199 | # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html |
2105 | # |
2200 | # |
2106 | # in short: this is a mess. |
2201 | # in short: this is a mess. |
2107 | # |
2202 | # |
2108 | # note that we do not try to keep the length constant between writes as we are required to do. |
2203 | # note that we do not try to keep the length constant between writes as we are required to do. |
2109 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
2204 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
2110 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
2205 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
2111 | # have identity issues in that area. |
2206 | # have identity issues in that area. |
2112 | # Net::SSLeay::CTX_set_mode ($ssl, |
2207 | # Net::SSLeay::set_mode ($ssl, |
2113 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
2208 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
2114 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
2209 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
2115 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
2210 | Net::SSLeay::set_mode ($tls, 1|2); |
2116 | |
2211 | |
2117 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2212 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2118 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2213 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
2119 | |
2214 | |
2120 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
2215 | Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf}); |
… | |
… | |
2160 | |
2255 | |
2161 | return unless $self->{tls}; |
2256 | return unless $self->{tls}; |
2162 | |
2257 | |
2163 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2258 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
2164 | if $self->{tls} > 0; |
2259 | if $self->{tls} > 0; |
2165 | |
2260 | |
2166 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2261 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
2167 | } |
2262 | } |
2168 | |
2263 | |
2169 | =item $handle->resettls |
2264 | =item $handle->resettls |
2170 | |
2265 | |
… | |
… | |
2195 | push @linger, AE::io $fh, 1, sub { |
2290 | push @linger, AE::io $fh, 1, sub { |
2196 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2291 | my $len = syswrite $fh, $wbuf, length $wbuf; |
2197 | |
2292 | |
2198 | if ($len > 0) { |
2293 | if ($len > 0) { |
2199 | substr $wbuf, 0, $len, ""; |
2294 | substr $wbuf, 0, $len, ""; |
2200 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) { |
2295 | } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) { |
2201 | @linger = (); # end |
2296 | @linger = (); # end |
2202 | } |
2297 | } |
2203 | }; |
2298 | }; |
2204 | push @linger, AE::timer $linger, 0, sub { |
2299 | push @linger, AE::timer $linger, 0, sub { |
2205 | @linger = (); |
2300 | @linger = (); |