| SSH(7) | Erlang Application Definition | SSH(7) |
SSH - The ssh application implements the Secure Shell (SSH)
protocol and
provides an SSH File Transfer Protocol (SFTP) client and server.
The ssh application is an implementation of the SSH protocol in Erlang. ssh offers API functions to write customized SSH clients and servers as well as making the Erlang shell available over SSH. An SFTP client, ssh_sftp, and server, ssh_sftpd, are also included.
The ssh application uses the applications public_key and crypto to handle public keys and encryption. Hence, these applications must be loaded for the ssh application to work. The call ssh:start/0 will do the necessary calls to application:start/1,2 before it starts the ssh itself.
The SSH application uses Configuration Parameters. Where to set them are described in config User's Guide with SSH details in Configuration in SSH.
Some special configuration files from OpenSSH are also used:
By default, ssh looks for id_*, known_hosts, and authorized_keys in ~/.ssh, and for the ssh_host_*_key files in /etc/ssh. These locations can be changed by the options user_dir and system_dir. More about where to set them is described in Configuration in SSH.
Public key handling can also be customized through a callback module that implements the behaviors ssh_client_key_api and ssh_server_key_api.
See also the default callback module documentation in ssh_file.
id_* are the users private key files. Notice that the public key is part of the private key so the ssh application does not use the id_*.pub files. These are for the user's convenience when it is needed to convey the user's public key.
See ssh_file for details.
The known_hosts file contains a list of approved servers and their public keys. Once a server is listed, it can be verified without user interaction.
See ssh_file for details.
The authorized_key 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 ssh daemon.
See ssh_file for details.
RSA, DSA (if enabled), ECDSA, ED25519 and ED448 host keys are supported and are expected to be found in files named ssh_host_rsa_key, ssh_host_dsa_key, ssh_host_ecdsa_key, ssh_host_ed25519_key and ssh_host_ed448_key.
See ssh_file for details.
The ssh application uses the default OTP error logger to log unexpected errors or print information about special events.
The supported SSH version is 2.0.
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 ssh:default_algorithms/0. The user may override the default algorithm configuration both on the server side and the client side. See the options preferred_algorithms and modify_algorithms in the ssh:daemon/1,2,3 and ssh:connect/3,4 functions.
Supported algorithms are (in the default order):
The following unsecure sha1 algorithms are now disabled by default:
They can be enabled with the preferred_algorithms or modify_algorithms options. Use for example the Option value {modify_algorithms, [{append, [{kex,['diffie-hellman-group1-sha1']}]}]})
The following unsecure sha1 algorithm is now disabled by default:
It can be enabled with the preferred_algorithms or modify_algorithms options. Use for example the Option value {modify_algorithms, [{append, [{public_key,['ssh-dss']}]}]})
The following unsecure sha1 algorithm is disabled by default:
It can be enabled with the preferred_algorithms or modify_algorithms options. Use for example the Option value {modify_algorithms, [{append, [{mac,['hmac-sha1-96']}]}]})
See the text at the description of the rfc 5647 further down for more information regarding AEAD_AES_*_GCM.
Following the internet de-facto standard, the cipher and mac algorithm AEAD_AES_128_GCM is selected when the cipher aes128-gcm@openssh.com is negotiated. The cipher and mac algorithm AEAD_AES_256_GCM is selected when the cipher aes256-gcm@openssh.com is negotiated.
Unicode filenames are supported if the emulator and the underlaying OS support it. See section DESCRIPTION in the file manual page in Kernel for information about this subject.
The shell and the cli both support unicode.
The following rfc:s are supported:
Except
Except
Except
They are disabled by default, but can be enabled with the preferred_algorithms or modify_algorithms options.
Except
Except
Except
It is disabled by default, but can be enabled with the preferred_algorithms or modify_algorithms options.
There is an ambiguity in the synchronized selection of cipher and mac algorithm. This is resolved by OpenSSH in the ciphers aes128-gcm@openssh.com and aes256-gcm@openssh.com which are implemented. If the explicit ciphers and macs AEAD_AES_128_GCM or AEAD_AES_256_GCM are needed, they could be enabled with the options preferred_algorithms or modify_algorithms.
The second paragraph in section 5.1 is resolved as:
The first rule that matches when read in order from the top is applied
Except
Comment: Defines hmac-sha2-256 and hmac-sha2-512
Deviations:
are not enabled by default, but are still supported and can be enabled with the options preferred_algorithms or modify_algorithms.
Implemented are:
| ssh 4.10.8 | Ericsson AB |