| … | |
… | |
| 11 | |
11 | |
| 12 | my $hdl; $hdl = new AnyEvent::Handle |
12 | my $hdl; $hdl = new AnyEvent::Handle |
| 13 | fh => \*STDIN, |
13 | fh => \*STDIN, |
| 14 | on_error => sub { |
14 | on_error => sub { |
| 15 | my ($hdl, $fatal, $msg) = @_; |
15 | my ($hdl, $fatal, $msg) = @_; |
| 16 | AE::log error => "got error $msg\n"; |
16 | AE::log error => $msg; |
| 17 | $hdl->destroy; |
17 | $hdl->destroy; |
| 18 | $cv->send; |
18 | $cv->send; |
| 19 | }; |
19 | }; |
| 20 | |
20 | |
| 21 | # send some request line |
21 | # send some request line |
| … | |
… | |
| 170 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
170 | with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In |
| 171 | cases where the other side can close the connection at will, it is |
171 | cases where the other side can close the connection at will, it is |
| 172 | often easiest to not report C<EPIPE> errors in this callback. |
172 | often easiest to not report C<EPIPE> errors in this callback. |
| 173 | |
173 | |
| 174 | AnyEvent::Handle tries to find an appropriate error code for you to check |
174 | AnyEvent::Handle tries to find an appropriate error code for you to check |
| 175 | against, but in some cases (TLS errors), this does not work well. It is |
175 | against, but in some cases (TLS errors), this does not work well. |
| 176 | recommended to always output the C<$message> argument in human-readable |
176 | |
| 177 | error messages (it's usually the same as C<"$!">). |
177 | If you report the error to the user, it is recommended to always output |
|
|
178 | the C<$message> argument in human-readable error messages (you don't need |
|
|
179 | to report C<"$!"> if you report C<$message>). |
|
|
180 | |
|
|
181 | If you want to react programmatically to the error, then looking at C<$!> |
|
|
182 | and comparing it against some of the documented C<Errno> values is usually |
|
|
183 | better than looking at the C<$message>. |
| 178 | |
184 | |
| 179 | Non-fatal errors can be retried by returning, but it is recommended |
185 | Non-fatal errors can be retried by returning, but it is recommended |
| 180 | to simply ignore this parameter and instead abondon the handle object |
186 | to simply ignore this parameter and instead abondon the handle object |
| 181 | when this callback is invoked. Examples of non-fatal errors are timeouts |
187 | when this callback is invoked. Examples of non-fatal errors are timeouts |
| 182 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
188 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
| … | |
… | |
| 423 | appropriate error message. |
429 | appropriate error message. |
| 424 | |
430 | |
| 425 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
431 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
| 426 | automatically when you try to create a TLS handle): this module doesn't |
432 | automatically when you try to create a TLS handle): this module doesn't |
| 427 | have a dependency on that module, so if your module requires it, you have |
433 | have a dependency on that module, so if your module requires it, you have |
| 428 | to add the dependency yourself. |
434 | to add the dependency yourself. If Net::SSLeay cannot be loaded or is too |
|
|
435 | old, you get an C<EPROTO> error. |
| 429 | |
436 | |
| 430 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
437 | Unlike TCP, TLS has a server and client side: for the TLS server side, use |
| 431 | C<accept>, and for the TLS client side of a connection, use C<connect> |
438 | C<accept>, and for the TLS client side of a connection, use C<connect> |
| 432 | mode. |
439 | mode. |
| 433 | |
440 | |
| … | |
… | |
| 1478 | |
1485 | |
| 1479 | register_read_type line => sub { |
1486 | register_read_type line => sub { |
| 1480 | my ($self, $cb, $eol) = @_; |
1487 | my ($self, $cb, $eol) = @_; |
| 1481 | |
1488 | |
| 1482 | if (@_ < 3) { |
1489 | if (@_ < 3) { |
| 1483 | # this is more than twice as fast as the generic code below |
1490 | # this is faster then the generic code below |
| 1484 | sub { |
1491 | sub { |
| 1485 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1492 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1493 | or return; |
| 1486 | |
1494 | |
|
|
1495 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
| 1487 | $cb->($_[0], "$1", "$2"); |
1496 | $cb->($_[0], $str, "$1"); |
| 1488 | 1 |
1497 | 1 |
| 1489 | } |
1498 | } |
| 1490 | } else { |
1499 | } else { |
| 1491 | $eol = quotemeta $eol unless ref $eol; |
1500 | $eol = quotemeta $eol unless ref $eol; |
| 1492 | $eol = qr|^(.*?)($eol)|s; |
1501 | $eol = qr|^(.*?)($eol)|s; |
| … | |
… | |
| 1730 | |
1739 | |
| 1731 | # bypass unshift if we already have the remaining chunk |
1740 | # bypass unshift if we already have the remaining chunk |
| 1732 | if ($format + $len <= length $_[0]{rbuf}) { |
1741 | if ($format + $len <= length $_[0]{rbuf}) { |
| 1733 | my $data = substr $_[0]{rbuf}, $format, $len; |
1742 | my $data = substr $_[0]{rbuf}, $format, $len; |
| 1734 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1743 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1744 | |
| 1735 | $cb->($_[0], Storable::thaw ($data)); |
1745 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1746 | or return $_[0]->_error (Errno::EBADMSG); |
| 1736 | } else { |
1747 | } else { |
| 1737 | # remove prefix |
1748 | # remove prefix |
| 1738 | substr $_[0]{rbuf}, 0, $format, ""; |
1749 | substr $_[0]{rbuf}, 0, $format, ""; |
| 1739 | |
1750 | |
| 1740 | # read remaining chunk |
1751 | # read remaining chunk |
| 1741 | $_[0]->unshift_read (chunk => $len, sub { |
1752 | $_[0]->unshift_read (chunk => $len, sub { |
| 1742 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1753 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
| 1743 | $cb->($_[0], $ref); |
|
|
| 1744 | } else { |
|
|
| 1745 | $_[0]->_error (Errno::EBADMSG); |
1754 | or $_[0]->_error (Errno::EBADMSG); |
| 1746 | } |
|
|
| 1747 | }); |
1755 | }); |
| 1748 | } |
1756 | } |
| 1749 | |
1757 | |
| 1750 | 1 |
1758 | 1 |
| 1751 | } |
1759 | } |
|
|
1760 | }; |
|
|
1761 | |
|
|
1762 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1763 | |
|
|
1764 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1765 | record without consuming anything. Only SSL version 3 or higher |
|
|
1766 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1767 | SSL2-compatible framing is supported). |
|
|
1768 | |
|
|
1769 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1770 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1771 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1772 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1773 | be definitely not TLS, it calls the callback with a false value for |
|
|
1774 | C<$detect>. |
|
|
1775 | |
|
|
1776 | The callback could use this information to decide whether or not to start |
|
|
1777 | TLS negotiation. |
|
|
1778 | |
|
|
1779 | In all cases the data read so far is passed to the following read |
|
|
1780 | handlers. |
|
|
1781 | |
|
|
1782 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1783 | |
|
|
1784 | If you want to design a protocol that works in the presence of TLS |
|
|
1785 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1786 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1787 | read type does are a bit more strict, but might losen in the future to |
|
|
1788 | accomodate protocol changes. |
|
|
1789 | |
|
|
1790 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1791 | L<Net::SSLeay>). |
|
|
1792 | |
|
|
1793 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1794 | |
|
|
1795 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1796 | to start tls by calling C<starttls> with the given arguments. |
|
|
1797 | |
|
|
1798 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1799 | been configured to accept, as servers do not normally send a handshake on |
|
|
1800 | their own and ths cannot be detected in this way. |
|
|
1801 | |
|
|
1802 | See C<tls_detect> above for more details. |
|
|
1803 | |
|
|
1804 | Example: give the client a chance to start TLS before accepting a text |
|
|
1805 | line. |
|
|
1806 | |
|
|
1807 | $hdl->push_read (tls_detect => "accept"); |
|
|
1808 | $hdl->push_read (line => sub { |
|
|
1809 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1810 | }); |
|
|
1811 | |
|
|
1812 | =cut |
|
|
1813 | |
|
|
1814 | register_read_type tls_detect => sub { |
|
|
1815 | my ($self, $cb) = @_; |
|
|
1816 | |
|
|
1817 | sub { |
|
|
1818 | # this regex matches a full or partial tls record |
|
|
1819 | if ( |
|
|
1820 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1821 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1822 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1823 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1824 | ) { |
|
|
1825 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1826 | |
|
|
1827 | # full match, valid TLS record |
|
|
1828 | my ($major, $minor) = unpack "CC", $1; |
|
|
1829 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1830 | } else { |
|
|
1831 | # mismatch == guaranteed not TLS |
|
|
1832 | $cb->($self, undef); |
|
|
1833 | } |
|
|
1834 | |
|
|
1835 | 1 |
|
|
1836 | } |
|
|
1837 | }; |
|
|
1838 | |
|
|
1839 | register_read_type tls_autostart => sub { |
|
|
1840 | my ($self, @tls) = @_; |
|
|
1841 | |
|
|
1842 | $RH{tls_detect}($self, sub { |
|
|
1843 | return unless $_[1]; |
|
|
1844 | $_[0]->starttls (@tls); |
|
|
1845 | }) |
| 1752 | }; |
1846 | }; |
| 1753 | |
1847 | |
| 1754 | =back |
1848 | =back |
| 1755 | |
1849 | |
| 1756 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1850 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
| … | |
… | |
| 1856 | my ($self, $err) = @_; |
1950 | my ($self, $err) = @_; |
| 1857 | |
1951 | |
| 1858 | return $self->_error ($!, 1) |
1952 | return $self->_error ($!, 1) |
| 1859 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1953 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
| 1860 | |
1954 | |
| 1861 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1955 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
| 1862 | |
1956 | |
| 1863 | # reduce error string to look less scary |
1957 | # reduce error string to look less scary |
| 1864 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1958 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
| 1865 | |
1959 | |
| 1866 | if ($self->{_on_starttls}) { |
1960 | if ($self->{_on_starttls}) { |
| … | |
… | |
| 1932 | |
2026 | |
| 1933 | =item $handle->starttls ($tls[, $tls_ctx]) |
2027 | =item $handle->starttls ($tls[, $tls_ctx]) |
| 1934 | |
2028 | |
| 1935 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2029 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
| 1936 | object is created, you can also do that at a later time by calling |
2030 | object is created, you can also do that at a later time by calling |
| 1937 | C<starttls>. |
2031 | C<starttls>. See the C<tls> constructor argument for general info. |
| 1938 | |
2032 | |
| 1939 | Starting TLS is currently an asynchronous operation - when you push some |
2033 | Starting TLS is currently an asynchronous operation - when you push some |
| 1940 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2034 | write data and then call C<< ->starttls >> then TLS negotiation will start |
| 1941 | immediately, after which the queued write data is then sent. |
2035 | immediately, after which the queued write data is then sent. This might |
|
|
2036 | change in future versions, so best make sure you have no outstanding write |
|
|
2037 | data when calling this method. |
| 1942 | |
2038 | |
| 1943 | The first argument is the same as the C<tls> constructor argument (either |
2039 | The first argument is the same as the C<tls> constructor argument (either |
| 1944 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2040 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
| 1945 | |
2041 | |
| 1946 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2042 | The second argument is the optional C<AnyEvent::TLS> object that is used |
| … | |
… | |
| 1968 | my ($self, $tls, $ctx) = @_; |
2064 | my ($self, $tls, $ctx) = @_; |
| 1969 | |
2065 | |
| 1970 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2066 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
| 1971 | if $self->{tls}; |
2067 | if $self->{tls}; |
| 1972 | |
2068 | |
|
|
2069 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2070 | eval { |
|
|
2071 | require Net::SSLeay; |
|
|
2072 | require AnyEvent::TLS; |
|
|
2073 | 1 |
|
|
2074 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2075 | } |
|
|
2076 | |
| 1973 | $self->{tls} = $tls; |
2077 | $self->{tls} = $tls; |
| 1974 | $self->{tls_ctx} = $ctx if @_ > 2; |
2078 | $self->{tls_ctx} = $ctx if @_ > 2; |
| 1975 | |
2079 | |
| 1976 | return unless $self->{fh}; |
2080 | return unless $self->{fh}; |
| 1977 | |
2081 | |
| 1978 | require Net::SSLeay; |
|
|
| 1979 | |
|
|
| 1980 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2082 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
| 1981 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2083 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
| 1982 | |
2084 | |
| 1983 | $tls = delete $self->{tls}; |
2085 | $tls = delete $self->{tls}; |
| 1984 | $ctx = $self->{tls_ctx}; |
2086 | $ctx = $self->{tls_ctx}; |
| 1985 | |
2087 | |
| 1986 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2088 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
| 1987 | |
2089 | |
| 1988 | if ("HASH" eq ref $ctx) { |
2090 | if ("HASH" eq ref $ctx) { |
| 1989 | require AnyEvent::TLS; |
|
|
| 1990 | |
|
|
| 1991 | if ($ctx->{cache}) { |
2091 | if ($ctx->{cache}) { |
| 1992 | my $key = $ctx+0; |
2092 | my $key = $ctx+0; |
| 1993 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2093 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
| 1994 | } else { |
2094 | } else { |
| 1995 | $ctx = new AnyEvent::TLS %$ctx; |
2095 | $ctx = new AnyEvent::TLS %$ctx; |
| … | |
… | |
| 2228 | handles requests until the server gets some QUIT command, causing it to |
2328 | handles requests until the server gets some QUIT command, causing it to |
| 2229 | close the connection first (highly desirable for a busy TCP server). A |
2329 | close the connection first (highly desirable for a busy TCP server). A |
| 2230 | client dropping the connection is an error, which means this variant can |
2330 | client dropping the connection is an error, which means this variant can |
| 2231 | detect an unexpected detection close. |
2331 | detect an unexpected detection close. |
| 2232 | |
2332 | |
| 2233 | To handle this case, always make sure you have a on-empty read queue, by |
2333 | To handle this case, always make sure you have a non-empty read queue, by |
| 2234 | pushing the "read request start" handler on it: |
2334 | pushing the "read request start" handler on it: |
| 2235 | |
2335 | |
| 2236 | # we assume a request starts with a single line |
2336 | # we assume a request starts with a single line |
| 2237 | my @start_request; @start_request = (line => sub { |
2337 | my @start_request; @start_request = (line => sub { |
| 2238 | my ($hdl, $line) = @_; |
2338 | my ($hdl, $line) = @_; |
| … | |
… | |
| 2336 | C<low_water_mark> this will be called precisely when all data has been |
2436 | C<low_water_mark> this will be called precisely when all data has been |
| 2337 | written to the socket: |
2437 | written to the socket: |
| 2338 | |
2438 | |
| 2339 | $handle->push_write (...); |
2439 | $handle->push_write (...); |
| 2340 | $handle->on_drain (sub { |
2440 | $handle->on_drain (sub { |
| 2341 | AE::log debug => "all data submitted to the kernel\n"; |
2441 | AE::log debug => "All data submitted to the kernel."; |
| 2342 | undef $handle; |
2442 | undef $handle; |
| 2343 | }); |
2443 | }); |
| 2344 | |
2444 | |
| 2345 | If you just want to queue some data and then signal EOF to the other side, |
2445 | If you just want to queue some data and then signal EOF to the other side, |
| 2346 | consider using C<< ->push_shutdown >> instead. |
2446 | consider using C<< ->push_shutdown >> instead. |
