1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2019. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
%% -------------------------------------------------------------------------
%%
%% Module for encrypted Erlang protocol - a minimal encrypted
%% distribution protocol based on only a shared secret
%% and the crypto application
%%
-module(inet_crypto_dist).
-define(DIST_NAME, inet_crypto).
-define(DIST_PROTO, crypto).
-define(DRIVER, inet_tcp).
-define(FAMILY, inet).
-export([listen/1, accept/1, accept_connection/5,
setup/5, close/1, select/1, is_node_name/1]).
%% Generalized dist API, for sibling IPv6 module inet6_crypto_dist
-export([gen_listen/2, gen_accept/2, gen_accept_connection/6,
gen_setup/6, gen_close/2, gen_select/2]).
-export([nodelay/0]).
%% Debug
%%%-compile(export_all).
-export([dbg/0, test_server/0, test_client/1]).
-include_lib("kernel/include/net_address.hrl").
-include_lib("kernel/include/dist.hrl").
-include_lib("kernel/include/dist_util.hrl").
%% -------------------------------------------------------------------------
-record(params,
{socket,
dist_handle,
hmac_algorithm = sha256,
aead_cipher = aes_gcm,
iv = 12,
key = 16,
tag_len = 16,
rekey_interval = 32768
}).
-record(public_key_pair,
{type = ecdh,
params = brainpoolP384t1,
public,
private}).
params(Socket) ->
#params{socket = Socket}.
%% -------------------------------------------------------------------------
%% Keep the same public/private key pair during the node's lifetime
%% in the process state of a process linked to the acceptor process.
%% Create it the first time it is needed.
%%
start_public_key_pair() ->
spawn_link(
fun () ->
register(?MODULE, self()),
public_key_pair(#public_key_pair{})
end).
public_key_pair(PKP) ->
receive
{Pid, Tag, public_key_pair} ->
case PKP of
#public_key_pair{
type = Type,
params = Params,
public = undefined} ->
%%
{Public, Private} = crypto:generate_key(Type, Params),
PKP_1 =
PKP#public_key_pair{
public = Public, private = Private},
Pid ! {Tag, PKP_1},
public_key_pair(PKP_1);
#public_key_pair{} ->
Pid ! {Tag, PKP},
public_key_pair(PKP)
end
end.
public_key_pair() ->
Pid = whereis(?MODULE),
Ref = erlang:monitor(process, Pid),
Pid ! {self(), Ref, public_key_pair},
receive
{Ref, PKP} ->
erlang:demonitor(Ref, [flush]),
PKP;
{'DOWN', Ref, process, Pid, Reason} ->
error(Reason)
end.
%% -------------------------------------------------------------------------
%% Erlang distribution plugin structure explained to myself
%% -------
%% These are the processes involved in the distribution:
%% * net_kernel
%% * The Acceptor
%% * The Controller | Handshaker | Ticker
%% * The DistCtrl process that may be split into:
%% + The Output controller
%% + The Input controller
%% For the regular inet_tcp_dist distribution module, DistCtrl
%% is not one or two processes, but one port - a gen_tcp socket
%%
%% When the VM is started with the argument "-proto_dist inet_crypto"
%% net_kernel registers the module inet_crypto_dist acli,oams distribution
%% module. net_kernel calls listen/1 to create a listen socket
%% and then accept/1 with the listen socket as argument to spawn
%% the Acceptor process, which is linked to net_kernel. Apparently
%% the listen socket is owned by net_kernel - I wonder if it could
%% be owned by the Acceptor process instead...
%%
%% The Acceptor process calls blocking accept on the listen socket
%% and when an incoming socket is returned it spawns the DistCtrl
%% process a linked to the Acceptor. The ownership of the accepted
%% socket is transferred to the DistCtrl process.
%% A message is sent to net_kernel to inform it that an incoming
%% connection has appeared and the Acceptor awaits a reply from net_kernel.
%%
%% net_kernel then calls accept_connection/5 to spawn the Controller |
%% Handshaker | Ticker process that is linked to net_kernel.
%% The Controller then awaits a message from the Acceptor process.
%%
%% When net_kernel has spawned the Controller it replies with a message
%% to the Acceptor that then calls DistCtrl to changes its links
%% so DistCtrl ends up linked to the Controller and not to the Acceptor.
%% The Acceptor then sends a message to the Controller. The Controller
%% then changes role into the Handshaker creates a #hs_data{} record
%% and calls dist_util:handshake_other_started/1. After this
%% the Acceptor goes back into a blocking accept on the listen socket.
%%
%% For the regular distribution inet_tcp_dist DistCtrl is a gen_tcp socket
%% and when it is a process it also acts as a socket. The #hs_data{}
%% record used by dist_util presents a set of funs that are used
%% by dist_util to perform the distribution handshake. These funs
%% make sure to transfer the handshake messages through the DistCtrl
%% "socket".
%%
%% When the handshake is finished a fun for this purpose in #hs_data{}
%% is called, which tells DistCtrl that it does not need to be prepared
%% for any more #hs_data{} handshake calls. The DistCtrl process in this
%% module then spawns the Input controller process that gets ownership
%% of the connection's gen_tcp socket and changes into {active, N} mode
%% so now it gets all incoming traffic and delivers that to the VM.
%% The original DistCtrl process changes role into the Output controller
%% process and starts asking the VM for outbound messages and transfers
%% them on the connection socket.
%%
%% The Handshaker now changes into the Ticker role, and uses only two
%% functions in the #hs_data{} record; one to get socket statistics
%% and one to send a tick. None of these may block for any reason
%% in particular not for a congested socket since that would destroy
%% connection supervision.
%%
%%
%% For an connection net_kernel calls setup/5 which spawns the
%% Controller process as linked to net_kernel. This Controller process
%% connects to the other node's listen socket and when that is succesful
%% spawns the DistCtrl process as linked to the controller and transfers
%% socket ownership to it.
%%
%% Then the Controller creates the #hs_data{} record and calls
%% dist_util:handshake_we_started/1 which changes the process role
%% into Handshaker.
%%
%% When the distribution handshake is finished the procedure is just
%% as for an incoming connection above.
%%
%%
%% To sum it up.
%%
%% There is an Acceptor process that is linked to net_kernel and
%% informs it when new connections arrive.
%%
%% net_kernel spawns Controllers for incoming and for outgoing connections.
%% these Controllers use the DistCtrl processes to do distribution
%% handshake and after that becomes Tickers that supervise the connection.
%%
%% The Controller | Handshaker | Ticker is linked to net_kernel, and to
%% DistCtrl, one or both. If any of these connection processes would die
%% all others should be killed by the links. Therefore none of them may
%% terminate with reason 'normal'.
%% -------------------------------------------------------------------------
%% -------------------------------------------------------------------------
%% select/1 is called by net_kernel to ask if this distribution protocol
%% is willing to handle Node
%%
select(Node) ->
gen_select(Node, ?DRIVER).
gen_select(Node, Driver) ->
case dist_util:split_node(Node) of
{node, _, Host} ->
case Driver:getaddr(Host) of
{ok, _} -> true;
_ -> false
end;
_ ->
false
end.
%% -------------------------------------------------------------------------
is_node_name(Node) ->
dist_util:is_node_name(Node).
%% -------------------------------------------------------------------------
%% Called by net_kernel to create a listen socket for this
%% distribution protocol. This listen socket is used by
%% the Acceptor process.
%%
listen(Name) ->
gen_listen(Name, ?DRIVER).
gen_listen(Name, Driver) ->
case inet_tcp_dist:gen_listen(Driver, Name) of
{ok, {Socket, Address, Creation}} ->
inet:setopts(Socket, [binary, {nodelay, true}]),
{ok,
{Socket, Address#net_address{protocol = ?DIST_PROTO}, Creation}};
Other ->
Other
end.
%% -------------------------------------------------------------------------
%% Called by net_kernel to spawn the Acceptor process that awaits
%% new connection in a blocking accept and informs net_kernel
%% when a new connection has appeared, and starts the DistCtrl
%% "socket" process for the connection.
%%
accept(Listen) ->
gen_accept(Listen, ?DRIVER).
gen_accept(Listen, Driver) ->
NetKernel = self(),
%%
%% Spawn Acceptor process
%%
monitor_dist_proc(
spawn_opt(
fun () ->
start_public_key_pair(),
accept_loop(Listen, Driver, NetKernel)
end,
[link, {priority, max}])).
accept_loop(Listen, Driver, NetKernel) ->
case Driver:accept(trace(Listen)) of
{ok, Socket} ->
wait_for_code_server(),
Timeout = net_kernel:connecttime(),
DistCtrl = start_dist_ctrl(trace(Socket), Timeout),
%% DistCtrl is a "socket"
NetKernel !
trace({accept,
self(), DistCtrl, Driver:family(), ?DIST_PROTO}),
receive
{NetKernel, controller, Controller} ->
call_dist_ctrl(DistCtrl, {controller, Controller, self()}),
Controller ! {self(), controller, Socket};
{NetKernel, unsupported_protocol} ->
exit(unsupported_protocol)
end,
accept_loop(Listen, Driver, NetKernel);
AcceptError ->
exit({accept, AcceptError})
end.
wait_for_code_server() ->
%% This is an ugly hack. Starting encryption on a connection
%% requires the crypto module to be loaded. Loading the crypto
%% module triggers its on_load function, which calls
%% code:priv_dir/1 to find the directory where its NIF library is.
%% However, distribution is started earlier than the code server,
%% so the code server is not necessarily started yet, and
%% code:priv_dir/1 might fail because of that, if we receive
%% an incoming connection on the distribution port early enough.
%%
%% If the on_load function of a module fails, the module is
%% unloaded, and the function call that triggered loading it fails
%% with 'undef', which is rather confusing.
%%
%% So let's avoid that by waiting for the code server to start.
%%
case whereis(code_server) of
undefined ->
timer:sleep(10),
wait_for_code_server();
Pid when is_pid(Pid) ->
ok
end.
%% -------------------------------------------------------------------------
%% Called by net_kernel when a new connection has appeared, to spawn
%% a Controller process that performs the handshake with the new node,
%% and then becomes the Ticker connection supervisor.
%% -------------------------------------------------------------------------
accept_connection(Acceptor, DistCtrl, MyNode, Allowed, SetupTime) ->
gen_accept_connection(
Acceptor, DistCtrl, MyNode, Allowed, SetupTime, ?DRIVER).
gen_accept_connection(
Acceptor, DistCtrl, MyNode, Allowed, SetupTime, Driver) ->
NetKernel = self(),
%%
%% Spawn Controller/handshaker/ticker process
%%
monitor_dist_proc(
spawn_opt(
fun() ->
do_accept(
Acceptor, DistCtrl,
trace(MyNode), Allowed, SetupTime, Driver, NetKernel)
end,
[link, {priority, max}])).
do_accept(
Acceptor, DistCtrl, MyNode, Allowed, SetupTime, Driver, NetKernel) ->
%%
receive
{Acceptor, controller, Socket} ->
Timer = dist_util:start_timer(SetupTime),
HSData =
hs_data_common(
NetKernel, MyNode, DistCtrl, Timer,
Socket, Driver:family()),
HSData_1 =
HSData#hs_data{
this_node = MyNode,
this_flags = 0,
allowed = Allowed},
dist_util:handshake_other_started(trace(HSData_1))
end.
%% -------------------------------------------------------------------------
%% Called by net_kernel to spawn a Controller process that sets up
%% a new connection to another Erlang node, performs the handshake
%% with the other it, and then becomes the Ticker process
%% that supervises the connection.
%% -------------------------------------------------------------------------
setup(Node, Type, MyNode, LongOrShortNames, SetupTime) ->
gen_setup(Node, Type, MyNode, LongOrShortNames, SetupTime, ?DRIVER).
gen_setup(Node, Type, MyNode, LongOrShortNames, SetupTime, Driver) ->
NetKernel = self(),
%%
%% Spawn Controller/handshaker/ticker process
%%
monitor_dist_proc(
spawn_opt(
setup_fun(
Node, Type, MyNode, LongOrShortNames, SetupTime, Driver, NetKernel),
[link, {priority, max}])).
-spec setup_fun(_,_,_,_,_,_,_) -> fun(() -> no_return()).
setup_fun(
Node, Type, MyNode, LongOrShortNames, SetupTime, Driver, NetKernel) ->
%%
fun() ->
do_setup(
trace(Node), Type, MyNode, LongOrShortNames, SetupTime,
Driver, NetKernel)
end.
-spec do_setup(_,_,_,_,_,_,_) -> no_return().
do_setup(
Node, Type, MyNode, LongOrShortNames, SetupTime, Driver, NetKernel) ->
%%
{Name, Address} = split_node(Driver, Node, LongOrShortNames),
ErlEpmd = net_kernel:epmd_module(),
{ARMod, ARFun} = get_address_resolver(ErlEpmd, Driver),
Timer = trace(dist_util:start_timer(SetupTime)),
case ARMod:ARFun(Name, Address, Driver:family()) of
{ok, Ip, TcpPort, Version} ->
do_setup_connect(
Node, Type, MyNode, Timer, Driver, NetKernel,
Ip, TcpPort, Version);
{ok, Ip} ->
case ErlEpmd:port_please(Name, Ip) of
{port, TcpPort, Version} ->
do_setup_connect(
Node, Type, MyNode, Timer, Driver, NetKernel,
Ip, TcpPort, trace(Version));
Other ->
_ = trace(
{ErlEpmd, port_please, [Name, Ip], Other}),
?shutdown(Node)
end;
Other ->
_ = trace(
{ARMod, ARFun, [Name, Address, Driver:family()],
Other}),
?shutdown(Node)
end.
-spec do_setup_connect(_,_,_,_,_,_,_,_,_) -> no_return().
do_setup_connect(
Node, Type, MyNode, Timer, Driver, NetKernel,
Ip, TcpPort, Version) ->
dist_util:reset_timer(Timer),
ConnectOpts =
trace(
connect_options(
[binary, {active, false}, {packet, 2}, {nodelay, true}])),
case Driver:connect(Ip, TcpPort, ConnectOpts) of
{ok, Socket} ->
DistCtrl =
try start_dist_ctrl(Socket, net_kernel:connecttime())
catch error : {dist_ctrl, _} = DistCtrlError ->
_ = trace(DistCtrlError),
?shutdown(Node)
end,
%% DistCtrl is a "socket"
HSData =
hs_data_common(
NetKernel, MyNode, DistCtrl, Timer,
Socket, Driver:family()),
HSData_1 =
HSData#hs_data{
other_node = Node,
this_flags = 0,
other_version = Version,
request_type = Type},
dist_util:handshake_we_started(trace(HSData_1));
ConnectError ->
_ = trace(
{Driver, connect, [Ip, TcpPort, ConnectOpts],
ConnectError}),
?shutdown(Node)
end.
%% -------------------------------------------------------------------------
%% close/1 is only called by net_kernel on the socket returned by listen/1.
close(Socket) ->
gen_close(Socket, ?DRIVER).
gen_close(Socket, Driver) ->
Driver:close(trace(Socket)).
%% -------------------------------------------------------------------------
hs_data_common(NetKernel, MyNode, DistCtrl, Timer, Socket, Family) ->
%% Field 'socket' below is set to DistCtrl, which makes
%% the distribution handshake process (ticker) call
%% the funs below with DistCtrl as the S argument.
%% So, S =:= DistCtrl below...
#hs_data{
kernel_pid = NetKernel,
this_node = MyNode,
socket = DistCtrl,
timer = Timer,
%%
f_send = % -> ok | {error, closed}=>?shutdown()
fun (S, Packet) when S =:= DistCtrl ->
try call_dist_ctrl(S, {send, Packet})
catch error : {dist_ctrl, Reason} ->
_ = trace(Reason),
{error, closed}
end
end,
f_recv = % -> {ok, List} | Other=>?shutdown()
fun (S, 0, infinity) when S =:= DistCtrl ->
try call_dist_ctrl(S, recv) of
{ok, Bin} when is_binary(Bin) ->
{ok, binary_to_list(Bin)};
Error ->
Error
catch error : {dist_ctrl, Reason} ->
{error, trace(Reason)}
end
end,
f_setopts_pre_nodeup =
fun (S) when S =:= DistCtrl ->
ok
end,
f_setopts_post_nodeup =
fun (S) when S =:= DistCtrl ->
ok
end,
f_getll =
fun (S) when S =:= DistCtrl ->
{ok, S} %% DistCtrl is the distribution port
end,
f_address = % -> #net_address{} | ?shutdown()
fun (S, Node) when S =:= DistCtrl ->
try call_dist_ctrl(S, peername) of
{ok, Address} ->
case dist_util:split_node(Node) of
{node, _, Host} ->
#net_address{
address = Address,
host = Host,
protocol = ?DIST_PROTO,
family = Family};
_ ->
?shutdown(Node)
end;
Error ->
_ = trace(Error),
?shutdown(Node)
catch error : {dist_ctrl, Reason} ->
_ = trace(Reason),
?shutdown(Node)
end
end,
f_handshake_complete = % -> ok | ?shutdown()
fun (S, Node, DistHandle) when S =:= DistCtrl ->
try call_dist_ctrl(S, {handshake_complete, DistHandle})
catch error : {dist_ctrl, Reason} ->
_ = trace(Reason),
?shutdown(Node)
end
end,
%%
%% mf_tick/1, mf_getstat/1, mf_setopts/2 and mf_getopts/2
%% are called by the ticker any time after f_handshake_complete/3
%% so they may not block the caller even for congested socket
mf_tick =
fun (S) when S =:= DistCtrl ->
S ! dist_tick
end,
mf_getstat = % -> {ok, RecvCnt, SendCnt, SendPend} | Other=>ignore_it
fun (S) when S =:= DistCtrl ->
case
inet:getstat(Socket, [recv_cnt, send_cnt, send_pend])
of
{ok, Stat} ->
split_stat(Stat, 0, 0, 0);
Error ->
trace(Error)
end
end,
mf_setopts =
fun (S, Opts) when S =:= DistCtrl ->
inet:setopts(Socket, setopts_filter(Opts))
end,
mf_getopts =
fun (S, Opts) when S =:= DistCtrl ->
inet:getopts(Socket, Opts)
end}.
setopts_filter(Opts) ->
[Opt ||
Opt <- Opts,
case Opt of
{K, _} when K =:= active; K =:= deliver; K =:= packet -> false;
K when K =:= list; K =:= binary -> false;
K when K =:= inet; K =:= inet6 -> false;
_ -> true
end].
split_stat([{recv_cnt, R}|Stat], _, W, P) ->
split_stat(Stat, R, W, P);
split_stat([{send_cnt, W}|Stat], R, _, P) ->
split_stat(Stat, R, W, P);
split_stat([{send_pend, P}|Stat], R, W, _) ->
split_stat(Stat, R, W, P);
split_stat([], R, W, P) ->
{ok, R, W, P}.
%% ------------------------------------------------------------
%% Determine if EPMD module supports address resolving. Default
%% is to use inet_tcp:getaddr/2.
%% ------------------------------------------------------------
get_address_resolver(EpmdModule, _Driver) ->
case erlang:function_exported(EpmdModule, address_please, 3) of
true -> {EpmdModule, address_please};
_ -> {erl_epmd, address_please}
end.
%% If Node is illegal terminate the connection setup!!
split_node(Driver, Node, LongOrShortNames) ->
case dist_util:split_node(Node) of
{node, Name, Host} ->
check_node(Driver, Node, Name, Host, LongOrShortNames);
{host, _} ->
error_logger:error_msg(
"** Nodename ~p illegal, no '@' character **~n",
[Node]),
?shutdown2(Node, trace({illegal_node_n@me, Node}));
_ ->
error_logger:error_msg(
"** Nodename ~p illegal **~n", [Node]),
?shutdown2(Node, trace({illegal_node_name, Node}))
end.
check_node(Driver, Node, Name, Host, LongOrShortNames) ->
case string:split(Host, ".", all) of
[_] when LongOrShortNames =:= longnames ->
case Driver:parse_address(Host) of
{ok, _} ->
{Name, Host};
_ ->
error_logger:error_msg(
"** System running to use "
"fully qualified hostnames **~n"
"** Hostname ~s is illegal **~n",
[Host]),
?shutdown2(Node, trace({not_longnames, Host}))
end;
[_, _|_] when LongOrShortNames =:= shortnames ->
error_logger:error_msg(
"** System NOT running to use "
"fully qualified hostnames **~n"
"** Hostname ~s is illegal **~n",
[Host]),
?shutdown2(Node, trace({not_shortnames, Host}));
_ ->
{Name, Host}
end.
%% -------------------------------------------------------------------------
connect_options(Opts) ->
case application:get_env(kernel, inet_dist_connect_options) of
{ok, ConnectOpts} ->
Opts ++ setopts_filter(ConnectOpts);
_ ->
Opts
end.
%% we may not always want the nodelay behaviour
%% for performance reasons
nodelay() ->
case application:get_env(kernel, dist_nodelay) of
undefined ->
{nodelay, true};
{ok, true} ->
{nodelay, true};
{ok, false} ->
{nodelay, false};
_ ->
{nodelay, true}
end.
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% The DistCtrl process(es).
%%
%% At net_kernel handshake_complete spawns off the input controller that
%% takes over the socket ownership, and itself becomes the output controller
%%
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% XXX Missing to "productified":
%%% * Cryptoanalysis by experts, this is crypto amateur work.
%%% * Is it useful?
%%% * An application to belong to (kernel)
%%% * Restart and/or code reload policy (not needed in kernel)
%%% * Fitting into the epmd/Erlang distro protocol version framework
%%% (something needs to be created for multiple protocols, epmd,
%%% multiple address families, fallback to previous version, etc)
%% Debug client and server
test_server() ->
{ok, Listen} = gen_tcp:listen(0, [{packet, 2}, {active, false}, binary]),
{ok, Port} = inet:port(Listen),
io:format(?MODULE_STRING":test_client(~w).~n", [Port]),
{ok, Socket} = gen_tcp:accept(Listen),
test(Socket).
test_client(Port) ->
{ok, Socket} =
gen_tcp:connect(
localhost, Port, [{packet, 2}, {active, false}, binary]),
test(Socket).
test(Socket) ->
start_dist_ctrl(Socket, 10000).
%% -------------------------------------------------------------------------
start_dist_ctrl(Socket, Timeout) ->
Secret = atom_to_binary(auth:get_cookie(), latin1),
Controller = self(),
Server =
monitor_dist_proc(
spawn_opt(
fun () ->
receive
{?MODULE, From, start} ->
{SendParams, RecvParams} =
init(Socket, Secret),
reply(From, self()),
handshake(SendParams, 1, RecvParams, 1, Controller)
end
end,
[link,
{priority, max},
{message_queue_data, off_heap},
{fullsweep_after, 0}])),
ok = gen_tcp:controlling_process(Socket, Server),
call_dist_ctrl(Server, start, Timeout).
call_dist_ctrl(Server, Msg) ->
call_dist_ctrl(Server, Msg, infinity).
%%
call_dist_ctrl(Server, Msg, Timeout) ->
Ref = erlang:monitor(process, Server),
Server ! {?MODULE, {Ref, self()}, Msg},
receive
{Ref, Res} ->
erlang:demonitor(Ref, [flush]),
Res;
{'DOWN', Ref, process, Server, Reason} ->
error({dist_ctrl, Reason})
after Timeout -> % Timeout < infinity is only used by start_dist_ctrl/2
receive
{'DOWN', Ref, process, Server, _} ->
receive {Ref, _} -> ok after 0 -> ok end,
error({dist_ctrl, timeout})
%% Server will be killed by link
end
end.
reply({Ref, Pid}, Msg) ->
Pid ! {Ref, Msg},
ok.
%% -------------------------------------------------------------------------
-define(TCP_ACTIVE, 16).
-define(CHUNK_SIZE, (65536 - 512)).
%% The start chunk starts with zeros, so it seems logical to
%% not have a chunk type with value 0
-define(HANDSHAKE_CHUNK, 1).
-define(DATA_CHUNK, 2).
-define(TICK_CHUNK, 3).
-define(REKEY_CHUNK, 4).
%% -------------------------------------------------------------------------
%% Crypto strategy
%% -------
%% The crypto strategy is as simple as possible to get an encrypted
%% connection as benchmark reference. It is geared around AEAD
%% ciphers in particular AES-GCM.
%%
%% The init message and the start message must fit in the TCP buffers
%% since both sides start with sending the init message, waits
%% for the other end's init message, sends the start message
%% and waits for the other end's start message. So if the send
%% blocks we have a deadlock.
%%
%% The init + start sequence tries to implement Password Encrypted
%% Key Exchange using a node public/private keypair and the
%% shared secret (the Cookie) to create session encryption keys
%% that can not be re-created if the shared secret is compromized,
%% which should create forward secrecy. You need both nodes'
%% keypairs and the shared secret to decrypt the traffic
%% between the nodes.
%%
%% All exchanged messages uses {packet, 2} i.e 16 bit size header.
%%
%% The init message contains a random number and encrypted: the public key
%% and two random numbers. The encryption is done with Key and IV hashed
%% from the unencrypted random number and the shared secret.
%%
%% The other node's public key is used with the own node's private
%% key to create a shared key that is hashed with one of the encrypted
%% random numbers from each side to create Key and IV for the session.
%%
%% The start message contains the two encrypted random numbers
%% this time encrypted with the session keys for verification
%% by the other side, plus the rekey interval. The rekey interval
%% is just there to get an early check for if the other side's
%% maximum rekey interal is acceptable, it is just an embryo
%% of some better check. Any side may rekey earlier but if the
%% rekey interval is exceeded the connection fails.
%%
%% Subsequent encrypted messages has the sequence number and the length
%% of the message as AAD data, and an incrementing IV. These messages
%% has got a message type that differentes data from ticks and rekeys.
%% Ticks have a random size in an attempt to make them less obvious to spot.
%%
%% The only reaction to errors is to crash noisily wich will bring
%% down the connection and hopefully produce something useful
%% in the local log, but all the other end sees is a closed connection.
%% -------------------------------------------------------------------------
init(Socket, Secret) ->
#public_key_pair{public = PubKey} = PKP = public_key_pair(),
Params = params(Socket),
{R2, R3, Msg} = init_msg(Params, PubKey, Secret),
ok = gen_tcp:send(Socket, Msg),
init_recv(Params, Secret, PKP, R2, R3).
init_recv(
#params{socket = Socket, iv = IVLen} = Params, Secret, PKP, R2, R3) ->
%%
{ok, InitMsg} = gen_tcp:recv(Socket, 0),
IVSaltLen = IVLen - 6,
try
case init_msg(Params, Secret, PKP, R2, R3, InitMsg) of
{#params{iv = <<IV2ASalt:IVSaltLen/binary, IV2ANo:48>>} =
SendParams,
RecvParams, SendStartMsg} ->
ok = gen_tcp:send(Socket, SendStartMsg),
{ok, RecvStartMsg} = gen_tcp:recv(Socket, 0),
#params{
iv = <<IV2BSalt:IVSaltLen/binary, IV2BNo:48>>} =
RecvParams_1 =
start_msg(RecvParams, R2, R3, RecvStartMsg),
{SendParams#params{iv = {IV2ASalt, IV2ANo}},
RecvParams_1#params{iv = {IV2BSalt, IV2BNo}}}
end
catch
error : Reason : Stacktrace->
_ = trace({Reason, Stacktrace}),
exit(connection_closed)
end.
init_msg(
#params{
hmac_algorithm = HmacAlgo,
aead_cipher = AeadCipher,
key = KeyLen,
iv = IVLen,
tag_len = TagLen}, PubKeyA, Secret) ->
%%
RLen = KeyLen + IVLen,
<<R1A:RLen/binary, R2A:RLen/binary, R3A:RLen/binary>> =
crypto:strong_rand_bytes(3 * RLen),
{Key1A, IV1A} = hmac_key_iv(HmacAlgo, R1A, Secret, KeyLen, IVLen),
Plaintext = [R2A, R3A, PubKeyA],
MsgLen = byte_size(R1A) + TagLen + iolist_size(Plaintext),
AAD = [<<MsgLen:32>>, R1A],
{Ciphertext, Tag} =
crypto:block_encrypt(AeadCipher, Key1A, IV1A, {AAD, Plaintext, TagLen}),
Msg = [R1A, Tag, Ciphertext],
{R2A, R3A, Msg}.
%%
init_msg(
#params{
hmac_algorithm = HmacAlgo,
aead_cipher = AeadCipher,
key = KeyLen,
iv = IVLen,
tag_len = TagLen,
rekey_interval = RekeyInterval} = Params,
Secret,
#public_key_pair{
type = PublicKeyType,
params = PublicKeyParams,
private = PrivKey},
R2A, R3A, Msg) ->
%%
RLen = KeyLen + IVLen,
case Msg of
<<R1B:RLen/binary, Tag:TagLen/binary, Ciphertext/binary>> ->
{Key1B, IV1B} = hmac_key_iv(HmacAlgo, R1B, Secret, KeyLen, IVLen),
MsgLen = byte_size(Msg),
AAD = [<<MsgLen:32>>, R1B],
case
crypto:block_decrypt(
AeadCipher, Key1B, IV1B, {AAD, Ciphertext, Tag})
of
<<R2B:RLen/binary, R3B:RLen/binary, PubKeyB/binary>> ->
SharedSecret =
crypto:compute_key(
PublicKeyType, PubKeyB, PrivKey, PublicKeyParams),
%%
{Key2A, IV2A} =
hmac_key_iv(
HmacAlgo, SharedSecret, [R2A, R3B], KeyLen, IVLen),
SendParams = Params#params{key = Key2A, iv = IV2A},
%%
StartCleartext = [R2B, R3B, <<RekeyInterval:32>>],
StartMsgLen = TagLen + iolist_size(StartCleartext),
StartAAD = <<StartMsgLen:32>>,
{StartCiphertext, StartTag} =
crypto:block_encrypt(
AeadCipher, Key2A, IV2A,
{StartAAD, StartCleartext, TagLen}),
StartMsg = [StartTag, StartCiphertext],
%%
{Key2B, IV2B} =
hmac_key_iv(
HmacAlgo, SharedSecret, [R2B, R3A], KeyLen, IVLen),
RecvParams = Params#params{key = Key2B, iv = IV2B},
%%
{SendParams, RecvParams, StartMsg}
end
end.
start_msg(
#params{
aead_cipher = AeadCipher,
key = Key2B,
iv = IV2B,
tag_len = TagLen,
rekey_interval = RekeyIntervalA} = RecvParams, R2A, R3A, Msg) ->
%%
case Msg of
<<Tag:TagLen/binary, Ciphertext/binary>> ->
KeyLen = byte_size(Key2B),
IVLen = byte_size(IV2B),
RLen = KeyLen + IVLen,
MsgLen = byte_size(Msg),
AAD = <<MsgLen:32>>,
case
crypto:block_decrypt(
AeadCipher, Key2B, IV2B, {AAD, Ciphertext, Tag})
of
<<R2A:RLen/binary, R3A:RLen/binary, RekeyIntervalB:32>>
when RekeyIntervalA =< (RekeyIntervalB bsl 2),
RekeyIntervalB =< (RekeyIntervalA bsl 2) ->
RecvParams#params{rekey_interval = RekeyIntervalB}
end
end.
hmac_key_iv(HmacAlgo, MacKey, Data, KeyLen, IVLen) ->
<<Key:KeyLen/binary, IV:IVLen/binary>> =
crypto:hmac(HmacAlgo, MacKey, Data, KeyLen + IVLen),
{Key, IV}.
%% -------------------------------------------------------------------------
%% net_kernel distribution handshake in progress
%%
handshake(
SendParams, SendSeq,
#params{socket = Socket} = RecvParams, RecvSeq, Controller) ->
receive
{?MODULE, From, {controller, Controller_1, Parent}} ->
Result = link(Controller_1),
true = unlink(Parent),
reply(From, Result),
handshake(SendParams, SendSeq, RecvParams, RecvSeq, Controller_1);
{?MODULE, From, {handshake_complete, DistHandle}} ->
InputHandler =
monitor_dist_proc(
spawn_opt(
fun () ->
link(Controller),
receive
DistHandle ->
ok =
inet:setopts(
Socket,
[{active, ?TCP_ACTIVE},
nodelay()]),
input_handler(
RecvParams#params{
dist_handle = DistHandle},
RecvSeq, empty_q(), infinity)
end
end,
[link,
{priority, normal},
{message_queue_data, off_heap},
{fullsweep_after, 0}])),
_ = monitor(process, InputHandler), % For the benchmark test
ok = gen_tcp:controlling_process(Socket, InputHandler),
ok = erlang:dist_ctrl_input_handler(DistHandle, InputHandler),
InputHandler ! DistHandle,
crypto:rand_seed_alg(crypto_cache),
reply(From, ok),
process_flag(priority, normal),
erlang:dist_ctrl_get_data_notification(DistHandle),
output_handler(
SendParams#params{dist_handle = DistHandle}, SendSeq);
%%
{?MODULE, From, {send, Data}} ->
case
encrypt_and_send_chunk(
SendParams, SendSeq, [?HANDSHAKE_CHUNK, Data])
of
{SendParams_1, SendSeq_1, ok} ->
reply(From, ok),
handshake(
SendParams_1, SendSeq_1, RecvParams, RecvSeq,
Controller);
{_, _, Error} ->
reply(From, {error, closed}),
death_row({send, trace(Error)})
end;
{?MODULE, From, recv} ->
case recv_and_decrypt_chunk(RecvParams, RecvSeq) of
{RecvParams_1, RecvSeq_1, {ok, _} = Reply} ->
reply(From, Reply),
handshake(
SendParams, SendSeq, RecvParams_1, RecvSeq_1,
Controller);
{_, _, Error} ->
reply(From, Error),
death_row({recv, trace(Error)})
end;
{?MODULE, From, peername} ->
reply(From, inet:peername(Socket)),
handshake(SendParams, SendSeq, RecvParams, RecvSeq, Controller);
%%
_Alien ->
handshake(SendParams, SendSeq, RecvParams, RecvSeq, Controller)
end.
recv_and_decrypt_chunk(#params{socket = Socket} = RecvParams, RecvSeq) ->
case gen_tcp:recv(Socket, 0) of
{ok, Chunk} ->
case decrypt_chunk(RecvParams, RecvSeq, Chunk) of
<<?HANDSHAKE_CHUNK, Cleartext/binary>> ->
{RecvParams, RecvSeq + 1, {ok, Cleartext}};
OtherChunk when is_binary(OtherChunk) ->
{RecvParams, RecvSeq + 1, {error, decrypt_error}};
#params{} = RecvParams_1 ->
recv_and_decrypt_chunk(RecvParams_1, 0);
error ->
{RecvParams, RecvSeq, {error, decrypt_error}}
end;
Error ->
{RecvParams, RecvSeq, Error}
end.
%% -------------------------------------------------------------------------
%% Output handler process
%%
%% The game here is to flush all dist_data and dist_tick messages,
%% prioritize dist_data over dist_tick, and to not use selective receive
output_handler(Params, Seq) ->
receive
Msg ->
case Msg of
dist_data ->
output_handler_data(Params, Seq);
dist_tick ->
output_handler_tick(Params, Seq);
Other ->
%% Ignore
_ = trace(Other),
output_handler(Params, Seq)
end
end.
output_handler_data(Params, Seq) ->
receive
Msg ->
case Msg of
dist_data ->
output_handler_data(Params, Seq);
dist_tick ->
output_handler_data(Params, Seq);
Other ->
%% Ignore
_ = trace(Other),
output_handler_data(Params, Seq)
end
after 0 ->
DistHandle = Params#params.dist_handle,
Q = get_data(DistHandle, empty_q()),
{Params_1, Seq_1} = output_handler_send(Params, Seq, Q),
erlang:dist_ctrl_get_data_notification(DistHandle),
output_handler(Params_1, Seq_1)
end.
output_handler_tick(Params, Seq) ->
receive
Msg ->
case Msg of
dist_data ->
output_handler_data(Params, Seq);
dist_tick ->
output_handler_tick(Params, Seq);
Other ->
%% Ignore
_ = trace(Other),
output_handler_tick(Params, Seq)
end
after 0 ->
TickSize = 7 + rand:uniform(56),
TickData = binary:copy(<<0>>, TickSize),
case
encrypt_and_send_chunk(Params, Seq, [?TICK_CHUNK, TickData])
of
{Params_1, Seq_1, ok} ->
output_handler(Params_1, Seq_1);
{_, _, Error} ->
_ = trace(Error),
death_row()
end
end.
output_handler_send(Params, Seq, {_, Size, _} = Q) ->
if
?CHUNK_SIZE < Size ->
output_handler_send(Params, Seq, Q, ?CHUNK_SIZE);
true ->
case get_data(Params#params.dist_handle, Q) of
{_, 0, _} ->
{Params, Seq};
{_, Size, _} = Q_1 -> % Got no more
output_handler_send(Params, Seq, Q_1, Size);
Q_1 ->
output_handler_send(Params, Seq, Q_1)
end
end.
output_handler_send(Params, Seq, Q, Size) ->
{Cleartext, Q_1} = deq_iovec(Size, Q),
case
encrypt_and_send_chunk(Params, Seq, [?DATA_CHUNK, Cleartext])
of
{Params_1, Seq_1, ok} ->
output_handler_send(Params_1, Seq_1, Q_1);
{_, _, Error} ->
_ = trace(Error),
death_row()
end.
%% -------------------------------------------------------------------------
%% Input handler process
%%
%% Here is T = 0|infinity to steer if we should try to receive
%% more data or not; start with infinity, and when we get some
%% data try with 0 to see if more is waiting
input_handler(#params{socket = Socket} = Params, Seq, Q, T) ->
receive
Msg ->
case Msg of
{tcp_passive, Socket} ->
ok = inet:setopts(Socket, [{active, ?TCP_ACTIVE}]),
Q_1 =
case T of
0 ->
deliver_data(Params#params.dist_handle, Q);
infinity ->
Q
end,
input_handler(Params, Seq, Q_1, infinity);
{tcp, Socket, Chunk} ->
input_chunk(Params, Seq, Q, T, Chunk);
{tcp_closed, Socket} ->
exit(connection_closed);
Other ->
%% Ignore...
_ = trace(Other),
input_handler(Params, Seq, Q, T)
end
after T ->
Q_1 = deliver_data(Params#params.dist_handle, Q),
input_handler(Params, Seq, Q_1, infinity)
end.
input_chunk(Params, Seq, Q, T, Chunk) ->
case decrypt_chunk(Params, Seq, Chunk) of
<<?DATA_CHUNK, Cleartext/binary>> ->
input_handler(Params, Seq + 1, enq_binary(Cleartext, Q), 0);
<<?TICK_CHUNK, _/binary>> ->
input_handler(Params, Seq + 1, Q, T);
OtherChunk when is_binary(OtherChunk) ->
_ = trace(invalid_chunk),
exit(connection_closed);
#params{} = Params_1 ->
input_handler(Params_1, 0, Q, T);
error ->
_ = trace(decrypt_error),
exit(connection_closed)
end.
%% -------------------------------------------------------------------------
%% erlang:dist_ctrl_* helpers
%% Get data for sending from the VM and place it in a queue
%%
get_data(DistHandle, {Front, Size, Rear}) ->
get_data(DistHandle, Front, Size, Rear).
%%
get_data(DistHandle, Front, Size, Rear) ->
case erlang:dist_ctrl_get_data(DistHandle) of
none ->
{Front, Size, Rear};
Bin when is_binary(Bin) ->
Len = byte_size(Bin),
get_data(
DistHandle, Front, Size + 4 + Len,
[Bin, <<Len:32>>|Rear]);
[Bin1, Bin2] ->
Len = byte_size(Bin1) + byte_size(Bin2),
get_data(
DistHandle, Front, Size + 4 + Len,
[Bin2, Bin1, <<Len:32>>|Rear]);
Iovec ->
Len = iolist_size(Iovec),
get_data(
DistHandle, Front, Size + 4 + Len,
lists:reverse(Iovec, [<<Len:32>>|Rear]))
end.
%% De-packet and deliver received data to the VM from a queue
%%
deliver_data(DistHandle, Q) ->
case Q of
{[], Size, []} ->
Size = 0, % Assert
Q;
{[], Size, Rear} ->
[Bin|Front] = lists:reverse(Rear),
deliver_data(DistHandle, Front, Size, [], Bin);
{[Bin|Front], Size, Rear} ->
deliver_data(DistHandle, Front, Size, Rear, Bin)
end.
%%
deliver_data(DistHandle, Front, Size, Rear, Bin) ->
case Bin of
<<DataSizeA:32, DataA:DataSizeA/binary,
DataSizeB:32, DataB:DataSizeB/binary, Rest/binary>> ->
erlang:dist_ctrl_put_data(DistHandle, DataA),
erlang:dist_ctrl_put_data(DistHandle, DataB),
deliver_data(
DistHandle,
Front, Size - (4 + DataSizeA + 4 + DataSizeB), Rear,
Rest);
<<DataSize:32, Data:DataSize/binary, Rest/binary>> ->
erlang:dist_ctrl_put_data(DistHandle, Data),
deliver_data(DistHandle, Front, Size - (4 + DataSize), Rear, Rest);
<<DataSize:32, FirstData/binary>> ->
TotalSize = 4 + DataSize,
if
TotalSize =< Size ->
BinSize = byte_size(Bin),
{MoreData, Q} =
deq_iovec(
TotalSize - BinSize,
Front, Size - BinSize, Rear),
erlang:dist_ctrl_put_data(DistHandle, [FirstData|MoreData]),
deliver_data(DistHandle, Q);
true -> % Incomplete data
{[Bin|Front], Size, Rear}
end;
<<_/binary>> ->
BinSize = byte_size(Bin),
if
4 =< Size -> % Fragmented header - extract a header bin
{RestHeader, {Front_1, _Size_1, Rear_1}} =
deq_iovec(4 - BinSize, Front, Size - BinSize, Rear),
Header = iolist_to_binary([Bin|RestHeader]),
deliver_data(DistHandle, Front_1, Size, Rear_1, Header);
true -> % Incomplete header
{[Bin|Front], Size, Rear}
end
end.
%% -------------------------------------------------------------------------
%% Encryption and decryption helpers
encrypt_and_send_chunk(
#params{
socket = Socket, rekey_interval = Seq,
key = Key, iv = {IVSalt, _}, hmac_algorithm = HmacAlgo} = Params,
Seq, Cleartext) ->
%%
KeyLen = byte_size(Key),
IVSaltLen = byte_size(IVSalt),
R = crypto:strong_rand_bytes(KeyLen + IVSaltLen + 6),
case
gen_tcp:send(
Socket, encrypt_chunk(Params, Seq, [?REKEY_CHUNK, R]))
of
ok ->
{Key_1, <<IVSalt_1:IVSaltLen/binary, IVNo_1:48>>} =
hmac_key_iv(HmacAlgo, Key, R, KeyLen, IVSaltLen + 6),
Params_1 = Params#params{key = Key_1, iv = {IVSalt_1, IVNo_1}},
Result =
gen_tcp:send(Socket, encrypt_chunk(Params_1, 0, Cleartext)),
{Params_1, 1, Result};
SendError ->
{Params, Seq + 1, SendError}
end;
encrypt_and_send_chunk(#params{socket = Socket} = Params, Seq, Cleartext) ->
Result = gen_tcp:send(Socket, encrypt_chunk(Params, Seq, Cleartext)),
{Params, Seq + 1, Result}.
encrypt_chunk(
#params{
aead_cipher = AeadCipher,
iv = {IVSalt, IVNo}, key = Key, tag_len = TagLen}, Seq, Cleartext) ->
%%
ChunkLen = iolist_size(Cleartext) + TagLen,
AAD = <<Seq:32, ChunkLen:32>>,
IVBin = <<IVSalt/binary, (IVNo + Seq):48>>,
{Ciphertext, CipherTag} =
crypto:block_encrypt(AeadCipher, Key, IVBin, {AAD, Cleartext, TagLen}),
Chunk = [Ciphertext,CipherTag],
Chunk.
decrypt_chunk(
#params{
aead_cipher = AeadCipher,
iv = {IVSalt, IVNo}, key = Key, tag_len = TagLen} = Params, Seq, Chunk) ->
%%
ChunkLen = byte_size(Chunk),
if
ChunkLen < TagLen ->
error;
true ->
AAD = <<Seq:32, ChunkLen:32>>,
IVBin = <<IVSalt/binary, (IVNo + Seq):48>>,
CiphertextLen = ChunkLen - TagLen,
case Chunk of
<<Ciphertext:CiphertextLen/binary,
CipherTag:TagLen/binary>> ->
block_decrypt(
Params, Seq, AeadCipher, Key, IVBin,
{AAD, Ciphertext, CipherTag});
_ ->
error
end
end.
block_decrypt(
#params{rekey_interval = RekeyInterval} = Params,
Seq, AeadCipher, Key, IV, Data) ->
%%
case crypto:block_decrypt(AeadCipher, Key, IV, Data) of
<<?REKEY_CHUNK, Rest/binary>> ->
KeyLen = byte_size(Key),
IVLen = byte_size(IV),
IVSaltLen = IVLen - 6,
RLen = KeyLen + IVLen,
case Rest of
<<R:RLen/binary>> ->
{Key_1, <<IVSalt:IVSaltLen/binary, IVNo:48>>} =
hmac_key_iv(
Params#params.hmac_algorithm,
Key, R, KeyLen, IVLen),
Params#params{iv = {IVSalt, IVNo}, key = Key_1};
_ ->
error
end;
Chunk when is_binary(Chunk) ->
case Seq of
RekeyInterval ->
%% This was one chunk too many without rekeying
error;
_ ->
Chunk
end;
error ->
error
end.
%% -------------------------------------------------------------------------
%% Queue of binaries i.e an iovec queue
empty_q() ->
{[], 0, []}.
enq_binary(Bin, {Front, Size, Rear}) ->
{Front, Size + byte_size(Bin), [Bin|Rear]}.
deq_iovec(GetSize, {Front, Size, Rear}) when GetSize =< Size ->
deq_iovec(GetSize, Front, Size, Rear, []).
%%
deq_iovec(GetSize, Front, Size, Rear) ->
deq_iovec(GetSize, Front, Size, Rear, []).
%%
deq_iovec(GetSize, [], Size, Rear, Acc) ->
deq_iovec(GetSize, lists:reverse(Rear), Size, [], Acc);
deq_iovec(GetSize, [Bin|Front], Size, Rear, Acc) ->
BinSize = byte_size(Bin),
if
BinSize < GetSize ->
deq_iovec(
GetSize - BinSize, Front, Size - BinSize, Rear, [Bin|Acc]);
GetSize < BinSize ->
{Bin1,Bin2} = erlang:split_binary(Bin, GetSize),
{lists:reverse(Acc, [Bin1]), {[Bin2|Front], Size - GetSize, Rear}};
true ->
{lists:reverse(Acc, [Bin]), {Front, Size - BinSize, Rear}}
end.
%% -------------------------------------------------------------------------
death_row() -> death_row(connection_closed).
%%
death_row(normal) -> death_row(connection_closed);
death_row(Reason) -> receive after 5000 -> exit(Reason) end.
%% -------------------------------------------------------------------------
%% Trace point
trace(Term) -> Term.
%% Keep an eye on this Pid (debug)
monitor_dist_proc(Pid) ->
%%% spawn(
%%% fun () ->
%%% MRef = erlang:monitor(process, Pid),
%%% receive
%%% {'DOWN', MRef, _, _, normal} ->
%%% error_logger:error_report(
%%% [dist_proc_died,
%%% {reason, normal},
%%% {pid, Pid}]);
%%% {'DOWN', MRef, _, _, Reason} ->
%%% error_logger:info_report(
%%% [dist_proc_died,
%%% {reason, Reason},
%%% {pid, Pid}])
%%% end
%%% end),
Pid.
dbg() ->
dbg:stop(),
dbg:tracer(),
dbg:p(all, c),
dbg:tpl(?MODULE, trace, cx),
dbg:tpl(erlang, dist_ctrl_get_data_notification, cx),
dbg:tpl(erlang, dist_ctrl_get_data, cx),
dbg:tpl(erlang, dist_ctrl_put_data, cx),
ok.
|