-
Notifications
You must be signed in to change notification settings - Fork 3k
/
Copy pathssh.erl
1431 lines (1216 loc) · 53.6 KB
/
ssh.erl
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
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2004-2024. 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).
-moduledoc """
Main API of the ssh application
This is the interface module for the `SSH` application. The Secure Shell (SSH)
Protocol is a protocol for secure remote login and other secure network services
over an insecure network. See [ssh](ssh_app.md#supported) for details of
supported RFCs, versions, algorithms and unicode handling.
With the SSH application it is possible to start _clients_ and to start
_daemons_ (servers).
Clients are started with `connect/2`, `connect/3` or `connect/4`. They open an
encrypted connection on top of TCP/IP. In that encrypted connection one or more
channels could be opened with
[ssh_connection:session_channel/2,4](`ssh_connection:session_channel/2`).
Each channel is an isolated "pipe" between a client-side process and a
server-side process. Those process pairs could handle for example file transfers
(sftp) or remote command execution (shell, exec and/or cli). If a custom shell
is implemented, the user of the client could execute the special commands
remotely. Note that the user is not necessarily a human but probably a system
interfacing the SSH app.
A server-side subssystem (channel) server is requested by the client with
`ssh_connection:subsystem/4`.
A server (daemon) is started with [daemon/1](`daemon/2`), `daemon/2` or
[daemon/3](`daemon/2`). Possible channel handlers (subsystems) are declared with
the [subsystem](`t:subsystem_daemon_option/0`) option when the daemon is
started.
To just run a shell on a remote machine, there are functions that bundles the
needed three steps needed into one: [shell/1,2,3](`shell/1`). Similarly, to just
open an sftp (file transfer) connection to a remote machine, the simplest way is
to use [ssh_sftp:start_channel/1,2,3](`ssh_sftp:start_channel/1`).
To write your own client channel handler, use the behaviour
`m:ssh_client_channel`. For server channel handlers use `m:ssh_server_channel`
behaviour (replaces ssh_daemon_channel).
Both clients and daemons accepts options that controls the exact behaviour. Some
options are common to both. The three sets are called
[Client Options](`t:client_options/0`), [Daemon Options](`t:daemon_options/0`)
and [Common Options](`t:common_options/0`).
The descriptions of the options uses the
[Erlang Type Language](`e:system:typespec.md`) with explaining text.
> #### Note {: .info }
>
> See also [SSH Application Reference](index.html) and [Examples](using_ssh.md) section.
## Keys and files
A number of objects must be present for the SSH application to work. Those
objects are per default stored in files. The default names, paths and file
formats are the same as for [OpenSSH](http://www.openssh.com). Keys could be
generated with the `ssh-keygen` program from OpenSSH. See the
[User's Guide](using_ssh.md#running-an-erlang-ssh-daemon).
The paths could easily be changed by options:
[`user_dir`](`t:ssh_file:user_dir_common_option/0`) and
[`system_dir`](`t:ssh_file:system_dir_daemon_option/0`).
A completely different storage could be interfaced by writing callback modules
using the behaviours `m:ssh_client_key_api` and/or `m:ssh_server_key_api`. A
callback module is installed with the option
[`key_cb`](`t:key_cb_common_option/0`) to the client and/or the daemon.
### Daemons
The keys are by default stored in files:
- Mandatory: one or more _Host key(s)_, both private and public. Default is to
store them in the directory `/etc/ssh` in the files
- `ssh_host_dsa_key` and `ssh_host_dsa_key.pub`
- `ssh_host_rsa_key` and `ssh_host_rsa_key.pub`
- `ssh_host_ecdsa_key` and `ssh_host_ecdsa_key.pub`
The host keys directory could be changed with the option
[`system_dir`](`t:ssh_file:system_dir_daemon_option/0`).
- Optional: one or more _User's public key_ in case of `publickey`
authorization. Default is to store them concatenated in the file
`.ssh/authorized_keys` in the user's home directory.
The user keys directory could be changed with the option
[`user_dir`](`t:ssh_file:user_dir_common_option/0`).
### Clients
The keys and some other data are by default stored in files in the directory
`.ssh` in the user's home directory.
The directory could be changed with the option
[`user_dir`](`t:ssh_file:user_dir_common_option/0`).
- Optional: a list of _Host public key(s)_ for previously connected hosts. This
list is handled by the SSH application without any need of user assistance.
The default is to store them in the file `known_hosts`.
The `t:host_accepting_client_options/0` are associated with this list of keys.
- Optional: one or more _User's private key(s)_ in case of `publickey`
authorization. The default files are
- `id_dsa` and `id_dsa.pub`
- `id_rsa` and `id_rsa.pub`
- `id_ecdsa` and `id_ecdsa.pub`
""".
-moduledoc(#{titles =>
[{type,<<"Client Options">>},
{type,<<"Daemon Options (Server Options)">>},
{type,<<"Common Options">>},
{type,<<"Other data types">>}]}).
-include("ssh.hrl").
-include("ssh_connect.hrl").
-include_lib("public_key/include/public_key.hrl").
-include_lib("kernel/include/file.hrl").
-include_lib("kernel/include/inet.hrl").
-export([start/0, start/1, stop/0,
connect/2, connect/3, connect/4,
close/1, connection_info/2,
connection_info/1,
channel_info/3,
daemon/1, daemon/2, daemon/3,
daemon_info/1, daemon_info/2,
daemon_replace_options/2,
set_sock_opts/2, get_sock_opts/2,
default_algorithms/0,
chk_algos_opts/1,
stop_listener/1, stop_listener/2, stop_listener/3,
stop_daemon/1, stop_daemon/2, stop_daemon/3,
shell/1, shell/2, shell/3,
tcpip_tunnel_from_server/5, tcpip_tunnel_from_server/6,
tcpip_tunnel_to_server/5, tcpip_tunnel_to_server/6
]).
%% In move from public_key
-export([hostkey_fingerprint/1, hostkey_fingerprint/2
]).
%%% Internal export
-export([is_host/2]).
-behaviour(ssh_dbg).
-export([ssh_dbg_trace_points/0, ssh_dbg_flags/1, ssh_dbg_on/1, ssh_dbg_off/1, ssh_dbg_format/2, ssh_dbg_format/3]).
%%% "Deprecated" types export:
-export_type([ssh_daemon_ref/0, ssh_connection_ref/0, ssh_channel_id/0]).
-opaque ssh_daemon_ref() :: daemon_ref().
-opaque ssh_connection_ref() :: connection_ref().
-opaque ssh_channel_id() :: channel_id().
%%% Type exports
-export_type([daemon_ref/0,
connection_ref/0,
channel_id/0,
client_options/0, client_option/0,
daemon_options/0, daemon_option/0,
common_options/0,
role/0,
subsystem_spec/0,
algs_list/0,
double_algs/1,
modify_algs_list/0,
alg_entry/0,
kex_alg/0,
pubkey_alg/0,
cipher_alg/0,
mac_alg/0,
compression_alg/0,
host/0,
open_socket/0,
ip_port/0
]).
-doc """
Opaque data type representing a daemon.
Returned by the functions [`daemon/1,2,3`](`daemon/1`).
""".
-doc(#{title => <<"Other data types">>}).
-opaque daemon_ref() :: pid() .
-doc """
Opaque data type representing a channel inside a connection.
Returned by the functions
[ssh_connection:session_channel/2,4](`ssh_connection:session_channel/2`).
""".
-doc(#{title => <<"Other data types">>}).
-opaque channel_id() :: non_neg_integer().
-doc """
Opaque data type representing a connection between a client and a server
(daemon).
Returned by the functions [`connect/2,3,4`](`connect/3`) and
[`ssh_sftp:start_channel/2,3`](`ssh_sftp:start_channel/2`).
""".
-doc(#{title => <<"Other data types">>}).
-type connection_ref() :: pid(). % should be -opaque, but that gives problems
%%--------------------------------------------------------------------
%% Description: Starts the ssh application. Default type
%% is temporary. see application(3)
%%--------------------------------------------------------------------
-doc(#{equiv => start/1}).
-spec start() -> ok | {error, term()}.
start() ->
start(temporary).
-doc """
Utility function that starts the applications `crypto`, `public_key`, and `ssh`.
Default type is `temporary`. For more information, see the `m:application`
manual page in Kernel.
""".
-spec start(Type) -> ok | {error, term()} when
Type :: permanent | transient | temporary .
start(Type) ->
case application:ensure_all_started(ssh, Type) of
{ok, _} ->
%% Clear cached default_algorithms (if exists) ...
ssh_transport:clear_default_algorithms_env(),
%% ... and rebuild them taking configure options in account
ssh_transport:default_algorithms(),
ok;
Other ->
Other
end.
%%--------------------------------------------------------------------
%% Description: Stops the ssh application.
%%--------------------------------------------------------------------
-doc """
Stops the `ssh` application. For more information, see the `m:application`
manual page in Kernel.
""".
-spec stop() -> ok | {error, term()}.
stop() ->
application:stop(ssh).
%%--------------------------------------------------------------------
%% Description: Starts an ssh connection.
%%--------------------------------------------------------------------
-define(IS_VALID_OPTIONS(Options), is_list(Options)).
-define(IS_VALID_PORT(Port), (is_integer(Port) andalso Port > 0)).
-define(IS_VALID_TIMEOUT(Timeout),
(Timeout == infinity
orelse (is_integer(Timeout)
andalso Timeout >= 0))).
-doc(#{equiv => connect/4}).
-doc(#{since => <<"OTP 19.0">>}).
-spec connect(OpenTcpSocket, Options)
-> {ok, connection_ref()}
| {error, term()} when
OpenTcpSocket :: open_socket(),
Options :: client_options().
connect(OpenTcpSocket, Options) when ?IS_VALID_OPTIONS(Options) ->
connect(OpenTcpSocket, Options, infinity);
connect(_OpenTcpSocket, Options) ->
bad_arg([{options, Options}]).
-doc(#{equiv => connect/4}).
-spec connect(open_socket(), client_options(), timeout()) ->
{ok, connection_ref()} | {error, term()}
; (host(), inet:port_number(), client_options()) ->
{ok, connection_ref()} | {error, term()}.
connect(Host, Port, Options) when ?IS_VALID_PORT(Port),
?IS_VALID_OPTIONS(Options) ->
Timeout = proplists:get_value(connect_timeout, Options, infinity),
connect(Host, Port, Options, Timeout);
connect(Socket, UserOptions, NegotiationTimeout)
when ?IS_VALID_OPTIONS(UserOptions),
?IS_VALID_TIMEOUT(NegotiationTimeout) ->
case ssh_options:handle_options(client, UserOptions) of
{error, Error} ->
{error, Error};
Options = #{} ->
case valid_socket_to_use(Socket, ?GET_OPT(transport,Options)) of
ok ->
continue_connect(Socket, Options, NegotiationTimeout);
{error,SockError} ->
{error,SockError}
end
end;
connect(_HostOrSocket, PortOrOptions, OptionsOrTimeout) ->
bad_arg(PortOrOptions, OptionsOrTimeout).
-doc """
connect(Host, Port, Options, NegotiationTimeout) -> Result
Connects to an SSH server at the `Host` on `Port`.
As an alternative, an already open TCP socket could be passed to the function in
`TcpSocket`. The SSH initiation and negotiation will be initiated on that one
with the SSH that should be at the other end.
No channel is started. This is done by calling
[ssh_connection:session_channel/2,4](`ssh_connection:session_channel/2`).
The `NegotiationTimeout` is in milli-seconds. The default value is `infinity` or
the value of the [`connect_timeout`](`t:connect_timeout_client_option/0`)
option, if present. For connection timeout, use the option
[`connect_timeout`](`t:connect_timeout_client_option/0`).
""".
-spec connect(Host, Port, Options, NegotiationTimeout)
-> {ok, connection_ref()}
| {error, term()} when
Host :: host(),
Port :: inet:port_number(),
Options :: client_options(),
NegotiationTimeout :: timeout().
connect(Host0, Port, UserOptions, NegotiationTimeout)
when ?IS_VALID_PORT(Port),
?IS_VALID_OPTIONS(UserOptions),
?IS_VALID_TIMEOUT(NegotiationTimeout) ->
case ssh_options:handle_options(client, UserOptions) of
{error, Reason} ->
{error, Reason};
Options ->
SocketOpts = [{active,false} | ?GET_OPT(socket_options,Options)],
Host = mangle_connect_address(Host0, Options),
try
transport_connect(Host, Port, SocketOpts, Options)
of
{ok, Socket} ->
continue_connect(Socket, Options, NegotiationTimeout);
{error, Reason} ->
{error, Reason}
catch
_:badarg -> {error, {options,?GET_OPT(socket_options,Options)}};
_:{error,Reason} -> {error,Reason};
error:Error -> {error,Error};
Class:Error -> {error, {Class,Error}}
end
end;
connect(_Host, Port, UserOptions, NegotiationTimeout) ->
bad_arg([{port, Port},
{options, UserOptions},
{timeout, NegotiationTimeout}]).
bad_arg(Args) ->
hd(bad_args(Args)).
%% Special handling for finding the incorrect args for connect/3,
%% which has two distinctly different signatures.
bad_arg(Arg2, Arg3) ->
E0 = bad_args([{port, Arg2}, {options, Arg3}]),
E1 = bad_args([{options, Arg2}, {timeout, Arg3}]),
%% Select the case with only one error
case {E0, E1} of
{[Error], _} -> Error;
{_, [Error]} -> Error;
{[Error, _], _} -> Error
end.
%% Return list of errors
-spec bad_args([{'options' | 'port' | 'timeout', any()}]) ->
[{'error', term()}].
bad_args(Args) ->
IsErr = fun(true, _) -> false;
(false, Error) -> {true, {error, Error}}
end,
Check =
fun({options, Arg}) -> IsErr(?IS_VALID_OPTIONS(Arg), invalid_options);
({timeout, Arg}) -> IsErr(?IS_VALID_TIMEOUT(Arg), invalid_timeout);
({port, Arg}) -> IsErr(?IS_VALID_PORT(Arg), invalid_port)
end,
lists:filtermap(Check, Args).
%%%----------------
continue_connect(Socket, Options0, NegTimeout) ->
{ok, {SockHost,SockPort}} = inet:sockname(Socket),
Options = ?PUT_INTERNAL_OPT([{negotiation_timeout,NegTimeout}], Options0),
Address = #address{address = SockHost,
port = SockPort,
profile = ?GET_OPT(profile,Options)
},
ssh_system_sup:start_subsystem(client, Address, Socket, Options).
%%--------------------------------------------------------------------
-doc "Closes an SSH connection.".
-spec close(ConnectionRef) -> ok | {error,term()} when
ConnectionRef :: connection_ref() .
%%
%% Description: Closes an ssh connection.
%%--------------------------------------------------------------------
close(ConnectionRef) ->
ssh_connection_handler:stop(ConnectionRef).
%%--------------------------------------------------------------------
%% Description: Retrieves information about a connection.
%%---------------------------------------------------------------------
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-type version() :: {protocol_version(), software_version()}.
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-type protocol_version() :: {Major::pos_integer(), Minor::non_neg_integer()}.
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-type software_version() :: string().
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-type conn_info_algs() :: [{kex, kex_alg()}
| {hkey, pubkey_alg()}
| {encrypt, cipher_alg()}
| {decrypt, cipher_alg()}
| {send_mac, mac_alg()}
| {recv_mac, mac_alg()}
| {compress, compression_alg()}
| {decompress, compression_alg()}
| {send_ext_info, boolean()}
| {recv_ext_info, boolean()}
].
-doc """
Return values from the `connection_info/1` and `connection_info/2` functions.
In the `option` info tuple are only the options included that differs from the
default values.
""".
-doc(#{title => <<"Other data types">>}).
-type conn_info_channels() :: [proplists:proplist()].
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-type connection_info_tuple() ::
{client_version, version()}
| {server_version, version()}
| {user, string()}
| {peer, {inet:hostname(), ip_port()}}
| {sockname, ip_port()}
| {options, client_options()}
| {algorithms, conn_info_algs()}
| {channels, conn_info_channels()}.
-doc(#{equiv => connection_info/2}).
-doc(#{since => <<"OTP 22.1">>}).
-spec connection_info(ConnectionRef) -> InfoTupleList when
ConnectionRef :: connection_ref(),
InfoTupleList :: [InfoTuple],
InfoTuple :: connection_info_tuple().
connection_info(ConnectionRef) ->
connection_info(ConnectionRef, []).
-doc """
Returns information about a connection intended for e.g debugging or logging.
When the `Key` is a single `Item`, the result is a single `InfoTuple`
""".
-spec connection_info(ConnectionRef, ItemList|Item) -> InfoTupleList|InfoTuple when
ConnectionRef :: connection_ref(),
ItemList :: [Item],
Item :: client_version | server_version | user | peer | sockname | options | algorithms | sockname,
InfoTupleList :: [InfoTuple],
InfoTuple :: connection_info_tuple().
connection_info(ConnectionRef, Key) ->
ssh_connection_handler:connection_info(ConnectionRef, Key).
%%--------------------------------------------------------------------
-doc false.
-spec channel_info(connection_ref(), channel_id(), [atom()]) -> proplists:proplist().
%%
%% Description: Retrieves information about a connection.
%%--------------------------------------------------------------------
channel_info(ConnectionRef, ChannelId, Options) ->
ssh_connection_handler:channel_info(ConnectionRef, ChannelId, Options).
%%--------------------------------------------------------------------
%% Description: Starts a server listening for SSH connections
%% on the given port.
%%--------------------------------------------------------------------
-doc(#{equiv => daemon/3}).
-spec daemon(inet:port_number()) -> {ok,daemon_ref()} | {error,term()}.
daemon(Port) ->
daemon(Port, []).
-doc(#{equiv => daemon/3}).
-spec daemon(inet:port_number()|open_socket(), daemon_options()) -> {ok,daemon_ref()} | {error,term()}.
daemon(Port, UserOptions) when 0 =< Port,Port =< 65535 ->
daemon(any, Port, UserOptions);
daemon(Socket, UserOptions) ->
case ssh_options:handle_options(server, UserOptions) of
#{} = Options0 ->
case valid_socket_to_use(Socket, ?GET_OPT(transport,Options0)) of
ok ->
try
%% throws error:Error if no usable hostkey is found
ssh_connection_handler:available_hkey_algorithms(server, Options0),
{ok, {SockHost,SockPort}} = inet:sockname(Socket),
Address = #address{address = SockHost,
port = SockPort,
profile = ?GET_OPT(profile,Options0)
},
Options = ?PUT_INTERNAL_OPT({connected_socket, Socket}, Options0),
case ssh_system_sup:start_subsystem(server, Address, Socket, Options) of
{ok,Pid} ->
{ok,Pid};
{error, {already_started, _}} ->
{error, eaddrinuse};
{error, Error} ->
{error, Error}
end
catch
error:{shutdown,Err} ->
{error,Err};
exit:{noproc, _} ->
{error, ssh_not_started};
C:R ->
{error,{could_not_start_connection,{C,R}}}
end;
{error,SockError} ->
{error,SockError}
end;
{error,OptionError} ->
{error,OptionError}
end.
-doc """
daemon(HostAddress, Port, Options) -> Result
Starts a server listening for SSH connections on the given port. If the `Port`
is 0, a random free port is selected. See `daemon_info/1` about how to find the
selected port number.
As an alternative, an already open TCP socket could be passed to the function in
`TcpSocket`. The SSH initiation and negotiation will be initiated on that one
when an SSH starts at the other end of the TCP socket.
For a description of the options, see [Daemon Options](`t:daemon_options/0`).
Please note that by historical reasons both the `HostAddress` argument and the
[gen_tcp connect_option() `{ip,Address}`](`t:gen_tcp:connect_option/0`) set the
listening address. This is a source of possible inconsistent settings.
The rules for handling the two address passing options are:
- if `HostAddress` is an IP-address, that IP-address is the listening address.
An 'ip'-option will be discarded if present.
- if `HostAddress` is the atom `loopback`, the listening address is `loopback`
and an loopback address will be chosen by the underlying layers. An
'ip'-option will be discarded if present.
- if `HostAddress` is the atom `any` and no 'ip'-option is present, the
listening address is `any` and the socket will listen to all addresses
- if `HostAddress` is `any` and an 'ip'-option is present, the listening address
is set to the value of the 'ip'-option
""".
-spec daemon(any | inet:ip_address(), inet:port_number(), daemon_options()) -> {ok,daemon_ref()} | {error,term()}
;(socket, open_socket(), daemon_options()) -> {ok,daemon_ref()} | {error,term()}
.
daemon(Host0, Port0, UserOptions0) when 0 =< Port0, Port0 =< 65535,
Host0 == any ; Host0 == loopback ; is_tuple(Host0) ->
try
{Host1, UserOptions} = handle_daemon_args(Host0, UserOptions0),
#{} = Options0 = ssh_options:handle_options(server, UserOptions),
%% We need to open the listen socket here before start of the system supervisor. That
%% is because Port0 might be 0, or if an FD is provided in the Options0, in which case
%% the real listening port will be known only after the gen_tcp:listen call.
maybe_open_listen_socket(Host1, Port0, Options0)
of
{Host, Port, ListenSocket, Options1} ->
try
%% Now Host,Port is what to use for the supervisor to register its name,
%% and ListenSocket, if provided, is for listening on connections. But
%% it is still owned by self()...
%% throws error:Error if no usable hostkey is found
ssh_connection_handler:available_hkey_algorithms(server, Options1),
ssh_system_sup:start_system(server,
#address{address = Host,
port = Port,
profile = ?GET_OPT(profile,Options1)},
Options1)
of
{ok,DaemonRef} when ListenSocket == undefined ->
{ok,DaemonRef};
{ok,DaemonRef} ->
receive
{request_control, ListenSocket, ReqPid} ->
ok = controlling_process(ListenSocket, ReqPid, Options1),
ReqPid ! {its_yours,ListenSocket}
end,
{ok,DaemonRef};
{error, {already_started, _}} ->
close_listen_socket(ListenSocket, Options1),
{error, eaddrinuse};
{error, Error} ->
close_listen_socket(ListenSocket, Options1),
{error, Error}
catch
error:{shutdown,Err} ->
close_listen_socket(ListenSocket, Options1),
{error,Err};
exit:{noproc, _} ->
close_listen_socket(ListenSocket, Options1),
{error, ssh_not_started};
error:Error ->
close_listen_socket(ListenSocket, Options1),
error(Error);
exit:Exit ->
close_listen_socket(ListenSocket, Options1),
exit(Exit)
end
catch
throw:bad_fd ->
{error,bad_fd};
throw:bad_socket ->
{error,bad_socket};
error:{badmatch,{error,Error}} ->
{error,Error};
error:Error ->
{error,Error};
_C:_E ->
{error,{cannot_start_daemon,_C,_E}}
end;
daemon(_, _, _) ->
{error, badarg}.
%%--------------------------------------------------------------------
-doc """
Replaces the options in a running daemon with the options in `NewUserOptions`.
Only connections established after this call are affected, already established
connections are not.
> #### Note {: .info }
>
> In the final phase of this function, the listening process is restarted.
> Therfore a connection attempt to the daemon in this final phase could fail.
The handling of Erlang configurations is described in the User's Guide; see
chapters [Configuration in SSH](configurations.md) and
[Configuring algorithms in SSH](configure_algos.md).
""".
-doc(#{since => <<"OTP 25.1">>}).
-spec daemon_replace_options(DaemonRef, NewUserOptions) -> {ok,daemon_ref()}
| {error,term()} when
DaemonRef :: daemon_ref(),
NewUserOptions :: daemon_options().
daemon_replace_options(DaemonRef, NewUserOptions) ->
{ok,Os0} = ssh_system_sup:get_acceptor_options(DaemonRef),
Os1 = ssh_options:merge_options(server, NewUserOptions, Os0),
ssh_system_sup:replace_acceptor_options(DaemonRef, Os1).
%%--------------------------------------------------------------------
-doc """
Return values from the `daemon_info/1` and `daemon_info/2` functions.
In the `option` info tuple are only the options included that differs from the
default values.
""".
-doc(#{title => <<"Other data types">>}).
-type daemon_info_tuple() ::
{port, inet:port_number()}
| {ip, inet:ip_address()}
| {profile, atom()}
| {options, daemon_options()}.
-doc(#{equiv => daemon_info/2}).
-doc(#{since => <<"OTP 19.0">>}).
-spec daemon_info(DaemonRef) -> {ok,InfoTupleList} | {error,bad_daemon_ref} when
DaemonRef :: daemon_ref(),
InfoTupleList :: [InfoTuple],
InfoTuple :: daemon_info_tuple().
daemon_info(DaemonRef) ->
case ssh_system_sup:get_daemon_listen_address(DaemonRef) of
{ok,A} ->
Address =
case inet:parse_strict_address(A#address.address) of
{ok,IP} -> A#address{address=IP};
_ -> A
end,
Opts =
%% Pick a subset of the Options to present:
case ssh_system_sup:get_options(DaemonRef, Address) of
{ok, OptMap} ->
lists:sort(
maps:to_list(
ssh_options:keep_set_options(
server,
ssh_options:keep_user_options(server,OptMap))));
_ ->
[]
end,
{ok, [{port, Address#address.port},
{ip, Address#address.address},
{profile, Address#address.profile},
{options, Opts}
]};
_ ->
{error,bad_daemon_ref}
end.
-doc """
Returns information about a daemon intended for e.g debugging or logging.
When the `Key` is a single `Item`, the result is a single `InfoTuple`
Note that [`daemon_info/1`](`daemon_info/1`) and
[`daemon_info/2`](`daemon_info/2`) returns different types due to compatibility
reasons.
""".
-doc(#{since => <<"OTP 22.1">>}).
-spec daemon_info(DaemonRef, ItemList|Item) -> InfoTupleList|InfoTuple | {error,bad_daemon_ref} when
DaemonRef :: daemon_ref(),
ItemList :: [Item],
Item :: ip | port | profile | options,
InfoTupleList :: [InfoTuple],
InfoTuple :: daemon_info_tuple().
daemon_info(DaemonRef, Key) when is_atom(Key) ->
case daemon_info(DaemonRef, [Key]) of
[{Key,Val}] -> {Key,Val};
Other -> Other
end;
daemon_info(DaemonRef, Keys) ->
case daemon_info(DaemonRef) of
{ok,KVs} ->
[{Key,proplists:get_value(Key,KVs)} || Key <- Keys,
lists:keymember(Key,1,KVs)];
_ ->
[]
end.
%%--------------------------------------------------------------------
%% Description: Stops the listener, but leaves
%% existing connections started by the listener up and running.
%%--------------------------------------------------------------------
-doc(#{equiv => stop_listener/3}).
-spec stop_listener(daemon_ref()) -> ok.
stop_listener(SysSup) ->
ssh_system_sup:stop_listener(SysSup).
-doc(#{equiv => stop_listener/3}).
-spec stop_listener(inet:ip_address(), inet:port_number()) -> ok.
stop_listener(Address, Port) ->
stop_listener(Address, Port, ?DEFAULT_PROFILE).
-doc """
Stops the listener, but leaves existing connections started by the listener
operational.
""".
-doc(#{since => <<"OTP 21.0">>}).
-spec stop_listener(any|inet:ip_address(), inet:port_number(), term()) -> ok.
stop_listener(Address, Port, Profile) ->
lists:foreach(fun({Sup,_Addr}) ->
stop_listener(Sup)
end,
ssh_system_sup:addresses(server,
#address{address=Address,
port=Port,
profile=Profile})).
-doc(#{equiv => stop_daemon/3}).
-spec stop_daemon(DaemonRef::daemon_ref()) -> ok.
stop_daemon(SysSup) ->
ssh_system_sup:stop_system(server, SysSup).
-doc(#{equiv => stop_daemon/3}).
-spec stop_daemon(inet:ip_address(), inet:port_number()) -> ok.
stop_daemon(Address, Port) ->
stop_daemon(Address, Port, ?DEFAULT_PROFILE).
-doc "Stops the listener and all connections started by the listener.".
-doc(#{since => <<"OTP 21.0">>}).
-spec stop_daemon(any|inet:ip_address(), inet:port_number(), atom()) -> ok.
stop_daemon(Address, Port, Profile) ->
lists:foreach(fun({Sup,_Addr}) ->
stop_daemon(Sup)
end,
ssh_system_sup:addresses(server,
#address{address=Address,
port=Port,
profile=Profile})).
%%--------------------------------------------------------------------
%% Description: Starts an interactive shell to an SSH server on the
%% given <Host>. The function waits for user input,
%% and will not return until the remote shell is ended.(e.g. on
%% exit from the shell)
%%--------------------------------------------------------------------
-doc(#{equiv => shell/3}).
-spec shell(open_socket() | host() | connection_ref()) -> _.
shell(ConnectionRef) when is_pid(ConnectionRef) ->
case ssh_connection:session_channel(ConnectionRef, infinity) of
{ok,ChannelId} ->
success = ssh_connection:ptty_alloc(ConnectionRef, ChannelId,
[{pty_opts, [{echo,0}]}
]),
success = ssh_connection:send_environment_vars(ConnectionRef, ChannelId,
["LANG", "LC_ALL"]),
Args = [{channel_cb, ssh_shell},
{init_args,[ConnectionRef, ChannelId]},
{cm, ConnectionRef}, {channel_id, ChannelId}],
{ok, State} = ssh_client_channel:init([Args]),
try
ssh_client_channel:enter_loop(State)
catch
exit:normal ->
ok
end;
Error ->
Error
end;
shell(Dest) ->
case is_host(Dest, []) of
true ->
shell(Dest, ?SSH_DEFAULT_PORT, []);
false ->
%% Maybe socket
shell_socket(Dest, [])
end.
-doc(#{equiv => shell/3}).
-spec shell(open_socket() | host(), client_options()) -> _.
shell(Dest, Options) ->
case is_host(Dest, Options) of
true ->
shell(Dest, ?SSH_DEFAULT_PORT, Options);
false ->
%% Maybe socket
shell_socket(Dest, Options)
end.
shell_socket(Socket, Options) ->
case connect(Socket, Options) of
{ok,ConnectionRef} ->
shell(ConnectionRef),
close(ConnectionRef);
Error ->
Error
end.
-doc """
shell(Host, Port, Options) -> Result
Connects to an SSH server at `Host` and `Port` (defaults to 22) and starts an
interactive shell on that remote host.
As an alternative, an already open TCP socket could be passed to the function in
`TcpSocket`. The SSH initiation and negotiation will be initiated on that one
and finally a shell will be started on the host at the other end of the TCP
socket.
For a description of the options, see [Client Options](`t:client_options/0`).
The function waits for user input, and does not return until the remote shell is
ended (that is, exit from the shell).
""".
-spec shell(Host, Port, Options) -> _ when
Host :: host(),
Port :: inet:port_number(),
Options :: client_options() .
shell(Host, Port, Options) ->
case connect(Host, Port, Options) of
{ok,ConnectionRef} ->
shell(ConnectionRef),
close(ConnectionRef);
Error ->
Error
end.
%%--------------------------------------------------------------------
-doc """
Returns a key-value list, where the keys are the different types of algorithms
and the values are the algorithms themselves.
See the [User's Guide](configure_algos.md#example_default_algorithms) for an
example.
""".
-doc(#{since => <<"OTP 18.0">>}).
-spec default_algorithms() -> algs_list() .
%%--------------------------------------------------------------------
default_algorithms() ->
ssh_transport:default_algorithms().
%%--------------------------------------------------------------------
-doc false.
-spec chk_algos_opts(client_options()|daemon_options()) -> internal_options() | {error,term()}.
%%--------------------------------------------------------------------
chk_algos_opts(Opts) ->
case lists:foldl(
fun({preferred_algorithms,_}, Acc) -> Acc;
({modify_algorithms,_}, Acc) -> Acc;
(KV, Acc) -> [KV|Acc]
end, [], Opts)
of
[] ->
case ssh_options:handle_options(client, Opts) of
M when is_map(M) ->
maps:get(preferred_algorithms, M);
Others ->
Others
end;
OtherOps ->
{error, {non_algo_opts_found,OtherOps}}
end.
%%--------------------------------------------------------------------
-doc """
Sets tcp socket options on the tcp-socket below an ssh connection.
This function calls the `inet:setopts/2`, read that documentation and for
`t:gen_tcp:option/0`.
All gen_tcp socket options except
- `active`
- `deliver`
- `mode` and
- `packet`
are allowed. The excluded options are reserved by the SSH application.
> #### Warning {: .warning }
>
> This is an extremely dangerous function. You use it on your own risk.
>
> Some options are OS and OS version dependent. Do not use it unless you know
> what effect your option values will have on an TCP stream.
>
> Some values may destroy the functionality of the SSH protocol.
""".
-doc(#{since => <<"OTP 22.3">>}).
-spec set_sock_opts(ConnectionRef, SocketOptions) ->
ok | {error, inet:posix()} when
ConnectionRef :: connection_ref(),
SocketOptions :: [gen_tcp:option()] .
%%--------------------------------------------------------------------
set_sock_opts(ConnectionRef, SocketOptions) ->
ssh_connection_handler:set_sock_opts(ConnectionRef, SocketOptions).
%%--------------------------------------------------------------------