… | |
… | |
496 | callback. |
496 | callback. |
497 | |
497 | |
498 | This callback will only be called on TLS shutdowns, not when the |
498 | This callback will only be called on TLS shutdowns, not when the |
499 | underlying handle signals EOF. |
499 | underlying handle signals EOF. |
500 | |
500 | |
501 | =item json => JSON or JSON::XS object |
501 | =item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object |
502 | |
502 | |
503 | This is the json coder object used by the C<json> read and write types. |
503 | This is the json coder object used by the C<json> read and write types. |
504 | |
504 | |
505 | If you don't supply it, then AnyEvent::Handle will create and use a |
505 | 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 |
506 | suitable one (on demand), which will write and expect UTF-8 encoded |
|
|
507 | JSON texts (either using L<JSON::XS> or L<JSON>). The written texts are |
|
|
508 | guaranteed not to contain any newline character. |
|
|
509 | |
|
|
510 | For security reasons, this encoder will likely I<not> handle numbers and |
|
|
511 | strings, only arrays and objects/hashes. The reason is that originally |
|
|
512 | JSON was self-delimited, but Dougles Crockford thought it was a splendid |
|
|
513 | idea to redefine JSON incompatibly, so this is no longer true. |
|
|
514 | |
|
|
515 | For protocols that used back-to-back JSON texts, this might lead to |
|
|
516 | run-ins, where two or more JSON texts will be interpreted as one JSON |
507 | texts. |
517 | text. |
508 | |
518 | |
|
|
519 | For this reason, if the default encoder uses L<JSON::XS>, it will default |
|
|
520 | to not allowing anything but arrays and objects/hashes, at least for the |
|
|
521 | forseeable future (it will change at some point). This might or might not |
|
|
522 | be true for the L<JSON> module, so this might cause a security issue. |
|
|
523 | |
|
|
524 | If you depend on either behaviour, you should create your own json object |
|
|
525 | and pass it in explicitly. |
|
|
526 | |
|
|
527 | =item cbor => L<CBOR::XS> object |
|
|
528 | |
|
|
529 | This is the cbor coder object used by the C<cbor> read and write types. |
|
|
530 | |
|
|
531 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
532 | suitable one (on demand), which will write CBOR without using extensions, |
|
|
533 | if possible. |
|
|
534 | |
509 | Note that you are responsible to depend on the JSON module if you want to |
535 | 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. |
536 | want to use this functionality, as AnyEvent does not have a dependency on |
|
|
537 | it itself. |
511 | |
538 | |
512 | =back |
539 | =back |
513 | |
540 | |
514 | =cut |
541 | =cut |
515 | |
542 | |
… | |
… | |
1045 | |
1072 | |
1046 | Encodes the given hash or array reference into a JSON object. Unless you |
1073 | 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 |
1074 | provide your own JSON object, this means it will be encoded to JSON text |
1048 | in UTF-8. |
1075 | in UTF-8. |
1049 | |
1076 | |
|
|
1077 | The default encoder might or might not handle every type of JSON value - |
|
|
1078 | it might be limited to arrays and objects for security reasons. See the |
|
|
1079 | C<json> constructor attribute for more details. |
|
|
1080 | |
1050 | JSON objects (and arrays) are self-delimiting, so you can write JSON at |
1081 | 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 |
1082 | and hashes, you can write JSON at one end of a handle and read them at the |
1052 | additional framing. |
1083 | other end without using any additional framing. |
1053 | |
1084 | |
1054 | The generated JSON text is guaranteed not to contain any newlines: While |
1085 | 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 |
1086 | contain any newlines: While this module doesn't need delimiters after or |
1056 | able to read them, many other languages depend on that. |
1087 | between JSON texts to be able to read them, many other languages depend on |
|
|
1088 | them. |
1057 | |
1089 | |
1058 | A simple RPC protocol that interoperates easily with others is to send |
1090 | A simple RPC protocol that interoperates easily with other languages is |
1059 | JSON arrays (or objects, although arrays are usually the better choice as |
1091 | 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 |
1092 | choice as they mimic how function argument passing works) and a newline |
1061 | JSON text: |
1093 | after each JSON text: |
1062 | |
1094 | |
1063 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1095 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1064 | $handle->push_write ("\012"); |
1096 | $handle->push_write ("\012"); |
1065 | |
1097 | |
1066 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
1098 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
… | |
… | |
1069 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1101 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1070 | |
1102 | |
1071 | Other languages could read single lines terminated by a newline and pass |
1103 | Other languages could read single lines terminated by a newline and pass |
1072 | this line into their JSON decoder of choice. |
1104 | this line into their JSON decoder of choice. |
1073 | |
1105 | |
|
|
1106 | =item cbor => $perl_scalar |
|
|
1107 | |
|
|
1108 | Encodes the given scalar into a CBOR value. Unless you provide your own |
|
|
1109 | L<CBOR::XS> object, this means it will be encoded to a CBOR string not |
|
|
1110 | using any extensions, if possible. |
|
|
1111 | |
|
|
1112 | CBOR values are self-delimiting, so you can write CBOR at one end of |
|
|
1113 | a handle and read them at the other end without using any additional |
|
|
1114 | framing. |
|
|
1115 | |
|
|
1116 | A simple nd very very fast RPC protocol that interoperates with |
|
|
1117 | other languages is to send CBOR and receive CBOR values (arrays are |
|
|
1118 | recommended): |
|
|
1119 | |
|
|
1120 | $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever |
|
|
1121 | |
|
|
1122 | An AnyEvent::Handle receiver would simply use the C<cbor> read type: |
|
|
1123 | |
|
|
1124 | $handle->push_read (cbor => sub { my $array = $_[1]; ... }); |
|
|
1125 | |
1074 | =cut |
1126 | =cut |
1075 | |
1127 | |
1076 | sub json_coder() { |
1128 | sub json_coder() { |
1077 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1129 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1078 | || do { require JSON; JSON->new->utf8 } |
1130 | || do { require JSON::PP; JSON::PP->new->utf8 } |
1079 | } |
1131 | } |
1080 | |
1132 | |
1081 | register_write_type json => sub { |
1133 | register_write_type json => sub { |
1082 | my ($self, $ref) = @_; |
1134 | my ($self, $ref) = @_; |
1083 | |
1135 | |
1084 | my $json = $self->{json} ||= json_coder; |
1136 | ($self->{json} ||= json_coder) |
1085 | |
|
|
1086 | $json->encode ($ref) |
1137 | ->encode ($ref) |
|
|
1138 | }; |
|
|
1139 | |
|
|
1140 | sub cbor_coder() { |
|
|
1141 | require CBOR::XS; |
|
|
1142 | CBOR::XS->new |
|
|
1143 | } |
|
|
1144 | |
|
|
1145 | register_write_type cbor => sub { |
|
|
1146 | my ($self, $scalar) = @_; |
|
|
1147 | |
|
|
1148 | ($self->{cbor} ||= cbor_coder) |
|
|
1149 | ->encode ($scalar) |
1087 | }; |
1150 | }; |
1088 | |
1151 | |
1089 | =item storable => $reference |
1152 | =item storable => $reference |
1090 | |
1153 | |
1091 | Freezes the given reference using L<Storable> and writes it to the |
1154 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
1485 | |
1548 | |
1486 | register_read_type line => sub { |
1549 | register_read_type line => sub { |
1487 | my ($self, $cb, $eol) = @_; |
1550 | my ($self, $cb, $eol) = @_; |
1488 | |
1551 | |
1489 | if (@_ < 3) { |
1552 | if (@_ < 3) { |
1490 | # this is more than twice as fast as the generic code below |
1553 | # this is faster then the generic code below |
1491 | sub { |
1554 | sub { |
1492 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1555 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1556 | or return; |
1493 | |
1557 | |
|
|
1558 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
1494 | $cb->($_[0], "$1", "$2"); |
1559 | $cb->($_[0], $str, "$1"); |
1495 | 1 |
1560 | 1 |
1496 | } |
1561 | } |
1497 | } else { |
1562 | } else { |
1498 | $eol = quotemeta $eol unless ref $eol; |
1563 | $eol = quotemeta $eol unless ref $eol; |
1499 | $eol = qr|^(.*?)($eol)|s; |
1564 | $eol = qr|^(.*?)($eol)|s; |
… | |
… | |
1662 | =item json => $cb->($handle, $hash_or_arrayref) |
1727 | =item json => $cb->($handle, $hash_or_arrayref) |
1663 | |
1728 | |
1664 | Reads a JSON object or array, decodes it and passes it to the |
1729 | 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. |
1730 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1666 | |
1731 | |
1667 | If a C<json> object was passed to the constructor, then that will be used |
1732 | 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. |
1733 | used for the final decode, otherwise it will create a L<JSON::XS> or |
|
|
1734 | L<JSON::PP> coder object expecting UTF-8. |
1669 | |
1735 | |
1670 | This read type uses the incremental parser available with JSON version |
1736 | 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 |
1737 | 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 | |
1738 | |
1675 | Since JSON texts are fully self-delimiting, the C<json> read and write |
1739 | 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 |
1740 | types are an ideal simple RPC protocol: just exchange JSON datagrams. See |
1677 | the C<json> write type description, above, for an actual example. |
1741 | the C<json> write type description, above, for an actual example. |
1678 | |
1742 | |
… | |
… | |
1682 | my ($self, $cb) = @_; |
1746 | my ($self, $cb) = @_; |
1683 | |
1747 | |
1684 | my $json = $self->{json} ||= json_coder; |
1748 | my $json = $self->{json} ||= json_coder; |
1685 | |
1749 | |
1686 | my $data; |
1750 | my $data; |
1687 | my $rbuf = \$self->{rbuf}; |
|
|
1688 | |
1751 | |
1689 | sub { |
1752 | sub { |
1690 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1753 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1691 | |
1754 | |
1692 | if ($ref) { |
1755 | if ($ref) { |
… | |
… | |
1706 | |
1769 | |
1707 | () |
1770 | () |
1708 | } else { |
1771 | } else { |
1709 | $_[0]{rbuf} = ""; |
1772 | $_[0]{rbuf} = ""; |
1710 | |
1773 | |
|
|
1774 | () |
|
|
1775 | } |
|
|
1776 | } |
|
|
1777 | }; |
|
|
1778 | |
|
|
1779 | =item cbor => $cb->($handle, $scalar) |
|
|
1780 | |
|
|
1781 | Reads a CBOR value, decodes it and passes it to the callback. When a parse |
|
|
1782 | error occurs, an C<EBADMSG> error will be raised. |
|
|
1783 | |
|
|
1784 | If a L<CBOR::XS> object was passed to the constructor, then that will be |
|
|
1785 | used for the final decode, otherwise it will create a CBOR coder without |
|
|
1786 | enabling any options. |
|
|
1787 | |
|
|
1788 | You have to provide a dependency to L<CBOR::XS> on your own: this module |
|
|
1789 | will load the L<CBOR::XS> module, but AnyEvent does not depend on it |
|
|
1790 | itself. |
|
|
1791 | |
|
|
1792 | Since CBOR values are fully self-delimiting, the C<cbor> read and write |
|
|
1793 | types are an ideal simple RPC protocol: just exchange CBOR datagrams. See |
|
|
1794 | the C<cbor> write type description, above, for an actual example. |
|
|
1795 | |
|
|
1796 | =cut |
|
|
1797 | |
|
|
1798 | register_read_type cbor => sub { |
|
|
1799 | my ($self, $cb) = @_; |
|
|
1800 | |
|
|
1801 | my $cbor = $self->{cbor} ||= cbor_coder; |
|
|
1802 | |
|
|
1803 | my $data; |
|
|
1804 | |
|
|
1805 | sub { |
|
|
1806 | my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) }; |
|
|
1807 | |
|
|
1808 | if (@value) { |
|
|
1809 | $cb->($_[0], @value); |
|
|
1810 | |
|
|
1811 | 1 |
|
|
1812 | } elsif ($@) { |
|
|
1813 | # error case |
|
|
1814 | $cbor->incr_reset; |
|
|
1815 | |
|
|
1816 | $_[0]->_error (Errno::EBADMSG); |
|
|
1817 | |
|
|
1818 | () |
|
|
1819 | } else { |
1711 | () |
1820 | () |
1712 | } |
1821 | } |
1713 | } |
1822 | } |
1714 | }; |
1823 | }; |
1715 | |
1824 | |
… | |
… | |
1753 | }); |
1862 | }); |
1754 | } |
1863 | } |
1755 | |
1864 | |
1756 | 1 |
1865 | 1 |
1757 | } |
1866 | } |
|
|
1867 | }; |
|
|
1868 | |
|
|
1869 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1870 | |
|
|
1871 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1872 | record without consuming anything. Only SSL version 3 or higher |
|
|
1873 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1874 | SSL2-compatible framing is supported). |
|
|
1875 | |
|
|
1876 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1877 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1878 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1879 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1880 | be definitely not TLS, it calls the callback with a false value for |
|
|
1881 | C<$detect>. |
|
|
1882 | |
|
|
1883 | The callback could use this information to decide whether or not to start |
|
|
1884 | TLS negotiation. |
|
|
1885 | |
|
|
1886 | In all cases the data read so far is passed to the following read |
|
|
1887 | handlers. |
|
|
1888 | |
|
|
1889 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1890 | |
|
|
1891 | If you want to design a protocol that works in the presence of TLS |
|
|
1892 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1893 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1894 | read type does are a bit more strict, but might losen in the future to |
|
|
1895 | accomodate protocol changes. |
|
|
1896 | |
|
|
1897 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1898 | L<Net::SSLeay>). |
|
|
1899 | |
|
|
1900 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1901 | |
|
|
1902 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1903 | to start tls by calling C<starttls> with the given arguments. |
|
|
1904 | |
|
|
1905 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1906 | been configured to accept, as servers do not normally send a handshake on |
|
|
1907 | their own and ths cannot be detected in this way. |
|
|
1908 | |
|
|
1909 | See C<tls_detect> above for more details. |
|
|
1910 | |
|
|
1911 | Example: give the client a chance to start TLS before accepting a text |
|
|
1912 | line. |
|
|
1913 | |
|
|
1914 | $hdl->push_read (tls_detect => "accept"); |
|
|
1915 | $hdl->push_read (line => sub { |
|
|
1916 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1917 | }); |
|
|
1918 | |
|
|
1919 | =cut |
|
|
1920 | |
|
|
1921 | register_read_type tls_detect => sub { |
|
|
1922 | my ($self, $cb) = @_; |
|
|
1923 | |
|
|
1924 | sub { |
|
|
1925 | # this regex matches a full or partial tls record |
|
|
1926 | if ( |
|
|
1927 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1928 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1929 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1930 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1931 | ) { |
|
|
1932 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1933 | |
|
|
1934 | # full match, valid TLS record |
|
|
1935 | my ($major, $minor) = unpack "CC", $1; |
|
|
1936 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1937 | } else { |
|
|
1938 | # mismatch == guaranteed not TLS |
|
|
1939 | $cb->($self, undef); |
|
|
1940 | } |
|
|
1941 | |
|
|
1942 | 1 |
|
|
1943 | } |
|
|
1944 | }; |
|
|
1945 | |
|
|
1946 | register_read_type tls_autostart => sub { |
|
|
1947 | my ($self, @tls) = @_; |
|
|
1948 | |
|
|
1949 | $RH{tls_detect}($self, sub { |
|
|
1950 | return unless $_[1]; |
|
|
1951 | $_[0]->starttls (@tls); |
|
|
1952 | }) |
1758 | }; |
1953 | }; |
1759 | |
1954 | |
1760 | =back |
1955 | =back |
1761 | |
1956 | |
1762 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1957 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
… | |
… | |
1886 | sub _dotls { |
2081 | sub _dotls { |
1887 | my ($self) = @_; |
2082 | my ($self) = @_; |
1888 | |
2083 | |
1889 | my $tmp; |
2084 | my $tmp; |
1890 | |
2085 | |
1891 | if (length $self->{_tls_wbuf}) { |
2086 | while (length $self->{_tls_wbuf}) { |
1892 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
2087 | if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) { |
1893 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
2088 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
2089 | |
|
|
2090 | return $self->_tls_error ($tmp) |
|
|
2091 | if $tmp != $ERROR_WANT_READ |
|
|
2092 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
2093 | |
|
|
2094 | last; |
1894 | } |
2095 | } |
1895 | |
2096 | |
1896 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
2097 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1897 | return $self->_tls_error ($tmp) |
|
|
1898 | if $tmp != $ERROR_WANT_READ |
|
|
1899 | && ($tmp != $ERROR_SYSCALL || $!); |
|
|
1900 | } |
2098 | } |
1901 | |
2099 | |
1902 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
2100 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1903 | unless (length $tmp) { |
2101 | unless (length $tmp) { |
1904 | $self->{_on_starttls} |
2102 | $self->{_on_starttls} |
… | |
… | |
1918 | $self->{_tls_rbuf} .= $tmp; |
2116 | $self->{_tls_rbuf} .= $tmp; |
1919 | $self->_drain_rbuf; |
2117 | $self->_drain_rbuf; |
1920 | $self->{tls} or return; # tls session might have gone away in callback |
2118 | $self->{tls} or return; # tls session might have gone away in callback |
1921 | } |
2119 | } |
1922 | |
2120 | |
1923 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
2121 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); # -1 is not neccessarily correct, but Net::SSLeay doesn't tell us |
1924 | return $self->_tls_error ($tmp) |
2122 | return $self->_tls_error ($tmp) |
1925 | if $tmp != $ERROR_WANT_READ |
2123 | if $tmp != $ERROR_WANT_READ |
1926 | && ($tmp != $ERROR_SYSCALL || $!); |
2124 | && ($tmp != $ERROR_SYSCALL || $!); |
1927 | |
2125 | |
1928 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
2126 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |