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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE appref SYSTEM "appref.dtd">
<appref>
<header>
<copyright>
<year>2012</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
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.
</legalnotice>
<title>SSH</title>
<prepared></prepared>
<docno></docno>
<checked></checked>
<date></date>
<rev></rev>
<file>ssh_app.xml</file>
</header>
<app>SSH</app>
<appsummary>The ssh application implements the Secure Shell (SSH) protocol and
provides an SSH File Transfer Protocol (SFTP) client and server.</appsummary>
<description>
<p>The <c>ssh</c> application is an implementation of the SSH protocol in Erlang.
<c>ssh</c> offers API functions to write customized SSH clients and servers as well as
making the Erlang shell available over SSH. An SFTP client, <c>ssh_sftp</c>, and server,
<c>ssh_sftpd</c>, are also included.</p>
</description>
<section>
<title>DEPENDENCIES</title>
<p>The <c>ssh</c> application uses the applications
<seealso marker="public_key:public_key">public_key</seealso> and
<seealso marker="crypto:crypto">crypto</seealso>
to handle public keys and encryption. Hence, these
applications must be loaded for the <c>ssh</c> application to work. In
an embedded environment this means that they must be started with
<seealso marker="kernel:application#start/1">application:start/1,2</seealso> before the
<c>ssh</c> application is started.
</p>
</section>
<section>
<title>CONFIGURATION</title>
<p>The <c>ssh</c> application does not have an application-
specific configuration file, as described in <seealso marker="kernel:application">application(3)</seealso>.
However, by default it use the following configuration files
from OpenSSH:</p>
<list type="bulleted">
<item><c>known_hosts</c></item>
<item><c>authorized_keys</c></item>
<item><c>authorized_keys2</c></item>
<item><c>id_dsa</c></item>
<item><c>id_rsa</c></item>
<item><c>id_ecdsa</c></item>
<item><c>ssh_host_dsa_key</c></item>
<item><c>ssh_host_rsa_key</c></item>
<item><c>ssh_host_ecdsa_key</c></item>
</list>
<p>By default, <c>ssh</c> looks for <c>id_dsa</c>, <c>id_rsa</c>,
<c>id_ecdsa_key</c>,
<c>known_hosts</c>, and <c>authorized_keys</c> in ~/.ssh,
and for the host key files in <c>/etc/ssh</c>. These locations can be changed
by the options <c>user_dir</c> and <c>system_dir</c>.
</p>
<p>Public key handling can also be customized through a callback module that
implements the behaviors
<seealso marker="ssh_client_key_api">ssh_client_key_api</seealso> and
<seealso marker="ssh_server_key_api">ssh_server_key_api</seealso>.
</p>
</section>
<section>
<title>Public Keys</title>
<p><c>id_dsa</c>, <c>id_rsa</c> and <c>id_ecdsa</c> are the users private key files.
Notice that the public key is part of the private key so the <c>ssh</c>
application does not use the <c>id_<*>.pub</c> files. These are
for the user's convenience when it is needed to convey the user's
public key.
</p>
</section>
<section>
<title>Known Hosts</title>
<p>The <c>known_hosts</c> file contains a list of approved servers and
their public keys. Once a server is listed, it can be verified
without user interaction.
</p>
</section>
<section>
<title>Authorized Keys</title>
<p>The <c>authorized_key</c> file keeps track of the user's authorized
public keys. The most common use of this file is to let users
log in without entering their password, which is supported by the
Erlang <c>ssh</c> daemon.
</p>
</section>
<section>
<title>Host Keys</title>
<p>RSA and DSA host keys are supported and are
expected to be found in files named <c>ssh_host_rsa_key</c>,
<c>ssh_host_dsa_key</c> and <c>ssh_host_ecdsa_key</c>.
</p>
</section>
<section>
<title>ERROR LOGGER AND EVENT HANDLERS</title>
<p>The <c>ssh</c> application uses the default <seealso marker="kernel:error_logger">OTP error logger</seealso> to log unexpected errors or print information about special events.</p>
</section>
<section>
<marker id="supported"/>
<title>SUPPORTED</title>
<p>The supported SSH version is 2.0.</p>
<title>Algorithms</title>
<p>The actual set of algorithms may vary depending on which OpenSSL crypto library that is installed on the machine.
For the list on a particular installation, use the command
<seealso marker="ssh:ssh#default_algorithms/0">ssh:default_algorithms/0</seealso>.
The user may override the default algorithm configuration both on the server side and the client side.
See the option <c>preferred_algorithms</c> in the <seealso marker="ssh:ssh#daemon/1">ssh:daemon/1,2,3</seealso> and
<seealso marker="ssh:ssh#connect/3">ssh:connect/3,4</seealso> functions.
</p>
<p>Supported algorithms are:</p>
<taglist>
<tag>Public key algorithms</tag>
<item>
<list type="bulleted">
<item>ecdsa-sha2-nistp256</item>
<item>ecdsa-sha2-nistp384</item>
<item>ecdsa-sha2-nistp521</item>
<item>ssh-rsa</item>
<item>ssh-dss</item>
</list>
</item>
<tag>MAC algorithms</tag>
<item>
<list type="bulleted">
<item>hmac-sha2-256</item>
<item>hmac-sha2-512</item>
<item>hmac-sha1</item>
</list>
</item>
<tag>Encryption algorithms</tag>
<item>
<list type="bulleted">
<item>aes128-ctr</item>
<item>aes192-ctr</item>
<item>aes256-ctr</item>
<item>aes128-cbc</item>
<item>3des-cbc</item>
</list>
</item>
<tag>Key exchange algorithms</tag>
<item>
<list type="bulleted">
<item>ecdh-sha2-nistp256</item>
<item>ecdh-sha2-nistp384</item>
<item>ecdh-sha2-nistp521</item>
<item>diffie-hellman-group-exchange-sha1</item>
<item>diffie-hellman-group-exchange-sha256</item>
<item>diffie-hellman-group14-sha1</item>
<item>diffie-hellman-group1-sha1</item>
</list>
</item>
<tag>Compression algorithms</tag>
<item>
<list type="bulleted">
<item>none</item>
<item>[email protected]</item>
<item>zlib</item>
</list>
</item>
</taglist>
<title>Unicode support</title>
<p>Unicode filenames are supported if the emulator and the underlaying OS support it. See section DESCRIPTION in the
<seealso marker="kernel:file">file</seealso> manual page in <c>kernel</c> for information about this subject.
</p>
<p>The shell and the cli support unicode.
</p>
</section>
<section>
<title>SEE ALSO</title>
<p><seealso marker="kernel:application">application(3)</seealso></p>
</section>
</appref>
|
