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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC vs.
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC

…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.331;	19	our $VERSION = 4.82;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
		31	warn "got error $_[2]\n";
32	$cv->send;	32	$cv->send;
33	},
34	);	33	);
35		34
36	# send some request line	35	# send some request line
37	$handle->push_write ("getinfo\015\012");	36	$hdl->push_write ("getinfo\015\012");
38		37
39	# read the response line	38	# read the response line
40	$handle->push_read (line => sub {	39	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	40	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	41	warn "got line <$line>\n";
43	$cv->send;	42	$cv->send;
44	});	43	});
45		44
46	$cv->recv;	45	$cv->recv;
47		46
…		…
63		62
64	=head1 METHODS	63	=head1 METHODS
65		64
66	=over 4	65	=over 4
67		66
68	=item B<new (%args)>	67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		68
70	The constructor supports these arguments (all as key => value pairs).	69	The constructor supports these arguments (all as C<< key => value >> pairs).
71		70
72	=over 4	71	=over 4
73		72
74	=item fh => $filehandle [MANDATORY]	73	=item fh => $filehandle [MANDATORY]
75		74
…		…
95	waiting for data.	94	waiting for data.
96		95
97	If an EOF condition has been detected but no C<on_eof> callback has been	96	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	97	set, then a fatal error will be raised with C<$!> set to <0>.
99		98
100	=item on_error => $cb->($handle, $fatal)	99	=item on_error => $cb->($handle, $fatal, $message)
101		100
102	This is the error callback, which is called when, well, some error	101	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to	102	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	103	connect or a read error.
105		104
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	105	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable	106	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	107	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	108	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		110
		111	AnyEvent::Handle tries to find an appropriate error code for you to check
		112	against, but in some cases (TLS errors), this does not work well. It is
		113	recommended to always output the C<$message> argument in human-readable
		114	error messages (it's usually the same as C<"$!">).
111		115
112	Non-fatal errors can be retried by simply returning, but it is recommended	116	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	117	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	118	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		120
117	On callback entrance, the value of C<$!> contains the operating system	121	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		123	C<EPROTO>).
119		124
120	While not mandatory, it is I<highly> recommended to set this callback, as	125	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls	126	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	127	C<croak>.
123		128
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	132	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the	133	callback will only be called when at least one octet of data is in the
129	read buffer).	134	read buffer).
130		135
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		138	must not enlarge or modify the read buffer, you can only remove data at
		139	the beginning from it.
133		140
134	When an EOF condition is detected then AnyEvent::Handle will first try to	141	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before	142	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal	143	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).	144	error will be raised (with C<$!> set to C<EPIPE>).
…		…
235		242
236	This will not work for partial TLS data that could not be encoded	243	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost. Calling the C<stoptls> method in time might	244	yet. This data will be lost. Calling the C<stoptls> method in time might
238	help.	245	help.
239		246
		247	=item peername => $string
		248
		249	A string used to identify the remote site - usually the DNS hostname
		250	(I<not> IDN!) used to create the connection, rarely the IP address.
		251
		252	Apart from being useful in error messages, this string is also used in TLS
		253	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		254	verification will be skipped when C<peername> is not specified or
		255	C<undef>.
		256
240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	257	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
241		258
242	When this parameter is given, it enables TLS (SSL) mode, that means	259	When this parameter is given, it enables TLS (SSL) mode, that means
243	AnyEvent will start a TLS handshake as soon as the conenction has been	260	AnyEvent will start a TLS handshake as soon as the conenction has been
244	established and will transparently encrypt/decrypt data afterwards.	261	established and will transparently encrypt/decrypt data afterwards.
		262
		263	All TLS protocol errors will be signalled as C<EPROTO>, with an
		264	appropriate error message.
