| 1 | =head1 NAME |
1 | =head1 NAME |
| 2 | |
2 | |
| 3 | AnyEvent::MP::Transport - actual transport protocol |
3 | AnyEvent::MP::Transport - actual transport protocol handler |
| 4 | |
4 | |
| 5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
| 6 | |
6 | |
| 7 | use AnyEvent::MP::Transport; |
7 | use AnyEvent::MP::Transport; |
| 8 | |
8 | |
| 9 | =head1 DESCRIPTION |
9 | =head1 DESCRIPTION |
| 10 | |
10 | |
| 11 | This is the superclass for MP transports, most of which is considered an |
11 | This implements the actual transport protocol for MP (it represents a |
| 12 | implementation detail. |
12 | single link), most of which is considered an implementation detail. |
| 13 | |
13 | |
| 14 | See the "PROTOCOL" section below if you want to write another client for |
14 | See the "PROTOCOL" section below if you want to write another client for |
| 15 | this protocol. |
15 | this protocol. |
| 16 | |
16 | |
| 17 | =head1 FUNCTIONS/METHODS |
17 | =head1 FUNCTIONS/METHODS |
| … | |
… | |
| 22 | |
22 | |
| 23 | package AnyEvent::MP::Transport; |
23 | package AnyEvent::MP::Transport; |
| 24 | |
24 | |
| 25 | use common::sense; |
25 | use common::sense; |
| 26 | |
26 | |
| 27 | use Scalar::Util; |
27 | use Scalar::Util (); |
|
|
28 | use List::Util (); |
| 28 | use MIME::Base64 (); |
29 | use MIME::Base64 (); |
| 29 | use Storable (); |
30 | use Storable (); |
| 30 | use JSON::XS (); |
31 | use JSON::XS (); |
| 31 | |
32 | |
|
|
33 | use Digest::MD6 (); |
|
|
34 | use Digest::HMAC_MD6 (); |
|
|
35 | |
| 32 | use AE (); |
36 | use AE (); |
| 33 | use AnyEvent::Socket (); |
37 | use AnyEvent::Socket (); |
| 34 | use AnyEvent::Handle (); |
38 | use AnyEvent::Handle 4.92 (); |
| 35 | |
39 | |
| 36 | use base Exporter::; |
40 | use base Exporter::; |
| 37 | |
41 | |
| 38 | our $VERSION = '0.0'; |
42 | our $VERSION = '0.0'; |
| 39 | our $PROTOCOL_VERSION = 0; |
43 | our $PROTOCOL_VERSION = 0; |
| … | |
… | |
| 43 | Creates a listener on the given host/port using |
47 | Creates a listener on the given host/port using |
| 44 | C<AnyEvent::Socket::tcp_server>. |
48 | C<AnyEvent::Socket::tcp_server>. |
| 45 | |
49 | |
| 46 | See C<new>, below, for constructor arguments. |
50 | See C<new>, below, for constructor arguments. |
| 47 | |
51 | |
| 48 | Defaults for peerhost, peerport, fh and tls are provided. |
52 | Defaults for peerhost, peerport and fh are provided. |
| 49 | |
53 | |
| 50 | =cut |
54 | =cut |
| 51 | |
55 | |
| 52 | sub mp_server($$@) { |
56 | sub mp_server($$@) { |
| 53 | my $cb = pop; |
57 | my $cb = pop; |
| … | |
… | |
| 58 | |
62 | |
| 59 | $cb->(new AnyEvent::MP::Transport |
63 | $cb->(new AnyEvent::MP::Transport |
| 60 | fh => $fh, |
64 | fh => $fh, |
| 61 | peerhost => $host, |
65 | peerhost => $host, |
| 62 | peerport => $port, |
66 | peerport => $port, |
| 63 | tls => "accept", |
|
|
| 64 | @args, |
67 | @args, |
| 65 | ); |
68 | ); |
| 66 | } |
69 | } |
| 67 | } |
70 | } |
| 68 | |
71 | |
| … | |
… | |
| 82 | $cb->(new AnyEvent::MP::Transport |
85 | $cb->(new AnyEvent::MP::Transport |
| 83 | fh => $fh, |
86 | fh => $fh, |
| 84 | peername => $host, |
87 | peername => $host, |
| 85 | peerhost => $nhost, |
88 | peerhost => $nhost, |
| 86 | peerport => $nport, |
89 | peerport => $nport, |
| 87 | tls => "accept", |
|
|
| 88 | @args, |
90 | @args, |
| 89 | ); |
91 | ); |
| 90 | } |
92 | } |
| 91 | } |
93 | } |
| 92 | |
94 | |
| … | |
… | |
| 105 | on_eof => sub { clean-close-callback }, |
107 | on_eof => sub { clean-close-callback }, |
| 106 | on_connect => sub { successful-connect-callback }, |
108 | on_connect => sub { successful-connect-callback }, |
| 107 | greeting => { key => value }, |
109 | greeting => { key => value }, |
| 108 | |
110 | |
| 109 | # tls support |
111 | # tls support |
| 110 | tls => "accept|connect", |
|
|
| 111 | tls_ctx => AnyEvent::TLS, |
112 | tls_ctx => AnyEvent::TLS, |
| 112 | peername => $peername, # for verification |
113 | peername => $peername, # for verification |
| 113 | ; |
114 | ; |
| 114 | |
115 | |
| 115 | =cut |
116 | =cut |
| 116 | |
117 | |
|
|
118 | sub LATENCY() { 3 } # assumed max. network latency |
|
|
119 | |
| 117 | our @FRAMINGS = qw(json storable); # the framing types we accept and send, in order of preference |
120 | our @FRAMINGS = qw(json storable); # the framing types we accept and send, in order of preference |
| 118 | our @AUTH_SND = qw(hmac_md6_64_256); # auth types we send |
121 | our @AUTH_SND = qw(hmac_md6_64_256); # auth types we send |
| 119 | our @AUTH_RCV = (@AUTH_SND, qw(hex_secret)); # auth types we accept |
122 | our @AUTH_RCV = (@AUTH_SND, qw(cleartext)); # auth types we accept |
| 120 | |
123 | |
| 121 | #AnyEvent::Handle::register_write_type mp_record => sub { |
124 | #AnyEvent::Handle::register_write_type mp_record => sub { |
| 122 | #}; |
125 | #}; |
| 123 | |
126 | |
| 124 | sub new { |
127 | sub new { |
| … | |
… | |
| 129 | $self->{queue} = []; |
132 | $self->{queue} = []; |
| 130 | |
133 | |
| 131 | { |
134 | { |
| 132 | Scalar::Util::weaken (my $self = $self); |
135 | Scalar::Util::weaken (my $self = $self); |
| 133 | |
136 | |
| 134 | if (exists $arg{connect}) { |
|
|
| 135 | $arg{tls_ctx} ||= { sslv2 => 0, sslv3 => 0, tlsv1 => 1, verify => 1 }; |
|
|
| 136 | } |
|
|
| 137 | |
|
|
| 138 | $arg{secret} = AnyEvent::MP::Base::default_secret () |
137 | $arg{secret} = AnyEvent::MP::Base::default_secret () |
| 139 | unless exists $arg{secret}; |
138 | unless exists $arg{secret}; |
| 140 | |
139 | |
|
|
140 | $arg{timeout} = 30 |
|
|
141 | unless exists $arg{timeout}; |
|
|
142 | |
|
|
143 | $arg{timeout} = 1 + LATENCY |
|
|
144 | if $arg{timeout} < 1 + LATENCY; |
|
|
145 | |
|
|
146 | my $secret = $arg{secret}; |
|
|
147 | |
|
|
148 | if ($secret =~ /-----BEGIN RSA PRIVATE KEY-----.*-----END RSA PRIVATE KEY-----.*-----BEGIN CERTIFICATE-----.*-----END CERTIFICATE-----/s) { |
|
|
149 | # assume TLS mode |
|
|
150 | $arg{tls_ctx} = { |
|
|
151 | sslv2 => 0, |
|
|
152 | sslv3 => 0, |
|
|
153 | tlsv1 => 1, |
|
|
154 | verify => 1, |
|
|
155 | cert => $secret, |
|
|
156 | ca_cert => $secret, |
|
|
157 | verify_require_client_cert => 1, |
|
|
158 | }; |
|
|
159 | } |
|
|
160 | |
| 141 | $self->{hdl} = new AnyEvent::Handle |
161 | $self->{hdl} = new AnyEvent::Handle |
| 142 | fh => delete $arg{fh}, |
162 | fh => delete $arg{fh}, |
| 143 | rbuf_max => 64 * 1024, |
|
|
| 144 | autocork => 1, |
163 | autocork => 1, |
| 145 | no_delay => 1, |
164 | no_delay => 1, |
| 146 | on_error => sub { |
165 | on_error => sub { |
| 147 | $self->error ($_[2]); |
166 | $self->error ($_[2]); |
| 148 | }, |
167 | }, |
|
|
168 | rtimeout => $AnyEvent::MP::Base::CONNECT_TIMEOUT, |
| 149 | peername => delete $arg{peername}, |
169 | peername => delete $arg{peername}, |
| 150 | ; |
170 | ; |
| 151 | |
171 | |
| 152 | my $secret = $arg{secret}; |
|
|
| 153 | my $greeting_kv = $self->{greeting} ||= {}; |
172 | my $greeting_kv = $self->{greeting} ||= {}; |
|
|
173 | |
|
|
174 | $self->{local_node} = $AnyEvent::MP::Base::NODE; |
|
|
175 | |
| 154 | $greeting_kv->{"tls"} = "1.0" |
176 | $greeting_kv->{"tls"} = "1.0" if $arg{tls_ctx}; |
| 155 | if $arg{tls_ctx}; |
|
|
| 156 | $greeting_kv->{provider} = "AE-$VERSION"; |
177 | $greeting_kv->{provider} = "AE-$VERSION"; |
| 157 | $greeting_kv->{peeraddr} = AnyEvent::Socket::format_hostport $self->{peerhost}, $self->{peerport}; |
178 | $greeting_kv->{peeraddr} = AnyEvent::Socket::format_hostport $self->{peerhost}, $self->{peerport}; |
|
|
179 | $greeting_kv->{timeout} = $arg{timeout}; |
| 158 | |
180 | |
| 159 | # send greeting |
181 | # send greeting |
| 160 | my $lgreeting1 = "aemp;$PROTOCOL_VERSION;$PROTOCOL_VERSION" # version, min |
182 | my $lgreeting1 = "aemp;$PROTOCOL_VERSION" |
| 161 | . ";$AnyEvent::MP::Base::UNIQ" |
183 | . ";$self->{local_node}" |
| 162 | . ";$AnyEvent::MP::Base::NODE" |
|
|
| 163 | . ";" . (join ",", @AUTH_RCV) |
184 | . ";" . (join ",", @AUTH_RCV) |
| 164 | . ";" . (join ",", @FRAMINGS) |
185 | . ";" . (join ",", @FRAMINGS) |
| 165 | . (join "", map ";$_=$greeting_kv->{$_}", keys %$greeting_kv); |
186 | . (join "", map ";$_=$greeting_kv->{$_}", keys %$greeting_kv); |
|
|
187 | |
| 166 | my $lgreeting2 = MIME::Base64::encode_base64 AnyEvent::MP::Base::nonce (33), ""; |
188 | my $lgreeting2 = MIME::Base64::encode_base64 AnyEvent::MP::Base::nonce (33), ""; |
| 167 | |
189 | |
| 168 | $self->{hdl}->push_write ("$lgreeting1\012$lgreeting2\012"); |
190 | $self->{hdl}->push_write ("$lgreeting1\012$lgreeting2\012"); |
| 169 | |
191 | |
| 170 | # expect greeting |
192 | # expect greeting |
|
|
193 | $self->{hdl}->rbuf_max (4 * 1024); |
| 171 | $self->{hdl}->push_read (line => sub { |
194 | $self->{hdl}->push_read (line => sub { |
| 172 | my $rgreeting1 = $_[1]; |
195 | my $rgreeting1 = $_[1]; |
| 173 | |
196 | |
| 174 | my ($aemp, $version, $version_min, $uniq, $rnode, $auths, $framings, @kv) = split /;/, $rgreeting1; |
197 | my ($aemp, $version, $rnode, $auths, $framings, @kv) = split /;/, $rgreeting1; |
| 175 | |
198 | |
| 176 | if ($aemp ne "aemp") { |
199 | if ($aemp ne "aemp") { |
| 177 | return $self->error ("unparsable greeting"); |
200 | return $self->error ("unparsable greeting"); |
| 178 | } elsif ($version_min > $PROTOCOL_VERSION) { |
201 | } elsif ($version != $PROTOCOL_VERSION) { |
| 179 | return $self->error ("version mismatch (we: $PROTOCOL_VERSION, they: $version_min .. $version)"); |
202 | return $self->error ("version mismatch (we: $PROTOCOL_VERSION, they: $version)"); |
| 180 | } |
203 | } |
| 181 | |
204 | |
| 182 | my $s_auth; |
205 | my $s_auth; |
| 183 | for my $auth_ (split /,/, $auths) { |
206 | for my $auth_ (split /,/, $auths) { |
| 184 | if (grep $auth_ eq $_, @AUTH_SND) { |
207 | if (grep $auth_ eq $_, @AUTH_SND) { |
| … | |
… | |
| 201 | } |
224 | } |
| 202 | |
225 | |
| 203 | defined $s_framing |
226 | defined $s_framing |
| 204 | or return $self->error ("$framings: no common framing method supported"); |
227 | or return $self->error ("$framings: no common framing method supported"); |
| 205 | |
228 | |
| 206 | $self->{remote_uniq} = $uniq; |
|
|
| 207 | $self->{remote_node} = $rnode; |
229 | $self->{remote_node} = $rnode; |
| 208 | |
230 | |
| 209 | $self->{remote_greeting} = { |
231 | $self->{remote_greeting} = { |
| 210 | map /^([^=]+)(?:=(.*))?/ ? ($1 => $2) : (), |
232 | map /^([^=]+)(?:=(.*))?/ ? ($1 => $2) : (), |
| 211 | @kv |
233 | @kv |
| … | |
… | |
| 213 | |
235 | |
| 214 | # read nonce |
236 | # read nonce |
| 215 | $self->{hdl}->push_read (line => sub { |
237 | $self->{hdl}->push_read (line => sub { |
| 216 | my $rgreeting2 = $_[1]; |
238 | my $rgreeting2 = $_[1]; |
| 217 | |
239 | |
|
|
240 | "$lgreeting1\012$lgreeting2" ne "$rgreeting1\012$rgreeting2" # echo attack? |
|
|
241 | or return $self->error ("authentication error, echo attack?"); |
|
|
242 | |
|
|
243 | my $key = Digest::MD6::md6 $secret; |
|
|
244 | my $lauth; |
|
|
245 | |
| 218 | if ($self->{tls_ctx} and 1 == int $self->{remote_greeting}{"tls"}) { |
246 | if ($self->{tls_ctx} and 1 == int $self->{remote_greeting}{tls}) { |
| 219 | $self->{tls} = $lgreeting2 lt $rgreeting2 ? "connect" : "accept"; |
247 | $self->{tls} = $lgreeting2 lt $rgreeting2 ? "connect" : "accept"; |
| 220 | $self->{hdl}->starttls ($self->{tls}, $self->{tls_ctx}); |
248 | $self->{hdl}->starttls ($self->{tls}, $self->{tls_ctx}); |
|
|
249 | $s_auth = "tls"; |
|
|
250 | $lauth = ""; |
|
|
251 | } else { |
|
|
252 | # we currently only support hmac_md6_64_256 |
|
|
253 | $lauth = Digest::HMAC_MD6::hmac_md6_hex $key, "$lgreeting1\012$lgreeting2\012$rgreeting1\012$rgreeting2\012", 64, 256; |
| 221 | } |
254 | } |
| 222 | |
|
|
| 223 | # auth |
|
|
| 224 | require Digest::MD6; |
|
|
| 225 | require Digest::HMAC_MD6; |
|
|
| 226 | |
|
|
| 227 | my $key = Digest::MD6::md6_hex ($secret); |
|
|
| 228 | my $lauth = Digest::HMAC_MD6::hmac_md6_base64 ($key, "$lgreeting1\012$lgreeting2\012$rgreeting1\012$rgreeting2\012", 64, 256); |
|
|
| 229 | |
|
|
| 230 | my $rauth = |
|
|
| 231 | $s_auth eq "hmac_md6_64_256" ? Digest::HMAC_MD6::hmac_md6_base64 ($key, "$rgreeting1\012$rgreeting2\012$lgreeting1\012$lgreeting2\012", 64, 256) |
|
|
| 232 | : $s_auth eq "hex_secret" ? unpack "H*", $secret |
|
|
| 233 | : die; |
|
|
| 234 | |
|
|
| 235 | $lauth ne $rauth # echo attack? |
|
|
| 236 | or return $self->error ("authentication error"); |
|
|
| 237 | |
255 | |
| 238 | $self->{hdl}->push_write ("$s_auth;$lauth;$s_framing\012"); |
256 | $self->{hdl}->push_write ("$s_auth;$lauth;$s_framing\012"); |
| 239 | |
257 | |
| 240 | $self->{hdl}->rbuf_max (64); # enough for 44 reply bytes or so |
258 | # read the authentication response |
| 241 | $self->{hdl}->push_read (line => sub { |
259 | $self->{hdl}->push_read (line => sub { |
| 242 | my ($hdl, $rline) = @_; |
260 | my ($hdl, $rline) = @_; |
| 243 | |
261 | |
| 244 | my ($auth_method, $rauth2, $r_framing) = split /;/, $rline; |
262 | my ($auth_method, $rauth2, $r_framing) = split /;/, $rline; |
|
|
263 | |
|
|
264 | my $rauth = |
|
|
265 | $auth_method eq "hmac_md6_64_256" ? Digest::HMAC_MD6::hmac_md6_hex $key, "$rgreeting1\012$rgreeting2\012$lgreeting1\012$lgreeting2\012", 64, 256 |
|
|
266 | : $auth_method eq "cleartext" ? unpack "H*", $secret |
|
|
267 | : $auth_method eq "tls" ? ($self->{tls} ? "" : "\012\012") # \012\012 never matches |
|
|
268 | : return $self->error ("$auth_method: fatal, selected unsupported auth method"); |
| 245 | |
269 | |
| 246 | if ($rauth2 ne $rauth) { |
270 | if ($rauth2 ne $rauth) { |
| 247 | return $self->error ("authentication failure/shared secret mismatch"); |
271 | return $self->error ("authentication failure/shared secret mismatch"); |
| 248 | } |
272 | } |
| 249 | |
273 | |
| 250 | $self->{s_framing} = $s_framing; |
274 | $self->{s_framing} = $s_framing; |
| 251 | |
275 | |
| 252 | $hdl->rbuf_max (undef); |
276 | $hdl->rbuf_max (undef); |
| 253 | my $queue = delete $self->{queue}; # we are connected |
277 | my $queue = delete $self->{queue}; # we are connected |
| 254 | |
278 | |
|
|
279 | $self->{hdl}->rtimeout ($self->{remote_greeting}{timeout}); |
|
|
280 | $self->{hdl}->wtimeout ($arg{timeout} - LATENCY); |
|
|
281 | $self->{hdl}->on_wtimeout (sub { $self->send (["", "devnull"]) }); |
|
|
282 | |
| 255 | $self->connected; |
283 | $self->connected; |
| 256 | |
284 | |
| 257 | $hdl->push_write ($self->{s_framing} => $_) |
285 | # send queued messages |
|
|
286 | $self->send ($_) |
| 258 | for @$queue; |
287 | for @$queue; |
| 259 | |
288 | |
|
|
289 | # receive handling |
|
|
290 | my $src_node = $self->{node}; |
|
|
291 | |
| 260 | my $rmsg; $rmsg = sub { |
292 | my $rmsg; $rmsg = sub { |
| 261 | $_[0]->push_read ($r_framing => $rmsg); |
293 | $_[0]->push_read ($r_framing => $rmsg); |
| 262 | |
294 | |
|
|
295 | local $AnyEvent::MP::Base::SRCNODE = $src_node; |
| 263 | AnyEvent::MP::Base::_inject ($_[1]); |
296 | AnyEvent::MP::Base::_inject (@{ $_[1] }); |
| 264 | }; |
297 | }; |
| 265 | $hdl->push_read ($r_framing => $rmsg); |
298 | $hdl->push_read ($r_framing => $rmsg); |
| 266 | }); |
299 | }); |
| 267 | }); |
300 | }); |
| 268 | }); |
301 | }); |
| … | |
… | |
| 273 | |
306 | |
| 274 | sub error { |
307 | sub error { |
| 275 | my ($self, $msg) = @_; |
308 | my ($self, $msg) = @_; |
| 276 | |
309 | |
| 277 | if ($self->{node} && $self->{node}{transport} == $self) { |
310 | if ($self->{node} && $self->{node}{transport} == $self) { |
|
|
311 | #TODO: store error, but do not instantly fail |
|
|
312 | $self->{node}->fail (transport_error => $self->{node}{noderef}, $msg); |
| 278 | $self->{node}->clr_transport; |
313 | $self->{node}->clr_transport; |
| 279 | } |
314 | } |
| 280 | $AnyEvent::MP::Base::WARN->("$self->{peerhost}:$self->{peerport}: $msg"); |
315 | $AnyEvent::MP::Base::WARN->("$self->{peerhost}:$self->{peerport}: $msg"); |
| 281 | $self->destroy; |
316 | $self->destroy; |
| 282 | } |
317 | } |
| 283 | |
318 | |
| 284 | sub connected { |
319 | sub connected { |
| 285 | my ($self) = @_; |
320 | my ($self) = @_; |
| 286 | |
321 | |
|
|
322 | if (ref $AnyEvent::MP::Base::SLAVE) { |
|
|
323 | # first connect with a master node |
|
|
324 | my $via = $self->{remote_node}; |
|
|
325 | $via =~ s/,/!/g; |
|
|
326 | $AnyEvent::MP::Base::NODE .= "\@$via"; |
|
|
327 | $AnyEvent::MP::Base::NODE{$AnyEvent::MP::Base::NODE} = $AnyEvent::MP::Base::NODE{""}; |
|
|
328 | $AnyEvent::MP::Base::SLAVE->(); |
|
|
329 | } |
|
|
330 | |
|
|
331 | if ($self->{local_node} ne $AnyEvent::MP::Base::NODE) { |
|
|
332 | # node changed its name since first greeting |
|
|
333 | $self->send (["", iam => $AnyEvent::MP::Base::NODE]); |
|
|
334 | } |
|
|
335 | |
| 287 | my $node = AnyEvent::MP::Base::add_node ($self->{remote_node}); |
336 | my $node = AnyEvent::MP::Base::add_node ($self->{remote_node}); |
| 288 | Scalar::Util::weaken ($self->{node} = $node); |
337 | Scalar::Util::weaken ($self->{node} = $node); |
| 289 | $node->set_transport ($self); |
338 | $node->set_transport ($self); |
| 290 | } |
339 | } |
| 291 | |
340 | |
| … | |
… | |
| 319 | The greeting consists of two text lines that are ended by either an ASCII |
368 | The greeting consists of two text lines that are ended by either an ASCII |
| 320 | CR LF pair, or a single ASCII LF (recommended). |
369 | CR LF pair, or a single ASCII LF (recommended). |
| 321 | |
370 | |
| 322 | =head2 GREETING |
371 | =head2 GREETING |
| 323 | |
372 | |
|
|
373 | All the lines until after authentication must not exceed 4kb in length, |
|
|
374 | including delimiter. Afterwards there is no limit on the packet size that |
|
|
375 | can be received. |
|
|
376 | |
|
|
377 | =head3 First Greeting Line |
|
|
378 | |
|
|
379 | Example: |
|
|
380 | |
|
|
381 | aemp;0;fec.4a7720fc;127.0.0.1:1235,[::1]:1235;hmac_md6_64_256;json,storable;provider=AE-0.0 |
|
|
382 | |
| 324 | The first line contains strings separated (not ended) by C<;> |
383 | The first line contains strings separated (not ended) by C<;> |
| 325 | characters. The first seven strings are fixed by the protocol, the |
384 | characters. The first even ixtrings are fixed by the protocol, the |
| 326 | remaining strings are C<KEY=VALUE> pairs. None of them may contain C<;> |
385 | remaining strings are C<KEY=VALUE> pairs. None of them may contain C<;> |
| 327 | characters themselves. |
386 | characters themselves. |
| 328 | |
387 | |
| 329 | The seven fixed strings are: |
388 | The fixed strings are: |
| 330 | |
389 | |
| 331 | =over 4 |
390 | =over 4 |
| 332 | |
391 | |
| 333 | =item C<aemp> |
392 | =item protocol identification |
| 334 | |
393 | |
| 335 | The constant C<aemp> to identify the protocol. |
394 | The constant C<aemp> to identify the protocol. |
| 336 | |
395 | |
| 337 | =item protocol version |
396 | =item protocol version |
| 338 | |
397 | |
| 339 | The (maximum) protocol version supported by this end, currently C<0>. |
|
|
| 340 | |
|
|
| 341 | =item minimum protocol version |
|
|
| 342 | |
|
|
| 343 | The minimum protocol version supported by this end, currently C<0>. |
398 | The protocol version supported by this end, currently C<0>. If the |
| 344 | |
399 | versions don't match then no communication is possible. Minor extensions |
| 345 | =item a token uniquely identifying the current node instance |
400 | are supposed to be handled through additional key-value pairs. |
| 346 | |
|
|
| 347 | This is a string that must change between restarts. It usually contains |
|
|
| 348 | things like the current time, the (OS) process id or similar values, but |
|
|
| 349 | no meaning of the contents are assumed. |
|
|
| 350 | |
401 | |
| 351 | =item the node endpoint descriptors |
402 | =item the node endpoint descriptors |
| 352 | |
403 | |
| 353 | for public nodes, this is a comma-separated list of protocol endpoints, |
404 | for public nodes, this is a comma-separated list of protocol endpoints, |
| 354 | i.e., the noderef. For slave nodes, this is a unique identifier. |
405 | i.e., the noderef. For slave nodes, this is a unique identifier of the |
|
|
406 | form C<slave/nonce>. |
| 355 | |
407 | |
| 356 | =item the acceptable authentication methods |
408 | =item the acceptable authentication methods |
| 357 | |
409 | |
| 358 | A comma-separated list of authentication methods supported by the |
410 | A comma-separated list of authentication methods supported by the |
| 359 | node. Note that AnyEvent::MP supports a C<hex_secret> authentication |
411 | node. Note that AnyEvent::MP supports a C<hex_secret> authentication |
| … | |
… | |
| 366 | |
418 | |
| 367 | A comma-separated list of packet encoding/framign formats understood. The |
419 | A comma-separated list of packet encoding/framign formats understood. The |
| 368 | receiving side should choose the first framing format it supports for |
420 | receiving side should choose the first framing format it supports for |
| 369 | sending packets (which might be different from the format it has to accept). |
421 | sending packets (which might be different from the format it has to accept). |
| 370 | |
422 | |
| 371 | =cut |
423 | =back |
| 372 | |
424 | |
| 373 | The remaining arguments are C<KEY=VALUE> pairs. The following key-value |
425 | The remaining arguments are C<KEY=VALUE> pairs. The following key-value |
| 374 | pairs are known at this time: |
426 | pairs are known at this time: |
| 375 | |
427 | |
| 376 | =over 4 |
428 | =over 4 |
| … | |
… | |
| 388 | =item tls=<major>.<minor> |
440 | =item tls=<major>.<minor> |
| 389 | |
441 | |
| 390 | Indicates that the other side supports TLS (version should be 1.0) and |
442 | Indicates that the other side supports TLS (version should be 1.0) and |
| 391 | wishes to do a TLS handshake. |
443 | wishes to do a TLS handshake. |
| 392 | |
444 | |
|
|
445 | =item timeout=<seconds> |
|
|
446 | |
|
|
447 | The amount of time after which this node should be detected as dead unless |
|
|
448 | some data has been received. The node is responsible to send traffic |
|
|
449 | reasonably more often than this interval (such as every timeout minus five |
|
|
450 | seconds). |
|
|
451 | |
| 393 | =back |
452 | =back |
|
|
453 | |
|
|
454 | =head3 Second Greeting Line |
| 394 | |
455 | |
| 395 | After this greeting line there will be a second line containing a |
456 | After this greeting line there will be a second line containing a |
| 396 | cryptographic nonce, i.e. random data of high quality. To keep the |
457 | cryptographic nonce, i.e. random data of high quality. To keep the |
| 397 | protocol text-only, these are usually 32 base64-encoded octets, but |
458 | protocol text-only, these are usually 32 base64-encoded octets, but |
| 398 | it could be anything that doesn't contain any ASCII CR or ASCII LF |
459 | it could be anything that doesn't contain any ASCII CR or ASCII LF |
| 399 | characters. |
460 | characters. |
| 400 | |
461 | |
| 401 | Example of the two lines of greeting: |
462 | I<< The two nonces B<must> be different, and an aemp implementation |
|
|
463 | B<must> check and fail when they are identical >>. |
| 402 | |
464 | |
| 403 | aemp;0;0;e7d.4a76f48f;10.0.0.1:4040;hmac_md6_64_256,hex_secret;json,storable;provider=AE-0.0;peeraddr=127.0.0.1:1235 |
465 | Example of a nonce line: |
| 404 | XntegV2Guvss0qNn7phCPnoU87xqxV+4Mqm/5y4iQm6a |
466 | |
|
|
467 | p/I122ql7kJR8lumW3lXlXCeBnyDAvz8NQo3x5IFowE4 |
| 405 | |
468 | |
| 406 | =head2 TLS handshake |
469 | =head2 TLS handshake |
| 407 | |
470 | |
| 408 | If, after the handshake, both sides indicate interest in TLS, then the |
471 | I<< If, after the handshake, both sides indicate interest in TLS, then the |
| 409 | connection I<must> use TLS, or fail. |
472 | connection B<must> use TLS, or fail. >> |
| 410 | |
473 | |
| 411 | Both sides compare their nonces, and the side who sent the lower nonce |
474 | Both sides compare their nonces, and the side who sent the lower nonce |
| 412 | value ("string" comparison on the raw octet values) becomes the client, |
475 | value ("string" comparison on the raw octet values) becomes the client, |
| 413 | and the one with the higher nonce the server. |
476 | and the one with the higher nonce the server. |
| 414 | |
477 | |
| … | |
… | |
| 425 | |
488 | |
| 426 | =item the authentication method chosen |
489 | =item the authentication method chosen |
| 427 | |
490 | |
| 428 | This must be one of the methods offered by the other side in the greeting. |
491 | This must be one of the methods offered by the other side in the greeting. |
| 429 | |
492 | |
|
|
493 | The currently supported authentication methods are: |
|
|
494 | |
|
|
495 | =over 4 |
|
|
496 | |
|
|
497 | =item cleartext |
|
|
498 | |
|
|
499 | This is simply the shared secret, lowercase-hex-encoded. This method is of |
|
|
500 | course very insecure, unless TLS is used, which is why this module will |
|
|
501 | accept, but not generate, cleartext auth replies. |
|
|
502 | |
|
|
503 | =item hmac_md6_64_256 |
|
|
504 | |
|
|
505 | This method uses an MD6 HMAC with 64 bit blocksize and 256 bit hash. First, the shared secret |
|
|
506 | is hashed with MD6: |
|
|
507 | |
|
|
508 | key = MD6 (secret) |
|
|
509 | |
|
|
510 | This secret is then used to generate the "local auth reply", by taking |
|
|
511 | the two local greeting lines and the two remote greeting lines (without |
|
|
512 | line endings), appending \012 to all of them, concatenating them and |
|
|
513 | calculating the MD6 HMAC with the key. |
|
|
514 | |
|
|
515 | lauth = HMAC_MD6 key, "lgreeting1\012lgreeting2\012rgreeting1\012rgreeting2\012" |
|
|
516 | |
|
|
517 | This authentication token is then lowercase-hex-encoded and sent to the |
|
|
518 | other side. |
|
|
519 | |
|
|
520 | Then the remote auth reply is generated using the same method, but local |
|
|
521 | and remote greeting lines swapped: |
|
|
522 | |
|
|
523 | rauth = HMAC_MD6 key, "rgreeting1\012rgreeting2\012lgreeting1\012lgreeting2\012" |
|
|
524 | |
|
|
525 | This is the token that is expected from the other side. |
|
|
526 | |
|
|
527 | =item tls |
|
|
528 | |
|
|
529 | This type is only valid iff TLS was enabled and the TLS handshake |
|
|
530 | was successful. It has no authentication data, as the server/client |
|
|
531 | certificate was successfully verified. |
|
|
532 | |
|
|
533 | Implementations supporting TLS I<must> accept this authentication type. |
|
|
534 | |
|
|
535 | =back |
|
|
536 | |
| 430 | =item the authentication data |
537 | =item the authentication data |
| 431 | |
538 | |
| 432 | The authentication data itself, usually base64 or hex-encoded data. |
539 | The authentication data itself, usually base64 or hex-encoded data, see |
|
|
540 | above. |
| 433 | |
541 | |
| 434 | =item the framing protocol chosen |
542 | =item the framing protocol chosen |
| 435 | |
543 | |
| 436 | This must be one of the framing protocols offered by the other side in the |
544 | This must be one of the framing protocols offered by the other side in the |
| 437 | greeting. Each side must accept the choice of the other side. |
545 | greeting. Each side must accept the choice of the other side. |
| 438 | |
546 | |
| 439 | =back |
547 | =back |
| 440 | |
548 | |
|
|
549 | Example of an authentication reply: |
|
|
550 | |
|
|
551 | hmac_md6_64_256;363d5175df38bd9eaddd3f6ca18aa1c0c4aa22f0da245ac638d048398c26b8d3;json |
|
|
552 | |
| 441 | =head2 DATA PHASE |
553 | =head2 DATA PHASE |
| 442 | |
554 | |
| 443 | After this, packets get exchanged using the chosen framing protocol. It is |
555 | After this, packets get exchanged using the chosen framing protocol. It is |
| 444 | quite possible that both sides use a different framing protocol. |
556 | quite possible that both sides use a different framing protocol. |
| 445 | |
557 | |
|
|
558 | =head2 FULL EXAMPLE |
|
|
559 | |
|
|
560 | This is an actual protocol dump of a handshake, followed by a single data |
|
|
561 | packet. The greater than/less than lines indicate the direction of the |
|
|
562 | transfer only. |
|
|
563 | |
|
|
564 | > aemp;0;nndKd+gn;10.0.0.1:4040;hmac_md6_64_256,cleartext;json,storable;provider=AE-0.0;peeraddr=127.0.0.1:1235 |
|
|
565 | > sRG8bbc4TDbkpvH8FTP4HBs87OhepH6VuApoZqXXskuG |
|
|
566 | < aemp;0;nmpKd+gh;127.0.0.1:1235,[::1]:1235;hmac_md6_64_256,cleartext;json,storable;provider=AE-0.0;peeraddr=127.0.0.1:58760 |
|
|
567 | < dCEUcL/LJVSTJcx8byEsOzrwhzJYOq+L3YcopA5T6EAo |
|
|
568 | > hmac_md6_64_256;9513d4b258975accfcb2ab7532b83690e9c119a502c612203332a591c7237788;json |
|
|
569 | < hmac_md6_64_256;0298d6ba2240faabb2b2e881cf86b97d70a113ca74a87dc006f9f1e9d3010f90;json |
|
|
570 | > ["","lookup","pinger","10.0.0.1:4040#nndKd+gn.a","resolved"] |
|
|
571 | |
| 446 | =head1 SEE ALSO |
572 | =head1 SEE ALSO |
| 447 | |
573 | |
| 448 | L<AnyEvent>. |
574 | L<AnyEvent>. |
| 449 | |
575 | |
| 450 | =head1 AUTHOR |
576 | =head1 AUTHOR |
