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