245		265
246	TLS mode requires Net::SSLeay to be installed (it will be loaded	266	TLS mode requires Net::SSLeay to be installed (it will be loaded
247	automatically when you try to create a TLS handle): this module doesn't	267	automatically when you try to create a TLS handle): this module doesn't
248	have a dependency on that module, so if your module requires it, you have	268	have a dependency on that module, so if your module requires it, you have
249	to add the dependency yourself.	269	to add the dependency yourself.
…		…
253	mode.	273	mode.
254		274
255	You can also provide your own TLS connection object, but you have	275	You can also provide your own TLS connection object, but you have
256	to make sure that you call either C<Net::SSLeay::set_connect_state>	276	to make sure that you call either C<Net::SSLeay::set_connect_state>
257	or C<Net::SSLeay::set_accept_state> on it before you pass it to	277	or C<Net::SSLeay::set_accept_state> on it before you pass it to
258	AnyEvent::Handle.	278	AnyEvent::Handle. Also, this module will take ownership of this connection
		279	object.
		280
		281	At some future point, AnyEvent::Handle might switch to another TLS
		282	implementation, then the option to use your own session object will go
		283	away.
259		284
260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	285	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
261	passing in the wrong integer will lead to certain crash. This most often	286	passing in the wrong integer will lead to certain crash. This most often
262	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	287	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
263	segmentation fault.	288	segmentation fault.
264		289
265	See the C<< ->starttls >> method for when need to start TLS negotiation later.	290	See the C<< ->starttls >> method for when need to start TLS negotiation later.
266		291
267	=item tls_ctx => $ssl_ctx	292	=item tls_ctx => $anyevent_tls
268		293
269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	294	Use the given C<AnyEvent::TLS> object to create the new TLS connection
270	(unless a connection object was specified directly). If this parameter is	295	(unless a connection object was specified directly). If this parameter is
271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	296	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		297
		298	Instead of an object, you can also specify a hash reference with C<< key
		299	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		300	new TLS context object.
		301
		302	=item on_starttls => $cb->($handle, $success[, $error_message])
		303
		304	This callback will be invoked when the TLS/SSL handshake has finished. If
		305	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		306	(C<on_stoptls> will not be called in this case).
		307
		308	The session in C<< $handle->{tls} >> can still be examined in this
		309	callback, even when the handshake was not successful.
		310
		311	TLS handshake failures will not cause C<on_error> to be invoked when this
		312	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		313
		314	Without this callback, handshake failures lead to C<on_error> being
		315	called, as normal.
		316
		317	Note that you cannot call C<starttls> right again in this callback. If you
		318	need to do that, start an zero-second timer instead whose callback can
		319	then call C<< ->starttls >> again.
		320
		321	=item on_stoptls => $cb->($handle)
		322
		323	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		324	set, then it will be invoked after freeing the TLS session. If it is not,
		325	then a TLS shutdown condition will be treated like a normal EOF condition
		326	on the handle.
		327
		328	The session in C<< $handle->{tls} >> can still be examined in this
		329	callback.
		330
		331	This callback will only be called on TLS shutdowns, not when the
		332	underlying handle signals EOF.
272		333
273	=item json => JSON or JSON::XS object	334	=item json => JSON or JSON::XS object
274		335
275	This is the json coder object used by the C<json> read and write types.	336	This is the json coder object used by the C<json> read and write types.
276		337
…		…
285		346
286	=cut	347	=cut
287		348
288	sub new {	349	sub new {
289	my $class = shift;	350	my $class = shift;
290
291	my $self = bless { @_ }, $class;	351	my $self = bless { @_ }, $class;
292		352
293	$self->{fh} or Carp::croak "mandatory argument fh is missing";	353	$self->{fh} or Carp::croak "mandatory argument fh is missing";
294		354
295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	355	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		356
		357	$self->{_activity} = AnyEvent->now;
		358	$self->_timeout;
		359
		360	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
296		361
297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	362	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
298	if $self->{tls};	363	if $self->{tls};
299		364
300	$self->{_activity} = AnyEvent->now;
301	$self->_timeout;
302
303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	365	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
304	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
305		366
306	$self->start_read	367	$self->start_read
307	if $self->{on_read};	368	if $self->{on_read};
308		369
309	$self	370	$self->{fh} && $self
310	}	371	}
311		372
312	sub _shutdown {	373	#sub _shutdown {
313	my ($self) = @_;	374	# my ($self) = @_;
314		375	#
315	delete $self->{_tw};	376	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
316	delete $self->{_rw};	377	# $self->{_eof} = 1; # tell starttls et. al to stop trying
317	delete $self->{_ww};	378	#
318	delete $self->{fh};
319
320	&_freetls;	379	# &_freetls;
321		380	#}
322	delete $self->{on_read};
323	delete $self->{_queue};
324	}
325		381
326	sub _error {	382	sub _error {
327	my ($self, $errno, $fatal) = @_;	383	my ($self, $errno, $fatal, $message) = @_;
328
329	$self->_shutdown
330	if $fatal;
331		384
332	$! = $errno;	385	$! = $errno;
		386	$message \|\|= "$!";
333		387
334	if ($self->{on_error}) {	388	if ($self->{on_error}) {
335	$self->{on_error}($self, $fatal);	389	$self->{on_error}($self, $fatal, $message);
		390	$self->destroy;
336	} elsif ($self->{fh}) {	391	} elsif ($self->{fh}) {
		392	$self->destroy;
337	Carp::croak "AnyEvent::Handle uncaught error: $!";	393	Carp::croak "AnyEvent::Handle uncaught error: $message";
338	}	394	}
339	}	395	}
340		396
341	=item $fh = $handle->fh	397	=item $fh = $handle->fh
342		398
…		…
401		457
402	eval {	458	eval {
403	local $SIG{__DIE__};	459	local $SIG{__DIE__};
404	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
405	};	461	};
		462	}
		463
		464	=item $handle->on_starttls ($cb)
		465
		466	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		467
		468	=cut
		469
		470	sub on_starttls {
		471	$_[0]{on_starttls} = $_[1];
		472	}
		473
		474	=item $handle->on_stoptls ($cb)
		475
		476	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		477
		478	=cut
		479
		480	sub on_starttls {
		481	$_[0]{on_stoptls} = $_[1];
406	}	482	}
407		483
408	#############################################################################	484	#############################################################################
409		485
410	=item $handle->timeout ($seconds)	486	=item $handle->timeout ($seconds)
…		…
509	Scalar::Util::weaken $self;	585	Scalar::Util::weaken $self;
510		586
511	my $cb = sub {	587	my $cb = sub {
512	my $len = syswrite $self->{fh}, $self->{wbuf};	588	my $len = syswrite $self->{fh}, $self->{wbuf};
513		589
514	if ($len >= 0) {	590	if (defined $len) {
515	substr $self->{wbuf}, 0, $len, "";	591	substr $self->{wbuf}, 0, $len, "";
516		592
517	$self->{_activity} = AnyEvent->now;	593	$self->{_activity} = AnyEvent->now;
518		594
519	$self->{on_drain}($self)	595	$self->{on_drain}($self)
…		…
654		730
655	pack "w/a*", Storable::nfreeze ($ref)	731	pack "w/a*", Storable::nfreeze ($ref)
656	};	732	};
657		733
658	=back	734	=back
		735
		736	=item $handle->push_shutdown
		737
		738	Sometimes you know you want to close the socket after writing your data
		739	before it was actually written. One way to do that is to replace your
		740	C<on_drain> handler by a callback that shuts down the socket (and set
		741	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		742	replaces the C<on_drain> callback with:
		743
		744	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		745
		746	This simply shuts down the write side and signals an EOF condition to the
		747	the peer.
		748
		749	You can rely on the normal read queue and C<on_eof> handling
		750	afterwards. This is the cleanest way to close a connection.
		751
		752	=cut
		753
		754	sub push_shutdown {
		755	my ($self) = @_;
		756
		757	delete $self->{low_water_mark};
		758	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		759	}
659		760
660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	761	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
661		762
662	This function (not method) lets you add your own types to C<push_write>.	763	This function (not method) lets you add your own types to C<push_write>.
663	Whenever the given C<type> is used, C<push_write> will invoke the code	764	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
767	) {	868	) {
768	$self->_error (&Errno::ENOSPC, 1), return;	869	$self->_error (&Errno::ENOSPC, 1), return;
769	}	870	}
770		871
771	while () {	872	while () {
		873	# we need to use a separate tls read buffer, as we must not receive data while
		874	# we are draining the buffer, and this can only happen with TLS.
		875	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		876
772	my $len = length $self->{rbuf};	877	my $len = length $self->{rbuf};
773		878
774	if (my $cb = shift @{ $self->{_queue} }) {	879	if (my $cb = shift @{ $self->{_queue} }) {
775	unless ($cb->($self)) {	880	unless ($cb->($self)) {
776	if ($self->{_eof}) {	881	if ($self->{_eof}) {
…		…
807		912
808	if ($self->{_eof}) {	913	if ($self->{_eof}) {
809	if ($self->{on_eof}) {	914	if ($self->{on_eof}) {
810	$self->{on_eof}($self)	915	$self->{on_eof}($self)
811	} else {	916	} else {
812	$self->_error (0, 1);	917	$self->_error (0, 1, "Unexpected end-of-file");
813	}	918	}
814	}	919	}
815		920
816	# may need to restart read watcher	921	# may need to restart read watcher
817	unless ($self->{_rw}) {	922	unless ($self->{_rw}) {
…		…
837		942
838	=item $handle->rbuf	943	=item $handle->rbuf
839		944
840	Returns the read buffer (as a modifiable lvalue).	945	Returns the read buffer (as a modifiable lvalue).
841		946
842	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	947	You can access the read buffer directly as the C<< ->{rbuf} >>
843	you want.	948	member, if you want. However, the only operation allowed on the
		949	read buffer (apart from looking at it) is removing data from its
		950	beginning. Otherwise modifying or appending to it is not allowed and will
		951	lead to hard-to-track-down bugs.
844		952
845	NOTE: The read buffer should only be used or modified if the C<on_read>,	953	NOTE: The read buffer should only be used or modified if the C<on_read>,
846	C<push_read> or C<unshift_read> methods are used. The other read methods	954	C<push_read> or C<unshift_read> methods are used. The other read methods
847	automatically manage the read buffer.	955	automatically manage the read buffer.
848		956
…		…
1164	=cut	1272	=cut
1165		1273
1166	register_read_type json => sub {	1274	register_read_type json => sub {
1167	my ($self, $cb) = @_;	1275	my ($self, $cb) = @_;
1168		1276
1169	require JSON;	1277	my $json = $self->{json} \|\|=
		1278	eval { require JSON::XS; JSON::XS->new->utf8 }
		1279	\|\| do { require JSON; JSON->new->utf8 };
1170		1280
1171	my $data;	1281	my $data;
1172	my $rbuf = \$self->{rbuf};	1282	my $rbuf = \$self->{rbuf};
1173		1283
1174	my $json = $self->{json} \|\|= JSON->new->utf8;
1175
1176	sub {	1284	sub {
1177	eval {
1178	my $ref = $json->incr_parse ($self->{rbuf});	1285	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1179		1286
1180	if ($ref) {	1287	if ($ref) {
1181	$self->{rbuf} = $json->incr_text;	1288	$self->{rbuf} = $json->incr_text;
1182	$json->incr_text = "";	1289	$json->incr_text = "";
1183	$cb->($self, $ref);	1290	$cb->($self, $ref);
1184
1185	1
1186	} else {
1187	$self->{rbuf} = "";
1188	()
1189	}
1190		1291
1191	1	1292	1
1192	} or do {	1293	} elsif ($@) {
1193	# error case	1294	# error case
1194	$json->incr_skip;	1295	$json->incr_skip;
1195		1296
1196	$self->{rbuf} = $json->incr_text;	1297	$self->{rbuf} = $json->incr_text;
1197	$json->incr_text = "";	1298	$json->incr_text = "";
1198		1299
1199	$self->_error (&Errno::EBADMSG);	1300	$self->_error (&Errno::EBADMSG);
		1301
		1302	()
		1303	} else {
		1304	$self->{rbuf} = "";
		1305
		1306	()
1200	};	1307	}
1201	}	1308	}
1202	};	1309	};
1203		1310
1204	=item storable => $cb->($handle, $ref)	1311	=item storable => $cb->($handle, $ref)
1205		1312
…		…
1324	}	1431	}
1325	});	1432	});
1326	}	1433	}
1327	}	1434	}
1328		1435
		1436	our $ERROR_SYSCALL;
		1437	our $ERROR_WANT_READ;
		1438
		1439	sub _tls_error {
		1440	my ($self, $err) = @_;
		1441
		1442	return $self->_error ($!, 1)
		1443	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1444
		1445	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1446
		1447	# reduce error string to look less scary
		1448	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1449
		1450	if ($self->{_on_starttls}) {
		1451	(delete $self->{_on_starttls})->($self, undef, $err);
		1452	&_freetls;
		1453	} else {
		1454	&_freetls;
		1455	$self->_error (&Errno::EPROTO, 1, $err);
		1456	}
		1457	}
		1458
1329	# poll the write BIO and send the data if applicable	1459	# poll the write BIO and send the data if applicable
		1460	# also decode read data if possible
		1461	# this is basiclaly our TLS state machine
		1462	# more efficient implementations are possible with openssl,
		1463	# but not with the buggy and incomplete Net::SSLeay.
1330	sub _dotls {	1464	sub _dotls {
1331	my ($self) = @_;	1465	my ($self) = @_;
1332		1466
1333	my $tmp;	1467	my $tmp;
1334		1468
1335	if (length $self->{_tls_wbuf}) {	1469	if (length $self->{_tls_wbuf}) {
1336	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1470	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1337	substr $self->{_tls_wbuf}, 0, $tmp, "";	1471	substr $self->{_tls_wbuf}, 0, $tmp, "";
1338	}	1472	}
		1473
		1474	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1475	return $self->_tls_error ($tmp)
		1476	if $tmp != $ERROR_WANT_READ
		1477	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1339	}	1478	}
1340		1479
1341	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1480	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1342	unless (length $tmp) {	1481	unless (length $tmp) {
1343	# let's treat SSL-eof as we treat normal EOF	1482	$self->{_on_starttls}
1344	delete $self->{_rw};	1483	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1345	$self->{_eof} = 1;
1346	&_freetls;	1484	&_freetls;
		1485
		1486	if ($self->{on_stoptls}) {
		1487	$self->{on_stoptls}($self);
		1488	return;
		1489	} else {
		1490	# let's treat SSL-eof as we treat normal EOF
		1491	delete $self->{_rw};
		1492	$self->{_eof} = 1;
		1493	}
1347	}	1494	}
1348		1495
1349	$self->{rbuf} .= $tmp;	1496	$self->{_tls_rbuf} .= $tmp;
1350	$self->_drain_rbuf unless $self->{_in_drain};	1497	$self->_drain_rbuf unless $self->{_in_drain};
1351	$self->{tls} or return; # tls session might have gone away in callback	1498	$self->{tls} or return; # tls session might have gone away in callback
1352	}	1499	}
1353		1500
1354	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1355
1356	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1357	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1358	return $self->_error ($!, 1);	1502	return $self->_tls_error ($tmp)
1359	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1503	if $tmp != $ERROR_WANT_READ
1360	return $self->_error (&Errno::EIO, 1);	1504	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1361	}
1362
1363	# all other errors are fine for our purposes
1364	}
1365		1505
1366	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1506	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1367	$self->{wbuf} .= $tmp;	1507	$self->{wbuf} .= $tmp;
1368	$self->_drain_wbuf;	1508	$self->_drain_wbuf;
1369	}	1509	}
		1510
		1511	$self->{_on_starttls}
		1512	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1513	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1370	}	1514	}
