1 | package AnyEvent::Handle; |
1 | package AnyEvent::Handle; |
2 | |
2 | |
3 | no warnings; |
|
|
4 | use strict qw(subs vars); |
|
|
5 | |
|
|
6 | use AnyEvent (); |
|
|
7 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
8 | use Scalar::Util (); |
3 | use Scalar::Util (); |
9 | use Carp (); |
4 | use Carp (); |
10 | use Fcntl (); |
|
|
11 | use Errno qw(EAGAIN EINTR); |
5 | use Errno qw(EAGAIN EINTR); |
12 | |
6 | |
|
|
7 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
|
|
8 | use AnyEvent::Util qw(WSAEWOULDBLOCK); |
|
|
9 | |
13 | =head1 NAME |
10 | =head1 NAME |
14 | |
11 | |
15 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
12 | AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 | |
13 | |
17 | =cut |
14 | =cut |
18 | |
15 | |
19 | our $VERSION = 4.33; |
16 | our $VERSION = 4.87; |
20 | |
17 | |
21 | =head1 SYNOPSIS |
18 | =head1 SYNOPSIS |
22 | |
19 | |
23 | use AnyEvent; |
20 | use AnyEvent; |
24 | use AnyEvent::Handle; |
21 | use AnyEvent::Handle; |
25 | |
22 | |
26 | my $cv = AnyEvent->condvar; |
23 | my $cv = AnyEvent->condvar; |
27 | |
24 | |
28 | my $handle = |
25 | my $hdl; $hdl = new AnyEvent::Handle |
29 | AnyEvent::Handle->new ( |
|
|
30 | fh => \*STDIN, |
26 | fh => \*STDIN, |
31 | on_eof => sub { |
27 | on_error => sub { |
32 | $cv->broadcast; |
28 | my ($hdl, $fatal, $msg) = @_; |
33 | }, |
29 | warn "got error $msg\n"; |
|
|
30 | $hdl->destroy; |
|
|
31 | $cv->send; |
34 | ); |
32 | ); |
35 | |
33 | |
36 | # send some request line |
34 | # send some request line |
37 | $handle->push_write ("getinfo\015\012"); |
35 | $hdl->push_write ("getinfo\015\012"); |
38 | |
36 | |
39 | # read the response line |
37 | # read the response line |
40 | $handle->push_read (line => sub { |
38 | $hdl->push_read (line => sub { |
41 | my ($handle, $line) = @_; |
39 | my ($hdl, $line) = @_; |
42 | warn "read line <$line>\n"; |
40 | warn "got line <$line>\n"; |
43 | $cv->send; |
41 | $cv->send; |
44 | }); |
42 | }); |
45 | |
43 | |
46 | $cv->recv; |
44 | $cv->recv; |
47 | |
45 | |
48 | =head1 DESCRIPTION |
46 | =head1 DESCRIPTION |
49 | |
47 | |
50 | This module is a helper module to make it easier to do event-based I/O on |
48 | This module is a helper module to make it easier to do event-based I/O on |
51 | filehandles. For utility functions for doing non-blocking connects and accepts |
49 | filehandles. |
52 | on sockets see L<AnyEvent::Util>. |
|
|
53 | |
50 | |
54 | The L<AnyEvent::Intro> tutorial contains some well-documented |
51 | The L<AnyEvent::Intro> tutorial contains some well-documented |
55 | AnyEvent::Handle examples. |
52 | AnyEvent::Handle examples. |
56 | |
53 | |
57 | In the following, when the documentation refers to of "bytes" then this |
54 | In the following, when the documentation refers to of "bytes" then this |
58 | means characters. As sysread and syswrite are used for all I/O, their |
55 | means characters. As sysread and syswrite are used for all I/O, their |
59 | treatment of characters applies to this module as well. |
56 | treatment of characters applies to this module as well. |
60 | |
57 | |
|
|
58 | At the very minimum, you should specify C<fh> or C<connect>, and the |
|
|
59 | C<on_error> callback. |
|
|
60 | |
61 | All callbacks will be invoked with the handle object as their first |
61 | All callbacks will be invoked with the handle object as their first |
62 | argument. |
62 | argument. |
63 | |
63 | |
64 | =head1 METHODS |
64 | =head1 METHODS |
65 | |
65 | |
66 | =over 4 |
66 | =over 4 |
67 | |
67 | |
68 | =item B<new (%args)> |
68 | =item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... |
69 | |
69 | |
70 | The constructor supports these arguments (all as key => value pairs). |
70 | The constructor supports these arguments (all as C<< key => value >> pairs). |
71 | |
71 | |
72 | =over 4 |
72 | =over 4 |
73 | |
73 | |
74 | =item fh => $filehandle [MANDATORY] |
74 | =item fh => $filehandle [C<fh> or C<connect> MANDATORY] |
75 | |
75 | |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
76 | The filehandle this L<AnyEvent::Handle> object will operate on. |
77 | |
|
|
78 | NOTE: The filehandle will be set to non-blocking mode (using |
77 | NOTE: The filehandle will be set to non-blocking mode (using |
79 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
78 | C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in |
80 | that mode. |
79 | that mode. |
81 | |
80 | |
|
|
81 | =item connect => [$host, $service] [C<fh> or C<connect> MANDATORY] |
|
|
82 | |
|
|
83 | Try to connect to the specified host and service (port), using |
|
|
84 | C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the |
|
|
85 | default C<peername>. |
|
|
86 | |
|
|
87 | You have to specify either this parameter, or C<fh>, above. |
|
|
88 | |
|
|
89 | It is possible to push requests on the read and write queues, and modify |
|
|
90 | properties of the stream, even while AnyEvent::Handle is connecting. |
|
|
91 | |
|
|
92 | When this parameter is specified, then the C<on_prepare>, |
|
|
93 | C<on_connect_error> and C<on_connect> callbacks will be called under the |
|
|
94 | appropriate circumstances: |
|
|
95 | |
|
|
96 | =over 4 |
|
|
97 | |
|
|
98 | =item on_prepare => $cb->($handle) |
|
|
99 | |
|
|
100 | This (rarely used) callback is called before a new connection is |
|
|
101 | attempted, but after the file handle has been created. It could be used to |
|
|
102 | prepare the file handle with parameters required for the actual connect |
|
|
103 | (as opposed to settings that can be changed when the connection is already |
|
|
104 | established). |
|
|
105 | |
|
|
106 | The return value of this callback should be the connect timeout value in |
|
|
107 | seconds (or C<0>, or C<undef>, or the empty list, to indicate the default |
|
|
108 | timeout is to be used). |
|
|
109 | |
|
|
110 | =item on_connect => $cb->($handle, $host, $port, $retry->()) |
|
|
111 | |
|
|
112 | This callback is called when a connection has been successfully established. |
|
|
113 | |
|
|
114 | The actual numeric host and port (the socket peername) are passed as |
|
|
115 | parameters, together with a retry callback. |
|
|
116 | |
|
|
117 | When, for some reason, the handle is not acceptable, then calling |
|
|
118 | C<$retry> will continue with the next conenction target (in case of |
|
|
119 | multi-homed hosts or SRV records there can be multiple connection |
|
|
120 | endpoints). When it is called then the read and write queues, eof status, |
|
|
121 | tls status and similar properties of the handle are being reset. |
|
|
122 | |
|
|
123 | In most cases, ignoring the C<$retry> parameter is the way to go. |
|
|
124 | |
|
|
125 | =item on_connect_error => $cb->($handle, $message) |
|
|
126 | |
|
|
127 | This callback is called when the conenction could not be |
|
|
128 | established. C<$!> will contain the relevant error code, and C<$message> a |
|
|
129 | message describing it (usually the same as C<"$!">). |
|
|
130 | |
|
|
131 | If this callback isn't specified, then C<on_error> will be called with a |
|
|
132 | fatal error instead. |
|
|
133 | |
|
|
134 | =back |
|
|
135 | |
|
|
136 | =item on_error => $cb->($handle, $fatal, $message) |
|
|
137 | |
|
|
138 | This is the error callback, which is called when, well, some error |
|
|
139 | occured, such as not being able to resolve the hostname, failure to |
|
|
140 | connect or a read error. |
|
|
141 | |
|
|
142 | Some errors are fatal (which is indicated by C<$fatal> being true). On |
|
|
143 | fatal errors the handle object will be destroyed (by a call to C<< -> |
|
|
144 | destroy >>) after invoking the error callback (which means you are free to |
|
|
145 | examine the handle object). Examples of fatal errors are an EOF condition |
|
|
146 | with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In |
|
|
147 | cases where the other side can close the connection at their will it is |
|
|
148 | often easiest to not report C<EPIPE> errors in this callback. |
|
|
149 | |
|
|
150 | AnyEvent::Handle tries to find an appropriate error code for you to check |
|
|
151 | against, but in some cases (TLS errors), this does not work well. It is |
|
|
152 | recommended to always output the C<$message> argument in human-readable |
|
|
153 | error messages (it's usually the same as C<"$!">). |
|
|
154 | |
|
|
155 | Non-fatal errors can be retried by simply returning, but it is recommended |
|
|
156 | to simply ignore this parameter and instead abondon the handle object |
|
|
157 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
158 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
159 | |
|
|
160 | On callback entrance, the value of C<$!> contains the operating system |
|
|
161 | error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or |
|
|
162 | C<EPROTO>). |
|
|
163 | |
|
|
164 | While not mandatory, it is I<highly> recommended to set this callback, as |
|
|
165 | you will not be notified of errors otherwise. The default simply calls |
|
|
166 | C<croak>. |
|
|
167 | |
|
|
168 | =item on_read => $cb->($handle) |
|
|
169 | |
|
|
170 | This sets the default read callback, which is called when data arrives |
|
|
171 | and no read request is in the queue (unlike read queue callbacks, this |
|
|
172 | callback will only be called when at least one octet of data is in the |
|
|
173 | read buffer). |
|
|
174 | |
|
|
175 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
176 | method or access the C<< $handle->{rbuf} >> member directly. Note that you |
|
|
177 | must not enlarge or modify the read buffer, you can only remove data at |
|
|
178 | the beginning from it. |
|
|
179 | |
|
|
180 | When an EOF condition is detected then AnyEvent::Handle will first try to |
|
|
181 | feed all the remaining data to the queued callbacks and C<on_read> before |
|
|
182 | calling the C<on_eof> callback. If no progress can be made, then a fatal |
|
|
183 | error will be raised (with C<$!> set to C<EPIPE>). |
|
|
184 | |
|
|
185 | Note that, unlike requests in the read queue, an C<on_read> callback |
|
|
186 | doesn't mean you I<require> some data: if there is an EOF and there |
|
|
187 | are outstanding read requests then an error will be flagged. With an |
|
|
188 | C<on_read> callback, the C<on_eof> callback will be invoked. |
|
|
189 | |
82 | =item on_eof => $cb->($handle) |
190 | =item on_eof => $cb->($handle) |
83 | |
191 | |
84 | Set the callback to be called when an end-of-file condition is detected, |
192 | Set the callback to be called when an end-of-file condition is detected, |
85 | i.e. in the case of a socket, when the other side has closed the |
193 | i.e. in the case of a socket, when the other side has closed the |
86 | connection cleanly. |
194 | connection cleanly, and there are no outstanding read requests in the |
|
|
195 | queue (if there are read requests, then an EOF counts as an unexpected |
|
|
196 | connection close and will be flagged as an error). |
87 | |
197 | |
88 | For sockets, this just means that the other side has stopped sending data, |
198 | For sockets, this just means that the other side has stopped sending data, |
89 | you can still try to write data, and, in fact, one can return from the EOF |
199 | you can still try to write data, and, in fact, one can return from the EOF |
90 | callback and continue writing data, as only the read part has been shut |
200 | callback and continue writing data, as only the read part has been shut |
91 | down. |
201 | down. |
92 | |
202 | |
93 | While not mandatory, it is I<highly> recommended to set an EOF callback, |
|
|
94 | otherwise you might end up with a closed socket while you are still |
|
|
95 | waiting for data. |
|
|
96 | |
|
|
97 | If an EOF condition has been detected but no C<on_eof> callback has been |
203 | 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>. |
204 | set, then a fatal error will be raised with C<$!> set to <0>. |
99 | |
|
|
100 | =item on_error => $cb->($handle, $fatal) |
|
|
101 | |
|
|
102 | 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 |
|
|
104 | connect or a read error. |
|
|
105 | |
|
|
106 | 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 |
|
|
108 | (but you are free to look at the current C<< ->rbuf >>). Examples of fatal |
|
|
109 | errors are an EOF condition with active (but unsatisifable) read watchers |
|
|
110 | (C<EPIPE>) or I/O errors. |
|
|
111 | |
|
|
112 | 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 |
|
|
114 | when this callback is invoked. Examples of non-fatal errors are timeouts |
|
|
115 | C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). |
|
|
116 | |
|
|
117 | On callback entrance, the value of C<$!> contains the operating system |
|
|
118 | error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). |
|
|
119 | |
|
|
120 | 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 |
|
|
122 | C<croak>. |
|
|
123 | |
|
|
124 | =item on_read => $cb->($handle) |
|
|
125 | |
|
|
126 | This sets the default read callback, which is called when data arrives |
|
|
127 | 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 |
|
|
129 | read buffer). |
|
|
130 | |
|
|
131 | To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
|
|
132 | method or access the C<$handle->{rbuf}> member directly. |
|
|
133 | |
|
|
134 | 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 |
|
|
136 | 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>). |
|
|
138 | |
205 | |
139 | =item on_drain => $cb->($handle) |
206 | =item on_drain => $cb->($handle) |
140 | |
207 | |
141 | This sets the callback that is called when the write buffer becomes empty |
208 | This sets the callback that is called when the write buffer becomes empty |
142 | (or when the callback is set and the buffer is empty already). |
209 | (or when the callback is set and the buffer is empty already). |
… | |
… | |
235 | |
302 | |
236 | This will not work for partial TLS data that could not be encoded |
303 | 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 |
304 | yet. This data will be lost. Calling the C<stoptls> method in time might |
238 | help. |
305 | help. |
239 | |
306 | |
|
|
307 | =item peername => $string |
|
|
308 | |
|
|
309 | A string used to identify the remote site - usually the DNS hostname |
|
|
310 | (I<not> IDN!) used to create the connection, rarely the IP address. |
|
|
311 | |
|
|
312 | Apart from being useful in error messages, this string is also used in TLS |
|
|
313 | peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This |
|
|
314 | verification will be skipped when C<peername> is not specified or |
|
|
315 | C<undef>. |
|
|
316 | |
240 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
317 | =item tls => "accept" | "connect" | Net::SSLeay::SSL object |
241 | |
318 | |
242 | When this parameter is given, it enables TLS (SSL) mode, that means |
319 | 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 |
320 | AnyEvent will start a TLS handshake as soon as the conenction has been |
244 | established and will transparently encrypt/decrypt data afterwards. |
321 | established and will transparently encrypt/decrypt data afterwards. |
|
|
322 | |
|
|
323 | All TLS protocol errors will be signalled as C<EPROTO>, with an |
|
|
324 | appropriate error message. |
245 | |
325 | |
246 | TLS mode requires Net::SSLeay to be installed (it will be loaded |
326 | 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 |
327 | 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 |
328 | have a dependency on that module, so if your module requires it, you have |
249 | to add the dependency yourself. |
329 | to add the dependency yourself. |
… | |
… | |
253 | mode. |
333 | mode. |
254 | |
334 | |
255 | You can also provide your own TLS connection object, but you have |
335 | 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> |
336 | 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 |
337 | or C<Net::SSLeay::set_accept_state> on it before you pass it to |
258 | AnyEvent::Handle. |
338 | AnyEvent::Handle. Also, this module will take ownership of this connection |
|
|
339 | object. |
|
|
340 | |
|
|
341 | At some future point, AnyEvent::Handle might switch to another TLS |
|
|
342 | implementation, then the option to use your own session object will go |
|
|
343 | away. |
|
|
344 | |
|
|
345 | B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, |
|
|
346 | passing in the wrong integer will lead to certain crash. This most often |
|
|
347 | happens when one uses a stylish C<< tls => 1 >> and is surprised about the |
|
|
348 | segmentation fault. |
259 | |
349 | |
260 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
350 | See the C<< ->starttls >> method for when need to start TLS negotiation later. |
261 | |
351 | |
262 | =item tls_ctx => $ssl_ctx |
352 | =item tls_ctx => $anyevent_tls |
263 | |
353 | |
264 | Use the given C<Net::SSLeay::CTX> object to create the new TLS connection |
354 | Use the given C<AnyEvent::TLS> object to create the new TLS connection |
265 | (unless a connection object was specified directly). If this parameter is |
355 | (unless a connection object was specified directly). If this parameter is |
266 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
356 | missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
|
|
357 | |
|
|
358 | Instead of an object, you can also specify a hash reference with C<< key |
|
|
359 | => value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a |
|
|
360 | new TLS context object. |
|
|
361 | |
|
|
362 | =item on_starttls => $cb->($handle, $success[, $error_message]) |
|
|
363 | |
|
|
364 | This callback will be invoked when the TLS/SSL handshake has finished. If |
|
|
365 | C<$success> is true, then the TLS handshake succeeded, otherwise it failed |
|
|
366 | (C<on_stoptls> will not be called in this case). |
|
|
367 | |
|
|
368 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
369 | callback, even when the handshake was not successful. |
|
|
370 | |
|
|
371 | TLS handshake failures will not cause C<on_error> to be invoked when this |
|
|
372 | callback is in effect, instead, the error message will be passed to C<on_starttls>. |
|
|
373 | |
|
|
374 | Without this callback, handshake failures lead to C<on_error> being |
|
|
375 | called, as normal. |
|
|
376 | |
|
|
377 | Note that you cannot call C<starttls> right again in this callback. If you |
|
|
378 | need to do that, start an zero-second timer instead whose callback can |
|
|
379 | then call C<< ->starttls >> again. |
|
|
380 | |
|
|
381 | =item on_stoptls => $cb->($handle) |
|
|
382 | |
|
|
383 | When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is |
|
|
384 | set, then it will be invoked after freeing the TLS session. If it is not, |
|
|
385 | then a TLS shutdown condition will be treated like a normal EOF condition |
|
|
386 | on the handle. |
|
|
387 | |
|
|
388 | The session in C<< $handle->{tls} >> can still be examined in this |
|
|
389 | callback. |
|
|
390 | |
|
|
391 | This callback will only be called on TLS shutdowns, not when the |
|
|
392 | underlying handle signals EOF. |
267 | |
393 | |
268 | =item json => JSON or JSON::XS object |
394 | =item json => JSON or JSON::XS object |
269 | |
395 | |
270 | This is the json coder object used by the C<json> read and write types. |
396 | This is the json coder object used by the C<json> read and write types. |
271 | |
397 | |
… | |
… | |
280 | |
406 | |
281 | =cut |
407 | =cut |
282 | |
408 | |
283 | sub new { |
409 | sub new { |
284 | my $class = shift; |
410 | my $class = shift; |
285 | |
|
|
286 | my $self = bless { @_ }, $class; |
411 | my $self = bless { @_ }, $class; |
287 | |
412 | |
288 | $self->{fh} or Carp::croak "mandatory argument fh is missing"; |
413 | if ($self->{fh}) { |
|
|
414 | $self->_start; |
|
|
415 | return unless $self->{fh}; # could be gone by now |
|
|
416 | |
|
|
417 | } elsif ($self->{connect}) { |
|
|
418 | require AnyEvent::Socket; |
|
|
419 | |
|
|
420 | $self->{peername} = $self->{connect}[0] |
|
|
421 | unless exists $self->{peername}; |
|
|
422 | |
|
|
423 | $self->{_skip_drain_rbuf} = 1; |
|
|
424 | |
|
|
425 | { |
|
|
426 | Scalar::Util::weaken (my $self = $self); |
|
|
427 | |
|
|
428 | $self->{_connect} = |
|
|
429 | AnyEvent::Socket::tcp_connect ( |
|
|
430 | $self->{connect}[0], |
|
|
431 | $self->{connect}[1], |
|
|
432 | sub { |
|
|
433 | my ($fh, $host, $port, $retry) = @_; |
|
|
434 | |
|
|
435 | if ($fh) { |
|
|
436 | $self->{fh} = $fh; |
|
|
437 | |
|
|
438 | delete $self->{_skip_drain_rbuf}; |
|
|
439 | $self->_start; |
|
|
440 | |
|
|
441 | $self->{on_connect} |
|
|
442 | and $self->{on_connect}($self, $host, $port, sub { |
|
|
443 | delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; |
|
|
444 | $self->{_skip_drain_rbuf} = 1; |
|
|
445 | &$retry; |
|
|
446 | }); |
|
|
447 | |
|
|
448 | } else { |
|
|
449 | if ($self->{on_connect_error}) { |
|
|
450 | $self->{on_connect_error}($self, "$!"); |
|
|
451 | $self->destroy; |
|
|
452 | } else { |
|
|
453 | $self->_error ($!, 1); |
|
|
454 | } |
|
|
455 | } |
|
|
456 | }, |
|
|
457 | sub { |
|
|
458 | local $self->{fh} = $_[0]; |
|
|
459 | |
|
|
460 | $self->{on_prepare} |
|
|
461 | ? $self->{on_prepare}->($self) |
|
|
462 | : () |
|
|
463 | } |
|
|
464 | ); |
|
|
465 | } |
|
|
466 | |
|
|
467 | } else { |
|
|
468 | Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified"; |
|
|
469 | } |
|
|
470 | |
|
|
471 | $self |
|
|
472 | } |
|
|
473 | |
|
|
474 | sub _start { |
|
|
475 | my ($self) = @_; |
289 | |
476 | |
290 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
477 | AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
|
|
478 | |
|
|
479 | $self->{_activity} = AnyEvent->now; |
|
|
480 | $self->_timeout; |
|
|
481 | |
|
|
482 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
291 | |
483 | |
292 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
484 | $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) |
293 | if $self->{tls}; |
485 | if $self->{tls}; |
294 | |
486 | |
295 | $self->{_activity} = AnyEvent->now; |
|
|
296 | $self->_timeout; |
|
|
297 | |
|
|
298 | $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; |
487 | $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
299 | $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; |
|
|
300 | |
488 | |
301 | $self->start_read |
489 | $self->start_read |
302 | if $self->{on_read}; |
490 | if $self->{on_read} || @{ $self->{_queue} }; |
303 | |
491 | |
304 | $self |
492 | $self->_drain_wbuf; |
305 | } |
493 | } |
306 | |
494 | |
307 | sub _shutdown { |
495 | #sub _shutdown { |
308 | my ($self) = @_; |
496 | # my ($self) = @_; |
309 | |
497 | # |
310 | delete $self->{_tw}; |
498 | # delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)}; |
311 | delete $self->{_rw}; |
499 | # $self->{_eof} = 1; # tell starttls et. al to stop trying |
312 | delete $self->{_ww}; |
500 | # |
313 | delete $self->{fh}; |
|
|
314 | |
|
|
315 | &_freetls; |
501 | # &_freetls; |
316 | |
502 | #} |
317 | delete $self->{on_read}; |
|
|
318 | delete $self->{_queue}; |
|
|
319 | } |
|
|
320 | |
503 | |
321 | sub _error { |
504 | sub _error { |
322 | my ($self, $errno, $fatal) = @_; |
505 | my ($self, $errno, $fatal, $message) = @_; |
323 | |
|
|
324 | $self->_shutdown |
|
|
325 | if $fatal; |
|
|
326 | |
506 | |
327 | $! = $errno; |
507 | $! = $errno; |
|
|
508 | $message ||= "$!"; |
328 | |
509 | |
329 | if ($self->{on_error}) { |
510 | if ($self->{on_error}) { |
330 | $self->{on_error}($self, $fatal); |
511 | $self->{on_error}($self, $fatal, $message); |
|
|
512 | $self->destroy if $fatal; |
331 | } elsif ($self->{fh}) { |
513 | } elsif ($self->{fh}) { |
|
|
514 | $self->destroy; |
332 | Carp::croak "AnyEvent::Handle uncaught error: $!"; |
515 | Carp::croak "AnyEvent::Handle uncaught error: $message"; |
333 | } |
516 | } |
334 | } |
517 | } |
335 | |
518 | |
336 | =item $fh = $handle->fh |
519 | =item $fh = $handle->fh |
337 | |
520 | |
… | |
… | |
394 | sub no_delay { |
577 | sub no_delay { |
395 | $_[0]{no_delay} = $_[1]; |
578 | $_[0]{no_delay} = $_[1]; |
396 | |
579 | |
397 | eval { |
580 | eval { |
398 | local $SIG{__DIE__}; |
581 | local $SIG{__DIE__}; |
399 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]; |
582 | setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] |
|
|
583 | if $_[0]{fh}; |
400 | }; |
584 | }; |
|
|
585 | } |
|
|
586 | |
|
|
587 | =item $handle->on_starttls ($cb) |
|
|
588 | |
|
|
589 | Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). |
|
|
590 | |
|
|
591 | =cut |
|
|
592 | |
|
|
593 | sub on_starttls { |
|
|
594 | $_[0]{on_starttls} = $_[1]; |
|
|
595 | } |
|
|
596 | |
|
|
597 | =item $handle->on_stoptls ($cb) |
|
|
598 | |
|
|
599 | Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). |
|
|
600 | |
|
|
601 | =cut |
|
|
602 | |
|
|
603 | sub on_starttls { |
|
|
604 | $_[0]{on_stoptls} = $_[1]; |
401 | } |
605 | } |
402 | |
606 | |
403 | ############################################################################# |
607 | ############################################################################# |
404 | |
608 | |
405 | =item $handle->timeout ($seconds) |
609 | =item $handle->timeout ($seconds) |
… | |
… | |
418 | # reset the timeout watcher, as neccessary |
622 | # reset the timeout watcher, as neccessary |
419 | # also check for time-outs |
623 | # also check for time-outs |
420 | sub _timeout { |
624 | sub _timeout { |
421 | my ($self) = @_; |
625 | my ($self) = @_; |
422 | |
626 | |
423 | if ($self->{timeout}) { |
627 | if ($self->{timeout} && $self->{fh}) { |
424 | my $NOW = AnyEvent->now; |
628 | my $NOW = AnyEvent->now; |
425 | |
629 | |
426 | # when would the timeout trigger? |
630 | # when would the timeout trigger? |
427 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
631 | my $after = $self->{_activity} + $self->{timeout} - $NOW; |
428 | |
632 | |
… | |
… | |
431 | $self->{_activity} = $NOW; |
635 | $self->{_activity} = $NOW; |
432 | |
636 | |
433 | if ($self->{on_timeout}) { |
637 | if ($self->{on_timeout}) { |
434 | $self->{on_timeout}($self); |
638 | $self->{on_timeout}($self); |
435 | } else { |
639 | } else { |
436 | $self->_error (&Errno::ETIMEDOUT); |
640 | $self->_error (Errno::ETIMEDOUT); |
437 | } |
641 | } |
438 | |
642 | |
439 | # callback could have changed timeout value, optimise |
643 | # callback could have changed timeout value, optimise |
440 | return unless $self->{timeout}; |
644 | return unless $self->{timeout}; |
441 | |
645 | |
… | |
… | |
504 | Scalar::Util::weaken $self; |
708 | Scalar::Util::weaken $self; |
505 | |
709 | |
506 | my $cb = sub { |
710 | my $cb = sub { |
507 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
711 | my $len = syswrite $self->{fh}, $self->{wbuf}; |
508 | |
712 | |
509 | if ($len >= 0) { |
713 | if (defined $len) { |
510 | substr $self->{wbuf}, 0, $len, ""; |
714 | substr $self->{wbuf}, 0, $len, ""; |
511 | |
715 | |
512 | $self->{_activity} = AnyEvent->now; |
716 | $self->{_activity} = AnyEvent->now; |
513 | |
717 | |
514 | $self->{on_drain}($self) |
718 | $self->{on_drain}($self) |
… | |
… | |
546 | ->($self, @_); |
750 | ->($self, @_); |
547 | } |
751 | } |
548 | |
752 | |
549 | if ($self->{tls}) { |
753 | if ($self->{tls}) { |
550 | $self->{_tls_wbuf} .= $_[0]; |
754 | $self->{_tls_wbuf} .= $_[0]; |
551 | |
755 | &_dotls ($self) if $self->{fh}; |
552 | &_dotls ($self); |
|
|
553 | } else { |
756 | } else { |
554 | $self->{wbuf} .= $_[0]; |
757 | $self->{wbuf} .= $_[0]; |
555 | $self->_drain_wbuf; |
758 | $self->_drain_wbuf if $self->{fh}; |
556 | } |
759 | } |
557 | } |
760 | } |
558 | |
761 | |
559 | =item $handle->push_write (type => @args) |
762 | =item $handle->push_write (type => @args) |
560 | |
763 | |
… | |
… | |
649 | |
852 | |
650 | pack "w/a*", Storable::nfreeze ($ref) |
853 | pack "w/a*", Storable::nfreeze ($ref) |
651 | }; |
854 | }; |
652 | |
855 | |
653 | =back |
856 | =back |
|
|
857 | |
|
|
858 | =item $handle->push_shutdown |
|
|
859 | |
|
|
860 | Sometimes you know you want to close the socket after writing your data |
|
|
861 | before it was actually written. One way to do that is to replace your |
|
|
862 | C<on_drain> handler by a callback that shuts down the socket (and set |
|
|
863 | C<low_water_mark> to C<0>). This method is a shorthand for just that, and |
|
|
864 | replaces the C<on_drain> callback with: |
|
|
865 | |
|
|
866 | sub { shutdown $_[0]{fh}, 1 } # for push_shutdown |
|
|
867 | |
|
|
868 | This simply shuts down the write side and signals an EOF condition to the |
|
|
869 | the peer. |
|
|
870 | |
|
|
871 | You can rely on the normal read queue and C<on_eof> handling |
|
|
872 | afterwards. This is the cleanest way to close a connection. |
|
|
873 | |
|
|
874 | =cut |
|
|
875 | |
|
|
876 | sub push_shutdown { |
|
|
877 | my ($self) = @_; |
|
|
878 | |
|
|
879 | delete $self->{low_water_mark}; |
|
|
880 | $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); |
|
|
881 | } |
654 | |
882 | |
655 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
883 | =item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) |
656 | |
884 | |
657 | This function (not method) lets you add your own types to C<push_write>. |
885 | This function (not method) lets you add your own types to C<push_write>. |
658 | Whenever the given C<type> is used, C<push_write> will invoke the code |
886 | Whenever the given C<type> is used, C<push_write> will invoke the code |
… | |
… | |
752 | =cut |
980 | =cut |
753 | |
981 | |
754 | sub _drain_rbuf { |
982 | sub _drain_rbuf { |
755 | my ($self) = @_; |
983 | my ($self) = @_; |
756 | |
984 | |
|
|
985 | # avoid recursion |
|
|
986 | return if exists $self->{_skip_drain_rbuf}; |
757 | local $self->{_in_drain} = 1; |
987 | local $self->{_skip_drain_rbuf} = 1; |
758 | |
988 | |
759 | if ( |
989 | if ( |
760 | defined $self->{rbuf_max} |
990 | defined $self->{rbuf_max} |
761 | && $self->{rbuf_max} < length $self->{rbuf} |
991 | && $self->{rbuf_max} < length $self->{rbuf} |
762 | ) { |
992 | ) { |
763 | $self->_error (&Errno::ENOSPC, 1), return; |
993 | $self->_error (Errno::ENOSPC, 1), return; |
764 | } |
994 | } |
765 | |
995 | |
766 | while () { |
996 | while () { |
|
|
997 | # we need to use a separate tls read buffer, as we must not receive data while |
|
|
998 | # we are draining the buffer, and this can only happen with TLS. |
|
|
999 | $self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf}; |
|
|
1000 | |
767 | my $len = length $self->{rbuf}; |
1001 | my $len = length $self->{rbuf}; |
768 | |
1002 | |
769 | if (my $cb = shift @{ $self->{_queue} }) { |
1003 | if (my $cb = shift @{ $self->{_queue} }) { |
770 | unless ($cb->($self)) { |
1004 | unless ($cb->($self)) { |
771 | if ($self->{_eof}) { |
1005 | if ($self->{_eof}) { |
772 | # no progress can be made (not enough data and no data forthcoming) |
1006 | # no progress can be made (not enough data and no data forthcoming) |
773 | $self->_error (&Errno::EPIPE, 1), return; |
1007 | $self->_error (Errno::EPIPE, 1), return; |
774 | } |
1008 | } |
775 | |
1009 | |
776 | unshift @{ $self->{_queue} }, $cb; |
1010 | unshift @{ $self->{_queue} }, $cb; |
777 | last; |
1011 | last; |
778 | } |
1012 | } |
… | |
… | |
786 | && !@{ $self->{_queue} } # and the queue is still empty |
1020 | && !@{ $self->{_queue} } # and the queue is still empty |
787 | && $self->{on_read} # but we still have on_read |
1021 | && $self->{on_read} # but we still have on_read |
788 | ) { |
1022 | ) { |
789 | # no further data will arrive |
1023 | # no further data will arrive |
790 | # so no progress can be made |
1024 | # so no progress can be made |
791 | $self->_error (&Errno::EPIPE, 1), return |
1025 | $self->_error (Errno::EPIPE, 1), return |
792 | if $self->{_eof}; |
1026 | if $self->{_eof}; |
793 | |
1027 | |
794 | last; # more data might arrive |
1028 | last; # more data might arrive |
795 | } |
1029 | } |
796 | } else { |
1030 | } else { |
… | |
… | |
802 | |
1036 | |
803 | if ($self->{_eof}) { |
1037 | if ($self->{_eof}) { |
804 | if ($self->{on_eof}) { |
1038 | if ($self->{on_eof}) { |
805 | $self->{on_eof}($self) |
1039 | $self->{on_eof}($self) |
806 | } else { |
1040 | } else { |
807 | $self->_error (0, 1); |
1041 | $self->_error (0, 1, "Unexpected end-of-file"); |
808 | } |
1042 | } |
809 | } |
1043 | } |
810 | |
1044 | |
811 | # may need to restart read watcher |
1045 | # may need to restart read watcher |
812 | unless ($self->{_rw}) { |
1046 | unless ($self->{_rw}) { |
… | |
… | |
825 | |
1059 | |
826 | sub on_read { |
1060 | sub on_read { |
827 | my ($self, $cb) = @_; |
1061 | my ($self, $cb) = @_; |
828 | |
1062 | |
829 | $self->{on_read} = $cb; |
1063 | $self->{on_read} = $cb; |
830 | $self->_drain_rbuf if $cb && !$self->{_in_drain}; |
1064 | $self->_drain_rbuf if $cb; |
831 | } |
1065 | } |
832 | |
1066 | |
833 | =item $handle->rbuf |
1067 | =item $handle->rbuf |
834 | |
1068 | |
835 | Returns the read buffer (as a modifiable lvalue). |
1069 | Returns the read buffer (as a modifiable lvalue). |
836 | |
1070 | |
837 | You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
1071 | You can access the read buffer directly as the C<< ->{rbuf} >> |
838 | you want. |
1072 | member, if you want. However, the only operation allowed on the |
|
|
1073 | read buffer (apart from looking at it) is removing data from its |
|
|
1074 | beginning. Otherwise modifying or appending to it is not allowed and will |
|
|
1075 | lead to hard-to-track-down bugs. |
839 | |
1076 | |
840 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
1077 | NOTE: The read buffer should only be used or modified if the C<on_read>, |
841 | C<push_read> or C<unshift_read> methods are used. The other read methods |
1078 | C<push_read> or C<unshift_read> methods are used. The other read methods |
842 | automatically manage the read buffer. |
1079 | automatically manage the read buffer. |
843 | |
1080 | |
… | |
… | |
884 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
1121 | $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") |
885 | ->($self, $cb, @_); |
1122 | ->($self, $cb, @_); |
886 | } |
1123 | } |
887 | |
1124 | |
888 | push @{ $self->{_queue} }, $cb; |
1125 | push @{ $self->{_queue} }, $cb; |
889 | $self->_drain_rbuf unless $self->{_in_drain}; |
1126 | $self->_drain_rbuf; |
890 | } |
1127 | } |
891 | |
1128 | |
892 | sub unshift_read { |
1129 | sub unshift_read { |
893 | my $self = shift; |
1130 | my $self = shift; |
894 | my $cb = pop; |
1131 | my $cb = pop; |
… | |
… | |
900 | ->($self, $cb, @_); |
1137 | ->($self, $cb, @_); |
901 | } |
1138 | } |
902 | |
1139 | |
903 | |
1140 | |
904 | unshift @{ $self->{_queue} }, $cb; |
1141 | unshift @{ $self->{_queue} }, $cb; |
905 | $self->_drain_rbuf unless $self->{_in_drain}; |
1142 | $self->_drain_rbuf; |
906 | } |
1143 | } |
907 | |
1144 | |
908 | =item $handle->push_read (type => @args, $cb) |
1145 | =item $handle->push_read (type => @args, $cb) |
909 | |
1146 | |
910 | =item $handle->unshift_read (type => @args, $cb) |
1147 | =item $handle->unshift_read (type => @args, $cb) |
… | |
… | |
1043 | return 1; |
1280 | return 1; |
1044 | } |
1281 | } |
1045 | |
1282 | |
1046 | # reject |
1283 | # reject |
1047 | if ($reject && $$rbuf =~ $reject) { |
1284 | if ($reject && $$rbuf =~ $reject) { |
1048 | $self->_error (&Errno::EBADMSG); |
1285 | $self->_error (Errno::EBADMSG); |
1049 | } |
1286 | } |
1050 | |
1287 | |
1051 | # skip |
1288 | # skip |
1052 | if ($skip && $$rbuf =~ $skip) { |
1289 | if ($skip && $$rbuf =~ $skip) { |
1053 | $data .= substr $$rbuf, 0, $+[0], ""; |
1290 | $data .= substr $$rbuf, 0, $+[0], ""; |
… | |
… | |
1069 | my ($self, $cb) = @_; |
1306 | my ($self, $cb) = @_; |
1070 | |
1307 | |
1071 | sub { |
1308 | sub { |
1072 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1309 | unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) { |
1073 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1310 | if ($_[0]{rbuf} =~ /[^0-9]/) { |
1074 | $self->_error (&Errno::EBADMSG); |
1311 | $self->_error (Errno::EBADMSG); |
1075 | } |
1312 | } |
1076 | return; |
1313 | return; |
1077 | } |
1314 | } |
1078 | |
1315 | |
1079 | my $len = $1; |
1316 | my $len = $1; |
… | |
… | |
1082 | my $string = $_[1]; |
1319 | my $string = $_[1]; |
1083 | $_[0]->unshift_read (chunk => 1, sub { |
1320 | $_[0]->unshift_read (chunk => 1, sub { |
1084 | if ($_[1] eq ",") { |
1321 | if ($_[1] eq ",") { |
1085 | $cb->($_[0], $string); |
1322 | $cb->($_[0], $string); |
1086 | } else { |
1323 | } else { |
1087 | $self->_error (&Errno::EBADMSG); |
1324 | $self->_error (Errno::EBADMSG); |
1088 | } |
1325 | } |
1089 | }); |
1326 | }); |
1090 | }); |
1327 | }); |
1091 | |
1328 | |
1092 | 1 |
1329 | 1 |
… | |
… | |
1139 | } |
1376 | } |
1140 | }; |
1377 | }; |
1141 | |
1378 | |
1142 | =item json => $cb->($handle, $hash_or_arrayref) |
1379 | =item json => $cb->($handle, $hash_or_arrayref) |
1143 | |
1380 | |
1144 | Reads a JSON object or array, decodes it and passes it to the callback. |
1381 | Reads a JSON object or array, decodes it and passes it to the |
|
|
1382 | callback. When a parse error occurs, an C<EBADMSG> error will be raised. |
1145 | |
1383 | |
1146 | If a C<json> object was passed to the constructor, then that will be used |
1384 | If a C<json> object was passed to the constructor, then that will be used |
1147 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1385 | for the final decode, otherwise it will create a JSON coder expecting UTF-8. |
1148 | |
1386 | |
1149 | This read type uses the incremental parser available with JSON version |
1387 | This read type uses the incremental parser available with JSON version |
… | |
… | |
1158 | =cut |
1396 | =cut |
1159 | |
1397 | |
1160 | register_read_type json => sub { |
1398 | register_read_type json => sub { |
1161 | my ($self, $cb) = @_; |
1399 | my ($self, $cb) = @_; |
1162 | |
1400 | |
1163 | require JSON; |
1401 | my $json = $self->{json} ||= |
|
|
1402 | eval { require JSON::XS; JSON::XS->new->utf8 } |
|
|
1403 | || do { require JSON; JSON->new->utf8 }; |
1164 | |
1404 | |
1165 | my $data; |
1405 | my $data; |
1166 | my $rbuf = \$self->{rbuf}; |
1406 | my $rbuf = \$self->{rbuf}; |
1167 | |
1407 | |
1168 | my $json = $self->{json} ||= JSON->new->utf8; |
|
|
1169 | |
|
|
1170 | sub { |
1408 | sub { |
1171 | my $ref = $json->incr_parse ($self->{rbuf}); |
1409 | my $ref = eval { $json->incr_parse ($self->{rbuf}) }; |
1172 | |
1410 | |
1173 | if ($ref) { |
1411 | if ($ref) { |
1174 | $self->{rbuf} = $json->incr_text; |
1412 | $self->{rbuf} = $json->incr_text; |
1175 | $json->incr_text = ""; |
1413 | $json->incr_text = ""; |
1176 | $cb->($self, $ref); |
1414 | $cb->($self, $ref); |
1177 | |
1415 | |
1178 | 1 |
1416 | 1 |
|
|
1417 | } elsif ($@) { |
|
|
1418 | # error case |
|
|
1419 | $json->incr_skip; |
|
|
1420 | |
|
|
1421 | $self->{rbuf} = $json->incr_text; |
|
|
1422 | $json->incr_text = ""; |
|
|
1423 | |
|
|
1424 | $self->_error (Errno::EBADMSG); |
|
|
1425 | |
|
|
1426 | () |
1179 | } else { |
1427 | } else { |
1180 | $self->{rbuf} = ""; |
1428 | $self->{rbuf} = ""; |
|
|
1429 | |
1181 | () |
1430 | () |
1182 | } |
1431 | } |
1183 | } |
1432 | } |
1184 | }; |
1433 | }; |
1185 | |
1434 | |
… | |
… | |
1217 | # read remaining chunk |
1466 | # read remaining chunk |
1218 | $_[0]->unshift_read (chunk => $len, sub { |
1467 | $_[0]->unshift_read (chunk => $len, sub { |
1219 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1468 | if (my $ref = eval { Storable::thaw ($_[1]) }) { |
1220 | $cb->($_[0], $ref); |
1469 | $cb->($_[0], $ref); |
1221 | } else { |
1470 | } else { |
1222 | $self->_error (&Errno::EBADMSG); |
1471 | $self->_error (Errno::EBADMSG); |
1223 | } |
1472 | } |
1224 | }); |
1473 | }); |
1225 | } |
1474 | } |
1226 | |
1475 | |
1227 | 1 |
1476 | 1 |
… | |
… | |
1291 | if ($self->{tls}) { |
1540 | if ($self->{tls}) { |
1292 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1541 | Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); |
1293 | |
1542 | |
1294 | &_dotls ($self); |
1543 | &_dotls ($self); |
1295 | } else { |
1544 | } else { |
1296 | $self->_drain_rbuf unless $self->{_in_drain}; |
1545 | $self->_drain_rbuf; |
1297 | } |
1546 | } |
1298 | |
1547 | |
1299 | } elsif (defined $len) { |
1548 | } elsif (defined $len) { |
1300 | delete $self->{_rw}; |
1549 | delete $self->{_rw}; |
1301 | $self->{_eof} = 1; |
1550 | $self->{_eof} = 1; |
1302 | $self->_drain_rbuf unless $self->{_in_drain}; |
1551 | $self->_drain_rbuf; |
1303 | |
1552 | |
1304 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1553 | } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { |
1305 | return $self->_error ($!, 1); |
1554 | return $self->_error ($!, 1); |
1306 | } |
1555 | } |
1307 | }); |
1556 | }); |
1308 | } |
1557 | } |
1309 | } |
1558 | } |
1310 | |
1559 | |
|
|
1560 | our $ERROR_SYSCALL; |
|
|
1561 | our $ERROR_WANT_READ; |
|
|
1562 | |
|
|
1563 | sub _tls_error { |
|
|
1564 | my ($self, $err) = @_; |
|
|
1565 | |
|
|
1566 | return $self->_error ($!, 1) |
|
|
1567 | if $err == Net::SSLeay::ERROR_SYSCALL (); |
|
|
1568 | |
|
|
1569 | my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()); |
|
|
1570 | |
|
|
1571 | # reduce error string to look less scary |
|
|
1572 | $err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /; |
|
|
1573 | |
|
|
1574 | if ($self->{_on_starttls}) { |
|
|
1575 | (delete $self->{_on_starttls})->($self, undef, $err); |
|
|
1576 | &_freetls; |
|
|
1577 | } else { |
|
|
1578 | &_freetls; |
|
|
1579 | $self->_error (Errno::EPROTO, 1, $err); |
|
|
1580 | } |
|
|
1581 | } |
|
|
1582 | |
1311 | # poll the write BIO and send the data if applicable |
1583 | # poll the write BIO and send the data if applicable |
|
|
1584 | # also decode read data if possible |
|
|
1585 | # this is basiclaly our TLS state machine |
|
|
1586 | # more efficient implementations are possible with openssl, |
|
|
1587 | # but not with the buggy and incomplete Net::SSLeay. |
1312 | sub _dotls { |
1588 | sub _dotls { |
1313 | my ($self) = @_; |
1589 | my ($self) = @_; |
1314 | |
1590 | |
1315 | my $tmp; |
1591 | my $tmp; |
1316 | |
1592 | |
1317 | if (length $self->{_tls_wbuf}) { |
1593 | if (length $self->{_tls_wbuf}) { |
1318 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1594 | while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { |
1319 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1595 | substr $self->{_tls_wbuf}, 0, $tmp, ""; |
1320 | } |
1596 | } |
|
|
1597 | |
|
|
1598 | $tmp = Net::SSLeay::get_error ($self->{tls}, $tmp); |
|
|
1599 | return $self->_tls_error ($tmp) |
|
|
1600 | if $tmp != $ERROR_WANT_READ |
|
|
1601 | && ($tmp != $ERROR_SYSCALL || $!); |
1321 | } |
1602 | } |
1322 | |
1603 | |
1323 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1604 | while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) { |
1324 | unless (length $tmp) { |
1605 | unless (length $tmp) { |
1325 | # let's treat SSL-eof as we treat normal EOF |
1606 | $self->{_on_starttls} |
1326 | delete $self->{_rw}; |
1607 | and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ??? |
1327 | $self->{_eof} = 1; |
|
|
1328 | &_freetls; |
1608 | &_freetls; |
|
|
1609 | |
|
|
1610 | if ($self->{on_stoptls}) { |
|
|
1611 | $self->{on_stoptls}($self); |
|
|
1612 | return; |
|
|
1613 | } else { |
|
|
1614 | # let's treat SSL-eof as we treat normal EOF |
|
|
1615 | delete $self->{_rw}; |
|
|
1616 | $self->{_eof} = 1; |
|
|
1617 | } |
1329 | } |
1618 | } |
1330 | |
1619 | |
1331 | $self->{rbuf} .= $tmp; |
1620 | $self->{_tls_rbuf} .= $tmp; |
1332 | $self->_drain_rbuf unless $self->{_in_drain}; |
1621 | $self->_drain_rbuf; |
1333 | $self->{tls} or return; # tls session might have gone away in callback |
1622 | $self->{tls} or return; # tls session might have gone away in callback |
1334 | } |
1623 | } |
1335 | |
1624 | |
1336 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1625 | $tmp = Net::SSLeay::get_error ($self->{tls}, -1); |
1337 | |
|
|
1338 | if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) { |
|
|
1339 | if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) { |
|
|
1340 | return $self->_error ($!, 1); |
1626 | return $self->_tls_error ($tmp) |
1341 | } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) { |
1627 | if $tmp != $ERROR_WANT_READ |
1342 | return $self->_error (&Errno::EIO, 1); |
1628 | && ($tmp != $ERROR_SYSCALL || $!); |
1343 | } |
|
|
1344 | |
|
|
1345 | # all other errors are fine for our purposes |
|
|
1346 | } |
|
|
1347 | |
1629 | |
1348 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1630 | while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { |
1349 | $self->{wbuf} .= $tmp; |
1631 | $self->{wbuf} .= $tmp; |
1350 | $self->_drain_wbuf; |
1632 | $self->_drain_wbuf; |
1351 | } |
1633 | } |
|
|
1634 | |
|
|
1635 | $self->{_on_starttls} |
|
|
1636 | and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () |
|
|
1637 | and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); |
1352 | } |
1638 | } |
1353 | |
1639 | |
1354 | =item $handle->starttls ($tls[, $tls_ctx]) |
1640 | =item $handle->starttls ($tls[, $tls_ctx]) |
1355 | |
1641 | |
1356 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1642 | Instead of starting TLS negotiation immediately when the AnyEvent::Handle |
1357 | object is created, you can also do that at a later time by calling |
1643 | object is created, you can also do that at a later time by calling |
1358 | C<starttls>. |
1644 | C<starttls>. |
1359 | |
1645 | |
|
|
1646 | Starting TLS is currently an asynchronous operation - when you push some |
|
|
1647 | write data and then call C<< ->starttls >> then TLS negotiation will start |
|
|
1648 | immediately, after which the queued write data is then sent. |
|
|
1649 | |
1360 | The first argument is the same as the C<tls> constructor argument (either |
1650 | The first argument is the same as the C<tls> constructor argument (either |
1361 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1651 | C<"connect">, C<"accept"> or an existing Net::SSLeay object). |
1362 | |
1652 | |
1363 | The second argument is the optional C<Net::SSLeay::CTX> object that is |
1653 | The second argument is the optional C<AnyEvent::TLS> object that is used |
1364 | used when AnyEvent::Handle has to create its own TLS connection object. |
1654 | when AnyEvent::Handle has to create its own TLS connection object, or |
|
|
1655 | a hash reference with C<< key => value >> pairs that will be used to |
|
|
1656 | construct a new context. |
1365 | |
1657 | |
1366 | The TLS connection object will end up in C<< $handle->{tls} >> after this |
1658 | The TLS connection object will end up in C<< $handle->{tls} >>, the TLS |
1367 | call and can be used or changed to your liking. Note that the handshake |
1659 | context in C<< $handle->{tls_ctx} >> after this call and can be used or |
1368 | might have already started when this function returns. |
1660 | changed to your liking. Note that the handshake might have already started |
|
|
1661 | when this function returns. |
1369 | |
1662 | |
1370 | If it an error to start a TLS handshake more than once per |
1663 | Due to bugs in OpenSSL, it might or might not be possible to do multiple |
1371 | AnyEvent::Handle object (this is due to bugs in OpenSSL). |
1664 | handshakes on the same stream. Best do not attempt to use the stream after |
|
|
1665 | stopping TLS. |
1372 | |
1666 | |
1373 | =cut |
1667 | =cut |
|
|
1668 | |
|
|
1669 | our %TLS_CACHE; #TODO not yet documented, should we? |
1374 | |
1670 | |
1375 | sub starttls { |
1671 | sub starttls { |
1376 | my ($self, $ssl, $ctx) = @_; |
1672 | my ($self, $tls, $ctx) = @_; |
|
|
1673 | |
|
|
1674 | Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught" |
|
|
1675 | if $self->{tls}; |
|
|
1676 | |
|
|
1677 | $self->{tls} = $tls; |
|
|
1678 | $self->{tls_ctx} = $ctx if @_ > 2; |
|
|
1679 | |
|
|
1680 | return unless $self->{fh}; |
1377 | |
1681 | |
1378 | require Net::SSLeay; |
1682 | require Net::SSLeay; |
1379 | |
1683 | |
1380 | Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object" |
1684 | $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); |
|
|
1685 | $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); |
|
|
1686 | |
1381 | if $self->{tls}; |
1687 | $tls = $self->{tls}; |
|
|
1688 | $ctx = $self->{tls_ctx}; |
|
|
1689 | |
|
|
1690 | local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session |
|
|
1691 | |
|
|
1692 | if ("HASH" eq ref $ctx) { |
|
|
1693 | require AnyEvent::TLS; |
|
|
1694 | |
|
|
1695 | if ($ctx->{cache}) { |
|
|
1696 | my $key = $ctx+0; |
|
|
1697 | $ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx; |
|
|
1698 | } else { |
|
|
1699 | $ctx = new AnyEvent::TLS %$ctx; |
|
|
1700 | } |
|
|
1701 | } |
1382 | |
1702 | |
1383 | if ($ssl eq "accept") { |
1703 | $self->{tls_ctx} = $ctx || TLS_CTX (); |
1384 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
1704 | $self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername}); |
1385 | Net::SSLeay::set_accept_state ($ssl); |
|
|
1386 | } elsif ($ssl eq "connect") { |
|
|
1387 | $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
|
|
1388 | Net::SSLeay::set_connect_state ($ssl); |
|
|
1389 | } |
|
|
1390 | |
|
|
1391 | $self->{tls} = $ssl; |
|
|
1392 | |
1705 | |
1393 | # basically, this is deep magic (because SSL_read should have the same issues) |
1706 | # basically, this is deep magic (because SSL_read should have the same issues) |
1394 | # but the openssl maintainers basically said: "trust us, it just works". |
1707 | # but the openssl maintainers basically said: "trust us, it just works". |
1395 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1708 | # (unfortunately, we have to hardcode constants because the abysmally misdesigned |
1396 | # and mismaintained ssleay-module doesn't even offer them). |
1709 | # and mismaintained ssleay-module doesn't even offer them). |
… | |
… | |
1400 | # |
1713 | # |
1401 | # note that we do not try to keep the length constant between writes as we are required to do. |
1714 | # note that we do not try to keep the length constant between writes as we are required to do. |
1402 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1715 | # we assume that most (but not all) of this insanity only applies to non-blocking cases, |
1403 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1716 | # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to |
1404 | # have identity issues in that area. |
1717 | # have identity issues in that area. |
1405 | Net::SSLeay::CTX_set_mode ($self->{tls}, |
1718 | # Net::SSLeay::CTX_set_mode ($ssl, |
1406 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1719 | # (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
1407 | | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
1720 | # | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
|
|
1721 | Net::SSLeay::CTX_set_mode ($tls, 1|2); |
1408 | |
1722 | |
1409 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1723 | $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1410 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1724 | $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
1411 | |
1725 | |
1412 | Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); |
1726 | Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); |
|
|
1727 | |
|
|
1728 | $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } |
|
|
1729 | if $self->{on_starttls}; |
1413 | |
1730 | |
1414 | &_dotls; # need to trigger the initial handshake |
1731 | &_dotls; # need to trigger the initial handshake |
1415 | $self->start_read; # make sure we actually do read |
1732 | $self->start_read; # make sure we actually do read |
1416 | } |
1733 | } |
1417 | |
1734 | |
1418 | =item $handle->stoptls |
1735 | =item $handle->stoptls |
1419 | |
1736 | |
1420 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1737 | Shuts down the SSL connection - this makes a proper EOF handshake by |
1421 | sending a close notify to the other side, but since OpenSSL doesn't |
1738 | sending a close notify to the other side, but since OpenSSL doesn't |
1422 | support non-blocking shut downs, it is not possible to re-use the stream |
1739 | support non-blocking shut downs, it is not guarenteed that you can re-use |
1423 | afterwards. |
1740 | the stream afterwards. |
1424 | |
1741 | |
1425 | =cut |
1742 | =cut |
1426 | |
1743 | |
1427 | sub stoptls { |
1744 | sub stoptls { |
1428 | my ($self) = @_; |
1745 | my ($self) = @_; |
… | |
… | |
1430 | if ($self->{tls}) { |
1747 | if ($self->{tls}) { |
1431 | Net::SSLeay::shutdown ($self->{tls}); |
1748 | Net::SSLeay::shutdown ($self->{tls}); |
1432 | |
1749 | |
1433 | &_dotls; |
1750 | &_dotls; |
1434 | |
1751 | |
1435 | # we don't give a shit. no, we do, but we can't. no... |
1752 | # # we don't give a shit. no, we do, but we can't. no...#d# |
1436 | # we, we... have to use openssl :/ |
1753 | # # we, we... have to use openssl :/#d# |
1437 | &_freetls; |
1754 | # &_freetls;#d# |
1438 | } |
1755 | } |
1439 | } |
1756 | } |
1440 | |
1757 | |
1441 | sub _freetls { |
1758 | sub _freetls { |
1442 | my ($self) = @_; |
1759 | my ($self) = @_; |
1443 | |
1760 | |
1444 | return unless $self->{tls}; |
1761 | return unless $self->{tls}; |
1445 | |
1762 | |
1446 | Net::SSLeay::free (delete $self->{tls}); |
1763 | $self->{tls_ctx}->_put_session (delete $self->{tls}) |
|
|
1764 | if ref $self->{tls}; |
1447 | |
1765 | |
1448 | delete @$self{qw(_rbio _wbio _tls_wbuf)}; |
1766 | delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; |
1449 | } |
1767 | } |
1450 | |
1768 | |
1451 | sub DESTROY { |
1769 | sub DESTROY { |
1452 | my $self = shift; |
1770 | my ($self) = @_; |
1453 | |
1771 | |
1454 | &_freetls; |
1772 | &_freetls; |
1455 | |
1773 | |
1456 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1774 | my $linger = exists $self->{linger} ? $self->{linger} : 3600; |
1457 | |
1775 | |
1458 | if ($linger && length $self->{wbuf}) { |
1776 | if ($linger && length $self->{wbuf} && $self->{fh}) { |
1459 | my $fh = delete $self->{fh}; |
1777 | my $fh = delete $self->{fh}; |
1460 | my $wbuf = delete $self->{wbuf}; |
1778 | my $wbuf = delete $self->{wbuf}; |
1461 | |
1779 | |
1462 | my @linger; |
1780 | my @linger; |
1463 | |
1781 | |
… | |
… | |
1477 | } |
1795 | } |
1478 | |
1796 | |
1479 | =item $handle->destroy |
1797 | =item $handle->destroy |
1480 | |
1798 | |
1481 | Shuts down the handle object as much as possible - this call ensures that |
1799 | Shuts down the handle object as much as possible - this call ensures that |
1482 | no further callbacks will be invoked and resources will be freed as much |
1800 | no further callbacks will be invoked and as many resources as possible |
1483 | as possible. You must not call any methods on the object afterwards. |
1801 | will be freed. You must not call any methods on the object afterwards. |
1484 | |
1802 | |
1485 | Normally, you can just "forget" any references to an AnyEvent::Handle |
1803 | Normally, you can just "forget" any references to an AnyEvent::Handle |
1486 | object and it will simply shut down. This works in fatal error and EOF |
1804 | object and it will simply shut down. This works in fatal error and EOF |
1487 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1805 | callbacks, as well as code outside. It does I<NOT> work in a read or write |
1488 | callback, so when you want to destroy the AnyEvent::Handle object from |
1806 | callback, so when you want to destroy the AnyEvent::Handle object from |
1489 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
1807 | within such an callback. You I<MUST> call C<< ->destroy >> explicitly in |
1490 | that case. |
1808 | that case. |
1491 | |
1809 | |
|
|
1810 | Destroying the handle object in this way has the advantage that callbacks |
|
|
1811 | will be removed as well, so if those are the only reference holders (as |
|
|
1812 | is common), then one doesn't need to do anything special to break any |
|
|
1813 | reference cycles. |
|
|
1814 | |
1492 | The handle might still linger in the background and write out remaining |
1815 | The handle might still linger in the background and write out remaining |
1493 | data, as specified by the C<linger> option, however. |
1816 | data, as specified by the C<linger> option, however. |
1494 | |
1817 | |
1495 | =cut |
1818 | =cut |
1496 | |
1819 | |
… | |
… | |
1501 | %$self = (); |
1824 | %$self = (); |
1502 | } |
1825 | } |
1503 | |
1826 | |
1504 | =item AnyEvent::Handle::TLS_CTX |
1827 | =item AnyEvent::Handle::TLS_CTX |
1505 | |
1828 | |
1506 | This function creates and returns the Net::SSLeay::CTX object used by |
1829 | This function creates and returns the AnyEvent::TLS object used by default |
1507 | default for TLS mode. |
1830 | for TLS mode. |
1508 | |
1831 | |
1509 | The context is created like this: |
1832 | The context is created by calling L<AnyEvent::TLS> without any arguments. |
1510 | |
|
|
1511 | Net::SSLeay::load_error_strings; |
|
|
1512 | Net::SSLeay::SSLeay_add_ssl_algorithms; |
|
|
1513 | Net::SSLeay::randomize; |
|
|
1514 | |
|
|
1515 | my $CTX = Net::SSLeay::CTX_new; |
|
|
1516 | |
|
|
1517 | Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
|
|
1518 | |
1833 | |
1519 | =cut |
1834 | =cut |
1520 | |
1835 | |
1521 | our $TLS_CTX; |
1836 | our $TLS_CTX; |
1522 | |
1837 | |
1523 | sub TLS_CTX() { |
1838 | sub TLS_CTX() { |
1524 | $TLS_CTX || do { |
1839 | $TLS_CTX ||= do { |
1525 | require Net::SSLeay; |
1840 | require AnyEvent::TLS; |
1526 | |
1841 | |
1527 | Net::SSLeay::load_error_strings (); |
1842 | new AnyEvent::TLS |
1528 | Net::SSLeay::SSLeay_add_ssl_algorithms (); |
|
|
1529 | Net::SSLeay::randomize (); |
|
|
1530 | |
|
|
1531 | $TLS_CTX = Net::SSLeay::CTX_new (); |
|
|
1532 | |
|
|
1533 | Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
|
|
1534 | |
|
|
1535 | $TLS_CTX |
|
|
1536 | } |
1843 | } |
1537 | } |
1844 | } |
1538 | |
1845 | |
1539 | =back |
1846 | =back |
1540 | |
1847 | |
… | |
… | |
1579 | |
1886 | |
1580 | $handle->on_read (sub { }); |
1887 | $handle->on_read (sub { }); |
1581 | $handle->on_eof (undef); |
1888 | $handle->on_eof (undef); |
1582 | $handle->on_error (sub { |
1889 | $handle->on_error (sub { |
1583 | my $data = delete $_[0]{rbuf}; |
1890 | my $data = delete $_[0]{rbuf}; |
1584 | undef $handle; |
|
|
1585 | }); |
1891 | }); |
1586 | |
1892 | |
1587 | The reason to use C<on_error> is that TCP connections, due to latencies |
1893 | The reason to use C<on_error> is that TCP connections, due to latencies |
1588 | and packets loss, might get closed quite violently with an error, when in |
1894 | and packets loss, might get closed quite violently with an error, when in |
1589 | fact, all data has been received. |
1895 | fact, all data has been received. |
… | |
… | |
1605 | $handle->on_drain (sub { |
1911 | $handle->on_drain (sub { |
1606 | warn "all data submitted to the kernel\n"; |
1912 | warn "all data submitted to the kernel\n"; |
1607 | undef $handle; |
1913 | undef $handle; |
1608 | }); |
1914 | }); |
1609 | |
1915 | |
|
|
1916 | If you just want to queue some data and then signal EOF to the other side, |
|
|
1917 | consider using C<< ->push_shutdown >> instead. |
|
|
1918 | |
|
|
1919 | =item I want to contact a TLS/SSL server, I don't care about security. |
|
|
1920 | |
|
|
1921 | If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, |
|
|
1922 | simply connect to it and then create the AnyEvent::Handle with the C<tls> |
|
|
1923 | parameter: |
|
|
1924 | |
|
|
1925 | tcp_connect $host, $port, sub { |
|
|
1926 | my ($fh) = @_; |
|
|
1927 | |
|
|
1928 | my $handle = new AnyEvent::Handle |
|
|
1929 | fh => $fh, |
|
|
1930 | tls => "connect", |
|
|
1931 | on_error => sub { ... }; |
|
|
1932 | |
|
|
1933 | $handle->push_write (...); |
|
|
1934 | }; |
|
|
1935 | |
|
|
1936 | =item I want to contact a TLS/SSL server, I do care about security. |
|
|
1937 | |
|
|
1938 | Then you should additionally enable certificate verification, including |
|
|
1939 | peername verification, if the protocol you use supports it (see |
|
|
1940 | L<AnyEvent::TLS>, C<verify_peername>). |
|
|
1941 | |
|
|
1942 | E.g. for HTTPS: |
|
|
1943 | |
|
|
1944 | tcp_connect $host, $port, sub { |
|
|
1945 | my ($fh) = @_; |
|
|
1946 | |
|
|
1947 | my $handle = new AnyEvent::Handle |
|
|
1948 | fh => $fh, |
|
|
1949 | peername => $host, |
|
|
1950 | tls => "connect", |
|
|
1951 | tls_ctx => { verify => 1, verify_peername => "https" }, |
|
|
1952 | ... |
|
|
1953 | |
|
|
1954 | Note that you must specify the hostname you connected to (or whatever |
|
|
1955 | "peername" the protocol needs) as the C<peername> argument, otherwise no |
|
|
1956 | peername verification will be done. |
|
|
1957 | |
|
|
1958 | The above will use the system-dependent default set of trusted CA |
|
|
1959 | certificates. If you want to check against a specific CA, add the |
|
|
1960 | C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>: |
|
|
1961 | |
|
|
1962 | tls_ctx => { |
|
|
1963 | verify => 1, |
|
|
1964 | verify_peername => "https", |
|
|
1965 | ca_file => "my-ca-cert.pem", |
|
|
1966 | }, |
|
|
1967 | |
|
|
1968 | =item I want to create a TLS/SSL server, how do I do that? |
|
|
1969 | |
|
|
1970 | Well, you first need to get a server certificate and key. You have |
|
|
1971 | three options: a) ask a CA (buy one, use cacert.org etc.) b) create a |
|
|
1972 | self-signed certificate (cheap. check the search engine of your choice, |
|
|
1973 | there are many tutorials on the net) or c) make your own CA (tinyca2 is a |
|
|
1974 | nice program for that purpose). |
|
|
1975 | |
|
|
1976 | Then create a file with your private key (in PEM format, see |
|
|
1977 | L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The |
|
|
1978 | file should then look like this: |
|
|
1979 | |
|
|
1980 | -----BEGIN RSA PRIVATE KEY----- |
|
|
1981 | ...header data |
|
|
1982 | ... lots of base64'y-stuff |
|
|
1983 | -----END RSA PRIVATE KEY----- |
|
|
1984 | |
|
|
1985 | -----BEGIN CERTIFICATE----- |
|
|
1986 | ... lots of base64'y-stuff |
|
|
1987 | -----END CERTIFICATE----- |
|
|
1988 | |
|
|
1989 | The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then |
|
|
1990 | specify this file as C<cert_file>: |
|
|
1991 | |
|
|
1992 | tcp_server undef, $port, sub { |
|
|
1993 | my ($fh) = @_; |
|
|
1994 | |
|
|
1995 | my $handle = new AnyEvent::Handle |
|
|
1996 | fh => $fh, |
|
|
1997 | tls => "accept", |
|
|
1998 | tls_ctx => { cert_file => "my-server-keycert.pem" }, |
|
|
1999 | ... |
|
|
2000 | |
|
|
2001 | When you have intermediate CA certificates that your clients might not |
|
|
2002 | know about, just append them to the C<cert_file>. |
|
|
2003 | |
1610 | =back |
2004 | =back |
1611 | |
2005 | |
1612 | |
2006 | |
1613 | =head1 SUBCLASSING AnyEvent::Handle |
2007 | =head1 SUBCLASSING AnyEvent::Handle |
1614 | |
2008 | |