Name
ssh - OpenSSH SSH client (remote login program)
The OpenSSH SSH client supports SSH protocols 1 and 2. Protocol 2 is the default, with ssh falling back to protocol 1 if it detects protocol 2 is unsupported. These settings may be altered using the Protocol option in sshconfig(5), or enforced using the -1 and -2 options (see above). For Windows OpenSSH, the only available authentication methods are 'password' and 'publickey'. The default is '.ssh/authorizedkeys.ssh/authorizedkeys2'. If the path is not absolute, it is taken relative to user's home directory (or profile image path). The fine-tuning is done by editing /etc/ssh/sshdconfig. Any line starting with '#' will be ignored by sshd. UseDNS no # By setting this to no, connection speed can increase. PasswordAuthentication no # Do not allow password authentication. Other configuration options are shown in /etc/ssh/sshdconfig. The file includes comments that explain.
Synopsis
ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-bbind_address] [-ccipher_spec] [
Description
ssh (SSH client) is a program for logging into a remote machine and for executing commands on a remote machine. It is intended to replace rlogin andrsh, and provide secure encrypted communications between two untrusted hosts over an insecure network. X11 connections and arbitrary TCP ports can also beforwarded over the secure channel.
ssh connects and logs into the specified hostname (with optional user name). The user must prove his/her identity to the remote machineusing one of several methods depending on the protocol version used (see below).
If command is specified, it is executed on the remote host instead of a login shell.
The options are as follows:
-2' Forces ssh to try protocol version 2 only.-4' Forces ssh to use IPv4 addresses only.
-6' Forces ssh to use IPv6 addresses only.
-A' Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file.
Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's Unix-domain socket)can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on thekeys that enable them to authenticate using the identities loaded into the agent.
-a' Disables forwarding of the authentication agent connection.
-bbind_address
Use bind_address on the local machine as the source address of the connection. Only useful on systems with more than one address.
-C' Requests compression of all data (including stdin, stdout, stderr, and data for forwarded X11 and TCP connections). The compression algorithm isthe same used by gzip(1), and the 'level' can be controlled by the CompressionLevel option for protocol version 1. Compression is desirable on modemlines and other slow connections, but will only slow down things on fast networks. The default value can be set on a host-by-host basis in the configurationfiles; see the Compression option.
-ccipher_spec
Selects the cipher specification for encrypting the session.
Protocol version 1 allows specification of a single cipher. The supported values are '3des', 'blowfish', and 'des'. 3des (triple-des) is anencrypt-decrypt-encrypt triple with three different keys. It is believed to be secure. blowfish is a fast block cipher; it appears very secure and ismuch faster than 3des. des is only supported in the ssh client for interoperability with legacy protocol 1 implementations that do notsupport the 3des cipher. Its use is strongly discouraged due to cryptographic weaknesses. The default is '3des'.
For protocol version 2, cipher_spec is a comma-separated list of ciphers listed in order of preference. See the Ciphers keyword for moreinformation.
-D
[
bind_address:]port
Specifies a local 'dynamic' application-level port forwarding. This works by allocating a socket to listen to port on the local side, optionally boundto the specified bind_address. Whenever a connection is made to this port, the connection is forwarded over the secure channel, and the applicationprotocol is then used to determine where to connect to from the remote machine. Currently the SOCKS4 and SOCKS5 protocols are supported, and ssh willact as a SOCKS server. Only root can forward privileged ports. Dynamic port forwardings can also be specified in the configuration file.
IPv6 addresses can be specified with an alternative syntax:
[bind_address/]port or by enclosing the address in square brackets. Only the superuser can forward privileged ports. By default, the local portis bound in accordance with the GatewayPorts setting. However, an explicit bind_address may be used to bind the connection to a specific address.The bind_address of 'localhost' indicates that the listening port be bound for local use only, while an empty address or '*' indicates that the portshould be available from all interfaces.
-eescape_char
Sets the escape character for sessions with a pty (default: '~'). The escape character is only recognized at the beginning of a line. The escape characterfollowed by a dot ('.') closes the connection; followed by control-Z suspends the connection; and followed by itself sends the escape character once. Settingthe character to 'none' disables any escapes and makes the session fully transparent.
-Fconfigfile
Specifies an alternative per-user configuration file. If a configuration file is given on the command line, the system-wide configuration file(/etc/ssh/ssh_config) will be ignored. The default for the per-user configuration file is ~/.ssh/config.
-f' Requests ssh to go to background just before command execution. This is useful if ssh is going to ask for passwords or passphrases,but the user wants it in the background. This implies -n. The recommended way to start X11 programs at a remote site is with something like ssh -fhost xterm.
If the ExitOnForwardFailure configuration option is set to 'yes', then a client started with -f will wait for all remote port forwards to besuccessfully established before placing itself in the background.
-g' Allows remote hosts to connect to local forwarded ports.
-Ismartcard_device
Specify the device ssh should use to communicate with a smartcard used for storing the user's private RSA key. This option is only available if supportfor smartcard devices is compiled in (default is no support).
-iidentity_file
Selects a file from which the identity (private key) for RSA or DSA authentication is read. The default is ~/.ssh/identity for protocol version 1, and~/.ssh/id_rsa and ~/.ssh/id_dsa for protocol version 2. Identity files may also be specified on a per-host basis in the configuration file. It ispossible to have multiple -i options (and multiple identities specified in configuration files).
-K' Enables GSSAPI-based authentication and forwarding (delegation) of GSSAPI credentials to the server.
-k' Disables forwarding (delegation) of GSSAPI credentials to the server.
-L
[
bind_address:]port:host:hostport
Specifies that the given port on the local (client) host is to be forwarded to the given host and port on the remote side. This works by allocating a socket tolisten to port on the local side, optionally bound to the specified bind_address. Whenever a connection is made to this port, the connection isforwarded over the secure channel, and a connection is made to host port hostport from the remote machine. Port forwardings can also be specifiedin the configuration file. IPv6 addresses can be specified with an alternative syntax:
[bind_address/]port/host/hostport or by enclosing the address in square brackets. Only the superuser can forward privileged ports.By default, the local port is bound in accordance with the GatewayPorts setting. However, an explicit bind_address may be used to bind theconnection to a specific address. The bind_address of 'localhost' indicates that the listening port be bound for local use only, while an emptyaddress or '*' indicates that the port should be available from all interfaces.
-llogin_name
Specifies the user to log in as on the remote machine. This also may be specified on a per-host basis in the configuration file.
-M' Places the ssh client into 'master' mode for connection sharing. Multiple -M options places ssh into 'master' mode withconfirmation required before slave connections are accepted. Refer to the description of ControlMaster in ssh_config(5) for details.
-mmac_spec
Additionally, for protocol version 2 a comma-separated list of MAC (message authentication code) algorithms can be specified in order of preference. See theMACs keyword for more information.
-N' Do not execute a remote command. This is useful for just forwarding ports (protocol version 2 only).
-n' Redirects stdin from /dev/null (actually, prevents reading from stdin). This must be used when ssh is run in the background. Acommon trick is to use this to run X11 programs on a remote machine. For example, ssh -n shadows.cs.hut.fi emacs & will start an emacs onshadows.cs.hut.fi, and the X11 connection will be automatically forwarded over an encrypted channel. The ssh program will be put in the background.(This does not work if ssh needs to ask for a password or passphrase; see also the -f option.)
-Octl_cmd
Control an active connection multiplexing master process. When the -O option is specified, the ctl_cmd argument is interpreted and passed to themaster process. Valid commands are: 'check' (check that the master process is running) and 'exit' (request the master to exit).
-ooption
Can be used to give options in the format used in the configuration file. This is useful for specifying options for which there is no separate command-lineflag. For full details of the options listed below, and their possible values, see ssh_config(5).
AddressFamily
BatchMode
BindAddress
ChallengeResponseAuthentication
CheckHostIP
Cipher
Ciphers
ClearAllForwardings
Compression
CompressionLevel
ConnectionAttempts
ConnectTimeout
ControlMaster
ControlPath
DynamicForward
EscapeChar
ExitOnForwardFailure
ForwardAgent
ForwardX11
ForwardX11Trusted
GatewayPorts
GlobalKnownHostsFile
GSSAPIAuthentication
GSSAPIDelegateCredentials
HashKnownHosts
Host'
HostbasedAuthentication
HostKeyAlgorithms
HostKeyAlias
HostName
IdentityFile
IdentitiesOnly
KbdInteractiveDevices
LocalCommand
LocalForward
LogLevel
MACs'
NoHostAuthenticationForLocalhost
NumberOfPasswordPrompts
PasswordAuthentication
PermitLocalCommand
Port'
PreferredAuthentications
Protocol
ProxyCommand
PubkeyAuthentication
RekeyLimit
RemoteForward
RhostsRSAAuthentication
RSAAuthentication
SendEnv
ServerAliveInterval
ServerAliveCountMax
SmartcardDevice
StrictHostKeyChecking
TCPKeepAlive
Tunnel
TunnelDevice
UsePrivilegedPort
User'
UserKnownHostsFile
VerifyHostKeyDNS
VisualHostKey
XAuthLocation
-pport
Port to connect to on the remote host. This can be specified on a per-host basis in the configuration file.
-q' Quiet mode. Causes most warning and diagnostic messages to be suppressed.
-R
[
bind_address:]port:host:hostport
Specifies that the given port on the remote (server) host is to be forwarded to the given host and port on the local side. This works by allocating a socket tolisten to port on the remote side, and whenever a connection is made to this port, the connection is forwarded over the secure channel, and a connectionis made to host port hostport from the local machine.
Port forwardings can also be specified in the configuration file. Privileged ports can be forwarded only when logging in as root on the remote machine. IPv6addresses can be specified by enclosing the address in square braces or using an alternative syntax:
[bind_address/]host/port/hostport.
By default, the listening socket on the server will be bound to the loopback interface only. This may be overridden by specifying a bind_address. Anempty bind_address, or the address '*', indicates that the remote socket should listen on all interfaces. Specifying a remote bind_address willonly succeed if the server's GatewayPorts option is enabled (see sshd_config(5)).
If the port argument is '0', the listen port will be dynamically allocated on the server and reported to the client at run time.
-Sctl_path
Specifies the location of a control socket for connection sharing. Refer to the description of ControlPath and ControlMaster in ssh_config(5) fordetails.
-s' May be used to request invocation of a subsystem on the remote system. Subsystems are a feature of the SSH2 protocol which facilitate the use ofSSH as a secure transport for other applications (eg. sftp(1)). The subsystem is specified as the remote command.
-T' Disable pseudo-tty allocation.
-t' Force pseudo-tty allocation. This can be used to execute arbitrary screen-based programs on a remote machine, which can be very useful, e.g. whenimplementing menu services. Multiple -t options force tty allocation, even if ssh has no local tty.
-V' Display the version number and exit.
-v' Verbose mode. Causes ssh to print debugging messages about its progress. This is helpful in debugging connection, authentication, andconfiguration problems. Multiple -v options increase the verbosity. The maximum is 3.
-Whost:port
Requests that standard input and output on the client be forwarded to host on port over the secure channel. Implies -N, -T,ExitOnForwardFailure and ClearAllForwardings and works with Protocol version 2 only.
-w
local_tun[:remote_tun]
Requests tunnel device forwarding with the specified tun(4) devices between the client (local_tun) and the server (remote_tun).
The devices may be specified by numerical ID or the keyword 'any', which uses the next available tunnel device. If remote_tun is not specified, itdefaults to 'any'. See also the Tunnel and TunnelDevice directives in ssh_config(5). If the Tunnel directive is unset, it is set to thedefault tunnel mode, which is 'point-to-point'.
-X' Enables X11 forwarding. This can also be specified on a per-host basis in a configuration file.
X11 forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the user's X authorizationdatabase) can access the local X11 display through the forwarded connection. An attacker may then be able to perform activities such as keystroke monitoring.
For this reason, X11 forwarding is subjected to X11 SECURITY extension restrictions by default. Please refer to the ssh -Y option and theForwardX11Trusted directive in ssh_config(5) for more information.
-x' Disables X11 forwarding.
-Y' Enables trusted X11 forwarding. Trusted X11 forwardings are not subjected to the X11 SECURITY extension controls.
-y' Send log information using the syslog(3) system module. By default this information is sent to stderr.
ssh may additionally obtain configuration data from a per-user configuration file and a system-wide configuration file. The file format andconfiguration options are described in ssh_config(5).
ssh exits with the exit status of the remote command or with 255 if an error occurred.
Authentication
The OpenSSH SSH client supports SSH protocols 1 and 2. Protocol 2 is the default, with ssh falling back to protocol 1 if it detects protocol 2 isunsupported. These settings may be altered using the Protocol option in ssh_config(5), or enforced using the -1 and -2 options (seeabove). Both protocols support similar authentication methods, but protocol 2 is preferred since it provides additional mechanisms for confidentiality (thetraffic is encrypted using AES, 3DES, Blowfish, CAST128, or Arcfour) and integrity (hmac-md5, hmac-sha1, umac-64, hmac-ripemd160). Protocol 1 lacks a strongmechanism for ensuring the integrity of the connection.
The methods available for authentication are: GSSAPI-based authentication, host-based authentication, public key authentication, challenge-responseauthentication, and password authentication. Authentication methods are tried in the order specified above, though protocol 2 has a configuration option tochange the default order: PreferredAuthentications.
Host-based authentication works as follows: If the machine the user logs in from is listed in /etc/hosts.equiv or /etc/ssh/shosts.equiv on theremote machine, and the user names are the same on both sides, or if the files ~/.rhosts or ~/.shosts exist in the user's home directory on theremote machine and contain a line containing the name of the client machine and the name of the user on that machine, the user is considered for login.Additionally, the server must be able to verify the client's host key (see the description of /etc/ssh/ssh_known_hosts and~/.ssh/known_hosts, below) for login to be permitted. This authentication method closes security holes due to IP spoofing, DNS spoofing, and routingspoofing. [Note to the administrator: /etc/hosts.equiv, ~/.rhosts, and the rlogin/rsh protocol in general, are inherently insecure and should bedisabled if security is desired.]
Public key authentication works as follows: The scheme is based on public-key cryptography, using cryptosystems where encryption and decryption are doneusing separate keys, and it is unfeasible to derive the decryption key from the encryption key. The idea is that each user creates a public/private key pairfor authentication purposes. The server knows the public key, and only the user knows the private key. ssh implements public key authentication protocolautomatically, using either the RSA or DSA algorithms. Protocol 1 is restricted to using only RSA keys, but protocol 2 may use either. The HISTORYsection of ssl(8) contains a brief discussion of the two algorithms.
The file ~/.ssh/authorized_keys lists the public keys that are permitted for logging in. When the user logs in, the ssh program tells theserver which key pair it would like to use for authentication. The client proves that it has access to the private key and the server checks that thecorresponding public key is authorized to accept the account.
The user creates his/her key pair by running ssh-keygen(1). This stores the private key in ~/.ssh/identity (protocol 1), ~/.ssh/id_dsa(protocol 2 DSA), or ~/.ssh/id_rsa (protocol 2 RSA) and stores the public key in ~/.ssh/identity.pub (protocol 1), ~/.ssh/id_dsa.pub(protocol 2 DSA), or ~/.ssh/id_rsa.pub (protocol 2 RSA) in the user's home directory. The user should then copy the public key to~/.ssh/authorized_keys in his/her home directory on the remote machine. The authorized_keys file corresponds to the conventional ~/.rhostsfile, and has one key per line, though the lines can be very long. After this, the user can log in without giving the password.
The most convenient way to use public key authentication may be with an authentication agent. See ssh-agent(1) for more information.
Challenge-response authentication works as follows: The server sends an arbitrary 'challenge' text, and prompts for a response. Protocol 2 allows multiplechallenges and responses; protocol 1 is restricted to just one challenge/response. Examples of challenge-response authentication include BSD Authentication(see login.conf(5)) and PAM (some non-OpenBSD systems).
Finally, if other authentication methods fail, ssh prompts the user for a password. The password is sent to the remote host for checking; however,since all communications are encrypted, the password cannot be seen by someone listening on the network.
ssh automatically maintains and checks a database containing identification for all hosts it has ever been used with. Host keys are stored in~/.ssh/known_hosts in the user's home directory. Additionally, the file /etc/ssh/ssh_known_hosts is automatically checked for known hosts. Anynew hosts are automatically added to the user's file. If a host's identification ever changes, ssh warns about this and disables password authenticationto prevent server spoofing or man-in-the-middle attacks, which could otherwise be used to circumvent the encryption. The StrictHostKeyChecking optioncan be used to control logins to machines whose host key is not known or has changed.
When the user's identity has been accepted by the server, the server either executes the given command, or logs into the machine and gives the user a normalshell on the remote machine. All communication with the remote command or shell will be automatically encrypted.
If a pseudo-terminal has been allocated (normal login session), the user may use the escape characters noted below.
If no pseudo-tty has been allocated, the session is transparent and can be used to reliably transfer binary data. On most systems, setting the escapecharacter to 'none' will also make the session transparent even if a tty is used.
The session terminates when the command or shell on the remote machine exits and all X11 and TCP connections have been closed.
Escape Characters
When a pseudo-terminal has been requested, ssh supports a number of functions through the use of an escape character.
A single tilde character can be sent as ~~ or by following the tilde by a character other than those described below. The escape character mustalways follow a newline to be interpreted as special. The escape character can be changed in configuration files using the EscapeChar configurationdirective or on the command line by the -e option.
The supported escapes (assuming the default '~') are:
~^Z' Background ssh.~#' List forwarded connections.
~&' Background ssh at logout when waiting for forwarded connection / X11 sessions to terminate.
~?' Display a list of escape characters.
~B' Send a BREAK to the remote system (only useful for SSH protocol version 2 and if the peer supports it).
~C' Open command line. Currently this allows the addition of port forwardings using the -L, -R and -D options (see above). Italso allows the cancellation of existing remote port-forwardings using -KR[
bind_address:]port. !command allows the user to execute a local command if the PermitLocalCommand option is enabled inssh_config(5). Basic help is available, using the -h option.
~R' Request rekeying of the connection (only useful for SSH protocol version 2 and if the peer supports it).
Tcp Forwarding
Forwarding of arbitrary TCP connections over the secure channel can be specified either on the command line or in a configuration file. One possibleapplication of TCP forwarding is a secure connection to a mail server; another is going through firewalls.
In the example below, we look at encrypting communication between an IRC client and server, even though the IRC server does not directly support encryptedcommunications. This works as follows: the user connects to the remote host using ssh, specifying a port to be used to forward connections to the remoteserver. After that it is possible to start the service which is to be encrypted on the client machine, connecting to the same local port, and ssh willencrypt and forward the connection.
The following example tunnels an IRC session from client machine '127.0.0.1' (localhost) to remote server 'server.example.com':This tunnels a connection to IRC server 'server.example.com', joining channel '#users', nickname 'pinky', using port 1234. It doesn't matter whichport is used, as long as it's greater than 1023 (remember, only root can open sockets on privileged ports) and doesn't conflict with any ports already in use.The connection is forwarded to port 6667 on the remote server, since that's the standard port for IRC services.
The -f option backgrounds ssh and the remote command 'sleep 10' is specified to allow an amount of time (10 seconds, in the example) tostart the service which is to be tunnelled. If no connections are made within the time specified, ssh will exit.
X11 FORWARDING
If the ForwardX11 variable is set to 'yes' (or see the description of the -X, -x, and -Y options above) and the user is usingX11 (the DISPLAY environment variable is set), the connection to the X11 display is automatically forwarded to the remote side in such a way that any X11programs started from the shell (or command) will go through the encrypted channel, and the connection to the real X server will be made from the localmachine. The user should not manually set DISPLAY. Forwarding of X11 connections can be configured on the command line or in configuration files.
The DISPLAY value set by ssh will point to the server machine, but with a display number greater than zero. This is normal, and happens becausessh creates a 'proxy' X server on the server machine for forwarding the connections over the encrypted channel.
ssh will also automatically set up Xauthority data on the server machine. For this purpose, it will generate a random authorization cookie, store itin Xauthority on the server, and verify that any forwarded connections carry this cookie and replace it by the real cookie when the connection is opened. Thereal authentication cookie is never sent to the server machine (and no cookies are sent in the plain).
If the ForwardAgent variable is set to 'yes' (or see the description of the -A and -a options above) and the user is using anauthentication agent, the connection to the agent is automatically forwarded to the remote side.
Verifying Host Keys
When connecting to a server for the first time, a fingerprint of the server's public key is presented to the user (unless the optionStrictHostKeyChecking has been disabled). Fingerprints can be determined using ssh-keygen(1):
- Work with built-in tools (no need for Putty or others)
- Remote commands can be executed, i.e. you can open several tunnels after another for which otherwise you might need to open several instances of your remote connection program (like Putty)
- With the right configuration, you just need to type “ssh *myserver*” and OpenSSH does the rest – minimum interaction needed
- Dynamic port forwarding allows local applications to access otherwise inaccessible remote content without the need for reconfiguration (as long as you make sure they can handle SOCKS)
To get a listing of the fingerprints along with their random art for all known hosts, the following command line can be used:
- PermitRootLogin is set to'forced-commands-only':Since an SSH-based setup entails a fair amount of overhead, it may be more suited to temporary setups, such as for wireless VPNs. More permanent VPNs arebetter provided by tools such as ipsecctl(8) and isakmpd(8).
Environment
ssh will normally set the following environment variables:HOME' Set to the path of the user's home directory.
LOGNAME' Synonym for USER; set for compatibility with systems that use this variable.
MAIL' Set to the path of the user's mailbox.
PATH' Set to the default PATH, as specified when compiling ssh.
SSH_ASKPASS' If ssh needs a passphrase, it will read the passphrase from the current terminal if it was run from a terminal. If ssh does nothave a terminal associated with it but DISPLAY and SSH_ASKPASS are set, it will execute the program specified by SSH_ASKPASS and open an X11 window to read thepassphrase. This is particularly useful when calling ssh from a .xsession or related script. (Note that on some machines it may be necessary toredirect the input from /dev/null to make this work.)
SSH_AUTH_SOCK' Identifies the path of a UNIX-domain socket used to communicate with the agent.
SSH_CONNECTION' Identifies the client and server ends of the connection. The variable contains four space-separated values: client IP address, client portnumber, server IP address, and server port number.
SSH_ORIGINAL_COMMAND
This variable contains the original command line if a forced command is executed. It can be used to extract the original arguments.
SSH_TTY' This is set to the name of the tty (path to the device) associated with the current shell or command. If the current session has no tty, thisvariable is not set.
TZ' This variable is set to indicate the present time zone if it was set when the daemon was started (i.e. the daemon passes the value on to newconnections).
USER' Set to the name of the user logging in.
Additionally, ssh reads ~/.ssh/environment, and adds lines of the format 'VARNAME=value' to the environment if the file exists and users areallowed to change their environment. For more information, see the PermitUserEnvironment option in sshd_config(5).
Environment
The reseeding of the OpenSSL random generator is usually done from /dev/urandom. If the SSH_USE_STRONG_RNG environment variable is set tovalue other than 0 the OpenSSL random generator is reseeded from /dev/random. The number of bytes read is defined by the SSH_USE_STRONG_RNGvalue. Minimum is 6 bytes. This setting is not recommended on the computers without the hardware random generator because insufficient entropy causes theconnection to be blocked until enough entropy is available.Files
This file is used for host-based authentication (see above). On some machines this file may need to be world-readable if the user's home directory is on anNFS partition, because sshd(8) reads it as root. Additionally, this file must be owned by the user, and must not have write permissions for anyone else. Therecommended permission for most machines is read/write for the user, and not accessible by others.~/.shosts
This file is used in exactly the same way as .rhosts, but allows host-based authentication without permitting login with rlogin/rsh.
~/.ssh/
This directory is the default location for all user-specific configuration and authentication information. There is no general requirement to keep the entirecontents of this directory secret, but the recommended permissions are read/write/execute for the user, and not accessible by others.
~/.ssh/authorized_keys
Lists the public keys (RSA/DSA) that can be used for logging in as this user. The format of this file is described in the sshd(8) manual page. This file is nothighly sensitive, but the recommended permissions are read/write for the user, and not accessible by others.
~/.ssh/config
This is the per-user configuration file. The file format and configuration options are described in ssh_config(5). Because of the potential for abuse, thisfile must have strict permissions: read/write for the user, and not accessible by others.
~/.ssh/environment
Contains additional definitions for environment variables; see ENVIRONMENT, above.
~/.ssh/identity
~/.ssh/id_dsa
~/.ssh/id_rsa
Contains the private key for authentication. These files contain sensitive data and should be readable by the user but not accessible by others(read/write/execute). ssh will simply ignore a private key file if it is accessible by others. It is possible to specify a passphrase when generatingthe key which will be used to encrypt the sensitive part of this file using 3DES.
~/.ssh/identity.pub
~/.ssh/id_dsa.pub
~/.ssh/id_rsa.pub
Contains the public key for authentication. These files are not sensitive and can (but need not) be readable by anyone.
~/.ssh/known_hosts
Contains a list of host keys for all hosts the user has logged into that are not already in the systemwide list of known host keys. See sshd(8) for furtherdetails of the format of this file.
~/.ssh/rc
Commands in this file are executed by ssh when the user logs in, just before the user's shell (or command) is started. See the sshd(8) manual page formore information.
/etc/hosts.equiv
This file is for host-based authentication (see above). It should only be writable by root.
/etc/ssh/shosts.equiv
This file is used in exactly the same way as hosts.equiv, but allows host-based authentication without permitting login with rlogin/rsh.
/etc/ssh/ssh_config
Systemwide configuration file. The file format and configuration options are described in ssh_config(5).
/etc/ssh/ssh_host_key
/etc/ssh/ssh_host_dsa_key
/etc/ssh/ssh_host_rsa_key
These three files contain the private parts of the host keys and are used for host-based authentication. If protocol version 1 is used, ssh must besetuid root, since the host key is readable only by root. For protocol version 2, ssh uses ssh-keysign(8) to access the host keys, eliminating therequirement that ssh be setuid root when host-based authentication is used. By default ssh is not setuid root.
/etc/ssh/ssh_known_hosts
Systemwide list of known host keys. This file should be prepared by the system administrator to contain the public host keys of all machines in theorganization. It should be world-readable. See sshd(8) for further details of the format of this file.
/etc/ssh/sshrc
Commands in this file are executed by ssh when the user logs in, just before the user's shell (or command) is started. See the sshd(8) manual page formore information.
IPV6
IPv6 address can be used everywhere where IPv4 address. In all entries must be the IPv6 address enclosed in square brackets. Note: The square brackets aremetacharacters for the shell and must be escaped in shell.
See Also
scp(1), sftp(1), ssh-add(1), ssh-agent(1), ssh-keygen(1), ssh-keyscan(1), tun(4), hosts.equiv(5), ssh_config(5), ssh-keysign(8), sshd(8)
Authors
OpenSSH is a derivative of the original and free ssh 1.2.12 release by Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo de Raadt andDug Song removed many bugs, re-added newer features and created OpenSSH. Markus Friedl contributed the support for SSH protocol versions 1.5 and 2.0.
BSD April 14, 2013 BSD
Referenced By
autossh(1),bvnc(1),byobu-launcher-install(1),byobu-launcher-uninstall(1),cdrecord(1),ckeygen(1),clogin(1),cloginrc(5),conch(1),cpdup(1),darcs(1),distcc(1),distccd(1),dsync(1),fetchmail(1),forward(1),gsh(1),gsissh-keygen(1),gsissh-keysign(8),gsissh_config(5),gsisshd(8),gsisshd_config(5),hb_report(8),isoinfo(1),isoinfo(8),kup(1),ldm(1),lsyncd(1),mirrordir(1),mkxauth(1),mussh(1),muttrc(5),nc(1),openvpn(8),pdcp(1),pdsh(1),pssh(1),pty(7),qodem(1),rancid.conf(5),rdiff-backup(1),rdist(1),readcd(1),readom(1),recon(1),router.db(5),rsnapshotSsh Config Settings
(1),rssh(1),rssh.conf(5),safekeep(1),scponly(8),secure-mcserv(1),sftp-server(8),shmux(1),ssh-copy-id(1),sshfp(1),sshuttle(8),sss_ssh_knownhostsproxy(1),star(1),sudoers(5),tentakel(1),tkconch(1),tmux(1),wodim(1),x11vnc(1),xlock(1),zfs(8),ztelnet(1)Windows 10 has a very useful implementation of OpenSSH to build up secure tunnels to remote systems. Compared to a tool like Putty, using the “ssh” command has some advantages, for example:
One thing that still requires interaction is when ssh asks you to enter the password for your private key. Even if you built up a neat SSH config as I will explain later, the ssh client will still ask you for a password for every single connection if your private key is password protected (what it hopefully is):
I will show you how you can store your private key in the OpenSSH Authentication Agent, so that you will not need to enter the password each time you build up an SSH tunnel. We will also briefly talk about agent forwarding, so that even on remote machines no password will be needed. But first let’s talk about the general SSH configuration. But first let’s see what is possible with the current implementation of OpenSSH in Windows 10 – and what not.
Setting up your SSH config
The example above assumes that you created the folder C:Users*YourUser*.ssh and a file “config” that contains something like the following code:
If you want, you can use port forwarding so that you can work from your local workstation with the remote system:
This means, that if you browse to http://localhost:9999 on your local system, you can see data that the remote webserver is theoretically only providing locally for its own localhost. Of course, local and remote port which are both 9999 in the current example can be different. You can also forward multiple ports. If you have a proxy server running your remote host, you could forward that port and set up proxy-aware applications (for example your web browser) to use that proxy on that port.
ProxyJump – Currently not working
As mentioned in the list of advantages above, you can even execute a remote command after you established the tunnel, for example to built up another tunnel from the remote system to yet another system. OpenSSH therefore distinguishes between to methods: ProxyJump and ProxyCommand. If you simply want to jump from the first remote host to another remote host – which is most likely the case if your final system is only reachable via an intermediate bastion host – you could use ProxyJump. Unfortunately, as of now due to a bug in the Windows implementation of OpenSSH, this does not work. It apparently will be fixed in July 2020:
As soon as it will work you should be able to get it working even without a config file, by using the parameter “-J” instead:
This should log you in with “YourProxyUser” on IP.Of.Your.Proxy and from there you will be logged in to IP.Of.Your.Server with “YourTargetSystemUser”. Obviously, IP.Of.Your.Server needs to be reachable from the proxy/bastion. If DNS is working, you can of course also use a hostname instead of an IP address.
ProxyCommand – The flexible alternative
While ProxyJump is not working and as a more flexible alternative, you can also execute any command of your choice on the proxy using “ProxyCommand”. If you are working without a config file, you can use the parameter “-O” for ProxyCommand:
Note that you cannot use ProxyCommand and ProxyJump in the same host configuration. For ProxyCommand, you can use some wildcards, as the manpage explains:
‘%h’ will be substituted by the host name to connect, ‘%p’ by the port, and ‘%r’ by the remote user name. The command can be basically anything, and should read from its standard input and write to its standard output. It should eventually connect an sshd server running on some machine, or execute sshd -i somewhere.
Actually, ProxyJump seems to be just a “shortcut” to use ProxyCommand: If you do use ProxyJump and set ssh to verbose output, you can see how it translates ProxyJump to ProxyCommand:
Here you can also see the reason why it is not working – it is translated to “ssh”, but in current implementations of OpenSSH in Windows you need to indicate the full extension, i.e. “ProxyCommand ssh.exe”. This is still better than having to indicate the full path as it was required before due to another bug. So, let’s hope this will be fixed soon – or if it bugs you (haha), you can fix it manually.
Of course, you can also execute any other command apart from ssh, for example netcat, but also something like corkscrew to tunnel SSH through http proxies. If you want to learn more about the many things you can do with it, there are excellent tutorials on what is possible with ProxyCommand.
The important parameter for ProxyCommand is “-W”, which the manpage (for Linux) explains as follows:
-Whost:port
Requests that standard input and output on the client be forwarded to host on port over the secure channel. Implies -N, -T, ExitOnForwardFailure and ClearAllForwardings and works with Protocol version 2 only.
We will have another look on how this works in the next section.
Chained Configurations
You can “cross-reference” within your SSH config. So let’s assume you have something like the following setup:
Now type:
What will happen is that your local ssh client will take the “MyServer” configuration and see the line “ProxyCommand”. This tells the client that prior to executing the connection described in “MyServer”, it first will have to execute a command on an intermediary.
In the example above we are telling ssh that when it establishes a connection to IP.Of.Your.Server, it shall first run SSH on our local Windows 10 system, using the connection information provided in “Bastion”.
What I would like to note is that you can chain multiple times, but in practice I realized that things can easily break then. For work I’m using a fourfold jump, i.e. from my workstations over server 1, server 2, server 3 to server 4. This does work, but when I then try to use a service on server 3 – where port forwarding should allow me to do it – sometimes the connection cannot be established. An easy workaround is to build up a second connection that only jumps up to server 3 and ends there.
You can get a better understanding on how chaining works when you run ssh in verbose mode, i.e.:
You will then see the line:
This means, on that local Windows 10, it shall take the connection information from “Bastion” (%h = host “IP.Of.Your.Server”, %p = port “22”). Afterwards, it will forward the “MyServer” configuration over the standard input/output on the bastion host.
Default Settings
One last remark on the SSH config file: If you call your host “*”, all settings written there will be used as default, but can be overwritten in the specific host definitions. You can write the host definitions before or after the “*” host and in any order.
There are other websites that explain all options that you can in the config file.
SSH Agent: Storing your key’s password
Normally, if you open a new ssh session, you will have to enter your private key’s password every single time. There are however ways how to prevent this. Obviously, you will need to decide by yourself if the gain in convenience is worth it to store your decrypted private key temporarily on your system, which theoretically can be accessed by malware.
Usually, other programs should not be able to access memory space of your ssh instance where you enter your password and where your private key is then decrypted. However, as soon as this instance ends (for example because you end the remote session), memory is freed up and your temporarily stored password-unprotected private key is gone. To make things a bit more persistent, a so-called ssh agent can run as a service and keep your password so that instances of ssh can ask the service for the required password. If you know Putty, you might already have worked with its ssh agent called “Pageant“. Obviously, it is not guaranteed that malicious software does not use the ssh agent’s services, hence you should have some trust in your system’s security posture. You should also not use this technique if somebody else with admin rights is working on your system, because they can read your key then.
The advantage of working with an ssh-agent is that you only will have to enter your private key’s password once and the service will keep it.
If you do want to use this convenient service, first you need to make sure that the authentication service is actually running: Press Win-R, type services.msc and look for “Open SSH Authentication Agent”. Make sure that the Startup type is on “Automatic”, and also don’t forget to start the service with “Start” if it was not running before. Then press OK to save the changes and close the window:
If you saved your private key with default path and name under *YourUserDirectory*.sshrsa_id, you will not even have to provide any key name and just type:
If your key is named differently, type:
Now, you can simply add your private key, enter your password once and it will be stored for the duration of your Windows session. If for security reasons you only want to keep the key in the agent for a certain time, you can indicate the lifetime with the -t parameter, e.g. one hour would be:
To verify which keys are currently stored in your agent, type:
This will return all keys that are currently held in memory for you by the agent. Oh, and if you created your key pair with Puttygen and therefore have to convert them to the OpenSSH format, just check out StackExchange.
Also here a quick note: For some reason, sessions sometimes seem to struggle to access the key from the agent and you will still have to enter your key manually again. Still figuring out what is the reason behind this…
Agent Forwarding: No password prompt anymore
The ssh agent ensures that for any further connection from your system to a remote system you will not need to enter your private key’s password anymore for the duration of the session. However, if you connect from your first remote system to another remote system and that system is asking for your private key as well, you will have to enter the password once more. Of course, you could store your private key on the first remote system and use an ssh agent there as well, but you should never copy your private key to any other system than your own. Moreover, your password for the private key would be readable on the remote machine if you typed it in there (it’s going through the SSH tunnel to the remote machine with encryption, but then goes out there to the standard output in unencrypted form).
SSH also has a solution for this: Agent forwarding allows remote systems to simply forward their key challenge to your local system – this even works across multiple hops and neither your private key, nor your password is ever transmitted. Nevertheless, only use agent forwarding with remote system you trust. Especially in enterprise environments, this option will often be disabled.
Ssh Config Set Password
Note: I did not have a chance so far to try this out on Windows 10, so below is a description how it should work if OpenSSH is properly implemented.
To use agent forwarding, you have two possibilities: You can extend your SSH config (see above) with the following line:
Some implementations of OpenSSH also allow to indicate forwarding as parameter, so when opening a connection – without the need for any config – you would simply type:
For some reason, the CLI parameter -A does not seem to be implemented for the Windows agent, though. You should also make sure that agent forwarding is actually supported and allowed by your target system. In the server config it needs to have this line:
Ubuntu Enable Ssh Password Authentication
Further Reading
If you are not yet aware of them anyway, I recommend you to learn about the very useful possibilities that dynamic port forwarding brings.
I also recommend this site for an excellent overview on how key challenges – with and without agent forwarding work and another site for top 5 security recommendations.
PAM solutions might grant access to servers only temporarily and on-demand, which is an interesting concept that avoids to have orphaned keys lying around in the trusted keys folder.