1371		1515
1372	=item $handle->starttls ($tls[, $tls_ctx])	1516	=item $handle->starttls ($tls[, $tls_ctx])
1373		1517
1374	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1376	C<starttls>.	1520	C<starttls>.
1377		1521
1378	The first argument is the same as the C<tls> constructor argument (either	1522	The first argument is the same as the C<tls> constructor argument (either
1379	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1380		1524
1381	The second argument is the optional C<Net::SSLeay::CTX> object that is	1525	The second argument is the optional C<AnyEvent::TLS> object that is used
1382	used when AnyEvent::Handle has to create its own TLS connection object.	1526	when AnyEvent::Handle has to create its own TLS connection object, or
		1527	a hash reference with C<< key => value >> pairs that will be used to
		1528	construct a new context.
1383		1529
1384	The TLS connection object will end up in C<< $handle->{tls} >> after this	1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1385	call and can be used or changed to your liking. Note that the handshake	1531	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1386	might have already started when this function returns.	1532	changed to your liking. Note that the handshake might have already started
		1533	when this function returns.
1387		1534
1388	If it an error to start a TLS handshake more than once per	1535	If it an error to start a TLS handshake more than once per
1389	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1536	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1390		1537
1391	=cut	1538	=cut
1392		1539
		1540	our %TLS_CACHE; #TODO not yet documented, should we?
		1541
1393	sub starttls {	1542	sub starttls {
1394	my ($self, $ssl, $ctx) = @_;	1543	my ($self, $ssl, $ctx) = @_;
1395		1544
1396	require Net::SSLeay;	1545	require Net::SSLeay;
1397		1546
1398	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1399	if $self->{tls};	1548	if $self->{tls};
		1549
		1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1552
		1553	$ctx \|\|= $self->{tls_ctx};
		1554
		1555	if ("HASH" eq ref $ctx) {
		1556	require AnyEvent::TLS;
		1557
		1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1559
		1560	if ($ctx->{cache}) {
		1561	my $key = $ctx+0;
		1562	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1563	} else {
		1564	$ctx = new AnyEvent::TLS %$ctx;
		1565	}
		1566	}
1400		1567
1401	if ($ssl eq "accept") {	1568	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1402	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1403	Net::SSLeay::set_accept_state ($ssl);
1404	} elsif ($ssl eq "connect") {
1405	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1406	Net::SSLeay::set_connect_state ($ssl);
1407	}
1408
1409	$self->{tls} = $ssl;
1410		1570
1411	# basically, this is deep magic (because SSL_read should have the same issues)	1571	# basically, this is deep magic (because SSL_read should have the same issues)
1412	# but the openssl maintainers basically said: "trust us, it just works".	1572	# but the openssl maintainers basically said: "trust us, it just works".
1413	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1414	# and mismaintained ssleay-module doesn't even offer them).	1574	# and mismaintained ssleay-module doesn't even offer them).
…		…
1418	#	1578	#
1419	# note that we do not try to keep the length constant between writes as we are required to do.	1579	# note that we do not try to keep the length constant between writes as we are required to do.
1420	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1580	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1421	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1581	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1422	# have identity issues in that area.	1582	# have identity issues in that area.
1423	Net::SSLeay::CTX_set_mode ($self->{tls},	1583	# Net::SSLeay::CTX_set_mode ($ssl,
1424	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1425	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1585	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1586	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1426		1587
1427	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1428	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1429		1590
1430	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1592
		1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1594	if $self->{on_starttls};
1431		1595
1432	&_dotls; # need to trigger the initial handshake	1596	&_dotls; # need to trigger the initial handshake
1433	$self->start_read; # make sure we actually do read	1597	$self->start_read; # make sure we actually do read
1434	}	1598	}
1435		1599
…		…
1448	if ($self->{tls}) {	1612	if ($self->{tls}) {
1449	Net::SSLeay::shutdown ($self->{tls});	1613	Net::SSLeay::shutdown ($self->{tls});
1450		1614
1451	&_dotls;	1615	&_dotls;
1452		1616
1453	# we don't give a shit. no, we do, but we can't. no...	1617	# # we don't give a shit. no, we do, but we can't. no...#d#
1454	# we, we... have to use openssl :/	1618	# # we, we... have to use openssl :/#d#
1455	&_freetls;	1619	# &_freetls;#d#
1456	}	1620	}
1457	}	1621	}
1458		1622
1459	sub _freetls {	1623	sub _freetls {
1460	my ($self) = @_;	1624	my ($self) = @_;
1461		1625
1462	return unless $self->{tls};	1626	return unless $self->{tls};
1463		1627
1464	Net::SSLeay::free (delete $self->{tls});	1628	$self->{tls_ctx}->_put_session (delete $self->{tls});
1465		1629
1466	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1467	}	1631	}
1468		1632
1469	sub DESTROY {	1633	sub DESTROY {
1470	my $self = shift;	1634	my ($self) = @_;
1471		1635
1472	&_freetls;	1636	&_freetls;
1473		1637
1474	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1475		1639
…		…
1495	}	1659	}
1496		1660
1497	=item $handle->destroy	1661	=item $handle->destroy
1498		1662
1499	Shuts down the handle object as much as possible - this call ensures that	1663	Shuts down the handle object as much as possible - this call ensures that
1500	no further callbacks will be invoked and resources will be freed as much	1664	no further callbacks will be invoked and as many resources as possible
1501	as possible. You must not call any methods on the object afterwards.	1665	will be freed. You must not call any methods on the object afterwards.
1502		1666
1503	Normally, you can just "forget" any references to an AnyEvent::Handle	1667	Normally, you can just "forget" any references to an AnyEvent::Handle
1504	object and it will simply shut down. This works in fatal error and EOF	1668	object and it will simply shut down. This works in fatal error and EOF
1505	callbacks, as well as code outside. It does I<NOT> work in a read or write	1669	callbacks, as well as code outside. It does I<NOT> work in a read or write
1506	callback, so when you want to destroy the AnyEvent::Handle object from	1670	callback, so when you want to destroy the AnyEvent::Handle object from
1507	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1671	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1508	that case.	1672	that case.
1509		1673
		1674	Destroying the handle object in this way has the advantage that callbacks
		1675	will be removed as well, so if those are the only reference holders (as
		1676	is common), then one doesn't need to do anything special to break any
		1677	reference cycles.
		1678
1510	The handle might still linger in the background and write out remaining	1679	The handle might still linger in the background and write out remaining
1511	data, as specified by the C<linger> option, however.	1680	data, as specified by the C<linger> option, however.
1512		1681
1513	=cut	1682	=cut
1514		1683
…		…
1519	%$self = ();	1688	%$self = ();
1520	}	1689	}
1521		1690
1522	=item AnyEvent::Handle::TLS_CTX	1691	=item AnyEvent::Handle::TLS_CTX
1523		1692
1524	This function creates and returns the Net::SSLeay::CTX object used by	1693	This function creates and returns the AnyEvent::TLS object used by default
1525	default for TLS mode.	1694	for TLS mode.
1526		1695
1527	The context is created like this:	1696	The context is created by calling L<AnyEvent::TLS> without any arguments.
1528
1529	Net::SSLeay::load_error_strings;
1530	Net::SSLeay::SSLeay_add_ssl_algorithms;
1531	Net::SSLeay::randomize;
1532
1533	my $CTX = Net::SSLeay::CTX_new;
1534
1535	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1536		1697
1537	=cut	1698	=cut
1538		1699
1539	our $TLS_CTX;	1700	our $TLS_CTX;
1540		1701
1541	sub TLS_CTX() {	1702	sub TLS_CTX() {
1542	$TLS_CTX \|\| do {	1703	$TLS_CTX \|\|= do {
1543	require Net::SSLeay;	1704	require AnyEvent::TLS;
1544		1705
1545	Net::SSLeay::load_error_strings ();	1706	new AnyEvent::TLS
1546	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1547	Net::SSLeay::randomize ();
1548
1549	$TLS_CTX = Net::SSLeay::CTX_new ();
1550
1551	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1552
1553	$TLS_CTX
1554	}	1707	}
1555	}	1708	}
1556		1709
1557	=back	1710	=back
1558		1711
…		…
1597		1750
1598	$handle->on_read (sub { });	1751	$handle->on_read (sub { });
1599	$handle->on_eof (undef);	1752	$handle->on_eof (undef);
1600	$handle->on_error (sub {	1753	$handle->on_error (sub {
1601	my $data = delete $_[0]{rbuf};	1754	my $data = delete $_[0]{rbuf};
1602	undef $handle;
1603	});	1755	});
1604		1756
1605	The reason to use C<on_error> is that TCP connections, due to latencies	1757	The reason to use C<on_error> is that TCP connections, due to latencies
1606	and packets loss, might get closed quite violently with an error, when in	1758	and packets loss, might get closed quite violently with an error, when in
1607	fact, all data has been received.	1759	fact, all data has been received.
…		…
1623	$handle->on_drain (sub {	1775	$handle->on_drain (sub {
1624	warn "all data submitted to the kernel\n";	1776	warn "all data submitted to the kernel\n";
1625	undef $handle;	1777	undef $handle;
1626	});	1778	});
1627		1779
		1780	If you just want to queue some data and then signal EOF to the other side,
		1781	consider using C<< ->push_shutdown >> instead.
		1782
		1783	=item I want to contact a TLS/SSL server, I don't care about security.
		1784
		1785	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1786	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1787	parameter:
		1788
		1789	tcp_connect $host, $port, sub {
		1790	my ($fh) = @_;
		1791
		1792	my $handle = new AnyEvent::Handle
		1793	fh => $fh,
		1794	tls => "connect",
		1795	on_error => sub { ... };
		1796
		1797	$handle->push_write (...);
		1798	};
		1799
		1800	=item I want to contact a TLS/SSL server, I do care about security.
		1801
		1802	Then you should additionally enable certificate verification, including
		1803	peername verification, if the protocol you use supports it (see
		1804	L<AnyEvent::TLS>, C<verify_peername>).
		1805
		1806	E.g. for HTTPS:
		1807
		1808	tcp_connect $host, $port, sub {
		1809	my ($fh) = @_;
		1810
		1811	my $handle = new AnyEvent::Handle
		1812	fh => $fh,
		1813	peername => $host,
		1814	tls => "connect",
		1815	tls_ctx => { verify => 1, verify_peername => "https" },
		1816	...
		1817
		1818	Note that you must specify the hostname you connected to (or whatever
		1819	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1820	peername verification will be done.
		1821
		1822	The above will use the system-dependent default set of trusted CA
		1823	certificates. If you want to check against a specific CA, add the
		1824	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1825
		1826	tls_ctx => {
		1827	verify => 1,
		1828	verify_peername => "https",
		1829	ca_file => "my-ca-cert.pem",
		1830	},
		1831
		1832	=item I want to create a TLS/SSL server, how do I do that?
		1833
		1834	Well, you first need to get a server certificate and key. You have
		1835	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1836	self-signed certificate (cheap. check the search engine of your choice,
		1837	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1838	nice program for that purpose).
		1839
		1840	Then create a file with your private key (in PEM format, see
		1841	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1842	file should then look like this:
		1843
		1844	-----BEGIN RSA PRIVATE KEY-----
		1845	...header data
		1846	... lots of base64'y-stuff
		1847	-----END RSA PRIVATE KEY-----
		1848
		1849	-----BEGIN CERTIFICATE-----
		1850	... lots of base64'y-stuff
		1851	-----END CERTIFICATE-----
		1852
		1853	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1854	specify this file as C<cert_file>:
		1855
		1856	tcp_server undef, $port, sub {
		1857	my ($fh) = @_;
		1858
		1859	my $handle = new AnyEvent::Handle
		1860	fh => $fh,
		1861	tls => "accept",
		1862	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1863	...
		1864
		1865	When you have intermediate CA certificates that your clients might not
		1866	know about, just append them to the C<cert_file>.
		1867
1628	=back	1868	=back
1629		1869
1630		1870
1631	=head1 SUBCLASSING AnyEvent::Handle	1871	=head1 SUBCLASSING AnyEvent::Handle
1632		1872

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC vs. Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC vs.
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC