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 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2008-2021. 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(ssh_compat_SUITE).
-include_lib("common_test/include/ct.hrl").
-include("ssh_transport.hrl"). % #ssh_msg_kexinit{}
-include_lib("kernel/include/inet.hrl"). % #hostent{}
-include_lib("kernel/include/file.hrl"). % #file_info{}
-include("ssh_test_lib.hrl").
-export([
suite/0,
all/0,
groups/0,
init_per_suite/1,
end_per_suite/1,
init_per_group/2,
end_per_group/2,
init_per_testcase/2,
end_per_testcase/2
]).
-export([
all_algorithms_sftp_exec_reneg_otp_is_client/1,
check_docker_present/1,
login_otp_is_client/1,
login_otp_is_server/1,
renegotiation_otp_is_server/1,
send_recv_big_with_renegotiate_otp_is_client/1
]).
-define(USER,"sshtester").
-define(PASSWD, "foobar").
-define(BAD_PASSWD, "NOT-"?PASSWD).
-define(DOCKER_PFX, "ssh_compat_suite-ssh").
%%--------------------------------------------------------------------
%% Common Test interface functions -----------------------------------
%%--------------------------------------------------------------------
suite() ->
[{timetrap,{seconds,90}}].
all() ->
%% [check_docker_present] ++
[{group,G} || G <- ssh_image_versions()].
groups() ->
[{otp_client, [], [login_otp_is_client,
all_algorithms_sftp_exec_reneg_otp_is_client,
send_recv_big_with_renegotiate_otp_is_client
]},
{otp_server, [], [login_otp_is_server,
renegotiation_otp_is_server
]} |
[{G, [], [{group,otp_client}, {group,otp_server}]} || G <- ssh_image_versions()]
].
ssh_image_versions() ->
try
%% Find all useful containers in such a way that undefined command, too low
%% privileges, no containers and containers found give meaningful result:
L0 = ["REPOSITORY"++_|_] = string:tokens(os:cmd("docker images"), "\r\n"),
[["REPOSITORY","TAG"|_]|L1] = [string:tokens(E, " ") || E<-L0],
[list_to_atom(V) || [?DOCKER_PFX,V|_] <- L1]
of
Vs ->
lists:sort(Vs)
catch
error:{badmatch,_} ->
[]
end.
%%--------------------------------------------------------------------
init_per_suite(Config) ->
?CHECK_CRYPTO(
case os:find_executable("docker") of
false ->
{skip, "No docker"};
_ ->
ssh:start(),
ct:log("Crypto info: ~p",[crypto:info_lib()]),
ct:log("ssh image versions: ~p",[ssh_image_versions()]),
Config
end).
end_per_suite(_Config) ->
%% Remove all containers that are not running:
%%% os:cmd("docker rm $(docker ps -aq -f status=exited)"),
%% Remove dangling images:
%%% os:cmd("docker rmi $(docker images -f dangling=true -q)"),
catch ssh:stop(),
ok.
init_per_group(otp_server, Config) ->
case proplists:get_value(common_remote_client_algs, Config) of
undefined ->
SSHver = proplists:get_value(ssh_version, Config, ""),
{skip,"No "++SSHver++ " client found in docker"};
_ ->
Config
end;
init_per_group(otp_client, Config) ->
Config;
init_per_group(G, Config0) ->
case lists:member(G, ssh_image_versions()) of
true ->
%% This group is for one of the images
Vssh = atom_to_list(G),
Cmnt = io_lib:format("+++ ~s +++",[Vssh]),
ct:comment("~s",[Cmnt]),
try start_docker(G) of
{ok,ID} ->
ct:log("==> ~p started",[G]),
%% Find the algorithms that both client and server supports:
{IP,Port} = ip_port([{id,ID}]),
ct:log("Try contact ~p:~p",[IP,Port]),
Config1 = [{id,ID},
{ssh_version,Vssh}
| Config0],
try common_algs(Config1, IP, Port) of
{ok, ServerHello, RemoteServerCommon, ClientHello, RemoteClientCommon} ->
case chk_hellos([ServerHello,ClientHello], Cmnt) of
Cmnt ->
ok;
NewCmnt ->
ct:comment("~s",[NewCmnt])
end,
AuthMethods =
%% This should be obtained by querying the peer, but that
%% is a bit hard. It is possible with ssh_protocol_SUITE
%% techniques, but it can wait.
case Vssh of
"dropbear" ++ _ ->
[password, publickey];
_ ->
[password, 'keyboard-interactive', publickey]
end,
[{common_remote_server_algs,RemoteServerCommon},
{common_remote_client_algs,RemoteClientCommon},
{common_authmethods,AuthMethods}
|Config1];
Other ->
ct:log("Error in init_per_group: ~p",[Other]),
stop_docker(ID),
{fail, "Can't contact docker sshd"}
catch
Class:Exc:ST ->
ct:log("common_algs: ~p:~p~n~p",[Class,Exc,ST]),
stop_docker(ID),
{fail, "Failed during setup"}
end
catch
cant_start_docker ->
{skip, "Can't start docker"};
C:E:ST ->
ct:log("No ~p~n~p:~p~n~p",[G,C,E,ST]),
{skip, "Can't start docker"}
end;
false ->
Config0
end.
end_per_group(G, Config) ->
case lists:member(G, ssh_image_versions()) of
true ->
catch stop_docker(proplists:get_value(id,Config));
false ->
ok
end.
init_per_testcase(TC, Config) when TC==login_otp_is_client ;
TC==all_algorithms_sftp_exec_reneg_otp_is_client ->
case proplists:get_value(ssh_version, Config) of
"openssh4.4p1-openssl0.9.8c" -> {skip, "Not tested"};
"openssh4.5p1-openssl0.9.8m" -> {skip, "Not tested"};
"openssh5.0p1-openssl0.9.8za" -> {skip, "Not tested"};
"openssh6.2p2-openssl0.9.8c" -> {skip, "Not tested"};
"openssh6.3p1-openssl0.9.8zh" -> {skip, "Not tested"};
"openssh6.6p1-openssl1.0.2n" -> {skip, "Not tested"};
_ ->
Config
end;
init_per_testcase(_, Config) ->
Config.
end_per_testcase(_TC, _Config) ->
ok.
%%--------------------------------------------------------------------
%% Test Cases --------------------------------------------------------
%%--------------------------------------------------------------------
check_docker_present(_Config) ->
ct:log("This testcase is just to show in Monitor that we have a test host with docker installed",[]),
{fail, "Test is OK: just showing docker is available"}.
%%--------------------------------------------------------------------
login_otp_is_client(Config) ->
{IP,Port} = ip_port(Config),
PublicKeyAlgs = [A || {public_key,A} <- proplists:get_value(common_remote_server_algs, Config)],
CommonAuths =
[{AuthMethod,Alg} || AuthMethod <- proplists:get_value(common_authmethods, Config),
Alg <- case AuthMethod of
publickey ->
PublicKeyAlgs;
_ ->
[' ']
end
],
chk_all_algos(?FUNCTION_NAME, CommonAuths, Config,
fun(AuthMethod,Alg) ->
{Opts,Dir} =
case AuthMethod of
publickey ->
{[{pref_public_key_algs, [Alg]}],
setup_remote_auth_keys_and_local_priv(Alg, Config)};
_ ->
{[{password,?PASSWD}], new_dir(Config)}
end,
ssh:connect(IP, Port, [{auth_methods, atom_to_list(AuthMethod)},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{user,?USER},
{user_dir, Dir},
{silently_accept_hosts,true},
{save_accepted_host, false},
{user_interaction,false}
| Opts
])
end).
%%--------------------------------------------------------------------
login_otp_is_server(Config) ->
PublicKeyAlgs = [A || {public_key,A} <- proplists:get_value(common_remote_client_algs, Config)],
CommonAuths =
[{AuthMethod,Alg} || AuthMethod <- proplists:get_value(common_authmethods, Config),
Alg <- case AuthMethod of
publickey ->
PublicKeyAlgs;
_ ->
[' ']
end
],
SysDir = setup_local_hostdir(hd(PublicKeyAlgs), Config),
chk_all_algos(?FUNCTION_NAME, CommonAuths, Config,
fun(AuthMethod,Alg) ->
{Opts,UsrDir} =
case AuthMethod of
publickey ->
{[{user_passwords, [{?USER,?BAD_PASSWD}]},
{pref_public_key_algs, [Alg]}
],
setup_remote_priv_and_local_auth_keys(Alg, Config)
};
_ ->
{[{user_passwords, [{?USER,?PASSWD}]}],
new_dir(Config)
}
end,
{Server, Host, HostPort} =
ssh_test_lib:daemon(0,
[{auth_methods, atom_to_list(AuthMethod)},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{system_dir, SysDir},
{user_dir, UsrDir},
{failfun, fun ssh_test_lib:failfun/2}
| Opts
]),
R = exec_from_docker(Config, Host, HostPort,
"'lists:concat([\"Answer=\",1+3]).\r\n'",
[<<"Answer=4">>],
""),
ssh:stop_daemon(Server),
R
end).
%%--------------------------------------------------------------------
all_algorithms_sftp_exec_reneg_otp_is_client(Config) ->
CommonAlgs = proplists:get_value(common_remote_server_algs, Config),
{IP,Port} = ip_port(Config),
chk_all_algos(?FUNCTION_NAME, CommonAlgs, Config,
fun(Tag, Alg) ->
PrefAlgs =
[{T,L} || {T,L} <- ssh_transport:supported_algorithms(),
T =/= Tag],
ConnRes =
ssh:connect(IP, Port,
[{user,?USER},
{password,?PASSWD},
{auth_methods, "password"},
{user_dir, new_dir(Config)},
{preferred_algorithms, [{Tag,[Alg]} | PrefAlgs]},
{silently_accept_hosts,true},
{save_accepted_host, false},
{user_interaction,false}
]) ,
test_erl_client_reneg(ConnRes, % Seems that max 10 channels may be open in sshd
[{exec,1},
{sftp,5},
{no_subsyst,1},
{setenv, 1},
{sftp_async,1}
])
end).
%%--------------------------------------------------------------------
renegotiation_otp_is_server(Config) ->
PublicKeyAlgs = [A || {public_key,A} <- proplists:get_value(common_remote_client_algs, Config, [])],
ct:log("PublicKeyAlgs = ~p", [PublicKeyAlgs]),
UserDir = setup_remote_priv_and_local_auth_keys(hd(PublicKeyAlgs), Config),
SftpRootDir = new_dir(Config),
ct:log("Rootdir = ~p",[SftpRootDir]),
Parent = self(),
Ref = make_ref(),
{Server, Host, Port} =
ssh_test_lib:daemon(0,
[{system_dir, setup_local_hostdir(Config)},
{user_dir, UserDir},
{user_passwords, [{?USER,?PASSWD}]},
{failfun, fun ssh_test_lib:failfun/2},
{modify_algorithms, [{append, [{public_key,PublicKeyAlgs}]}]},
{connectfun,
fun(_,_,_) ->
HostConnRef = self(),
reneg_tester(Parent, Ref, HostConnRef),
ct:log("Connected ~p",[HostConnRef]),
timer:sleep(1100), % Just a bit more than 1 s
ok
end},
{subsystems,
[ssh_sftpd:subsystem_spec([{cwd,SftpRootDir},
{root,SftpRootDir}])
]}
]),
case sftp_tests_erl_server(Config, Host, Port, SftpRootDir, UserDir, Ref) of
ok ->
ssh:stop_daemon(Server);
{error,Error} ->
ssh:stop_daemon(Server),
ct:log("Error: ~p", [Error]),
{fail, Error}
end.
reneg_tester(Parent, Ref, HostConnRef) ->
spawn(fun() ->
reneg_tester_loop(Parent, Ref, HostConnRef, renegotiate_test(init,HostConnRef))
end).
reneg_tester_loop(Parent, Ref, HostConnRef, Kex1) ->
case ssh_test_lib:get_kex_init(HostConnRef) of
Kex1 ->
timer:sleep(500),
reneg_tester_loop(Parent, Ref, HostConnRef, Kex1);
_OtherKex ->
ct:log("Kex is changed.", []),
Parent ! {kex_changed, Ref}
end.
%%--------------------------------------------------------------------
send_recv_big_with_renegotiate_otp_is_client(Config) ->
%% Connect to the remote openssh server:
{IP,Port} = ip_port(Config),
C = ssh_test_lib:connect(IP, Port, [{user,?USER},
{password,?PASSWD},
{user_dir, setup_remote_auth_keys_and_local_priv('ssh-rsa', Config)},
{silently_accept_hosts,true},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{user_interaction,false}
]),
%% Open a channel and exec the Linux 'cat' command at the openssh side.
%% This 'cat' will read stdin and write to stdout until an eof is read from stdin.
{ok, Ch1} = ssh_connection:session_channel(C, infinity),
success = ssh_connection:exec(C, Ch1, "cat", infinity),
%% Build big binary
HalfSizeBytes = 100*1000*1000,
Data = << <<X:32>> || X <- lists:seq(1, HalfSizeBytes div 4)>>,
%% Send the data. Must spawn a process to avoid deadlock. The client will block
%% until all is sent through the send window. But the server will stop receiving
%% when the servers send-window towards the client is full.
%% Since the client can't receive before the server has received all but 655k from the client
%% ssh_connection:send/4 is blocking...
spawn_link(
fun() ->
ct:comment("Sending ~p Mbytes with renegotiation in the middle",[2*byte_size(Data)/1000000]),
%% ct:log("sending first ~p bytes",[byte_size(Data)]),
ok = ssh_connection:send(C, Ch1, Data, 10000),
%% ct:log("Init renegotiation test",[]),
Kex1 = renegotiate_test(init, C),
%% ct:log("sending next ~p bytes",[byte_size(Data)]),
ok = ssh_connection:send(C, Ch1, Data, 10000),
%% ct:log("Finnish renegotiation test",[]),
renegotiate_test(Kex1, C),
%% ct:log("sending eof",[]),
ok = ssh_connection:send_eof(C, Ch1)
%%, ct:log("READY, sent ~p bytes",[2*byte_size(Data)])
end),
{eof,ReceivedData} =
loop_until(fun({eof,_}) -> true;
(_ ) -> false
end,
fun(Acc) ->
%%ct:log("Get more ~p",[ ExpectedSize-byte_size(Acc) ]),
receive
{ssh_cm, C, {eof,Ch}} when Ch==Ch1 ->
%% ct:log("eof received",[]),
{eof,Acc};
{ssh_cm, C, {data,Ch,0,B}} when Ch==Ch1,
is_binary(B) ->
%% ct:log("(1) Received ~p bytes (total ~p), missing ~p bytes",
%% [byte_size(B),
%% byte_size(B)+byte_size(Acc),
%% 2*byte_size(Data)-(byte_size(B)+byte_size(Acc))]),
ssh_connection:adjust_window(C, Ch1, byte_size(B)),
<<Acc/binary, B/binary>>
end
end,
<<>>),
ExpectedData = <<Data/binary, Data/binary>>,
case ReceivedData of
ExpectedData ->
%% ct:log("Correct data returned",[]),
%% receive close messages
loop_until(fun(Left) -> %% ct:log("Expect: ~p",[Left]),
Left == []
end,
fun([Next|Rest]) ->
receive
{ssh_cm,C,Next} -> Rest
end
end,
[%% Already received: {eof, Ch1},
{exit_status,Ch1,0},
{closed,Ch1}]
),
ok;
_ when is_binary(ReceivedData) ->
ct:fail("~p bytes echoed but ~p expected", [byte_size(ReceivedData), 2*byte_size(Data)])
end.
%%--------------------------------------------------------------------
%% Utilities ---------------------------------------------------------
%%--------------------------------------------------------------------
%%--------------------------------------------------------------------
%%
%% A practical meta function
%%
loop_until(CondFun, DoFun, Acc) ->
case CondFun(Acc) of
true ->
Acc;
false ->
loop_until(CondFun, DoFun, DoFun(Acc))
end.
%%--------------------------------------------------------------------
%%
%% Exec the Command in the docker. Add the arguments ExtraSshArg in the
%% ssh command.
%%
%% If Expects is returned, then return 'ok', else return {fail,Msg}.
%%
exec_from_docker(Config, HostIP, HostPort, Command, Expects, ExtraSshArg) when is_binary(hd(Expects)),
is_list(Config) ->
{DockerIP,DockerPort} = ip_port(Config),
C = ssh_test_lib:connect(DockerIP, DockerPort,
[{user,?USER},
{password,?PASSWD},
{user_dir, new_dir(Config)},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{silently_accept_hosts,true},
{user_interaction,false}
]),
R = exec_from_docker(C, HostIP, HostPort, Command, Expects, ExtraSshArg, Config),
ssh:close(C),
R.
exec_from_docker(C, DestIP, DestPort, Command, Expects, ExtraSshArg, Config) when is_binary(hd(Expects)) ->
ExecCommand =
lists:concat(
["sshpass -p ",?PASSWD," "
| case proplists:get_value(ssh_version,Config) of
"dropbear" ++ _ ->
["dbclient -y -y -p ",DestPort," ",ExtraSshArg," ",iptoa(DestIP)," "];
_ -> %% OpenSSH or compatible
["/buildroot/ssh/bin/ssh -o 'CheckHostIP=no' -o 'StrictHostKeyChecking=no' ",
ExtraSshArg," -p ",DestPort," ",iptoa(DestIP)," "]
end]) ++ Command,
case exec(C, ExecCommand) of
{ok,{ExitStatus,Result}} = R when ExitStatus == 0 ->
case binary:match(Result, Expects) of
nomatch ->
ct:log("Result of~n ~s~nis~n ~p",[ExecCommand,R]),
{fail, "Bad answer"};
_ ->
ok
end;
{ok,_} = R ->
ct:log("Result of~n ~s~nis~n ~p",[ExecCommand,R]),
{fail, "Exit status =/= 0"};
R ->
ct:log("Result of~n ~s~nis~n ~p",[ExecCommand,R]),
{fail, "Couldn't login to host"}
end.
exec(C, Cmd) ->
%% ct:log("~s",[Cmd]),
{ok,Ch} = ssh_connection:session_channel(C, 10000),
success = ssh_connection:exec(C, Ch, Cmd, 10000),
result_of_exec(C, Ch).
result_of_exec(C, Ch) ->
result_of_exec(C, Ch, undefined, <<>>).
result_of_exec(C, Ch, ExitStatus, Acc) ->
receive
{ssh_cm,C,{closed,Ch}} ->
%%ct:log("CHAN ~p got *closed*",[Ch]),
{ok, {ExitStatus, Acc}};
{ssh_cm,C,{exit_status,Ch,ExStat}} when ExitStatus == undefined ->
%%ct:log("CHAN ~p got *exit status ~p*",[Ch,ExStat]),
result_of_exec(C, Ch, ExStat, Acc);
{ssh_cm,C,{data,Ch,_,Data}=_X} when ExitStatus == undefined ->
%%ct:log("CHAN ~p got ~p",[Ch,_X]),
result_of_exec(C, Ch, ExitStatus, <<Acc/binary, Data/binary>>);
_Other ->
%%ct:log("OTHER: ~p",[_Other]),
result_of_exec(C, Ch, ExitStatus, Acc)
after 5000 ->
ct:log("NO MORE, received so far:~n~s",[Acc]),
{error, timeout}
end.
%%--------------------------------------------------------------------
%%
%% Loop through all {Tag,Alg} pairs in CommonAlgs, call DoTestFun(Tag,Alg) which
%% returns one of {ok,C}, ok, or Other.
%%
%% The chk_all_algos returns 'ok' or {fail,FaledAlgosList}
%%
chk_all_algos(FunctionName, CommonAlgs, Config, DoTestFun) when is_function(DoTestFun,2) ->
ct:comment("~p algorithms",[length(CommonAlgs)]),
%% Check each algorithm
Nmax = length(CommonAlgs),
{_N,Failed} =
lists:foldl(
fun({Tag,Alg}, {N,FailedAlgos}) ->
ct:log("Try ~p ~p/~p",[{Tag,Alg},N,Nmax]),
case DoTestFun(Tag,Alg) of
{ok,C} ->
ssh:close(C),
{N+1,FailedAlgos};
ok ->
{N+1,FailedAlgos};
Other ->
ct:log("FAILED! ~p ~p: ~p",[Tag,Alg,Other]),
{N+1, [{Alg,Other}|FailedAlgos]}
end
end, {1,[]}, CommonAlgs),
ct:pal("~s", [format_result_table_use_all_algos(FunctionName, Config, CommonAlgs, Failed)]),
case Failed of
[] ->
ok;
_ ->
{fail, Failed}
end.
%%--------------------------------------------------------------------
%%
%% Functions to set up local and remote host's and user's keys and directories
%%
setup_local_hostdir(Config) ->
KeyAlgs = lists:usort(
[A || From <- [common_remote_client_algs,
common_remote_server_algs],
{public_key,A} <- proplists:get_value(From, Config, [])]),
setup_local_hostdirs(KeyAlgs, new_dir(Config), Config).
setup_local_hostdirs(KeyAlgs, HostDir, Config) ->
lists:foreach(
fun(KeyAlg) ->
setup_local_hostdir(KeyAlg, HostDir, Config)
end, KeyAlgs),
HostDir.
setup_local_hostdir(KeyAlg, Config) ->
setup_local_hostdir(KeyAlg, new_dir(Config), Config).
setup_local_hostdir(KeyAlg, HostDir, Config) ->
{ok, {Priv,Publ}} = host_priv_pub_keys(Config, KeyAlg),
%% Local private and public key
DstFile = filename:join(HostDir, dst_filename(host,KeyAlg)),
ok = file:write_file(DstFile, Priv),
ok = file:write_file(DstFile++".pub", Publ),
HostDir.
setup_remote_auth_keys_and_local_priv(KeyAlg, Config) ->
{IP,Port} = ip_port(Config),
setup_remote_auth_keys_and_local_priv(KeyAlg, IP, Port, new_dir(Config), Config).
setup_remote_auth_keys_and_local_priv(KeyAlg, IP, Port, UserDir, Config) ->
{ok, {Priv,Publ}} = user_priv_pub_keys(Config, KeyAlg),
%% Local private and public keys
DstFile = filename:join(UserDir, dst_filename(user,KeyAlg)),
ok = file:write_file(DstFile, Priv),
ok = file:write_file(DstFile++".pub", Publ),
%% Remote auth_methods with public key
{ok,Ch,Cc} = ssh_sftp:start_channel(IP, Port, [{user, ?USER },
{password, ?PASSWD },
{auth_methods, "password"},
{silently_accept_hosts,true},
{save_accepted_host, false},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{user_interaction,false}
]),
_ = ssh_sftp:make_dir(Ch, ".ssh"),
ok = ssh_sftp:write_file(Ch, ".ssh/authorized_keys", Publ),
ok = ssh_sftp:write_file_info(Ch, ".ssh/authorized_keys", #file_info{mode=8#700}),
ok = ssh_sftp:write_file_info(Ch, ".ssh", #file_info{mode=8#700}),
ok = ssh_sftp:stop_channel(Ch),
ok = ssh:close(Cc),
UserDir.
setup_remote_priv_and_local_auth_keys(KeyAlg, Config) ->
{IP,Port} = ip_port(Config),
setup_remote_priv_and_local_auth_keys(KeyAlg, IP, Port, new_dir(Config), Config).
setup_remote_priv_and_local_auth_keys(KeyAlg, IP, Port, UserDir, Config) ->
{ok, {Priv,Publ}} = user_priv_pub_keys(Config, KeyAlg),
%% Local auth_methods with public key
AuthKeyFile = filename:join(UserDir, "authorized_keys"),
ok = file:write_file(AuthKeyFile, Publ),
%% Remote private and public key
{ok,Ch,Cc} = ssh_sftp:start_channel(IP, Port, [{user, ?USER },
{password, ?PASSWD },
{auth_methods, "password"},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{silently_accept_hosts,true},
{user_interaction,false}
]),
rm_id_in_remote_dir(Ch, ".ssh"),
_ = ssh_sftp:make_dir(Ch, ".ssh"),
DstFile = filename:join(".ssh", dst_filename(user,KeyAlg)),
ok = ssh_sftp:write_file(Ch, DstFile, Priv),
ok = ssh_sftp:write_file_info(Ch, DstFile, #file_info{mode=8#700}),
ok = ssh_sftp:write_file(Ch, DstFile++".pub", Publ),
ok = ssh_sftp:write_file_info(Ch, ".ssh", #file_info{mode=8#700}),
ok = ssh_sftp:stop_channel(Ch),
ok = ssh:close(Cc),
UserDir.
rm_id_in_remote_dir(Ch, Dir) ->
case ssh_sftp:list_dir(Ch, Dir) of
{error,_Error} ->
ok;
{ok,FileNames} ->
lists:foreach(fun("id_"++_ = F) ->
ok = ssh_sftp:delete(Ch, filename:join(Dir,F));
(_) ->
leave
end, FileNames)
end.
user_priv_pub_keys(Config, KeyAlg) -> priv_pub_keys("users_keys", user, Config, KeyAlg).
host_priv_pub_keys(Config, KeyAlg) -> priv_pub_keys("host_keys", host, Config, KeyAlg).
priv_pub_keys(KeySubDir, Type, Config, KeyAlg) ->
KeyDir = filename:join(proplists:get_value(data_dir,Config), KeySubDir),
{ok,Priv} = file:read_file(filename:join(KeyDir,src_filename(Type,KeyAlg))),
{ok,Publ} = file:read_file(filename:join(KeyDir,src_filename(Type,KeyAlg)++".pub")),
{ok, {Priv,Publ}}.
%%%---------------- The default filenames
src_filename(user, 'ssh-rsa' ) -> "id_rsa";
src_filename(user, 'rsa-sha2-256' ) -> "id_rsa";
src_filename(user, 'rsa-sha2-512' ) -> "id_rsa";
src_filename(user, 'ssh-dss' ) -> "id_dsa";
src_filename(user, 'ssh-ed25519' ) -> "id_ed25519";
src_filename(user, 'ssh-ed448' ) -> "id_ed448";
src_filename(user, 'ecdsa-sha2-nistp256') -> "id_ecdsa256";
src_filename(user, 'ecdsa-sha2-nistp384') -> "id_ecdsa384";
src_filename(user, 'ecdsa-sha2-nistp521') -> "id_ecdsa521";
src_filename(host, 'ssh-rsa' ) -> "ssh_host_rsa_key";
src_filename(host, 'rsa-sha2-256' ) -> "ssh_host_rsa_key";
src_filename(host, 'rsa-sha2-512' ) -> "ssh_host_rsa_key";
src_filename(host, 'ssh-dss' ) -> "ssh_host_dsa_key";
src_filename(host, 'ssh-ed25519' ) -> "ssh_host_ed25519_key";
src_filename(host, 'ssh-ed448' ) -> "ssh_host_ed448_key";
src_filename(host, 'ecdsa-sha2-nistp256') -> "ssh_host_ecdsa_key256";
src_filename(host, 'ecdsa-sha2-nistp384') -> "ssh_host_ecdsa_key384";
src_filename(host, 'ecdsa-sha2-nistp521') -> "ssh_host_ecdsa_key521".
dst_filename(user, 'ssh-rsa' ) -> "id_rsa";
dst_filename(user, 'rsa-sha2-256' ) -> "id_rsa";
dst_filename(user, 'rsa-sha2-512' ) -> "id_rsa";
dst_filename(user, 'ssh-dss' ) -> "id_dsa";
dst_filename(user, 'ssh-ed25519' ) -> "id_ed25519";
dst_filename(user, 'ssh-ed448' ) -> "id_ed448";
dst_filename(user, 'ecdsa-sha2-nistp256') -> "id_ecdsa";
dst_filename(user, 'ecdsa-sha2-nistp384') -> "id_ecdsa";
dst_filename(user, 'ecdsa-sha2-nistp521') -> "id_ecdsa";
dst_filename(host, 'ssh-rsa' ) -> "ssh_host_rsa_key";
dst_filename(host, 'rsa-sha2-256' ) -> "ssh_host_rsa_key";
dst_filename(host, 'rsa-sha2-512' ) -> "ssh_host_rsa_key";
dst_filename(host, 'ssh-dss' ) -> "ssh_host_dsa_key";
dst_filename(host, 'ssh-ed25519' ) -> "ssh_host_ed25519_key";
dst_filename(host, 'ssh-ed448' ) -> "ssh_host_ed448_key";
dst_filename(host, 'ecdsa-sha2-nistp256') -> "ssh_host_ecdsa_key";
dst_filename(host, 'ecdsa-sha2-nistp384') -> "ssh_host_ecdsa_key";
dst_filename(host, 'ecdsa-sha2-nistp521') -> "ssh_host_ecdsa_key".
%%--------------------------------------------------------------------
%%
%% Format the result table for chk_all_algos/4
%%
format_result_table_use_all_algos(FunctionName, Config, CommonAlgs, Failed) ->
%% Write a nice table with the result
AlgHead = 'Algorithm',
AlgWidth = lists:max([length(atom_to_list(A)) || {_,A} <- CommonAlgs]),
{ResultTable,_} =
lists:mapfoldl(
fun({T,A}, Tprev) ->
Tag = case T of
Tprev -> "";
_ -> io_lib:format('~s~n',[T])
end,
{io_lib:format('~s ~*s ~s~n',
[Tag, -AlgWidth, A,
case proplists:get_value(A,Failed) of
undefined -> "(ok)";
Err -> io_lib:format("<<<< FAIL <<<< ~p",[Err])
end]),
T}
end, undefined, CommonAlgs),
Vssh = proplists:get_value(ssh_version,Config,""),
io_lib:format("~nResults of ~p, Peer version: ~s~n~n"
"Tag ~*s Result~n"
"=====~*..=s=======~n~s"
,[FunctionName, Vssh,
-AlgWidth, AlgHead,
AlgWidth, "", ResultTable]).
%%--------------------------------------------------------------------
%%
%% Docker handling: start_docker/1 and stop_docker/1
%%
start_docker(Ver) ->
Cmnd = lists:concat(["docker run -itd --rm -p 1234 ",?DOCKER_PFX,":",Ver]),
Id0 = os:cmd(Cmnd),
ct:log("Ver = ~p, Cmnd ~p~n-> ~p",[Ver,Cmnd,Id0]),
case is_docker_sha(Id0) of
true ->
Id = hd(string:tokens(Id0, "\n")),
IP = ip(Id),
Port = 1234,
{ok, {Ver,{IP,Port},Id}};
false ->
throw(cant_start_docker)
end.
stop_docker({_Ver,_,Id}) ->
Cmnd = lists:concat(["docker kill ",Id]),
os:cmd(Cmnd).
is_docker_sha(L) ->
lists:all(fun(C) when $a =< C,C =< $z -> true;
(C) when $0 =< C,C =< $9 -> true;
($\n) -> true;
(_) -> false
end, L).
%%--------------------------------------------------------------------
%%
%% Misc docker info functions
ip_port(Config) ->
{_Ver,{IP,Port},_} = proplists:get_value(id,Config),
{IP,Port}.
ip(Id) ->
Cmnd = lists:concat(["docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' ",
Id]),
IPstr0 = os:cmd(Cmnd),
ct:log("Cmnd ~p~n-> ~p",[Cmnd,IPstr0]),
IPstr = hd(string:tokens(IPstr0, "\n")),
{ok,IP} = inet:parse_address(IPstr),
IP.
%%--------------------------------------------------------------------
%%
%% Normalize the host returned from ssh_test_lib
iptoa({0,0,0,0}) -> inet_parse:ntoa(host_ip());
iptoa(IP) -> inet_parse:ntoa(IP).
host_ip() ->
{ok,Name} = inet:gethostname(),
{ok,IP} = inet:ip(Name),
IP.
%%--------------------------------------------------------------------
%%
%% Create a new fresh directory or clear an existing one
%%
new_dir(Config) ->
PrivDir = proplists:get_value(priv_dir, Config),
SubDirName = integer_to_list(erlang:system_time()),
Dir = filename:join(PrivDir, SubDirName),
case file:read_file_info(Dir) of
{error,enoent} ->
ok = file:make_dir(Dir),
Dir;
_ ->
timer:sleep(25),
new_dir(Config)
end.
%%--------------------------------------------------------------------
%%
%% Find the intersection of algorithms for otp ssh and the docker ssh.
%% Returns {ok, ServerHello, Server, ClientHello, Client} where Server are the algorithms common
%% with the docker server and analogous for Client.
%%
%% Client may be undefined if no usable client is found.
%%
%% Both Server and Client are lists of {Tag,AlgName}.
%%
common_algs(Config, IP, Port) ->
case remote_server_algs(IP, Port) of
{ok, {ServerHello, RemoteServerKexInit}} ->
RemoteServerAlgs = kexint_msg2default_algorithms(RemoteServerKexInit),
Server = find_common_algs(RemoteServerAlgs,
use_algorithms(ServerHello)),
ct:log("Remote server:~n~p~n~p",[ServerHello, RemoteServerAlgs]),
case remote_client_algs(Config) of
{ok,{ClientHello,RemoteClientKexInit}} ->
RemoteClientAlgs = kexint_msg2default_algorithms(RemoteClientKexInit),
Client = find_common_algs(RemoteClientAlgs,
use_algorithms(ClientHello)),
ct:log("Remote client:~n~p~n~p",[ClientHello, RemoteClientAlgs]),
{ok, ServerHello, Server, ClientHello, Client};
{error,_} =TO ->
ct:log("Remote client algs can't be found: ~p",[TO]),
{ok, ServerHello, Server, undefined, undefined};
Other ->
Other
end;
Other ->
Other
end.
chk_hellos(Hs, Str) ->
lists:foldl(
fun(H, Acc) ->
try binary:split(H, <<"-">>, [global])
of
%% [<<"SSH">>,<<"2.0">>|_] ->
%% Acc;
[<<"SSH">>,OldVer = <<"1.",_/binary>>|_] ->
io_lib:format("~s, Old SSH ver ~s",[Acc,OldVer]);
_ ->
Acc
catch
_:_ ->
Acc
end
end, Str, Hs).
find_common_algs(Remote, Local) ->
[{T,V} || {T,Vs} <- ssh_test_lib:extract_algos(
ssh_test_lib:intersection(Remote,
Local)),
V <- Vs].
use_algorithms(RemoteHelloBin) ->
MyAlgos = ssh:chk_algos_opts(
[{modify_algorithms,
[{append, alg_diff()}
]}
]),
ssh_transport:adjust_algs_for_peer_version(binary_to_list(RemoteHelloBin)++"\r\n",
MyAlgos).
alg_diff() ->
alg_diff(ssh:default_algorithms(), ssh_transport:supported_algorithms()).
alg_diff(L1, L2) when is_atom(hd(L1)) ; is_atom(hd(L2)) ->
(L2--L1)--['AEAD_AES_256_GCM','AEAD_AES_128_GCM'];
alg_diff(L1, L2) ->
[{T, Diff} || {{T,EL1},{T,EL2}} <- lists:zip(L1,L2),
Diff <- [alg_diff(EL1,EL2)],
Diff =/= []
].
kexint_msg2default_algorithms(#ssh_msg_kexinit{kex_algorithms = Kex,
server_host_key_algorithms = PubKey,
encryption_algorithms_client_to_server = CipherC2S,
encryption_algorithms_server_to_client = CipherS2C,
mac_algorithms_client_to_server = MacC2S,
mac_algorithms_server_to_client = MacS2C,
compression_algorithms_client_to_server = CompC2S,
compression_algorithms_server_to_client = CompS2C
}) ->
[{kex, ssh_test_lib:to_atoms(Kex)},
{public_key, ssh_test_lib:to_atoms(PubKey)},
{cipher, [{client2server,ssh_test_lib:to_atoms(CipherC2S)},
{server2client,ssh_test_lib:to_atoms(CipherS2C)}]},
{mac, [{client2server,ssh_test_lib:to_atoms(MacC2S)},
{server2client,ssh_test_lib:to_atoms(MacS2C)}]},
{compression, [{client2server,ssh_test_lib:to_atoms(CompC2S)},
{server2client,ssh_test_lib:to_atoms(CompS2C)}]}].
%%--------------------------------------------------------------------
%%
%% Find the algorithms supported by the remote server
%%
%% Connect with tcp to the server, send a hello and read the returned
%% server hello and kexinit message.
%%
remote_server_algs(IP, Port) ->
case try_gen_tcp_connect(IP, Port, 5) of
{ok,S} ->
ok = gen_tcp:send(S, "SSH-2.0-CheckAlgs\r\n"),
receive_hello(S);
{error,Error} ->
{error,Error}
end.
try_gen_tcp_connect(IP, Port, N) when N>0 ->
case gen_tcp:connect(IP, Port, [binary]) of
{ok,S} ->
{ok,S};
{error,_Error} when N>1 ->
receive after 1000 -> ok end,
try_gen_tcp_connect(IP, Port, N-1);
{error,Error} ->
{error,Error}
end;
try_gen_tcp_connect(_, _, _) ->
{error, "No contact"}.
%%--------------------------------------------------------------------
%%
%% Find the algorithms supported by the remote client
%%
%% Set up a fake ssh server and make the remote client connect to it. Use
%% hello message and the kexinit message.
%%
remote_client_algs(Config) ->
Parent = self(),
Ref = make_ref(),
spawn(
fun() ->
{ok,Sl} = gen_tcp:listen(0, [binary]),
{ok,{IP,Port}} = inet:sockname(Sl),
Parent ! {addr,Ref,IP,Port},
{ok,S} = gen_tcp:accept(Sl),
ok = gen_tcp:send(S, "SSH-2.0-CheckAlgs\r\n"),
Parent ! {Ref,receive_hello(S)}
end),
receive
{addr,Ref,IP,Port} ->
spawn(fun() ->
exec_from_docker(Config, IP, Port,
"howdy.\r\n",
[<<"howdy">>],
"")
end),
receive
{Ref, Result} ->
Result
after 5000 ->
{error, {timeout,2}}
end
after 5000 ->
{error, {timeout,1}}
end.
%%% Receive a few packets from the remote server or client and find what is supported:
receive_hello(S) ->
try
receive_hello(S, <<>>)
of
Result ->
Result
catch
Class:Error:ST ->
{error, {Class,Error,ST}}
end.
receive_hello(S, Ack) ->
%% The Ack is to collect bytes until the full message is received
receive
{tcp, S, Bin0} when is_binary(Bin0) ->
case binary:split(<<Ack/binary, Bin0/binary>>, [<<"\r\n">>,<<"\r">>,<<"\n">>]) of
[Hello = <<"SSH-2.0-",_/binary>>, NextPacket] ->
%% ct:log("Got 2.0 hello (~p), ~p bytes to next msg",[Hello,size(NextPacket)]),
{ok, {Hello, receive_kexinit(S, NextPacket)}};
[Hello = <<"SSH-1.99-",_/binary>>, NextPacket] ->
%% ct:log("Got 1.99 hello (~p), ~p bytes to next msg",[Hello,size(NextPacket)]),
{ok, {Hello, receive_kexinit(S, NextPacket)}};
[Bin] when size(Bin) < 256 ->
%% ct:log("Got part of hello (~p chars):~n~s~n~s",[size(Bin),Bin,
%% [io_lib:format('~2.16.0b ',[C])
%% || C <- binary_to_list(Bin0)
%% ]
%% ]),
receive_hello(S, Bin0);
_ ->
ct:log("Bad hello string (line ~p, ~p chars):~n~s~n~s",[?LINE,size(Bin0),Bin0,
[io_lib:format('~2.16.0b ',[C])
|| C <- binary_to_list(Bin0)
]
]),
ct:fail("Bad hello string received")
end;
Other ->
ct:log("Bad hello string (line ~p):~n~p",[?LINE,Other]),
ct:fail("Bad hello string received")
after 10000 ->
ct:log("Timeout waiting for hello!~n~s",[Ack]),
throw(timeout)
end.
receive_kexinit(_S, <<PacketLen:32, PaddingLen:8, PayloadAndPadding/binary>>)
when PacketLen < 5000, % heuristic max len to stop huge attempts if packet decoding get out of sync
size(PayloadAndPadding) >= (PacketLen-1) % Need more bytes?
->
ct:log("Has all ~p packet bytes",[PacketLen]),
PayloadLen = PacketLen - PaddingLen - 1,
<<Payload:PayloadLen/binary, _Padding:PaddingLen/binary>> = PayloadAndPadding,
ssh_message:decode(Payload);
receive_kexinit(S, Ack) ->
ct:log("Has ~p bytes, need more",[size(Ack)]),
receive
{tcp, S, Bin0} when is_binary(Bin0) ->
receive_kexinit(S, <<Ack/binary, Bin0/binary>>);
Other ->
ct:log("Bad hello string (line ~p):~n~p",[?LINE,Other]),
ct:fail("Bad hello string received")
after 10000 ->
ct:log("Timeout waiting for kexinit!~n~s",[Ack]),
throw(timeout)
end.
%%%----------------------------------------------------------------
%%% Test of sftp from the OpenSSH client side
%%%
sftp_tests_erl_server(Config, ServerIP, ServerPort, ServerRootDir, UserDir, Ref) ->
try
Cmnds = prepare_local_directory(ServerRootDir),
case call_sftp_in_docker(Config, ServerIP, ServerPort, Cmnds, UserDir, Ref) of
ok ->
check_local_directory(ServerRootDir);
{error,Error} ->
{error,Error}
end
catch
Class:Excep:ST ->
{error, {Class,Excep,ST}}
end.
prepare_local_directory(ServerRootDir) ->
file:write_file(filename:join(ServerRootDir,"tst1"),
<<"Some test text">>
),
["get tst1",
"put tst1 tst2",
"put tst1 tst3",
"rename tst1 ex_tst1",
"rm tst3",
"mkdir mydir",
"cd mydir",
"put tst1 file_1",
"put tst1 unreadable_file",
"chmod 222 unreadable_file",
"exit"].
check_local_directory(ServerRootDir) ->
TimesToTry = 3, % sleep 0.5, 1, 2 and then 4 secs (7.5s in total)
check_local_directory(ServerRootDir, 500, TimesToTry-1).
check_local_directory(ServerRootDir, SleepTime, N) ->
case do_check_local_directory(ServerRootDir) of
{error,_Error} when N>0 ->
%% Could be that the erlang side is faster and the docker's operations
%% are not yet finalized.
%% Sleep for a while and retry a few times:
timer:sleep(SleepTime),
check_local_directory(ServerRootDir, 2*SleepTime, N-1);
Other ->
Other
end.
do_check_local_directory(ServerRootDir) ->
case lists:sort(ok(file:list_dir(ServerRootDir)) -- [".",".."]) of
["ex_tst1","mydir","tst2"] ->
{ok,Expect} = file:read_file(filename:join(ServerRootDir,"ex_tst1")),
case file:read_file(filename:join(ServerRootDir,"tst2")) of
{ok,Expect} ->
case lists:sort(ok(file:list_dir(filename:join(ServerRootDir,"mydir"))) -- [".",".."]) of
["file_1","unreadable_file"] ->
case file:read_file(filename:join([ServerRootDir,"mydir","file_1"])) of
{ok,Expect} ->
case file:read_file(filename:join([ServerRootDir,"mydir","unreadable_file"])) of
{error,_} ->
ok;
{ok,_} ->
{error, {could_read_unreadable,"mydir/unreadable_file"}}
end;
{ok,Other} ->
ct:log("file_1:~n~s~nExpected:~n~s",[Other,Expect]),
{error, {bad_contents_in_file,"mydir/file_1"}}
end;
Other ->
ct:log("Directory ~s~n~p",[filename:join(ServerRootDir,"mydir"),Other]),
{error,{bad_dir_contents,"mydir"}}
end;
{ok,Other} ->
ct:log("tst2:~n~s~nExpected:~n~s",[Other,Expect]),
{error, {bad_contents_in_file,"tst2"}}
end;
["tst1"] ->
{error,{missing_file,"tst2"}};
Other ->
ct:log("Directory ~s~n~p",[ServerRootDir,Other]),
{error,{bad_dir_contents,"/"}}
end.
call_sftp_in_docker(Config, ServerIP, ServerPort, Cmnds, UserDir, Ref) ->
{DockerIP,DockerPort} = ip_port(Config),
ct:log("Going to connect ~p:~p", [DockerIP, DockerPort]),
C = ssh_test_lib:connect(DockerIP, DockerPort,
[{user,?USER},
{password,?PASSWD},
{user_dir, UserDir},
{preferred_algorithms, ssh_transport:supported_algorithms()},
{silently_accept_hosts,true},
{user_interaction,false}
]),
%% Make commands for "expect" in the docker:
PreExpectCmnds = ["spawn /buildroot/ssh/bin/sftp -oPort="++integer_to_list(ServerPort)++
" -oCheckHostIP=no -oStrictHostKeyChecking=no " ++
iptoa(ServerIP)++"\n"
],
PostExpectCmnds= [],
ExpectCmnds =
PreExpectCmnds ++
["expect \"sftp>\" {sleep 1; send \""++Cmnd++"\n\"}\n" || Cmnd <- Cmnds] ++
PostExpectCmnds,
%% Make an commands file in the docker
{ok,Ch} = ssh_sftp:start_channel(C, [{timeout,10000}]),
ok = ssh_sftp:write_file(Ch, "commands", erlang:iolist_to_binary(ExpectCmnds)),
ok = ssh_sftp:stop_channel(Ch),
%% Call expect in the docker
{ok, Ch1} = ssh_connection:session_channel(C, infinity),
ct:log("Going to execute 'expect commands' in docker", []),
success = ssh_connection:exec(C, Ch1, "expect commands", infinity),
ct:log("'expect commands' in docker executed!", []),
case recv_log_msgs(C, Ch1) of
ok ->
receive
{kex_changed, Ref} ->
%% success
ct:log("Kex changed",[]),
ssh:close(C),
ok
after
30000 ->
%% failure
ct:log("Kex NOT changed",[]),
ssh:close(C),
{error,"Kex NOT changed"}
end;
{error,Error} ->
ssh:close(C),
{error,Error}
end.
recv_log_msgs(C, Ch) ->
receive
{ssh_cm,C,{closed,Ch}} ->
ct:log("Channel closed ~p",[{closed,1}]),
ok;
{ssh_cm,C,{data,Ch,1,Msg}} ->
ct:log("*** ERROR from docker:~n~s",[Msg]),
recv_log_msgs(C, Ch);
{ssh_cm,C,_Msg} ->
ct:log("Got ~p",[_Msg]),
recv_log_msgs(C, Ch)
after
30000 ->
%% failure
ct:log("Exec Channel ~p in ~p NOT closed properly", [Ch,C]),
ssh:close(C),
{error,"Exec channel NOT closed"}
end.
%%%----------------------------------------------------------------
%%%----------------------------------------------------------------
%%%
%%% Tests from the Erlang client side
%%%
%%%----------------------------------------------------------------
%%%----------------------------------------------------------------
test_erl_client_reneg({ok,C}, Spec) ->
%% Start the test processes on the connection C:
Parent = self(),
Pids = [spawn(
fun() ->
Parent ! {self(), TestType, Id, one_test_erl_client(TestType,Id,C)}
end
)
|| {TestType,N} <- Spec,
Id <- lists:seq(1,N)],
Kex1 = renegotiate_test(init, C),
%% Collect the results:
case lists:filter(
fun(R) -> R=/=ok end,
[receive
{Pid,_TestType,_Id,ok} ->
%% ct:log("Test ~p:~p passed!", [_TestType,_Id]),
ok;
{Pid,TestType,Id,OtherResult} ->
ct:log("~p:~p ~p ~p~n~p",[?MODULE,?LINE,TestType,Id,OtherResult]),
{error,TestType,Id}
end || Pid <- Pids])
of
[] ->
renegotiate_test(Kex1, C),
{ok,C};
Other ->
renegotiate_test(Kex1, C),
Other
end;
test_erl_client_reneg(Error, _) ->
Error.
one_test_erl_client(exec, Id, C) ->
{ok, Ch} = ssh_connection:session_channel(C, infinity),
success = ssh_connection:exec(C, Ch, "echo Hi there", 5000),
case loop_until(fun({eof,_}) -> true;
(_ ) -> false
end,
fun(Acc) ->
receive
{ssh_cm, C, {eof,Ch}} ->
{eof,Acc};
{ssh_cm, C, {data,Ch,0,B}} when is_binary(B) ->
<<Acc/binary, B/binary>>
end
end,
<<>>) of
{eof,<<"Hi there\n">>} ->
ok;
Other ->
ct:log("exec Got other ~p", [Other]),
{error, {exec,Id,bad_msg,Other,undefined}}
end;
one_test_erl_client(no_subsyst, Id, C) ->
{ok, Ch} = ssh_connection:session_channel(C, infinity),
case ssh_connection:subsystem(C, Ch, "foo", infinity) of
failure ->
ok;
Other ->
ct:log("no_subsyst Got other ~p", [Other]),
{error, {no_subsyst,Id,bad_ret,Other,undefined}}
end;
one_test_erl_client(setenv, Id, C) ->
{ok, Ch} = ssh_connection:session_channel(C, infinity),
Var = "ENV_TEST",
Value = lists:concat(["env_test_",Id,"_",erlang:system_time()]),
Env = case ssh_connection:setenv(C, Ch, Var, Value, infinity) of
success -> binary_to_list(Value++"\n");
failure -> <<"\n">>
end,
success = ssh_connection:exec(C, Ch, "echo $"++Var, 5000),
case loop_until(fun({eof,_}) -> true;
(_ ) -> false
end,
fun(Acc) ->
receive
{ssh_cm, C, {eof,Ch}} ->
{eof,Acc};
{ssh_cm, C, {data,Ch,0,B}} when is_binary(B) ->
<<Acc/binary, B/binary>>
end
end,
<<>>) of
{eof,Env} ->
ok;
Other ->
ct:log("setenv Got other ~p", [Other]),
{error, {setenv,Id,bad_msg,Other,undefined}}
end;
one_test_erl_client(SFTP, Id, C) when SFTP==sftp ; SFTP==sftp_async ->
try
{ok,Ch} = ssh_sftp:start_channel(C, [{timeout,10000}]),
%% A new fresh name of a new file tree:
RootDir = lists:concat(["r_",Id,"_",erlang:system_time()]),
%% Check that it does not exist:
false = lists:member(RootDir, ok(ssh_sftp:list_dir(Ch, "."))),
%% Create it:
ok = ssh_sftp:make_dir(Ch, RootDir),
{ok, #file_info{type=directory, access=read_write}} = ssh_sftp:read_file_info(Ch, RootDir),
R = do_sftp_tests_erl_client(SFTP, C, Ch, Id, RootDir),
catch ssh_sftp:stop_channel(Ch),
R
catch
Class:Error:ST ->
{error, {SFTP,Id,Class,Error,ST}}
end.
do_sftp_tests_erl_client(sftp_async, _C, Ch, _Id, RootDir) ->
FileName1 = "boring_name",
F1 = filename:join(RootDir, FileName1),
%% Open a new handle and start writing:
{ok,Handle1} = ssh_sftp:open(Ch, F1, [write,binary]),
{async,Aref1} = ssh_sftp:awrite(Ch, Handle1, <<0:250000/unsigned-unit:8>>),
wait_for_async_result(Aref1);
do_sftp_tests_erl_client(sftp, _C, Ch, _Id, RootDir) ->
FileName0 = "f0",
F0 = filename:join(RootDir, FileName0),
%% Create and write a file:
ok = ssh_sftp:write_file(Ch,
F0 = filename:join(RootDir, FileName0),
Data0 = mkbin(1234,240)),
{ok,Data0} = ssh_sftp:read_file(Ch, F0),
{ok, #file_info{type=regular, access=read_write, size=1234}} = ssh_sftp:read_file_info(Ch, F0),
%% Re-write:
{ok,Handle0} = ssh_sftp:open(Ch, F0, [write,read,binary]),
ok = ssh_sftp:pwrite(Ch, Handle0, 16, Data0_1=mkbin(10,255)),
<<B1:16/binary, _:10/binary, B2:(1234-26)/binary>> = Data0,
FileContents = <<B1:16/binary, Data0_1:10/binary, B2:(1234-26)/binary>>,
<<_:1/binary, Part:25/binary, _/binary>> = FileContents,
{ok, Part} = ssh_sftp:pread(Ch, Handle0, 1, 25),
%% Check:
{ok, FileContents} = ssh_sftp:pread(Ch, Handle0, 0, 1234),
ok = ssh_sftp:close(Ch, Handle0),
%% Check in another way:
{ok, FileContents} = ssh_sftp:read_file(Ch, F0),
%% Remove write access rights and check that it can't be written:
ok = ssh_sftp:write_file_info(Ch, F0, #file_info{mode=8#400}), %read}),
{ok, #file_info{type=regular, access=read}} = ssh_sftp:read_file_info(Ch, F0),
{error,permission_denied} = ssh_sftp:write_file(Ch, F0, mkbin(10,14)),
%% Test deletion of file and dir:
[FileName0] = ok(ssh_sftp:list_dir(Ch, RootDir)) -- [".", ".."],
ok = ssh_sftp:delete(Ch, F0),
[] = ok(ssh_sftp:list_dir(Ch, RootDir)) -- [".", ".."],
ok = ssh_sftp:del_dir(Ch, RootDir),
false = lists:member(RootDir, ok(ssh_sftp:list_dir(Ch, "."))),
ok.
wait_for_async_result(Aref) ->
receive
{async_reply, Aref, Result} ->
Result
after
60000 ->
timeout
end.
mkbin(Size, Byte) ->
list_to_binary(lists:duplicate(Size,Byte)).
ok({ok,X}) -> X.
%%%----------------------------------------------------------------
renegotiate_test(init, ConnectionRef) ->
Kex1 = ssh_test_lib:get_kex_init(ConnectionRef),
ssh_connection_handler:renegotiate(ConnectionRef),
%%ct:log("Renegotiate test initiated!",[]),
Kex1;
renegotiate_test(Kex1, ConnectionRef) ->
case ssh_test_lib:get_kex_init(ConnectionRef) of
Kex1 ->
ct:log("Renegotiate test failed, Kex1 == Kex2!",[]),
error(renegotiate_failed);
_ ->
%% ct:log("Renegotiate test passed!",[]),
ok
end.
|