[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.232 by root, Fri Mar 30 03:11:17 2012 UTC vs.
Revision 1.251 by root, Tue Feb 26 02:08:34 2019 UTC

…		…
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!";	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
…		…
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
…		…
170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In	169	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	170	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.	171	often easiest to not report C<EPIPE> errors in this callback.
173		172
174	AnyEvent::Handle tries to find an appropriate error code for you to check	173	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	174	against, but in some cases (TLS errors), this does not work well.
176	recommended to always output the C<$message> argument in human-readable	175
177	error messages (it's usually the same as C<"$!">).	176	If you report the error to the user, it is recommended to always output
		177	the C<$message> argument in human-readable error messages (you don't need
		178	to report C<"$!"> if you report C<$message>).
		179
		180	If you want to react programmatically to the error, then looking at C<$!>
		181	and comparing it against some of the documented C<Errno> values is usually
		182	better than looking at the C<$message>.
178		183
179	Non-fatal errors can be retried by returning, but it is recommended	184	Non-fatal errors can be retried by returning, but it is recommended
180	to simply ignore this parameter and instead abondon the handle object	185	to simply ignore this parameter and instead abondon the handle object
181	when this callback is invoked. Examples of non-fatal errors are timeouts	186	when this callback is invoked. Examples of non-fatal errors are timeouts
182	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	187	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
…		…
423	appropriate error message.	428	appropriate error message.
424		429
425	TLS mode requires Net::SSLeay to be installed (it will be loaded	430	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	431	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	432	have a dependency on that module, so if your module requires it, you have
428	to add the dependency yourself.	433	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		434	old, you get an C<EPROTO> error.
429		435
430	Unlike TCP, TLS has a server and client side: for the TLS server side, use	436	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>	437	C<accept>, and for the TLS client side of a connection, use C<connect>
432	mode.	438	mode.
433		439
…		…
489	callback.	495	callback.
490		496
491	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
492	underlying handle signals EOF.	498	underlying handle signals EOF.
493		499
494	=item json => JSON or JSON::XS object	500	=item json => L<JSON>, L<JSON::PP> or L<JSON::XS> object
495		501
496	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.
497		503
498	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
499	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
500	texts.	516	text.
501		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
502	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
503	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.
504		537
505	=back	538	=back
506		539
507	=cut	540	=cut
508		541
…		…
580	# with AnyEvent::Handle, do them a favour.	613	# with AnyEvent::Handle, do them a favour.
581	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();	614	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
582	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!"
583	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;	616	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
584		617
585	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	618	AnyEvent::fh_unblock $self->{fh};
586		619
587	$self->{_activity} =	620	$self->{_activity} =
588	$self->{_ractivity} =	621	$self->{_ractivity} =
589	$self->{_wactivity} = AE::now;	622	$self->{_wactivity} = AE::now;
590		623
…		…
722	$_[0]{oobinline} = $_[1];	755	$_[0]{oobinline} = $_[1];
723		756
724	eval {	757	eval {
725	local $SIG{__DIE__};	758	local $SIG{__DIE__};
726	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]	759	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
727	if $_[0]{fh};
728	};
729	}
730
731	=item $handle->keepalive ($boolean)
732
733	Enables or disables the C<keepalive> setting (see constructor argument of
734	the same name for details).
735
736	=cut
737
738	sub keepalive {
739	$_[0]{keepalive} = $_[1];
740
741	eval {
742	local $SIG{__DIE__};
743	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
744	if $_[0]{fh};	760	if $_[0]{fh};
745	};	761	};
746	}	762	}
747		763
748	=item $handle->on_starttls ($cb)	764	=item $handle->on_starttls ($cb)
…		…
940	$self->{on_drain}($self)	956	$self->{on_drain}($self)
941	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})
942	&& $self->{on_drain};	958	&& $self->{on_drain};
943		959
944	delete $self->{_ww} unless length $self->{wbuf};	960	delete $self->{_ww} unless length $self->{wbuf};
945	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	961	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
946	$self->_error ($!, 1);	962	$self->_error ($!, 1);
947	}	963	}
948	};	964	};
949		965
950	# try to write data immediately	966	# try to write data immediately
…		…
1038		1054
1039	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
1040	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
1041	in UTF-8.	1057	in UTF-8.
1042		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
1043	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
1044	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
1045	additional framing.	1065	other end without using any additional framing.
1046		1066
1047	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
1048	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
1049	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.
1050		1071
1051	A simple RPC protocol that interoperates easily with others is to send	1072	A simple RPC protocol that interoperates easily with other languages is
1052	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
1053	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
1054	JSON text:	1075	after each JSON text:
1055		1076
1056	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1077	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
1057	$handle->push_write ("\012");	1078	$handle->push_write ("\012");
1058		1079
1059	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
…		…
1062	$handle->push_read (json => sub { my $array = $_[1]; ... });	1083	$handle->push_read (json => sub { my $array = $_[1]; ... });
1063		1084
1064	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
1065	this line into their JSON decoder of choice.	1086	this line into their JSON decoder of choice.
1066		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
1067	=cut	1108	=cut
1068		1109
1069	sub json_coder() {	1110	sub json_coder() {
1070	eval { require JSON::XS; JSON::XS->new->utf8 }	1111	eval { require JSON::XS; JSON::XS->new->utf8 }
1071	\|\| do { require JSON; JSON->new->utf8 }	1112	\|\| do { require JSON::PP; JSON::PP->new->utf8 }
1072	}	1113	}
1073		1114
1074	register_write_type json => sub {	1115	register_write_type json => sub {
1075	my ($self, $ref) = @_;	1116	my ($self, $ref) = @_;
1076		1117
1077	my $json = $self->{json} \|\|= json_coder;	1118	($self->{json} \|\|= json_coder)
1078
1079	$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)
1080	};	1132	};
1081		1133
1082	=item storable => $reference	1134	=item storable => $reference
1083		1135
1084	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
…		…
1478		1530
1479	register_read_type line => sub {	1531	register_read_type line => sub {
1480	my ($self, $cb, $eol) = @_;	1532	my ($self, $cb, $eol) = @_;
1481		1533
1482	if (@_ < 3) {	1534	if (@_ < 3) {
1483	# this is more than twice as fast as the generic code below	1535	# this is faster then the generic code below
1484	sub {	1536	sub {
1485	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;	1537	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1538	or return;
1486		1539
		1540	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
1487	$cb->($_[0], "$1", "$2");	1541	$cb->($_[0], $str, "$1");
1488	1	1542	1
1489	}	1543	}
1490	} else {	1544	} else {
1491	$eol = quotemeta $eol unless ref $eol;	1545	$eol = quotemeta $eol unless ref $eol;
1492	$eol = qr\|^(.*?)($eol)\|s;	1546	$eol = qr\|^(.*?)($eol)\|s;
…		…
1501	};	1555	};
1502		1556
1503	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1557	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
1504		1558
1505	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
1506	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.
1507		1562
1508	Example: read a single line terminated by '\n'.	1563	Example: read a single line terminated by '\n'.
1509		1564
1510	$handle->push_read (regex => qr<\n>, sub { ... });	1565	$handle->push_read (regex => qr<\n>, sub { ... });
1511		1566
…		…
1655	=item json => $cb->($handle, $hash_or_arrayref)	1710	=item json => $cb->($handle, $hash_or_arrayref)
1656		1711
1657	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
1658	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.
1659		1714
1660	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
1661	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.
1662		1718
1663	This read type uses the incremental parser available with JSON version	1719	This read type uses the incremental parser available with JSON version
1664	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.
1665	dependency on your own: this module will load the JSON module, but
1666	AnyEvent does not depend on it itself.
1667		1721
1668	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
1669	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
1670	the C<json> write type description, above, for an actual example.	1724	the C<json> write type description, above, for an actual example.
1671		1725
…		…
1675	my ($self, $cb) = @_;	1729	my ($self, $cb) = @_;
1676		1730
1677	my $json = $self->{json} \|\|= json_coder;	1731	my $json = $self->{json} \|\|= json_coder;
1678		1732
1679	my $data;	1733	my $data;
1680	my $rbuf = \$self->{rbuf};
1681		1734
1682	sub {	1735	sub {
1683	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };	1736	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1684		1737
1685	if ($ref) {	1738	if ($ref) {
…		…
1699		1752
1700	()	1753	()
1701	} else {	1754	} else {
1702	$_[0]{rbuf} = "";	1755	$_[0]{rbuf} = "";
1703		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 {
1704	()	1803	()
1705	}	1804	}
1706	}	1805	}
1707	};	1806	};
1708		1807
…		…
1746	});	1845	});
1747	}	1846	}
1748		1847
1749	1	1848	1
1750	}	1849	}
		1850	};
		1851
		1852	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1853
		1854	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1855	record without consuming anything. Only SSL version 3 or higher
		1856	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1857	SSL2-compatible framing is supported).
		1858
		1859	If it detects that the input data is likely TLS, it calls the callback
		1860	with a true value for C<$detect> and the (on-wire) TLS version as second
		1861	and third argument (C<$major> is C<3>, and C<$minor> is 0..4 for SSL
		1862	3.0, TLS 1.0, 1.1, 1.2 and 1.3, respectively). If it detects the input
		1863	to be definitely not TLS, it calls the callback with a false value for
		1864	C<$detect>.
		1865
		1866	The callback could use this information to decide whether or not to start
		1867	TLS negotiation.
		1868
		1869	In all cases the data read so far is passed to the following read
		1870	handlers.
		1871
		1872	Usually you want to use the C<tls_autostart> read type instead.
		1873
		1874	If you want to design a protocol that works in the presence of TLS
		1875	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1876	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1877	read type does are a bit more strict, but might losen in the future to
		1878	accomodate protocol changes.
		1879
		1880	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1881	L<Net::SSLeay>).
		1882
		1883	=item tls_autostart => [$tls_ctx, ]$tls
		1884
		1885	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1886	to start tls by calling C<starttls> with the given arguments.
		1887
		1888	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1889	been configured to accept, as servers do not normally send a handshake on
		1890	their own and ths cannot be detected in this way.
		1891
		1892	See C<tls_detect> above for more details.
		1893
		1894	Example: give the client a chance to start TLS before accepting a text
		1895	line.
		1896
		1897	$hdl->push_read (tls_autostart => "accept");
		1898	$hdl->push_read (line => sub {
		1899	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1900	});
		1901
		1902	=cut
		1903
		1904	register_read_type tls_detect => sub {
		1905	my ($self, $cb) = @_;
		1906
		1907	sub {
		1908	# this regex matches a full or partial tls record
		1909	if (
		1910	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1911	$self->{rbuf} =~ /^(?:\z\| \x16 (\z\| [\x03\x04] (?:\z\| . (?:\z\| [\x00-\x40] ))))/xs
		1912	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1913	or $self->{rbuf} =~ /^(?:\z\| [\x80-\xff] (?:\z\| . (?:\z\| \x01 (\z\| [\x03\x04] (?:\z\| . (?:\z\| . ))))))/xs
		1914	) {
		1915	return if 3 != length $1; # partial match, can't decide yet
		1916
		1917	# full match, valid TLS record
		1918	my ($major, $minor) = unpack "CC", $1;
		1919	$cb->($self, "accept", $major, $minor);
		1920	} else {
		1921	# mismatch == guaranteed not TLS
		1922	$cb->($self, undef);
		1923	}
		1924
		1925	1
		1926	}
		1927	};
		1928
		1929	register_read_type tls_autostart => sub {
		1930	my ($self, @tls) = @_;
		1931
		1932	$RH{tls_detect}($self, sub {
		1933	return unless $_[1];
		1934	$_[0]->starttls (@tls);
		1935	})
1751	};	1936	};
1752		1937
1753	=back	1938	=back
1754		1939
1755	=item custom read types - Package::anyevent_read_type $handle, $cb, @args	1940	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
…		…
1839	} elsif (defined $len) {	2024	} elsif (defined $len) {
1840	delete $self->{_rw};	2025	delete $self->{_rw};
1841	$self->{_eof} = 1;	2026	$self->{_eof} = 1;
1842	$self->_drain_rbuf;	2027	$self->_drain_rbuf;
1843		2028
1844	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2029	} elsif ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK) {
1845	return $self->_error ($!, 1);	2030	return $self->_error ($!, 1);
1846	}	2031	}
1847	};	2032	};
1848	}	2033	}
1849	}	2034	}
…		…
1855	my ($self, $err) = @_;	2040	my ($self, $err) = @_;
1856		2041
1857	return $self->_error ($!, 1)	2042	return $self->_error ($!, 1)
1858	if $err == Net::SSLeay::ERROR_SYSCALL ();	2043	if $err == Net::SSLeay::ERROR_SYSCALL ();
1859		2044
1860	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	2045	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1861		2046
1862	# reduce error string to look less scary	2047	# reduce error string to look less scary
1863	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	2048	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1864		2049
1865	if ($self->{_on_starttls}) {	2050	if ($self->{_on_starttls}) {
…		…
1879	sub _dotls {	2064	sub _dotls {
1880	my ($self) = @_;	2065	my ($self) = @_;
1881		2066
1882	my $tmp;	2067	my $tmp;
1883		2068
1884	if (length $self->{_tls_wbuf}) {	2069	while (length $self->{_tls_wbuf}) {
1885	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2070	if (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) <= 0) {
1886	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;
1887	}	2078	}
1888		2079
1889	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	2080	substr $self->{_tls_wbuf}, 0, $tmp, "";
1890	return $self->_tls_error ($tmp)
1891	if $tmp != $ERROR_WANT_READ
1892	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1893	}	2081	}
1894		2082
1895	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	2083	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1896	unless (length $tmp) {	2084	unless (length $tmp) {
1897	$self->{_on_starttls}	2085	$self->{_on_starttls}
…		…
1911	$self->{_tls_rbuf} .= $tmp;	2099	$self->{_tls_rbuf} .= $tmp;
1912	$self->_drain_rbuf;	2100	$self->_drain_rbuf;
1913	$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
1914	}	2102	}
1915		2103
1916	$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
1917	return $self->_tls_error ($tmp)	2105	return $self->_tls_error ($tmp)
1918	if $tmp != $ERROR_WANT_READ	2106	if $tmp != $ERROR_WANT_READ
1919	&& ($tmp != $ERROR_SYSCALL \|\| $!);	2107	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1920		2108
1921	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2109	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
…		…
1931		2119
1932	=item $handle->starttls ($tls[, $tls_ctx])	2120	=item $handle->starttls ($tls[, $tls_ctx])
1933		2121
1934	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2122	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1935	object is created, you can also do that at a later time by calling	2123	object is created, you can also do that at a later time by calling
1936	C<starttls>.	2124	C<starttls>. See the C<tls> constructor argument for general info.
1937		2125
1938	Starting TLS is currently an asynchronous operation - when you push some	2126	Starting TLS is currently an asynchronous operation - when you push some
1939	write data and then call C<< ->starttls >> then TLS negotiation will start	2127	write data and then call C<< ->starttls >> then TLS negotiation will start
1940	immediately, after which the queued write data is then sent.	2128	immediately, after which the queued write data is then sent. This might
		2129	change in future versions, so best make sure you have no outstanding write
		2130	data when calling this method.
1941		2131
1942	The first argument is the same as the C<tls> constructor argument (either	2132	The first argument is the same as the C<tls> constructor argument (either
1943	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2133	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1944		2134
1945	The second argument is the optional C<AnyEvent::TLS> object that is used	2135	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1967	my ($self, $tls, $ctx) = @_;	2157	my ($self, $tls, $ctx) = @_;
1968		2158
1969	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"	2159	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
1970	if $self->{tls};	2160	if $self->{tls};
1971		2161
		2162	unless (defined $AnyEvent::TLS::VERSION) {
		2163	eval {
		2164	require Net::SSLeay;
		2165	require AnyEvent::TLS;
		2166	1
		2167	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2168	}
		2169
1972	$self->{tls} = $tls;	2170	$self->{tls} = $tls;
1973	$self->{tls_ctx} = $ctx if @_ > 2;	2171	$self->{tls_ctx} = $ctx if @_ > 2;
1974		2172
1975	return unless $self->{fh};	2173	return unless $self->{fh};
1976		2174
1977	require Net::SSLeay;
1978
1979	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	2175	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1980	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	2176	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1981		2177
1982	$tls = delete $self->{tls};	2178	$tls = delete $self->{tls};
1983	$ctx = $self->{tls_ctx};	2179	$ctx = $self->{tls_ctx};
1984		2180
1985	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	2181	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1986		2182
1987	if ("HASH" eq ref $ctx) {	2183	if ("HASH" eq ref $ctx) {
1988	require AnyEvent::TLS;
1989
1990	if ($ctx->{cache}) {	2184	if ($ctx->{cache}) {
1991	my $key = $ctx+0;	2185	my $key = $ctx+0;
1992	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	2186	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1993	} else {	2187	} else {
1994	$ctx = new AnyEvent::TLS %$ctx;	2188	$ctx = new AnyEvent::TLS %$ctx;
…		…
1999	$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});
2000		2194
2001	# 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)
2002	# but the openssl maintainers basically said: "trust us, it just works".	2196	# but the openssl maintainers basically said: "trust us, it just works".
2003	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2197	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
2004	# and mismaintained ssleay-module doesn't even offer them).	2198	# and mismaintained ssleay-module didn't offer them for a decade or so).
2005	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2199	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
2006	#	2200	#
2007	# in short: this is a mess.	2201	# in short: this is a mess.
2008	#	2202	#
2009	# 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.
2010	# 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,
2011	# 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
2012	# have identity issues in that area.	2206	# have identity issues in that area.
2013	# Net::SSLeay::CTX_set_mode ($ssl,	2207	# Net::SSLeay::set_mode ($ssl,
2014	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	2208	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
2015	# \| (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));
2016	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	2210	Net::SSLeay::set_mode ($tls, 1\|2);
2017		2211
2018	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2212	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2019	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2213	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
2020		2214
2021	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});	2215	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
…		…
2096	push @linger, AE::io $fh, 1, sub {	2290	push @linger, AE::io $fh, 1, sub {
2097	my $len = syswrite $fh, $wbuf, length $wbuf;	2291	my $len = syswrite $fh, $wbuf, length $wbuf;
2098		2292
2099	if ($len > 0) {	2293	if ($len > 0) {
2100	substr $wbuf, 0, $len, "";	2294	substr $wbuf, 0, $len, "";
2101	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {	2295	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != EWOULDBLOCK && $! != WSAEWOULDBLOCK)) {
2102	@linger = (); # end	2296	@linger = (); # end
2103	}	2297	}
2104	};	2298	};
2105	push @linger, AE::timer $linger, 0, sub {	2299	push @linger, AE::timer $linger, 0, sub {
2106	@linger = ();	2300	@linger = ();
…		…
2227	handles requests until the server gets some QUIT command, causing it to	2421	handles requests until the server gets some QUIT command, causing it to
2228	close the connection first (highly desirable for a busy TCP server). A	2422	close the connection first (highly desirable for a busy TCP server). A
2229	client dropping the connection is an error, which means this variant can	2423	client dropping the connection is an error, which means this variant can
2230	detect an unexpected detection close.	2424	detect an unexpected detection close.
2231		2425
2232	To handle this case, always make sure you have a on-empty read queue, by	2426	To handle this case, always make sure you have a non-empty read queue, by
2233	pushing the "read request start" handler on it:	2427	pushing the "read request start" handler on it:
2234		2428
2235	# we assume a request starts with a single line	2429	# we assume a request starts with a single line
2236	my @start_request; @start_request = (line => sub {	2430	my @start_request; @start_request = (line => sub {
2237	my ($hdl, $line) = @_;	2431	my ($hdl, $line) = @_;

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.232 by root, Fri Mar 30 03:11:17 2012 UTC vs. Revision 1.251 by root, Tue Feb 26 02:08:34 2019 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.232 by root, Fri Mar 30 03:11:17 2012 UTC vs.
Revision 1.251 by root, Tue Feb 26 02:08:34 2019 UTC