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 | 3541f18 | 2002-08-20 19:03:20 +0000 | [diff] [blame^] | 37 | .\" $OpenBSD: ssh.1,v 1.163 2002/08/17 23:07:14 stevesk 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 |
Ben Lindstrom | a10aed8 | 2001-09-12 16:43:26 +0000 | [diff] [blame] | 47 | .Ar hostname | user@hostname |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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 |
Ben Lindstrom | 14f31ab | 2001-09-12 17:48:04 +0000 | [diff] [blame] | 60 | .Op Fl F Ar configfile |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 61 | .Oo Fl L Xo |
| 62 | .Sm off |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 63 | .Ar port : |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 64 | .Ar host : |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 65 | .Ar hostport |
| 66 | .Sm on |
| 67 | .Xc |
| 68 | .Oc |
| 69 | .Oo Fl R Xo |
| 70 | .Sm off |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 71 | .Ar port : |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 72 | .Ar host : |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 73 | .Ar hostport |
| 74 | .Sm on |
| 75 | .Xc |
| 76 | .Oc |
Ben Lindstrom | 6e69d53 | 2001-09-12 17:59:59 +0000 | [diff] [blame] | 77 | .Op Fl D Ar port |
Ben Lindstrom | a10aed8 | 2001-09-12 16:43:26 +0000 | [diff] [blame] | 78 | .Ar hostname | user@hostname |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 79 | .Op Ar command |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 80 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 81 | .Nm |
Ben Lindstrom | d58eb5f | 2001-03-07 06:07:22 +0000 | [diff] [blame] | 82 | (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] | 83 | executing commands on a remote machine. |
| 84 | It is intended to replace |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 85 | rlogin and rsh, and provide secure encrypted communications between |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 86 | two untrusted hosts over an insecure network. |
| 87 | X11 connections and |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 88 | arbitrary TCP/IP ports can also be forwarded over the secure channel. |
| 89 | .Pp |
| 90 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 91 | connects and logs into the specified |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 92 | .Ar hostname . |
| 93 | The user must prove |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 94 | his/her identity to the remote machine using one of several methods |
| 95 | depending on the protocol version used: |
| 96 | .Pp |
| 97 | .Ss SSH protocol version 1 |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 98 | .Pp |
| 99 | First, if the machine the user logs in from is listed in |
| 100 | .Pa /etc/hosts.equiv |
| 101 | or |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 102 | .Pa /etc/shosts.equiv |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 103 | on the remote machine, and the user names are |
| 104 | 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] | 105 | Second, if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 106 | .Pa \&.rhosts |
| 107 | or |
| 108 | .Pa \&.shosts |
| 109 | exists in the user's home directory on the |
| 110 | remote machine and contains a line containing the name of the client |
| 111 | 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] | 112 | permitted to log in. |
| 113 | This form of authentication alone is normally not |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 114 | allowed by the server because it is not secure. |
| 115 | .Pp |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 116 | The second authentication method is the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 117 | .Pa rhosts |
| 118 | or |
| 119 | .Pa hosts.equiv |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 120 | method combined with RSA-based host authentication. |
| 121 | It means that if the login would be permitted by |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 122 | .Pa $HOME/.rhosts , |
| 123 | .Pa $HOME/.shosts , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 124 | .Pa /etc/hosts.equiv , |
| 125 | or |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 126 | .Pa /etc/shosts.equiv , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 127 | and if additionally the server can verify the client's |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 128 | host key (see |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 129 | .Pa /etc/ssh/ssh_known_hosts |
Damien Miller | 33e511e | 1999-11-11 11:43:13 +1100 | [diff] [blame] | 130 | and |
| 131 | .Pa $HOME/.ssh/known_hosts |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 132 | in the |
| 133 | .Sx FILES |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 134 | section), only then login is permitted. |
| 135 | This authentication method closes security holes due to IP |
| 136 | spoofing, DNS spoofing and routing spoofing. |
| 137 | [Note to the administrator: |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 138 | .Pa /etc/hosts.equiv , |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 139 | .Pa $HOME/.rhosts , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 140 | and the rlogin/rsh protocol in general, are inherently insecure and should be |
| 141 | disabled if security is desired.] |
| 142 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 143 | As a third authentication method, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 144 | .Nm |
| 145 | supports RSA based authentication. |
| 146 | The scheme is based on public-key cryptography: there are cryptosystems |
| 147 | where encryption and decryption are done using separate keys, and it |
| 148 | is not possible to derive the decryption key from the encryption key. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 149 | RSA is one such system. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 150 | The idea is that each user creates a public/private |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 151 | key pair for authentication purposes. |
| 152 | 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] | 153 | The file |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 154 | .Pa $HOME/.ssh/authorized_keys |
| 155 | lists the public keys that are permitted for logging |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 156 | in. |
| 157 | When the user logs in, the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 158 | .Nm |
| 159 | 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] | 160 | authentication. |
| 161 | The server checks if this key is permitted, and if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 162 | so, sends the user (actually the |
| 163 | .Nm |
| 164 | program running on behalf of the user) a challenge, a random number, |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 165 | encrypted by the user's public key. |
| 166 | The challenge can only be |
| 167 | decrypted using the proper private key. |
| 168 | The user's client then decrypts the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 169 | challenge using the private key, proving that he/she knows the private |
| 170 | key but without disclosing it to the server. |
| 171 | .Pp |
| 172 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 173 | implements the RSA authentication protocol automatically. |
| 174 | The user creates his/her RSA key pair by running |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 175 | .Xr ssh-keygen 1 . |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 176 | This stores the private key in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 177 | .Pa $HOME/.ssh/identity |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 178 | and the public key in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 179 | .Pa $HOME/.ssh/identity.pub |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 180 | in the user's home directory. |
| 181 | The user should then copy the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 182 | .Pa identity.pub |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 183 | to |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 184 | .Pa $HOME/.ssh/authorized_keys |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 185 | in his/her home directory on the remote machine (the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 186 | .Pa authorized_keys |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 187 | file corresponds to the conventional |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 188 | .Pa $HOME/.rhosts |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 189 | file, and has one key |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 190 | per line, though the lines can be very long). |
| 191 | After this, the user can log in without giving the password. |
| 192 | RSA authentication is much |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 193 | more secure than rhosts authentication. |
| 194 | .Pp |
| 195 | The most convenient way to use RSA authentication may be with an |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 196 | authentication agent. |
| 197 | See |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 198 | .Xr ssh-agent 1 |
| 199 | for more information. |
| 200 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 201 | If other authentication methods fail, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 202 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 203 | prompts the user for a password. |
| 204 | The password is sent to the remote |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 205 | host for checking; however, since all communications are encrypted, |
| 206 | the password cannot be seen by someone listening on the network. |
| 207 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 208 | .Ss SSH protocol version 2 |
| 209 | .Pp |
Damien Miller | 07a2d42 | 2002-02-05 12:16:15 +1100 | [diff] [blame] | 210 | When a user connects using protocol version 2 |
| 211 | similar authentication methods are available. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 212 | Using the default values for |
| 213 | .Cm PreferredAuthentications , |
Ben Lindstrom | a9086a1 | 2001-08-06 20:58:51 +0000 | [diff] [blame] | 214 | the client will try to authenticate first using the hostbased method; |
| 215 | if this method fails public key authentication is attempted, |
| 216 | and finally if this method fails keyboard-interactive and |
| 217 | password authentication are tried. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 218 | .Pp |
| 219 | The public key method is similar to RSA authentication described |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 220 | 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] | 221 | The client uses his private key, |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 222 | .Pa $HOME/.ssh/id_dsa |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 223 | or |
| 224 | .Pa $HOME/.ssh/id_rsa , |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 225 | to sign the session identifier and sends the result to the server. |
| 226 | The server checks whether the matching public key is listed in |
Ben Lindstrom | f96704d | 2001-06-25 04:17:12 +0000 | [diff] [blame] | 227 | .Pa $HOME/.ssh/authorized_keys |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 228 | and grants access if both the key is found and the signature is correct. |
| 229 | The session identifier is derived from a shared Diffie-Hellman value |
| 230 | and is only known to the client and the server. |
| 231 | .Pp |
| 232 | If public key authentication fails or is not available a password |
| 233 | 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] | 234 | .Pp |
| 235 | Additionally, |
| 236 | .Nm |
| 237 | supports hostbased or challenge response authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 238 | .Pp |
| 239 | Protocol 2 provides additional mechanisms for confidentiality |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 240 | (the traffic is encrypted using 3DES, Blowfish, CAST128 or Arcfour) |
Ben Lindstrom | ec26fb1 | 2001-03-06 01:05:23 +0000 | [diff] [blame] | 241 | and integrity (hmac-md5, hmac-sha1). |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 242 | Note that protocol 1 lacks a strong mechanism for ensuring the |
| 243 | integrity of the connection. |
| 244 | .Pp |
| 245 | .Ss Login session and remote execution |
| 246 | .Pp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 247 | When the user's identity has been accepted by the server, the server |
| 248 | either executes the given command, or logs into the machine and gives |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 249 | the user a normal shell on the remote machine. |
| 250 | All communication with |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 251 | the remote command or shell will be automatically encrypted. |
| 252 | .Pp |
| 253 | If a pseudo-terminal has been allocated (normal login session), the |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 254 | user may use the escape characters noted below. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 255 | .Pp |
| 256 | If no pseudo tty has been allocated, the |
| 257 | session is transparent and can be used to reliably transfer binary |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 258 | data. |
| 259 | On most systems, setting the escape character to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 260 | .Dq none |
| 261 | will also make the session transparent even if a tty is used. |
| 262 | .Pp |
Ben Lindstrom | a688561 | 2000-12-09 03:45:32 +0000 | [diff] [blame] | 263 | The session terminates when the command or shell on the remote |
Ben Lindstrom | ebd888d | 2001-03-05 05:49:29 +0000 | [diff] [blame] | 264 | machine exits and all X11 and TCP/IP connections have been closed. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 265 | The exit status of the remote program is returned as the exit status |
| 266 | of |
| 267 | .Nm ssh . |
| 268 | .Pp |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 269 | .Ss Escape Characters |
| 270 | .Pp |
| 271 | 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] | 272 | through the use of an escape character. |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 273 | .Pp |
| 274 | A single tilde character can be sent as |
| 275 | .Ic ~~ |
Ben Lindstrom | 6600769 | 2001-07-22 20:41:59 +0000 | [diff] [blame] | 276 | 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] | 277 | The escape character must always follow a newline to be interpreted as |
| 278 | special. |
| 279 | The escape character can be changed in configuration files using the |
| 280 | .Cm EscapeChar |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 281 | configuration directive or on the command line by the |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 282 | .Fl e |
| 283 | option. |
| 284 | .Pp |
| 285 | The supported escapes (assuming the default |
| 286 | .Ql ~ ) |
| 287 | are: |
| 288 | .Bl -tag -width Ds |
| 289 | .It Cm ~. |
| 290 | Disconnect |
| 291 | .It Cm ~^Z |
| 292 | Background ssh |
| 293 | .It Cm ~# |
| 294 | List forwarded connections |
| 295 | .It Cm ~& |
| 296 | Background ssh at logout when waiting for forwarded connection / X11 sessions |
Damien Miller | 1f8dddc | 2001-11-12 11:02:25 +1100 | [diff] [blame] | 297 | to terminate |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 298 | .It Cm ~? |
| 299 | Display a list of escape characters |
Ben Lindstrom | 5589f4b | 2002-03-22 03:24:32 +0000 | [diff] [blame] | 300 | .It Cm ~C |
| 301 | Open command line (only useful for adding port forwardings using the |
| 302 | .Fl L |
| 303 | and |
| 304 | .Fl R |
| 305 | options) |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 306 | .It Cm ~R |
Ben Lindstrom | f8d2457 | 2001-04-22 17:11:56 +0000 | [diff] [blame] | 307 | Request rekeying of the connection (only useful for SSH protocol version 2 |
| 308 | and if the peer supports it) |
Ben Lindstrom | 9ffdcb5 | 2001-04-20 12:50:51 +0000 | [diff] [blame] | 309 | .El |
| 310 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 311 | .Ss X11 and TCP forwarding |
| 312 | .Pp |
Ben Lindstrom | 7121507 | 2001-05-17 03:16:18 +0000 | [diff] [blame] | 313 | If the |
| 314 | .Cm ForwardX11 |
| 315 | variable is set to |
| 316 | .Dq yes |
| 317 | (or, see the description of the |
| 318 | .Fl X |
| 319 | and |
| 320 | .Fl x |
| 321 | options described later) |
| 322 | and the user is using X11 (the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 323 | .Ev DISPLAY |
| 324 | environment variable is set), the connection to the X11 display is |
| 325 | automatically forwarded to the remote side in such a way that any X11 |
| 326 | programs started from the shell (or command) will go through the |
| 327 | 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] | 328 | from the local machine. |
| 329 | The user should not manually set |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 330 | .Ev DISPLAY . |
| 331 | Forwarding of X11 connections can be |
| 332 | configured on the command line or in configuration files. |
| 333 | .Pp |
| 334 | The |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 335 | .Ev DISPLAY |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 336 | value set by |
| 337 | .Nm |
| 338 | will point to the server machine, but with a display number greater |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 339 | than zero. |
| 340 | This is normal, and happens because |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 341 | .Nm |
| 342 | creates a |
| 343 | .Dq proxy |
| 344 | X server on the server machine for forwarding the |
| 345 | connections over the encrypted channel. |
| 346 | .Pp |
| 347 | .Nm |
| 348 | will also automatically set up Xauthority data on the server machine. |
| 349 | For this purpose, it will generate a random authorization cookie, |
| 350 | store it in Xauthority on the server, and verify that any forwarded |
| 351 | connections carry this cookie and replace it by the real cookie when |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 352 | the connection is opened. |
| 353 | The real authentication cookie is never |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 354 | sent to the server machine (and no cookies are sent in the plain). |
| 355 | .Pp |
Ben Lindstrom | 3541f18 | 2002-08-20 19:03:20 +0000 | [diff] [blame^] | 356 | If the |
| 357 | .Cm ForwardAgent |
| 358 | variable is set to |
| 359 | .Dq yes |
| 360 | (or, see the description of the |
| 361 | .Fl A |
| 362 | and |
| 363 | .Fl a |
| 364 | options described later) and |
| 365 | the user is using an authentication agent, the connection to the agent |
| 366 | is automatically forwarded to the remote side. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 367 | .Pp |
| 368 | Forwarding of arbitrary TCP/IP connections over the secure channel can |
Ben Lindstrom | 979c981 | 2001-07-22 20:45:39 +0000 | [diff] [blame] | 369 | be specified either on the command line or in a configuration file. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 370 | 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] | 371 | electronic purse; another is going through firewalls. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 372 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 373 | .Ss Server authentication |
| 374 | .Pp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 375 | .Nm |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 376 | automatically maintains and checks a database containing |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 377 | identifications for all hosts it has ever been used with. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 378 | Host keys are stored in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 379 | .Pa $HOME/.ssh/known_hosts |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 380 | in the user's home directory. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 381 | Additionally, the file |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 382 | .Pa /etc/ssh/ssh_known_hosts |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 383 | is automatically checked for known hosts. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 384 | Any new hosts are automatically added to the user's file. |
| 385 | If a host's identification |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 386 | ever changes, |
| 387 | .Nm |
| 388 | warns about this and disables password authentication to prevent a |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 389 | trojan horse from getting the user's password. |
| 390 | Another purpose of |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 391 | this mechanism is to prevent man-in-the-middle attacks which could |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 392 | otherwise be used to circumvent the encryption. |
| 393 | The |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 394 | .Cm StrictHostKeyChecking |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 395 | option can be used to prevent logins to machines whose |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 396 | host key is not known or has changed. |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 397 | .Pp |
| 398 | The options are as follows: |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 399 | .Bl -tag -width Ds |
| 400 | .It Fl a |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 401 | Disables forwarding of the authentication agent connection. |
Damien Miller | b1715dc | 2000-05-30 13:44:51 +1000 | [diff] [blame] | 402 | .It Fl A |
| 403 | Enables forwarding of the authentication agent connection. |
| 404 | 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] | 405 | .It Fl b Ar bind_address |
| 406 | Specify the interface to transmit from on machines with multiple |
| 407 | interfaces or aliased addresses. |
Ben Lindstrom | ffa1dd6 | 2001-09-12 16:52:28 +0000 | [diff] [blame] | 408 | .It Fl c Ar blowfish|3des|des |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 409 | Selects the cipher to use for encrypting the session. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 410 | .Ar 3des |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 411 | is used by default. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 412 | It is believed to be secure. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 413 | .Ar 3des |
| 414 | (triple-des) is an encrypt-decrypt-encrypt triple with three different keys. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 415 | .Ar blowfish |
| 416 | 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] | 417 | .Ar 3des . |
Ben Lindstrom | ffa1dd6 | 2001-09-12 16:52:28 +0000 | [diff] [blame] | 418 | .Ar des |
| 419 | is only supported in the |
| 420 | .Nm |
| 421 | client for interoperability with legacy protocol 1 implementations |
| 422 | that do not support the |
| 423 | .Ar 3des |
| 424 | cipher. Its use is strongly discouraged due to cryptographic |
| 425 | weaknesses. |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 426 | .It Fl c Ar cipher_spec |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 427 | Additionally, for protocol version 2 a comma-separated list of ciphers can |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 428 | be specified in order of preference. |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 429 | See |
| 430 | .Cm Ciphers |
| 431 | for more information. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 432 | .It Fl e Ar ch|^ch|none |
| 433 | Sets the escape character for sessions with a pty (default: |
| 434 | .Ql ~ ) . |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 435 | The escape character is only recognized at the beginning of a line. |
| 436 | The escape character followed by a dot |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 437 | .Pq Ql \&. |
| 438 | closes the connection, followed |
| 439 | by control-Z suspends the connection, and followed by itself sends the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 440 | escape character once. |
| 441 | Setting the character to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 442 | .Dq none |
| 443 | disables any escapes and makes the session fully transparent. |
| 444 | .It Fl f |
| 445 | Requests |
| 446 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 447 | to go to background just before command execution. |
| 448 | This is useful if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 449 | .Nm |
| 450 | is going to ask for passwords or passphrases, but the user |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 451 | wants it in the background. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 452 | This implies |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 453 | .Fl n . |
| 454 | The recommended way to start X11 programs at a remote site is with |
| 455 | something like |
| 456 | .Ic ssh -f host xterm . |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 457 | .It Fl g |
| 458 | Allows remote hosts to connect to local forwarded ports. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 459 | .It Fl i Ar identity_file |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 460 | Selects a file from which the identity (private key) for |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 461 | RSA or DSA authentication is read. |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 462 | The default is |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 463 | .Pa $HOME/.ssh/identity |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 464 | for protocol version 1, and |
| 465 | .Pa $HOME/.ssh/id_rsa |
| 466 | and |
| 467 | .Pa $HOME/.ssh/id_dsa |
| 468 | for protocol version 2. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 469 | Identity files may also be specified on |
| 470 | a per-host basis in the configuration file. |
| 471 | It is possible to have multiple |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 472 | .Fl i |
| 473 | options (and multiple identities specified in |
| 474 | configuration files). |
Ben Lindstrom | ae996bf | 2001-08-06 21:27:53 +0000 | [diff] [blame] | 475 | .It Fl I Ar smartcard_device |
| 476 | Specifies which smartcard device to use. The argument is |
| 477 | the device |
| 478 | .Nm |
| 479 | should use to communicate with a smartcard used for storing the user's |
| 480 | private RSA key. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 481 | .It Fl k |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 482 | Disables forwarding of Kerberos tickets and AFS tokens. |
| 483 | 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] | 484 | .It Fl l Ar login_name |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 485 | Specifies the user to log in as on the remote machine. |
| 486 | 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] | 487 | .It Fl m Ar mac_spec |
| 488 | Additionally, for protocol version 2 a comma-separated list of MAC |
| 489 | (message authentication code) algorithms can |
| 490 | be specified in order of preference. |
| 491 | See the |
| 492 | .Cm MACs |
| 493 | keyword for more information. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 494 | .It Fl n |
| 495 | Redirects stdin from |
| 496 | .Pa /dev/null |
| 497 | (actually, prevents reading from stdin). |
| 498 | This must be used when |
| 499 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 500 | is run in the background. |
| 501 | A common trick is to use this to run X11 programs on a remote machine. |
| 502 | For example, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 503 | .Ic ssh -n shadows.cs.hut.fi emacs & |
| 504 | will start an emacs on shadows.cs.hut.fi, and the X11 |
| 505 | connection will be automatically forwarded over an encrypted channel. |
| 506 | The |
| 507 | .Nm |
| 508 | program will be put in the background. |
| 509 | (This does not work if |
| 510 | .Nm |
| 511 | needs to ask for a password or passphrase; see also the |
| 512 | .Fl f |
| 513 | option.) |
Damien Miller | dcb6ecd | 2000-05-17 22:34:22 +1000 | [diff] [blame] | 514 | .It Fl N |
| 515 | Do not execute a remote command. |
Ben Lindstrom | 594e203 | 2001-09-12 18:35:30 +0000 | [diff] [blame] | 516 | This is useful for just forwarding ports |
Damien Miller | dcb6ecd | 2000-05-17 22:34:22 +1000 | [diff] [blame] | 517 | (protocol version 2 only). |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 518 | .It Fl o Ar option |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 519 | Can be used to give options in the format used in the configuration file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 520 | This is useful for specifying options for which there is no separate |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 521 | command-line flag. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 522 | .It Fl p Ar port |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 523 | Port to connect to on the remote host. |
| 524 | This can be specified on a |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 525 | per-host basis in the configuration file. |
| 526 | .It Fl P |
| 527 | Use a non-privileged port for outgoing connections. |
Ben Lindstrom | 594e203 | 2001-09-12 18:35:30 +0000 | [diff] [blame] | 528 | This can be used if a firewall does |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 529 | not permit connections from privileged ports. |
Damien Miller | a34a28b | 1999-12-14 10:47:15 +1100 | [diff] [blame] | 530 | Note that this option turns off |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 531 | .Cm RhostsAuthentication |
| 532 | and |
Kevin Steves | fcec7f8 | 2000-12-15 19:55:48 +0000 | [diff] [blame] | 533 | .Cm RhostsRSAAuthentication |
| 534 | for older servers. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 535 | .It Fl q |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 536 | Quiet mode. |
| 537 | Causes all warning and diagnostic messages to be suppressed. |
Damien Miller | 832562e | 2001-01-30 09:30:01 +1100 | [diff] [blame] | 538 | .It Fl s |
Ben Lindstrom | 2464322 | 2001-06-25 05:08:11 +0000 | [diff] [blame] | 539 | 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 |
| 540 | of SSH as a secure transport for other applications (eg. sftp). The |
Damien Miller | 832562e | 2001-01-30 09:30:01 +1100 | [diff] [blame] | 541 | subsystem is specified as the remote command. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 542 | .It Fl t |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 543 | Force pseudo-tty allocation. |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 544 | This can be used to execute arbitrary |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 545 | screen-based programs on a remote machine, which can be very useful, |
| 546 | e.g., when implementing menu services. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 547 | Multiple |
| 548 | .Fl t |
| 549 | options force tty allocation, even if |
| 550 | .Nm |
| 551 | has no local tty. |
Damien Miller | dcb6ecd | 2000-05-17 22:34:22 +1000 | [diff] [blame] | 552 | .It Fl T |
Ben Lindstrom | c72745a | 2000-12-02 19:03:54 +0000 | [diff] [blame] | 553 | Disable pseudo-tty allocation. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 554 | .It Fl v |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 555 | Verbose mode. |
| 556 | Causes |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 557 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 558 | to print debugging messages about its progress. |
| 559 | This is helpful in |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 560 | debugging connection, authentication, and configuration problems. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 561 | Multiple |
| 562 | .Fl v |
| 563 | options increases the verbosity. |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 564 | Maximum is 3. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 565 | .It Fl x |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 566 | Disables X11 forwarding. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 567 | .It Fl X |
| 568 | Enables X11 forwarding. |
Damien Miller | b1715dc | 2000-05-30 13:44:51 +1000 | [diff] [blame] | 569 | 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] | 570 | .It Fl C |
| 571 | Requests compression of all data (including stdin, stdout, stderr, and |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 572 | data for forwarded X11 and TCP/IP connections). |
| 573 | The compression algorithm is the same used by |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 574 | .Xr gzip 1 , |
| 575 | and the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 576 | .Dq level |
| 577 | can be controlled by the |
| 578 | .Cm CompressionLevel |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 579 | option. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 580 | Compression is desirable on modem lines and other |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 581 | slow connections, but will only slow down things on fast networks. |
| 582 | The default value can be set on a host-by-host basis in the |
| 583 | configuration files; see the |
Ben Lindstrom | e2b9b06 | 2001-08-06 20:50:55 +0000 | [diff] [blame] | 584 | .Cm Compression |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 585 | option. |
Ben Lindstrom | 14f31ab | 2001-09-12 17:48:04 +0000 | [diff] [blame] | 586 | .It Fl F Ar configfile |
| 587 | Specifies an alternative per-user configuration file. |
| 588 | If a configuration file is given on the command line, |
| 589 | the system-wide configuration file |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 590 | .Pq Pa /etc/ssh/ssh_config |
Ben Lindstrom | 14f31ab | 2001-09-12 17:48:04 +0000 | [diff] [blame] | 591 | will be ignored. |
| 592 | The default for the per-user configuration file is |
| 593 | .Pa $HOME/.ssh/config . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 594 | .It Fl L Ar port:host:hostport |
| 595 | 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] | 596 | forwarded to the given host and port on the remote side. |
| 597 | This works by allocating a socket to listen to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 598 | .Ar port |
| 599 | on the local side, and whenever a connection is made to this port, the |
| 600 | connection is forwarded over the secure channel, and a connection is |
| 601 | made to |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 602 | .Ar host |
| 603 | port |
| 604 | .Ar hostport |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 605 | from the remote machine. |
| 606 | Port forwardings can also be specified in the configuration file. |
| 607 | Only root can forward privileged ports. |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 608 | IPv6 addresses can be specified with an alternative syntax: |
| 609 | .Ar port/host/hostport |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 610 | .It Fl R Ar port:host:hostport |
| 611 | 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] | 612 | forwarded to the given host and port on the local side. |
| 613 | This works by allocating a socket to listen to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 614 | .Ar port |
| 615 | on the remote side, and whenever a connection is made to this port, the |
| 616 | connection is forwarded over the secure channel, and a connection is |
| 617 | made to |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 618 | .Ar host |
| 619 | port |
| 620 | .Ar hostport |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 621 | from the local machine. |
| 622 | Port forwardings can also be specified in the configuration file. |
| 623 | Privileged ports can be forwarded only when |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 624 | logging in as root on the remote machine. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 625 | IPv6 addresses can be specified with an alternative syntax: |
| 626 | .Ar port/host/hostport |
Ben Lindstrom | 19ceb17 | 2001-09-12 17:54:24 +0000 | [diff] [blame] | 627 | .It Fl D Ar port |
| 628 | Specifies a local |
| 629 | .Dq dynamic |
| 630 | application-level port forwarding. |
| 631 | This works by allocating a socket to listen to |
| 632 | .Ar port |
| 633 | on the local side, and whenever a connection is made to this port, the |
| 634 | connection is forwarded over the secure channel, and the application |
| 635 | protocol is then used to determine where to connect to from the |
| 636 | remote machine. Currently the SOCKS4 protocol is supported, and |
| 637 | .Nm |
| 638 | will act as a SOCKS4 server. |
| 639 | Only root can forward privileged ports. |
| 640 | Dynamic port forwardings can also be specified in the configuration file. |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 641 | .It Fl 1 |
| 642 | Forces |
| 643 | .Nm |
| 644 | to try protocol version 1 only. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 645 | .It Fl 2 |
| 646 | Forces |
| 647 | .Nm |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 648 | to try protocol version 2 only. |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 649 | .It Fl 4 |
| 650 | Forces |
| 651 | .Nm |
| 652 | to use IPv4 addresses only. |
| 653 | .It Fl 6 |
| 654 | Forces |
| 655 | .Nm |
| 656 | to use IPv6 addresses only. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 657 | .El |
| 658 | .Sh CONFIGURATION FILES |
| 659 | .Nm |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 660 | may additionally obtain configuration data from |
| 661 | a per-user configuration file and a system-wide configuration file. |
| 662 | The file format and configuration options are described in |
| 663 | .Xr ssh_config 5 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 664 | .Sh ENVIRONMENT |
| 665 | .Nm |
| 666 | will normally set the following environment variables: |
| 667 | .Bl -tag -width Ds |
| 668 | .It Ev DISPLAY |
| 669 | The |
| 670 | .Ev DISPLAY |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 671 | variable indicates the location of the X11 server. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 672 | It is automatically set by |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 673 | .Nm |
| 674 | to point to a value of the form |
| 675 | .Dq hostname:n |
| 676 | where hostname indicates |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 677 | the host where the shell runs, and n is an integer >= 1. |
| 678 | .Nm |
| 679 | uses this special value to forward X11 connections over the secure |
| 680 | channel. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 681 | The user should normally not set |
| 682 | .Ev DISPLAY |
| 683 | explicitly, as that |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 684 | will render the X11 connection insecure (and will require the user to |
| 685 | manually copy any required authorization cookies). |
| 686 | .It Ev HOME |
| 687 | Set to the path of the user's home directory. |
| 688 | .It Ev LOGNAME |
| 689 | Synonym for |
| 690 | .Ev USER ; |
| 691 | set for compatibility with systems that use this variable. |
| 692 | .It Ev MAIL |
Ben Lindstrom | e59433d | 2001-09-12 16:41:37 +0000 | [diff] [blame] | 693 | Set to the path of the user's mailbox. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 694 | .It Ev PATH |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 695 | Set to the default |
| 696 | .Ev PATH , |
| 697 | as specified when compiling |
| 698 | .Nm ssh . |
Ben Lindstrom | 5bf5d67 | 2001-07-04 04:31:38 +0000 | [diff] [blame] | 699 | .It Ev SSH_ASKPASS |
| 700 | If |
| 701 | .Nm |
| 702 | needs a passphrase, it will read the passphrase from the current |
| 703 | terminal if it was run from a terminal. |
| 704 | If |
| 705 | .Nm |
| 706 | does not have a terminal associated with it but |
| 707 | .Ev DISPLAY |
| 708 | and |
| 709 | .Ev SSH_ASKPASS |
| 710 | are set, it will execute the program specified by |
| 711 | .Ev SSH_ASKPASS |
| 712 | and open an X11 window to read the passphrase. |
| 713 | This is particularly useful when calling |
| 714 | .Nm |
| 715 | from a |
| 716 | .Pa .Xsession |
| 717 | or related script. |
| 718 | (Note that on some machines it |
| 719 | may be necessary to redirect the input from |
| 720 | .Pa /dev/null |
| 721 | to make this work.) |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 722 | .It Ev SSH_AUTH_SOCK |
Ben Lindstrom | e59433d | 2001-09-12 16:41:37 +0000 | [diff] [blame] | 723 | Identifies the path of a unix-domain socket used to communicate with the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 724 | agent. |
| 725 | .It Ev SSH_CLIENT |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 726 | Identifies the client end of the connection. |
| 727 | The variable contains |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 728 | three space-separated values: client ip-address, client port number, |
| 729 | and server port number. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 730 | .It Ev SSH_ORIGINAL_COMMAND |
| 731 | The variable contains the original command line if a forced command |
| 732 | is executed. |
| 733 | It can be used to extract the original arguments. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 734 | .It Ev SSH_TTY |
| 735 | 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] | 736 | with the current shell or command. |
| 737 | If the current session has no tty, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 738 | this variable is not set. |
| 739 | .It Ev TZ |
| 740 | The timezone variable is set to indicate the present timezone if it |
Damien Miller | 942da03 | 2000-08-18 13:59:06 +1000 | [diff] [blame] | 741 | 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] | 742 | on to new connections). |
| 743 | .It Ev USER |
| 744 | Set to the name of the user logging in. |
| 745 | .El |
| 746 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 747 | Additionally, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 748 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 749 | reads |
| 750 | .Pa $HOME/.ssh/environment , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 751 | and adds lines of the format |
| 752 | .Dq VARNAME=value |
Ben Lindstrom | dc7adf2 | 2002-08-20 18:38:02 +0000 | [diff] [blame] | 753 | to the environment if the file exists and if users are allowed to |
| 754 | change their environment. |
Ben Lindstrom | bd9bf38 | 2002-08-20 18:54:20 +0000 | [diff] [blame] | 755 | See the |
Ben Lindstrom | dc7adf2 | 2002-08-20 18:38:02 +0000 | [diff] [blame] | 756 | .Cm PermitUserEnvironment |
Ben Lindstrom | bd9bf38 | 2002-08-20 18:54:20 +0000 | [diff] [blame] | 757 | option in |
Ben Lindstrom | dc7adf2 | 2002-08-20 18:38:02 +0000 | [diff] [blame] | 758 | .Xr sshd_config 5 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 759 | .Sh FILES |
Damien Miller | 98c7ad6 | 2000-03-09 21:27:49 +1100 | [diff] [blame] | 760 | .Bl -tag -width Ds |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 761 | .It Pa $HOME/.ssh/known_hosts |
Ben Lindstrom | e59433d | 2001-09-12 16:41:37 +0000 | [diff] [blame] | 762 | Records host keys for all hosts the user has logged into that are not |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 763 | in |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 764 | .Pa /etc/ssh/ssh_known_hosts . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 765 | See |
| 766 | .Xr sshd 8 . |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 767 | .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa |
| 768 | Contains the authentication identity of the user. |
| 769 | 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] | 770 | These files |
| 771 | contain sensitive data and should be readable by the user but not |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 772 | accessible by others (read/write/execute). |
| 773 | Note that |
| 774 | .Nm |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 775 | ignores a private key file if it is accessible by others. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 776 | It is possible to specify a passphrase when |
| 777 | generating the key; the passphrase will be used to encrypt the |
| 778 | sensitive part of this file using 3DES. |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 779 | .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] | 780 | Contains the public key for authentication (public part of the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 781 | identity file in human-readable form). |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 782 | The contents of the |
| 783 | .Pa $HOME/.ssh/identity.pub |
| 784 | file should be added to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 785 | .Pa $HOME/.ssh/authorized_keys |
| 786 | on all machines |
Ben Lindstrom | 594e203 | 2001-09-12 18:35:30 +0000 | [diff] [blame] | 787 | where the user wishes to log in using protocol version 1 RSA authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 788 | The contents of the |
| 789 | .Pa $HOME/.ssh/id_dsa.pub |
Ben Lindstrom | 18a82ac | 2001-04-11 15:59:35 +0000 | [diff] [blame] | 790 | and |
| 791 | .Pa $HOME/.ssh/id_rsa.pub |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 792 | file should be added to |
Ben Lindstrom | f96704d | 2001-06-25 04:17:12 +0000 | [diff] [blame] | 793 | .Pa $HOME/.ssh/authorized_keys |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 794 | on all machines |
Ben Lindstrom | 594e203 | 2001-09-12 18:35:30 +0000 | [diff] [blame] | 795 | where the user wishes to log in using protocol version 2 DSA/RSA authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 796 | These files are not |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 797 | sensitive and can (but need not) be readable by anyone. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 798 | These files are |
Kevin Steves | 3c034ae | 2001-02-05 13:47:11 +0000 | [diff] [blame] | 799 | never used automatically and are not necessary; they are only provided for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 800 | the convenience of the user. |
| 801 | .It Pa $HOME/.ssh/config |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 802 | This is the per-user configuration file. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 803 | The file format and configuration options are described in |
| 804 | .Xr ssh_config 5 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 805 | .It Pa $HOME/.ssh/authorized_keys |
Ben Lindstrom | f96704d | 2001-06-25 04:17:12 +0000 | [diff] [blame] | 806 | 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] | 807 | The format of this file is described in the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 808 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 809 | manual page. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 810 | In the simplest form the format is the same as the .pub |
| 811 | identity files. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 812 | This file is not highly sensitive, but the recommended |
| 813 | permissions are read/write for the user, and not accessible by others. |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 814 | .It Pa /etc/ssh/ssh_known_hosts |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 815 | Systemwide list of known host keys. |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 816 | This file should be prepared by the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 817 | 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] | 818 | organization. |
| 819 | This file should be world-readable. |
| 820 | This file contains |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 821 | public keys, one per line, in the following format (fields separated |
Ben Lindstrom | d6481ea | 2001-06-25 04:37:41 +0000 | [diff] [blame] | 822 | by spaces): system name, public key and optional comment field. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 823 | When different names are used |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 824 | for the same machine, all such names should be listed, separated by |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 825 | commas. |
| 826 | The format is described on the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 827 | .Xr sshd 8 |
| 828 | manual page. |
| 829 | .Pp |
| 830 | The canonical system name (as returned by name servers) is used by |
| 831 | .Xr sshd 8 |
| 832 | to verify the client host when logging in; other names are needed because |
| 833 | .Nm |
| 834 | does not convert the user-supplied name to a canonical name before |
| 835 | checking the key, because someone with access to the name servers |
| 836 | would then be able to fool host authentication. |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 837 | .It Pa /etc/ssh/ssh_config |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 838 | Systemwide configuration file. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 839 | The file format and configuration options are described in |
| 840 | .Xr ssh_config 5 . |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 841 | .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key |
Damien Miller | 705499b | 2001-11-12 11:05:38 +1100 | [diff] [blame] | 842 | These three files contain the private parts of the host keys |
| 843 | and are used for |
| 844 | .Cm RhostsRSAAuthentication |
| 845 | and |
| 846 | .Cm HostbasedAuthentication . |
Ben Lindstrom | 5cac423 | 2002-06-11 15:45:02 +0000 | [diff] [blame] | 847 | If the protocol version 1 |
| 848 | .Cm RhostsRSAAuthentication |
Ben Lindstrom | cb72e4f | 2002-06-21 00:41:51 +0000 | [diff] [blame] | 849 | method is used, |
Damien Miller | 705499b | 2001-11-12 11:05:38 +1100 | [diff] [blame] | 850 | .Nm |
Ben Lindstrom | 5cac423 | 2002-06-11 15:45:02 +0000 | [diff] [blame] | 851 | must be setuid root, since the host key is readable only by root. |
| 852 | For protocol version 2, |
| 853 | .Nm |
| 854 | uses |
| 855 | .Xr ssh-keysign 8 |
| 856 | to access the host keys for |
| 857 | .Cm HostbasedAuthentication . |
| 858 | This eliminates the requirement that |
| 859 | .Nm |
| 860 | be setuid root when that authentication method is used. |
| 861 | By default |
| 862 | .Nm |
| 863 | is not setuid root. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 864 | .It Pa $HOME/.rhosts |
| 865 | This file is used in |
| 866 | .Pa \&.rhosts |
| 867 | authentication to list the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 868 | host/user pairs that are permitted to log in. |
| 869 | (Note that this file is |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 870 | also used by rlogin and rsh, which makes using this file insecure.) |
| 871 | Each line of the file contains a host name (in the canonical form |
| 872 | returned by name servers), and then a user name on that host, |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 873 | separated by a space. |
Ben Lindstrom | ebd888d | 2001-03-05 05:49:29 +0000 | [diff] [blame] | 874 | On some machines this file may need to be |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 875 | world-readable if the user's home directory is on a NFS partition, |
| 876 | because |
| 877 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 878 | reads it as root. |
| 879 | Additionally, this file must be owned by the user, |
| 880 | and must not have write permissions for anyone else. |
| 881 | The recommended |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 882 | permission for most machines is read/write for the user, and not |
| 883 | accessible by others. |
| 884 | .Pp |
| 885 | Note that by default |
| 886 | .Xr sshd 8 |
| 887 | will be installed so that it requires successful RSA host |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 888 | authentication before permitting \s+2.\s0rhosts authentication. |
Ben Lindstrom | 594e203 | 2001-09-12 18:35:30 +0000 | [diff] [blame] | 889 | If the server machine does not have the client's host key in |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 890 | .Pa /etc/ssh/ssh_known_hosts , |
Ben Lindstrom | 594e203 | 2001-09-12 18:35:30 +0000 | [diff] [blame] | 891 | it can be stored in |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 892 | .Pa $HOME/.ssh/known_hosts . |
| 893 | The easiest way to do this is to |
| 894 | connect back to the client from the server machine using ssh; this |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 895 | will automatically add the host key to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 896 | .Pa $HOME/.ssh/known_hosts . |
| 897 | .It Pa $HOME/.shosts |
| 898 | This file is used exactly the same way as |
| 899 | .Pa \&.rhosts . |
| 900 | The purpose for |
| 901 | having this file is to be able to use rhosts authentication with |
| 902 | .Nm |
| 903 | without permitting login with |
Ben Lindstrom | c57bbf1 | 2002-05-15 21:36:45 +0000 | [diff] [blame] | 904 | .Nm rlogin |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 905 | or |
| 906 | .Xr rsh 1 . |
| 907 | .It Pa /etc/hosts.equiv |
| 908 | This file is used during |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 909 | .Pa \&.rhosts authentication. |
| 910 | It contains |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 911 | canonical hosts names, one per line (the full format is described on |
| 912 | the |
| 913 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 914 | manual page). |
| 915 | If the client host is found in this file, login is |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 916 | automatically permitted provided client and server user names are the |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 917 | same. |
| 918 | Additionally, successful RSA host authentication is normally |
| 919 | required. |
| 920 | This file should only be writable by root. |
Damien Miller | 886c63a | 2000-01-20 23:13:36 +1100 | [diff] [blame] | 921 | .It Pa /etc/shosts.equiv |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 922 | This file is processed exactly as |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 923 | .Pa /etc/hosts.equiv . |
| 924 | This file may be useful to permit logins using |
| 925 | .Nm |
| 926 | but not using rsh/rlogin. |
Damien Miller | 05eda43 | 2002-02-10 18:32:28 +1100 | [diff] [blame] | 927 | .It Pa /etc/ssh/sshrc |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 928 | Commands in this file are executed by |
| 929 | .Nm |
| 930 | when the user logs in just before the user's shell (or command) is started. |
| 931 | See the |
| 932 | .Xr sshd 8 |
| 933 | manual page for more information. |
| 934 | .It Pa $HOME/.ssh/rc |
| 935 | Commands in this file are executed by |
| 936 | .Nm |
| 937 | when the user logs in just before the user's shell (or command) is |
| 938 | started. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 939 | See the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 940 | .Xr sshd 8 |
| 941 | manual page for more information. |
Damien Miller | 4f0fa56 | 1999-12-26 14:24:41 +1100 | [diff] [blame] | 942 | .It Pa $HOME/.ssh/environment |
| 943 | Contains additional definitions for environment variables, see section |
| 944 | .Sx ENVIRONMENT |
| 945 | above. |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 946 | .El |
Damien Miller | 07a2d42 | 2002-02-05 12:16:15 +1100 | [diff] [blame] | 947 | .Sh DIAGNOSTICS |
| 948 | .Nm |
| 949 | exits with the exit status of the remote command or with 255 |
| 950 | if an error occurred. |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 951 | .Sh AUTHORS |
Ben Lindstrom | 035782e | 2001-01-29 08:34:16 +0000 | [diff] [blame] | 952 | OpenSSH is a derivative of the original and free |
| 953 | ssh 1.2.12 release by Tatu Ylonen. |
| 954 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| 955 | Theo de Raadt and Dug Song |
| 956 | removed many bugs, re-added newer features and |
| 957 | created OpenSSH. |
| 958 | Markus Friedl contributed the support for SSH |
| 959 | protocol versions 1.5 and 2.0. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 960 | .Sh SEE ALSO |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 961 | .Xr rsh 1 , |
| 962 | .Xr scp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 963 | .Xr sftp 1 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 964 | .Xr ssh-add 1 , |
| 965 | .Xr ssh-agent 1 , |
| 966 | .Xr ssh-keygen 1 , |
| 967 | .Xr telnet 1 , |
Ben Lindstrom | bf69e3b | 2002-06-23 00:31:24 +0000 | [diff] [blame] | 968 | .Xr ssh_config 5 , |
Ben Lindstrom | c001cd3 | 2002-06-23 00:32:11 +0000 | [diff] [blame] | 969 | .Xr ssh-keysign 8 , |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 970 | .Xr sshd 8 |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 971 | .Rs |
| 972 | .%A T. Ylonen |
| 973 | .%A T. Kivinen |
| 974 | .%A M. Saarinen |
| 975 | .%A T. Rinne |
| 976 | .%A S. Lehtinen |
| 977 | .%T "SSH Protocol Architecture" |
Ben Lindstrom | f181384 | 2002-03-27 17:18:31 +0000 | [diff] [blame] | 978 | .%N draft-ietf-secsh-architecture-12.txt |
| 979 | .%D January 2002 |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 980 | .%O work in progress material |
| 981 | .Re |