Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1 | .\" -*- nroff -*- |
| 2 | .\" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 3 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 4 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 5 | .\" All rights reserved |
| 6 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 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". |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 12 | .\" |
Ben Lindstrom | 92a2e38 | 2001-03-05 06:59:27 +0000 | [diff] [blame] | 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. |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 16 | .\" |
| 17 | .\" Redistribution and use in source and binary forms, with or without |
| 18 | .\" modification, are permitted provided that the following conditions |
| 19 | .\" are met: |
| 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. |
| 25 | .\" |
| 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. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 36 | .\" |
Ben Lindstrom | ae996bf | 2001-08-06 21:27:53 +0000 | [diff] [blame^] | 37 | .\" $OpenBSD: ssh.1,v 1.125 2001/07/31 09:28:44 jakob Exp $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 38 | .Dd September 25, 1999 |
| 39 | .Dt SSH 1 |
| 40 | .Os |
| 41 | .Sh NAME |
| 42 | .Nm ssh |
Ben Lindstrom | d58eb5f | 2001-03-07 06:07:22 +0000 | [diff] [blame] | 43 | .Nd OpenSSH SSH client (remote login program) |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 44 | .Sh SYNOPSIS |
| 45 | .Nm ssh |
| 46 | .Op Fl l Ar login_name |
| 47 | .Op Ar hostname | user@hostname |
| 48 | .Op Ar command |
| 49 | .Pp |
| 50 | .Nm ssh |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 51 | .Op Fl afgknqstvxACNPTX1246 |
Ben Lindstrom | e0f8804 | 2001-04-30 13:06:24 +0000 | [diff] [blame] | 52 | .Op Fl b Ar bind_address |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 53 | .Op Fl c Ar cipher_spec |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 54 | .Op Fl e Ar escape_char |
| 55 | .Op Fl i Ar identity_file |
| 56 | .Op Fl l Ar login_name |
Ben Lindstrom | 06b33aa | 2001-02-15 03:01:59 +0000 | [diff] [blame] | 57 | .Op Fl m Ar mac_spec |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 58 | .Op Fl o Ar option |
| 59 | .Op Fl p Ar port |
| 60 | .Oo Fl L Xo |
| 61 | .Sm off |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 62 | .Ar port : |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 63 | .Ar host : |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 64 | .Ar hostport |
| 65 | .Sm on |
| 66 | .Xc |
| 67 | .Oc |
| 68 | .Oo Fl R Xo |
| 69 | .Sm off |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 70 | .Ar port : |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 71 | .Ar host : |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 72 | .Ar hostport |
| 73 | .Sm on |
| 74 | .Xc |
| 75 | .Oc |
| 76 | .Op Ar hostname | user@hostname |
| 77 | .Op Ar command |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 78 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 79 | .Nm |
Ben Lindstrom | d58eb5f | 2001-03-07 06:07:22 +0000 | [diff] [blame] | 80 | (SSH client) is a program for logging into a remote machine and for |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 81 | executing commands on a remote machine. |
| 82 | It is intended to replace |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 83 | rlogin and rsh, and provide secure encrypted communications between |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 84 | two untrusted hosts over an insecure network. |
| 85 | X11 connections and |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 86 | arbitrary TCP/IP ports can also be forwarded over the secure channel. |
| 87 | .Pp |
| 88 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 89 | connects and logs into the specified |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 90 | .Ar hostname . |
| 91 | The user must prove |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 92 | his/her identity to the remote machine using one of several methods |
| 93 | depending on the protocol version used: |
| 94 | .Pp |
| 95 | .Ss SSH protocol version 1 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 96 | .Pp |
| 97 | First, if the machine the user logs in from is listed in |
| 98 | .Pa /etc/hosts.equiv |
| 99 | or |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 100 | .Pa /etc/shosts.equiv |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 101 | on the remote machine, and the user names are |
| 102 | the same on both sides, the user is immediately permitted to log in. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 103 | Second, if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 104 | .Pa \&.rhosts |
| 105 | or |
| 106 | .Pa \&.shosts |
| 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 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 110 | permitted to log in. |
| 111 | This form of authentication alone is normally not |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 112 | allowed by the server because it is not secure. |
| 113 | .Pp |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 114 | The second authentication method is the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 115 | .Pa rhosts |
| 116 | or |
| 117 | .Pa hosts.equiv |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 118 | method combined with RSA-based host authentication. |
| 119 | It means that if the login would be permitted by |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 120 | .Pa $HOME/.rhosts , |
| 121 | .Pa $HOME/.shosts , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 122 | .Pa /etc/hosts.equiv , |
| 123 | or |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 124 | .Pa /etc/shosts.equiv , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 125 | and if additionally the server can verify the client's |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 126 | host key (see |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 127 | .Pa /etc/ssh_known_hosts |
Damien Miller | 33e511e | 1999-11-11 11:43:13 +1100 | [diff] [blame] | 128 | and |
| 129 | .Pa $HOME/.ssh/known_hosts |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 130 | in the |
| 131 | .Sx FILES |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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: |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 136 | .Pa /etc/hosts.equiv , |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 137 | .Pa $HOME/.rhosts , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 138 | and the rlogin/rsh protocol in general, are inherently insecure and should be |
| 139 | disabled if security is desired.] |
| 140 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 141 | As a third authentication method, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 142 | .Nm |
| 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. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 147 | RSA is one such system. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 148 | The idea is that each user creates a public/private |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 149 | key pair for authentication purposes. |
| 150 | The server knows the public key, and only the user knows the private key. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 151 | The file |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 152 | .Pa $HOME/.ssh/authorized_keys |
| 153 | lists the public keys that are permitted for logging |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 154 | in. |
| 155 | When the user logs in, the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 156 | .Nm |
| 157 | program tells the server which key pair it would like to use for |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 158 | authentication. |
| 159 | The server checks if this key is permitted, and if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 160 | so, sends the user (actually the |
| 161 | .Nm |
| 162 | program running on behalf of the user) a challenge, a random number, |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 167 | challenge using the private key, proving that he/she knows the private |
| 168 | key but without disclosing it to the server. |
| 169 | .Pp |
| 170 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 171 | implements the RSA authentication protocol automatically. |
| 172 | The user creates his/her RSA key pair by running |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 173 | .Xr ssh-keygen 1 . |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 174 | This stores the private key in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 175 | .Pa $HOME/.ssh/identity |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 176 | and the public key in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 177 | .Pa $HOME/.ssh/identity.pub |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 178 | in the user's home directory. |
| 179 | The user should then copy the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 180 | .Pa identity.pub |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 181 | to |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 182 | .Pa $HOME/.ssh/authorized_keys |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 183 | in his/her home directory on the remote machine (the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 184 | .Pa authorized_keys |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 185 | file corresponds to the conventional |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 186 | .Pa $HOME/.rhosts |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 187 | file, and has one key |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 191 | more secure than rhosts authentication. |
| 192 | .Pp |
| 193 | The most convenient way to use RSA authentication may be with an |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 194 | authentication agent. |
| 195 | See |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 196 | .Xr ssh-agent 1 |
| 197 | for more information. |
| 198 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 199 | If other authentication methods fail, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 200 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 201 | prompts the user for a password. |
| 202 | The password is sent to the remote |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 203 | host for checking; however, since all communications are encrypted, |
| 204 | the password cannot be seen by someone listening on the network. |
| 205 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 206 | .Ss SSH protocol version 2 |
| 207 | .Pp |
| 208 | When a user connects using the protocol version 2 |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 209 | different authentication methods are available. |
| 210 | Using the default values for |
| 211 | .Cm PreferredAuthentications , |
Ben Lindstrom | a9086a1 | 2001-08-06 20:58:51 +0000 | [diff] [blame] | 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. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 216 | .Pp |
| 217 | The public key method is similar to RSA authentication described |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 218 | in the previous section and allows the RSA or DSA algorithm to be used: |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 219 | The client uses his private key, |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 220 | .Pa $HOME/.ssh/id_dsa |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 221 | or |
| 222 | .Pa $HOME/.ssh/id_rsa , |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 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 |
Ben Lindstrom | f96704d | 2001-06-25 04:17:12 +0000 | [diff] [blame] | 225 | .Pa $HOME/.ssh/authorized_keys |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 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. |
| 229 | .Pp |
| 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. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 232 | .Pp |
| 233 | Additionally, |
| 234 | .Nm |
| 235 | supports hostbased or challenge response authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 236 | .Pp |
| 237 | Protocol 2 provides additional mechanisms for confidentiality |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 238 | (the traffic is encrypted using 3DES, Blowfish, CAST128 or Arcfour) |
Ben Lindstrom | ec26fb1 | 2001-03-06 01:05:23 +0000 | [diff] [blame] | 239 | and integrity (hmac-md5, hmac-sha1). |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 240 | Note that protocol 1 lacks a strong mechanism for ensuring the |
| 241 | integrity of the connection. |
| 242 | .Pp |
| 243 | .Ss Login session and remote execution |
| 244 | .Pp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 247 | the user a normal shell on the remote machine. |
| 248 | All communication with |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 249 | the remote command or shell will be automatically encrypted. |
| 250 | .Pp |
| 251 | If a pseudo-terminal has been allocated (normal login session), the |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 252 | user may use the escape characters noted below. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 253 | .Pp |
| 254 | If no pseudo tty has been allocated, the |
| 255 | session is transparent and can be used to reliably transfer binary |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 256 | data. |
| 257 | On most systems, setting the escape character to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 258 | .Dq none |
| 259 | will also make the session transparent even if a tty is used. |
| 260 | .Pp |
Ben Lindstrom | a688561 | 2000-12-09 03:45:32 +0000 | [diff] [blame] | 261 | The session terminates when the command or shell on the remote |
Ben Lindstrom | ebd888d | 2001-03-05 05:49:29 +0000 | [diff] [blame] | 262 | machine exits and all X11 and TCP/IP connections have been closed. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 263 | The exit status of the remote program is returned as the exit status |
| 264 | of |
| 265 | .Nm ssh . |
| 266 | .Pp |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 267 | .Ss Escape Characters |
| 268 | .Pp |
| 269 | When a pseudo terminal has been requested, ssh supports a number of functions |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 270 | through the use of an escape character. |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 271 | .Pp |
| 272 | A single tilde character can be sent as |
| 273 | .Ic ~~ |
Ben Lindstrom | 6600769 | 2001-07-22 20:41:59 +0000 | [diff] [blame] | 274 | or by following the tilde by a character other than those described below. |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 275 | The escape character must always follow a newline to be interpreted as |
| 276 | special. |
| 277 | The escape character can be changed in configuration files using the |
| 278 | .Cm EscapeChar |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 279 | configuration directive or on the command line by the |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 280 | .Fl e |
| 281 | option. |
| 282 | .Pp |
| 283 | The supported escapes (assuming the default |
| 284 | .Ql ~ ) |
| 285 | are: |
| 286 | .Bl -tag -width Ds |
| 287 | .It Cm ~. |
| 288 | Disconnect |
| 289 | .It Cm ~^Z |
| 290 | Background ssh |
| 291 | .It Cm ~# |
| 292 | List forwarded connections |
| 293 | .It Cm ~& |
| 294 | Background ssh at logout when waiting for forwarded connection / X11 sessions |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 295 | to terminate (protocol version 1 only) |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 296 | .It Cm ~? |
| 297 | Display a list of escape characters |
| 298 | .It Cm ~R |
Ben Lindstrom | f8d2457 | 2001-04-22 17:11:56 +0000 | [diff] [blame] | 299 | Request rekeying of the connection (only useful for SSH protocol version 2 |
| 300 | and if the peer supports it) |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 301 | .El |
| 302 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 303 | .Ss X11 and TCP forwarding |
| 304 | .Pp |
Ben Lindstrom | 7121507 | 2001-05-17 03:16:18 +0000 | [diff] [blame] | 305 | If the |
| 306 | .Cm ForwardX11 |
| 307 | variable is set to |
| 308 | .Dq yes |
| 309 | (or, see the description of the |
| 310 | .Fl X |
| 311 | and |
| 312 | .Fl x |
| 313 | options described later) |
| 314 | and the user is using X11 (the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 315 | .Ev DISPLAY |
| 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 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 320 | from the local machine. |
| 321 | The user should not manually set |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 322 | .Ev DISPLAY . |
| 323 | Forwarding of X11 connections can be |
| 324 | configured on the command line or in configuration files. |
| 325 | .Pp |
| 326 | The |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 327 | .Ev DISPLAY |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 328 | value set by |
| 329 | .Nm |
| 330 | will point to the server machine, but with a display number greater |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 331 | than zero. |
| 332 | This is normal, and happens because |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 333 | .Nm |
| 334 | creates a |
| 335 | .Dq proxy |
| 336 | X server on the server machine for forwarding the |
| 337 | connections over the encrypted channel. |
| 338 | .Pp |
| 339 | .Nm |
| 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 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 344 | the connection is opened. |
| 345 | The real authentication cookie is never |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 346 | sent to the server machine (and no cookies are sent in the plain). |
| 347 | .Pp |
| 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 |
Ben Lindstrom | 979c981 | 2001-07-22 20:45:39 +0000 | [diff] [blame] | 350 | the command line or in a configuration file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 351 | .Pp |
| 352 | Forwarding of arbitrary TCP/IP connections over the secure channel can |
Ben Lindstrom | 979c981 | 2001-07-22 20:45:39 +0000 | [diff] [blame] | 353 | be specified either on the command line or in a configuration file. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 354 | One possible application of TCP/IP forwarding is a secure connection to an |
Ben Lindstrom | ebd888d | 2001-03-05 05:49:29 +0000 | [diff] [blame] | 355 | electronic purse; another is going through firewalls. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 356 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 357 | .Ss Server authentication |
| 358 | .Pp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 359 | .Nm |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 360 | automatically maintains and checks a database containing |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 361 | identifications for all hosts it has ever been used with. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 362 | Host keys are stored in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 363 | .Pa $HOME/.ssh/known_hosts |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 364 | in the user's home directory. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 365 | Additionally, the file |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 366 | .Pa /etc/ssh_known_hosts |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 367 | is automatically checked for known hosts. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 368 | Any new hosts are automatically added to the user's file. |
| 369 | If a host's identification |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 370 | ever changes, |
| 371 | .Nm |
| 372 | warns about this and disables password authentication to prevent a |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 373 | trojan horse from getting the user's password. |
| 374 | Another purpose of |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 375 | this mechanism is to prevent man-in-the-middle attacks which could |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 376 | otherwise be used to circumvent the encryption. |
| 377 | The |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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. |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 381 | .Pp |
| 382 | The options are as follows: |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 383 | .Bl -tag -width Ds |
| 384 | .It Fl a |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 385 | Disables forwarding of the authentication agent connection. |
Damien Miller | b1715dc | 2000-05-30 13:44:51 +1000 | [diff] [blame] | 386 | .It Fl A |
| 387 | Enables forwarding of the authentication agent connection. |
| 388 | This can also be specified on a per-host basis in a configuration file. |
Ben Lindstrom | e0f8804 | 2001-04-30 13:06:24 +0000 | [diff] [blame] | 389 | .It Fl b Ar bind_address |
| 390 | Specify the interface to transmit from on machines with multiple |
| 391 | interfaces or aliased addresses. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 392 | .It Fl c Ar blowfish|3des |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 393 | Selects the cipher to use for encrypting the session. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 394 | .Ar 3des |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 395 | is used by default. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 396 | It is believed to be secure. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 397 | .Ar 3des |
| 398 | (triple-des) is an encrypt-decrypt-encrypt triple with three different keys. |
| 399 | It is presumably more secure than the |
| 400 | .Ar des |
Damien Miller | 69b69aa | 2000-10-28 14:19:58 +1100 | [diff] [blame] | 401 | cipher which is no longer fully supported in |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 402 | .Nm ssh . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 403 | .Ar blowfish |
| 404 | is a fast block cipher, it appears very secure and is much faster than |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 405 | .Ar 3des . |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 406 | .It Fl c Ar cipher_spec |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 407 | Additionally, for protocol version 2 a comma-separated list of ciphers can |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 408 | be specified in order of preference. |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 409 | See |
| 410 | .Cm Ciphers |
| 411 | for more information. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 412 | .It Fl e Ar ch|^ch|none |
| 413 | Sets the escape character for sessions with a pty (default: |
| 414 | .Ql ~ ) . |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 415 | The escape character is only recognized at the beginning of a line. |
| 416 | The escape character followed by a dot |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 417 | .Pq Ql \&. |
| 418 | closes the connection, followed |
| 419 | by control-Z suspends the connection, and followed by itself sends the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 420 | escape character once. |
| 421 | Setting the character to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 422 | .Dq none |
| 423 | disables any escapes and makes the session fully transparent. |
| 424 | .It Fl f |
| 425 | Requests |
| 426 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 427 | to go to background just before command execution. |
| 428 | This is useful if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 429 | .Nm |
| 430 | is going to ask for passwords or passphrases, but the user |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 431 | wants it in the background. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 432 | This implies |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 433 | .Fl n . |
| 434 | The recommended way to start X11 programs at a remote site is with |
| 435 | something like |
| 436 | .Ic ssh -f host xterm . |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 437 | .It Fl g |
| 438 | Allows remote hosts to connect to local forwarded ports. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 439 | .It Fl i Ar identity_file |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 440 | Selects the file from which the identity (private key) for |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 441 | RSA or DSA authentication is read. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 442 | Default is |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 443 | .Pa $HOME/.ssh/identity |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 448 | .Fl i |
| 449 | options (and multiple identities specified in |
| 450 | configuration files). |
Ben Lindstrom | ae996bf | 2001-08-06 21:27:53 +0000 | [diff] [blame^] | 451 | .It Fl I Ar smartcard_device |
| 452 | Specifies which smartcard device to use. The argument is |
| 453 | the device |
| 454 | .Nm |
| 455 | should use to communicate with a smartcard used for storing the user's |
| 456 | private RSA key. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 457 | .It Fl k |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 458 | Disables forwarding of Kerberos tickets and AFS tokens. |
| 459 | This may also be specified on a per-host basis in the configuration file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 460 | .It Fl l Ar login_name |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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. |
Ben Lindstrom | 06b33aa | 2001-02-15 03:01:59 +0000 | [diff] [blame] | 463 | .It Fl m Ar mac_spec |
| 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. |
| 467 | See the |
| 468 | .Cm MACs |
| 469 | keyword for more information. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 470 | .It Fl n |
| 471 | Redirects stdin from |
| 472 | .Pa /dev/null |
| 473 | (actually, prevents reading from stdin). |
| 474 | This must be used when |
| 475 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 476 | is run in the background. |
| 477 | A common trick is to use this to run X11 programs on a remote machine. |
| 478 | For example, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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. |
| 482 | The |
| 483 | .Nm |
| 484 | program will be put in the background. |
| 485 | (This does not work if |
| 486 | .Nm |
| 487 | needs to ask for a password or passphrase; see also the |
| 488 | .Fl f |
| 489 | option.) |
Damien Miller | dcb6ecd | 2000-05-17 22:34:22 +1000 | [diff] [blame] | 490 | .It Fl N |
| 491 | Do not execute a remote command. |
Ben Lindstrom | c72745a | 2000-12-02 19:03:54 +0000 | [diff] [blame] | 492 | This is useful if you just want to forward ports |
Damien Miller | dcb6ecd | 2000-05-17 22:34:22 +1000 | [diff] [blame] | 493 | (protocol version 2 only). |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 494 | .It Fl o Ar option |
| 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 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 497 | command-line flag. |
| 498 | The option has the same format as a line in the configuration file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 499 | .It Fl p Ar port |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 500 | Port to connect to on the remote host. |
| 501 | This can be specified on a |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 502 | per-host basis in the configuration file. |
| 503 | .It Fl P |
| 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. |
Damien Miller | a34a28b | 1999-12-14 10:47:15 +1100 | [diff] [blame] | 507 | Note that this option turns off |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 508 | .Cm RhostsAuthentication |
| 509 | and |
Kevin Steves | fcec7f8 | 2000-12-15 19:55:48 +0000 | [diff] [blame] | 510 | .Cm RhostsRSAAuthentication |
| 511 | for older servers. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 512 | .It Fl q |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 513 | Quiet mode. |
| 514 | Causes all warning and diagnostic messages to be suppressed. |
| 515 | Only fatal errors are displayed. |
Damien Miller | 832562e | 2001-01-30 09:30:01 +1100 | [diff] [blame] | 516 | .It Fl s |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 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 |
Damien Miller | 832562e | 2001-01-30 09:30:01 +1100 | [diff] [blame] | 519 | subsystem is specified as the remote command. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 520 | .It Fl t |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 521 | Force pseudo-tty allocation. |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 522 | This can be used to execute arbitrary |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 523 | screen-based programs on a remote machine, which can be very useful, |
| 524 | e.g., when implementing menu services. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 525 | Multiple |
| 526 | .Fl t |
| 527 | options force tty allocation, even if |
| 528 | .Nm |
| 529 | has no local tty. |
Damien Miller | dcb6ecd | 2000-05-17 22:34:22 +1000 | [diff] [blame] | 530 | .It Fl T |
Ben Lindstrom | c72745a | 2000-12-02 19:03:54 +0000 | [diff] [blame] | 531 | Disable pseudo-tty allocation. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 532 | .It Fl v |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 533 | Verbose mode. |
| 534 | Causes |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 535 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 536 | to print debugging messages about its progress. |
| 537 | This is helpful in |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 538 | debugging connection, authentication, and configuration problems. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 539 | Multiple |
| 540 | .Fl v |
| 541 | options increases the verbosity. |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 542 | Maximum is 3. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 543 | .It Fl x |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 544 | Disables X11 forwarding. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 545 | .It Fl X |
| 546 | Enables X11 forwarding. |
Damien Miller | b1715dc | 2000-05-30 13:44:51 +1000 | [diff] [blame] | 547 | This can also be specified on a per-host basis in a configuration file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 548 | .It Fl C |
| 549 | Requests compression of all data (including stdin, stdout, stderr, and |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 550 | data for forwarded X11 and TCP/IP connections). |
| 551 | The compression algorithm is the same used by |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 552 | .Xr gzip 1 , |
| 553 | and the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 554 | .Dq level |
| 555 | can be controlled by the |
| 556 | .Cm CompressionLevel |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 557 | option (see below). |
| 558 | Compression is desirable on modem lines and other |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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 |
Ben Lindstrom | e2b9b06 | 2001-08-06 20:50:55 +0000 | [diff] [blame] | 562 | .Cm Compression |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 563 | option below. |
| 564 | .It Fl L Ar port:host:hostport |
| 565 | Specifies that the given port on the local (client) host is to be |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 566 | forwarded to the given host and port on the remote side. |
| 567 | This works by allocating a socket to listen to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 568 | .Ar port |
| 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 |
| 571 | made to |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 572 | .Ar host |
| 573 | port |
| 574 | .Ar hostport |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 575 | from the remote machine. |
| 576 | Port forwardings can also be specified in the configuration file. |
| 577 | Only root can forward privileged ports. |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 578 | IPv6 addresses can be specified with an alternative syntax: |
| 579 | .Ar port/host/hostport |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 580 | .It Fl R Ar port:host:hostport |
| 581 | Specifies that the given port on the remote (server) host is to be |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 582 | forwarded to the given host and port on the local side. |
| 583 | This works by allocating a socket to listen to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 584 | .Ar port |
| 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 |
| 587 | made to |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 588 | .Ar host |
| 589 | port |
| 590 | .Ar hostport |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 591 | from the local machine. |
| 592 | Port forwardings can also be specified in the configuration file. |
| 593 | Privileged ports can be forwarded only when |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 594 | logging in as root on the remote machine. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 595 | IPv6 addresses can be specified with an alternative syntax: |
| 596 | .Ar port/host/hostport |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 597 | .It Fl 1 |
| 598 | Forces |
| 599 | .Nm |
| 600 | to try protocol version 1 only. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 601 | .It Fl 2 |
| 602 | Forces |
| 603 | .Nm |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 604 | to try protocol version 2 only. |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 605 | .It Fl 4 |
| 606 | Forces |
| 607 | .Nm |
| 608 | to use IPv4 addresses only. |
| 609 | .It Fl 6 |
| 610 | Forces |
| 611 | .Nm |
| 612 | to use IPv6 addresses only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 613 | .El |
| 614 | .Sh CONFIGURATION FILES |
| 615 | .Nm |
| 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 |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 620 | .Pq Pa /etc/ssh_config . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 621 | For each parameter, the first obtained value |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 622 | will be used. |
| 623 | The configuration files contain sections bracketed by |
| 624 | .Dq Host |
| 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. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 628 | .Pp |
| 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. |
| 632 | .Pp |
| 633 | The configuration file has the following format: |
| 634 | .Pp |
| 635 | Empty lines and lines starting with |
| 636 | .Ql # |
| 637 | are comments. |
| 638 | .Pp |
| 639 | Otherwise a line is of the format |
| 640 | .Dq keyword arguments . |
| 641 | The possible |
| 642 | keywords and their meanings are as follows (note that the |
| 643 | configuration files are case-sensitive): |
| 644 | .Bl -tag -width Ds |
| 645 | .It Cm Host |
| 646 | Restricts the following declarations (up to the next |
| 647 | .Cm Host |
| 648 | keyword) to be only for those hosts that match one of the patterns |
| 649 | given after the keyword. |
| 650 | .Ql \&* |
| 651 | and |
| 652 | .Ql ? |
| 653 | can be used as wildcards in the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 654 | patterns. |
| 655 | A single |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 656 | .Ql \&* |
| 657 | as a pattern can be used to provide global |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 658 | defaults for all hosts. |
| 659 | The host is the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 660 | .Ar hostname |
| 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 |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 664 | Specifies whether to pass AFS tokens to remote host. |
| 665 | The argument to this keyword must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 666 | .Dq yes |
| 667 | or |
| 668 | .Dq no . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 669 | This option applies to protocol version 1 only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 670 | .It Cm BatchMode |
| 671 | If set to |
| 672 | .Dq yes , |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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. |
| 676 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 677 | .Dq yes |
| 678 | or |
| 679 | .Dq no . |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 680 | The default is |
| 681 | .Dq no . |
Ben Lindstrom | e0f8804 | 2001-04-30 13:06:24 +0000 | [diff] [blame] | 682 | .It Cm BindAddress |
| 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 |
| 687 | is set to |
| 688 | .Dq yes . |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 689 | .It Cm CheckHostIP |
| 690 | If this flag is set to |
| 691 | .Dq yes , |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 692 | ssh will additionally check the host IP address in the |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 693 | .Pa known_hosts |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 694 | file. |
| 695 | This allows ssh to detect if a host key changed due to DNS spoofing. |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 696 | If the option is set to |
| 697 | .Dq no , |
| 698 | the check will not be executed. |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 699 | The default is |
| 700 | .Dq yes . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 701 | .It Cm Cipher |
Damien Miller | 50a41ed | 2000-10-16 12:14:42 +1100 | [diff] [blame] | 702 | Specifies the cipher to use for encrypting the session |
Damien Miller | 69b69aa | 2000-10-28 14:19:58 +1100 | [diff] [blame] | 703 | in protocol version 1. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 704 | Currently, |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 705 | .Dq blowfish |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 706 | and |
| 707 | .Dq 3des |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 708 | are supported. |
| 709 | The default is |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 710 | .Dq 3des . |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 711 | .It Cm Ciphers |
| 712 | Specifies the ciphers allowed for protocol version 2 |
| 713 | in order of preference. |
| 714 | Multiple ciphers must be comma-separated. |
| 715 | The default is |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 716 | .Pp |
| 717 | .Bd -literal |
Ben Lindstrom | ec26fb1 | 2001-03-06 01:05:23 +0000 | [diff] [blame] | 718 | ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour, |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 719 | aes192-cbc,aes256-cbc'' |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 720 | .Ed |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 721 | .It Cm Compression |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 722 | Specifies whether to use compression. |
| 723 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 724 | .Dq yes |
| 725 | or |
| 726 | .Dq no . |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 727 | The default is |
| 728 | .Dq no . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 729 | .It Cm CompressionLevel |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 730 | Specifies the compression level to use if compression is enabled. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 734 | .Xr gzip 1 . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 735 | Note that this option applies to protocol version 1 only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 736 | .It Cm ConnectionAttempts |
| 737 | Specifies the number of tries (one per second) to make before falling |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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. |
Ben Lindstrom | f9cedb9 | 2001-08-06 21:07:11 +0000 | [diff] [blame] | 741 | The default is 1. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 742 | .It Cm EscapeChar |
| 743 | Sets the escape character (default: |
| 744 | .Ql ~ ) . |
| 745 | The escape character can also |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 746 | be set on the command line. |
| 747 | The argument should be a single character, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 748 | .Ql ^ |
| 749 | followed by a letter, or |
| 750 | .Dq none |
| 751 | to disable the escape |
| 752 | character entirely (making the connection transparent for binary |
| 753 | data). |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 754 | .It Cm FallBackToRsh |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 755 | Specifies that if connecting via |
| 756 | .Nm |
| 757 | fails due to a connection refused error (there is no |
| 758 | .Xr sshd 8 |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 759 | listening on the remote host), |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 760 | .Xr rsh 1 |
| 761 | should automatically be used instead (after a suitable warning about |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 762 | the session being unencrypted). |
| 763 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 764 | .Dq yes |
| 765 | or |
| 766 | .Dq no . |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 767 | The default is |
| 768 | .Dq no . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 769 | .It Cm ForwardAgent |
| 770 | Specifies whether the connection to the authentication agent (if any) |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 771 | will be forwarded to the remote machine. |
| 772 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 773 | .Dq yes |
| 774 | or |
| 775 | .Dq no . |
Damien Miller | b1715dc | 2000-05-30 13:44:51 +1000 | [diff] [blame] | 776 | The default is |
| 777 | .Dq no . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 778 | .It Cm ForwardX11 |
| 779 | Specifies whether X11 connections will be automatically redirected |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 780 | over the secure channel and |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 781 | .Ev DISPLAY |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 782 | set. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 783 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 784 | .Dq yes |
| 785 | or |
| 786 | .Dq no . |
Damien Miller | 98c7ad6 | 2000-03-09 21:27:49 +1100 | [diff] [blame] | 787 | The default is |
| 788 | .Dq no . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 789 | .It Cm GatewayPorts |
| 790 | Specifies whether remote hosts are allowed to connect to local |
| 791 | forwarded ports. |
| 792 | The argument must be |
| 793 | .Dq yes |
| 794 | or |
| 795 | .Dq no . |
| 796 | The default is |
| 797 | .Dq no . |
| 798 | .It Cm GlobalKnownHostsFile |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 799 | Specifies a file to use for the global |
Ben Lindstrom | 1e62174 | 2001-03-06 01:10:53 +0000 | [diff] [blame] | 800 | host key database instead of |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 801 | .Pa /etc/ssh_known_hosts . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 802 | .It Cm HostbasedAuthentication |
| 803 | Specifies whether to try rhosts based authentication with public key |
| 804 | authentication. |
| 805 | The argument must be |
| 806 | .Dq yes |
| 807 | or |
| 808 | .Dq no . |
| 809 | The default is |
Ben Lindstrom | 1bfe291 | 2001-06-05 19:37:25 +0000 | [diff] [blame] | 810 | .Dq no . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 811 | This option applies to protocol version 2 only and |
| 812 | is similar to |
| 813 | .Cm RhostsRSAAuthentication . |
Ben Lindstrom | 982dbbc | 2001-04-17 18:11:36 +0000 | [diff] [blame] | 814 | .It Cm HostKeyAlgorithms |
Ben Lindstrom | f0609f8 | 2001-05-04 22:38:43 +0000 | [diff] [blame] | 815 | Specifies the protocol version 2 host key algorithms |
Ben Lindstrom | 982dbbc | 2001-04-17 18:11:36 +0000 | [diff] [blame] | 816 | that the client wants to use in order of preference. |
| 817 | The default for this option is: |
| 818 | .Dq ssh-rsa,ssh-dss |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 819 | .It Cm HostKeyAlias |
| 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. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 825 | .It Cm HostName |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 830 | .Cm HostName |
| 831 | specifications). |
| 832 | .It Cm IdentityFile |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 833 | Specifies the file from which the user's RSA or DSA authentication identity |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 834 | is read (default |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 835 | .Pa $HOME/.ssh/identity |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 836 | in the user's home directory). |
| 837 | Additionally, any identities represented by the authentication agent |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 842 | multiple identity files specified in configuration files; all these |
| 843 | identities will be tried in sequence. |
| 844 | .It Cm KeepAlive |
| 845 | Specifies whether the system should send keepalive messages to the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 846 | other side. |
| 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 850 | connections will die if the route is down temporarily, and some people |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 851 | find it annoying. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 852 | .Pp |
| 853 | The default is |
| 854 | .Dq yes |
| 855 | (to send keepalives), and the client will notice |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 856 | if the network goes down or the remote host dies. |
| 857 | This is important in scripts, and many users want it too. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 858 | .Pp |
| 859 | To disable keepalives, the value should be set to |
| 860 | .Dq no |
| 861 | in both the server and the client configuration files. |
| 862 | .It Cm KerberosAuthentication |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 863 | Specifies whether Kerberos authentication will be used. |
| 864 | The argument to this keyword must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 865 | .Dq yes |
| 866 | or |
| 867 | .Dq no . |
| 868 | .It Cm KerberosTgtPassing |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 872 | .Dq yes |
| 873 | or |
| 874 | .Dq no . |
| 875 | .It Cm LocalForward |
| 876 | Specifies that a TCP/IP port on the local machine be forwarded over |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
| 879 | host:port. |
| 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. |
Damien Miller | 5ce662a | 1999-11-11 17:57:39 +1100 | [diff] [blame] | 883 | .It Cm LogLevel |
| 884 | Gives the verbosity level that is used when logging messages from |
| 885 | .Nm ssh . |
| 886 | The possible values are: |
Ben Lindstrom | db65e8f | 2001-01-19 04:26:52 +0000 | [diff] [blame] | 887 | QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG. |
| 888 | The default is INFO. |
Ben Lindstrom | 06b33aa | 2001-02-15 03:01:59 +0000 | [diff] [blame] | 889 | .It Cm MACs |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 890 | Specifies the MAC (message authentication code) algorithms |
Ben Lindstrom | 06b33aa | 2001-02-15 03:01:59 +0000 | [diff] [blame] | 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. |
| 895 | The default is |
Ben Lindstrom | bd0e2de | 2001-06-05 19:52:52 +0000 | [diff] [blame] | 896 | .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 897 | .It Cm NumberOfPasswordPrompts |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 898 | Specifies the number of password prompts before giving up. |
| 899 | The argument to this keyword must be an integer. |
| 900 | Default is 3. |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 901 | .It Cm PasswordAuthentication |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 902 | Specifies whether to use password authentication. |
| 903 | The argument to this keyword must be |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 904 | .Dq yes |
| 905 | or |
| 906 | .Dq no . |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 907 | The default is |
| 908 | .Dq yes . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 909 | .It Cm Port |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 910 | Specifies the port number to connect on the remote host. |
| 911 | Default is 22. |
Damien Miller | 1e42f30 | 2001-03-19 23:59:11 +1100 | [diff] [blame] | 912 | .It Cm PreferredAuthentications |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 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. |
Damien Miller | 1e42f30 | 2001-03-19 23:59:11 +1100 | [diff] [blame] | 915 | .Cm keyboard-interactive ) |
| 916 | over another method (e.g. |
| 917 | .Cm password ) |
| 918 | The default for this option is: |
Ben Lindstrom | a9086a1 | 2001-08-06 20:58:51 +0000 | [diff] [blame] | 919 | .Dq hostbased,publickey,keyboard-interactive,password |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 920 | .It Cm Protocol |
| 921 | Specifies the protocol versions |
| 922 | .Nm |
| 923 | should support in order of preference. |
| 924 | The possible values are |
| 925 | .Dq 1 |
| 926 | and |
| 927 | .Dq 2 . |
| 928 | Multiple versions must be comma-separated. |
| 929 | The default is |
Ben Lindstrom | f327235 | 2001-04-05 23:29:59 +0000 | [diff] [blame] | 930 | .Dq 2,1 . |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 931 | This means that |
| 932 | .Nm |
Ben Lindstrom | f327235 | 2001-04-05 23:29:59 +0000 | [diff] [blame] | 933 | tries version 2 and falls back to version 1 |
| 934 | if version 2 is not available. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 935 | .It Cm ProxyCommand |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 936 | Specifies the command to use to connect to the server. |
| 937 | The command |
| 938 | string extends to the end of the line, and is executed with |
| 939 | .Pa /bin/sh . |
| 940 | In the command string, |
| 941 | .Ql %h |
| 942 | will be substituted by the host name to |
| 943 | connect and |
| 944 | .Ql %p |
| 945 | by the port. |
| 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 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 949 | .Xr sshd 8 |
| 950 | server running on some machine, or execute |
| 951 | .Ic sshd -i |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 952 | somewhere. |
| 953 | Host key management will be done using the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 954 | HostName of the host being connected (defaulting to the name typed by |
| 955 | the user). |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 956 | Note that |
| 957 | .Cm CheckHostIP |
| 958 | is not available for connects with a proxy command. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 959 | .Pp |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 960 | .It Cm PubkeyAuthentication |
| 961 | Specifies whether to try public key authentication. |
| 962 | The argument to this keyword must be |
| 963 | .Dq yes |
| 964 | or |
| 965 | .Dq no . |
| 966 | The default is |
| 967 | .Dq yes . |
| 968 | This option applies to protocol version 2 only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 969 | .It Cm RemoteForward |
| 970 | Specifies that a TCP/IP port on the remote machine be forwarded over |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
| 973 | host:port. |
| 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. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 977 | .It Cm RhostsAuthentication |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 978 | Specifies whether to try rhosts based authentication. |
| 979 | Note that this |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 980 | declaration only affects the client side and has no effect whatsoever |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 981 | on security. |
| 982 | Disabling rhosts authentication may reduce |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 983 | authentication time on slow connections when rhosts authentication is |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 984 | not used. |
| 985 | Most servers do not permit RhostsAuthentication because it |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 986 | is not secure (see |
Ben Lindstrom | d2bf0d6 | 2001-06-25 04:10:54 +0000 | [diff] [blame] | 987 | .Cm RhostsRSAAuthentication ) . |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 988 | The argument to this keyword must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 989 | .Dq yes |
| 990 | or |
| 991 | .Dq no . |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 992 | The default is |
| 993 | .Dq yes . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 994 | This option applies to protocol version 1 only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 995 | .It Cm RhostsRSAAuthentication |
| 996 | Specifies whether to try rhosts based authentication with RSA host |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 997 | authentication. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 998 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 999 | .Dq yes |
| 1000 | or |
| 1001 | .Dq no . |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 1002 | The default is |
| 1003 | .Dq yes . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 1004 | This option applies to protocol version 1 only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1005 | .It Cm RSAAuthentication |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1006 | Specifies whether to try RSA authentication. |
| 1007 | The argument to this keyword must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1008 | .Dq yes |
| 1009 | or |
| 1010 | .Dq no . |
| 1011 | RSA authentication will only be |
| 1012 | attempted if the identity file exists, or an authentication agent is |
| 1013 | running. |
Ben Lindstrom | 89b0bd6 | 2001-03-29 00:27:11 +0000 | [diff] [blame] | 1014 | The default is |
| 1015 | .Dq yes . |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1016 | Note that this option applies to protocol version 1 only. |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 1017 | .It Cm ChallengeResponseAuthentication |
| 1018 | Specifies whether to use challenge response authentication. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1019 | The argument to this keyword must be |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 1020 | .Dq yes |
| 1021 | or |
| 1022 | .Dq no . |
| 1023 | The default is |
Ben Lindstrom | 0076d75 | 2001-08-06 20:53:26 +0000 | [diff] [blame] | 1024 | .Dq yes . |
Ben Lindstrom | ae996bf | 2001-08-06 21:27:53 +0000 | [diff] [blame^] | 1025 | .It Cm SmartcardDevice |
| 1026 | Specifies which smartcard device to use. The argument to this keyword is |
| 1027 | the device |
| 1028 | .Nm |
| 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 |
| 1031 | is not activated. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1032 | .It Cm StrictHostKeyChecking |
| 1033 | If this flag is set to |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1034 | .Dq yes , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1035 | .Nm |
Ben Lindstrom | eb930d4 | 2001-01-29 08:37:08 +0000 | [diff] [blame] | 1036 | will never automatically add host keys to the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1037 | .Pa $HOME/.ssh/known_hosts |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1038 | file, and refuses to connect to hosts whose host key has changed. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1039 | This provides maximum protection against trojan horse attacks. |
| 1040 | However, it can be somewhat annoying if you don't have good |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 1041 | .Pa /etc/ssh_known_hosts |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1042 | files installed and frequently |
Ben Lindstrom | eb930d4 | 2001-01-29 08:37:08 +0000 | [diff] [blame] | 1043 | connect to new hosts. |
| 1044 | This option forces the user to manually |
| 1045 | add all new hosts. |
| 1046 | If this flag is set to |
| 1047 | .Dq no , |
| 1048 | .Nm |
| 1049 | will automatically add new host keys to the |
| 1050 | user known hosts files. |
| 1051 | If this flag is set to |
| 1052 | .Dq ask , |
| 1053 | new host keys |
| 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 |
| 1056 | .Nm |
| 1057 | will refuse to connect to hosts whose host key has changed. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1058 | The host keys of |
Ben Lindstrom | eb930d4 | 2001-01-29 08:37:08 +0000 | [diff] [blame] | 1059 | known hosts will be verified automatically in all cases. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1060 | The argument must be |
Ben Lindstrom | eb930d4 | 2001-01-29 08:37:08 +0000 | [diff] [blame] | 1061 | .Dq yes , |
| 1062 | .Dq no |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1063 | or |
Ben Lindstrom | eb930d4 | 2001-01-29 08:37:08 +0000 | [diff] [blame] | 1064 | .Dq ask . |
| 1065 | The default is |
| 1066 | .Dq ask . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1067 | .It Cm UsePrivilegedPort |
| 1068 | Specifies whether to use a privileged port for outgoing connections. |
| 1069 | The argument must be |
| 1070 | .Dq yes |
| 1071 | or |
| 1072 | .Dq no . |
| 1073 | The default is |
Ben Lindstrom | cebc858 | 2001-03-08 03:39:10 +0000 | [diff] [blame] | 1074 | .Dq no . |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 1075 | Note that you need to set this option to |
| 1076 | .Dq yes |
| 1077 | if you want to use |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1078 | .Cm RhostsAuthentication |
| 1079 | and |
Kevin Steves | fcec7f8 | 2000-12-15 19:55:48 +0000 | [diff] [blame] | 1080 | .Cm RhostsRSAAuthentication |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 1081 | with older servers. |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 1082 | .It Cm User |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 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 |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 1086 | having to remember to give the user name on the command line. |
| 1087 | .It Cm UserKnownHostsFile |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1088 | Specifies a file to use for the user |
Ben Lindstrom | 1e62174 | 2001-03-06 01:10:53 +0000 | [diff] [blame] | 1089 | host key database instead of |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 1090 | .Pa $HOME/.ssh/known_hosts . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1091 | .It Cm UseRsh |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1092 | Specifies that rlogin/rsh should be used for this host. |
| 1093 | It is possible that the host does not at all support the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1094 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1095 | protocol. |
| 1096 | This causes |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1097 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1098 | to immediately execute |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1099 | .Xr rsh 1 . |
| 1100 | All other options (except |
| 1101 | .Cm HostName ) |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1102 | are ignored if this has been specified. |
| 1103 | The argument must be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1104 | .Dq yes |
| 1105 | or |
| 1106 | .Dq no . |
Damien Miller | d3a1857 | 2000-06-07 19:55:44 +1000 | [diff] [blame] | 1107 | .It Cm XAuthLocation |
| 1108 | Specifies the location of the |
| 1109 | .Xr xauth 1 |
| 1110 | program. |
| 1111 | The default is |
| 1112 | .Pa /usr/X11R6/bin/xauth . |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 1113 | .El |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1114 | .Sh ENVIRONMENT |
| 1115 | .Nm |
| 1116 | will normally set the following environment variables: |
| 1117 | .Bl -tag -width Ds |
| 1118 | .It Ev DISPLAY |
| 1119 | The |
| 1120 | .Ev DISPLAY |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1121 | variable indicates the location of the X11 server. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1122 | It is automatically set by |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1123 | .Nm |
| 1124 | to point to a value of the form |
| 1125 | .Dq hostname:n |
| 1126 | where hostname indicates |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1127 | the host where the shell runs, and n is an integer >= 1. |
| 1128 | .Nm |
| 1129 | uses this special value to forward X11 connections over the secure |
| 1130 | channel. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 1131 | The user should normally not set |
| 1132 | .Ev DISPLAY |
| 1133 | explicitly, as that |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1134 | will render the X11 connection insecure (and will require the user to |
| 1135 | manually copy any required authorization cookies). |
| 1136 | .It Ev HOME |
| 1137 | Set to the path of the user's home directory. |
| 1138 | .It Ev LOGNAME |
| 1139 | Synonym for |
| 1140 | .Ev USER ; |
| 1141 | set for compatibility with systems that use this variable. |
| 1142 | .It Ev MAIL |
| 1143 | Set to point the user's mailbox. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1144 | .It Ev PATH |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1145 | Set to the default |
| 1146 | .Ev PATH , |
| 1147 | as specified when compiling |
| 1148 | .Nm ssh . |
Ben Lindstrom | 5bf5d67 | 2001-07-04 04:31:38 +0000 | [diff] [blame] | 1149 | .It Ev SSH_ASKPASS |
| 1150 | If |
| 1151 | .Nm |
| 1152 | needs a passphrase, it will read the passphrase from the current |
| 1153 | terminal if it was run from a terminal. |
| 1154 | If |
| 1155 | .Nm |
| 1156 | does not have a terminal associated with it but |
| 1157 | .Ev DISPLAY |
| 1158 | and |
| 1159 | .Ev SSH_ASKPASS |
| 1160 | are set, it will execute the program specified by |
| 1161 | .Ev SSH_ASKPASS |
| 1162 | and open an X11 window to read the passphrase. |
| 1163 | This is particularly useful when calling |
| 1164 | .Nm |
| 1165 | from a |
| 1166 | .Pa .Xsession |
| 1167 | or related script. |
| 1168 | (Note that on some machines it |
| 1169 | may be necessary to redirect the input from |
| 1170 | .Pa /dev/null |
| 1171 | to make this work.) |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1172 | .It Ev SSH_AUTH_SOCK |
| 1173 | indicates the path of a unix-domain socket used to communicate with the |
| 1174 | agent. |
| 1175 | .It Ev SSH_CLIENT |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1176 | Identifies the client end of the connection. |
| 1177 | The variable contains |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1178 | three space-separated values: client ip-address, client port number, |
| 1179 | and server port number. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 1180 | .It Ev SSH_ORIGINAL_COMMAND |
| 1181 | The variable contains the original command line if a forced command |
| 1182 | is executed. |
| 1183 | It can be used to extract the original arguments. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1184 | .It Ev SSH_TTY |
| 1185 | This is set to the name of the tty (path to the device) associated |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1186 | with the current shell or command. |
| 1187 | If the current session has no tty, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1188 | this variable is not set. |
| 1189 | .It Ev TZ |
| 1190 | The timezone variable is set to indicate the present timezone if it |
Damien Miller | 942da03 | 2000-08-18 13:59:06 +1000 | [diff] [blame] | 1191 | was set when the daemon was started (i.e., the daemon passes the value |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1192 | on to new connections). |
| 1193 | .It Ev USER |
| 1194 | Set to the name of the user logging in. |
| 1195 | .El |
| 1196 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1197 | Additionally, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1198 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1199 | reads |
| 1200 | .Pa $HOME/.ssh/environment , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1201 | and adds lines of the format |
| 1202 | .Dq VARNAME=value |
| 1203 | to the environment. |
| 1204 | .Sh FILES |
Damien Miller | 98c7ad6 | 2000-03-09 21:27:49 +1100 | [diff] [blame] | 1205 | .Bl -tag -width Ds |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1206 | .It Pa $HOME/.ssh/known_hosts |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1207 | Records host keys for all hosts the user has logged into (that are not |
| 1208 | in |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1209 | .Pa /etc/ssh_known_hosts . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1210 | See |
| 1211 | .Xr sshd 8 . |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 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. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1215 | These files |
| 1216 | contain sensitive data and should be readable by the user but not |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1217 | accessible by others (read/write/execute). |
| 1218 | Note that |
| 1219 | .Nm |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1220 | ignores a private key file if it is accessible by others. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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. |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 1224 | .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1225 | Contains the public key for authentication (public part of the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1226 | identity file in human-readable form). |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1227 | The contents of the |
| 1228 | .Pa $HOME/.ssh/identity.pub |
| 1229 | file should be added to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1230 | .Pa $HOME/.ssh/authorized_keys |
| 1231 | on all machines |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 1232 | where you wish to log in using protocol version 1 RSA authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1233 | The contents of the |
| 1234 | .Pa $HOME/.ssh/id_dsa.pub |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 1235 | and |
| 1236 | .Pa $HOME/.ssh/id_rsa.pub |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1237 | file should be added to |
Ben Lindstrom | f96704d | 2001-06-25 04:17:12 +0000 | [diff] [blame] | 1238 | .Pa $HOME/.ssh/authorized_keys |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1239 | on all machines |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 1240 | where you wish to log in using protocol version 2 DSA/RSA authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1241 | These files are not |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1242 | sensitive and can (but need not) be readable by anyone. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1243 | These files are |
Kevin Steves | 3c034ae | 2001-02-05 13:47:11 +0000 | [diff] [blame] | 1244 | never used automatically and are not necessary; they are only provided for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1245 | the convenience of the user. |
| 1246 | .It Pa $HOME/.ssh/config |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1247 | This is the per-user configuration file. |
| 1248 | The format of this file is described above. |
| 1249 | This file is used by the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1250 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1251 | client. |
| 1252 | This file does not usually contain any sensitive information, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1253 | but the recommended permissions are read/write for the user, and not |
| 1254 | accessible by others. |
| 1255 | .It Pa $HOME/.ssh/authorized_keys |
Ben Lindstrom | f96704d | 2001-06-25 04:17:12 +0000 | [diff] [blame] | 1256 | Lists the public keys (RSA/DSA) that can be used for logging in as this user. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1257 | The format of this file is described in the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1258 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1259 | manual page. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1260 | In the simplest form the format is the same as the .pub |
| 1261 | identity files. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1262 | This file is not highly sensitive, but the recommended |
| 1263 | permissions are read/write for the user, and not accessible by others. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1264 | .It Pa /etc/ssh_known_hosts |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1265 | Systemwide list of known host keys. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1266 | This file should be prepared by the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1267 | system administrator to contain the public host keys of all machines in the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1268 | organization. |
| 1269 | This file should be world-readable. |
| 1270 | This file contains |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1271 | public keys, one per line, in the following format (fields separated |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 1272 | by spaces): system name, public key and optional comment field. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1273 | When different names are used |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1274 | for the same machine, all such names should be listed, separated by |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1275 | commas. |
| 1276 | The format is described on the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1277 | .Xr sshd 8 |
| 1278 | manual page. |
| 1279 | .Pp |
| 1280 | The canonical system name (as returned by name servers) is used by |
| 1281 | .Xr sshd 8 |
| 1282 | to verify the client host when logging in; other names are needed because |
| 1283 | .Nm |
| 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. |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 1287 | .It Pa /etc/ssh_config |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1288 | Systemwide configuration file. |
| 1289 | This file provides defaults for those |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1290 | values that are not specified in the user's configuration file, and |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1291 | for those users who do not have a configuration file. |
| 1292 | This file must be world-readable. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1293 | .It Pa $HOME/.rhosts |
| 1294 | This file is used in |
| 1295 | .Pa \&.rhosts |
| 1296 | authentication to list the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1297 | host/user pairs that are permitted to log in. |
| 1298 | (Note that this file is |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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, |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1302 | separated by a space. |
Ben Lindstrom | ebd888d | 2001-03-05 05:49:29 +0000 | [diff] [blame] | 1303 | On some machines this file may need to be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1304 | world-readable if the user's home directory is on a NFS partition, |
| 1305 | because |
| 1306 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1307 | reads it as root. |
| 1308 | Additionally, this file must be owned by the user, |
| 1309 | and must not have write permissions for anyone else. |
| 1310 | The recommended |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1311 | permission for most machines is read/write for the user, and not |
| 1312 | accessible by others. |
| 1313 | .Pp |
| 1314 | Note that by default |
| 1315 | .Xr sshd 8 |
| 1316 | will be installed so that it requires successful RSA host |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1317 | authentication before permitting \s+2.\s0rhosts authentication. |
| 1318 | If your server machine does not have the client's host key in |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 1319 | .Pa /etc/ssh_known_hosts , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1320 | you can store it in |
| 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 |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 1324 | will automatically add the host key to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1325 | .Pa $HOME/.ssh/known_hosts . |
| 1326 | .It Pa $HOME/.shosts |
| 1327 | This file is used exactly the same way as |
| 1328 | .Pa \&.rhosts . |
| 1329 | The purpose for |
| 1330 | having this file is to be able to use rhosts authentication with |
| 1331 | .Nm |
| 1332 | without permitting login with |
| 1333 | .Xr rlogin 1 |
| 1334 | or |
| 1335 | .Xr rsh 1 . |
| 1336 | .It Pa /etc/hosts.equiv |
| 1337 | This file is used during |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1338 | .Pa \&.rhosts authentication. |
| 1339 | It contains |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1340 | canonical hosts names, one per line (the full format is described on |
| 1341 | the |
| 1342 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1343 | manual page). |
| 1344 | If the client host is found in this file, login is |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1345 | automatically permitted provided client and server user names are the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1346 | same. |
| 1347 | Additionally, successful RSA host authentication is normally |
| 1348 | required. |
| 1349 | This file should only be writable by root. |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 1350 | .It Pa /etc/shosts.equiv |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1351 | This file is processed exactly as |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1352 | .Pa /etc/hosts.equiv . |
| 1353 | This file may be useful to permit logins using |
| 1354 | .Nm |
| 1355 | but not using rsh/rlogin. |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 1356 | .It Pa /etc/sshrc |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1357 | Commands in this file are executed by |
| 1358 | .Nm |
| 1359 | when the user logs in just before the user's shell (or command) is started. |
| 1360 | See the |
| 1361 | .Xr sshd 8 |
| 1362 | manual page for more information. |
| 1363 | .It Pa $HOME/.ssh/rc |
| 1364 | Commands in this file are executed by |
| 1365 | .Nm |
| 1366 | when the user logs in just before the user's shell (or command) is |
| 1367 | started. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1368 | See the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1369 | .Xr sshd 8 |
| 1370 | manual page for more information. |
Damien Miller | 4f0fa56 | 1999-12-26 14:24:41 +1100 | [diff] [blame] | 1371 | .It Pa $HOME/.ssh/environment |
| 1372 | Contains additional definitions for environment variables, see section |
| 1373 | .Sx ENVIRONMENT |
| 1374 | above. |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 1375 | .El |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 1376 | .Sh AUTHORS |
Ben Lindstrom | 035782e | 2001-01-29 08:34:16 +0000 | [diff] [blame] | 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 |
| 1382 | created OpenSSH. |
| 1383 | Markus Friedl contributed the support for SSH |
| 1384 | protocol versions 1.5 and 2.0. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1385 | .Sh SEE ALSO |
| 1386 | .Xr rlogin 1 , |
| 1387 | .Xr rsh 1 , |
| 1388 | .Xr scp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 1389 | .Xr sftp 1 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1390 | .Xr ssh-add 1 , |
| 1391 | .Xr ssh-agent 1 , |
| 1392 | .Xr ssh-keygen 1 , |
| 1393 | .Xr telnet 1 , |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 1394 | .Xr sshd 8 |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 1395 | .Rs |
| 1396 | .%A T. Ylonen |
| 1397 | .%A T. Kivinen |
| 1398 | .%A M. Saarinen |
| 1399 | .%A T. Rinne |
| 1400 | .%A S. Lehtinen |
| 1401 | .%T "SSH Protocol Architecture" |
| 1402 | .%N draft-ietf-secsh-architecture-07.txt |
| 1403 | .%D January 2001 |
| 1404 | .%O work in progress material |
| 1405 | .Re |