… | |
… | |
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>). |
… | |
… | |
230 | If an EOF condition has been detected but no C<on_eof> callback has been |
236 | If an EOF condition has been detected but no C<on_eof> callback has been |
231 | set, then a fatal error will be raised with C<$!> set to <0>. |
237 | set, then a fatal error will be raised with C<$!> set to <0>. |
232 | |
238 | |
233 | =item on_drain => $cb->($handle) |
239 | =item on_drain => $cb->($handle) |
234 | |
240 | |
235 | This sets the callback that is called when the write buffer becomes empty |
241 | This sets the callback that is called once when the write buffer becomes |
236 | (or immediately if the buffer is empty already). |
242 | empty (and immediately when the handle object is created). |
237 | |
243 | |
238 | To append to the write buffer, use the C<< ->push_write >> method. |
244 | To append to the write buffer, use the C<< ->push_write >> method. |
239 | |
245 | |
240 | This callback is useful when you don't want to put all of your write data |
246 | This callback is useful when you don't want to put all of your write data |
241 | into the queue at once, for example, when you want to write the contents |
247 | into the queue at once, for example, when you want to write the contents |
… | |
… | |
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 | |
… | |
… | |
489 | callback. |
496 | callback. |
490 | |
497 | |
491 | 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 |
492 | underlying handle signals EOF. |
499 | underlying handle signals EOF. |
493 | |
500 | |
494 | =item json => JSON or JSON::XS object |
501 | =item json => L<JSON> or L<JSON::XS> object |
495 | |
502 | |
496 | 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. |
497 | |
504 | |
498 | 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 |
499 | 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 JSON |
500 | texts. |
507 | texts. |
501 | |
508 | |
502 | Note that you are responsible to depend on the JSON module if you want to |
509 | Note that you are responsible to depend on the L<JSON> module if you want |
503 | use this functionality, as AnyEvent does not have a dependency itself. |
510 | to use this functionality, as AnyEvent does not have a dependency on it |
|
|
511 | itself. |
|
|
512 | |
|
|
513 | =item cbor => L<CBOR::XS> object |
|
|
514 | |
|
|
515 | This is the cbor coder object used by the C<cbor> read and write types. |
|
|
516 | |
|
|
517 | If you don't supply it, then AnyEvent::Handle will create and use a |
|
|
518 | suitable one (on demand), which will write CBOR without using extensions, |
|
|
519 | if possible. texts. |
|
|
520 | |
|
|
521 | Note that you are responsible to depend on the L<CBOR::XS> module if you |
|
|
522 | want to use this functionality, as AnyEvent does not have a dependency on |
|
|
523 | it itself. |
504 | |
524 | |
505 | =back |
525 | =back |
506 | |
526 | |
507 | =cut |
527 | =cut |
508 | |
528 | |
… | |
… | |
886 | |
906 | |
887 | The write queue is very simple: you can add data to its end, and |
907 | The write queue is very simple: you can add data to its end, and |
888 | AnyEvent::Handle will automatically try to get rid of it for you. |
908 | AnyEvent::Handle will automatically try to get rid of it for you. |
889 | |
909 | |
890 | When data could be written and the write buffer is shorter then the low |
910 | When data could be written and the write buffer is shorter then the low |
891 | water mark, the C<on_drain> callback will be invoked. |
911 | water mark, the C<on_drain> callback will be invoked once. |
892 | |
912 | |
893 | =over 4 |
913 | =over 4 |
894 | |
914 | |
895 | =item $handle->on_drain ($cb) |
915 | =item $handle->on_drain ($cb) |
896 | |
916 | |
… | |
… | |
1046 | |
1066 | |
1047 | The generated JSON text is guaranteed not to contain any newlines: While |
1067 | The generated JSON text is guaranteed not to contain any newlines: While |
1048 | this module doesn't need delimiters after or between JSON texts to be |
1068 | this module doesn't need delimiters after or between JSON texts to be |
1049 | able to read them, many other languages depend on that. |
1069 | able to read them, many other languages depend on that. |
1050 | |
1070 | |
1051 | A simple RPC protocol that interoperates easily with others is to send |
1071 | A simple RPC protocol that interoperates easily with other languages is |
1052 | JSON arrays (or objects, although arrays are usually the better choice as |
1072 | to send JSON arrays (or objects, although arrays are usually the better |
1053 | they mimic how function argument passing works) and a newline after each |
1073 | choice as they mimic how function argument passing works) and a newline |
1054 | JSON text: |
1074 | after each JSON text: |
1055 | |
1075 | |
1056 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1076 | $handle->push_write (json => ["method", "arg1", "arg2"]); # whatever |
1057 | $handle->push_write ("\012"); |
1077 | $handle->push_write ("\012"); |
1058 | |
1078 | |
1059 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
1079 | An AnyEvent::Handle receiver would simply use the C<json> read type and |
… | |
… | |
1062 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1082 | $handle->push_read (json => sub { my $array = $_[1]; ... }); |
1063 | |
1083 | |
1064 | Other languages could read single lines terminated by a newline and pass |
1084 | Other languages could read single lines terminated by a newline and pass |
1065 | this line into their JSON decoder of choice. |
1085 | this line into their JSON decoder of choice. |
1066 | |
1086 | |
|
|
1087 | =item cbor => $perl_scalar |
|
|
1088 | |
|
|
1089 | Encodes the given scalar into a CBOR value. Unless you provide your own |
|
|
1090 | L<CBOR::XS> object, this means it will be encoded to a CBOR string not |
|
|
1091 | using any extensions, if possible. |
|
|
1092 | |
|
|
1093 | CBOR values are self-delimiting, so you can write CBOR at one end of |
|
|
1094 | a handle and read them at the other end without using any additional |
|
|
1095 | framing. |
|
|
1096 | |
|
|
1097 | A simple nd very very fast RPC protocol that interoperates with |
|
|
1098 | other languages is to send CBOR and receive CBOR values (arrays are |
|
|
1099 | recommended): |
|
|
1100 | |
|
|
1101 | $handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever |
|
|
1102 | |
|
|
1103 | An AnyEvent::Handle receiver would simply use the C<cbor> read type: |
|
|
1104 | |
|
|
1105 | $handle->push_read (cbor => sub { my $array = $_[1]; ... }); |
|
|
1106 | |
1067 | =cut |
1107 | =cut |
1068 | |
1108 | |
1069 | sub json_coder() { |
1109 | sub json_coder() { |
1070 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1110 | eval { require JSON::XS; JSON::XS->new->utf8 } |
1071 | || do { require JSON; JSON->new->utf8 } |
1111 | || do { require JSON; JSON->new->utf8 } |
1072 | } |
1112 | } |
1073 | |
1113 | |
1074 | register_write_type json => sub { |
1114 | register_write_type json => sub { |
1075 | my ($self, $ref) = @_; |
1115 | my ($self, $ref) = @_; |
1076 | |
1116 | |
1077 | my $json = $self->{json} ||= json_coder; |
1117 | ($self->{json} ||= json_coder) |
1078 | |
|
|
1079 | $json->encode ($ref) |
1118 | ->encode ($ref) |
|
|
1119 | }; |
|
|
1120 | |
|
|
1121 | sub cbor_coder() { |
|
|
1122 | require CBOR::XS; |
|
|
1123 | CBOR::XS->new |
|
|
1124 | } |
|
|
1125 | |
|
|
1126 | register_write_type cbor => sub { |
|
|
1127 | my ($self, $scalar) = @_; |
|
|
1128 | |
|
|
1129 | ($self->{cbor} ||= cbor_coder) |
|
|
1130 | ->encode ($scalar) |
1080 | }; |
1131 | }; |
1081 | |
1132 | |
1082 | =item storable => $reference |
1133 | =item storable => $reference |
1083 | |
1134 | |
1084 | Freezes the given reference using L<Storable> and writes it to the |
1135 | Freezes the given reference using L<Storable> and writes it to the |
… | |
… | |
1478 | |
1529 | |
1479 | register_read_type line => sub { |
1530 | register_read_type line => sub { |
1480 | my ($self, $cb, $eol) = @_; |
1531 | my ($self, $cb, $eol) = @_; |
1481 | |
1532 | |
1482 | if (@_ < 3) { |
1533 | if (@_ < 3) { |
1483 | # this is more than twice as fast as the generic code below |
1534 | # this is faster then the generic code below |
1484 | sub { |
1535 | sub { |
1485 | $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return; |
1536 | (my $pos = index $_[0]{rbuf}, "\012") >= 0 |
|
|
1537 | or return; |
1486 | |
1538 | |
|
|
1539 | (my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die; |
1487 | $cb->($_[0], "$1", "$2"); |
1540 | $cb->($_[0], $str, "$1"); |
1488 | 1 |
1541 | 1 |
1489 | } |
1542 | } |
1490 | } else { |
1543 | } else { |
1491 | $eol = quotemeta $eol unless ref $eol; |
1544 | $eol = quotemeta $eol unless ref $eol; |
1492 | $eol = qr|^(.*?)($eol)|s; |
1545 | $eol = qr|^(.*?)($eol)|s; |
… | |
… | |
1675 | my ($self, $cb) = @_; |
1728 | my ($self, $cb) = @_; |
1676 | |
1729 | |
1677 | my $json = $self->{json} ||= json_coder; |
1730 | my $json = $self->{json} ||= json_coder; |
1678 | |
1731 | |
1679 | my $data; |
1732 | my $data; |
1680 | my $rbuf = \$self->{rbuf}; |
|
|
1681 | |
1733 | |
1682 | sub { |
1734 | sub { |
1683 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1735 | my $ref = eval { $json->incr_parse ($_[0]{rbuf}) }; |
1684 | |
1736 | |
1685 | if ($ref) { |
1737 | if ($ref) { |
… | |
… | |
1704 | () |
1756 | () |
1705 | } |
1757 | } |
1706 | } |
1758 | } |
1707 | }; |
1759 | }; |
1708 | |
1760 | |
|
|
1761 | =item cbor => $cb->($handle, $scalar) |
|
|
1762 | |
|
|
1763 | Reads a CBOR value, decodes it and passes it to the callback. When a parse |
|
|
1764 | error occurs, an C<EBADMSG> error will be raised. |
|
|
1765 | |
|
|
1766 | If a L<CBOR::XS> object was passed to the constructor, then that will be |
|
|
1767 | used for the final decode, otherwise it will create a CBOR coder without |
|
|
1768 | enabling any options. |
|
|
1769 | |
|
|
1770 | You have to provide a dependency to L<CBOR::XS> on your own: this module |
|
|
1771 | will load the L<CBOR::XS> module, but AnyEvent does not depend on it |
|
|
1772 | itself. |
|
|
1773 | |
|
|
1774 | Since CBOR values are fully self-delimiting, the C<cbor> read and write |
|
|
1775 | types are an ideal simple RPC protocol: just exchange CBOR datagrams. See |
|
|
1776 | the C<cbor> write type description, above, for an actual example. |
|
|
1777 | |
|
|
1778 | =cut |
|
|
1779 | |
|
|
1780 | register_read_type cbor => sub { |
|
|
1781 | my ($self, $cb) = @_; |
|
|
1782 | |
|
|
1783 | my $cbor = $self->{cbor} ||= cbor_coder; |
|
|
1784 | |
|
|
1785 | my $data; |
|
|
1786 | |
|
|
1787 | sub { |
|
|
1788 | my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) }; |
|
|
1789 | |
|
|
1790 | if (@value) { |
|
|
1791 | $cb->($_[0], @value); |
|
|
1792 | |
|
|
1793 | 1 |
|
|
1794 | } elsif ($@) { |
|
|
1795 | # error case |
|
|
1796 | $cbor->incr_reset; |
|
|
1797 | |
|
|
1798 | $_[0]->_error (Errno::EBADMSG); |
|
|
1799 | |
|
|
1800 | () |
|
|
1801 | } else { |
|
|
1802 | () |
|
|
1803 | } |
|
|
1804 | } |
|
|
1805 | }; |
|
|
1806 | |
1709 | =item storable => $cb->($handle, $ref) |
1807 | =item storable => $cb->($handle, $ref) |
1710 | |
1808 | |
1711 | Deserialises a L<Storable> frozen representation as written by the |
1809 | Deserialises a L<Storable> frozen representation as written by the |
1712 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
1810 | C<storable> write type (BER-encoded length prefix followed by nfreeze'd |
1713 | data). |
1811 | data). |
… | |
… | |
1730 | |
1828 | |
1731 | # bypass unshift if we already have the remaining chunk |
1829 | # bypass unshift if we already have the remaining chunk |
1732 | if ($format + $len <= length $_[0]{rbuf}) { |
1830 | if ($format + $len <= length $_[0]{rbuf}) { |
1733 | my $data = substr $_[0]{rbuf}, $format, $len; |
1831 | my $data = substr $_[0]{rbuf}, $format, $len; |
1734 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
1832 | substr $_[0]{rbuf}, 0, $format + $len, ""; |
|
|
1833 | |
1735 | $cb->($_[0], Storable::thaw ($data)); |
1834 | eval { $cb->($_[0], Storable::thaw ($data)); 1 } |
|
|
1835 | or return $_[0]->_error (Errno::EBADMSG); |
1736 | } else { |
1836 | } else { |
1737 | # remove prefix |
1837 | # remove prefix |
1738 | substr $_[0]{rbuf}, 0, $format, ""; |
1838 | substr $_[0]{rbuf}, 0, $format, ""; |
1739 | |
1839 | |
1740 | # read remaining chunk |
1840 | # read remaining chunk |
1741 | $_[0]->unshift_read (chunk => $len, sub { |
1841 | $_[0]->unshift_read (chunk => $len, sub { |
1742 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1842 | eval { $cb->($_[0], Storable::thaw ($_[1])); 1 } |
1743 | $cb->($_[0], $ref); |
|
|
1744 | } else { |
|
|
1745 | $_[0]->_error (Errno::EBADMSG); |
1843 | or $_[0]->_error (Errno::EBADMSG); |
1746 | } |
|
|
1747 | }); |
1844 | }); |
1748 | } |
1845 | } |
1749 | |
1846 | |
1750 | 1 |
1847 | 1 |
1751 | } |
1848 | } |
|
|
1849 | }; |
|
|
1850 | |
|
|
1851 | =item tls_detect => $cb->($handle, $detect, $major, $minor) |
|
|
1852 | |
|
|
1853 | Checks the input stream for a valid SSL or TLS handshake TLSPaintext |
|
|
1854 | record without consuming anything. Only SSL version 3 or higher |
|
|
1855 | is handled, up to the fictituous protocol 4.x (but both SSL3+ and |
|
|
1856 | SSL2-compatible framing is supported). |
|
|
1857 | |
|
|
1858 | If it detects that the input data is likely TLS, it calls the callback |
|
|
1859 | with a true value for C<$detect> and the (on-wire) TLS version as second |
|
|
1860 | and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL |
|
|
1861 | 3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to |
|
|
1862 | be definitely not TLS, it calls the callback with a false value for |
|
|
1863 | C<$detect>. |
|
|
1864 | |
|
|
1865 | The callback could use this information to decide whether or not to start |
|
|
1866 | TLS negotiation. |
|
|
1867 | |
|
|
1868 | In all cases the data read so far is passed to the following read |
|
|
1869 | handlers. |
|
|
1870 | |
|
|
1871 | Usually you want to use the C<tls_autostart> read type instead. |
|
|
1872 | |
|
|
1873 | If you want to design a protocol that works in the presence of TLS |
|
|
1874 | dtection, make sure that any non-TLS data doesn't start with the octet 22 |
|
|
1875 | (ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this |
|
|
1876 | read type does are a bit more strict, but might losen in the future to |
|
|
1877 | accomodate protocol changes. |
|
|
1878 | |
|
|
1879 | This read type does not rely on L<AnyEvent::TLS> (and thus, not on |
|
|
1880 | L<Net::SSLeay>). |
|
|
1881 | |
|
|
1882 | =item tls_autostart => $tls[, $tls_ctx] |
|
|
1883 | |
|
|
1884 | Tries to detect a valid SSL or TLS handshake. If one is detected, it tries |
|
|
1885 | to start tls by calling C<starttls> with the given arguments. |
|
|
1886 | |
|
|
1887 | In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has |
|
|
1888 | been configured to accept, as servers do not normally send a handshake on |
|
|
1889 | their own and ths cannot be detected in this way. |
|
|
1890 | |
|
|
1891 | See C<tls_detect> above for more details. |
|
|
1892 | |
|
|
1893 | Example: give the client a chance to start TLS before accepting a text |
|
|
1894 | line. |
|
|
1895 | |
|
|
1896 | $hdl->push_read (tls_detect => "accept"); |
|
|
1897 | $hdl->push_read (line => sub { |
|
|
1898 | print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n"; |
|
|
1899 | }); |
|
|
1900 | |
|
|
1901 | =cut |
|
|
1902 | |
|
|
1903 | register_read_type tls_detect => sub { |
|
|
1904 | my ($self, $cb) = @_; |
|
|
1905 | |
|
|
1906 | sub { |
|
|
1907 | # this regex matches a full or partial tls record |
|
|
1908 | if ( |
|
|
1909 | # ssl3+: type(22=handshake) major(=3) minor(any) length_hi |
|
|
1910 | $self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs |
|
|
1911 | # ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength) |
|
|
1912 | or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs |
|
|
1913 | ) { |
|
|
1914 | return if 3 != length $1; # partial match, can't decide yet |
|
|
1915 | |
|
|
1916 | # full match, valid TLS record |
|
|
1917 | my ($major, $minor) = unpack "CC", $1; |
|
|
1918 | $cb->($self, "accept", $major + $minor * 0.1); |
|
|
1919 | } else { |
|
|
1920 | # mismatch == guaranteed not TLS |
|
|
1921 | $cb->($self, undef); |
|
|
1922 | } |
|
|
1923 | |
|
|
1924 | 1 |
|
|
1925 | } |
|
|
1926 | }; |
|
|
1927 | |
|
|
1928 | register_read_type tls_autostart => sub { |
|
|
1929 | my ($self, @tls) = @_; |
|
|
1930 | |
|
|
1931 | $RH{tls_detect}($self, sub { |
|
|
1932 | return unless $_[1]; |
|
|
1933 | $_[0]->starttls (@tls); |
|
|
1934 | }) |
1752 | }; |
1935 | }; |
1753 | |
1936 | |
1754 | =back |
1937 | =back |
1755 | |
1938 | |
1756 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
1939 | =item custom read types - Package::anyevent_read_type $handle, $cb, @args |
… | |
… | |
1856 | my ($self, $err) = @_; |
2039 | my ($self, $err) = @_; |
1857 | |
2040 | |
1858 | return $self->_error ($!, 1) |
2041 | return $self->_error ($!, 1) |
1859 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
2042 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
1860 | |
2043 | |
1861 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
2044 | my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
1862 | |
2045 | |
1863 | # reduce error string to look less scary |
2046 | # reduce error string to look less scary |
1864 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
2047 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
1865 | |
2048 | |
1866 | if ($self->{_on_starttls}) { |
2049 | if ($self->{_on_starttls}) { |
… | |
… | |
1932 | |
2115 | |
1933 | =item $handle->starttls ($tls[, $tls_ctx]) |
2116 | =item $handle->starttls ($tls[, $tls_ctx]) |
1934 | |
2117 | |
1935 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
2118 | 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 |
2119 | object is created, you can also do that at a later time by calling |
1937 | C<starttls>. |
2120 | C<starttls>. See the C<tls> constructor argument for general info. |
1938 | |
2121 | |
1939 | Starting TLS is currently an asynchronous operation - when you push some |
2122 | Starting TLS is currently an asynchronous operation - when you push some |
1940 | write data and then call C<< ->starttls >> then TLS negotiation will start |
2123 | write data and then call C<< ->starttls >> then TLS negotiation will start |
1941 | immediately, after which the queued write data is then sent. |
2124 | immediately, after which the queued write data is then sent. This might |
|
|
2125 | change in future versions, so best make sure you have no outstanding write |
|
|
2126 | data when calling this method. |
1942 | |
2127 | |
1943 | The first argument is the same as the C<tls> constructor argument (either |
2128 | The first argument is the same as the C<tls> constructor argument (either |
1944 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
2129 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1945 | |
2130 | |
1946 | The second argument is the optional C<AnyEvent::TLS> object that is used |
2131 | The second argument is the optional C<AnyEvent::TLS> object that is used |
… | |
… | |
1968 | my ($self, $tls, $ctx) = @_; |
2153 | my ($self, $tls, $ctx) = @_; |
1969 | |
2154 | |
1970 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
2155 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
1971 | if $self->{tls}; |
2156 | if $self->{tls}; |
1972 | |
2157 | |
|
|
2158 | unless (defined $AnyEvent::TLS::VERSION) { |
|
|
2159 | eval { |
|
|
2160 | require Net::SSLeay; |
|
|
2161 | require AnyEvent::TLS; |
|
|
2162 | 1 |
|
|
2163 | } or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system"); |
|
|
2164 | } |
|
|
2165 | |
1973 | $self->{tls} = $tls; |
2166 | $self->{tls} = $tls; |
1974 | $self->{tls_ctx} = $ctx if @_ > 2; |
2167 | $self->{tls_ctx} = $ctx if @_ > 2; |
1975 | |
2168 | |
1976 | return unless $self->{fh}; |
2169 | return unless $self->{fh}; |
1977 | |
2170 | |
1978 | require Net::SSLeay; |
|
|
1979 | |
|
|
1980 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
2171 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
1981 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
2172 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
1982 | |
2173 | |
1983 | $tls = delete $self->{tls}; |
2174 | $tls = delete $self->{tls}; |
1984 | $ctx = $self->{tls_ctx}; |
2175 | $ctx = $self->{tls_ctx}; |
1985 | |
2176 | |
1986 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
2177 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
1987 | |
2178 | |
1988 | if ("HASH" eq ref $ctx) { |
2179 | if ("HASH" eq ref $ctx) { |
1989 | require AnyEvent::TLS; |
|
|
1990 | |
|
|
1991 | if ($ctx->{cache}) { |
2180 | if ($ctx->{cache}) { |
1992 | my $key = $ctx+0; |
2181 | my $key = $ctx+0; |
1993 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
2182 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
1994 | } else { |
2183 | } else { |
1995 | $ctx = new AnyEvent::TLS %$ctx; |
2184 | $ctx = new AnyEvent::TLS %$ctx; |
… | |
… | |
2228 | handles requests until the server gets some QUIT command, causing it to |
2417 | 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 |
2418 | 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 |
2419 | client dropping the connection is an error, which means this variant can |
2231 | detect an unexpected detection close. |
2420 | detect an unexpected detection close. |
2232 | |
2421 | |
2233 | To handle this case, always make sure you have a on-empty read queue, by |
2422 | To handle this case, always make sure you have a non-empty read queue, by |
2234 | pushing the "read request start" handler on it: |
2423 | pushing the "read request start" handler on it: |
2235 | |
2424 | |
2236 | # we assume a request starts with a single line |
2425 | # we assume a request starts with a single line |
2237 | my @start_request; @start_request = (line => sub { |
2426 | my @start_request; @start_request = (line => sub { |
2238 | my ($hdl, $line) = @_; |
2427 | my ($hdl, $line) = @_; |
… | |
… | |
2336 | C<low_water_mark> this will be called precisely when all data has been |
2525 | C<low_water_mark> this will be called precisely when all data has been |
2337 | written to the socket: |
2526 | written to the socket: |
2338 | |
2527 | |
2339 | $handle->push_write (...); |
2528 | $handle->push_write (...); |
2340 | $handle->on_drain (sub { |
2529 | $handle->on_drain (sub { |
2341 | AE::log debug => "all data submitted to the kernel\n"; |
2530 | AE::log debug => "All data submitted to the kernel."; |
2342 | undef $handle; |
2531 | undef $handle; |
2343 | }); |
2532 | }); |
2344 | |
2533 | |
2345 | If you just want to queue some data and then signal EOF to the other side, |
2534 | If you just want to queue some data and then signal EOF to the other side, |
2346 | consider using C<< ->push_shutdown >> instead. |
2535 | consider using C<< ->push_shutdown >> instead. |
… | |
… | |
2430 | When you have intermediate CA certificates that your clients might not |
2619 | When you have intermediate CA certificates that your clients might not |
2431 | know about, just append them to the C<cert_file>. |
2620 | know about, just append them to the C<cert_file>. |
2432 | |
2621 | |
2433 | =back |
2622 | =back |
2434 | |
2623 | |
2435 | |
|
|
2436 | =head1 SUBCLASSING AnyEvent::Handle |
2624 | =head1 SUBCLASSING AnyEvent::Handle |
2437 | |
2625 | |
2438 | In many cases, you might want to subclass AnyEvent::Handle. |
2626 | In many cases, you might want to subclass AnyEvent::Handle. |
2439 | |
2627 | |
2440 | To make this easier, a given version of AnyEvent::Handle uses these |
2628 | To make this easier, a given version of AnyEvent::Handle uses these |
… | |
… | |
2466 | |
2654 | |
2467 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2655 | Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
2468 | |
2656 | |
2469 | =cut |
2657 | =cut |
2470 | |
2658 | |
2471 | 1; # End of AnyEvent::Handle |
2659 | 1 |
|
|
2660 | |