2 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
3 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 .\" All rights reserved
6 .\" As far as I am concerned, the code I have written for this software
7 .\" can be used freely for any purpose. Any derived versions of this
8 .\" software must be clearly marked as such, and if the derived work is
9 .\" incompatible with the protocol description in the RFC file, it must be
10 .\" called by a name other than "ssh" or "Secure Shell".
12 .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
13 .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
14 .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
16 .\" Redistribution and use in source and binary forms, with or without
17 .\" modification, are permitted provided that the following conditions
19 .\" 1. Redistributions of source code must retain the above copyright
20 .\" notice, this list of conditions and the following disclaimer.
21 .\" 2. Redistributions in binary form must reproduce the above copyright
22 .\" notice, this list of conditions and the following disclaimer in the
23 .\" documentation and/or other materials provided with the distribution.
25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 .\" $OpenBSD: ssh.1,v 1.361 2015/07/20 18:44:12 millert Exp $
38 .Dd $Mdocdate: July 20 2015 $
43 .Nd OpenSSH SSH client (remote login program)
47 .Op Fl 1246AaCfGgKkMNnqsTtVvXxYy
48 .Op Fl b Ar bind_address
49 .Op Fl c Ar cipher_spec
50 .Op Fl D Oo Ar bind_address : Oc Ns Ar port
52 .Op Fl e Ar escape_char
53 .Op Fl F Ar configfile
55 .Op Fl i Ar identity_file
57 .Op Fl l Ar login_name
62 .Op Fl Q Cm cipher | cipher-auth | mac | kex | key | protocol-version
65 .Op Fl W Ar host : Ns Ar port
66 .Op Fl w Ar local_tun Ns Op : Ns Ar remote_tun
67 .Oo Ar user Ns @ Oc Ns Ar hostname
72 (SSH client) is a program for logging into a remote machine and for
73 executing commands on a remote machine.
74 It is intended to replace rlogin and rsh,
75 and provide secure encrypted communications between
76 two untrusted hosts over an insecure network.
77 X11 connections, arbitrary TCP ports and
79 sockets can also be forwarded over the secure channel.
82 connects and logs into the specified
88 his/her identity to the remote machine using one of several methods
89 depending on the protocol version used (see below).
94 it is executed on the remote host instead of a login shell.
96 The options are as follows:
98 .Bl -tag -width Ds -compact
102 to try protocol version 1 only.
107 to try protocol version 2 only.
112 to use IPv4 addresses only.
117 to use IPv6 addresses only.
120 Enables forwarding of the authentication agent connection.
121 This can also be specified on a per-host basis in a configuration file.
123 Agent forwarding should be enabled with caution.
124 Users with the ability to bypass file permissions on the remote host
127 socket) can access the local agent through the forwarded connection.
128 An attacker cannot obtain key material from the agent,
129 however they can perform operations on the keys that enable them to
130 authenticate using the identities loaded into the agent.
133 Disables forwarding of the authentication agent connection.
135 .It Fl b Ar bind_address
138 on the local machine as the source address
140 Only useful on systems with more than one address.
143 Requests compression of all data (including stdin, stdout, stderr, and
144 data for forwarded X11, TCP and
147 The compression algorithm is the same used by
151 can be controlled by the
153 option for protocol version 1.
154 Compression is desirable on modem lines and other
155 slow connections, but will only slow down things on fast networks.
156 The default value can be set on a host-by-host basis in the
157 configuration files; see the
161 .It Fl c Ar cipher_spec
162 Selects the cipher specification for encrypting the session.
164 Protocol version 1 allows specification of a single cipher.
165 The supported values are
170 For protocol version 2,
172 is a comma-separated list of ciphers
173 listed in order of preference.
178 for more information.
182 .Oo Ar bind_address : Oc
188 application-level port forwarding.
189 This works by allocating a socket to listen to
191 on the local side, optionally bound to the specified
193 Whenever a connection is made to this port, the
194 connection is forwarded over the secure channel, and the application
195 protocol is then used to determine where to connect to from the
197 Currently the SOCKS4 and SOCKS5 protocols are supported, and
199 will act as a SOCKS server.
200 Only root can forward privileged ports.
201 Dynamic port forwardings can also be specified in the configuration file.
203 IPv6 addresses can be specified by enclosing the address in square brackets.
204 Only the superuser can forward privileged ports.
205 By default, the local port is bound in accordance with the
210 may be used to bind the connection to a specific address.
215 indicates that the listening port be bound for local use only, while an
218 indicates that the port should be available from all interfaces.
223 instead of standard error.
225 .It Fl e Ar escape_char
226 Sets the escape character for sessions with a pty (default:
228 The escape character is only recognized at the beginning of a line.
229 The escape character followed by a dot
231 closes the connection;
232 followed by control-Z suspends the connection;
233 and followed by itself sends the escape character once.
234 Setting the character to
236 disables any escapes and makes the session fully transparent.
238 .It Fl F Ar configfile
239 Specifies an alternative per-user configuration file.
240 If a configuration file is given on the command line,
241 the system-wide configuration file
242 .Pq Pa /etc/ssh/ssh_config
244 The default for the per-user configuration file is
250 to go to background just before command execution.
253 is going to ask for passwords or passphrases, but the user
254 wants it in the background.
257 The recommended way to start X11 programs at a remote site is with
259 .Ic ssh -f host xterm .
262 .Cm ExitOnForwardFailure
263 configuration option is set to
265 then a client started with
267 will wait for all remote port forwards to be successfully established
268 before placing itself in the background.
273 to print its configuration after evaluating
280 Allows remote hosts to connect to local forwarded ports.
281 If used on a multiplexed connection, then this option must be specified
282 on the master process.
285 Specify the PKCS#11 shared library
287 should use to communicate with a PKCS#11 token providing the user's
290 .It Fl i Ar identity_file
291 Selects a file from which the identity (private key) for
292 public key authentication is read.
295 for protocol version 1, and
297 .Pa ~/.ssh/id_ecdsa ,
298 .Pa ~/.ssh/id_ed25519
301 for protocol version 2.
302 Identity files may also be specified on
303 a per-host basis in the configuration file.
304 It is possible to have multiple
306 options (and multiple identities specified in
307 configuration files).
309 will also try to load certificate information from the filename obtained
312 to identity filenames.
315 Enables GSSAPI-based authentication and forwarding (delegation) of GSSAPI
316 credentials to the server.
319 Disables forwarding (delegation) of GSSAPI credentials to the server.
323 .Oo Ar bind_address : Oc
324 .Ar port : host : hostport
329 .Oo Ar bind_address : Oc
330 .Ar port : remote_socket
335 .Ar local_socket : host : hostport
340 .Ar local_socket : remote_socket
343 Specifies that connections to the given TCP port or Unix socket on the local
344 (client) host are to be forwarded to the given host and port, or Unix socket,
346 This works by allocating a socket to listen to either a TCP
348 on the local side, optionally bound to the specified
351 Whenever a connection is made to the local port or socket, the
352 connection is forwarded over the secure channel, and a connection is
359 from the remote machine.
361 Port forwardings can also be specified in the configuration file.
362 Only the superuser can forward privileged ports.
363 IPv6 addresses can be specified by enclosing the address in square brackets.
365 By default, the local port is bound in accordance with the
370 may be used to bind the connection to a specific address.
375 indicates that the listening port be bound for local use only, while an
378 indicates that the port should be available from all interfaces.
380 .It Fl l Ar login_name
381 Specifies the user to log in as on the remote machine.
382 This also may be specified on a per-host basis in the configuration file.
389 mode for connection sharing.
396 mode with confirmation required before slave connections are accepted.
397 Refer to the description of
404 Additionally, for protocol version 2 a comma-separated list of MAC
405 (message authentication code) algorithms can
406 be specified in order of preference.
409 keyword for more information.
412 Do not execute a remote command.
413 This is useful for just forwarding ports
414 (protocol version 2 only).
419 (actually, prevents reading from stdin).
420 This must be used when
422 is run in the background.
423 A common trick is to use this to run X11 programs on a remote machine.
425 .Ic ssh -n shadows.cs.hut.fi emacs &
426 will start an emacs on shadows.cs.hut.fi, and the X11
427 connection will be automatically forwarded over an encrypted channel.
430 program will be put in the background.
431 (This does not work if
433 needs to ask for a password or passphrase; see also the
438 Control an active connection multiplexing master process.
441 option is specified, the
443 argument is interpreted and passed to the master process.
446 (check that the master process is running),
448 (request forwardings without command execution),
450 (cancel forwardings),
452 (request the master to exit), and
454 (request the master to stop accepting further multiplexing requests).
457 Can be used to give options in the format used in the configuration file.
458 This is useful for specifying options for which there is no separate
460 For full details of the options listed below, and their possible values, see
463 .Bl -tag -width Ds -offset indent -compact
468 .It CanonicalizeFallbackLocal
469 .It CanonicalizeHostname
470 .It CanonicalizeMaxDots
471 .It CanonicalizePermittedCNAMEs
472 .It ChallengeResponseAuthentication
476 .It ClearAllForwardings
479 .It ConnectionAttempts
486 .It ExitOnForwardFailure
490 .It ForwardX11Timeout
491 .It ForwardX11Trusted
493 .It GlobalKnownHostsFile
494 .It GSSAPIAuthentication
495 .It GSSAPIDelegateCredentials
498 .It HostbasedAuthentication
499 .It HostbasedKeyTypes
500 .It HostKeyAlgorithms
506 .It KbdInteractiveAuthentication
507 .It KbdInteractiveDevices
514 .It NoHostAuthenticationForLocalhost
515 .It NumberOfPasswordPrompts
516 .It PasswordAuthentication
517 .It PermitLocalCommand
520 .It PreferredAuthentications
524 .It PubkeyAcceptedKeyTypes
525 .It PubkeyAuthentication
529 .It RhostsRSAAuthentication
530 .It RSAAuthentication
532 .It ServerAliveInterval
533 .It ServerAliveCountMax
534 .It StreamLocalBindMask
535 .It StreamLocalBindUnlink
536 .It StrictHostKeyChecking
541 .It UsePrivilegedPort
543 .It UserKnownHostsFile
551 Port to connect to on the remote host.
552 This can be specified on a
553 per-host basis in the configuration file.
555 .It Fl Q Cm cipher | cipher-auth | mac | kex | key | protocol-version
558 for the algorithms supported for the specified version 2.
559 The available features are:
561 (supported symmetric ciphers),
563 (supported symmetric ciphers that support authenticated encryption),
565 (supported message integrity codes),
567 (key exchange algorithms),
571 (supported SSH protocol versions).
575 Causes most warning and diagnostic messages to be suppressed.
579 .Oo Ar bind_address : Oc
580 .Ar port : host : hostport
585 .Oo Ar bind_address : Oc
586 .Ar port : local_socket
591 .Ar remote_socket : host : hostport
596 .Ar remote_socket : local_socket
599 Specifies that connections to the given TCP port or Unix socket on the remote
600 (server) host are to be forwarded to the given host and port, or Unix socket,
602 This works by allocating a socket to listen to either a TCP
604 or to a Unix socket on the remote side.
605 Whenever a connection is made to this port or Unix socket, the
606 connection is forwarded over the secure channel, and a connection
613 from the local machine.
615 Port forwardings can also be specified in the configuration file.
616 Privileged ports can be forwarded only when
617 logging in as root on the remote machine.
618 IPv6 addresses can be specified by enclosing the address in square brackets.
620 By default, TCP listening sockets on the server will be bound to the loopback
622 This may be overridden by specifying a
628 indicates that the remote socket should listen on all interfaces.
631 will only succeed if the server's
633 option is enabled (see
634 .Xr sshd_config 5 ) .
640 the listen port will be dynamically allocated on the server and reported
641 to the client at run time.
642 When used together with
644 the allocated port will be printed to the standard output.
647 Specifies the location of a control socket for connection sharing,
650 to disable connection sharing.
651 Refer to the description of
660 May be used to request invocation of a subsystem on the remote system.
661 Subsystems are a feature of the SSH2 protocol which facilitate the use
662 of SSH as a secure transport for other applications (eg.\&
664 The subsystem is specified as the remote command.
667 Disable pseudo-terminal allocation.
670 Force pseudo-terminal allocation.
671 This can be used to execute arbitrary
672 screen-based programs on a remote machine, which can be very useful,
673 e.g. when implementing menu services.
676 options force tty allocation, even if
681 Display the version number and exit.
687 to print debugging messages about its progress.
689 debugging connection, authentication, and configuration problems.
692 options increase the verbosity.
695 .It Fl W Ar host : Ns Ar port
696 Requests that standard input and output on the client be forwarded to
700 over the secure channel.
704 .Cm ExitOnForwardFailure
706 .Cm ClearAllForwardings .
707 Works with Protocol version 2 only.
710 .Ar local_tun Ns Op : Ns Ar remote_tun
714 device forwarding with the specified
716 devices between the client
721 The devices may be specified by numerical ID or the keyword
723 which uses the next available tunnel device.
726 is not specified, it defaults to
736 directive is unset, it is set to the default tunnel mode, which is
740 Enables X11 forwarding.
741 This can also be specified on a per-host basis in a configuration file.
743 X11 forwarding should be enabled with caution.
744 Users with the ability to bypass file permissions on the remote host
745 (for the user's X authorization database)
746 can access the local X11 display through the forwarded connection.
747 An attacker may then be able to perform activities such as keystroke monitoring.
749 For this reason, X11 forwarding is subjected to X11 SECURITY extension
750 restrictions by default.
755 .Cm ForwardX11Trusted
758 for more information.
761 Disables X11 forwarding.
764 Enables trusted X11 forwarding.
765 Trusted X11 forwardings are not subjected to the X11 SECURITY extension
769 Send log information using the
772 By default this information is sent to stderr.
776 may additionally obtain configuration data from
777 a per-user configuration file and a system-wide configuration file.
778 The file format and configuration options are described in
781 The OpenSSH SSH client supports SSH protocols 1 and 2.
782 The default is to use protocol 2 only,
783 though this can be changed via the
792 Both protocols support similar authentication methods,
793 but protocol 2 is the default since
794 it provides additional mechanisms for confidentiality
795 (the traffic is encrypted using AES, 3DES, Blowfish, CAST128, or Arcfour)
796 and integrity (hmac-md5, hmac-sha1,
797 hmac-sha2-256, hmac-sha2-512,
798 umac-64, umac-128, hmac-ripemd160).
799 Protocol 1 lacks a strong mechanism for ensuring the
800 integrity of the connection.
802 The methods available for authentication are:
803 GSSAPI-based authentication,
804 host-based authentication,
805 public key authentication,
806 challenge-response authentication,
807 and password authentication.
808 Authentication methods are tried in the order specified above,
809 though protocol 2 has a configuration option to change the default order:
810 .Cm PreferredAuthentications .
812 Host-based authentication works as follows:
813 If the machine the user logs in from is listed in
816 .Pa /etc/shosts.equiv
817 on the remote machine, and the user names are
818 the same on both sides, or if the files
822 exist in the user's home directory on the
823 remote machine and contain a line containing the name of the client
824 machine and the name of the user on that machine, the user is
825 considered for login.
826 Additionally, the server
828 be able to verify the client's
829 host key (see the description of
830 .Pa /etc/ssh/ssh_known_hosts
832 .Pa ~/.ssh/known_hosts ,
834 for login to be permitted.
835 This authentication method closes security holes due to IP
836 spoofing, DNS spoofing, and routing spoofing.
837 [Note to the administrator:
838 .Pa /etc/hosts.equiv ,
840 and the rlogin/rsh protocol in general, are inherently insecure and should be
841 disabled if security is desired.]
843 Public key authentication works as follows:
844 The scheme is based on public-key cryptography,
846 where encryption and decryption are done using separate keys,
847 and it is unfeasible to derive the decryption key from the encryption key.
848 The idea is that each user creates a public/private
849 key pair for authentication purposes.
850 The server knows the public key, and only the user knows the private key.
852 implements public key authentication protocol automatically,
853 using one of the DSA, ECDSA, Ed25519 or RSA algorithms.
854 Protocol 1 is restricted to using only RSA keys,
855 but protocol 2 may use any.
856 The HISTORY section of
858 contains a brief discussion of the DSA and RSA algorithms.
861 .Pa ~/.ssh/authorized_keys
862 lists the public keys that are permitted for logging in.
863 When the user logs in, the
865 program tells the server which key pair it would like to use for
867 The client proves that it has access to the private key
868 and the server checks that the corresponding public key
869 is authorized to accept the account.
871 The user creates his/her key pair by running
873 This stores the private key in
880 .Pa ~/.ssh/id_ed25519
881 (protocol 2 Ed25519),
885 and stores the public key in
886 .Pa ~/.ssh/identity.pub
888 .Pa ~/.ssh/id_dsa.pub
890 .Pa ~/.ssh/id_ecdsa.pub
892 .Pa ~/.ssh/id_ed25519.pub
893 (protocol 2 Ed25519),
895 .Pa ~/.ssh/id_rsa.pub
897 in the user's home directory.
898 The user should then copy the public key
900 .Pa ~/.ssh/authorized_keys
901 in his/her home directory on the remote machine.
904 file corresponds to the conventional
906 file, and has one key
907 per line, though the lines can be very long.
908 After this, the user can log in without giving the password.
910 A variation on public key authentication
911 is available in the form of certificate authentication:
912 instead of a set of public/private keys,
913 signed certificates are used.
914 This has the advantage that a single trusted certification authority
915 can be used in place of many public/private keys.
916 See the CERTIFICATES section of
918 for more information.
920 The most convenient way to use public key or certificate authentication
921 may be with an authentication agent.
924 for more information.
926 Challenge-response authentication works as follows:
927 The server sends an arbitrary
929 text, and prompts for a response.
930 Protocol 2 allows multiple challenges and responses;
931 protocol 1 is restricted to just one challenge/response.
932 Examples of challenge-response authentication include
940 Finally, if other authentication methods fail,
942 prompts the user for a password.
943 The password is sent to the remote
944 host for checking; however, since all communications are encrypted,
945 the password cannot be seen by someone listening on the network.
948 automatically maintains and checks a database containing
949 identification for all hosts it has ever been used with.
950 Host keys are stored in
951 .Pa ~/.ssh/known_hosts
952 in the user's home directory.
953 Additionally, the file
954 .Pa /etc/ssh/ssh_known_hosts
955 is automatically checked for known hosts.
956 Any new hosts are automatically added to the user's file.
957 If a host's identification ever changes,
959 warns about this and disables password authentication to prevent
960 server spoofing or man-in-the-middle attacks,
961 which could otherwise be used to circumvent the encryption.
963 .Cm StrictHostKeyChecking
964 option can be used to control logins to machines whose
965 host key is not known or has changed.
967 When the user's identity has been accepted by the server, the server
968 either executes the given command in a non-interactive session or,
969 if no command has been specified, logs into the machine and gives
970 the user a normal shell as an interactive session.
971 All communication with
972 the remote command or shell will be automatically encrypted.
974 If an interactive session is requested
976 by default will only request a pseudo-terminal (pty) for interactive
977 sessions when the client has one.
982 can be used to override this behaviour.
984 If a pseudo-terminal has been allocated the
985 user may use the escape characters noted below.
987 If no pseudo-terminal has been allocated,
988 the session is transparent and can be used to reliably transfer binary data.
989 On most systems, setting the escape character to
991 will also make the session transparent even if a tty is used.
993 The session terminates when the command or shell on the remote
994 machine exits and all X11 and TCP connections have been closed.
995 .Sh ESCAPE CHARACTERS
996 When a pseudo-terminal has been requested,
998 supports a number of functions through the use of an escape character.
1000 A single tilde character can be sent as
1002 or by following the tilde by a character other than those described below.
1003 The escape character must always follow a newline to be interpreted as
1005 The escape character can be changed in configuration files using the
1007 configuration directive or on the command line by the
1011 The supported escapes (assuming the default
1021 List forwarded connections.
1025 at logout when waiting for forwarded connection / X11 sessions to terminate.
1027 Display a list of escape characters.
1029 Send a BREAK to the remote system
1030 (only useful for SSH protocol version 2 and if the peer supports it).
1033 Currently this allows the addition of port forwardings using the
1038 options (see above).
1039 It also allows the cancellation of existing port-forwardings
1042 .Fl KL Oo Ar bind_address : Oc Ar port
1046 .Fl KR Oo Ar bind_address : Oc Ar port
1050 .Fl KD Oo Ar bind_address : Oc Ar port
1052 for dynamic port-forwardings.
1053 .Ic !\& Ns Ar command
1054 allows the user to execute a local command if the
1055 .Ic PermitLocalCommand
1056 option is enabled in
1058 Basic help is available, using the
1062 Request rekeying of the connection
1063 (only useful for SSH protocol version 2 and if the peer supports it).
1065 Decrease the verbosity
1067 when errors are being written to stderr.
1069 Increase the verbosity
1071 when errors are being written to stderr.
1074 Forwarding of arbitrary TCP connections over the secure channel can
1075 be specified either on the command line or in a configuration file.
1076 One possible application of TCP forwarding is a secure connection to a
1077 mail server; another is going through firewalls.
1079 In the example below, we look at encrypting communication between
1080 an IRC client and server, even though the IRC server does not directly
1081 support encrypted communications.
1082 This works as follows:
1083 the user connects to the remote host using
1085 specifying a port to be used to forward connections
1086 to the remote server.
1087 After that it is possible to start the service which is to be encrypted
1088 on the client machine,
1089 connecting to the same local port,
1092 will encrypt and forward the connection.
1094 The following example tunnels an IRC session from client machine
1098 .Dq server.example.com :
1099 .Bd -literal -offset 4n
1100 $ ssh -f -L 1234:localhost:6667 server.example.com sleep 10
1101 $ irc -c '#users' -p 1234 pinky 127.0.0.1
1104 This tunnels a connection to IRC server
1105 .Dq server.example.com ,
1111 It doesn't matter which port is used,
1112 as long as it's greater than 1023
1113 (remember, only root can open sockets on privileged ports)
1114 and doesn't conflict with any ports already in use.
1115 The connection is forwarded to port 6667 on the remote server,
1116 since that's the standard port for IRC services.
1122 and the remote command
1124 is specified to allow an amount of time
1125 (10 seconds, in the example)
1126 to start the service which is to be tunnelled.
1127 If no connections are made within the time specified,
1135 (or see the description of the
1141 and the user is using X11 (the
1143 environment variable is set), the connection to the X11 display is
1144 automatically forwarded to the remote side in such a way that any X11
1145 programs started from the shell (or command) will go through the
1146 encrypted channel, and the connection to the real X server will be made
1147 from the local machine.
1148 The user should not manually set
1150 Forwarding of X11 connections can be
1151 configured on the command line or in configuration files.
1157 will point to the server machine, but with a display number greater than zero.
1158 This is normal, and happens because
1162 X server on the server machine for forwarding the
1163 connections over the encrypted channel.
1166 will also automatically set up Xauthority data on the server machine.
1167 For this purpose, it will generate a random authorization cookie,
1168 store it in Xauthority on the server, and verify that any forwarded
1169 connections carry this cookie and replace it by the real cookie when
1170 the connection is opened.
1171 The real authentication cookie is never
1172 sent to the server machine (and no cookies are sent in the plain).
1178 (or see the description of the
1183 the user is using an authentication agent, the connection to the agent
1184 is automatically forwarded to the remote side.
1185 .Sh VERIFYING HOST KEYS
1186 When connecting to a server for the first time,
1187 a fingerprint of the server's public key is presented to the user
1189 .Cm StrictHostKeyChecking
1191 Fingerprints can be determined using
1194 .Dl $ ssh-keygen -l -f /etc/ssh/ssh_host_rsa_key
1196 If the fingerprint is already known, it can be matched
1197 and the key can be accepted or rejected.
1198 If only legacy (MD5) fingerprints for the server are available, the
1201 option may be used to downgrade the fingerprint algorithm to match.
1203 Because of the difficulty of comparing host keys
1204 just by looking at fingerprint strings,
1205 there is also support to compare host keys visually,
1212 a small ASCII graphic gets displayed on every login to a server, no matter
1213 if the session itself is interactive or not.
1214 By learning the pattern a known server produces, a user can easily
1215 find out that the host key has changed when a completely different pattern
1217 Because these patterns are not unambiguous however, a pattern that looks
1218 similar to the pattern remembered only gives a good probability that the
1219 host key is the same, not guaranteed proof.
1221 To get a listing of the fingerprints along with their random art for
1222 all known hosts, the following command line can be used:
1224 .Dl $ ssh-keygen -lv -f ~/.ssh/known_hosts
1226 If the fingerprint is unknown,
1227 an alternative method of verification is available:
1228 SSH fingerprints verified by DNS.
1229 An additional resource record (RR),
1231 is added to a zonefile
1232 and the connecting client is able to match the fingerprint
1233 with that of the key presented.
1235 In this example, we are connecting a client to a server,
1236 .Dq host.example.com .
1237 The SSHFP resource records should first be added to the zonefile for
1239 .Bd -literal -offset indent
1240 $ ssh-keygen -r host.example.com.
1243 The output lines will have to be added to the zonefile.
1244 To check that the zone is answering fingerprint queries:
1246 .Dl $ dig -t SSHFP host.example.com
1248 Finally the client connects:
1249 .Bd -literal -offset indent
1250 $ ssh -o "VerifyHostKeyDNS ask" host.example.com
1252 Matching host key fingerprint found in DNS.
1253 Are you sure you want to continue connecting (yes/no)?
1257 .Cm VerifyHostKeyDNS
1260 for more information.
1261 .Sh SSH-BASED VIRTUAL PRIVATE NETWORKS
1263 contains support for Virtual Private Network (VPN) tunnelling
1266 network pseudo-device,
1267 allowing two networks to be joined securely.
1270 configuration option
1272 controls whether the server supports this,
1273 and at what level (layer 2 or 3 traffic).
1275 The following example would connect client network 10.0.50.0/24
1276 with remote network 10.0.99.0/24 using a point-to-point connection
1277 from 10.1.1.1 to 10.1.1.2,
1278 provided that the SSH server running on the gateway to the remote network,
1279 at 192.168.1.15, allows it.
1282 .Bd -literal -offset indent
1283 # ssh -f -w 0:1 192.168.1.15 true
1284 # ifconfig tun0 10.1.1.1 10.1.1.2 netmask 255.255.255.252
1285 # route add 10.0.99.0/24 10.1.1.2
1289 .Bd -literal -offset indent
1290 # ifconfig tun1 10.1.1.2 10.1.1.1 netmask 255.255.255.252
1291 # route add 10.0.50.0/24 10.1.1.1
1294 Client access may be more finely tuned via the
1295 .Pa /root/.ssh/authorized_keys
1296 file (see below) and the
1299 The following entry would permit connections on
1303 and on tun device 2 from user
1308 .Dq forced-commands-only :
1309 .Bd -literal -offset 2n
1310 tunnel="1",command="sh /etc/netstart tun1" ssh-rsa ... jane
1311 tunnel="2",command="sh /etc/netstart tun2" ssh-rsa ... john
1314 Since an SSH-based setup entails a fair amount of overhead,
1315 it may be more suited to temporary setups,
1316 such as for wireless VPNs.
1317 More permanent VPNs are better provided by tools such as
1323 will normally set the following environment variables:
1324 .Bl -tag -width "SSH_ORIGINAL_COMMAND"
1328 variable indicates the location of the X11 server.
1329 It is automatically set by
1331 to point to a value of the form
1335 indicates the host where the shell runs, and
1337 is an integer \*(Ge 1.
1339 uses this special value to forward X11 connections over the secure
1341 The user should normally not set
1344 will render the X11 connection insecure (and will require the user to
1345 manually copy any required authorization cookies).
1347 Set to the path of the user's home directory.
1351 set for compatibility with systems that use this variable.
1353 Set to the path of the user's mailbox.
1357 as specified when compiling
1362 needs a passphrase, it will read the passphrase from the current
1363 terminal if it was run from a terminal.
1366 does not have a terminal associated with it but
1370 are set, it will execute the program specified by
1372 and open an X11 window to read the passphrase.
1373 This is particularly useful when calling
1378 (Note that on some machines it
1379 may be necessary to redirect the input from
1382 .It Ev SSH_AUTH_SOCK
1383 Identifies the path of a
1385 socket used to communicate with the agent.
1386 .It Ev SSH_CONNECTION
1387 Identifies the client and server ends of the connection.
1388 The variable contains
1389 four space-separated values: client IP address, client port number,
1390 server IP address, and server port number.
1391 .It Ev SSH_ORIGINAL_COMMAND
1392 This variable contains the original command line if a forced command
1394 It can be used to extract the original arguments.
1396 This is set to the name of the tty (path to the device) associated
1397 with the current shell or command.
1398 If the current session has no tty,
1399 this variable is not set.
1401 This variable is set to indicate the present time zone if it
1402 was set when the daemon was started (i.e. the daemon passes the value
1403 on to new connections).
1405 Set to the name of the user logging in.
1411 .Pa ~/.ssh/environment ,
1412 and adds lines of the format
1414 to the environment if the file exists and users are allowed to
1415 change their environment.
1416 For more information, see the
1417 .Cm PermitUserEnvironment
1421 .Bl -tag -width Ds -compact
1423 This file is used for host-based authentication (see above).
1424 On some machines this file may need to be
1425 world-readable if the user's home directory is on an NFS partition,
1429 Additionally, this file must be owned by the user,
1430 and must not have write permissions for anyone else.
1432 permission for most machines is read/write for the user, and not
1433 accessible by others.
1436 This file is used in exactly the same way as
1438 but allows host-based authentication without permitting login with
1442 This directory is the default location for all user-specific configuration
1443 and authentication information.
1444 There is no general requirement to keep the entire contents of this directory
1445 secret, but the recommended permissions are read/write/execute for the user,
1446 and not accessible by others.
1448 .It Pa ~/.ssh/authorized_keys
1449 Lists the public keys (DSA, ECDSA, Ed25519, RSA)
1450 that can be used for logging in as this user.
1451 The format of this file is described in the
1454 This file is not highly sensitive, but the recommended
1455 permissions are read/write for the user, and not accessible by others.
1457 .It Pa ~/.ssh/config
1458 This is the per-user configuration file.
1459 The file format and configuration options are described in
1461 Because of the potential for abuse, this file must have strict permissions:
1462 read/write for the user, and not writable by others.
1464 .It Pa ~/.ssh/environment
1465 Contains additional definitions for environment variables; see
1469 .It Pa ~/.ssh/identity
1470 .It Pa ~/.ssh/id_dsa
1471 .It Pa ~/.ssh/id_ecdsa
1472 .It Pa ~/.ssh/id_ed25519
1473 .It Pa ~/.ssh/id_rsa
1474 Contains the private key for authentication.
1476 contain sensitive data and should be readable by the user but not
1477 accessible by others (read/write/execute).
1479 will simply ignore a private key file if it is accessible by others.
1480 It is possible to specify a passphrase when
1481 generating the key which will be used to encrypt the
1482 sensitive part of this file using 3DES.
1484 .It Pa ~/.ssh/identity.pub
1485 .It Pa ~/.ssh/id_dsa.pub
1486 .It Pa ~/.ssh/id_ecdsa.pub
1487 .It Pa ~/.ssh/id_ed25519.pub
1488 .It Pa ~/.ssh/id_rsa.pub
1489 Contains the public key for authentication.
1491 sensitive and can (but need not) be readable by anyone.
1493 .It Pa ~/.ssh/known_hosts
1494 Contains a list of host keys for all hosts the user has logged into
1495 that are not already in the systemwide list of known host keys.
1498 for further details of the format of this file.
1501 Commands in this file are executed by
1503 when the user logs in, just before the user's shell (or command) is
1507 manual page for more information.
1509 .It Pa /etc/hosts.equiv
1510 This file is for host-based authentication (see above).
1511 It should only be writable by root.
1513 .It Pa /etc/shosts.equiv
1514 This file is used in exactly the same way as
1516 but allows host-based authentication without permitting login with
1519 .It Pa /etc/ssh/ssh_config
1520 Systemwide configuration file.
1521 The file format and configuration options are described in
1524 .It Pa /etc/ssh/ssh_host_key
1525 .It Pa /etc/ssh/ssh_host_dsa_key
1526 .It Pa /etc/ssh/ssh_host_ecdsa_key
1527 .It Pa /etc/ssh/ssh_host_ed25519_key
1528 .It Pa /etc/ssh/ssh_host_rsa_key
1529 These files contain the private parts of the host keys
1530 and are used for host-based authentication.
1531 If protocol version 1 is used,
1533 must be setuid root, since the host key is readable only by root.
1534 For protocol version 2,
1538 to access the host keys,
1539 eliminating the requirement that
1541 be setuid root when host-based authentication is used.
1546 .It Pa /etc/ssh/ssh_known_hosts
1547 Systemwide list of known host keys.
1548 This file should be prepared by the
1549 system administrator to contain the public host keys of all machines in the
1551 It should be world-readable.
1554 for further details of the format of this file.
1556 .It Pa /etc/ssh/sshrc
1557 Commands in this file are executed by
1559 when the user logs in, just before the user's shell (or command) is started.
1562 manual page for more information.
1566 exits with the exit status of the remote command or with 255
1567 if an error occurred.
1585 .%T The Secure Shell (SSH) Protocol Assigned Numbers
1593 .%T The Secure Shell (SSH) Protocol Architecture
1601 .%T The Secure Shell (SSH) Authentication Protocol
1609 .%T The Secure Shell (SSH) Transport Layer Protocol
1617 .%T The Secure Shell (SSH) Connection Protocol
1625 .%T Using DNS to Securely Publish Secure Shell (SSH) Key Fingerprints
1633 .%T Generic Message Exchange Authentication for the Secure Shell Protocol (SSH)
1641 .%T The Secure Shell (SSH) Session Channel Break Extension
1650 .%T The Secure Shell (SSH) Transport Layer Encryption Modes
1657 .%T Improved Arcfour Modes for the Secure Shell (SSH) Transport Layer Protocol
1666 .%T Diffie-Hellman Group Exchange for the Secure Shell (SSH) Transport Layer Protocol
1674 .%T The Secure Shell (SSH) Public Key File Format
1682 .%T Elliptic Curve Algorithm Integration in the Secure Shell Transport Layer
1689 .%O International Workshop on Cryptographic Techniques and E-Commerce (CrypTEC '99)
1690 .%T Hash Visualization: a New Technique to improve Real-World Security
1693 OpenSSH is a derivative of the original and free
1694 ssh 1.2.12 release by Tatu Ylonen.
1695 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1696 Theo de Raadt and Dug Song
1697 removed many bugs, re-added newer features and
1699 Markus Friedl contributed the support for SSH
1700 protocol versions 1.5 and 2.0.