From ac4107ceea994f028ae67b43dbe6676b9ccf2b3b Mon Sep 17 00:00:00 2001 From: tmanevik Date: Thu, 19 Mar 2015 14:00:43 +0100 Subject: Editorial updates SSH application --- lib/ssh/doc/src/ssh_app.xml | 120 ++++++++++++++++++++++++++------------------ 1 file changed, 70 insertions(+), 50 deletions(-) (limited to 'lib/ssh/doc/src/ssh_app.xml') diff --git a/lib/ssh/doc/src/ssh_app.xml b/lib/ssh/doc/src/ssh_app.xml index a1d2402790..498565057f 100644 --- a/lib/ssh/doc/src/ssh_app.xml +++ b/lib/ssh/doc/src/ssh_app.xml @@ -18,78 +18,98 @@ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - SSH + + + + + ssh_app.xml SSH - The ssh application implements the SSH (Secure Shell) protocol and - provides an SFTP (SSH File Transfer Protocol) client and server. + 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.

+ -
+
DEPENDENCIES -

The ssh application uses the Erlang applications public_key and - crypto to handle public keys and encryption, hence these - applications needs to be loaded for the ssh application to work. In - an embedded environment that means they need to be started with - application:start/[1,2] before the ssh application is started. +

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 currently have an application - specific configuration file as described in application(3), - however it will by default use the following configuration files - from openssh: known_hosts, authorized_keys, authorized_keys2, - id_dsa and id_rsa, ssh_host_dsa_key and ssh_host_rsa_key. By - default Erlang SSH will look for id_dsa, id_rsa, known_hosts - and authorized_keys in ~/.ssh, and the host key files in /etc/ssh - . These locations may be changed by the options user_dir and - system_dir. Public key handling may also be customized by - providing a callback module implementing the behaviors - ssh_client_key_api and - ssh_server_key_api. -

+

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 + ssh_host_dsa_key + ssh_host_rsa_key + +

By default, ssh looks for id_dsa, id_rsa, + 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 and id_rsa are the users private key files, note that - the public key is part of the private key so the ssh - application will not use the id_<*>.pub files. These are - for the users convenience when he/she needs to convey their +

+
+ Public Keys +

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

-
- -
- KNOW HOSTS -

The known_hosts file contains a list of approved servers and - their public keys. Once a server is listed, it can be verified +

+
+ 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 +

+
+ 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. + log in without entering their password, which is supported by the + Erlang ssh daemon.

-
- -
- HOST KEYS -

Currently rsa and dsa host keys are supported and are - expected to be found in files named ssh_host_rsa_key and - ssh_host_dsa_key. +

+
+ Host Keys +

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

-
+
+
+ ERROR LOGGER AND EVENT HANDLERS +

The ssh application has no error logger or event handlers.

-- cgit v1.2.3