3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\" All rights reserved
7 .\" As far as I am concerned, the code I have written for this software
8 .\" can be used freely for any purpose. Any derived versions of this
9 .\" software must be clearly marked as such, and if the derived work is
10 .\" incompatible with the protocol description in the RFC file, it must be
11 .\" called by a name other than "ssh" or "Secure Shell".
13 .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14 .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15 .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
17 .\" Redistribution and use in source and binary forms, with or without
18 .\" modification, are permitted provided that the following conditions
20 .\" 1. Redistributions of source code must retain the above copyright
21 .\" notice, this list of conditions and the following disclaimer.
22 .\" 2. Redistributions in binary form must reproduce the above copyright
23 .\" notice, this list of conditions and the following disclaimer in the
24 .\" documentation and/or other materials provided with the distribution.
26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 .\" $OpenBSD: ssh.1,v 1.125 2001/07/31 09:28:44 jakob Exp $
38 .Dd September 25, 1999
43 .Nd OpenSSH SSH client (remote login program)
46 .Op Fl l Ar login_name
47 .Op Ar hostname | user@hostname
51 .Op Fl afgknqstvxACNPTX1246
52 .Op Fl b Ar bind_address
53 .Op Fl c Ar cipher_spec
54 .Op Fl e Ar escape_char
55 .Op Fl i Ar identity_file
56 .Op Fl l Ar login_name
76 .Op Ar hostname | user@hostname
80 (SSH client) is a program for logging into a remote machine and for
81 executing commands on a remote machine.
82 It is intended to replace
83 rlogin and rsh, and provide secure encrypted communications between
84 two untrusted hosts over an insecure network.
86 arbitrary TCP/IP ports can also be forwarded over the secure channel.
89 connects and logs into the specified
92 his/her identity to the remote machine using one of several methods
93 depending on the protocol version used:
95 .Ss SSH protocol version 1
97 First, if the machine the user logs in from is listed in
100 .Pa /etc/shosts.equiv
101 on the remote machine, and the user names are
102 the same on both sides, the user is immediately permitted to log in.
107 exists in the user's home directory on the
108 remote machine and contains a line containing the name of the client
109 machine and the name of the user on that machine, the user is
111 This form of authentication alone is normally not
112 allowed by the server because it is not secure.
114 The second authentication method is the
118 method combined with RSA-based host authentication.
119 It means that if the login would be permitted by
122 .Pa /etc/hosts.equiv ,
124 .Pa /etc/shosts.equiv ,
125 and if additionally the server can verify the client's
127 .Pa /etc/ssh_known_hosts
129 .Pa $HOME/.ssh/known_hosts
132 section), only then login is permitted.
133 This authentication method closes security holes due to IP
134 spoofing, DNS spoofing and routing spoofing.
135 [Note to the administrator:
136 .Pa /etc/hosts.equiv ,
138 and the rlogin/rsh protocol in general, are inherently insecure and should be
139 disabled if security is desired.]
141 As a third authentication method,
143 supports RSA based authentication.
144 The scheme is based on public-key cryptography: there are cryptosystems
145 where encryption and decryption are done using separate keys, and it
146 is not possible to derive the decryption key from the encryption key.
147 RSA is one such system.
148 The idea is that each user creates a public/private
149 key pair for authentication purposes.
150 The server knows the public key, and only the user knows the private key.
152 .Pa $HOME/.ssh/authorized_keys
153 lists the public keys that are permitted for logging
155 When the user logs in, the
157 program tells the server which key pair it would like to use for
159 The server checks if this key is permitted, and if
160 so, sends the user (actually the
162 program running on behalf of the user) a challenge, a random number,
163 encrypted by the user's public key.
164 The challenge can only be
165 decrypted using the proper private key.
166 The user's client then decrypts the
167 challenge using the private key, proving that he/she knows the private
168 key but without disclosing it to the server.
171 implements the RSA authentication protocol automatically.
172 The user creates his/her RSA key pair by running
174 This stores the private key in
175 .Pa $HOME/.ssh/identity
176 and the public key in
177 .Pa $HOME/.ssh/identity.pub
178 in the user's home directory.
179 The user should then copy the
182 .Pa $HOME/.ssh/authorized_keys
183 in his/her home directory on the remote machine (the
185 file corresponds to the conventional
187 file, and has one key
188 per line, though the lines can be very long).
189 After this, the user can log in without giving the password.
190 RSA authentication is much
191 more secure than rhosts authentication.
193 The most convenient way to use RSA authentication may be with an
194 authentication agent.
197 for more information.
199 If other authentication methods fail,
201 prompts the user for a password.
202 The password is sent to the remote
203 host for checking; however, since all communications are encrypted,
204 the password cannot be seen by someone listening on the network.
206 .Ss SSH protocol version 2
208 When a user connects using the protocol version 2
209 different authentication methods are available.
210 Using the default values for
211 .Cm PreferredAuthentications ,
212 the client will try to authenticate first using the hostbased method;
213 if this method fails public key authentication is attempted,
214 and finally if this method fails keyboard-interactive and
215 password authentication are tried.
217 The public key method is similar to RSA authentication described
218 in the previous section and allows the RSA or DSA algorithm to be used:
219 The client uses his private key,
220 .Pa $HOME/.ssh/id_dsa
222 .Pa $HOME/.ssh/id_rsa ,
223 to sign the session identifier and sends the result to the server.
224 The server checks whether the matching public key is listed in
225 .Pa $HOME/.ssh/authorized_keys
226 and grants access if both the key is found and the signature is correct.
227 The session identifier is derived from a shared Diffie-Hellman value
228 and is only known to the client and the server.
230 If public key authentication fails or is not available a password
231 can be sent encrypted to the remote host for proving the user's identity.
235 supports hostbased or challenge response authentication.
237 Protocol 2 provides additional mechanisms for confidentiality
238 (the traffic is encrypted using 3DES, Blowfish, CAST128 or Arcfour)
239 and integrity (hmac-md5, hmac-sha1).
240 Note that protocol 1 lacks a strong mechanism for ensuring the
241 integrity of the connection.
243 .Ss Login session and remote execution
245 When the user's identity has been accepted by the server, the server
246 either executes the given command, or logs into the machine and gives
247 the user a normal shell on the remote machine.
248 All communication with
249 the remote command or shell will be automatically encrypted.
251 If a pseudo-terminal has been allocated (normal login session), the
252 user may use the escape characters noted below.
254 If no pseudo tty has been allocated, the
255 session is transparent and can be used to reliably transfer binary
257 On most systems, setting the escape character to
259 will also make the session transparent even if a tty is used.
261 The session terminates when the command or shell on the remote
262 machine exits and all X11 and TCP/IP connections have been closed.
263 The exit status of the remote program is returned as the exit status
267 .Ss Escape Characters
269 When a pseudo terminal has been requested, ssh supports a number of functions
270 through the use of an escape character.
272 A single tilde character can be sent as
274 or by following the tilde by a character other than those described below.
275 The escape character must always follow a newline to be interpreted as
277 The escape character can be changed in configuration files using the
279 configuration directive or on the command line by the
283 The supported escapes (assuming the default
292 List forwarded connections
294 Background ssh at logout when waiting for forwarded connection / X11 sessions
295 to terminate (protocol version 1 only)
297 Display a list of escape characters
299 Request rekeying of the connection (only useful for SSH protocol version 2
300 and if the peer supports it)
303 .Ss X11 and TCP forwarding
309 (or, see the description of the
313 options described later)
314 and the user is using X11 (the
316 environment variable is set), the connection to the X11 display is
317 automatically forwarded to the remote side in such a way that any X11
318 programs started from the shell (or command) will go through the
319 encrypted channel, and the connection to the real X server will be made
320 from the local machine.
321 The user should not manually set
323 Forwarding of X11 connections can be
324 configured on the command line or in configuration files.
330 will point to the server machine, but with a display number greater
332 This is normal, and happens because
336 X server on the server machine for forwarding the
337 connections over the encrypted channel.
340 will also automatically set up Xauthority data on the server machine.
341 For this purpose, it will generate a random authorization cookie,
342 store it in Xauthority on the server, and verify that any forwarded
343 connections carry this cookie and replace it by the real cookie when
344 the connection is opened.
345 The real authentication cookie is never
346 sent to the server machine (and no cookies are sent in the plain).
348 If the user is using an authentication agent, the connection to the agent
349 is automatically forwarded to the remote side unless disabled on
350 the command line or in a configuration file.
352 Forwarding of arbitrary TCP/IP connections over the secure channel can
353 be specified either on the command line or in a configuration file.
354 One possible application of TCP/IP forwarding is a secure connection to an
355 electronic purse; another is going through firewalls.
357 .Ss Server authentication
360 automatically maintains and checks a database containing
361 identifications for all hosts it has ever been used with.
362 Host keys are stored in
363 .Pa $HOME/.ssh/known_hosts
364 in the user's home directory.
365 Additionally, the file
366 .Pa /etc/ssh_known_hosts
367 is automatically checked for known hosts.
368 Any new hosts are automatically added to the user's file.
369 If a host's identification
372 warns about this and disables password authentication to prevent a
373 trojan horse from getting the user's password.
375 this mechanism is to prevent man-in-the-middle attacks which could
376 otherwise be used to circumvent the encryption.
378 .Cm StrictHostKeyChecking
379 option (see below) can be used to prevent logins to machines whose
380 host key is not known or has changed.
382 The options are as follows:
385 Disables forwarding of the authentication agent connection.
387 Enables forwarding of the authentication agent connection.
388 This can also be specified on a per-host basis in a configuration file.
389 .It Fl b Ar bind_address
390 Specify the interface to transmit from on machines with multiple
391 interfaces or aliased addresses.
392 .It Fl c Ar blowfish|3des
393 Selects the cipher to use for encrypting the session.
396 It is believed to be secure.
398 (triple-des) is an encrypt-decrypt-encrypt triple with three different keys.
399 It is presumably more secure than the
401 cipher which is no longer fully supported in
404 is a fast block cipher, it appears very secure and is much faster than
406 .It Fl c Ar cipher_spec
407 Additionally, for protocol version 2 a comma-separated list of ciphers can
408 be specified in order of preference.
411 for more information.
412 .It Fl e Ar ch|^ch|none
413 Sets the escape character for sessions with a pty (default:
415 The escape character is only recognized at the beginning of a line.
416 The escape character followed by a dot
418 closes the connection, followed
419 by control-Z suspends the connection, and followed by itself sends the
420 escape character once.
421 Setting the character to
423 disables any escapes and makes the session fully transparent.
427 to go to background just before command execution.
430 is going to ask for passwords or passphrases, but the user
431 wants it in the background.
434 The recommended way to start X11 programs at a remote site is with
436 .Ic ssh -f host xterm .
438 Allows remote hosts to connect to local forwarded ports.
439 .It Fl i Ar identity_file
440 Selects the file from which the identity (private key) for
441 RSA or DSA authentication is read.
443 .Pa $HOME/.ssh/identity
444 in the user's home directory.
445 Identity files may also be specified on
446 a per-host basis in the configuration file.
447 It is possible to have multiple
449 options (and multiple identities specified in
450 configuration files).
451 .It Fl I Ar smartcard_device
452 Specifies which smartcard device to use. The argument is
455 should use to communicate with a smartcard used for storing the user's
458 Disables forwarding of Kerberos tickets and AFS tokens.
459 This may also be specified on a per-host basis in the configuration file.
460 .It Fl l Ar login_name
461 Specifies the user to log in as on the remote machine.
462 This also may be specified on a per-host basis in the configuration file.
464 Additionally, for protocol version 2 a comma-separated list of MAC
465 (message authentication code) algorithms can
466 be specified in order of preference.
469 keyword for more information.
473 (actually, prevents reading from stdin).
474 This must be used when
476 is run in the background.
477 A common trick is to use this to run X11 programs on a remote machine.
479 .Ic ssh -n shadows.cs.hut.fi emacs &
480 will start an emacs on shadows.cs.hut.fi, and the X11
481 connection will be automatically forwarded over an encrypted channel.
484 program will be put in the background.
485 (This does not work if
487 needs to ask for a password or passphrase; see also the
491 Do not execute a remote command.
492 This is useful if you just want to forward ports
493 (protocol version 2 only).
495 Can be used to give options in the format used in the config file.
496 This is useful for specifying options for which there is no separate
498 The option has the same format as a line in the configuration file.
500 Port to connect to on the remote host.
501 This can be specified on a
502 per-host basis in the configuration file.
504 Use a non-privileged port for outgoing connections.
505 This can be used if your firewall does
506 not permit connections from privileged ports.
507 Note that this option turns off
508 .Cm RhostsAuthentication
510 .Cm RhostsRSAAuthentication
514 Causes all warning and diagnostic messages to be suppressed.
515 Only fatal errors are displayed.
517 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
518 of SSH as a secure transport for other applications (eg. sftp). The
519 subsystem is specified as the remote command.
521 Force pseudo-tty allocation.
522 This can be used to execute arbitrary
523 screen-based programs on a remote machine, which can be very useful,
524 e.g., when implementing menu services.
527 options force tty allocation, even if
531 Disable pseudo-tty allocation.
536 to print debugging messages about its progress.
538 debugging connection, authentication, and configuration problems.
541 options increases the verbosity.
544 Disables X11 forwarding.
546 Enables X11 forwarding.
547 This can also be specified on a per-host basis in a configuration file.
549 Requests compression of all data (including stdin, stdout, stderr, and
550 data for forwarded X11 and TCP/IP connections).
551 The compression algorithm is the same used by
555 can be controlled by the
558 Compression is desirable on modem lines and other
559 slow connections, but will only slow down things on fast networks.
560 The default value can be set on a host-by-host basis in the
561 configuration files; see the
564 .It Fl L Ar port:host:hostport
565 Specifies that the given port on the local (client) host is to be
566 forwarded to the given host and port on the remote side.
567 This works by allocating a socket to listen to
569 on the local side, and whenever a connection is made to this port, the
570 connection is forwarded over the secure channel, and a connection is
575 from the remote machine.
576 Port forwardings can also be specified in the configuration file.
577 Only root can forward privileged ports.
578 IPv6 addresses can be specified with an alternative syntax:
579 .Ar port/host/hostport
580 .It Fl R Ar port:host:hostport
581 Specifies that the given port on the remote (server) host is to be
582 forwarded to the given host and port on the local side.
583 This works by allocating a socket to listen to
585 on the remote side, and whenever a connection is made to this port, the
586 connection is forwarded over the secure channel, and a connection is
591 from the local machine.
592 Port forwardings can also be specified in the configuration file.
593 Privileged ports can be forwarded only when
594 logging in as root on the remote machine.
595 IPv6 addresses can be specified with an alternative syntax:
596 .Ar port/host/hostport
600 to try protocol version 1 only.
604 to try protocol version 2 only.
608 to use IPv4 addresses only.
612 to use IPv6 addresses only.
614 .Sh CONFIGURATION FILES
616 obtains configuration data from the following sources (in this order):
617 command line options, user's configuration file
618 .Pq Pa $HOME/.ssh/config ,
619 and system-wide configuration file
620 .Pq Pa /etc/ssh_config .
621 For each parameter, the first obtained value
623 The configuration files contain sections bracketed by
625 specifications, and that section is only applied for hosts that
626 match one of the patterns given in the specification.
627 The matched host name is the one given on the command line.
629 Since the first obtained value for each parameter is used, more
630 host-specific declarations should be given near the beginning of the
631 file, and general defaults at the end.
633 The configuration file has the following format:
635 Empty lines and lines starting with
639 Otherwise a line is of the format
640 .Dq keyword arguments .
642 keywords and their meanings are as follows (note that the
643 configuration files are case-sensitive):
646 Restricts the following declarations (up to the next
648 keyword) to be only for those hosts that match one of the patterns
649 given after the keyword.
653 can be used as wildcards in the
657 as a pattern can be used to provide global
658 defaults for all hosts.
661 argument given on the command line (i.e., the name is not converted to
662 a canonicalized host name before matching).
663 .It Cm AFSTokenPassing
664 Specifies whether to pass AFS tokens to remote host.
665 The argument to this keyword must be
669 This option applies to protocol version 1 only.
673 passphrase/password querying will be disabled.
674 This option is useful in scripts and other batch jobs where you have no
675 user to supply the password.
683 Specify the interface to transmit from on machines with multiple
684 interfaces or aliased addresses.
685 Note that this option does not work if
686 .Cm UsePrivilegedPort
690 If this flag is set to
692 ssh will additionally check the host IP address in the
695 This allows ssh to detect if a host key changed due to DNS spoofing.
696 If the option is set to
698 the check will not be executed.
702 Specifies the cipher to use for encrypting the session
703 in protocol version 1.
712 Specifies the ciphers allowed for protocol version 2
713 in order of preference.
714 Multiple ciphers must be comma-separated.
718 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
719 aes192-cbc,aes256-cbc''
722 Specifies whether to use compression.
729 .It Cm CompressionLevel
730 Specifies the compression level to use if compression is enabled.
731 The argument must be an integer from 1 (fast) to 9 (slow, best).
732 The default level is 6, which is good for most applications.
733 The meaning of the values is the same as in
735 Note that this option applies to protocol version 1 only.
736 .It Cm ConnectionAttempts
737 Specifies the number of tries (one per second) to make before falling
738 back to rsh or exiting.
739 The argument must be an integer.
740 This may be useful in scripts if the connection sometimes fails.
743 Sets the escape character (default:
745 The escape character can also
746 be set on the command line.
747 The argument should be a single character,
749 followed by a letter, or
751 to disable the escape
752 character entirely (making the connection transparent for binary
755 Specifies that if connecting via
757 fails due to a connection refused error (there is no
759 listening on the remote host),
761 should automatically be used instead (after a suitable warning about
762 the session being unencrypted).
770 Specifies whether the connection to the authentication agent (if any)
771 will be forwarded to the remote machine.
779 Specifies whether X11 connections will be automatically redirected
780 over the secure channel and
790 Specifies whether remote hosts are allowed to connect to local
798 .It Cm GlobalKnownHostsFile
799 Specifies a file to use for the global
800 host key database instead of
801 .Pa /etc/ssh_known_hosts .
802 .It Cm HostbasedAuthentication
803 Specifies whether to try rhosts based authentication with public key
811 This option applies to protocol version 2 only and
813 .Cm RhostsRSAAuthentication .
814 .It Cm HostKeyAlgorithms
815 Specifies the protocol version 2 host key algorithms
816 that the client wants to use in order of preference.
817 The default for this option is:
820 Specifies an alias that should be used instead of the
821 real host name when looking up or saving the host key
822 in the host key database files.
823 This option is useful for tunneling ssh connections
824 or if you have multiple servers running on a single host.
826 Specifies the real host name to log into.
827 This can be used to specify nicknames or abbreviations for hosts.
828 Default is the name given on the command line.
829 Numeric IP addresses are also permitted (both on the command line and in
833 Specifies the file from which the user's RSA or DSA authentication identity
835 .Pa $HOME/.ssh/identity
836 in the user's home directory).
837 Additionally, any identities represented by the authentication agent
838 will be used for authentication.
839 The file name may use the tilde
840 syntax to refer to a user's home directory.
841 It is possible to have
842 multiple identity files specified in configuration files; all these
843 identities will be tried in sequence.
845 Specifies whether the system should send keepalive messages to the
847 If they are sent, death of the connection or crash of one
848 of the machines will be properly noticed.
849 However, this means that
850 connections will die if the route is down temporarily, and some people
855 (to send keepalives), and the client will notice
856 if the network goes down or the remote host dies.
857 This is important in scripts, and many users want it too.
859 To disable keepalives, the value should be set to
861 in both the server and the client configuration files.
862 .It Cm KerberosAuthentication
863 Specifies whether Kerberos authentication will be used.
864 The argument to this keyword must be
868 .It Cm KerberosTgtPassing
869 Specifies whether a Kerberos TGT will be forwarded to the server.
870 This will only work if the Kerberos server is actually an AFS kaserver.
871 The argument to this keyword must be
876 Specifies that a TCP/IP port on the local machine be forwarded over
877 the secure channel to given host:port from the remote machine.
878 The first argument must be a port number, and the second must be
880 Multiple forwardings may be specified, and additional
881 forwardings can be given on the command line.
882 Only the superuser can forward privileged ports.
884 Gives the verbosity level that is used when logging messages from
886 The possible values are:
887 QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG.
890 Specifies the MAC (message authentication code) algorithms
891 in order of preference.
892 The MAC algorithm is used in protocol version 2
893 for data integrity protection.
894 Multiple algorithms must be comma-separated.
896 .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
897 .It Cm NumberOfPasswordPrompts
898 Specifies the number of password prompts before giving up.
899 The argument to this keyword must be an integer.
901 .It Cm PasswordAuthentication
902 Specifies whether to use password authentication.
903 The argument to this keyword must be
910 Specifies the port number to connect on the remote host.
912 .It Cm PreferredAuthentications
913 Specifies the order in which the client should try protocol 2
914 authentication methods. This allows a client to prefer one method (e.g.
915 .Cm keyboard-interactive )
916 over another method (e.g.
918 The default for this option is:
919 .Dq hostbased,publickey,keyboard-interactive,password
921 Specifies the protocol versions
923 should support in order of preference.
924 The possible values are
928 Multiple versions must be comma-separated.
933 tries version 2 and falls back to version 1
934 if version 2 is not available.
936 Specifies the command to use to connect to the server.
938 string extends to the end of the line, and is executed with
940 In the command string,
942 will be substituted by the host name to
946 The command can be basically anything,
947 and should read from its standard input and write to its standard output.
948 It should eventually connect an
950 server running on some machine, or execute
953 Host key management will be done using the
954 HostName of the host being connected (defaulting to the name typed by
958 is not available for connects with a proxy command.
960 .It Cm PubkeyAuthentication
961 Specifies whether to try public key authentication.
962 The argument to this keyword must be
968 This option applies to protocol version 2 only.
970 Specifies that a TCP/IP port on the remote machine be forwarded over
971 the secure channel to given host:port from the local machine.
972 The first argument must be a port number, and the second must be
974 Multiple forwardings may be specified, and additional
975 forwardings can be given on the command line.
976 Only the superuser can forward privileged ports.
977 .It Cm RhostsAuthentication
978 Specifies whether to try rhosts based authentication.
980 declaration only affects the client side and has no effect whatsoever
982 Disabling rhosts authentication may reduce
983 authentication time on slow connections when rhosts authentication is
985 Most servers do not permit RhostsAuthentication because it
987 .Cm RhostsRSAAuthentication ) .
988 The argument to this keyword must be
994 This option applies to protocol version 1 only.
995 .It Cm RhostsRSAAuthentication
996 Specifies whether to try rhosts based authentication with RSA host
1004 This option applies to protocol version 1 only.
1005 .It Cm RSAAuthentication
1006 Specifies whether to try RSA authentication.
1007 The argument to this keyword must be
1011 RSA authentication will only be
1012 attempted if the identity file exists, or an authentication agent is
1016 Note that this option applies to protocol version 1 only.
1017 .It Cm ChallengeResponseAuthentication
1018 Specifies whether to use challenge response authentication.
1019 The argument to this keyword must be
1025 .It Cm SmartcardDevice
1026 Specifies which smartcard device to use. The argument to this keyword is
1029 should use to communicate with a smartcard used for storing the user's
1030 private RSA key. By default, no device is specified and smartcard support
1032 .It Cm StrictHostKeyChecking
1033 If this flag is set to
1036 will never automatically add host keys to the
1037 .Pa $HOME/.ssh/known_hosts
1038 file, and refuses to connect to hosts whose host key has changed.
1039 This provides maximum protection against trojan horse attacks.
1040 However, it can be somewhat annoying if you don't have good
1041 .Pa /etc/ssh_known_hosts
1042 files installed and frequently
1043 connect to new hosts.
1044 This option forces the user to manually
1046 If this flag is set to
1049 will automatically add new host keys to the
1050 user known hosts files.
1051 If this flag is set to
1054 will be added to the user known host files only after the user
1055 has confirmed that is what they really want to do, and
1057 will refuse to connect to hosts whose host key has changed.
1059 known hosts will be verified automatically in all cases.
1060 The argument must be
1067 .It Cm UsePrivilegedPort
1068 Specifies whether to use a privileged port for outgoing connections.
1069 The argument must be
1075 Note that you need to set this option to
1078 .Cm RhostsAuthentication
1080 .Cm RhostsRSAAuthentication
1083 Specifies the user to log in as.
1084 This can be useful if you have a different user name on different machines.
1085 This saves the trouble of
1086 having to remember to give the user name on the command line.
1087 .It Cm UserKnownHostsFile
1088 Specifies a file to use for the user
1089 host key database instead of
1090 .Pa $HOME/.ssh/known_hosts .
1092 Specifies that rlogin/rsh should be used for this host.
1093 It is possible that the host does not at all support the
1098 to immediately execute
1100 All other options (except
1102 are ignored if this has been specified.
1103 The argument must be
1107 .It Cm XAuthLocation
1108 Specifies the location of the
1112 .Pa /usr/X11R6/bin/xauth .
1116 will normally set the following environment variables:
1121 variable indicates the location of the X11 server.
1122 It is automatically set by
1124 to point to a value of the form
1126 where hostname indicates
1127 the host where the shell runs, and n is an integer >= 1.
1129 uses this special value to forward X11 connections over the secure
1131 The user should normally not set
1134 will render the X11 connection insecure (and will require the user to
1135 manually copy any required authorization cookies).
1137 Set to the path of the user's home directory.
1141 set for compatibility with systems that use this variable.
1143 Set to point the user's mailbox.
1147 as specified when compiling
1152 needs a passphrase, it will read the passphrase from the current
1153 terminal if it was run from a terminal.
1156 does not have a terminal associated with it but
1160 are set, it will execute the program specified by
1162 and open an X11 window to read the passphrase.
1163 This is particularly useful when calling
1168 (Note that on some machines it
1169 may be necessary to redirect the input from
1172 .It Ev SSH_AUTH_SOCK
1173 indicates the path of a unix-domain socket used to communicate with the
1176 Identifies the client end of the connection.
1177 The variable contains
1178 three space-separated values: client ip-address, client port number,
1179 and server port number.
1180 .It Ev SSH_ORIGINAL_COMMAND
1181 The variable contains the original command line if a forced command
1183 It can be used to extract the original arguments.
1185 This is set to the name of the tty (path to the device) associated
1186 with the current shell or command.
1187 If the current session has no tty,
1188 this variable is not set.
1190 The timezone variable is set to indicate the present timezone if it
1191 was set when the daemon was started (i.e., the daemon passes the value
1192 on to new connections).
1194 Set to the name of the user logging in.
1200 .Pa $HOME/.ssh/environment ,
1201 and adds lines of the format
1206 .It Pa $HOME/.ssh/known_hosts
1207 Records host keys for all hosts the user has logged into (that are not
1209 .Pa /etc/ssh_known_hosts .
1212 .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa
1213 Contains the authentication identity of the user.
1214 They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively.
1216 contain sensitive data and should be readable by the user but not
1217 accessible by others (read/write/execute).
1220 ignores a private key file if it is accessible by others.
1221 It is possible to specify a passphrase when
1222 generating the key; the passphrase will be used to encrypt the
1223 sensitive part of this file using 3DES.
1224 .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub
1225 Contains the public key for authentication (public part of the
1226 identity file in human-readable form).
1228 .Pa $HOME/.ssh/identity.pub
1229 file should be added to
1230 .Pa $HOME/.ssh/authorized_keys
1232 where you wish to log in using protocol version 1 RSA authentication.
1234 .Pa $HOME/.ssh/id_dsa.pub
1236 .Pa $HOME/.ssh/id_rsa.pub
1237 file should be added to
1238 .Pa $HOME/.ssh/authorized_keys
1240 where you wish to log in using protocol version 2 DSA/RSA authentication.
1242 sensitive and can (but need not) be readable by anyone.
1244 never used automatically and are not necessary; they are only provided for
1245 the convenience of the user.
1246 .It Pa $HOME/.ssh/config
1247 This is the per-user configuration file.
1248 The format of this file is described above.
1249 This file is used by the
1252 This file does not usually contain any sensitive information,
1253 but the recommended permissions are read/write for the user, and not
1254 accessible by others.
1255 .It Pa $HOME/.ssh/authorized_keys
1256 Lists the public keys (RSA/DSA) that can be used for logging in as this user.
1257 The format of this file is described in the
1260 In the simplest form the format is the same as the .pub
1262 This file is not highly sensitive, but the recommended
1263 permissions are read/write for the user, and not accessible by others.
1264 .It Pa /etc/ssh_known_hosts
1265 Systemwide list of known host keys.
1266 This file should be prepared by the
1267 system administrator to contain the public host keys of all machines in the
1269 This file should be world-readable.
1271 public keys, one per line, in the following format (fields separated
1272 by spaces): system name, public key and optional comment field.
1273 When different names are used
1274 for the same machine, all such names should be listed, separated by
1276 The format is described on the
1280 The canonical system name (as returned by name servers) is used by
1282 to verify the client host when logging in; other names are needed because
1284 does not convert the user-supplied name to a canonical name before
1285 checking the key, because someone with access to the name servers
1286 would then be able to fool host authentication.
1287 .It Pa /etc/ssh_config
1288 Systemwide configuration file.
1289 This file provides defaults for those
1290 values that are not specified in the user's configuration file, and
1291 for those users who do not have a configuration file.
1292 This file must be world-readable.
1293 .It Pa $HOME/.rhosts
1294 This file is used in
1296 authentication to list the
1297 host/user pairs that are permitted to log in.
1298 (Note that this file is
1299 also used by rlogin and rsh, which makes using this file insecure.)
1300 Each line of the file contains a host name (in the canonical form
1301 returned by name servers), and then a user name on that host,
1302 separated by a space.
1303 On some machines this file may need to be
1304 world-readable if the user's home directory is on a NFS partition,
1308 Additionally, this file must be owned by the user,
1309 and must not have write permissions for anyone else.
1311 permission for most machines is read/write for the user, and not
1312 accessible by others.
1314 Note that by default
1316 will be installed so that it requires successful RSA host
1317 authentication before permitting \s+2.\s0rhosts authentication.
1318 If your server machine does not have the client's host key in
1319 .Pa /etc/ssh_known_hosts ,
1321 .Pa $HOME/.ssh/known_hosts .
1322 The easiest way to do this is to
1323 connect back to the client from the server machine using ssh; this
1324 will automatically add the host key to
1325 .Pa $HOME/.ssh/known_hosts .
1326 .It Pa $HOME/.shosts
1327 This file is used exactly the same way as
1330 having this file is to be able to use rhosts authentication with
1332 without permitting login with
1336 .It Pa /etc/hosts.equiv
1337 This file is used during
1338 .Pa \&.rhosts authentication.
1340 canonical hosts names, one per line (the full format is described on
1344 If the client host is found in this file, login is
1345 automatically permitted provided client and server user names are the
1347 Additionally, successful RSA host authentication is normally
1349 This file should only be writable by root.
1350 .It Pa /etc/shosts.equiv
1351 This file is processed exactly as
1352 .Pa /etc/hosts.equiv .
1353 This file may be useful to permit logins using
1355 but not using rsh/rlogin.
1357 Commands in this file are executed by
1359 when the user logs in just before the user's shell (or command) is started.
1362 manual page for more information.
1363 .It Pa $HOME/.ssh/rc
1364 Commands in this file are executed by
1366 when the user logs in just before the user's shell (or command) is
1370 manual page for more information.
1371 .It Pa $HOME/.ssh/environment
1372 Contains additional definitions for environment variables, see section
1377 OpenSSH is a derivative of the original and free
1378 ssh 1.2.12 release by Tatu Ylonen.
1379 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1380 Theo de Raadt and Dug Song
1381 removed many bugs, re-added newer features and
1383 Markus Friedl contributed the support for SSH
1384 protocol versions 1.5 and 2.0.
1401 .%T "SSH Protocol Architecture"
1402 .%N draft-ietf-secsh-architecture-07.txt
1404 .%O work in progress material
andersk / openssh.git / blob