Annotation of src/usr.bin/ssh/ssh.1, Revision 1.132
1.1 deraadt 1: .\" -*- nroff -*-
2: .\"
3: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5: .\" All rights reserved
6: .\"
1.59 deraadt 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".
12: .\"
1.93 deraadt 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.
1.59 deraadt 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.
1.1 deraadt 25: .\"
1.59 deraadt 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.
1.1 deraadt 36: .\"
1.132 ! markus 37: .\" $OpenBSD: ssh.1,v 1.131 2001/08/22 17:45:16 stevesk Exp $
1.2 deraadt 38: .Dd September 25, 1999
39: .Dt SSH 1
40: .Os
41: .Sh NAME
42: .Nm ssh
1.96 deraadt 43: .Nd OpenSSH SSH client (remote login program)
1.2 deraadt 44: .Sh SYNOPSIS
45: .Nm ssh
46: .Op Fl l Ar login_name
1.130 stevesk 47: .Ar hostname | user@hostname
1.2 deraadt 48: .Op Ar command
49: .Pp
50: .Nm ssh
1.86 jakob 51: .Op Fl afgknqstvxACNPTX1246
1.108 markus 52: .Op Fl b Ar bind_address
1.51 markus 53: .Op Fl c Ar cipher_spec
1.2 deraadt 54: .Op Fl e Ar escape_char
55: .Op Fl i Ar identity_file
56: .Op Fl l Ar login_name
1.91 markus 57: .Op Fl m Ar mac_spec
1.2 deraadt 58: .Op Fl o Ar option
59: .Op Fl p Ar port
1.132 ! markus 60: .Op Fl F Ar configfile
1.12 aaron 61: .Oo Fl L Xo
62: .Sm off
1.33 markus 63: .Ar port :
1.12 aaron 64: .Ar host :
65: .Ar hostport
66: .Sm on
67: .Xc
68: .Oc
69: .Oo Fl R Xo
70: .Sm off
1.33 markus 71: .Ar port :
1.12 aaron 72: .Ar host :
73: .Ar hostport
74: .Sm on
75: .Xc
76: .Oc
1.130 stevesk 77: .Ar hostname | user@hostname
1.2 deraadt 78: .Op Ar command
1.44 aaron 79: .Sh DESCRIPTION
1.2 deraadt 80: .Nm
1.96 deraadt 81: (SSH client) is a program for logging into a remote machine and for
1.40 aaron 82: executing commands on a remote machine.
83: It is intended to replace
1.1 deraadt 84: rlogin and rsh, and provide secure encrypted communications between
1.40 aaron 85: two untrusted hosts over an insecure network.
86: X11 connections and
1.1 deraadt 87: arbitrary TCP/IP ports can also be forwarded over the secure channel.
1.2 deraadt 88: .Pp
89: .Nm
1.44 aaron 90: connects and logs into the specified
1.2 deraadt 91: .Ar hostname .
1.1 deraadt 92: The user must prove
1.49 markus 93: his/her identity to the remote machine using one of several methods
94: depending on the protocol version used:
95: .Pp
96: .Ss SSH protocol version 1
1.2 deraadt 97: .Pp
1.1 deraadt 98: First, if the machine the user logs in from is listed in
1.2 deraadt 99: .Pa /etc/hosts.equiv
1.1 deraadt 100: or
1.2 deraadt 101: .Pa /etc/shosts.equiv
1.1 deraadt 102: on the remote machine, and the user names are
103: the same on both sides, the user is immediately permitted to log in.
1.44 aaron 104: Second, if
1.2 deraadt 105: .Pa \&.rhosts
1.1 deraadt 106: or
1.2 deraadt 107: .Pa \&.shosts
1.1 deraadt 108: exists in the user's home directory on the
109: remote machine and contains a line containing the name of the client
110: machine and the name of the user on that machine, the user is
1.40 aaron 111: permitted to log in.
112: This form of authentication alone is normally not
1.1 deraadt 113: allowed by the server because it is not secure.
1.2 deraadt 114: .Pp
1.107 markus 115: The second authentication method is the
1.2 deraadt 116: .Pa rhosts
1.1 deraadt 117: or
1.2 deraadt 118: .Pa hosts.equiv
1.40 aaron 119: method combined with RSA-based host authentication.
120: It means that if the login would be permitted by
1.49 markus 121: .Pa $HOME/.rhosts ,
122: .Pa $HOME/.shosts ,
1.2 deraadt 123: .Pa /etc/hosts.equiv ,
1.1 deraadt 124: or
1.2 deraadt 125: .Pa /etc/shosts.equiv ,
1.11 deraadt 126: and if additionally the server can verify the client's
1.44 aaron 127: host key (see
1.2 deraadt 128: .Pa /etc/ssh_known_hosts
1.23 markus 129: and
130: .Pa $HOME/.ssh/known_hosts
1.1 deraadt 131: in the
1.2 deraadt 132: .Sx FILES
1.40 aaron 133: section), only then login is permitted.
134: This authentication method closes security holes due to IP
135: spoofing, DNS spoofing and routing spoofing.
136: [Note to the administrator:
1.2 deraadt 137: .Pa /etc/hosts.equiv ,
1.49 markus 138: .Pa $HOME/.rhosts ,
1.1 deraadt 139: and the rlogin/rsh protocol in general, are inherently insecure and should be
140: disabled if security is desired.]
1.2 deraadt 141: .Pp
1.44 aaron 142: As a third authentication method,
1.2 deraadt 143: .Nm
1.1 deraadt 144: supports RSA based authentication.
145: The scheme is based on public-key cryptography: there are cryptosystems
146: where encryption and decryption are done using separate keys, and it
147: is not possible to derive the decryption key from the encryption key.
1.40 aaron 148: RSA is one such system.
1.44 aaron 149: The idea is that each user creates a public/private
1.40 aaron 150: key pair for authentication purposes.
151: The server knows the public key, and only the user knows the private key.
1.44 aaron 152: The file
1.2 deraadt 153: .Pa $HOME/.ssh/authorized_keys
1.1 deraadt 154: lists the public keys that are permitted for logging
1.40 aaron 155: in.
156: When the user logs in, the
1.2 deraadt 157: .Nm
1.1 deraadt 158: program tells the server which key pair it would like to use for
1.40 aaron 159: authentication.
160: The server checks if this key is permitted, and if
1.1 deraadt 161: so, sends the user (actually the
1.2 deraadt 162: .Nm
1.1 deraadt 163: program running on behalf of the user) a challenge, a random number,
1.40 aaron 164: encrypted by the user's public key.
165: The challenge can only be
166: decrypted using the proper private key.
167: The user's client then decrypts the
1.1 deraadt 168: challenge using the private key, proving that he/she knows the private
169: key but without disclosing it to the server.
1.2 deraadt 170: .Pp
171: .Nm
1.40 aaron 172: implements the RSA authentication protocol automatically.
173: The user creates his/her RSA key pair by running
1.2 deraadt 174: .Xr ssh-keygen 1 .
1.44 aaron 175: This stores the private key in
1.49 markus 176: .Pa $HOME/.ssh/identity
1.1 deraadt 177: and the public key in
1.49 markus 178: .Pa $HOME/.ssh/identity.pub
1.40 aaron 179: in the user's home directory.
180: The user should then copy the
1.2 deraadt 181: .Pa identity.pub
1.44 aaron 182: to
1.49 markus 183: .Pa $HOME/.ssh/authorized_keys
1.44 aaron 184: in his/her home directory on the remote machine (the
1.2 deraadt 185: .Pa authorized_keys
1.44 aaron 186: file corresponds to the conventional
1.49 markus 187: .Pa $HOME/.rhosts
1.1 deraadt 188: file, and has one key
1.40 aaron 189: per line, though the lines can be very long).
190: After this, the user can log in without giving the password.
191: RSA authentication is much
1.1 deraadt 192: more secure than rhosts authentication.
1.2 deraadt 193: .Pp
1.1 deraadt 194: The most convenient way to use RSA authentication may be with an
1.40 aaron 195: authentication agent.
196: See
1.2 deraadt 197: .Xr ssh-agent 1
1.1 deraadt 198: for more information.
1.2 deraadt 199: .Pp
1.44 aaron 200: If other authentication methods fail,
1.2 deraadt 201: .Nm
1.40 aaron 202: prompts the user for a password.
203: The password is sent to the remote
1.1 deraadt 204: host for checking; however, since all communications are encrypted,
205: the password cannot be seen by someone listening on the network.
1.2 deraadt 206: .Pp
1.49 markus 207: .Ss SSH protocol version 2
208: .Pp
209: When a user connects using the protocol version 2
1.107 markus 210: different authentication methods are available.
211: Using the default values for
212: .Cm PreferredAuthentications ,
1.123 markus 213: the client will try to authenticate first using the hostbased method;
214: if this method fails public key authentication is attempted,
215: and finally if this method fails keyboard-interactive and
216: password authentication are tried.
1.49 markus 217: .Pp
218: The public key method is similar to RSA authentication described
1.107 markus 219: in the previous section and allows the RSA or DSA algorithm to be used:
1.102 itojun 220: The client uses his private key,
1.49 markus 221: .Pa $HOME/.ssh/id_dsa
1.102 itojun 222: or
223: .Pa $HOME/.ssh/id_rsa ,
1.49 markus 224: to sign the session identifier and sends the result to the server.
225: The server checks whether the matching public key is listed in
1.115 markus 226: .Pa $HOME/.ssh/authorized_keys
1.49 markus 227: and grants access if both the key is found and the signature is correct.
228: The session identifier is derived from a shared Diffie-Hellman value
229: and is only known to the client and the server.
230: .Pp
231: If public key authentication fails or is not available a password
232: can be sent encrypted to the remote host for proving the user's identity.
1.107 markus 233: .Pp
234: Additionally,
235: .Nm
236: supports hostbased or challenge response authentication.
1.49 markus 237: .Pp
238: Protocol 2 provides additional mechanisms for confidentiality
1.51 markus 239: (the traffic is encrypted using 3DES, Blowfish, CAST128 or Arcfour)
1.94 deraadt 240: and integrity (hmac-md5, hmac-sha1).
1.49 markus 241: Note that protocol 1 lacks a strong mechanism for ensuring the
242: integrity of the connection.
243: .Pp
244: .Ss Login session and remote execution
245: .Pp
1.1 deraadt 246: When the user's identity has been accepted by the server, the server
247: either executes the given command, or logs into the machine and gives
1.40 aaron 248: the user a normal shell on the remote machine.
249: All communication with
1.1 deraadt 250: the remote command or shell will be automatically encrypted.
1.2 deraadt 251: .Pp
1.1 deraadt 252: If a pseudo-terminal has been allocated (normal login session), the
1.104 djm 253: user may use the escape characters noted below.
1.2 deraadt 254: .Pp
1.1 deraadt 255: If no pseudo tty has been allocated, the
256: session is transparent and can be used to reliably transfer binary
1.40 aaron 257: data.
258: On most systems, setting the escape character to
1.2 deraadt 259: .Dq none
260: will also make the session transparent even if a tty is used.
261: .Pp
1.71 djm 262: The session terminates when the command or shell on the remote
1.92 markus 263: machine exits and all X11 and TCP/IP connections have been closed.
1.1 deraadt 264: The exit status of the remote program is returned as the exit status
265: of
1.2 deraadt 266: .Nm ssh .
1.104 djm 267: .Pp
268: .Ss Escape Characters
269: .Pp
270: When a pseudo terminal has been requested, ssh supports a number of functions
1.117 itojun 271: through the use of an escape character.
1.104 djm 272: .Pp
273: A single tilde character can be sent as
274: .Ic ~~
1.119 stevesk 275: or by following the tilde by a character other than those described below.
1.104 djm 276: The escape character must always follow a newline to be interpreted as
277: special.
278: The escape character can be changed in configuration files using the
279: .Cm EscapeChar
1.117 itojun 280: configuration directive or on the command line by the
1.104 djm 281: .Fl e
282: option.
283: .Pp
284: The supported escapes (assuming the default
285: .Ql ~ )
286: are:
287: .Bl -tag -width Ds
288: .It Cm ~.
289: Disconnect
290: .It Cm ~^Z
291: Background ssh
292: .It Cm ~#
293: List forwarded connections
294: .It Cm ~&
295: Background ssh at logout when waiting for forwarded connection / X11 sessions
1.107 markus 296: to terminate (protocol version 1 only)
1.104 djm 297: .It Cm ~?
298: Display a list of escape characters
299: .It Cm ~R
1.105 djm 300: Request rekeying of the connection (only useful for SSH protocol version 2
301: and if the peer supports it)
1.104 djm 302: .El
1.2 deraadt 303: .Pp
1.49 markus 304: .Ss X11 and TCP forwarding
305: .Pp
1.110 deraadt 306: If the
307: .Cm ForwardX11
308: variable is set to
309: .Dq yes
310: (or, see the description of the
311: .Fl X
312: and
313: .Fl x
314: options described later)
315: and the user is using X11 (the
1.2 deraadt 316: .Ev DISPLAY
1.1 deraadt 317: environment variable is set), the connection to the X11 display is
318: automatically forwarded to the remote side in such a way that any X11
319: programs started from the shell (or command) will go through the
320: encrypted channel, and the connection to the real X server will be made
1.40 aaron 321: from the local machine.
322: The user should not manually set
1.2 deraadt 323: .Ev DISPLAY .
1.1 deraadt 324: Forwarding of X11 connections can be
325: configured on the command line or in configuration files.
1.2 deraadt 326: .Pp
327: The
1.44 aaron 328: .Ev DISPLAY
1.2 deraadt 329: value set by
330: .Nm
1.1 deraadt 331: will point to the server machine, but with a display number greater
1.40 aaron 332: than zero.
333: This is normal, and happens because
1.2 deraadt 334: .Nm
335: creates a
336: .Dq proxy
337: X server on the server machine for forwarding the
1.1 deraadt 338: connections over the encrypted channel.
1.2 deraadt 339: .Pp
340: .Nm
1.1 deraadt 341: will also automatically set up Xauthority data on the server machine.
342: For this purpose, it will generate a random authorization cookie,
343: store it in Xauthority on the server, and verify that any forwarded
344: connections carry this cookie and replace it by the real cookie when
1.40 aaron 345: the connection is opened.
346: The real authentication cookie is never
1.1 deraadt 347: sent to the server machine (and no cookies are sent in the plain).
1.2 deraadt 348: .Pp
1.1 deraadt 349: If the user is using an authentication agent, the connection to the agent
350: is automatically forwarded to the remote side unless disabled on
1.120 stevesk 351: the command line or in a configuration file.
1.2 deraadt 352: .Pp
1.1 deraadt 353: Forwarding of arbitrary TCP/IP connections over the secure channel can
1.120 stevesk 354: be specified either on the command line or in a configuration file.
1.40 aaron 355: One possible application of TCP/IP forwarding is a secure connection to an
1.92 markus 356: electronic purse; another is going through firewalls.
1.2 deraadt 357: .Pp
1.49 markus 358: .Ss Server authentication
359: .Pp
1.2 deraadt 360: .Nm
1.49 markus 361: automatically maintains and checks a database containing
1.40 aaron 362: identifications for all hosts it has ever been used with.
1.116 markus 363: Host keys are stored in
1.49 markus 364: .Pa $HOME/.ssh/known_hosts
1.40 aaron 365: in the user's home directory.
1.116 markus 366: Additionally, the file
1.2 deraadt 367: .Pa /etc/ssh_known_hosts
1.116 markus 368: is automatically checked for known hosts.
1.40 aaron 369: Any new hosts are automatically added to the user's file.
370: If a host's identification
1.1 deraadt 371: ever changes,
1.2 deraadt 372: .Nm
1.1 deraadt 373: warns about this and disables password authentication to prevent a
1.40 aaron 374: trojan horse from getting the user's password.
375: Another purpose of
1.1 deraadt 376: this mechanism is to prevent man-in-the-middle attacks which could
1.40 aaron 377: otherwise be used to circumvent the encryption.
378: The
1.2 deraadt 379: .Cm StrictHostKeyChecking
1.1 deraadt 380: option (see below) can be used to prevent logins to machines whose
381: host key is not known or has changed.
1.65 aaron 382: .Pp
383: The options are as follows:
1.2 deraadt 384: .Bl -tag -width Ds
1.4 dugsong 385: .It Fl a
1.42 aaron 386: Disables forwarding of the authentication agent connection.
1.54 markus 387: .It Fl A
388: Enables forwarding of the authentication agent connection.
389: This can also be specified on a per-host basis in a configuration file.
1.108 markus 390: .It Fl b Ar bind_address
391: Specify the interface to transmit from on machines with multiple
392: interfaces or aliased addresses.
1.131 stevesk 393: .It Fl c Ar blowfish|3des|des
1.44 aaron 394: Selects the cipher to use for encrypting the session.
1.2 deraadt 395: .Ar 3des
1.40 aaron 396: is used by default.
1.44 aaron 397: It is believed to be secure.
1.5 deraadt 398: .Ar 3des
399: (triple-des) is an encrypt-decrypt-encrypt triple with three different keys.
400: .Ar blowfish
401: is a fast block cipher, it appears very secure and is much faster than
1.40 aaron 402: .Ar 3des .
1.131 stevesk 403: .Ar des
404: is only supported in the
405: .Nm
406: client for interoperability with legacy protocol 1 implementations
407: that do not support the
408: .Ar 3des
409: cipher. Its use is strongly discouraged due to cryptographic
410: weaknesses.
1.90 markus 411: .It Fl c Ar cipher_spec
1.51 markus 412: Additionally, for protocol version 2 a comma-separated list of ciphers can
1.61 aaron 413: be specified in order of preference.
1.90 markus 414: See
415: .Cm Ciphers
416: for more information.
1.2 deraadt 417: .It Fl e Ar ch|^ch|none
418: Sets the escape character for sessions with a pty (default:
419: .Ql ~ ) .
1.40 aaron 420: The escape character is only recognized at the beginning of a line.
421: The escape character followed by a dot
1.2 deraadt 422: .Pq Ql \&.
423: closes the connection, followed
1.1 deraadt 424: by control-Z suspends the connection, and followed by itself sends the
1.40 aaron 425: escape character once.
426: Setting the character to
1.2 deraadt 427: .Dq none
428: disables any escapes and makes the session fully transparent.
429: .It Fl f
430: Requests
431: .Nm
1.40 aaron 432: to go to background just before command execution.
433: This is useful if
1.2 deraadt 434: .Nm
435: is going to ask for passwords or passphrases, but the user
1.40 aaron 436: wants it in the background.
1.44 aaron 437: This implies
1.2 deraadt 438: .Fl n .
1.1 deraadt 439: The recommended way to start X11 programs at a remote site is with
1.2 deraadt 440: something like
441: .Ic ssh -f host xterm .
1.34 markus 442: .It Fl g
443: Allows remote hosts to connect to local forwarded ports.
1.2 deraadt 444: .It Fl i Ar identity_file
1.44 aaron 445: Selects the file from which the identity (private key) for
1.68 markus 446: RSA or DSA authentication is read.
1.44 aaron 447: Default is
1.49 markus 448: .Pa $HOME/.ssh/identity
1.40 aaron 449: in the user's home directory.
450: Identity files may also be specified on
451: a per-host basis in the configuration file.
452: It is possible to have multiple
1.2 deraadt 453: .Fl i
454: options (and multiple identities specified in
1.1 deraadt 455: configuration files).
1.125 jakob 456: .It Fl I Ar smartcard_device
457: Specifies which smartcard device to use. The argument is
458: the device
459: .Nm
460: should use to communicate with a smartcard used for storing the user's
461: private RSA key.
1.2 deraadt 462: .It Fl k
1.42 aaron 463: Disables forwarding of Kerberos tickets and AFS tokens.
464: This may also be specified on a per-host basis in the configuration file.
1.2 deraadt 465: .It Fl l Ar login_name
1.40 aaron 466: Specifies the user to log in as on the remote machine.
467: This also may be specified on a per-host basis in the configuration file.
1.91 markus 468: .It Fl m Ar mac_spec
469: Additionally, for protocol version 2 a comma-separated list of MAC
470: (message authentication code) algorithms can
471: be specified in order of preference.
472: See the
473: .Cm MACs
474: keyword for more information.
1.2 deraadt 475: .It Fl n
476: Redirects stdin from
477: .Pa /dev/null
478: (actually, prevents reading from stdin).
1.1 deraadt 479: This must be used when
1.2 deraadt 480: .Nm
1.40 aaron 481: is run in the background.
482: A common trick is to use this to run X11 programs on a remote machine.
483: For example,
1.2 deraadt 484: .Ic ssh -n shadows.cs.hut.fi emacs &
485: will start an emacs on shadows.cs.hut.fi, and the X11
1.1 deraadt 486: connection will be automatically forwarded over an encrypted channel.
487: The
1.2 deraadt 488: .Nm
1.1 deraadt 489: program will be put in the background.
490: (This does not work if
1.2 deraadt 491: .Nm
492: needs to ask for a password or passphrase; see also the
493: .Fl f
494: option.)
1.53 markus 495: .It Fl N
496: Do not execute a remote command.
1.70 markus 497: This is useful if you just want to forward ports
1.53 markus 498: (protocol version 2 only).
1.2 deraadt 499: .It Fl o Ar option
1.127 stevesk 500: Can be used to give options in the format used in the configuration file.
1.1 deraadt 501: This is useful for specifying options for which there is no separate
1.40 aaron 502: command-line flag.
1.2 deraadt 503: .It Fl p Ar port
1.40 aaron 504: Port to connect to on the remote host.
505: This can be specified on a
1.1 deraadt 506: per-host basis in the configuration file.
1.16 markus 507: .It Fl P
508: Use a non-privileged port for outgoing connections.
509: This can be used if your firewall does
510: not permit connections from privileged ports.
1.30 provos 511: Note that this option turns off
1.16 markus 512: .Cm RhostsAuthentication
513: and
1.72 markus 514: .Cm RhostsRSAAuthentication
515: for older servers.
1.2 deraadt 516: .It Fl q
1.40 aaron 517: Quiet mode.
518: Causes all warning and diagnostic messages to be suppressed.
519: Only fatal errors are displayed.
1.80 djm 520: .It Fl s
1.117 itojun 521: 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
522: of SSH as a secure transport for other applications (eg. sftp). The
1.80 djm 523: subsystem is specified as the remote command.
1.2 deraadt 524: .It Fl t
1.40 aaron 525: Force pseudo-tty allocation.
1.43 brad 526: This can be used to execute arbitrary
1.40 aaron 527: screen-based programs on a remote machine, which can be very useful,
528: e.g., when implementing menu services.
1.73 markus 529: Multiple
530: .Fl t
531: options force tty allocation, even if
532: .Nm
533: has no local tty.
1.53 markus 534: .It Fl T
1.69 markus 535: Disable pseudo-tty allocation.
1.2 deraadt 536: .It Fl v
1.40 aaron 537: Verbose mode.
538: Causes
1.2 deraadt 539: .Nm
1.40 aaron 540: to print debugging messages about its progress.
541: This is helpful in
1.1 deraadt 542: debugging connection, authentication, and configuration problems.
1.73 markus 543: Multiple
544: .Fl v
545: options increases the verbosity.
1.61 aaron 546: Maximum is 3.
1.2 deraadt 547: .It Fl x
1.40 aaron 548: Disables X11 forwarding.
1.2 deraadt 549: .It Fl X
1.1 deraadt 550: Enables X11 forwarding.
1.54 markus 551: This can also be specified on a per-host basis in a configuration file.
1.2 deraadt 552: .It Fl C
1.1 deraadt 553: Requests compression of all data (including stdin, stdout, stderr, and
1.40 aaron 554: data for forwarded X11 and TCP/IP connections).
555: The compression algorithm is the same used by
1.34 markus 556: .Xr gzip 1 ,
557: and the
1.2 deraadt 558: .Dq level
559: can be controlled by the
560: .Cm CompressionLevel
1.40 aaron 561: option (see below).
562: Compression is desirable on modem lines and other
1.1 deraadt 563: slow connections, but will only slow down things on fast networks.
564: The default value can be set on a host-by-host basis in the
565: configuration files; see the
1.121 pvalchev 566: .Cm Compression
1.1 deraadt 567: option below.
1.132 ! markus 568: .It Fl F Ar configfile
! 569: Specifies an alternative per-user configuration file.
! 570: If a configuration file is given on the command line,
! 571: the system-wide configuration file
! 572: .Pq Pa /etc/ssh_config
! 573: will be ignored.
! 574: The default for the per-user configuration file is
! 575: .Pa $HOME/.ssh/config .
1.2 deraadt 576: .It Fl L Ar port:host:hostport
1.1 deraadt 577: Specifies that the given port on the local (client) host is to be
1.40 aaron 578: forwarded to the given host and port on the remote side.
579: This works by allocating a socket to listen to
1.2 deraadt 580: .Ar port
1.1 deraadt 581: on the local side, and whenever a connection is made to this port, the
582: connection is forwarded over the secure channel, and a connection is
583: made to
1.32 markus 584: .Ar host
585: port
586: .Ar hostport
1.40 aaron 587: from the remote machine.
588: Port forwardings can also be specified in the configuration file.
589: Only root can forward privileged ports.
1.32 markus 590: IPv6 addresses can be specified with an alternative syntax:
591: .Ar port/host/hostport
1.2 deraadt 592: .It Fl R Ar port:host:hostport
1.1 deraadt 593: Specifies that the given port on the remote (server) host is to be
1.40 aaron 594: forwarded to the given host and port on the local side.
595: This works by allocating a socket to listen to
1.2 deraadt 596: .Ar port
1.1 deraadt 597: on the remote side, and whenever a connection is made to this port, the
598: connection is forwarded over the secure channel, and a connection is
599: made to
1.32 markus 600: .Ar host
601: port
602: .Ar hostport
1.40 aaron 603: from the local machine.
604: Port forwardings can also be specified in the configuration file.
605: Privileged ports can be forwarded only when
1.1 deraadt 606: logging in as root on the remote machine.
1.107 markus 607: IPv6 addresses can be specified with an alternative syntax:
608: .Ar port/host/hostport
1.85 jakob 609: .It Fl 1
610: Forces
611: .Nm
612: to try protocol version 1 only.
1.46 markus 613: .It Fl 2
614: Forces
615: .Nm
1.50 markus 616: to try protocol version 2 only.
1.32 markus 617: .It Fl 4
618: Forces
619: .Nm
620: to use IPv4 addresses only.
621: .It Fl 6
622: Forces
623: .Nm
624: to use IPv6 addresses only.
1.2 deraadt 625: .El
626: .Sh CONFIGURATION FILES
627: .Nm
1.127 stevesk 628: obtains configuration data from the following sources in
629: the following order:
1.1 deraadt 630: command line options, user's configuration file
1.2 deraadt 631: .Pq Pa $HOME/.ssh/config ,
632: and system-wide configuration file
633: .Pq Pa /etc/ssh_config .
634: For each parameter, the first obtained value
1.40 aaron 635: will be used.
636: The configuration files contain sections bracketed by
637: .Dq Host
638: specifications, and that section is only applied for hosts that
639: match one of the patterns given in the specification.
640: The matched host name is the one given on the command line.
1.2 deraadt 641: .Pp
1.1 deraadt 642: Since the first obtained value for each parameter is used, more
643: host-specific declarations should be given near the beginning of the
644: file, and general defaults at the end.
1.2 deraadt 645: .Pp
1.1 deraadt 646: The configuration file has the following format:
1.2 deraadt 647: .Pp
648: Empty lines and lines starting with
649: .Ql #
650: are comments.
651: .Pp
652: Otherwise a line is of the format
653: .Dq keyword arguments .
1.127 stevesk 654: Configuration options may be separated by whitespace or
655: optional whitespace and exactly one
656: .Ql = ;
657: the latter format is useful to avoid the need to quote whitespace
658: when specifying configuration options using the
659: .Nm ssh ,
660: .Nm scp
661: and
662: .Nm sftp
663: .Fl o
664: option.
665: .Pp
1.2 deraadt 666: The possible
1.128 stevesk 667: keywords and their meanings are as follows (note that
668: keywords are case-insensitive and arguments are case-sensitive):
1.2 deraadt 669: .Bl -tag -width Ds
670: .It Cm Host
1.1 deraadt 671: Restricts the following declarations (up to the next
1.2 deraadt 672: .Cm Host
1.1 deraadt 673: keyword) to be only for those hosts that match one of the patterns
1.2 deraadt 674: given after the keyword.
675: .Ql \&*
676: and
677: .Ql ?
678: can be used as wildcards in the
1.40 aaron 679: patterns.
680: A single
1.2 deraadt 681: .Ql \&*
682: as a pattern can be used to provide global
1.40 aaron 683: defaults for all hosts.
684: The host is the
1.2 deraadt 685: .Ar hostname
1.1 deraadt 686: argument given on the command line (i.e., the name is not converted to
687: a canonicalized host name before matching).
1.2 deraadt 688: .It Cm AFSTokenPassing
1.42 aaron 689: Specifies whether to pass AFS tokens to remote host.
690: The argument to this keyword must be
1.2 deraadt 691: .Dq yes
692: or
693: .Dq no .
1.107 markus 694: This option applies to protocol version 1 only.
1.2 deraadt 695: .It Cm BatchMode
696: If set to
697: .Dq yes ,
1.40 aaron 698: passphrase/password querying will be disabled.
699: This option is useful in scripts and other batch jobs where you have no
700: user to supply the password.
701: The argument must be
1.2 deraadt 702: .Dq yes
703: or
704: .Dq no .
1.100 stevesk 705: The default is
706: .Dq no .
1.108 markus 707: .It Cm BindAddress
708: Specify the interface to transmit from on machines with multiple
709: interfaces or aliased addresses.
710: Note that this option does not work if
711: .Cm UsePrivilegedPort
712: is set to
713: .Dq yes .
1.34 markus 714: .It Cm CheckHostIP
715: If this flag is set to
716: .Dq yes ,
1.100 stevesk 717: ssh will additionally check the host IP address in the
1.34 markus 718: .Pa known_hosts
1.42 aaron 719: file.
720: This allows ssh to detect if a host key changed due to DNS spoofing.
1.34 markus 721: If the option is set to
722: .Dq no ,
723: the check will not be executed.
1.100 stevesk 724: The default is
725: .Dq yes .
1.2 deraadt 726: .It Cm Cipher
1.62 markus 727: Specifies the cipher to use for encrypting the session
1.64 markus 728: in protocol version 1.
1.40 aaron 729: Currently,
1.131 stevesk 730: .Dq blowfish ,
731: .Dq 3des ,
1.1 deraadt 732: and
1.131 stevesk 733: .Dq des
1.40 aaron 734: are supported.
1.131 stevesk 735: .Ar des
736: is only supported in the
737: .Nm
738: client for interoperability with legacy protocol 1 implementations
739: that do not support the
740: .Ar 3des
741: cipher. Its use is strongly discouraged due to cryptographic
742: weaknesses.
1.40 aaron 743: The default is
1.2 deraadt 744: .Dq 3des .
1.45 markus 745: .It Cm Ciphers
746: Specifies the ciphers allowed for protocol version 2
747: in order of preference.
748: Multiple ciphers must be comma-separated.
749: The default is
1.88 provos 750: .Pp
751: .Bd -literal
1.94 deraadt 752: ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
1.107 markus 753: aes192-cbc,aes256-cbc''
1.88 provos 754: .Ed
1.2 deraadt 755: .It Cm Compression
1.40 aaron 756: Specifies whether to use compression.
757: The argument must be
1.2 deraadt 758: .Dq yes
759: or
760: .Dq no .
1.100 stevesk 761: The default is
762: .Dq no .
1.2 deraadt 763: .It Cm CompressionLevel
1.100 stevesk 764: Specifies the compression level to use if compression is enabled.
1.40 aaron 765: The argument must be an integer from 1 (fast) to 9 (slow, best).
766: The default level is 6, which is good for most applications.
767: The meaning of the values is the same as in
1.34 markus 768: .Xr gzip 1 .
1.107 markus 769: Note that this option applies to protocol version 1 only.
1.2 deraadt 770: .It Cm ConnectionAttempts
1.1 deraadt 771: Specifies the number of tries (one per second) to make before falling
1.40 aaron 772: back to rsh or exiting.
773: The argument must be an integer.
774: This may be useful in scripts if the connection sometimes fails.
1.124 markus 775: The default is 1.
1.2 deraadt 776: .It Cm EscapeChar
777: Sets the escape character (default:
778: .Ql ~ ) .
779: The escape character can also
1.40 aaron 780: be set on the command line.
781: The argument should be a single character,
1.2 deraadt 782: .Ql ^
783: followed by a letter, or
784: .Dq none
785: to disable the escape
1.1 deraadt 786: character entirely (making the connection transparent for binary
787: data).
1.44 aaron 788: .It Cm FallBackToRsh
1.1 deraadt 789: Specifies that if connecting via
1.2 deraadt 790: .Nm
1.1 deraadt 791: fails due to a connection refused error (there is no
1.2 deraadt 792: .Xr sshd 8
1.44 aaron 793: listening on the remote host),
1.2 deraadt 794: .Xr rsh 1
1.1 deraadt 795: should automatically be used instead (after a suitable warning about
1.40 aaron 796: the session being unencrypted).
797: The argument must be
1.2 deraadt 798: .Dq yes
799: or
800: .Dq no .
1.100 stevesk 801: The default is
802: .Dq no .
1.2 deraadt 803: .It Cm ForwardAgent
1.1 deraadt 804: Specifies whether the connection to the authentication agent (if any)
1.40 aaron 805: will be forwarded to the remote machine.
806: The argument must be
1.2 deraadt 807: .Dq yes
808: or
1.54 markus 809: .Dq no .
810: The default is
1.2 deraadt 811: .Dq no .
812: .It Cm ForwardX11
1.1 deraadt 813: Specifies whether X11 connections will be automatically redirected
1.44 aaron 814: over the secure channel and
1.2 deraadt 815: .Ev DISPLAY
1.40 aaron 816: set.
1.44 aaron 817: The argument must be
1.2 deraadt 818: .Dq yes
819: or
1.38 markus 820: .Dq no .
821: The default is
1.3 deraadt 822: .Dq no .
823: .It Cm GatewayPorts
824: Specifies whether remote hosts are allowed to connect to local
825: forwarded ports.
826: The argument must be
827: .Dq yes
828: or
829: .Dq no .
830: The default is
1.2 deraadt 831: .Dq no .
832: .It Cm GlobalKnownHostsFile
1.116 markus 833: Specifies a file to use for the global
1.95 stevesk 834: host key database instead of
1.2 deraadt 835: .Pa /etc/ssh_known_hosts .
1.107 markus 836: .It Cm HostbasedAuthentication
837: Specifies whether to try rhosts based authentication with public key
838: authentication.
839: The argument must be
840: .Dq yes
841: or
842: .Dq no .
843: The default is
1.112 markus 844: .Dq no .
1.107 markus 845: This option applies to protocol version 2 only and
846: is similar to
847: .Cm RhostsRSAAuthentication .
848: .It Cm HostKeyAlgorithms
1.109 stevesk 849: Specifies the protocol version 2 host key algorithms
1.107 markus 850: that the client wants to use in order of preference.
851: The default for this option is:
852: .Dq ssh-rsa,ssh-dss
1.74 markus 853: .It Cm HostKeyAlias
854: Specifies an alias that should be used instead of the
855: real host name when looking up or saving the host key
1.107 markus 856: in the host key database files.
1.82 stevesk 857: This option is useful for tunneling ssh connections
1.74 markus 858: or if you have multiple servers running on a single host.
1.2 deraadt 859: .It Cm HostName
1.40 aaron 860: Specifies the real host name to log into.
861: This can be used to specify nicknames or abbreviations for hosts.
862: Default is the name given on the command line.
863: Numeric IP addresses are also permitted (both on the command line and in
1.2 deraadt 864: .Cm HostName
1.1 deraadt 865: specifications).
1.2 deraadt 866: .It Cm IdentityFile
1.107 markus 867: Specifies the file from which the user's RSA or DSA authentication identity
1.2 deraadt 868: is read (default
1.49 markus 869: .Pa $HOME/.ssh/identity
1.2 deraadt 870: in the user's home directory).
1.1 deraadt 871: Additionally, any identities represented by the authentication agent
1.40 aaron 872: will be used for authentication.
873: The file name may use the tilde
874: syntax to refer to a user's home directory.
875: It is possible to have
1.1 deraadt 876: multiple identity files specified in configuration files; all these
877: identities will be tried in sequence.
1.2 deraadt 878: .It Cm KeepAlive
1.1 deraadt 879: Specifies whether the system should send keepalive messages to the
1.40 aaron 880: other side.
881: If they are sent, death of the connection or crash of one
882: of the machines will be properly noticed.
883: However, this means that
1.1 deraadt 884: connections will die if the route is down temporarily, and some people
1.41 aaron 885: find it annoying.
1.2 deraadt 886: .Pp
887: The default is
888: .Dq yes
889: (to send keepalives), and the client will notice
1.40 aaron 890: if the network goes down or the remote host dies.
891: This is important in scripts, and many users want it too.
1.2 deraadt 892: .Pp
893: To disable keepalives, the value should be set to
894: .Dq no
895: in both the server and the client configuration files.
896: .It Cm KerberosAuthentication
1.42 aaron 897: Specifies whether Kerberos authentication will be used.
898: The argument to this keyword must be
1.4 dugsong 899: .Dq yes
900: or
901: .Dq no .
1.2 deraadt 902: .It Cm KerberosTgtPassing
1.42 aaron 903: Specifies whether a Kerberos TGT will be forwarded to the server.
904: This will only work if the Kerberos server is actually an AFS kaserver.
905: The argument to this keyword must be
1.4 dugsong 906: .Dq yes
907: or
908: .Dq no .
1.2 deraadt 909: .It Cm LocalForward
1.1 deraadt 910: Specifies that a TCP/IP port on the local machine be forwarded over
1.40 aaron 911: the secure channel to given host:port from the remote machine.
912: The first argument must be a port number, and the second must be
913: host:port.
914: Multiple forwardings may be specified, and additional
915: forwardings can be given on the command line.
916: Only the superuser can forward privileged ports.
1.24 markus 917: .It Cm LogLevel
918: Gives the verbosity level that is used when logging messages from
919: .Nm ssh .
920: The possible values are:
1.77 markus 921: QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG.
922: The default is INFO.
1.91 markus 923: .It Cm MACs
1.117 itojun 924: Specifies the MAC (message authentication code) algorithms
1.91 markus 925: in order of preference.
926: The MAC algorithm is used in protocol version 2
927: for data integrity protection.
928: Multiple algorithms must be comma-separated.
929: The default is
1.113 markus 930: .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
1.14 dugsong 931: .It Cm NumberOfPasswordPrompts
1.42 aaron 932: Specifies the number of password prompts before giving up.
933: The argument to this keyword must be an integer.
934: Default is 3.
1.34 markus 935: .It Cm PasswordAuthentication
1.40 aaron 936: Specifies whether to use password authentication.
937: The argument to this keyword must be
1.34 markus 938: .Dq yes
939: or
940: .Dq no .
1.100 stevesk 941: The default is
942: .Dq yes .
1.2 deraadt 943: .It Cm Port
1.40 aaron 944: Specifies the port number to connect on the remote host.
945: Default is 22.
1.99 djm 946: .It Cm PreferredAuthentications
1.117 itojun 947: Specifies the order in which the client should try protocol 2
948: authentication methods. This allows a client to prefer one method (e.g.
1.99 djm 949: .Cm keyboard-interactive )
950: over another method (e.g.
951: .Cm password )
952: The default for this option is:
1.123 markus 953: .Dq hostbased,publickey,keyboard-interactive,password
1.45 markus 954: .It Cm Protocol
955: Specifies the protocol versions
956: .Nm
957: should support in order of preference.
958: The possible values are
959: .Dq 1
960: and
961: .Dq 2 .
962: Multiple versions must be comma-separated.
963: The default is
1.101 markus 964: .Dq 2,1 .
1.49 markus 965: This means that
966: .Nm
1.101 markus 967: tries version 2 and falls back to version 1
968: if version 2 is not available.
1.2 deraadt 969: .It Cm ProxyCommand
1.40 aaron 970: Specifies the command to use to connect to the server.
971: The command
972: string extends to the end of the line, and is executed with
973: .Pa /bin/sh .
974: In the command string,
975: .Ql %h
976: will be substituted by the host name to
977: connect and
978: .Ql %p
979: by the port.
980: The command can be basically anything,
981: and should read from its standard input and write to its standard output.
982: It should eventually connect an
1.2 deraadt 983: .Xr sshd 8
1.1 deraadt 984: server running on some machine, or execute
1.2 deraadt 985: .Ic sshd -i
1.40 aaron 986: somewhere.
987: Host key management will be done using the
1.1 deraadt 988: HostName of the host being connected (defaulting to the name typed by
989: the user).
1.29 markus 990: Note that
991: .Cm CheckHostIP
992: is not available for connects with a proxy command.
1.2 deraadt 993: .Pp
1.107 markus 994: .It Cm PubkeyAuthentication
995: Specifies whether to try public key authentication.
996: The argument to this keyword must be
997: .Dq yes
998: or
999: .Dq no .
1000: The default is
1001: .Dq yes .
1002: This option applies to protocol version 2 only.
1.2 deraadt 1003: .It Cm RemoteForward
1.1 deraadt 1004: Specifies that a TCP/IP port on the remote machine be forwarded over
1.40 aaron 1005: the secure channel to given host:port from the local machine.
1006: The first argument must be a port number, and the second must be
1007: host:port.
1008: Multiple forwardings may be specified, and additional
1009: forwardings can be given on the command line.
1010: Only the superuser can forward privileged ports.
1.2 deraadt 1011: .It Cm RhostsAuthentication
1.40 aaron 1012: Specifies whether to try rhosts based authentication.
1013: Note that this
1.1 deraadt 1014: declaration only affects the client side and has no effect whatsoever
1.40 aaron 1015: on security.
1016: Disabling rhosts authentication may reduce
1.1 deraadt 1017: authentication time on slow connections when rhosts authentication is
1.40 aaron 1018: not used.
1019: Most servers do not permit RhostsAuthentication because it
1.117 itojun 1020: is not secure (see
1.114 mpech 1021: .Cm RhostsRSAAuthentication ) .
1.40 aaron 1022: The argument to this keyword must be
1.2 deraadt 1023: .Dq yes
1024: or
1025: .Dq no .
1.100 stevesk 1026: The default is
1027: .Dq yes .
1.107 markus 1028: This option applies to protocol version 1 only.
1.2 deraadt 1029: .It Cm RhostsRSAAuthentication
1.1 deraadt 1030: Specifies whether to try rhosts based authentication with RSA host
1.40 aaron 1031: authentication.
1032: The argument must be
1.2 deraadt 1033: .Dq yes
1034: or
1035: .Dq no .
1.100 stevesk 1036: The default is
1037: .Dq yes .
1.107 markus 1038: This option applies to protocol version 1 only.
1.2 deraadt 1039: .It Cm RSAAuthentication
1.40 aaron 1040: Specifies whether to try RSA authentication.
1041: The argument to this keyword must be
1.2 deraadt 1042: .Dq yes
1043: or
1044: .Dq no .
1.1 deraadt 1045: RSA authentication will only be
1046: attempted if the identity file exists, or an authentication agent is
1047: running.
1.100 stevesk 1048: The default is
1049: .Dq yes .
1.50 markus 1050: Note that this option applies to protocol version 1 only.
1.81 markus 1051: .It Cm ChallengeResponseAuthentication
1052: Specifies whether to use challenge response authentication.
1.40 aaron 1053: The argument to this keyword must be
1.27 markus 1054: .Dq yes
1055: or
1056: .Dq no .
1057: The default is
1.122 markus 1058: .Dq yes .
1.125 jakob 1059: .It Cm SmartcardDevice
1060: Specifies which smartcard device to use. The argument to this keyword is
1061: the device
1062: .Nm
1063: should use to communicate with a smartcard used for storing the user's
1064: private RSA key. By default, no device is specified and smartcard support
1065: is not activated.
1.2 deraadt 1066: .It Cm StrictHostKeyChecking
1067: If this flag is set to
1.44 aaron 1068: .Dq yes ,
1.2 deraadt 1069: .Nm
1.79 stevesk 1070: will never automatically add host keys to the
1.2 deraadt 1071: .Pa $HOME/.ssh/known_hosts
1.116 markus 1072: file, and refuses to connect to hosts whose host key has changed.
1.40 aaron 1073: This provides maximum protection against trojan horse attacks.
1074: However, it can be somewhat annoying if you don't have good
1.2 deraadt 1075: .Pa /etc/ssh_known_hosts
1.1 deraadt 1076: files installed and frequently
1.79 stevesk 1077: connect to new hosts.
1078: This option forces the user to manually
1079: add all new hosts.
1080: If this flag is set to
1081: .Dq no ,
1082: .Nm
1083: will automatically add new host keys to the
1084: user known hosts files.
1085: If this flag is set to
1086: .Dq ask ,
1087: new host keys
1088: will be added to the user known host files only after the user
1089: has confirmed that is what they really want to do, and
1090: .Nm
1091: will refuse to connect to hosts whose host key has changed.
1.40 aaron 1092: The host keys of
1.79 stevesk 1093: known hosts will be verified automatically in all cases.
1.40 aaron 1094: The argument must be
1.79 stevesk 1095: .Dq yes ,
1096: .Dq no
1.2 deraadt 1097: or
1.79 stevesk 1098: .Dq ask .
1099: The default is
1100: .Dq ask .
1.16 markus 1101: .It Cm UsePrivilegedPort
1102: Specifies whether to use a privileged port for outgoing connections.
1103: The argument must be
1104: .Dq yes
1105: or
1106: .Dq no .
1107: The default is
1.98 markus 1108: .Dq no .
1.107 markus 1109: Note that you need to set this option to
1110: .Dq yes
1111: if you want to use
1.16 markus 1112: .Cm RhostsAuthentication
1113: and
1.72 markus 1114: .Cm RhostsRSAAuthentication
1.107 markus 1115: with older servers.
1.34 markus 1116: .It Cm User
1.40 aaron 1117: Specifies the user to log in as.
1118: This can be useful if you have a different user name on different machines.
1119: This saves the trouble of
1.34 markus 1120: having to remember to give the user name on the command line.
1121: .It Cm UserKnownHostsFile
1.116 markus 1122: Specifies a file to use for the user
1.95 stevesk 1123: host key database instead of
1.34 markus 1124: .Pa $HOME/.ssh/known_hosts .
1.2 deraadt 1125: .It Cm UseRsh
1.40 aaron 1126: Specifies that rlogin/rsh should be used for this host.
1127: It is possible that the host does not at all support the
1.2 deraadt 1128: .Nm
1.40 aaron 1129: protocol.
1130: This causes
1.2 deraadt 1131: .Nm
1.40 aaron 1132: to immediately execute
1.2 deraadt 1133: .Xr rsh 1 .
1.1 deraadt 1134: All other options (except
1.2 deraadt 1135: .Cm HostName )
1.40 aaron 1136: are ignored if this has been specified.
1137: The argument must be
1.2 deraadt 1138: .Dq yes
1139: or
1140: .Dq no .
1.55 markus 1141: .It Cm XAuthLocation
1142: Specifies the location of the
1143: .Xr xauth 1
1144: program.
1145: The default is
1146: .Pa /usr/X11R6/bin/xauth .
1.58 itojun 1147: .El
1.2 deraadt 1148: .Sh ENVIRONMENT
1149: .Nm
1.1 deraadt 1150: will normally set the following environment variables:
1.2 deraadt 1151: .Bl -tag -width Ds
1152: .It Ev DISPLAY
1153: The
1154: .Ev DISPLAY
1.40 aaron 1155: variable indicates the location of the X11 server.
1.44 aaron 1156: It is automatically set by
1.2 deraadt 1157: .Nm
1158: to point to a value of the form
1159: .Dq hostname:n
1160: where hostname indicates
1.40 aaron 1161: the host where the shell runs, and n is an integer >= 1.
1162: .Nm
1163: uses this special value to forward X11 connections over the secure
1164: channel.
1.107 markus 1165: The user should normally not set
1166: .Ev DISPLAY
1167: explicitly, as that
1.1 deraadt 1168: will render the X11 connection insecure (and will require the user to
1169: manually copy any required authorization cookies).
1.2 deraadt 1170: .It Ev HOME
1.1 deraadt 1171: Set to the path of the user's home directory.
1.2 deraadt 1172: .It Ev LOGNAME
1173: Synonym for
1.12 aaron 1174: .Ev USER ;
1175: set for compatibility with systems that use this variable.
1.2 deraadt 1176: .It Ev MAIL
1.129 stevesk 1177: Set to the path of the user's mailbox.
1.40 aaron 1178: .It Ev PATH
1.2 deraadt 1179: Set to the default
1180: .Ev PATH ,
1181: as specified when compiling
1.12 aaron 1182: .Nm ssh .
1.118 markus 1183: .It Ev SSH_ASKPASS
1184: If
1185: .Nm
1186: needs a passphrase, it will read the passphrase from the current
1187: terminal if it was run from a terminal.
1188: If
1189: .Nm
1190: does not have a terminal associated with it but
1191: .Ev DISPLAY
1192: and
1193: .Ev SSH_ASKPASS
1194: are set, it will execute the program specified by
1195: .Ev SSH_ASKPASS
1196: and open an X11 window to read the passphrase.
1197: This is particularly useful when calling
1198: .Nm
1199: from a
1200: .Pa .Xsession
1201: or related script.
1202: (Note that on some machines it
1203: may be necessary to redirect the input from
1204: .Pa /dev/null
1205: to make this work.)
1.18 markus 1206: .It Ev SSH_AUTH_SOCK
1.129 stevesk 1207: Identifies the path of a unix-domain socket used to communicate with the
1.17 markus 1208: agent.
1.2 deraadt 1209: .It Ev SSH_CLIENT
1.40 aaron 1210: Identifies the client end of the connection.
1211: The variable contains
1.1 deraadt 1212: three space-separated values: client ip-address, client port number,
1213: and server port number.
1.73 markus 1214: .It Ev SSH_ORIGINAL_COMMAND
1215: The variable contains the original command line if a forced command
1216: is executed.
1217: It can be used to extract the original arguments.
1.2 deraadt 1218: .It Ev SSH_TTY
1.1 deraadt 1219: This is set to the name of the tty (path to the device) associated
1.40 aaron 1220: with the current shell or command.
1221: If the current session has no tty,
1.1 deraadt 1222: this variable is not set.
1.2 deraadt 1223: .It Ev TZ
1.1 deraadt 1224: The timezone variable is set to indicate the present timezone if it
1.56 deraadt 1225: was set when the daemon was started (i.e., the daemon passes the value
1.1 deraadt 1226: on to new connections).
1.2 deraadt 1227: .It Ev USER
1.1 deraadt 1228: Set to the name of the user logging in.
1.2 deraadt 1229: .El
1230: .Pp
1.44 aaron 1231: Additionally,
1.2 deraadt 1232: .Nm
1.44 aaron 1233: reads
1234: .Pa $HOME/.ssh/environment ,
1.2 deraadt 1235: and adds lines of the format
1236: .Dq VARNAME=value
1.12 aaron 1237: to the environment.
1.2 deraadt 1238: .Sh FILES
1.36 markus 1239: .Bl -tag -width Ds
1.116 markus 1240: .It Pa $HOME/.ssh/known_hosts
1.129 stevesk 1241: Records host keys for all hosts the user has logged into that are not
1.2 deraadt 1242: in
1.116 markus 1243: .Pa /etc/ssh_known_hosts .
1.2 deraadt 1244: See
1245: .Xr sshd 8 .
1.102 itojun 1246: .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa
1247: Contains the authentication identity of the user.
1248: They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively.
1.48 markus 1249: These files
1250: contain sensitive data and should be readable by the user but not
1.15 markus 1251: accessible by others (read/write/execute).
1252: Note that
1253: .Nm
1.48 markus 1254: ignores a private key file if it is accessible by others.
1.15 markus 1255: It is possible to specify a passphrase when
1.1 deraadt 1256: generating the key; the passphrase will be used to encrypt the
1.8 deraadt 1257: sensitive part of this file using 3DES.
1.102 itojun 1258: .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub
1.1 deraadt 1259: Contains the public key for authentication (public part of the
1.40 aaron 1260: identity file in human-readable form).
1.48 markus 1261: The contents of the
1262: .Pa $HOME/.ssh/identity.pub
1263: file should be added to
1.2 deraadt 1264: .Pa $HOME/.ssh/authorized_keys
1265: on all machines
1.102 itojun 1266: where you wish to log in using protocol version 1 RSA authentication.
1.48 markus 1267: The contents of the
1268: .Pa $HOME/.ssh/id_dsa.pub
1.102 itojun 1269: and
1270: .Pa $HOME/.ssh/id_rsa.pub
1.48 markus 1271: file should be added to
1.115 markus 1272: .Pa $HOME/.ssh/authorized_keys
1.48 markus 1273: on all machines
1.102 itojun 1274: where you wish to log in using protocol version 2 DSA/RSA authentication.
1.48 markus 1275: These files are not
1.40 aaron 1276: sensitive and can (but need not) be readable by anyone.
1.48 markus 1277: These files are
1.84 markus 1278: never used automatically and are not necessary; they are only provided for
1.1 deraadt 1279: the convenience of the user.
1.2 deraadt 1280: .It Pa $HOME/.ssh/config
1.40 aaron 1281: This is the per-user configuration file.
1282: The format of this file is described above.
1283: This file is used by the
1.2 deraadt 1284: .Nm
1.40 aaron 1285: client.
1286: This file does not usually contain any sensitive information,
1.1 deraadt 1287: but the recommended permissions are read/write for the user, and not
1288: accessible by others.
1.2 deraadt 1289: .It Pa $HOME/.ssh/authorized_keys
1.115 markus 1290: Lists the public keys (RSA/DSA) that can be used for logging in as this user.
1.40 aaron 1291: The format of this file is described in the
1.2 deraadt 1292: .Xr sshd 8
1.40 aaron 1293: manual page.
1.116 markus 1294: In the simplest form the format is the same as the .pub
1295: identity files.
1.48 markus 1296: This file is not highly sensitive, but the recommended
1297: permissions are read/write for the user, and not accessible by others.
1.116 markus 1298: .It Pa /etc/ssh_known_hosts
1.40 aaron 1299: Systemwide list of known host keys.
1.116 markus 1300: This file should be prepared by the
1.1 deraadt 1301: system administrator to contain the public host keys of all machines in the
1.40 aaron 1302: organization.
1303: This file should be world-readable.
1304: This file contains
1.1 deraadt 1305: public keys, one per line, in the following format (fields separated
1.116 markus 1306: by spaces): system name, public key and optional comment field.
1.40 aaron 1307: When different names are used
1.1 deraadt 1308: for the same machine, all such names should be listed, separated by
1.40 aaron 1309: commas.
1310: The format is described on the
1.2 deraadt 1311: .Xr sshd 8
1.1 deraadt 1312: manual page.
1.2 deraadt 1313: .Pp
1.1 deraadt 1314: The canonical system name (as returned by name servers) is used by
1.2 deraadt 1315: .Xr sshd 8
1.1 deraadt 1316: to verify the client host when logging in; other names are needed because
1.2 deraadt 1317: .Nm
1.1 deraadt 1318: does not convert the user-supplied name to a canonical name before
1319: checking the key, because someone with access to the name servers
1320: would then be able to fool host authentication.
1.2 deraadt 1321: .It Pa /etc/ssh_config
1.40 aaron 1322: Systemwide configuration file.
1323: This file provides defaults for those
1.1 deraadt 1324: values that are not specified in the user's configuration file, and
1.40 aaron 1325: for those users who do not have a configuration file.
1326: This file must be world-readable.
1.2 deraadt 1327: .It Pa $HOME/.rhosts
1328: This file is used in
1329: .Pa \&.rhosts
1330: authentication to list the
1.40 aaron 1331: host/user pairs that are permitted to log in.
1332: (Note that this file is
1.1 deraadt 1333: also used by rlogin and rsh, which makes using this file insecure.)
1334: Each line of the file contains a host name (in the canonical form
1335: returned by name servers), and then a user name on that host,
1.40 aaron 1336: separated by a space.
1.92 markus 1337: On some machines this file may need to be
1.1 deraadt 1338: world-readable if the user's home directory is on a NFS partition,
1339: because
1.2 deraadt 1340: .Xr sshd 8
1.40 aaron 1341: reads it as root.
1342: Additionally, this file must be owned by the user,
1343: and must not have write permissions for anyone else.
1344: The recommended
1.1 deraadt 1345: permission for most machines is read/write for the user, and not
1346: accessible by others.
1.2 deraadt 1347: .Pp
1.1 deraadt 1348: Note that by default
1.2 deraadt 1349: .Xr sshd 8
1.1 deraadt 1350: will be installed so that it requires successful RSA host
1.40 aaron 1351: authentication before permitting \s+2.\s0rhosts authentication.
1352: If your server machine does not have the client's host key in
1.2 deraadt 1353: .Pa /etc/ssh_known_hosts ,
1354: you can store it in
1355: .Pa $HOME/.ssh/known_hosts .
1356: The easiest way to do this is to
1.1 deraadt 1357: connect back to the client from the server machine using ssh; this
1.48 markus 1358: will automatically add the host key to
1.2 deraadt 1359: .Pa $HOME/.ssh/known_hosts .
1360: .It Pa $HOME/.shosts
1361: This file is used exactly the same way as
1362: .Pa \&.rhosts .
1363: The purpose for
1.1 deraadt 1364: having this file is to be able to use rhosts authentication with
1.2 deraadt 1365: .Nm
1366: without permitting login with
1367: .Xr rlogin 1
1368: or
1369: .Xr rsh 1 .
1370: .It Pa /etc/hosts.equiv
1371: This file is used during
1.40 aaron 1372: .Pa \&.rhosts authentication.
1373: It contains
1.1 deraadt 1374: canonical hosts names, one per line (the full format is described on
1375: the
1.2 deraadt 1376: .Xr sshd 8
1.40 aaron 1377: manual page).
1378: If the client host is found in this file, login is
1.1 deraadt 1379: automatically permitted provided client and server user names are the
1.40 aaron 1380: same.
1381: Additionally, successful RSA host authentication is normally
1382: required.
1383: This file should only be writable by root.
1.2 deraadt 1384: .It Pa /etc/shosts.equiv
1.44 aaron 1385: This file is processed exactly as
1.2 deraadt 1386: .Pa /etc/hosts.equiv .
1.1 deraadt 1387: This file may be useful to permit logins using
1.2 deraadt 1388: .Nm
1.1 deraadt 1389: but not using rsh/rlogin.
1.2 deraadt 1390: .It Pa /etc/sshrc
1.1 deraadt 1391: Commands in this file are executed by
1.2 deraadt 1392: .Nm
1.1 deraadt 1393: when the user logs in just before the user's shell (or command) is started.
1394: See the
1.2 deraadt 1395: .Xr sshd 8
1.1 deraadt 1396: manual page for more information.
1.2 deraadt 1397: .It Pa $HOME/.ssh/rc
1.1 deraadt 1398: Commands in this file are executed by
1.2 deraadt 1399: .Nm
1.1 deraadt 1400: when the user logs in just before the user's shell (or command) is
1401: started.
1.44 aaron 1402: See the
1.2 deraadt 1403: .Xr sshd 8
1.1 deraadt 1404: manual page for more information.
1.31 markus 1405: .It Pa $HOME/.ssh/environment
1406: Contains additional definitions for environment variables, see section
1407: .Sx ENVIRONMENT
1408: above.
1.58 itojun 1409: .El
1.67 aaron 1410: .Sh AUTHORS
1.78 markus 1411: OpenSSH is a derivative of the original and free
1412: ssh 1.2.12 release by Tatu Ylonen.
1413: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1414: Theo de Raadt and Dug Song
1415: removed many bugs, re-added newer features and
1416: created OpenSSH.
1417: Markus Friedl contributed the support for SSH
1418: protocol versions 1.5 and 2.0.
1.2 deraadt 1419: .Sh SEE ALSO
1420: .Xr rlogin 1 ,
1421: .Xr rsh 1 ,
1422: .Xr scp 1 ,
1.83 djm 1423: .Xr sftp 1 ,
1.2 deraadt 1424: .Xr ssh-add 1 ,
1425: .Xr ssh-agent 1 ,
1426: .Xr ssh-keygen 1 ,
1427: .Xr telnet 1 ,
1.87 itojun 1428: .Xr sshd 8
1.106 markus 1429: .Rs
1430: .%A T. Ylonen
1431: .%A T. Kivinen
1432: .%A M. Saarinen
1433: .%A T. Rinne
1434: .%A S. Lehtinen
1435: .%T "SSH Protocol Architecture"
1.126 markus 1436: .%N draft-ietf-secsh-architecture-09.txt
1437: .%D July 2001
1.106 markus 1438: .%O work in progress material
1439: .Re
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh