User's Guide
Reference Manual
Release Notes
PDF
Top

SSH
Reference Manual
Version 4.2

Expand All
Contract All

Table of Contents

- SSH (App)
- ssh
  - Top of manual page
  - close/1
  - connect/3
  - connect/4
  - connection_info/2
  - daemon/1
  - daemon/2
  - daemon/3
  - default_algorithms/0
  - shell/1
  - shell/2
  - shell/3
  - start/0
  - start/1
  - stop/0
  - stop_daemon/1
  - stop_daemon/2
  - stop_listener/1
  - stop_listener/2
- ssh_channel
  - Top of manual page
  - call/2
  - call/3
  - cast/2
  - enter_loop/1
  - init/1
  - reply/2
  - start/4
  - start_link/4
  - Module:code_change/3
  - Module:init/1
  - Module:handle_call/3
  - Module:handle_cast/2
  - Module:handle_msg/2
  - Module:handle_ssh_msg/2
  - Module:terminate/2
- ssh_connection
  - Top of manual page
  - adjust_window/3
  - close/2
  - exec/4
  - exit_status/3
  - ptty_alloc/3
  - ptty_alloc/4
  - reply_request/4
  - send/3
  - send/4
  - send/4
  - send/5
  - send_eof/2
  - session_channel/2
  - session_channel/4
  - setenv/5
  - shell/2
  - subsystem/4
- ssh_client_key_api
  - Top of manual page
  - Module:add_host_key/3
  - Module:is_host_key/4
  - Module:user_key/2
- ssh_server_key_api
  - Top of manual page
  - Module:host_key/2
  - Module:is_auth_key/3
- ssh_sftp
  - Top of manual page
  - apread/4
  - apwrite/4
  - aread/3
  - awrite/3
  - close/2
  - close/3
  - delete/2
  - delete/3
  - del_dir/2
  - del_dir/3
  - list_dir/2
  - list_dir/3
  - make_dir/2
  - make_dir/3
  - make_symlink/3
  - make_symlink/4
  - open/3
  - open/4
  - opendir/2
  - opendir/3
  - open_tar/3
  - open_tar/4
  - position/3
  - position/4
  - pread/4
  - pread/5
  - pwrite/4
  - pwrite/5
  - read/3
  - read/4
  - read_file/2
  - read_file/3
  - read_file_info/2
  - read_file_info/3
  - read_link/2
  - read_link/3
  - read_link_info/2
  - read_link_info/3
  - rename/3
  - rename/4
  - start_channel/1
  - start_channel/2
  - start_channel/2
  - start_channel/3
  - stop_channel/1
  - write/3
  - write/4
  - write_file/3
  - write_file/4
  - write_file_info/3
  - write_file_info/4
- ssh_sftpd
  - Top of manual page
  - subsystem_spec/1

# SSH

### APPLICATION

SSH

### APPLICATION SUMMARY

The ssh application implements the Secure Shell (SSH) protocol and provides an SSH File Transfer Protocol (SFTP) client and server.

### DESCRIPTION

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.

### DEPENDENCIES

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. In an embedded environment this means that they must be started with application:start/1,2 before the ssh application is started.

### CONFIGURATION

The ssh application does not have an application- specific configuration file, as described in application(3). However, by default it use the following configuration files from OpenSSH:

- known_hosts
- authorized_keys
- authorized_keys2
- id_dsa
- id_rsa
- id_ecdsa
- ssh_host_dsa_key
- ssh_host_rsa_key
- ssh_host_ecdsa_key

By default, ssh looks for id_dsa, id_rsa, id_ecdsa_key, known_hosts, and authorized_keys in ~/.ssh, and for the host key files in /etc/ssh. These locations can be changed by the options user_dir and system_dir.

Public key handling can also be customized through a callback module that implements the behaviors ssh_client_key_api and ssh_server_key_api.

### Public Keys

id_dsa, id_rsa and id_ecdsa 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.

### Known Hosts

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.

### Authorized Keys

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.

### Host Keys

RSA and DSA host keys are supported and are expected to be found in files named ssh_host_rsa_key, ssh_host_dsa_key and ssh_host_ecdsa_key.

### ERROR LOGGER AND EVENT HANDLERS

The ssh application uses the default OTP error logger to log unexpected errors or print information about special events.

### SUPPORTED SPECIFICATIONS AND STANDARDS

The supported SSH version is 2.0.

### Algorithms

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 option preferred_algorithms in the ssh:daemon/1,2,3 and ssh:connect/3,4 functions.

Supported algorithms are:

Key exchange algorithms
  - ecdh-sha2-nistp256
  - ecdh-sha2-nistp384
  - ecdh-sha2-nistp521
  - diffie-hellman-group-exchange-sha1
  - diffie-hellman-group-exchange-sha256
  - diffie-hellman-group14-sha1
  - diffie-hellman-group1-sha1
Public key algorithms
  - ecdsa-sha2-nistp256
  - ecdsa-sha2-nistp384
  - ecdsa-sha2-nistp521
  - ssh-rsa
  - ssh-dss
MAC algorithms
  - hmac-sha2-256
  - hmac-sha2-512
  - hmac-sha1
Encryption algorithms (ciphers)
  - aes128-gcm@openssh.com (AEAD_AES_128_GCM)
  - aes256-gcm@openssh.com (AEAD_AES_256_GCM)
  - aes128-ctr
  - aes192-ctr
  - aes256-ctr
  - aes128-cbc
  - 3des-cbc

  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.

  See the text at the description of the rfc 5647 further down for more information.

Compression algorithms
  - none
  - zlib@openssh.com
  - zlib

### Unicode support

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.

### Rfcs

The following rfc:s are supported:

- RFC 4251, The Secure Shell (SSH) Protocol Architecture.

  Except

  - 9.4.6 Host-Based Authentication
  - 9.5.2 Proxy Forwarding
  - 9.5.3 X11 Forwarding

- RFC 4252, The Secure Shell (SSH) Authentication Protocol.

  Except

  - 9. Host-Based Authentication: "hostbased"

- RFC 4253, The Secure Shell (SSH) Transport Layer Protocol.

- RFC 4254, The Secure Shell (SSH) Connection Protocol.

  Except

  - 6.3. X11 Forwarding
  - 7. TCP/IP Port Forwarding

- RFC 4256, Generic Message Exchange Authentication for the Secure Shell Protocol (SSH).

  Except

  - num-prompts > 1
  - password changing
  - other identification methods than userid-password

- RFC 4419, Diffie-Hellman Group Exchange for the Secure Shell (SSH) Transport Layer Protocol.

- RFC 4716, The Secure Shell (SSH) Public Key File Format.

- RFC 5647, AES Galois Counter Mode for the Secure Shell Transport Layer Protocol.

  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 option preferred_algorithms.

  Warning

  If the client or the server is not Erlang/OTP, it is the users responsibility to check that other implementation has the same interpretation of AEAD_AES_*_GCM as the Erlang/OTP SSH before enabling them. The aes*-gcm@openssh.com variants are always safe to use since they lack the ambiguity.

  The second paragraph in section 5.1 is resolved as:

  - If the negotiated cipher is AEAD_AES_128_GCM, the mac algorithm is set to AEAD_AES_128_GCM.
  - If the negotiated cipher is AEAD_AES_256_GCM, the mac algorithm is set to AEAD_AES_256_GCM.
  - If the mac algorithm is AEAD_AES_128_GCM, the cipher is set to AEAD_AES_128_GCM.
  - If the mac algorithm is AEAD_AES_256_GCM, the cipher is set to AEAD_AES_256_GCM.

  The first rule that matches when read in order from the top is applied

- RFC 5656, Elliptic Curve Algorithm Integration in the Secure Shell Transport Layer.

  Except

  - 5. ECMQV Key Exchange
  - 6.4. ECMQV Key Exchange and Verification Method Name
  - 7.2. ECMQV Message Numbers
  - 10.2. Recommended Curves

- RFC 6668, SHA-2 Data Integrity Verification for the Secure Shell (SSH) Transport Layer Protocol

  Comment: Defines hmac-sha2-256 and hmac-sha2-512

### SEE ALSO

application(3)