1 |
root |
1.1 |
=head1 NAME |
2 |
|
|
|
3 |
root |
1.13 |
AnyEvent::MP::Transport - actual transport protocol handler |
4 |
root |
1.1 |
|
5 |
|
|
=head1 SYNOPSIS |
6 |
|
|
|
7 |
|
|
use AnyEvent::MP::Transport; |
8 |
|
|
|
9 |
|
|
=head1 DESCRIPTION |
10 |
|
|
|
11 |
root |
1.43 |
This module implements (and documents) the actual transport protocol for |
12 |
|
|
AEMP. |
13 |
root |
1.1 |
|
14 |
root |
1.7 |
See the "PROTOCOL" section below if you want to write another client for |
15 |
|
|
this protocol. |
16 |
root |
1.1 |
|
17 |
|
|
=head1 FUNCTIONS/METHODS |
18 |
|
|
|
19 |
|
|
=over 4 |
20 |
|
|
|
21 |
|
|
=cut |
22 |
|
|
|
23 |
|
|
package AnyEvent::MP::Transport; |
24 |
|
|
|
25 |
|
|
use common::sense; |
26 |
|
|
|
27 |
root |
1.27 |
use Scalar::Util (); |
28 |
|
|
use List::Util (); |
29 |
root |
1.1 |
use MIME::Base64 (); |
30 |
|
|
use Storable (); |
31 |
root |
1.2 |
use JSON::XS (); |
32 |
root |
1.1 |
|
33 |
root |
1.19 |
use Digest::MD6 (); |
34 |
|
|
use Digest::HMAC_MD6 (); |
35 |
|
|
|
36 |
root |
1.1 |
use AE (); |
37 |
|
|
use AnyEvent::Socket (); |
38 |
root |
1.27 |
use AnyEvent::Handle 4.92 (); |
39 |
root |
1.2 |
|
40 |
root |
1.30 |
use AnyEvent::MP::Config (); |
41 |
|
|
|
42 |
root |
1.2 |
our $PROTOCOL_VERSION = 0; |
43 |
root |
1.1 |
|
44 |
root |
1.39 |
=item $listener = mp_listener $host, $port, <constructor-args> |
45 |
root |
1.1 |
|
46 |
|
|
Creates a listener on the given host/port using |
47 |
|
|
C<AnyEvent::Socket::tcp_server>. |
48 |
|
|
|
49 |
|
|
See C<new>, below, for constructor arguments. |
50 |
|
|
|
51 |
root |
1.10 |
Defaults for peerhost, peerport and fh are provided. |
52 |
root |
1.1 |
|
53 |
|
|
=cut |
54 |
|
|
|
55 |
root |
1.46 |
sub mp_server($$;%) { |
56 |
|
|
my ($host, $port, %arg) = @_; |
57 |
root |
1.1 |
|
58 |
|
|
AnyEvent::Socket::tcp_server $host, $port, sub { |
59 |
|
|
my ($fh, $host, $port) = @_; |
60 |
|
|
|
61 |
root |
1.39 |
my $tp = new AnyEvent::MP::Transport |
62 |
root |
1.1 |
fh => $fh, |
63 |
|
|
peerhost => $host, |
64 |
|
|
peerport => $port, |
65 |
root |
1.46 |
%arg, |
66 |
root |
1.39 |
; |
67 |
|
|
$tp->{keepalive} = $tp; |
68 |
root |
1.46 |
}, delete $arg{prepare} |
69 |
root |
1.1 |
} |
70 |
|
|
|
71 |
root |
1.2 |
=item $guard = mp_connect $host, $port, <constructor-args>, $cb->($transport) |
72 |
|
|
|
73 |
|
|
=cut |
74 |
|
|
|
75 |
|
|
sub mp_connect { |
76 |
root |
1.31 |
my $release = pop; |
77 |
root |
1.2 |
my ($host, $port, @args) = @_; |
78 |
|
|
|
79 |
root |
1.51 |
new AnyEvent::MP::Transport |
80 |
|
|
connect => [$host, $port], |
81 |
|
|
release => $release, |
82 |
|
|
@args, |
83 |
|
|
; |
84 |
root |
1.2 |
} |
85 |
|
|
|
86 |
root |
1.1 |
=item new AnyEvent::MP::Transport |
87 |
|
|
|
88 |
|
|
# immediately starts negotiation |
89 |
|
|
my $transport = new AnyEvent::MP::Transport |
90 |
root |
1.2 |
# mandatory |
91 |
root |
1.1 |
fh => $filehandle, |
92 |
root |
1.2 |
local_id => $identifier, |
93 |
root |
1.1 |
on_recv => sub { receive-callback }, |
94 |
|
|
on_error => sub { error-callback }, |
95 |
|
|
|
96 |
|
|
# optional |
97 |
|
|
on_eof => sub { clean-close-callback }, |
98 |
|
|
on_connect => sub { successful-connect-callback }, |
99 |
root |
1.2 |
greeting => { key => value }, |
100 |
root |
1.1 |
|
101 |
|
|
# tls support |
102 |
|
|
tls_ctx => AnyEvent::TLS, |
103 |
|
|
peername => $peername, # for verification |
104 |
|
|
; |
105 |
|
|
|
106 |
|
|
=cut |
107 |
|
|
|
108 |
|
|
sub new { |
109 |
|
|
my ($class, %arg) = @_; |
110 |
|
|
|
111 |
|
|
my $self = bless \%arg, $class; |
112 |
|
|
|
113 |
|
|
$self->{queue} = []; |
114 |
|
|
|
115 |
|
|
{ |
116 |
|
|
Scalar::Util::weaken (my $self = $self); |
117 |
|
|
|
118 |
root |
1.50 |
my $config = $AnyEvent::MP::Kernel::CONFIG; |
119 |
root |
1.30 |
|
120 |
root |
1.50 |
my $timeout = $config->{monitor_timeout}; |
121 |
|
|
my $lframing = $config->{data_format}; |
122 |
|
|
my $auth_snd = $config->{auth_offer}; |
123 |
|
|
my $auth_rcv = $config->{auth_accept}; |
124 |
root |
1.31 |
|
125 |
root |
1.42 |
$self->{secret} = $config->{secret} |
126 |
|
|
unless exists $self->{secret}; |
127 |
root |
1.2 |
|
128 |
root |
1.42 |
my $secret = $self->{secret}; |
129 |
root |
1.19 |
|
130 |
root |
1.30 |
if (exists $config->{cert}) { |
131 |
root |
1.42 |
$self->{tls_ctx} = { |
132 |
root |
1.19 |
sslv2 => 0, |
133 |
|
|
sslv3 => 0, |
134 |
|
|
tlsv1 => 1, |
135 |
|
|
verify => 1, |
136 |
root |
1.30 |
cert => $config->{cert}, |
137 |
|
|
ca_cert => $config->{cert}, |
138 |
root |
1.19 |
verify_require_client_cert => 1, |
139 |
|
|
}; |
140 |
|
|
} |
141 |
|
|
|
142 |
root |
1.1 |
$self->{hdl} = new AnyEvent::Handle |
143 |
root |
1.51 |
($self->{fh} ? (fh => $self->{fh}) : (connect => $self->{connect})), |
144 |
root |
1.48 |
autocork => 1, |
145 |
|
|
no_delay => 1, |
146 |
|
|
keepalive => 1, |
147 |
|
|
on_error => sub { |
148 |
root |
1.1 |
$self->error ($_[2]); |
149 |
|
|
}, |
150 |
root |
1.51 |
on_connect => sub { |
151 |
|
|
$self->{peerhost} = $_[1]; |
152 |
|
|
$self->{peerport} = $_[2]; |
153 |
|
|
$self->{peeraddr} = AnyEvent::Socket::format_hostport $_[1], $_[2]; |
154 |
|
|
}, |
155 |
root |
1.49 |
rtimeout => $timeout, |
156 |
root |
1.1 |
; |
157 |
|
|
|
158 |
root |
1.2 |
my $greeting_kv = $self->{greeting} ||= {}; |
159 |
root |
1.24 |
|
160 |
root |
1.38 |
$self->{local_node} ||= $AnyEvent::MP::Kernel::NODE; |
161 |
root |
1.24 |
|
162 |
root |
1.42 |
$greeting_kv->{tls} = "1.0" if $self->{tls_ctx}; |
163 |
root |
1.31 |
$greeting_kv->{provider} = "AE-$AnyEvent::MP::Kernel::VERSION"; |
164 |
root |
1.7 |
$greeting_kv->{peeraddr} = AnyEvent::Socket::format_hostport $self->{peerhost}, $self->{peerport}; |
165 |
root |
1.42 |
$greeting_kv->{timeout} = $self->{timeout}; |
166 |
root |
1.23 |
|
167 |
root |
1.1 |
# send greeting |
168 |
root |
1.12 |
my $lgreeting1 = "aemp;$PROTOCOL_VERSION" |
169 |
root |
1.24 |
. ";$self->{local_node}" |
170 |
root |
1.50 |
. ";" . (join ",", @$auth_rcv) |
171 |
|
|
. ";" . (join ",", @$lframing) |
172 |
root |
1.7 |
. (join "", map ";$_=$greeting_kv->{$_}", keys %$greeting_kv); |
173 |
root |
1.12 |
|
174 |
root |
1.31 |
my $lgreeting2 = MIME::Base64::encode_base64 AnyEvent::MP::Kernel::nonce (66), ""; |
175 |
root |
1.1 |
|
176 |
root |
1.7 |
$self->{hdl}->push_write ("$lgreeting1\012$lgreeting2\012"); |
177 |
root |
1.1 |
|
178 |
|
|
# expect greeting |
179 |
root |
1.12 |
$self->{hdl}->rbuf_max (4 * 1024); |
180 |
root |
1.1 |
$self->{hdl}->push_read (line => sub { |
181 |
root |
1.7 |
my $rgreeting1 = $_[1]; |
182 |
root |
1.1 |
|
183 |
root |
1.26 |
my ($aemp, $version, $rnode, $auths, $framings, @kv) = split /;/, $rgreeting1; |
184 |
root |
1.1 |
|
185 |
|
|
if ($aemp ne "aemp") { |
186 |
|
|
return $self->error ("unparsable greeting"); |
187 |
root |
1.12 |
} elsif ($version != $PROTOCOL_VERSION) { |
188 |
|
|
return $self->error ("version mismatch (we: $PROTOCOL_VERSION, they: $version)"); |
189 |
root |
1.39 |
} elsif ($rnode eq $self->{local_node}) { |
190 |
root |
1.42 |
AnyEvent::MP::Global::avoid_seed ($self->{seed}) |
191 |
|
|
if exists $self->{seed}; |
192 |
|
|
|
193 |
root |
1.39 |
return $self->error ("I refuse to talk to myself"); |
194 |
|
|
} elsif ($AnyEvent::MP::Kernel::NODE{$rnode} && $AnyEvent::MP::Kernel::NODE{$rnode}{transport}) { |
195 |
|
|
return $self->error ("$rnode already connected, not connecting again."); |
196 |
root |
1.1 |
} |
197 |
|
|
|
198 |
root |
1.2 |
$self->{remote_node} = $rnode; |
199 |
root |
1.1 |
|
200 |
root |
1.2 |
$self->{remote_greeting} = { |
201 |
|
|
map /^([^=]+)(?:=(.*))?/ ? ($1 => $2) : (), |
202 |
|
|
@kv |
203 |
root |
1.1 |
}; |
204 |
|
|
|
205 |
root |
1.7 |
# read nonce |
206 |
|
|
$self->{hdl}->push_read (line => sub { |
207 |
|
|
my $rgreeting2 = $_[1]; |
208 |
|
|
|
209 |
root |
1.19 |
"$lgreeting1\012$lgreeting2" ne "$rgreeting1\012$rgreeting2" # echo attack? |
210 |
|
|
or return $self->error ("authentication error, echo attack?"); |
211 |
|
|
|
212 |
root |
1.41 |
my $tls = $self->{tls_ctx} && 1 == int $self->{remote_greeting}{tls}; |
213 |
|
|
|
214 |
|
|
my $s_auth; |
215 |
|
|
for my $auth_ (split /,/, $auths) { |
216 |
root |
1.50 |
if (grep $auth_ eq $_, @$auth_snd and ($auth_ !~ /^tls_/ or $tls)) { |
217 |
root |
1.41 |
$s_auth = $auth_; |
218 |
|
|
last; |
219 |
|
|
} |
220 |
|
|
} |
221 |
|
|
|
222 |
|
|
defined $s_auth |
223 |
|
|
or return $self->error ("$auths: no common auth type supported"); |
224 |
|
|
|
225 |
|
|
my $s_framing; |
226 |
|
|
for my $framing_ (split /,/, $framings) { |
227 |
root |
1.50 |
if (grep $framing_ eq $_, @$lframing) { |
228 |
root |
1.41 |
$s_framing = $framing_; |
229 |
|
|
last; |
230 |
|
|
} |
231 |
|
|
} |
232 |
|
|
|
233 |
|
|
defined $s_framing |
234 |
|
|
or return $self->error ("$framings: no common framing method supported"); |
235 |
|
|
|
236 |
root |
1.30 |
my $key; |
237 |
root |
1.19 |
my $lauth; |
238 |
|
|
|
239 |
root |
1.41 |
if ($tls) { |
240 |
root |
1.8 |
$self->{tls} = $lgreeting2 lt $rgreeting2 ? "connect" : "accept"; |
241 |
|
|
$self->{hdl}->starttls ($self->{tls}, $self->{tls_ctx}); |
242 |
root |
1.41 |
|
243 |
|
|
$lauth = |
244 |
|
|
$s_auth eq "tls_anon" ? "" |
245 |
|
|
: $s_auth eq "tls_md6_64_256" ? Digest::MD6::md6_hex "$lgreeting1\012$lgreeting2\012$rgreeting1\012$rgreeting2\012" |
246 |
|
|
: return $self->error ("$s_auth: fatal, selected unsupported snd auth method"); |
247 |
|
|
|
248 |
root |
1.30 |
} elsif (length $secret) { |
249 |
root |
1.41 |
return $self->error ("$s_auth: fatal, selected unsupported snd auth method") |
250 |
|
|
unless $s_auth eq "hmac_md6_64_256"; # hardcoded atm. |
251 |
|
|
|
252 |
root |
1.30 |
$key = Digest::MD6::md6 $secret; |
253 |
root |
1.19 |
# we currently only support hmac_md6_64_256 |
254 |
|
|
$lauth = Digest::HMAC_MD6::hmac_md6_hex $key, "$lgreeting1\012$lgreeting2\012$rgreeting1\012$rgreeting2\012", 64, 256; |
255 |
root |
1.41 |
|
256 |
root |
1.30 |
} else { |
257 |
|
|
return $self->error ("unable to handshake TLS and no shared secret configured"); |
258 |
root |
1.8 |
} |
259 |
root |
1.2 |
|
260 |
root |
1.7 |
$self->{hdl}->push_write ("$s_auth;$lauth;$s_framing\012"); |
261 |
root |
1.2 |
|
262 |
root |
1.19 |
# read the authentication response |
263 |
root |
1.7 |
$self->{hdl}->push_read (line => sub { |
264 |
|
|
my ($hdl, $rline) = @_; |
265 |
root |
1.2 |
|
266 |
root |
1.7 |
my ($auth_method, $rauth2, $r_framing) = split /;/, $rline; |
267 |
root |
1.1 |
|
268 |
root |
1.19 |
my $rauth = |
269 |
|
|
$auth_method eq "hmac_md6_64_256" ? Digest::HMAC_MD6::hmac_md6_hex $key, "$rgreeting1\012$rgreeting2\012$lgreeting1\012$lgreeting2\012", 64, 256 |
270 |
|
|
: $auth_method eq "cleartext" ? unpack "H*", $secret |
271 |
root |
1.41 |
: $auth_method eq "tls_anon" ? ($tls ? "" : "\012\012") # \012\012 never matches |
272 |
|
|
: $auth_method eq "tls_md6_64_256" ? ($tls ? Digest::MD6::md6_hex "$rgreeting1\012$rgreeting2\012$lgreeting1\012$lgreeting2\012" : "\012\012") |
273 |
|
|
: return $self->error ("$auth_method: fatal, selected unsupported rcv auth method"); |
274 |
root |
1.19 |
|
275 |
root |
1.7 |
if ($rauth2 ne $rauth) { |
276 |
|
|
return $self->error ("authentication failure/shared secret mismatch"); |
277 |
|
|
} |
278 |
root |
1.1 |
|
279 |
root |
1.7 |
$self->{s_framing} = $s_framing; |
280 |
root |
1.2 |
|
281 |
root |
1.7 |
$hdl->rbuf_max (undef); |
282 |
root |
1.1 |
|
283 |
root |
1.49 |
# we rely on TCP retransmit timeouts and keepalives |
284 |
|
|
$self->{hdl}->rtimeout (undef); |
285 |
|
|
|
286 |
|
|
# except listener-less nodes, they need to continuously probe |
287 |
|
|
unless (@$AnyEvent::MP::Kernel::LISTENER) { |
288 |
|
|
$self->{hdl}->wtimeout ($timeout); |
289 |
|
|
$self->{hdl}->on_wtimeout (sub { $self->send ([]) }); |
290 |
|
|
} |
291 |
|
|
|
292 |
|
|
$self->{remote_greeting}{untrusted} = 1 |
293 |
|
|
if $auth_method eq "tls_anon"; |
294 |
root |
1.24 |
|
295 |
root |
1.47 |
my $queue = delete $self->{queue}; # we are connected |
296 |
|
|
|
297 |
root |
1.7 |
$self->connected; |
298 |
root |
1.1 |
|
299 |
root |
1.27 |
# send queued messages |
300 |
root |
1.23 |
$self->send ($_) |
301 |
root |
1.7 |
for @$queue; |
302 |
root |
1.1 |
|
303 |
root |
1.27 |
# receive handling |
304 |
|
|
my $src_node = $self->{node}; |
305 |
root |
1.45 |
my $rmsg; $rmsg = $self->{rmsg} = sub { |
306 |
root |
1.7 |
$_[0]->push_read ($r_framing => $rmsg); |
307 |
root |
1.1 |
|
308 |
root |
1.31 |
local $AnyEvent::MP::Kernel::SRCNODE = $src_node; |
309 |
|
|
AnyEvent::MP::Kernel::_inject (@{ $_[1] }); |
310 |
root |
1.7 |
}; |
311 |
|
|
$hdl->push_read ($r_framing => $rmsg); |
312 |
root |
1.45 |
|
313 |
|
|
Scalar::Util::weaken $rmsg; |
314 |
|
|
Scalar::Util::weaken $src_node; |
315 |
root |
1.7 |
}); |
316 |
root |
1.1 |
}); |
317 |
|
|
}); |
318 |
|
|
} |
319 |
|
|
|
320 |
|
|
$self |
321 |
|
|
} |
322 |
|
|
|
323 |
|
|
sub error { |
324 |
|
|
my ($self, $msg) = @_; |
325 |
|
|
|
326 |
root |
1.39 |
delete $self->{keepalive}; |
327 |
|
|
|
328 |
root |
1.50 |
$AnyEvent::MP::Kernel::WARN->(9, "$self->{peerhost}:$self->{peerport} $msg");#d# |
329 |
root |
1.39 |
|
330 |
|
|
$self->{node}->transport_error (transport_error => $self->{node}{id}, $msg) |
331 |
root |
1.31 |
if $self->{node} && $self->{node}{transport} == $self; |
332 |
|
|
|
333 |
|
|
(delete $self->{release})->() |
334 |
|
|
if exists $self->{release}; |
335 |
|
|
|
336 |
root |
1.37 |
# $AnyEvent::MP::Kernel::WARN->(7, "$self->{peerhost}:$self->{peerport}: $msg"); |
337 |
root |
1.4 |
$self->destroy; |
338 |
root |
1.1 |
} |
339 |
|
|
|
340 |
root |
1.2 |
sub connected { |
341 |
|
|
my ($self) = @_; |
342 |
|
|
|
343 |
root |
1.39 |
delete $self->{keepalive}; |
344 |
|
|
|
345 |
root |
1.31 |
(delete $self->{release})->() |
346 |
|
|
if exists $self->{release}; |
347 |
root |
1.23 |
|
348 |
root |
1.39 |
$AnyEvent::MP::Kernel::WARN->(9, "$self->{peerhost}:$self->{peerport} connected as $self->{remote_node}"); |
349 |
|
|
|
350 |
root |
1.31 |
my $node = AnyEvent::MP::Kernel::add_node ($self->{remote_node}); |
351 |
root |
1.4 |
Scalar::Util::weaken ($self->{node} = $node); |
352 |
root |
1.31 |
$node->transport_connect ($self); |
353 |
root |
1.2 |
} |
354 |
|
|
|
355 |
root |
1.1 |
sub send { |
356 |
root |
1.2 |
$_[0]{hdl}->push_write ($_[0]{s_framing} => $_[1]); |
357 |
root |
1.1 |
} |
358 |
|
|
|
359 |
|
|
sub destroy { |
360 |
|
|
my ($self) = @_; |
361 |
|
|
|
362 |
root |
1.42 |
(delete $self->{release})->() |
363 |
|
|
if exists $self->{release}; |
364 |
|
|
|
365 |
root |
1.2 |
$self->{hdl}->destroy |
366 |
|
|
if $self->{hdl}; |
367 |
root |
1.1 |
} |
368 |
|
|
|
369 |
|
|
sub DESTROY { |
370 |
|
|
my ($self) = @_; |
371 |
|
|
|
372 |
|
|
$self->destroy; |
373 |
|
|
} |
374 |
|
|
|
375 |
|
|
=back |
376 |
|
|
|
377 |
root |
1.7 |
=head1 PROTOCOL |
378 |
|
|
|
379 |
root |
1.43 |
The AEMP protocol is relatively simple, and consists of three phases which |
380 |
|
|
are symmetrical for both sides: greeting (followed by optionally switching |
381 |
|
|
to TLS mode), authentication and packet exchange. |
382 |
root |
1.7 |
|
383 |
root |
1.43 |
The protocol is designed to allow both full-text and binary streams. |
384 |
root |
1.7 |
|
385 |
|
|
The greeting consists of two text lines that are ended by either an ASCII |
386 |
|
|
CR LF pair, or a single ASCII LF (recommended). |
387 |
|
|
|
388 |
|
|
=head2 GREETING |
389 |
|
|
|
390 |
root |
1.15 |
All the lines until after authentication must not exceed 4kb in length, |
391 |
root |
1.43 |
including line delimiter. Afterwards there is no limit on the packet size |
392 |
|
|
that can be received. |
393 |
root |
1.15 |
|
394 |
|
|
=head3 First Greeting Line |
395 |
root |
1.12 |
|
396 |
root |
1.16 |
Example: |
397 |
|
|
|
398 |
root |
1.43 |
aemp;0;rain;tls_md6_64_256,hmac_md6_64_256,tls_anon,cleartext;json,storable;timeout=12;peeraddr=10.0.0.1:48082 |
399 |
root |
1.16 |
|
400 |
|
|
The first line contains strings separated (not ended) by C<;> |
401 |
root |
1.43 |
characters. The first five strings are fixed by the protocol, the |
402 |
root |
1.16 |
remaining strings are C<KEY=VALUE> pairs. None of them may contain C<;> |
403 |
root |
1.43 |
characters themselves (when escaping is needed, use C<%3b> to represent |
404 |
|
|
C<;> and C<%25> to represent C<%>)- |
405 |
root |
1.16 |
|
406 |
root |
1.12 |
The fixed strings are: |
407 |
root |
1.7 |
|
408 |
|
|
=over 4 |
409 |
|
|
|
410 |
root |
1.18 |
=item protocol identification |
411 |
root |
1.7 |
|
412 |
root |
1.43 |
The constant C<aemp> to identify this protocol. |
413 |
root |
1.7 |
|
414 |
|
|
=item protocol version |
415 |
|
|
|
416 |
root |
1.12 |
The protocol version supported by this end, currently C<0>. If the |
417 |
|
|
versions don't match then no communication is possible. Minor extensions |
418 |
root |
1.18 |
are supposed to be handled through additional key-value pairs. |
419 |
root |
1.7 |
|
420 |
root |
1.43 |
=item the node ID |
421 |
root |
1.7 |
|
422 |
root |
1.39 |
This is the node ID of the connecting node. |
423 |
root |
1.7 |
|
424 |
|
|
=item the acceptable authentication methods |
425 |
|
|
|
426 |
|
|
A comma-separated list of authentication methods supported by the |
427 |
|
|
node. Note that AnyEvent::MP supports a C<hex_secret> authentication |
428 |
root |
1.43 |
method that accepts a clear-text password (hex-encoded), but will not use |
429 |
|
|
this authentication method itself. |
430 |
root |
1.7 |
|
431 |
root |
1.43 |
The receiving side should choose the first authentication method it |
432 |
|
|
supports. |
433 |
root |
1.7 |
|
434 |
|
|
=item the acceptable framing formats |
435 |
|
|
|
436 |
root |
1.43 |
A comma-separated list of packet encoding/framing formats understood. The |
437 |
root |
1.7 |
receiving side should choose the first framing format it supports for |
438 |
|
|
sending packets (which might be different from the format it has to accept). |
439 |
|
|
|
440 |
root |
1.10 |
=back |
441 |
root |
1.8 |
|
442 |
|
|
The remaining arguments are C<KEY=VALUE> pairs. The following key-value |
443 |
|
|
pairs are known at this time: |
444 |
|
|
|
445 |
|
|
=over 4 |
446 |
|
|
|
447 |
|
|
=item provider=<module-version> |
448 |
|
|
|
449 |
|
|
The software provider for this implementation. For AnyEvent::MP, this is |
450 |
|
|
C<AE-0.0> or whatever version it currently is at. |
451 |
|
|
|
452 |
|
|
=item peeraddr=<host>:<port> |
453 |
|
|
|
454 |
root |
1.39 |
The peer address (socket address of the other side) as seen locally. |
455 |
root |
1.8 |
|
456 |
|
|
=item tls=<major>.<minor> |
457 |
|
|
|
458 |
|
|
Indicates that the other side supports TLS (version should be 1.0) and |
459 |
|
|
wishes to do a TLS handshake. |
460 |
|
|
|
461 |
|
|
=back |
462 |
|
|
|
463 |
root |
1.15 |
=head3 Second Greeting Line |
464 |
|
|
|
465 |
root |
1.8 |
After this greeting line there will be a second line containing a |
466 |
|
|
cryptographic nonce, i.e. random data of high quality. To keep the |
467 |
|
|
protocol text-only, these are usually 32 base64-encoded octets, but |
468 |
|
|
it could be anything that doesn't contain any ASCII CR or ASCII LF |
469 |
|
|
characters. |
470 |
|
|
|
471 |
root |
1.14 |
I<< The two nonces B<must> be different, and an aemp implementation |
472 |
|
|
B<must> check and fail when they are identical >>. |
473 |
|
|
|
474 |
root |
1.43 |
Example of a nonce line (yes, it's random-looking because it is random |
475 |
|
|
data): |
476 |
root |
1.8 |
|
477 |
root |
1.43 |
2XYhdG7/O6epFa4wuP0ujAEx1rXYWRcOypjUYK7eF6yWAQr7gwIN9m/2+mVvBrTPXz5GJDgfGm9d8QRABAbmAP/s |
478 |
root |
1.8 |
|
479 |
|
|
=head2 TLS handshake |
480 |
|
|
|
481 |
root |
1.14 |
I<< If, after the handshake, both sides indicate interest in TLS, then the |
482 |
root |
1.43 |
connection B<must> use TLS, or fail to continue. >> |
483 |
root |
1.8 |
|
484 |
|
|
Both sides compare their nonces, and the side who sent the lower nonce |
485 |
|
|
value ("string" comparison on the raw octet values) becomes the client, |
486 |
|
|
and the one with the higher nonce the server. |
487 |
|
|
|
488 |
|
|
=head2 AUTHENTICATION PHASE |
489 |
|
|
|
490 |
|
|
After the greeting is received (and the optional TLS handshake), |
491 |
|
|
the authentication phase begins, which consists of sending a single |
492 |
|
|
C<;>-separated line with three fixed strings and any number of |
493 |
|
|
C<KEY=VALUE> pairs. |
494 |
|
|
|
495 |
|
|
The three fixed strings are: |
496 |
|
|
|
497 |
|
|
=over 4 |
498 |
|
|
|
499 |
|
|
=item the authentication method chosen |
500 |
|
|
|
501 |
|
|
This must be one of the methods offered by the other side in the greeting. |
502 |
|
|
|
503 |
root |
1.41 |
Note that all methods starting with C<tls_> are only valid I<iff> TLS was |
504 |
|
|
successfully handshaked (and to be secure the implementation must enforce |
505 |
|
|
this). |
506 |
|
|
|
507 |
root |
1.13 |
The currently supported authentication methods are: |
508 |
|
|
|
509 |
|
|
=over 4 |
510 |
|
|
|
511 |
|
|
=item cleartext |
512 |
|
|
|
513 |
|
|
This is simply the shared secret, lowercase-hex-encoded. This method is of |
514 |
root |
1.43 |
course very insecure if TLS is not used (and not completely secure even |
515 |
|
|
if TLS is used), which is why this module will accept, but not generate, |
516 |
|
|
cleartext auth replies. |
517 |
root |
1.13 |
|
518 |
|
|
=item hmac_md6_64_256 |
519 |
|
|
|
520 |
root |
1.43 |
This method uses an MD6 HMAC with 64 bit blocksize and 256 bit hash, and |
521 |
|
|
requires a shared secret. It is the preferred auth method when a shared |
522 |
|
|
secret is available. |
523 |
|
|
|
524 |
|
|
First, the shared secret is hashed with MD6: |
525 |
root |
1.13 |
|
526 |
|
|
key = MD6 (secret) |
527 |
|
|
|
528 |
|
|
This secret is then used to generate the "local auth reply", by taking |
529 |
|
|
the two local greeting lines and the two remote greeting lines (without |
530 |
|
|
line endings), appending \012 to all of them, concatenating them and |
531 |
root |
1.43 |
calculating the MD6 HMAC with the key: |
532 |
root |
1.13 |
|
533 |
|
|
lauth = HMAC_MD6 key, "lgreeting1\012lgreeting2\012rgreeting1\012rgreeting2\012" |
534 |
|
|
|
535 |
|
|
This authentication token is then lowercase-hex-encoded and sent to the |
536 |
|
|
other side. |
537 |
|
|
|
538 |
|
|
Then the remote auth reply is generated using the same method, but local |
539 |
|
|
and remote greeting lines swapped: |
540 |
|
|
|
541 |
|
|
rauth = HMAC_MD6 key, "rgreeting1\012rgreeting2\012lgreeting1\012lgreeting2\012" |
542 |
|
|
|
543 |
|
|
This is the token that is expected from the other side. |
544 |
|
|
|
545 |
root |
1.41 |
=item tls_anon |
546 |
root |
1.19 |
|
547 |
root |
1.43 |
This type is only valid I<iff> TLS was enabled and the TLS handshake |
548 |
root |
1.19 |
was successful. It has no authentication data, as the server/client |
549 |
|
|
certificate was successfully verified. |
550 |
|
|
|
551 |
root |
1.43 |
This authentication type is somewhat insecure, as it allows a |
552 |
|
|
man-in-the-middle attacker to change some of the connection parameters |
553 |
|
|
(such as the framing format), although there is no known attack that |
554 |
|
|
exploits this in a way that is worse than just denying the service. |
555 |
root |
1.41 |
|
556 |
root |
1.43 |
By default, this implementation accepts but never generates this auth |
557 |
|
|
reply. |
558 |
root |
1.41 |
|
559 |
|
|
=item tls_md6_64_256 |
560 |
|
|
|
561 |
root |
1.43 |
This type is only valid I<iff> TLS was enabled and the TLS handshake was |
562 |
|
|
successful. |
563 |
root |
1.41 |
|
564 |
|
|
This authentication type simply calculates: |
565 |
|
|
|
566 |
|
|
lauth = MD6 "rgreeting1\012rgreeting2\012lgreeting1\012lgreeting2\012" |
567 |
|
|
|
568 |
|
|
and lowercase-hex encodes the result and sends it as authentication |
569 |
|
|
data. No shared secret is required (authentication is done by TLS). The |
570 |
root |
1.43 |
checksum exists only to make tinkering with the greeting hard. |
571 |
root |
1.19 |
|
572 |
root |
1.13 |
=back |
573 |
|
|
|
574 |
root |
1.8 |
=item the authentication data |
575 |
|
|
|
576 |
root |
1.13 |
The authentication data itself, usually base64 or hex-encoded data, see |
577 |
|
|
above. |
578 |
root |
1.8 |
|
579 |
|
|
=item the framing protocol chosen |
580 |
|
|
|
581 |
|
|
This must be one of the framing protocols offered by the other side in the |
582 |
root |
1.43 |
greeting. Each side must accept the choice of the other side, and generate |
583 |
|
|
packets in the format it chose itself. |
584 |
root |
1.8 |
|
585 |
|
|
=back |
586 |
|
|
|
587 |
root |
1.16 |
Example of an authentication reply: |
588 |
root |
1.9 |
|
589 |
root |
1.13 |
hmac_md6_64_256;363d5175df38bd9eaddd3f6ca18aa1c0c4aa22f0da245ac638d048398c26b8d3;json |
590 |
root |
1.9 |
|
591 |
root |
1.8 |
=head2 DATA PHASE |
592 |
|
|
|
593 |
|
|
After this, packets get exchanged using the chosen framing protocol. It is |
594 |
|
|
quite possible that both sides use a different framing protocol. |
595 |
|
|
|
596 |
root |
1.16 |
=head2 FULL EXAMPLE |
597 |
|
|
|
598 |
root |
1.17 |
This is an actual protocol dump of a handshake, followed by a single data |
599 |
root |
1.16 |
packet. The greater than/less than lines indicate the direction of the |
600 |
|
|
transfer only. |
601 |
|
|
|
602 |
root |
1.43 |
> aemp;0;anon/57Cs1CggVJjzYaQp13XXg4;tls_md6_64_256,hmac_md6_64_256,tls_anon,cleartext;json,storable;provider=AE-0.8;timeout=12;peeraddr=10.0.0.17:4040 |
603 |
|
|
> yLgdG1ov/02shVkVQer3wzeuywZK+oraTdEQBmIqWHaegxSGDG4g+HqogLQbvdypFOsoDWJ1Sh4ImV4DMhvUBwTK |
604 |
|
|
|
605 |
|
|
< aemp;0;ruth;tls_md6_64_256,hmac_md6_64_256,tls_anon,cleartext;json,storable;provider=AE-0.8;timeout=12;peeraddr=10.0.0.1:37108 |
606 |
|
|
< +xMQXP8ElfNmuvEhsmcp+s2wCJOuQAsPxSg3d2Ewhs6gBnJz+ypVdWJ/wAVrXqlIJfLeVS/CBy4gEGkyWHSuVb1L |
607 |
|
|
|
608 |
|
|
> hmac_md6_64_256;5ad913855742ae5a03a5aeb7eafa4c78629de136bed6acd73eea36c9e98df44a;json |
609 |
|
|
|
610 |
|
|
< hmac_md6_64_256;84cd590976f794914c2ca26dac3a207a57a6798b9171289c114de07cf0c20401;json |
611 |
|
|
< ["","AnyEvent::MP::_spawn","57Cs1CggVJjzYaQp13XXg4.c","AnyEvent::MP::Global::connect",0,"anon/57Cs1CggVJjzYaQp13XXg4"] |
612 |
|
|
... |
613 |
|
|
|
614 |
|
|
The shared secret in use was C<8ugxrtw6H5tKnfPWfaSr4HGhE8MoJXmzTT1BWq7sLutNcD0IbXprQlZjIbl7MBKoeklG3IEfY9GlJthC0pENzk>. |
615 |
root |
1.16 |
|
616 |
root |
1.49 |
=head2 MONITORING |
617 |
|
|
|
618 |
|
|
Monitoring the connection itself is transport-specific. For TCP, all |
619 |
|
|
connection monitoring is currently left to TCP retransmit time-outs |
620 |
|
|
on a busy link, and TCP keepalive (which should be enabled) for idle |
621 |
|
|
connections. |
622 |
|
|
|
623 |
|
|
This is not sufficient for listener-less nodes, however: they need |
624 |
|
|
to regularly send data (30 seconds, or the monitoring interval, is |
625 |
|
|
recommended), so TCP actively probes. |
626 |
|
|
|
627 |
|
|
Future implementations of AnyEvent::Transport might query the kernel TCP |
628 |
|
|
buffer after a write timeout occurs, and if it is non-empty, shut down the |
629 |
|
|
connections, but this is an area of future research :) |
630 |
|
|
|
631 |
|
|
=head2 NODE PROTOCOL |
632 |
|
|
|
633 |
|
|
The transport simply transfers messages, but to implement a full node, a |
634 |
|
|
special node port must exist that understands a number of requests. |
635 |
|
|
|
636 |
|
|
If you are interested in implementing this, drop us a note so we finish |
637 |
|
|
the documentation. |
638 |
|
|
|
639 |
root |
1.1 |
=head1 SEE ALSO |
640 |
|
|
|
641 |
root |
1.29 |
L<AnyEvent::MP>. |
642 |
root |
1.1 |
|
643 |
|
|
=head1 AUTHOR |
644 |
|
|
|
645 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
646 |
|
|
http://home.schmorp.de/ |
647 |
|
|
|
648 |
|
|
=cut |
649 |
|
|
|
650 |
|
|
1 |
651 |
|
|
|