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 | .\" |
Darren Tucker | 7a4a765 | 2009-10-11 21:51:40 +1100 | [diff] [blame^] | 37 | .\" $OpenBSD: ssh.1,v 1.284 2009/10/08 20:42:12 jmc Exp $ |
| 38 | .Dd $Mdocdate: October 8 2009 $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 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 |
Damien Miller | e272a5b | 2008-11-03 19:22:37 +1100 | [diff] [blame] | 46 | .Op Fl 1246AaCfgKkMNnqsTtVvXxYy |
Ben Lindstrom | e0f8804 | 2001-04-30 13:06:24 +0000 | [diff] [blame] | 47 | .Op Fl b Ar bind_address |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 48 | .Op Fl c Ar cipher_spec |
Darren Tucker | c8d6421 | 2005-10-03 18:13:42 +1000 | [diff] [blame] | 49 | .Oo Fl D\ \& |
| 50 | .Sm off |
| 51 | .Oo Ar bind_address : Oc |
| 52 | .Ar port |
| 53 | .Sm on |
| 54 | .Oc |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 55 | .Op Fl e Ar escape_char |
Ben Lindstrom | 14f31ab | 2001-09-12 17:48:04 +0000 | [diff] [blame] | 56 | .Op Fl F Ar configfile |
Darren Tucker | 05d4dfe | 2005-10-03 18:17:38 +1000 | [diff] [blame] | 57 | .Bk -words |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 58 | .Op Fl i Ar identity_file |
Darren Tucker | 05d4dfe | 2005-10-03 18:17:38 +1000 | [diff] [blame] | 59 | .Ek |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 60 | .Oo Fl L\ \& |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 61 | .Sm off |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 62 | .Oo Ar bind_address : Oc |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 63 | .Ar port : host : hostport |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 64 | .Sm on |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 65 | .Oc |
Darren Tucker | 05d4dfe | 2005-10-03 18:17:38 +1000 | [diff] [blame] | 66 | .Bk -words |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 67 | .Op Fl l Ar login_name |
Darren Tucker | 05d4dfe | 2005-10-03 18:17:38 +1000 | [diff] [blame] | 68 | .Ek |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 69 | .Op Fl m Ar mac_spec |
Darren Tucker | 7ebfc10 | 2004-11-07 20:06:19 +1100 | [diff] [blame] | 70 | .Op Fl O Ar ctl_cmd |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 71 | .Op Fl o Ar option |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 72 | .Op Fl p Ar port |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 73 | .Oo Fl R\ \& |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 74 | .Sm off |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 75 | .Oo Ar bind_address : Oc |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 76 | .Ar port : host : hostport |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 77 | .Sm on |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 78 | .Oc |
Darren Tucker | 7ebfc10 | 2004-11-07 20:06:19 +1100 | [diff] [blame] | 79 | .Op Fl S Ar ctl_path |
Damien Miller | f0c8c15 | 2005-12-13 19:29:58 +1100 | [diff] [blame] | 80 | .Bk -words |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 81 | .Oo Fl w Ar local_tun Ns |
| 82 | .Op : Ns Ar remote_tun Oc |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 83 | .Oo Ar user Ns @ Oc Ns Ar hostname |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 84 | .Op Ar command |
Damien Miller | f0c8c15 | 2005-12-13 19:29:58 +1100 | [diff] [blame] | 85 | .Ek |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 86 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 87 | .Nm |
Ben Lindstrom | d58eb5f | 2001-03-07 06:07:22 +0000 | [diff] [blame] | 88 | (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] | 89 | executing commands on a remote machine. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 90 | It is intended to replace rlogin and rsh, |
| 91 | and provide secure encrypted communications between |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 92 | two untrusted hosts over an insecure network. |
Damien Miller | 8bfaf93 | 2006-01-14 10:09:30 +1100 | [diff] [blame] | 93 | X11 connections and arbitrary TCP ports |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 94 | can also be forwarded over the secure channel. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 95 | .Pp |
| 96 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 97 | connects and logs into the specified |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 98 | .Ar hostname |
| 99 | (with optional |
| 100 | .Ar user |
| 101 | name). |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 102 | The user must prove |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 103 | his/her identity to the remote machine using one of several methods |
Darren Tucker | 5434cfe | 2005-12-20 16:11:35 +1100 | [diff] [blame] | 104 | depending on the protocol version used (see below). |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 105 | .Pp |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 106 | If |
| 107 | .Ar command |
| 108 | is specified, |
Darren Tucker | b18c867 | 2005-12-20 16:10:09 +1100 | [diff] [blame] | 109 | it is executed on the remote host instead of a login shell. |
Darren Tucker | 0b42e6d | 2004-08-13 21:22:40 +1000 | [diff] [blame] | 110 | .Pp |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 111 | The options are as follows: |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 112 | .Bl -tag -width Ds |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 113 | .It Fl 1 |
| 114 | Forces |
| 115 | .Nm |
| 116 | to try protocol version 1 only. |
| 117 | .It Fl 2 |
| 118 | Forces |
| 119 | .Nm |
| 120 | to try protocol version 2 only. |
| 121 | .It Fl 4 |
| 122 | Forces |
| 123 | .Nm |
| 124 | to use IPv4 addresses only. |
| 125 | .It Fl 6 |
| 126 | Forces |
| 127 | .Nm |
| 128 | to use IPv6 addresses only. |
Damien Miller | b1715dc | 2000-05-30 13:44:51 +1000 | [diff] [blame] | 129 | .It Fl A |
| 130 | Enables forwarding of the authentication agent connection. |
| 131 | This can also be specified on a per-host basis in a configuration file. |
Damien Miller | b5fdfaa | 2002-09-12 09:52:03 +1000 | [diff] [blame] | 132 | .Pp |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 133 | Agent forwarding should be enabled with caution. |
| 134 | Users with the ability to bypass file permissions on the remote host |
| 135 | (for the agent's Unix-domain socket) |
| 136 | can access the local agent through the forwarded connection. |
| 137 | An attacker cannot obtain key material from the agent, |
Damien Miller | b5fdfaa | 2002-09-12 09:52:03 +1000 | [diff] [blame] | 138 | however they can perform operations on the keys that enable them to |
| 139 | authenticate using the identities loaded into the agent. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 140 | .It Fl a |
| 141 | Disables forwarding of the authentication agent connection. |
Ben Lindstrom | e0f8804 | 2001-04-30 13:06:24 +0000 | [diff] [blame] | 142 | .It Fl b Ar bind_address |
Darren Tucker | a5cf855 | 2005-07-14 17:04:18 +1000 | [diff] [blame] | 143 | Use |
| 144 | .Ar bind_address |
| 145 | on the local machine as the source address |
| 146 | of the connection. |
| 147 | Only useful on systems with more than one address. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 148 | .It Fl C |
| 149 | Requests compression of all data (including stdin, stdout, stderr, and |
Damien Miller | 8bfaf93 | 2006-01-14 10:09:30 +1100 | [diff] [blame] | 150 | data for forwarded X11 and TCP connections). |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 151 | The compression algorithm is the same used by |
| 152 | .Xr gzip 1 , |
| 153 | and the |
| 154 | .Dq level |
| 155 | can be controlled by the |
| 156 | .Cm CompressionLevel |
| 157 | option for protocol version 1. |
| 158 | Compression is desirable on modem lines and other |
| 159 | slow connections, but will only slow down things on fast networks. |
| 160 | The default value can be set on a host-by-host basis in the |
| 161 | configuration files; see the |
| 162 | .Cm Compression |
| 163 | option. |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 164 | .It Fl c Ar cipher_spec |
| 165 | Selects the cipher specification for encrypting the session. |
| 166 | .Pp |
| 167 | Protocol version 1 allows specification of a single cipher. |
Darren Tucker | 1e4308e | 2005-10-03 18:18:40 +1000 | [diff] [blame] | 168 | The supported values are |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 169 | .Dq 3des , |
Darren Tucker | ff9f484 | 2005-12-20 16:10:45 +1100 | [diff] [blame] | 170 | .Dq blowfish , |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 171 | and |
| 172 | .Dq des . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 173 | .Ar 3des |
| 174 | (triple-des) is an encrypt-decrypt-encrypt triple with three different keys. |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 175 | It is believed to be secure. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 176 | .Ar blowfish |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 177 | 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] | 178 | .Ar 3des . |
Ben Lindstrom | ffa1dd6 | 2001-09-12 16:52:28 +0000 | [diff] [blame] | 179 | .Ar des |
| 180 | is only supported in the |
| 181 | .Nm |
| 182 | client for interoperability with legacy protocol 1 implementations |
| 183 | that do not support the |
| 184 | .Ar 3des |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 185 | cipher. |
| 186 | Its use is strongly discouraged due to cryptographic weaknesses. |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 187 | The default is |
| 188 | .Dq 3des . |
| 189 | .Pp |
Damien Miller | 3597821 | 2005-12-24 14:56:47 +1100 | [diff] [blame] | 190 | For protocol version 2, |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 191 | .Ar cipher_spec |
| 192 | is a comma-separated list of ciphers |
| 193 | listed in order of preference. |
Darren Tucker | 3a6a51f | 2009-06-21 17:48:52 +1000 | [diff] [blame] | 194 | See the |
| 195 | .Cm Ciphers |
| 196 | keyword for more information. |
Darren Tucker | c8d6421 | 2005-10-03 18:13:42 +1000 | [diff] [blame] | 197 | .It Fl D Xo |
| 198 | .Sm off |
| 199 | .Oo Ar bind_address : Oc |
| 200 | .Ar port |
| 201 | .Sm on |
| 202 | .Xc |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 203 | Specifies a local |
| 204 | .Dq dynamic |
| 205 | application-level port forwarding. |
| 206 | This works by allocating a socket to listen to |
| 207 | .Ar port |
Darren Tucker | c8d6421 | 2005-10-03 18:13:42 +1000 | [diff] [blame] | 208 | on the local side, optionally bound to the specified |
| 209 | .Ar bind_address . |
| 210 | Whenever a connection is made to this port, the |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 211 | connection is forwarded over the secure channel, and the application |
| 212 | protocol is then used to determine where to connect to from the |
| 213 | remote machine. |
| 214 | Currently the SOCKS4 and SOCKS5 protocols are supported, and |
| 215 | .Nm |
| 216 | will act as a SOCKS server. |
| 217 | Only root can forward privileged ports. |
| 218 | Dynamic port forwardings can also be specified in the configuration file. |
Darren Tucker | c8d6421 | 2005-10-03 18:13:42 +1000 | [diff] [blame] | 219 | .Pp |
| 220 | IPv6 addresses can be specified with an alternative syntax: |
| 221 | .Sm off |
| 222 | .Xo |
| 223 | .Op Ar bind_address No / |
| 224 | .Ar port |
| 225 | .Xc |
| 226 | .Sm on |
| 227 | or by enclosing the address in square brackets. |
| 228 | Only the superuser can forward privileged ports. |
| 229 | By default, the local port is bound in accordance with the |
| 230 | .Cm GatewayPorts |
| 231 | setting. |
| 232 | However, an explicit |
| 233 | .Ar bind_address |
| 234 | may be used to bind the connection to a specific address. |
| 235 | The |
| 236 | .Ar bind_address |
| 237 | of |
| 238 | .Dq localhost |
| 239 | indicates that the listening port be bound for local use only, while an |
| 240 | empty address or |
| 241 | .Sq * |
| 242 | indicates that the port should be available from all interfaces. |
Damien Miller | 2142ba0 | 2005-12-24 14:56:29 +1100 | [diff] [blame] | 243 | .It Fl e Ar escape_char |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 244 | Sets the escape character for sessions with a pty (default: |
| 245 | .Ql ~ ) . |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 246 | The escape character is only recognized at the beginning of a line. |
| 247 | The escape character followed by a dot |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 248 | .Pq Ql \&. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 249 | closes the connection; |
| 250 | followed by control-Z suspends the connection; |
| 251 | and followed by itself sends the escape character once. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 252 | Setting the character to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 253 | .Dq none |
| 254 | disables any escapes and makes the session fully transparent. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 255 | .It Fl F Ar configfile |
| 256 | Specifies an alternative per-user configuration file. |
| 257 | If a configuration file is given on the command line, |
| 258 | the system-wide configuration file |
| 259 | .Pq Pa /etc/ssh/ssh_config |
| 260 | will be ignored. |
| 261 | The default for the per-user configuration file is |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 262 | .Pa ~/.ssh/config . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 263 | .It Fl f |
| 264 | Requests |
| 265 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 266 | to go to background just before command execution. |
| 267 | This is useful if |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 268 | .Nm |
| 269 | is going to ask for passwords or passphrases, but the user |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 270 | wants it in the background. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 271 | This implies |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 272 | .Fl n . |
| 273 | The recommended way to start X11 programs at a remote site is with |
| 274 | something like |
| 275 | .Ic ssh -f host xterm . |
Darren Tucker | 9a2a609 | 2008-07-04 12:53:50 +1000 | [diff] [blame] | 276 | .Pp |
| 277 | If the |
| 278 | .Cm ExitOnForwardFailure |
| 279 | configuration option is set to |
| 280 | .Dq yes , |
| 281 | then a client started with |
| 282 | .Fl f |
| 283 | will wait for all remote port forwards to be successfully established |
| 284 | before placing itself in the background. |
Damien Miller | 396691a | 2000-01-20 22:44:08 +1100 | [diff] [blame] | 285 | .It Fl g |
| 286 | Allows remote hosts to connect to local forwarded ports. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 287 | .It Fl I Ar smartcard_device |
Damien Miller | 2142ba0 | 2005-12-24 14:56:29 +1100 | [diff] [blame] | 288 | Specify the device |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 289 | .Nm |
| 290 | should use to communicate with a smartcard used for storing the user's |
| 291 | private RSA key. |
Damien Miller | 2142ba0 | 2005-12-24 14:56:29 +1100 | [diff] [blame] | 292 | This option is only available if support for smartcard devices |
| 293 | is compiled in (default is no support). |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 294 | .It Fl i Ar identity_file |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 295 | Selects a file from which the identity (private key) for |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 296 | RSA or DSA authentication is read. |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 297 | The default is |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 298 | .Pa ~/.ssh/identity |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 299 | for protocol version 1, and |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 300 | .Pa ~/.ssh/id_rsa |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 301 | and |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 302 | .Pa ~/.ssh/id_dsa |
Damien Miller | fae2386 | 2002-01-22 23:32:26 +1100 | [diff] [blame] | 303 | for protocol version 2. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 304 | Identity files may also be specified on |
| 305 | a per-host basis in the configuration file. |
| 306 | It is possible to have multiple |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 307 | .Fl i |
| 308 | options (and multiple identities specified in |
| 309 | configuration files). |
Darren Tucker | 415bddc | 2007-06-12 23:43:16 +1000 | [diff] [blame] | 310 | .It Fl K |
| 311 | Enables GSSAPI-based authentication and forwarding (delegation) of GSSAPI |
| 312 | credentials to the server. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 313 | .It Fl k |
Damien Miller | e0113cc | 2003-11-24 13:10:09 +1100 | [diff] [blame] | 314 | Disables forwarding (delegation) of GSSAPI credentials to the server. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 315 | .It Fl L Xo |
| 316 | .Sm off |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 317 | .Oo Ar bind_address : Oc |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 318 | .Ar port : host : hostport |
| 319 | .Sm on |
| 320 | .Xc |
| 321 | Specifies that the given port on the local (client) host is to be |
| 322 | forwarded to the given host and port on the remote side. |
| 323 | This works by allocating a socket to listen to |
| 324 | .Ar port |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 325 | on the local side, optionally bound to the specified |
| 326 | .Ar bind_address . |
| 327 | Whenever a connection is made to this port, the |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 328 | connection is forwarded over the secure channel, and a connection is |
| 329 | made to |
| 330 | .Ar host |
| 331 | port |
| 332 | .Ar hostport |
| 333 | from the remote machine. |
| 334 | Port forwardings can also be specified in the configuration file. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 335 | IPv6 addresses can be specified with an alternative syntax: |
| 336 | .Sm off |
| 337 | .Xo |
Damien Miller | b096ac4 | 2005-03-09 11:00:05 +1100 | [diff] [blame] | 338 | .Op Ar bind_address No / |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 339 | .Ar port No / Ar host No / |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 340 | .Ar hostport |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 341 | .Xc |
| 342 | .Sm on |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 343 | or by enclosing the address in square brackets. |
| 344 | Only the superuser can forward privileged ports. |
| 345 | By default, the local port is bound in accordance with the |
| 346 | .Cm GatewayPorts |
| 347 | setting. |
| 348 | However, an explicit |
| 349 | .Ar bind_address |
| 350 | may be used to bind the connection to a specific address. |
| 351 | The |
| 352 | .Ar bind_address |
| 353 | of |
| 354 | .Dq localhost |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 355 | indicates that the listening port be bound for local use only, while an |
| 356 | empty address or |
| 357 | .Sq * |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 358 | indicates that the port should be available from all interfaces. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 359 | .It Fl l Ar login_name |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 360 | Specifies the user to log in as on the remote machine. |
| 361 | This also may be specified on a per-host basis in the configuration file. |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 362 | .It Fl M |
| 363 | Places the |
| 364 | .Nm |
| 365 | client into |
| 366 | .Dq master |
| 367 | mode for connection sharing. |
Damien Miller | 88b2552 | 2005-12-31 16:23:15 +1100 | [diff] [blame] | 368 | Multiple |
| 369 | .Fl M |
| 370 | options places |
| 371 | .Nm |
| 372 | into |
| 373 | .Dq master |
| 374 | mode with confirmation required before slave connections are accepted. |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 375 | Refer to the description of |
| 376 | .Cm ControlMaster |
| 377 | in |
| 378 | .Xr ssh_config 5 |
| 379 | for details. |
Damien Miller | 5d1eceb | 2004-06-30 22:37:57 +1000 | [diff] [blame] | 380 | .It Fl m Ar mac_spec |
| 381 | Additionally, for protocol version 2 a comma-separated list of MAC |
| 382 | (message authentication code) algorithms can |
| 383 | be specified in order of preference. |
| 384 | See the |
| 385 | .Cm MACs |
| 386 | keyword for more information. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 387 | .It Fl N |
| 388 | Do not execute a remote command. |
| 389 | This is useful for just forwarding ports |
| 390 | (protocol version 2 only). |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 391 | .It Fl n |
| 392 | Redirects stdin from |
| 393 | .Pa /dev/null |
| 394 | (actually, prevents reading from stdin). |
| 395 | This must be used when |
| 396 | .Nm |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 397 | is run in the background. |
| 398 | A common trick is to use this to run X11 programs on a remote machine. |
| 399 | For example, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 400 | .Ic ssh -n shadows.cs.hut.fi emacs & |
| 401 | will start an emacs on shadows.cs.hut.fi, and the X11 |
| 402 | connection will be automatically forwarded over an encrypted channel. |
| 403 | The |
| 404 | .Nm |
| 405 | program will be put in the background. |
| 406 | (This does not work if |
| 407 | .Nm |
| 408 | needs to ask for a password or passphrase; see also the |
| 409 | .Fl f |
| 410 | option.) |
Darren Tucker | e04644c | 2004-12-03 14:08:45 +1100 | [diff] [blame] | 411 | .It Fl O Ar ctl_cmd |
| 412 | Control an active connection multiplexing master process. |
| 413 | When the |
| 414 | .Fl O |
| 415 | option is specified, the |
| 416 | .Ar ctl_cmd |
| 417 | argument is interpreted and passed to the master process. |
| 418 | Valid commands are: |
| 419 | .Dq check |
| 420 | (check that the master process is running) and |
| 421 | .Dq exit |
| 422 | (request the master to exit). |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 423 | .It Fl o Ar option |
Ben Lindstrom | 14c62eb | 2001-08-15 23:25:46 +0000 | [diff] [blame] | 424 | 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] | 425 | This is useful for specifying options for which there is no separate |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 426 | command-line flag. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 427 | For full details of the options listed below, and their possible values, see |
| 428 | .Xr ssh_config 5 . |
| 429 | .Pp |
| 430 | .Bl -tag -width Ds -offset indent -compact |
| 431 | .It AddressFamily |
| 432 | .It BatchMode |
| 433 | .It BindAddress |
| 434 | .It ChallengeResponseAuthentication |
| 435 | .It CheckHostIP |
| 436 | .It Cipher |
| 437 | .It Ciphers |
| 438 | .It ClearAllForwardings |
| 439 | .It Compression |
| 440 | .It CompressionLevel |
| 441 | .It ConnectionAttempts |
Darren Tucker | edae0ec | 2004-05-02 22:15:52 +1000 | [diff] [blame] | 442 | .It ConnectTimeout |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 443 | .It ControlMaster |
| 444 | .It ControlPath |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 445 | .It DynamicForward |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 446 | .It EscapeChar |
Darren Tucker | e7d4b19 | 2006-07-12 22:17:10 +1000 | [diff] [blame] | 447 | .It ExitOnForwardFailure |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 448 | .It ForwardAgent |
| 449 | .It ForwardX11 |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 450 | .It ForwardX11Trusted |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 451 | .It GatewayPorts |
| 452 | .It GlobalKnownHostsFile |
| 453 | .It GSSAPIAuthentication |
| 454 | .It GSSAPIDelegateCredentials |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 455 | .It HashKnownHosts |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 456 | .It Host |
| 457 | .It HostbasedAuthentication |
| 458 | .It HostKeyAlgorithms |
| 459 | .It HostKeyAlias |
| 460 | .It HostName |
| 461 | .It IdentityFile |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 462 | .It IdentitiesOnly |
Darren Tucker | 636ca90 | 2004-11-05 20:22:00 +1100 | [diff] [blame] | 463 | .It KbdInteractiveDevices |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 464 | .It LocalCommand |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 465 | .It LocalForward |
| 466 | .It LogLevel |
| 467 | .It MACs |
| 468 | .It NoHostAuthenticationForLocalhost |
| 469 | .It NumberOfPasswordPrompts |
| 470 | .It PasswordAuthentication |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 471 | .It PermitLocalCommand |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 472 | .It Port |
| 473 | .It PreferredAuthentications |
| 474 | .It Protocol |
| 475 | .It ProxyCommand |
| 476 | .It PubkeyAuthentication |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 477 | .It RekeyLimit |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 478 | .It RemoteForward |
| 479 | .It RhostsRSAAuthentication |
| 480 | .It RSAAuthentication |
Darren Tucker | 7a6c066 | 2004-05-02 22:14:03 +1000 | [diff] [blame] | 481 | .It SendEnv |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 482 | .It ServerAliveInterval |
| 483 | .It ServerAliveCountMax |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 484 | .It SmartcardDevice |
| 485 | .It StrictHostKeyChecking |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 486 | .It TCPKeepAlive |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 487 | .It Tunnel |
| 488 | .It TunnelDevice |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 489 | .It UsePrivilegedPort |
| 490 | .It User |
| 491 | .It UserKnownHostsFile |
| 492 | .It VerifyHostKeyDNS |
Damien Miller | 8639920 | 2008-06-30 00:04:31 +1000 | [diff] [blame] | 493 | .It VisualHostKey |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 494 | .It XAuthLocation |
| 495 | .El |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 496 | .It Fl p Ar port |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 497 | Port to connect to on the remote host. |
| 498 | This can be specified on a |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 499 | per-host basis in the configuration file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 500 | .It Fl q |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 501 | Quiet mode. |
Damien Miller | eb60247 | 2008-02-10 22:21:28 +1100 | [diff] [blame] | 502 | Causes most warning and diagnostic messages to be suppressed. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 503 | .It Fl R Xo |
| 504 | .Sm off |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 505 | .Oo Ar bind_address : Oc |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 506 | .Ar port : host : hostport |
| 507 | .Sm on |
| 508 | .Xc |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 509 | 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] | 510 | forwarded to the given host and port on the local side. |
| 511 | This works by allocating a socket to listen to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 512 | .Ar port |
| 513 | on the remote side, and whenever a connection is made to this port, the |
| 514 | connection is forwarded over the secure channel, and a connection is |
| 515 | made to |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 516 | .Ar host |
| 517 | port |
| 518 | .Ar hostport |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 519 | from the local machine. |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 520 | .Pp |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 521 | Port forwardings can also be specified in the configuration file. |
| 522 | Privileged ports can be forwarded only when |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 523 | logging in as root on the remote machine. |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 524 | IPv6 addresses can be specified by enclosing the address in square braces or |
| 525 | using an alternative syntax: |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 526 | .Sm off |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 527 | .Xo |
Damien Miller | b096ac4 | 2005-03-09 11:00:05 +1100 | [diff] [blame] | 528 | .Op Ar bind_address No / |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 529 | .Ar host No / Ar port No / |
| 530 | .Ar hostport |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 531 | .Xc . |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 532 | .Sm on |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 533 | .Pp |
| 534 | By default, the listening socket on the server will be bound to the loopback |
| 535 | interface only. |
Darren Tucker | 63917bd | 2008-11-11 16:33:48 +1100 | [diff] [blame] | 536 | This may be overridden by specifying a |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 537 | .Ar bind_address . |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 538 | An empty |
| 539 | .Ar bind_address , |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 540 | or the address |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 541 | .Ql * , |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 542 | indicates that the remote socket should listen on all interfaces. |
| 543 | Specifying a remote |
| 544 | .Ar bind_address |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 545 | will only succeed if the server's |
| 546 | .Cm GatewayPorts |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 547 | option is enabled (see |
Damien Miller | 36bf7dd | 2005-03-02 12:02:47 +1100 | [diff] [blame] | 548 | .Xr sshd_config 5 ) . |
Damien Miller | e2f4cc5 | 2009-02-14 16:33:49 +1100 | [diff] [blame] | 549 | .Pp |
| 550 | If the |
| 551 | .Ar port |
| 552 | argument is |
Damien Miller | 65fa4ca | 2009-02-14 16:34:05 +1100 | [diff] [blame] | 553 | .Ql 0 , |
Damien Miller | e2f4cc5 | 2009-02-14 16:33:49 +1100 | [diff] [blame] | 554 | the listen port will be dynamically allocated on the server and reported |
| 555 | to the client at run time. |
Darren Tucker | 7ebfc10 | 2004-11-07 20:06:19 +1100 | [diff] [blame] | 556 | .It Fl S Ar ctl_path |
Damien Miller | 5d1eceb | 2004-06-30 22:37:57 +1000 | [diff] [blame] | 557 | Specifies the location of a control socket for connection sharing. |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 558 | Refer to the description of |
Darren Tucker | ba5c592 | 2004-06-18 16:22:39 +1000 | [diff] [blame] | 559 | .Cm ControlPath |
| 560 | and |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 561 | .Cm ControlMaster |
| 562 | in |
| 563 | .Xr ssh_config 5 |
| 564 | for details. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 565 | .It Fl s |
| 566 | May be used to request invocation of a subsystem on the remote system. |
| 567 | Subsystems are a feature of the SSH2 protocol which facilitate the use |
| 568 | of SSH as a secure transport for other applications (eg.\& |
| 569 | .Xr sftp 1 ) . |
| 570 | The subsystem is specified as the remote command. |
| 571 | .It Fl T |
| 572 | Disable pseudo-tty allocation. |
| 573 | .It Fl t |
| 574 | Force pseudo-tty allocation. |
| 575 | This can be used to execute arbitrary |
| 576 | screen-based programs on a remote machine, which can be very useful, |
Damien Miller | 208f1ed | 2006-03-15 11:56:03 +1100 | [diff] [blame] | 577 | e.g. when implementing menu services. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 578 | Multiple |
| 579 | .Fl t |
| 580 | options force tty allocation, even if |
Ben Lindstrom | 19ceb17 | 2001-09-12 17:54:24 +0000 | [diff] [blame] | 581 | .Nm |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 582 | has no local tty. |
| 583 | .It Fl V |
| 584 | Display the version number and exit. |
| 585 | .It Fl v |
| 586 | Verbose mode. |
| 587 | Causes |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 588 | .Nm |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 589 | to print debugging messages about its progress. |
| 590 | This is helpful in |
| 591 | debugging connection, authentication, and configuration problems. |
| 592 | Multiple |
| 593 | .Fl v |
| 594 | options increase the verbosity. |
| 595 | The maximum is 3. |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 596 | .It Fl w Xo |
| 597 | .Ar local_tun Ns Op : Ns Ar remote_tun |
| 598 | .Xc |
| 599 | Requests |
| 600 | tunnel |
| 601 | device forwarding with the specified |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 602 | .Xr tun 4 |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 603 | devices between the client |
| 604 | .Pq Ar local_tun |
| 605 | and the server |
| 606 | .Pq Ar remote_tun . |
| 607 | .Pp |
Damien Miller | cf1e342 | 2005-12-24 14:56:04 +1100 | [diff] [blame] | 608 | The devices may be specified by numerical ID or the keyword |
| 609 | .Dq any , |
| 610 | which uses the next available tunnel device. |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 611 | If |
| 612 | .Ar remote_tun |
| 613 | is not specified, it defaults to |
| 614 | .Dq any . |
Damien Miller | cf1e342 | 2005-12-24 14:56:04 +1100 | [diff] [blame] | 615 | See also the |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 616 | .Cm Tunnel |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 617 | and |
| 618 | .Cm TunnelDevice |
| 619 | directives in |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 620 | .Xr ssh_config 5 . |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 621 | If the |
| 622 | .Cm Tunnel |
| 623 | directive is unset, it is set to the default tunnel mode, which is |
| 624 | .Dq point-to-point . |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 625 | .It Fl X |
| 626 | Enables X11 forwarding. |
| 627 | This can also be specified on a per-host basis in a configuration file. |
| 628 | .Pp |
| 629 | X11 forwarding should be enabled with caution. |
| 630 | Users with the ability to bypass file permissions on the remote host |
| 631 | (for the user's X authorization database) |
| 632 | can access the local X11 display through the forwarded connection. |
| 633 | An attacker may then be able to perform activities such as keystroke monitoring. |
Damien Miller | 947219e | 2005-03-02 13:22:30 +1100 | [diff] [blame] | 634 | .Pp |
Damien Miller | b022b23 | 2005-03-05 11:22:36 +1100 | [diff] [blame] | 635 | For this reason, X11 forwarding is subjected to X11 SECURITY extension |
Damien Miller | 947219e | 2005-03-02 13:22:30 +1100 | [diff] [blame] | 636 | restrictions by default. |
| 637 | Please refer to the |
| 638 | .Nm |
| 639 | .Fl Y |
| 640 | option and the |
| 641 | .Cm ForwardX11Trusted |
| 642 | directive in |
| 643 | .Xr ssh_config 5 |
| 644 | for more information. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 645 | .It Fl x |
| 646 | Disables X11 forwarding. |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 647 | .It Fl Y |
| 648 | Enables trusted X11 forwarding. |
Damien Miller | 947219e | 2005-03-02 13:22:30 +1100 | [diff] [blame] | 649 | Trusted X11 forwardings are not subjected to the X11 SECURITY extension |
| 650 | controls. |
Damien Miller | e272a5b | 2008-11-03 19:22:37 +1100 | [diff] [blame] | 651 | .It Fl y |
| 652 | Send log information using the |
| 653 | .Xr syslog 3 |
| 654 | system module. |
| 655 | By default this information is sent to stderr. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 656 | .El |
Damien Miller | e9b333a | 2005-12-24 14:53:04 +1100 | [diff] [blame] | 657 | .Pp |
| 658 | .Nm |
| 659 | may additionally obtain configuration data from |
| 660 | a per-user configuration file and a system-wide configuration file. |
| 661 | The file format and configuration options are described in |
| 662 | .Xr ssh_config 5 . |
| 663 | .Pp |
| 664 | .Nm |
| 665 | exits with the exit status of the remote command or with 255 |
| 666 | if an error occurred. |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 667 | .Sh AUTHENTICATION |
Darren Tucker | 94299ec | 2006-01-20 11:30:14 +1100 | [diff] [blame] | 668 | The OpenSSH SSH client supports SSH protocols 1 and 2. |
Darren Tucker | 7a4a765 | 2009-10-11 21:51:40 +1100 | [diff] [blame^] | 669 | The default is to use protocol 2 only, |
| 670 | though this can be changed via the |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 671 | .Cm Protocol |
| 672 | option in |
Darren Tucker | 7a4a765 | 2009-10-11 21:51:40 +1100 | [diff] [blame^] | 673 | .Xr ssh_config 5 |
| 674 | or the |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 675 | .Fl 1 |
| 676 | and |
| 677 | .Fl 2 |
| 678 | options (see above). |
| 679 | Both protocols support similar authentication methods, |
Darren Tucker | 7a4a765 | 2009-10-11 21:51:40 +1100 | [diff] [blame^] | 680 | but protocol 2 is the default since |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 681 | it provides additional mechanisms for confidentiality |
| 682 | (the traffic is encrypted using AES, 3DES, Blowfish, CAST128, or Arcfour) |
Damien Miller | e45796f | 2007-06-11 14:01:42 +1000 | [diff] [blame] | 683 | and integrity (hmac-md5, hmac-sha1, umac-64, hmac-ripemd160). |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 684 | Protocol 1 lacks a strong mechanism for ensuring the |
| 685 | integrity of the connection. |
| 686 | .Pp |
| 687 | The methods available for authentication are: |
Damien Miller | fbc94c8 | 2006-06-13 13:03:16 +1000 | [diff] [blame] | 688 | GSSAPI-based authentication, |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 689 | host-based authentication, |
| 690 | public key authentication, |
| 691 | challenge-response authentication, |
| 692 | and password authentication. |
| 693 | Authentication methods are tried in the order specified above, |
| 694 | though protocol 2 has a configuration option to change the default order: |
| 695 | .Cm PreferredAuthentications . |
| 696 | .Pp |
| 697 | Host-based authentication works as follows: |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 698 | If the machine the user logs in from is listed in |
| 699 | .Pa /etc/hosts.equiv |
| 700 | or |
| 701 | .Pa /etc/shosts.equiv |
| 702 | on the remote machine, and the user names are |
| 703 | the same on both sides, or if the files |
| 704 | .Pa ~/.rhosts |
| 705 | or |
| 706 | .Pa ~/.shosts |
| 707 | exist in the user's home directory on the |
| 708 | remote machine and contain a line containing the name of the client |
| 709 | machine and the name of the user on that machine, the user is |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 710 | considered for login. |
| 711 | Additionally, the server |
| 712 | .Em must |
| 713 | be able to verify the client's |
| 714 | host key (see the description of |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 715 | .Pa /etc/ssh/ssh_known_hosts |
| 716 | and |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 717 | .Pa ~/.ssh/known_hosts , |
| 718 | below) |
| 719 | for login to be permitted. |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 720 | This authentication method closes security holes due to IP |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 721 | spoofing, DNS spoofing, and routing spoofing. |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 722 | [Note to the administrator: |
| 723 | .Pa /etc/hosts.equiv , |
| 724 | .Pa ~/.rhosts , |
| 725 | and the rlogin/rsh protocol in general, are inherently insecure and should be |
| 726 | disabled if security is desired.] |
| 727 | .Pp |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 728 | Public key authentication works as follows: |
| 729 | The scheme is based on public-key cryptography, |
| 730 | using cryptosystems |
| 731 | where encryption and decryption are done using separate keys, |
| 732 | and it is unfeasible to derive the decryption key from the encryption key. |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 733 | The idea is that each user creates a public/private |
| 734 | key pair for authentication purposes. |
| 735 | The server knows the public key, and only the user knows the private key. |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 736 | .Nm |
| 737 | implements public key authentication protocol automatically, |
| 738 | using either the RSA or DSA algorithms. |
| 739 | Protocol 1 is restricted to using only RSA keys, |
| 740 | but protocol 2 may use either. |
| 741 | The |
| 742 | .Sx HISTORY |
| 743 | section of |
| 744 | .Xr ssl 8 |
| 745 | contains a brief discussion of the two algorithms. |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 746 | .Pp |
| 747 | The file |
| 748 | .Pa ~/.ssh/authorized_keys |
| 749 | lists the public keys that are permitted for logging in. |
| 750 | When the user logs in, the |
| 751 | .Nm |
| 752 | program tells the server which key pair it would like to use for |
| 753 | authentication. |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 754 | The client proves that it has access to the private key |
| 755 | and the server checks that the corresponding public key |
| 756 | is authorized to accept the account. |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 757 | .Pp |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 758 | The user creates his/her key pair by running |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 759 | .Xr ssh-keygen 1 . |
| 760 | This stores the private key in |
| 761 | .Pa ~/.ssh/identity |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 762 | (protocol 1), |
| 763 | .Pa ~/.ssh/id_dsa |
| 764 | (protocol 2 DSA), |
| 765 | or |
| 766 | .Pa ~/.ssh/id_rsa |
| 767 | (protocol 2 RSA) |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 768 | and stores the public key in |
| 769 | .Pa ~/.ssh/identity.pub |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 770 | (protocol 1), |
| 771 | .Pa ~/.ssh/id_dsa.pub |
| 772 | (protocol 2 DSA), |
| 773 | or |
| 774 | .Pa ~/.ssh/id_rsa.pub |
| 775 | (protocol 2 RSA) |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 776 | in the user's home directory. |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 777 | The user should then copy the public key |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 778 | to |
| 779 | .Pa ~/.ssh/authorized_keys |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 780 | in his/her home directory on the remote machine. |
| 781 | The |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 782 | .Pa authorized_keys |
| 783 | file corresponds to the conventional |
| 784 | .Pa ~/.rhosts |
| 785 | file, and has one key |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 786 | per line, though the lines can be very long. |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 787 | After this, the user can log in without giving the password. |
| 788 | .Pp |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 789 | The most convenient way to use public key authentication may be with an |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 790 | authentication agent. |
| 791 | See |
| 792 | .Xr ssh-agent 1 |
| 793 | for more information. |
| 794 | .Pp |
Damien Miller | c93a813 | 2005-12-24 14:52:13 +1100 | [diff] [blame] | 795 | Challenge-response authentication works as follows: |
| 796 | The server sends an arbitrary |
| 797 | .Qq challenge |
| 798 | text, and prompts for a response. |
| 799 | Protocol 2 allows multiple challenges and responses; |
| 800 | protocol 1 is restricted to just one challenge/response. |
| 801 | Examples of challenge-response authentication include |
| 802 | BSD Authentication (see |
| 803 | .Xr login.conf 5 ) |
| 804 | and PAM (some non-OpenBSD systems). |
| 805 | .Pp |
| 806 | Finally, if other authentication methods fail, |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 807 | .Nm |
| 808 | prompts the user for a password. |
| 809 | The password is sent to the remote |
| 810 | host for checking; however, since all communications are encrypted, |
| 811 | the password cannot be seen by someone listening on the network. |
Damien Miller | 48c94ab | 2006-01-02 23:38:00 +1100 | [diff] [blame] | 812 | .Pp |
| 813 | .Nm |
| 814 | automatically maintains and checks a database containing |
| 815 | identification for all hosts it has ever been used with. |
| 816 | Host keys are stored in |
| 817 | .Pa ~/.ssh/known_hosts |
| 818 | in the user's home directory. |
| 819 | Additionally, the file |
| 820 | .Pa /etc/ssh/ssh_known_hosts |
| 821 | is automatically checked for known hosts. |
| 822 | Any new hosts are automatically added to the user's file. |
| 823 | If a host's identification ever changes, |
| 824 | .Nm |
| 825 | warns about this and disables password authentication to prevent |
| 826 | server spoofing or man-in-the-middle attacks, |
| 827 | which could otherwise be used to circumvent the encryption. |
| 828 | The |
| 829 | .Cm StrictHostKeyChecking |
| 830 | option can be used to control logins to machines whose |
| 831 | host key is not known or has changed. |
| 832 | .Pp |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 833 | When the user's identity has been accepted by the server, the server |
| 834 | either executes the given command, or logs into the machine and gives |
| 835 | the user a normal shell on the remote machine. |
| 836 | All communication with |
| 837 | the remote command or shell will be automatically encrypted. |
| 838 | .Pp |
| 839 | If a pseudo-terminal has been allocated (normal login session), the |
| 840 | user may use the escape characters noted below. |
| 841 | .Pp |
| 842 | If no pseudo-tty has been allocated, |
| 843 | the session is transparent and can be used to reliably transfer binary data. |
| 844 | On most systems, setting the escape character to |
| 845 | .Dq none |
| 846 | will also make the session transparent even if a tty is used. |
| 847 | .Pp |
| 848 | The session terminates when the command or shell on the remote |
Damien Miller | 8bfaf93 | 2006-01-14 10:09:30 +1100 | [diff] [blame] | 849 | machine exits and all X11 and TCP connections have been closed. |
Damien Miller | 52d2061 | 2005-12-24 14:52:36 +1100 | [diff] [blame] | 850 | .Sh ESCAPE CHARACTERS |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 851 | When a pseudo-terminal has been requested, |
| 852 | .Nm |
| 853 | supports a number of functions through the use of an escape character. |
| 854 | .Pp |
| 855 | A single tilde character can be sent as |
| 856 | .Ic ~~ |
| 857 | or by following the tilde by a character other than those described below. |
| 858 | The escape character must always follow a newline to be interpreted as |
| 859 | special. |
| 860 | The escape character can be changed in configuration files using the |
| 861 | .Cm EscapeChar |
| 862 | configuration directive or on the command line by the |
| 863 | .Fl e |
| 864 | option. |
| 865 | .Pp |
| 866 | The supported escapes (assuming the default |
| 867 | .Ql ~ ) |
| 868 | are: |
| 869 | .Bl -tag -width Ds |
| 870 | .It Cm ~. |
| 871 | Disconnect. |
| 872 | .It Cm ~^Z |
| 873 | Background |
Damien Miller | 1164c29 | 2006-01-02 23:38:37 +1100 | [diff] [blame] | 874 | .Nm . |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 875 | .It Cm ~# |
| 876 | List forwarded connections. |
| 877 | .It Cm ~& |
| 878 | Background |
| 879 | .Nm |
| 880 | at logout when waiting for forwarded connection / X11 sessions to terminate. |
| 881 | .It Cm ~? |
| 882 | Display a list of escape characters. |
| 883 | .It Cm ~B |
| 884 | Send a BREAK to the remote system |
| 885 | (only useful for SSH protocol version 2 and if the peer supports it). |
| 886 | .It Cm ~C |
| 887 | Open command line. |
| 888 | Currently this allows the addition of port forwardings using the |
Damien Miller | 0164cb8 | 2008-11-05 16:30:31 +1100 | [diff] [blame] | 889 | .Fl L , |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 890 | .Fl R |
Damien Miller | 0164cb8 | 2008-11-05 16:30:31 +1100 | [diff] [blame] | 891 | and |
| 892 | .Fl D |
Damien Miller | 329cb01 | 2005-12-24 14:53:23 +1100 | [diff] [blame] | 893 | options (see above). |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 894 | It also allows the cancellation of existing remote port-forwardings |
| 895 | using |
Damien Miller | 57e8ad3 | 2006-07-10 20:20:52 +1000 | [diff] [blame] | 896 | .Sm off |
| 897 | .Fl KR Oo Ar bind_address : Oc Ar port . |
| 898 | .Sm on |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 899 | .Ic !\& Ns Ar command |
| 900 | allows the user to execute a local command if the |
| 901 | .Ic PermitLocalCommand |
| 902 | option is enabled in |
| 903 | .Xr ssh_config 5 . |
| 904 | Basic help is available, using the |
| 905 | .Fl h |
| 906 | option. |
| 907 | .It Cm ~R |
| 908 | Request rekeying of the connection |
| 909 | (only useful for SSH protocol version 2 and if the peer supports it). |
| 910 | .El |
Damien Miller | f317718 | 2006-01-14 10:09:13 +1100 | [diff] [blame] | 911 | .Sh TCP FORWARDING |
| 912 | Forwarding of arbitrary TCP connections over the secure channel can |
| 913 | be specified either on the command line or in a configuration file. |
| 914 | One possible application of TCP forwarding is a secure connection to a |
| 915 | mail server; another is going through firewalls. |
| 916 | .Pp |
| 917 | In the example below, we look at encrypting communication between |
| 918 | an IRC client and server, even though the IRC server does not directly |
| 919 | support encrypted communications. |
| 920 | This works as follows: |
| 921 | the user connects to the remote host using |
| 922 | .Nm , |
| 923 | specifying a port to be used to forward connections |
| 924 | to the remote server. |
| 925 | After that it is possible to start the service which is to be encrypted |
| 926 | on the client machine, |
| 927 | connecting to the same local port, |
| 928 | and |
| 929 | .Nm |
| 930 | will encrypt and forward the connection. |
| 931 | .Pp |
| 932 | The following example tunnels an IRC session from client machine |
| 933 | .Dq 127.0.0.1 |
| 934 | (localhost) |
| 935 | to remote server |
| 936 | .Dq server.example.com : |
| 937 | .Bd -literal -offset 4n |
| 938 | $ ssh -f -L 1234:localhost:6667 server.example.com sleep 10 |
| 939 | $ irc -c '#users' -p 1234 pinky 127.0.0.1 |
| 940 | .Ed |
| 941 | .Pp |
| 942 | This tunnels a connection to IRC server |
| 943 | .Dq server.example.com , |
| 944 | joining channel |
| 945 | .Dq #users , |
| 946 | nickname |
| 947 | .Dq pinky , |
| 948 | using port 1234. |
| 949 | It doesn't matter which port is used, |
| 950 | as long as it's greater than 1023 |
| 951 | (remember, only root can open sockets on privileged ports) |
| 952 | and doesn't conflict with any ports already in use. |
| 953 | The connection is forwarded to port 6667 on the remote server, |
| 954 | since that's the standard port for IRC services. |
| 955 | .Pp |
| 956 | The |
| 957 | .Fl f |
| 958 | option backgrounds |
| 959 | .Nm |
| 960 | and the remote command |
| 961 | .Dq sleep 10 |
| 962 | is specified to allow an amount of time |
| 963 | (10 seconds, in the example) |
| 964 | to start the service which is to be tunnelled. |
| 965 | If no connections are made within the time specified, |
| 966 | .Nm |
| 967 | will exit. |
Damien Miller | f317718 | 2006-01-14 10:09:13 +1100 | [diff] [blame] | 968 | .Sh X11 FORWARDING |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 969 | If the |
| 970 | .Cm ForwardX11 |
| 971 | variable is set to |
| 972 | .Dq yes |
| 973 | (or see the description of the |
Damien Miller | d7f308f | 2005-12-24 14:55:16 +1100 | [diff] [blame] | 974 | .Fl X , |
| 975 | .Fl x , |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 976 | and |
Damien Miller | d7f308f | 2005-12-24 14:55:16 +1100 | [diff] [blame] | 977 | .Fl Y |
Damien Miller | 9a765b2 | 2005-12-24 14:53:44 +1100 | [diff] [blame] | 978 | options above) |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 979 | and the user is using X11 (the |
| 980 | .Ev DISPLAY |
| 981 | environment variable is set), the connection to the X11 display is |
| 982 | automatically forwarded to the remote side in such a way that any X11 |
| 983 | programs started from the shell (or command) will go through the |
| 984 | encrypted channel, and the connection to the real X server will be made |
| 985 | from the local machine. |
| 986 | The user should not manually set |
| 987 | .Ev DISPLAY . |
| 988 | Forwarding of X11 connections can be |
| 989 | configured on the command line or in configuration files. |
| 990 | .Pp |
| 991 | The |
| 992 | .Ev DISPLAY |
| 993 | value set by |
| 994 | .Nm |
| 995 | will point to the server machine, but with a display number greater than zero. |
| 996 | This is normal, and happens because |
| 997 | .Nm |
| 998 | creates a |
| 999 | .Dq proxy |
| 1000 | X server on the server machine for forwarding the |
| 1001 | connections over the encrypted channel. |
| 1002 | .Pp |
| 1003 | .Nm |
| 1004 | will also automatically set up Xauthority data on the server machine. |
| 1005 | For this purpose, it will generate a random authorization cookie, |
| 1006 | store it in Xauthority on the server, and verify that any forwarded |
| 1007 | connections carry this cookie and replace it by the real cookie when |
| 1008 | the connection is opened. |
| 1009 | The real authentication cookie is never |
| 1010 | sent to the server machine (and no cookies are sent in the plain). |
| 1011 | .Pp |
| 1012 | If the |
| 1013 | .Cm ForwardAgent |
| 1014 | variable is set to |
| 1015 | .Dq yes |
| 1016 | (or see the description of the |
| 1017 | .Fl A |
| 1018 | and |
| 1019 | .Fl a |
Damien Miller | 9a765b2 | 2005-12-24 14:53:44 +1100 | [diff] [blame] | 1020 | options above) and |
Darren Tucker | d3877b9 | 2005-12-20 16:09:36 +1100 | [diff] [blame] | 1021 | the user is using an authentication agent, the connection to the agent |
| 1022 | is automatically forwarded to the remote side. |
Damien Miller | bbc5909 | 2006-01-31 21:46:51 +1100 | [diff] [blame] | 1023 | .Sh VERIFYING HOST KEYS |
| 1024 | When connecting to a server for the first time, |
| 1025 | a fingerprint of the server's public key is presented to the user |
| 1026 | (unless the option |
| 1027 | .Cm StrictHostKeyChecking |
| 1028 | has been disabled). |
| 1029 | Fingerprints can be determined using |
| 1030 | .Xr ssh-keygen 1 : |
| 1031 | .Pp |
| 1032 | .Dl $ ssh-keygen -l -f /etc/ssh/ssh_host_rsa_key |
| 1033 | .Pp |
Darren Tucker | f6bffb1 | 2008-06-14 09:04:26 +1000 | [diff] [blame] | 1034 | If the fingerprint is already known, it can be matched |
| 1035 | and the key can be accepted or rejected. |
| 1036 | Because of the difficulty of comparing host keys |
| 1037 | just by looking at hex strings, |
| 1038 | there is also support to compare host keys visually, |
| 1039 | using |
| 1040 | .Em random art . |
| 1041 | By setting the |
Damien Miller | 1028824 | 2008-06-30 00:04:03 +1000 | [diff] [blame] | 1042 | .Cm VisualHostKey |
Darren Tucker | f6bffb1 | 2008-06-14 09:04:26 +1000 | [diff] [blame] | 1043 | option to |
Damien Miller | 1028824 | 2008-06-30 00:04:03 +1000 | [diff] [blame] | 1044 | .Dq yes , |
Darren Tucker | f6bffb1 | 2008-06-14 09:04:26 +1000 | [diff] [blame] | 1045 | a small ASCII graphic gets displayed on every login to a server, no matter |
| 1046 | if the session itself is interactive or not. |
| 1047 | By learning the pattern a known server produces, a user can easily |
| 1048 | find out that the host key has changed when a completely different pattern |
| 1049 | is displayed. |
| 1050 | Because these patterns are not unambiguous however, a pattern that looks |
| 1051 | similar to the pattern remembered only gives a good probability that the |
| 1052 | host key is the same, not guaranteed proof. |
| 1053 | .Pp |
| 1054 | To get a listing of the fingerprints along with their random art for |
| 1055 | all known hosts, the following command line can be used: |
| 1056 | .Pp |
| 1057 | .Dl $ ssh-keygen -lv -f ~/.ssh/known_hosts |
| 1058 | .Pp |
Damien Miller | bbc5909 | 2006-01-31 21:46:51 +1100 | [diff] [blame] | 1059 | If the fingerprint is unknown, |
| 1060 | an alternative method of verification is available: |
| 1061 | SSH fingerprints verified by DNS. |
| 1062 | An additional resource record (RR), |
| 1063 | SSHFP, |
| 1064 | is added to a zonefile |
| 1065 | and the connecting client is able to match the fingerprint |
| 1066 | with that of the key presented. |
| 1067 | .Pp |
| 1068 | In this example, we are connecting a client to a server, |
| 1069 | .Dq host.example.com . |
| 1070 | The SSHFP resource records should first be added to the zonefile for |
| 1071 | host.example.com: |
| 1072 | .Bd -literal -offset indent |
Damien Miller | a1b3d63 | 2006-03-26 00:07:02 +1100 | [diff] [blame] | 1073 | $ ssh-keygen -r host.example.com. |
Damien Miller | bbc5909 | 2006-01-31 21:46:51 +1100 | [diff] [blame] | 1074 | .Ed |
| 1075 | .Pp |
| 1076 | The output lines will have to be added to the zonefile. |
| 1077 | To check that the zone is answering fingerprint queries: |
| 1078 | .Pp |
| 1079 | .Dl $ dig -t SSHFP host.example.com |
| 1080 | .Pp |
| 1081 | Finally the client connects: |
| 1082 | .Bd -literal -offset indent |
| 1083 | $ ssh -o "VerifyHostKeyDNS ask" host.example.com |
| 1084 | [...] |
| 1085 | Matching host key fingerprint found in DNS. |
| 1086 | Are you sure you want to continue connecting (yes/no)? |
| 1087 | .Ed |
| 1088 | .Pp |
| 1089 | See the |
| 1090 | .Cm VerifyHostKeyDNS |
| 1091 | option in |
| 1092 | .Xr ssh_config 5 |
| 1093 | for more information. |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1094 | .Sh SSH-BASED VIRTUAL PRIVATE NETWORKS |
| 1095 | .Nm |
| 1096 | contains support for Virtual Private Network (VPN) tunnelling |
| 1097 | using the |
| 1098 | .Xr tun 4 |
| 1099 | network pseudo-device, |
| 1100 | allowing two networks to be joined securely. |
| 1101 | The |
| 1102 | .Xr sshd_config 5 |
| 1103 | configuration option |
| 1104 | .Cm PermitTunnel |
| 1105 | controls whether the server supports this, |
| 1106 | and at what level (layer 2 or 3 traffic). |
| 1107 | .Pp |
| 1108 | The following example would connect client network 10.0.50.0/24 |
Damien Miller | 3975ee2 | 2006-11-05 05:31:33 +1100 | [diff] [blame] | 1109 | with remote network 10.0.99.0/24 using a point-to-point connection |
| 1110 | from 10.1.1.1 to 10.1.1.2, |
| 1111 | provided that the SSH server running on the gateway to the remote network, |
| 1112 | at 192.168.1.15, allows it. |
| 1113 | .Pp |
| 1114 | On the client: |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1115 | .Bd -literal -offset indent |
| 1116 | # ssh -f -w 0:1 192.168.1.15 true |
Damien Miller | 3975ee2 | 2006-11-05 05:31:33 +1100 | [diff] [blame] | 1117 | # ifconfig tun0 10.1.1.1 10.1.1.2 netmask 255.255.255.252 |
| 1118 | # route add 10.0.99.0/24 10.1.1.2 |
| 1119 | .Ed |
| 1120 | .Pp |
| 1121 | On the server: |
| 1122 | .Bd -literal -offset indent |
| 1123 | # ifconfig tun1 10.1.1.2 10.1.1.1 netmask 255.255.255.252 |
| 1124 | # route add 10.0.50.0/24 10.1.1.1 |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1125 | .Ed |
| 1126 | .Pp |
| 1127 | Client access may be more finely tuned via the |
| 1128 | .Pa /root/.ssh/authorized_keys |
| 1129 | file (see below) and the |
| 1130 | .Cm PermitRootLogin |
| 1131 | server option. |
Damien Miller | e93eaaa | 2006-03-15 11:05:59 +1100 | [diff] [blame] | 1132 | The following entry would permit connections on |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1133 | .Xr tun 4 |
Damien Miller | e93eaaa | 2006-03-15 11:05:59 +1100 | [diff] [blame] | 1134 | device 1 from user |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1135 | .Dq jane |
Damien Miller | e93eaaa | 2006-03-15 11:05:59 +1100 | [diff] [blame] | 1136 | and on tun device 2 from user |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1137 | .Dq john , |
| 1138 | if |
| 1139 | .Cm PermitRootLogin |
| 1140 | is set to |
| 1141 | .Dq forced-commands-only : |
| 1142 | .Bd -literal -offset 2n |
| 1143 | tunnel="1",command="sh /etc/netstart tun1" ssh-rsa ... jane |
Damien Miller | 9f67a21 | 2006-03-15 11:05:35 +1100 | [diff] [blame] | 1144 | tunnel="2",command="sh /etc/netstart tun2" ssh-rsa ... john |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1145 | .Ed |
| 1146 | .Pp |
Darren Tucker | ffe88e1 | 2006-10-18 07:53:06 +1000 | [diff] [blame] | 1147 | Since an SSH-based setup entails a fair amount of overhead, |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1148 | it may be more suited to temporary setups, |
| 1149 | such as for wireless VPNs. |
| 1150 | More permanent VPNs are better provided by tools such as |
| 1151 | .Xr ipsecctl 8 |
| 1152 | and |
| 1153 | .Xr isakmpd 8 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1154 | .Sh ENVIRONMENT |
| 1155 | .Nm |
| 1156 | will normally set the following environment variables: |
Damien Miller | 6aa2290 | 2006-01-06 14:48:34 +1100 | [diff] [blame] | 1157 | .Bl -tag -width "SSH_ORIGINAL_COMMAND" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1158 | .It Ev DISPLAY |
| 1159 | The |
| 1160 | .Ev DISPLAY |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1161 | variable indicates the location of the X11 server. |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1162 | It is automatically set by |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1163 | .Nm |
| 1164 | to point to a value of the form |
Damien Miller | 14af93e | 2006-01-02 23:38:21 +1100 | [diff] [blame] | 1165 | .Dq hostname:n , |
| 1166 | where |
| 1167 | .Dq hostname |
| 1168 | indicates the host where the shell runs, and |
| 1169 | .Sq n |
| 1170 | is an integer \*(Ge 1. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1171 | .Nm |
| 1172 | uses this special value to forward X11 connections over the secure |
| 1173 | channel. |
Ben Lindstrom | c65e6a0 | 2001-04-23 13:02:16 +0000 | [diff] [blame] | 1174 | The user should normally not set |
| 1175 | .Ev DISPLAY |
| 1176 | explicitly, as that |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1177 | will render the X11 connection insecure (and will require the user to |
| 1178 | manually copy any required authorization cookies). |
| 1179 | .It Ev HOME |
| 1180 | Set to the path of the user's home directory. |
| 1181 | .It Ev LOGNAME |
| 1182 | Synonym for |
| 1183 | .Ev USER ; |
| 1184 | set for compatibility with systems that use this variable. |
| 1185 | .It Ev MAIL |
Ben Lindstrom | e59433d | 2001-09-12 16:41:37 +0000 | [diff] [blame] | 1186 | Set to the path of the user's mailbox. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1187 | .It Ev PATH |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1188 | Set to the default |
| 1189 | .Ev PATH , |
| 1190 | as specified when compiling |
Damien Miller | 1164c29 | 2006-01-02 23:38:37 +1100 | [diff] [blame] | 1191 | .Nm . |
Ben Lindstrom | 5bf5d67 | 2001-07-04 04:31:38 +0000 | [diff] [blame] | 1192 | .It Ev SSH_ASKPASS |
| 1193 | If |
| 1194 | .Nm |
| 1195 | needs a passphrase, it will read the passphrase from the current |
| 1196 | terminal if it was run from a terminal. |
| 1197 | If |
| 1198 | .Nm |
| 1199 | does not have a terminal associated with it but |
| 1200 | .Ev DISPLAY |
| 1201 | and |
| 1202 | .Ev SSH_ASKPASS |
| 1203 | are set, it will execute the program specified by |
| 1204 | .Ev SSH_ASKPASS |
| 1205 | and open an X11 window to read the passphrase. |
| 1206 | This is particularly useful when calling |
| 1207 | .Nm |
| 1208 | from a |
Darren Tucker | 4e4fe00 | 2004-11-05 20:01:03 +1100 | [diff] [blame] | 1209 | .Pa .xsession |
Ben Lindstrom | 5bf5d67 | 2001-07-04 04:31:38 +0000 | [diff] [blame] | 1210 | or related script. |
| 1211 | (Note that on some machines it |
| 1212 | may be necessary to redirect the input from |
| 1213 | .Pa /dev/null |
| 1214 | to make this work.) |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1215 | .It Ev SSH_AUTH_SOCK |
Damien Miller | 14af93e | 2006-01-02 23:38:21 +1100 | [diff] [blame] | 1216 | Identifies the path of a |
| 1217 | .Ux Ns -domain |
| 1218 | socket used to communicate with the agent. |
Damien Miller | f37e246 | 2002-09-19 11:47:55 +1000 | [diff] [blame] | 1219 | .It Ev SSH_CONNECTION |
| 1220 | Identifies the client and server ends of the connection. |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1221 | The variable contains |
Damien Miller | 14af93e | 2006-01-02 23:38:21 +1100 | [diff] [blame] | 1222 | four space-separated values: client IP address, client port number, |
| 1223 | server IP address, and server port number. |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 1224 | .It Ev SSH_ORIGINAL_COMMAND |
Damien Miller | 14af93e | 2006-01-02 23:38:21 +1100 | [diff] [blame] | 1225 | This variable contains the original command line if a forced command |
Ben Lindstrom | 4dccfa5 | 2000-12-28 16:40:05 +0000 | [diff] [blame] | 1226 | is executed. |
| 1227 | It can be used to extract the original arguments. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1228 | .It Ev SSH_TTY |
| 1229 | 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] | 1230 | with the current shell or command. |
| 1231 | If the current session has no tty, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1232 | this variable is not set. |
| 1233 | .It Ev TZ |
Damien Miller | 6dbdb6a | 2005-12-13 19:25:43 +1100 | [diff] [blame] | 1234 | This variable is set to indicate the present time zone if it |
Damien Miller | 208f1ed | 2006-03-15 11:56:03 +1100 | [diff] [blame] | 1235 | 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] | 1236 | on to new connections). |
| 1237 | .It Ev USER |
| 1238 | Set to the name of the user logging in. |
| 1239 | .El |
| 1240 | .Pp |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1241 | Additionally, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1242 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 1243 | reads |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 1244 | .Pa ~/.ssh/environment , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1245 | and adds lines of the format |
| 1246 | .Dq VARNAME=value |
Damien Miller | 14af93e | 2006-01-02 23:38:21 +1100 | [diff] [blame] | 1247 | to the environment if the file exists and users are allowed to |
Ben Lindstrom | dc7adf2 | 2002-08-20 18:38:02 +0000 | [diff] [blame] | 1248 | change their environment. |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 1249 | For more information, see the |
Ben Lindstrom | dc7adf2 | 2002-08-20 18:38:02 +0000 | [diff] [blame] | 1250 | .Cm PermitUserEnvironment |
Ben Lindstrom | bd9bf38 | 2002-08-20 18:54:20 +0000 | [diff] [blame] | 1251 | option in |
Ben Lindstrom | dc7adf2 | 2002-08-20 18:38:02 +0000 | [diff] [blame] | 1252 | .Xr sshd_config 5 . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1253 | .Sh FILES |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1254 | .Bl -tag -width Ds -compact |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1255 | .It ~/.rhosts |
Damien Miller | 1bcdb50 | 2006-01-06 14:49:38 +1100 | [diff] [blame] | 1256 | This file is used for host-based authentication (see above). |
Ben Lindstrom | ebd888d | 2001-03-05 05:49:29 +0000 | [diff] [blame] | 1257 | On some machines this file may need to be |
Damien Miller | 1bcdb50 | 2006-01-06 14:49:38 +1100 | [diff] [blame] | 1258 | world-readable if the user's home directory is on an NFS partition, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1259 | because |
| 1260 | .Xr sshd 8 |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 1261 | reads it as root. |
| 1262 | Additionally, this file must be owned by the user, |
| 1263 | and must not have write permissions for anyone else. |
| 1264 | The recommended |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1265 | permission for most machines is read/write for the user, and not |
| 1266 | accessible by others. |
| 1267 | .Pp |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1268 | .It ~/.shosts |
Damien Miller | 1bcdb50 | 2006-01-06 14:49:38 +1100 | [diff] [blame] | 1269 | This file is used in exactly the same way as |
| 1270 | .Pa .rhosts , |
| 1271 | but allows host-based authentication without permitting login with |
| 1272 | rlogin/rsh. |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1273 | .Pp |
Damien Miller | 520e615 | 2008-02-10 22:46:22 +1100 | [diff] [blame] | 1274 | .It ~/.ssh/ |
| 1275 | This directory is the default location for all user-specific configuration |
| 1276 | and authentication information. |
| 1277 | There is no general requirement to keep the entire contents of this directory |
| 1278 | secret, but the recommended permissions are read/write/execute for the user, |
| 1279 | and not accessible by others. |
| 1280 | .Pp |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1281 | .It ~/.ssh/authorized_keys |
| 1282 | Lists the public keys (RSA/DSA) that can be used for logging in as this user. |
| 1283 | The format of this file is described in the |
| 1284 | .Xr sshd 8 |
| 1285 | manual page. |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1286 | This file is not highly sensitive, but the recommended |
| 1287 | permissions are read/write for the user, and not accessible by others. |
| 1288 | .Pp |
| 1289 | .It ~/.ssh/config |
| 1290 | This is the per-user configuration file. |
| 1291 | The file format and configuration options are described in |
| 1292 | .Xr ssh_config 5 . |
| 1293 | Because of the potential for abuse, this file must have strict permissions: |
| 1294 | read/write for the user, and not accessible by others. |
| 1295 | .Pp |
| 1296 | .It ~/.ssh/environment |
Damien Miller | 4c102ee | 2006-01-06 14:49:17 +1100 | [diff] [blame] | 1297 | Contains additional definitions for environment variables; see |
| 1298 | .Sx ENVIRONMENT , |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1299 | above. |
| 1300 | .Pp |
| 1301 | .It ~/.ssh/identity |
| 1302 | .It ~/.ssh/id_dsa |
| 1303 | .It ~/.ssh/id_rsa |
| 1304 | Contains the private key for authentication. |
| 1305 | These files |
| 1306 | contain sensitive data and should be readable by the user but not |
| 1307 | accessible by others (read/write/execute). |
| 1308 | .Nm |
| 1309 | will simply ignore a private key file if it is accessible by others. |
| 1310 | It is possible to specify a passphrase when |
| 1311 | generating the key which will be used to encrypt the |
| 1312 | sensitive part of this file using 3DES. |
| 1313 | .Pp |
| 1314 | .It ~/.ssh/identity.pub |
| 1315 | .It ~/.ssh/id_dsa.pub |
| 1316 | .It ~/.ssh/id_rsa.pub |
| 1317 | Contains the public key for authentication. |
| 1318 | These files are not |
| 1319 | sensitive and can (but need not) be readable by anyone. |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1320 | .Pp |
| 1321 | .It ~/.ssh/known_hosts |
Damien Miller | e87eb4c | 2006-01-14 10:08:36 +1100 | [diff] [blame] | 1322 | Contains a list of host keys for all hosts the user has logged into |
| 1323 | that are not already in the systemwide list of known host keys. |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1324 | See |
Damien Miller | e87eb4c | 2006-01-14 10:08:36 +1100 | [diff] [blame] | 1325 | .Xr sshd 8 |
| 1326 | for further details of the format of this file. |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1327 | .Pp |
| 1328 | .It ~/.ssh/rc |
| 1329 | Commands in this file are executed by |
| 1330 | .Nm |
Damien Miller | 7e76e1f | 2006-01-14 10:08:57 +1100 | [diff] [blame] | 1331 | when the user logs in, just before the user's shell (or command) is |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1332 | started. |
| 1333 | See the |
| 1334 | .Xr sshd 8 |
| 1335 | manual page for more information. |
| 1336 | .Pp |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1337 | .It /etc/hosts.equiv |
Damien Miller | 1bcdb50 | 2006-01-06 14:49:38 +1100 | [diff] [blame] | 1338 | This file is for host-based authentication (see above). |
| 1339 | It should only be writable by root. |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1340 | .Pp |
| 1341 | .It /etc/shosts.equiv |
Damien Miller | 1bcdb50 | 2006-01-06 14:49:38 +1100 | [diff] [blame] | 1342 | This file is used in exactly the same way as |
| 1343 | .Pa hosts.equiv , |
| 1344 | but allows host-based authentication without permitting login with |
| 1345 | rlogin/rsh. |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1346 | .Pp |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1347 | .It Pa /etc/ssh/ssh_config |
| 1348 | Systemwide configuration file. |
| 1349 | The file format and configuration options are described in |
| 1350 | .Xr ssh_config 5 . |
| 1351 | .Pp |
| 1352 | .It /etc/ssh/ssh_host_key |
| 1353 | .It /etc/ssh/ssh_host_dsa_key |
| 1354 | .It /etc/ssh/ssh_host_rsa_key |
| 1355 | These three files contain the private parts of the host keys |
Damien Miller | 7e76e1f | 2006-01-14 10:08:57 +1100 | [diff] [blame] | 1356 | and are used for host-based authentication. |
| 1357 | If protocol version 1 is used, |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1358 | .Nm |
| 1359 | must be setuid root, since the host key is readable only by root. |
| 1360 | For protocol version 2, |
| 1361 | .Nm |
| 1362 | uses |
| 1363 | .Xr ssh-keysign 8 |
Damien Miller | 7e76e1f | 2006-01-14 10:08:57 +1100 | [diff] [blame] | 1364 | to access the host keys, |
| 1365 | eliminating the requirement that |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1366 | .Nm |
Damien Miller | 7e76e1f | 2006-01-14 10:08:57 +1100 | [diff] [blame] | 1367 | be setuid root when host-based authentication is used. |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1368 | By default |
| 1369 | .Nm |
| 1370 | is not setuid root. |
| 1371 | .Pp |
| 1372 | .It /etc/ssh/ssh_known_hosts |
| 1373 | Systemwide list of known host keys. |
| 1374 | This file should be prepared by the |
| 1375 | system administrator to contain the public host keys of all machines in the |
| 1376 | organization. |
Damien Miller | e87eb4c | 2006-01-14 10:08:36 +1100 | [diff] [blame] | 1377 | It should be world-readable. |
| 1378 | See |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1379 | .Xr sshd 8 |
Damien Miller | e87eb4c | 2006-01-14 10:08:36 +1100 | [diff] [blame] | 1380 | for further details of the format of this file. |
Damien Miller | fb8ea74 | 2006-01-06 14:48:52 +1100 | [diff] [blame] | 1381 | .Pp |
Damien Miller | 7655f5c | 2006-01-06 14:48:18 +1100 | [diff] [blame] | 1382 | .It /etc/ssh/sshrc |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1383 | Commands in this file are executed by |
| 1384 | .Nm |
Damien Miller | 7e76e1f | 2006-01-14 10:08:57 +1100 | [diff] [blame] | 1385 | when the user logs in, just before the user's shell (or command) is started. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1386 | See the |
| 1387 | .Xr sshd 8 |
| 1388 | manual page for more information. |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 1389 | .El |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1390 | .Sh SEE ALSO |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1391 | .Xr scp 1 , |
Damien Miller | 3380426 | 2001-02-04 23:20:18 +1100 | [diff] [blame] | 1392 | .Xr sftp 1 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1393 | .Xr ssh-add 1 , |
| 1394 | .Xr ssh-agent 1 , |
| 1395 | .Xr ssh-keygen 1 , |
Damien Miller | 128a0f1 | 2006-01-06 14:50:11 +1100 | [diff] [blame] | 1396 | .Xr ssh-keyscan 1 , |
Darren Tucker | 248dd13 | 2006-01-20 11:30:58 +1100 | [diff] [blame] | 1397 | .Xr tun 4 , |
Darren Tucker | 6177695 | 2003-10-02 16:19:47 +1000 | [diff] [blame] | 1398 | .Xr hosts.equiv 5 , |
Ben Lindstrom | bf69e3b | 2002-06-23 00:31:24 +0000 | [diff] [blame] | 1399 | .Xr ssh_config 5 , |
Ben Lindstrom | c001cd3 | 2002-06-23 00:32:11 +0000 | [diff] [blame] | 1400 | .Xr ssh-keysign 8 , |
Ben Lindstrom | 5ab6ae1 | 2001-02-10 22:08:03 +0000 | [diff] [blame] | 1401 | .Xr sshd 8 |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 1402 | .Rs |
Damien Miller | 39a93a3 | 2006-03-15 11:34:45 +1100 | [diff] [blame] | 1403 | .%R RFC 4250 |
| 1404 | .%T "The Secure Shell (SSH) Protocol Assigned Numbers" |
| 1405 | .%D 2006 |
| 1406 | .Re |
| 1407 | .Rs |
| 1408 | .%R RFC 4251 |
| 1409 | .%T "The Secure Shell (SSH) Protocol Architecture" |
| 1410 | .%D 2006 |
| 1411 | .Re |
| 1412 | .Rs |
| 1413 | .%R RFC 4252 |
| 1414 | .%T "The Secure Shell (SSH) Authentication Protocol" |
| 1415 | .%D 2006 |
| 1416 | .Re |
| 1417 | .Rs |
| 1418 | .%R RFC 4253 |
| 1419 | .%T "The Secure Shell (SSH) Transport Layer Protocol" |
| 1420 | .%D 2006 |
| 1421 | .Re |
| 1422 | .Rs |
| 1423 | .%R RFC 4254 |
| 1424 | .%T "The Secure Shell (SSH) Connection Protocol" |
| 1425 | .%D 2006 |
| 1426 | .Re |
| 1427 | .Rs |
| 1428 | .%R RFC 4255 |
| 1429 | .%T "Using DNS to Securely Publish Secure Shell (SSH) Key Fingerprints" |
| 1430 | .%D 2006 |
| 1431 | .Re |
| 1432 | .Rs |
| 1433 | .%R RFC 4256 |
| 1434 | .%T "Generic Message Exchange Authentication for the Secure Shell Protocol (SSH)" |
| 1435 | .%D 2006 |
| 1436 | .Re |
| 1437 | .Rs |
| 1438 | .%R RFC 4335 |
| 1439 | .%T "The Secure Shell (SSH) Session Channel Break Extension" |
| 1440 | .%D 2006 |
| 1441 | .Re |
| 1442 | .Rs |
| 1443 | .%R RFC 4344 |
| 1444 | .%T "The Secure Shell (SSH) Transport Layer Encryption Modes" |
| 1445 | .%D 2006 |
| 1446 | .Re |
| 1447 | .Rs |
| 1448 | .%R RFC 4345 |
| 1449 | .%T "Improved Arcfour Modes for the Secure Shell (SSH) Transport Layer Protocol" |
| 1450 | .%D 2006 |
Ben Lindstrom | 160ec62 | 2001-04-22 17:17:46 +0000 | [diff] [blame] | 1451 | .Re |
Damien Miller | 3e96d74 | 2006-03-25 23:39:29 +1100 | [diff] [blame] | 1452 | .Rs |
| 1453 | .%R RFC 4419 |
| 1454 | .%T "Diffie-Hellman Group Exchange for the Secure Shell (SSH) Transport Layer Protocol" |
| 1455 | .%D 2006 |
| 1456 | .Re |
Damien Miller | c0367fb | 2007-01-05 16:25:46 +1100 | [diff] [blame] | 1457 | .Rs |
| 1458 | .%R RFC 4716 |
| 1459 | .%T "The Secure Shell (SSH) Public Key File Format" |
| 1460 | .%D 2006 |
| 1461 | .Re |
Darren Tucker | f6bffb1 | 2008-06-14 09:04:26 +1000 | [diff] [blame] | 1462 | .Rs |
| 1463 | .%T "Hash Visualization: a New Technique to improve Real-World Security" |
| 1464 | .%A A. Perrig |
| 1465 | .%A D. Song |
| 1466 | .%D 1999 |
| 1467 | .%O "International Workshop on Cryptographic Techniques and E-Commerce (CrypTEC '99)" |
| 1468 | .Re |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 1469 | .Sh AUTHORS |
| 1470 | OpenSSH is a derivative of the original and free |
| 1471 | ssh 1.2.12 release by Tatu Ylonen. |
| 1472 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| 1473 | Theo de Raadt and Dug Song |
| 1474 | removed many bugs, re-added newer features and |
| 1475 | created OpenSSH. |
| 1476 | Markus Friedl contributed the support for SSH |
| 1477 | protocol versions 1.5 and 2.0. |