Annotation of src/usr.bin/ssh/ssh.1, Revision 1.208
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.208 ! djm 37: .\" $OpenBSD: ssh.1,v 1.207 2005/04/21 06:17:50 djm 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
1.202 jmc 46: .Bk -words
1.191 djm 47: .Op Fl 1246AaCfgkMNnqsTtVvXxY
1.108 markus 48: .Op Fl b Ar bind_address
1.51 markus 49: .Op Fl c Ar cipher_spec
1.176 jmc 50: .Op Fl D Ar port
1.2 deraadt 51: .Op Fl e Ar escape_char
1.176 jmc 52: .Op Fl F Ar configfile
1.2 deraadt 53: .Op Fl i Ar identity_file
1.202 jmc 54: .Oo Fl L\ \&
1.12 aaron 55: .Sm off
1.200 djm 56: .Oo Ar bind_address : Oc
1.202 jmc 57: .Ar port : host : hostport
1.12 aaron 58: .Sm on
59: .Oc
1.176 jmc 60: .Op Fl l Ar login_name
61: .Op Fl m Ar mac_spec
1.198 djm 62: .Op Fl O Ar ctl_cmd
1.176 jmc 63: .Op Fl o Ar option
64: .Op Fl p Ar port
1.202 jmc 65: .Oo Fl R\ \&
1.12 aaron 66: .Sm off
1.200 djm 67: .Oo Ar bind_address : Oc
1.202 jmc 68: .Ar port : host : hostport
1.12 aaron 69: .Sm on
70: .Oc
1.198 djm 71: .Op Fl S Ar ctl_path
1.176 jmc 72: .Oo Ar user Ns @ Oc Ns Ar hostname
1.2 deraadt 73: .Op Ar command
1.202 jmc 74: .Ek
1.44 aaron 75: .Sh DESCRIPTION
1.2 deraadt 76: .Nm
1.96 deraadt 77: (SSH client) is a program for logging into a remote machine and for
1.40 aaron 78: executing commands on a remote machine.
1.176 jmc 79: It is intended to replace rlogin and rsh,
80: and provide secure encrypted communications between
1.40 aaron 81: two untrusted hosts over an insecure network.
1.176 jmc 82: X11 connections and arbitrary TCP/IP ports
83: 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.176 jmc 87: .Ar hostname
88: (with optional
89: .Ar user
90: name).
1.1 deraadt 91: The user must prove
1.49 markus 92: his/her identity to the remote machine using one of several methods
1.176 jmc 93: depending on the protocol version used.
1.49 markus 94: .Pp
1.176 jmc 95: If
96: .Ar command
97: is specified,
98: .Ar command
99: is executed on the remote host instead of a login shell.
1.49 markus 100: .Ss SSH protocol version 1
1.195 markus 101: The first authentication method is the
102: .Em rhosts
103: or
104: .Em hosts.equiv
105: method combined with RSA-based host authentication.
106: If the machine the user logs in from is listed in
1.2 deraadt 107: .Pa /etc/hosts.equiv
1.1 deraadt 108: or
1.2 deraadt 109: .Pa /etc/shosts.equiv
1.1 deraadt 110: on the remote machine, and the user names are
1.195 markus 111: the same on both sides, or if the files
1.207 djm 112: .Pa ~/.rhosts
1.1 deraadt 113: or
1.207 djm 114: .Pa ~/.shosts
1.195 markus 115: exist in the user's home directory on the
116: remote machine and contain a line containing the name of the client
1.1 deraadt 117: machine and the name of the user on that machine, the user is
1.195 markus 118: considered for log in.
119: Additionally, if the server can verify the client's
1.44 aaron 120: host key (see
1.147 deraadt 121: .Pa /etc/ssh/ssh_known_hosts
1.23 markus 122: and
1.207 djm 123: .Pa ~/.ssh/known_hosts
1.1 deraadt 124: in the
1.2 deraadt 125: .Sx FILES
1.176 jmc 126: section), only then is login permitted.
1.40 aaron 127: This authentication method closes security holes due to IP
128: spoofing, DNS spoofing and routing spoofing.
129: [Note to the administrator:
1.2 deraadt 130: .Pa /etc/hosts.equiv ,
1.207 djm 131: .Pa ~/.rhosts ,
1.1 deraadt 132: and the rlogin/rsh protocol in general, are inherently insecure and should be
133: disabled if security is desired.]
1.2 deraadt 134: .Pp
1.195 markus 135: As a second authentication method,
1.2 deraadt 136: .Nm
1.1 deraadt 137: supports RSA based authentication.
138: The scheme is based on public-key cryptography: there are cryptosystems
139: where encryption and decryption are done using separate keys, and it
140: is not possible to derive the decryption key from the encryption key.
1.40 aaron 141: RSA is one such system.
1.44 aaron 142: The idea is that each user creates a public/private
1.40 aaron 143: key pair for authentication purposes.
144: The server knows the public key, and only the user knows the private key.
1.176 jmc 145: .Pp
1.44 aaron 146: The file
1.207 djm 147: .Pa ~/.ssh/authorized_keys
1.176 jmc 148: lists the public keys that are permitted for logging in.
1.40 aaron 149: When the user logs in, the
1.2 deraadt 150: .Nm
1.1 deraadt 151: program tells the server which key pair it would like to use for
1.40 aaron 152: authentication.
1.176 jmc 153: The server checks if this key is permitted, and if so,
154: sends the user (actually the
1.2 deraadt 155: .Nm
1.1 deraadt 156: program running on behalf of the user) a challenge, a random number,
1.40 aaron 157: encrypted by the user's public key.
1.176 jmc 158: The challenge can only be decrypted using the proper private key.
159: The user's client then decrypts the challenge using the private key,
160: proving that he/she knows the private key
161: but without disclosing it to the server.
1.2 deraadt 162: .Pp
163: .Nm
1.40 aaron 164: implements the RSA authentication protocol automatically.
165: The user creates his/her RSA key pair by running
1.2 deraadt 166: .Xr ssh-keygen 1 .
1.44 aaron 167: This stores the private key in
1.207 djm 168: .Pa ~/.ssh/identity
1.176 jmc 169: and stores the public key in
1.207 djm 170: .Pa ~/.ssh/identity.pub
1.40 aaron 171: in the user's home directory.
172: The user should then copy the
1.2 deraadt 173: .Pa identity.pub
1.44 aaron 174: to
1.207 djm 175: .Pa ~/.ssh/authorized_keys
1.44 aaron 176: in his/her home directory on the remote machine (the
1.2 deraadt 177: .Pa authorized_keys
1.44 aaron 178: file corresponds to the conventional
1.207 djm 179: .Pa ~/.rhosts
1.1 deraadt 180: file, and has one key
1.40 aaron 181: per line, though the lines can be very long).
182: After this, the user can log in without giving the password.
1.2 deraadt 183: .Pp
1.1 deraadt 184: The most convenient way to use RSA authentication may be with an
1.40 aaron 185: authentication agent.
186: See
1.2 deraadt 187: .Xr ssh-agent 1
1.1 deraadt 188: for more information.
1.2 deraadt 189: .Pp
1.44 aaron 190: If other authentication methods fail,
1.2 deraadt 191: .Nm
1.40 aaron 192: prompts the user for a password.
193: The password is sent to the remote
1.1 deraadt 194: host for checking; however, since all communications are encrypted,
195: the password cannot be seen by someone listening on the network.
1.49 markus 196: .Ss SSH protocol version 2
1.176 jmc 197: When a user connects using protocol version 2,
1.145 markus 198: similar authentication methods are available.
1.107 markus 199: Using the default values for
200: .Cm PreferredAuthentications ,
1.123 markus 201: the client will try to authenticate first using the hostbased method;
1.176 jmc 202: if this method fails, public key authentication is attempted,
203: and finally if this method fails, keyboard-interactive and
1.123 markus 204: password authentication are tried.
1.49 markus 205: .Pp
206: The public key method is similar to RSA authentication described
1.107 markus 207: in the previous section and allows the RSA or DSA algorithm to be used:
1.102 itojun 208: The client uses his private key,
1.207 djm 209: .Pa ~/.ssh/id_dsa
1.102 itojun 210: or
1.207 djm 211: .Pa ~/.ssh/id_rsa ,
1.49 markus 212: to sign the session identifier and sends the result to the server.
213: The server checks whether the matching public key is listed in
1.207 djm 214: .Pa ~/.ssh/authorized_keys
1.49 markus 215: and grants access if both the key is found and the signature is correct.
216: The session identifier is derived from a shared Diffie-Hellman value
217: and is only known to the client and the server.
218: .Pp
1.176 jmc 219: If public key authentication fails or is not available, a password
220: can be sent encrypted to the remote host to prove the user's identity.
1.107 markus 221: .Pp
222: Additionally,
223: .Nm
224: supports hostbased or challenge response authentication.
1.49 markus 225: .Pp
226: Protocol 2 provides additional mechanisms for confidentiality
1.189 dtucker 227: (the traffic is encrypted using AES, 3DES, Blowfish, CAST128 or Arcfour)
228: and integrity (hmac-md5, hmac-sha1, hmac-ripemd160).
1.49 markus 229: Note that protocol 1 lacks a strong mechanism for ensuring the
230: integrity of the connection.
231: .Ss Login session and remote execution
1.1 deraadt 232: When the user's identity has been accepted by the server, the server
233: either executes the given command, or logs into the machine and gives
1.40 aaron 234: the user a normal shell on the remote machine.
235: All communication with
1.1 deraadt 236: the remote command or shell will be automatically encrypted.
1.2 deraadt 237: .Pp
1.1 deraadt 238: If a pseudo-terminal has been allocated (normal login session), the
1.104 djm 239: user may use the escape characters noted below.
1.2 deraadt 240: .Pp
1.176 jmc 241: If no pseudo-tty has been allocated,
242: the session is transparent and can be used to reliably transfer binary data.
1.40 aaron 243: On most systems, setting the escape character to
1.2 deraadt 244: .Dq none
245: will also make the session transparent even if a tty is used.
246: .Pp
1.71 djm 247: The session terminates when the command or shell on the remote
1.92 markus 248: machine exits and all X11 and TCP/IP connections have been closed.
1.176 jmc 249: The exit status of the remote program is returned as the exit status of
1.2 deraadt 250: .Nm ssh .
1.104 djm 251: .Ss Escape Characters
1.176 jmc 252: When a pseudo-terminal has been requested,
253: .Nm
254: supports a number of functions through the use of an escape character.
1.104 djm 255: .Pp
256: A single tilde character can be sent as
257: .Ic ~~
1.119 stevesk 258: or by following the tilde by a character other than those described below.
1.104 djm 259: The escape character must always follow a newline to be interpreted as
260: special.
261: The escape character can be changed in configuration files using the
262: .Cm EscapeChar
1.117 itojun 263: configuration directive or on the command line by the
1.104 djm 264: .Fl e
265: option.
266: .Pp
267: The supported escapes (assuming the default
268: .Ql ~ )
269: are:
270: .Bl -tag -width Ds
271: .It Cm ~.
1.176 jmc 272: Disconnect.
1.104 djm 273: .It Cm ~^Z
1.176 jmc 274: Background
275: .Nm ssh .
1.104 djm 276: .It Cm ~#
1.176 jmc 277: List forwarded connections.
1.104 djm 278: .It Cm ~&
1.176 jmc 279: Background
280: .Nm
281: at logout when waiting for forwarded connection / X11 sessions to terminate.
1.104 djm 282: .It Cm ~?
1.176 jmc 283: Display a list of escape characters.
1.170 markus 284: .It Cm ~B
1.176 jmc 285: Send a BREAK to the remote system
286: (only useful for SSH protocol version 2 and if the peer supports it).
1.149 jakob 287: .It Cm ~C
1.186 djm 288: Open command line.
289: Currently this allows the addition of port forwardings using the
1.149 jakob 290: .Fl L
291: and
292: .Fl R
1.186 djm 293: options (see below).
1.188 jmc 294: It also allows the cancellation of existing remote port-forwardings
1.186 djm 295: using
296: .Fl KR Ar hostport .
1.187 djm 297: Basic help is available, using the
298: .Fl h
1.186 djm 299: option.
1.104 djm 300: .It Cm ~R
1.176 jmc 301: Request rekeying of the connection
302: (only useful for SSH protocol version 2 and if the peer supports it).
1.104 djm 303: .El
1.49 markus 304: .Ss X11 and TCP forwarding
1.110 deraadt 305: If the
306: .Cm ForwardX11
307: variable is set to
308: .Dq yes
1.176 jmc 309: (or see the description of the
1.110 deraadt 310: .Fl X
311: and
312: .Fl x
313: options described later)
314: and the user is using X11 (the
1.2 deraadt 315: .Ev DISPLAY
1.1 deraadt 316: environment variable is set), the connection to the X11 display is
317: automatically forwarded to the remote side in such a way that any X11
318: programs started from the shell (or command) will go through the
319: encrypted channel, and the connection to the real X server will be made
1.40 aaron 320: from the local machine.
321: The user should not manually set
1.2 deraadt 322: .Ev DISPLAY .
1.1 deraadt 323: Forwarding of X11 connections can be
324: configured on the command line or in configuration files.
1.2 deraadt 325: .Pp
326: The
1.44 aaron 327: .Ev DISPLAY
1.2 deraadt 328: value set by
329: .Nm
1.176 jmc 330: will point to the server machine, but with a display number greater than zero.
1.40 aaron 331: This is normal, and happens because
1.2 deraadt 332: .Nm
333: creates a
334: .Dq proxy
335: X server on the server machine for forwarding the
1.1 deraadt 336: connections over the encrypted channel.
1.2 deraadt 337: .Pp
338: .Nm
1.1 deraadt 339: will also automatically set up Xauthority data on the server machine.
340: For this purpose, it will generate a random authorization cookie,
341: store it in Xauthority on the server, and verify that any forwarded
342: connections carry this cookie and replace it by the real cookie when
1.40 aaron 343: the connection is opened.
344: The real authentication cookie is never
1.1 deraadt 345: sent to the server machine (and no cookies are sent in the plain).
1.2 deraadt 346: .Pp
1.163 stevesk 347: If the
348: .Cm ForwardAgent
349: variable is set to
350: .Dq yes
1.176 jmc 351: (or see the description of the
1.163 stevesk 352: .Fl A
353: and
354: .Fl a
1.168 jmc 355: options described later) and
1.163 stevesk 356: the user is using an authentication agent, the connection to the agent
357: is automatically forwarded to the remote side.
1.2 deraadt 358: .Pp
1.1 deraadt 359: Forwarding of arbitrary TCP/IP connections over the secure channel can
1.120 stevesk 360: be specified either on the command line or in a configuration file.
1.40 aaron 361: One possible application of TCP/IP forwarding is a secure connection to an
1.92 markus 362: electronic purse; another is going through firewalls.
1.49 markus 363: .Ss Server authentication
1.2 deraadt 364: .Nm
1.49 markus 365: automatically maintains and checks a database containing
1.40 aaron 366: identifications for all hosts it has ever been used with.
1.116 markus 367: Host keys are stored in
1.207 djm 368: .Pa ~/.ssh/known_hosts
1.40 aaron 369: in the user's home directory.
1.116 markus 370: Additionally, the file
1.147 deraadt 371: .Pa /etc/ssh/ssh_known_hosts
1.116 markus 372: is automatically checked for known hosts.
1.40 aaron 373: Any new hosts are automatically added to the user's file.
1.176 jmc 374: If a host's identification ever changes,
1.2 deraadt 375: .Nm
1.1 deraadt 376: warns about this and disables password authentication to prevent a
1.40 aaron 377: trojan horse from getting the user's password.
1.176 jmc 378: Another purpose of this mechanism is to prevent man-in-the-middle attacks
379: which could otherwise be used to circumvent the encryption.
1.40 aaron 380: The
1.2 deraadt 381: .Cm StrictHostKeyChecking
1.158 stevesk 382: option can be used to prevent logins to machines whose
1.1 deraadt 383: host key is not known or has changed.
1.194 jakob 384: .Pp
385: .Nm
386: can be configured to verify host identification using fingerprint resource
387: records (SSHFP) published in DNS.
388: The
389: .Cm VerifyHostKeyDNS
390: option can be used to control how DNS lookups are performed.
391: SSHFP resource records can be generated using
392: .Xr ssh-keygen 1 .
1.65 aaron 393: .Pp
394: The options are as follows:
1.2 deraadt 395: .Bl -tag -width Ds
1.176 jmc 396: .It Fl 1
397: Forces
398: .Nm
399: to try protocol version 1 only.
400: .It Fl 2
401: Forces
402: .Nm
403: to try protocol version 2 only.
404: .It Fl 4
405: Forces
406: .Nm
407: to use IPv4 addresses only.
408: .It Fl 6
409: Forces
410: .Nm
411: to use IPv6 addresses only.
1.54 markus 412: .It Fl A
413: Enables forwarding of the authentication agent connection.
414: This can also be specified on a per-host basis in a configuration file.
1.165 stevesk 415: .Pp
1.168 jmc 416: Agent forwarding should be enabled with caution.
417: Users with the ability to bypass file permissions on the remote host
418: (for the agent's Unix-domain socket)
419: can access the local agent through the forwarded connection.
420: An attacker cannot obtain key material from the agent,
1.165 stevesk 421: however they can perform operations on the keys that enable them to
422: authenticate using the identities loaded into the agent.
1.176 jmc 423: .It Fl a
424: Disables forwarding of the authentication agent connection.
1.108 markus 425: .It Fl b Ar bind_address
1.206 jmc 426: Specify the interface address to transmit from on machines with multiple
1.108 markus 427: interfaces or aliased addresses.
1.176 jmc 428: .It Fl C
429: Requests compression of all data (including stdin, stdout, stderr, and
430: data for forwarded X11 and TCP/IP connections).
431: The compression algorithm is the same used by
432: .Xr gzip 1 ,
433: and the
434: .Dq level
435: can be controlled by the
436: .Cm CompressionLevel
437: option for protocol version 1.
438: Compression is desirable on modem lines and other
439: slow connections, but will only slow down things on fast networks.
440: The default value can be set on a host-by-host basis in the
441: configuration files; see the
442: .Cm Compression
443: option.
1.189 dtucker 444: .It Fl c Ar cipher_spec
445: Selects the cipher specification for encrypting the session.
446: .Pp
447: Protocol version 1 allows specification of a single cipher.
448: The suported values are
449: .Dq 3des ,
450: .Dq blowfish
451: and
452: .Dq des .
1.2 deraadt 453: .Ar 3des
1.189 dtucker 454: (triple-des) is an encrypt-decrypt-encrypt triple with three different keys.
1.44 aaron 455: It is believed to be secure.
1.5 deraadt 456: .Ar blowfish
1.176 jmc 457: is a fast block cipher; it appears very secure and is much faster than
1.40 aaron 458: .Ar 3des .
1.131 stevesk 459: .Ar des
460: is only supported in the
461: .Nm
462: client for interoperability with legacy protocol 1 implementations
463: that do not support the
464: .Ar 3des
1.168 jmc 465: cipher.
466: Its use is strongly discouraged due to cryptographic weaknesses.
1.189 dtucker 467: The default is
468: .Dq 3des .
469: .Pp
470: For protocol version 2
471: .Ar cipher_spec
472: is a comma-separated list of ciphers
473: listed in order of preference.
474: The supported ciphers are
475: .Dq 3des-cbc ,
476: .Dq aes128-cbc ,
477: .Dq aes192-cbc ,
478: .Dq aes256-cbc ,
479: .Dq aes128-ctr ,
480: .Dq aes192-ctr ,
481: .Dq aes256-ctr ,
1.208 ! djm 482: .Dq arcfour128 ,
! 483: .Dq arcfour256 ,
1.189 dtucker 484: .Dq arcfour ,
485: .Dq blowfish-cbc ,
486: and
487: .Dq cast128-cbc .
488: The default is
489: .Bd -literal
1.208 ! djm 490: ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
! 491: arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
! 492: aes192-ctr,aes256-ctr''
1.189 dtucker 493: .Ed
1.176 jmc 494: .It Fl D Ar port
495: Specifies a local
496: .Dq dynamic
497: application-level port forwarding.
498: This works by allocating a socket to listen to
499: .Ar port
500: on the local side, and whenever a connection is made to this port, the
501: connection is forwarded over the secure channel, and the application
502: protocol is then used to determine where to connect to from the
503: remote machine.
504: Currently the SOCKS4 and SOCKS5 protocols are supported, and
505: .Nm
506: will act as a SOCKS server.
507: Only root can forward privileged ports.
508: Dynamic port forwardings can also be specified in the configuration file.
509: .It Fl e Ar ch | ^ch | none
1.2 deraadt 510: Sets the escape character for sessions with a pty (default:
511: .Ql ~ ) .
1.40 aaron 512: The escape character is only recognized at the beginning of a line.
513: The escape character followed by a dot
1.2 deraadt 514: .Pq Ql \&.
1.176 jmc 515: closes the connection;
516: followed by control-Z suspends the connection;
517: and followed by itself sends the escape character once.
1.40 aaron 518: Setting the character to
1.2 deraadt 519: .Dq none
520: disables any escapes and makes the session fully transparent.
1.176 jmc 521: .It Fl F Ar configfile
522: Specifies an alternative per-user configuration file.
523: If a configuration file is given on the command line,
524: the system-wide configuration file
525: .Pq Pa /etc/ssh/ssh_config
526: will be ignored.
527: The default for the per-user configuration file is
1.207 djm 528: .Pa ~/.ssh/config .
1.2 deraadt 529: .It Fl f
530: Requests
531: .Nm
1.40 aaron 532: to go to background just before command execution.
533: This is useful if
1.2 deraadt 534: .Nm
535: is going to ask for passwords or passphrases, but the user
1.40 aaron 536: wants it in the background.
1.44 aaron 537: This implies
1.2 deraadt 538: .Fl n .
1.1 deraadt 539: The recommended way to start X11 programs at a remote site is with
1.2 deraadt 540: something like
541: .Ic ssh -f host xterm .
1.34 markus 542: .It Fl g
543: Allows remote hosts to connect to local forwarded ports.
1.176 jmc 544: .It Fl I Ar smartcard_device
545: Specifies which smartcard device to use.
546: The argument is the device
547: .Nm
548: should use to communicate with a smartcard used for storing the user's
549: private RSA key.
1.2 deraadt 550: .It Fl i Ar identity_file
1.144 stevesk 551: Selects a file from which the identity (private key) for
1.68 markus 552: RSA or DSA authentication is read.
1.144 stevesk 553: The default is
1.207 djm 554: .Pa ~/.ssh/identity
1.144 stevesk 555: for protocol version 1, and
1.207 djm 556: .Pa ~/.ssh/id_rsa
1.144 stevesk 557: and
1.207 djm 558: .Pa ~/.ssh/id_dsa
1.144 stevesk 559: for protocol version 2.
1.40 aaron 560: Identity files may also be specified on
561: a per-host basis in the configuration file.
562: It is possible to have multiple
1.2 deraadt 563: .Fl i
564: options (and multiple identities specified in
1.1 deraadt 565: configuration files).
1.2 deraadt 566: .It Fl k
1.179 dtucker 567: Disables forwarding (delegation) of GSSAPI credentials to the server.
1.176 jmc 568: .It Fl L Xo
569: .Sm off
1.200 djm 570: .Oo Ar bind_address : Oc
1.176 jmc 571: .Ar port : host : hostport
572: .Sm on
573: .Xc
574: Specifies that the given port on the local (client) host is to be
575: forwarded to the given host and port on the remote side.
576: This works by allocating a socket to listen to
577: .Ar port
1.200 djm 578: on the local side, optionally bound to the specified
579: .Ar bind_address .
580: Whenever a connection is made to this port, the
1.176 jmc 581: connection is forwarded over the secure channel, and a connection is
582: made to
583: .Ar host
584: port
585: .Ar hostport
586: from the remote machine.
587: Port forwardings can also be specified in the configuration file.
588: IPv6 addresses can be specified with an alternative syntax:
589: .Sm off
590: .Xo
1.205 jmc 591: .Op Ar bind_address No /
1.176 jmc 592: .Ar port No / Ar host No /
1.200 djm 593: .Ar hostport
1.176 jmc 594: .Xc
595: .Sm on
1.200 djm 596: or by enclosing the address in square brackets.
597: Only the superuser can forward privileged ports.
598: By default, the local port is bound in accordance with the
599: .Cm GatewayPorts
600: setting.
601: However, an explicit
602: .Ar bind_address
603: may be used to bind the connection to a specific address.
604: The
605: .Ar bind_address
606: of
607: .Dq localhost
1.202 jmc 608: indicates that the listening port be bound for local use only, while an
609: empty address or
610: .Sq *
1.200 djm 611: indicates that the port should be available from all interfaces.
1.2 deraadt 612: .It Fl l Ar login_name
1.40 aaron 613: Specifies the user to log in as on the remote machine.
614: This also may be specified on a per-host basis in the configuration file.
1.190 djm 615: .It Fl M
616: Places the
617: .Nm
618: client into
619: .Dq master
620: mode for connection sharing.
621: Refer to the description of
622: .Cm ControlMaster
623: in
624: .Xr ssh_config 5
625: for details.
1.193 jmc 626: .It Fl m Ar mac_spec
627: Additionally, for protocol version 2 a comma-separated list of MAC
628: (message authentication code) algorithms can
629: be specified in order of preference.
630: See the
631: .Cm MACs
632: keyword for more information.
1.176 jmc 633: .It Fl N
634: Do not execute a remote command.
635: This is useful for just forwarding ports
636: (protocol version 2 only).
1.2 deraadt 637: .It Fl n
638: Redirects stdin from
639: .Pa /dev/null
640: (actually, prevents reading from stdin).
1.1 deraadt 641: This must be used when
1.2 deraadt 642: .Nm
1.40 aaron 643: is run in the background.
644: A common trick is to use this to run X11 programs on a remote machine.
645: For example,
1.2 deraadt 646: .Ic ssh -n shadows.cs.hut.fi emacs &
647: will start an emacs on shadows.cs.hut.fi, and the X11
1.1 deraadt 648: connection will be automatically forwarded over an encrypted channel.
649: The
1.2 deraadt 650: .Nm
1.1 deraadt 651: program will be put in the background.
652: (This does not work if
1.2 deraadt 653: .Nm
654: needs to ask for a password or passphrase; see also the
655: .Fl f
656: option.)
1.199 jmc 657: .It Fl O Ar ctl_cmd
658: Control an active connection multiplexing master process.
659: When the
660: .Fl O
661: option is specified, the
662: .Ar ctl_cmd
663: argument is interpreted and passed to the master process.
664: Valid commands are:
665: .Dq check
666: (check that the master process is running) and
667: .Dq exit
668: (request the master to exit).
1.2 deraadt 669: .It Fl o Ar option
1.127 stevesk 670: Can be used to give options in the format used in the configuration file.
1.1 deraadt 671: This is useful for specifying options for which there is no separate
1.40 aaron 672: command-line flag.
1.176 jmc 673: For full details of the options listed below, and their possible values, see
674: .Xr ssh_config 5 .
675: .Pp
676: .Bl -tag -width Ds -offset indent -compact
677: .It AddressFamily
678: .It BatchMode
679: .It BindAddress
680: .It ChallengeResponseAuthentication
681: .It CheckHostIP
682: .It Cipher
683: .It Ciphers
684: .It ClearAllForwardings
685: .It Compression
686: .It CompressionLevel
687: .It ConnectionAttempts
1.185 dtucker 688: .It ConnectTimeout
1.190 djm 689: .It ControlMaster
690: .It ControlPath
1.176 jmc 691: .It DynamicForward
692: .It EscapeChar
693: .It ForwardAgent
694: .It ForwardX11
1.178 markus 695: .It ForwardX11Trusted
1.176 jmc 696: .It GatewayPorts
697: .It GlobalKnownHostsFile
698: .It GSSAPIAuthentication
699: .It GSSAPIDelegateCredentials
1.201 djm 700: .It HashKnownHosts
1.176 jmc 701: .It Host
702: .It HostbasedAuthentication
703: .It HostKeyAlgorithms
704: .It HostKeyAlias
705: .It HostName
706: .It IdentityFile
1.182 markus 707: .It IdentitiesOnly
1.197 djm 708: .It KbdInteractiveDevices
1.176 jmc 709: .It LocalForward
710: .It LogLevel
711: .It MACs
712: .It NoHostAuthenticationForLocalhost
713: .It NumberOfPasswordPrompts
714: .It PasswordAuthentication
715: .It Port
716: .It PreferredAuthentications
717: .It Protocol
718: .It ProxyCommand
719: .It PubkeyAuthentication
720: .It RemoteForward
721: .It RhostsRSAAuthentication
722: .It RSAAuthentication
1.184 jmc 723: .It SendEnv
1.181 markus 724: .It ServerAliveInterval
725: .It ServerAliveCountMax
1.176 jmc 726: .It SmartcardDevice
727: .It StrictHostKeyChecking
1.180 markus 728: .It TCPKeepAlive
1.176 jmc 729: .It UsePrivilegedPort
730: .It User
731: .It UserKnownHostsFile
732: .It VerifyHostKeyDNS
733: .It XAuthLocation
734: .El
1.2 deraadt 735: .It Fl p Ar port
1.40 aaron 736: Port to connect to on the remote host.
737: This can be specified on a
1.1 deraadt 738: per-host basis in the configuration file.
1.2 deraadt 739: .It Fl q
1.40 aaron 740: Quiet mode.
741: Causes all warning and diagnostic messages to be suppressed.
1.176 jmc 742: .It Fl R Xo
743: .Sm off
1.200 djm 744: .Oo Ar bind_address : Oc
1.176 jmc 745: .Ar port : host : hostport
746: .Sm on
747: .Xc
748: Specifies that the given port on the remote (server) host is to be
749: forwarded to the given host and port on the local side.
750: This works by allocating a socket to listen to
751: .Ar port
752: on the remote side, and whenever a connection is made to this port, the
753: connection is forwarded over the secure channel, and a connection is
754: made to
755: .Ar host
756: port
757: .Ar hostport
758: from the local machine.
1.200 djm 759: .Pp
1.176 jmc 760: Port forwardings can also be specified in the configuration file.
761: Privileged ports can be forwarded only when
762: logging in as root on the remote machine.
1.200 djm 763: IPv6 addresses can be specified by enclosing the address in square braces or
764: using an alternative syntax:
1.202 jmc 765: .Sm off
1.200 djm 766: .Xo
1.205 jmc 767: .Op Ar bind_address No /
1.202 jmc 768: .Ar host No / Ar port No /
769: .Ar hostport
770: .Xc .
1.176 jmc 771: .Sm on
1.200 djm 772: .Pp
773: By default, the listening socket on the server will be bound to the loopback
774: interface only.
775: This may be overriden by specifying a
776: .Ar bind_address .
1.202 jmc 777: An empty
778: .Ar bind_address ,
1.200 djm 779: or the address
1.202 jmc 780: .Ql * ,
1.200 djm 781: indicates that the remote socket should listen on all interfaces.
782: Specifying a remote
783: .Ar bind_address
1.202 jmc 784: will only succeed if the server's
785: .Cm GatewayPorts
1.200 djm 786: option is enabled (see
1.202 jmc 787: .Xr sshd_config 5 ) .
1.198 djm 788: .It Fl S Ar ctl_path
1.193 jmc 789: Specifies the location of a control socket for connection sharing.
1.190 djm 790: Refer to the description of
1.191 djm 791: .Cm ControlPath
792: and
1.190 djm 793: .Cm ControlMaster
794: in
795: .Xr ssh_config 5
796: for details.
1.80 djm 797: .It Fl s
1.172 jmc 798: May be used to request invocation of a subsystem on the remote system.
799: Subsystems are a feature of the SSH2 protocol which facilitate the use
1.176 jmc 800: of SSH as a secure transport for other applications (eg.\&
801: .Xr sftp 1 ) .
1.172 jmc 802: The subsystem is specified as the remote command.
1.176 jmc 803: .It Fl T
804: Disable pseudo-tty allocation.
1.2 deraadt 805: .It Fl t
1.40 aaron 806: Force pseudo-tty allocation.
1.43 brad 807: This can be used to execute arbitrary
1.40 aaron 808: screen-based programs on a remote machine, which can be very useful,
809: e.g., when implementing menu services.
1.73 markus 810: Multiple
811: .Fl t
812: options force tty allocation, even if
813: .Nm
814: has no local tty.
1.176 jmc 815: .It Fl V
816: Display the version number and exit.
1.2 deraadt 817: .It Fl v
1.40 aaron 818: Verbose mode.
819: Causes
1.2 deraadt 820: .Nm
1.40 aaron 821: to print debugging messages about its progress.
822: This is helpful in
1.1 deraadt 823: debugging connection, authentication, and configuration problems.
1.73 markus 824: Multiple
825: .Fl v
1.169 naddy 826: options increase the verbosity.
827: The maximum is 3.
1.2 deraadt 828: .It Fl X
1.1 deraadt 829: Enables X11 forwarding.
1.54 markus 830: This can also be specified on a per-host basis in a configuration file.
1.165 stevesk 831: .Pp
1.168 jmc 832: X11 forwarding should be enabled with caution.
833: Users with the ability to bypass file permissions on the remote host
834: (for the user's X authorization database)
835: can access the local X11 display through the forwarded connection.
836: An attacker may then be able to perform activities such as keystroke monitoring.
1.203 djm 837: .Pp
1.204 jmc 838: For this reason, X11 forwarding is subjected to X11 SECURITY extension
1.203 djm 839: restrictions by default.
840: Please refer to the
841: .Nm
842: .Fl Y
843: option and the
844: .Cm ForwardX11Trusted
845: directive in
846: .Xr ssh_config 5
847: for more information.
1.176 jmc 848: .It Fl x
849: Disables X11 forwarding.
1.178 markus 850: .It Fl Y
851: Enables trusted X11 forwarding.
1.203 djm 852: Trusted X11 forwardings are not subjected to the X11 SECURITY extension
853: controls.
1.2 deraadt 854: .El
855: .Sh CONFIGURATION FILES
856: .Nm
1.158 stevesk 857: may additionally obtain configuration data from
858: a per-user configuration file and a system-wide configuration file.
859: The file format and configuration options are described in
860: .Xr ssh_config 5 .
1.2 deraadt 861: .Sh ENVIRONMENT
862: .Nm
1.1 deraadt 863: will normally set the following environment variables:
1.176 jmc 864: .Bl -tag -width LOGNAME
1.2 deraadt 865: .It Ev DISPLAY
866: The
867: .Ev DISPLAY
1.40 aaron 868: variable indicates the location of the X11 server.
1.44 aaron 869: It is automatically set by
1.2 deraadt 870: .Nm
871: to point to a value of the form
872: .Dq hostname:n
873: where hostname indicates
1.176 jmc 874: the host where the shell runs, and n is an integer \*(Ge 1.
1.40 aaron 875: .Nm
876: uses this special value to forward X11 connections over the secure
877: channel.
1.107 markus 878: The user should normally not set
879: .Ev DISPLAY
880: explicitly, as that
1.1 deraadt 881: will render the X11 connection insecure (and will require the user to
882: manually copy any required authorization cookies).
1.2 deraadt 883: .It Ev HOME
1.1 deraadt 884: Set to the path of the user's home directory.
1.2 deraadt 885: .It Ev LOGNAME
886: Synonym for
1.12 aaron 887: .Ev USER ;
888: set for compatibility with systems that use this variable.
1.2 deraadt 889: .It Ev MAIL
1.129 stevesk 890: Set to the path of the user's mailbox.
1.40 aaron 891: .It Ev PATH
1.2 deraadt 892: Set to the default
893: .Ev PATH ,
894: as specified when compiling
1.12 aaron 895: .Nm ssh .
1.118 markus 896: .It Ev SSH_ASKPASS
897: If
898: .Nm
899: needs a passphrase, it will read the passphrase from the current
900: terminal if it was run from a terminal.
901: If
902: .Nm
903: does not have a terminal associated with it but
904: .Ev DISPLAY
905: and
906: .Ev SSH_ASKPASS
907: are set, it will execute the program specified by
908: .Ev SSH_ASKPASS
909: and open an X11 window to read the passphrase.
910: This is particularly useful when calling
911: .Nm
912: from a
1.196 jmc 913: .Pa .xsession
1.118 markus 914: or related script.
915: (Note that on some machines it
916: may be necessary to redirect the input from
917: .Pa /dev/null
918: to make this work.)
1.18 markus 919: .It Ev SSH_AUTH_SOCK
1.129 stevesk 920: Identifies the path of a unix-domain socket used to communicate with the
1.17 markus 921: agent.
1.166 stevesk 922: .It Ev SSH_CONNECTION
923: Identifies the client and server ends of the connection.
1.40 aaron 924: The variable contains
1.166 stevesk 925: four space-separated values: client ip-address, client port number,
926: server ip-address and server port number.
1.73 markus 927: .It Ev SSH_ORIGINAL_COMMAND
928: The variable contains the original command line if a forced command
929: is executed.
930: It can be used to extract the original arguments.
1.2 deraadt 931: .It Ev SSH_TTY
1.1 deraadt 932: This is set to the name of the tty (path to the device) associated
1.40 aaron 933: with the current shell or command.
934: If the current session has no tty,
1.1 deraadt 935: this variable is not set.
1.2 deraadt 936: .It Ev TZ
1.1 deraadt 937: The timezone variable is set to indicate the present timezone if it
1.56 deraadt 938: was set when the daemon was started (i.e., the daemon passes the value
1.1 deraadt 939: on to new connections).
1.2 deraadt 940: .It Ev USER
1.1 deraadt 941: Set to the name of the user logging in.
1.2 deraadt 942: .El
943: .Pp
1.44 aaron 944: Additionally,
1.2 deraadt 945: .Nm
1.44 aaron 946: reads
1.207 djm 947: .Pa ~/.ssh/environment ,
1.2 deraadt 948: and adds lines of the format
949: .Dq VARNAME=value
1.161 marc 950: to the environment if the file exists and if users are allowed to
951: change their environment.
1.176 jmc 952: For more information, see the
1.161 marc 953: .Cm PermitUserEnvironment
1.162 stevesk 954: option in
1.161 marc 955: .Xr sshd_config 5 .
1.2 deraadt 956: .Sh FILES
1.36 markus 957: .Bl -tag -width Ds
1.207 djm 958: .It Pa ~/.ssh/known_hosts
1.129 stevesk 959: Records host keys for all hosts the user has logged into that are not
1.2 deraadt 960: in
1.147 deraadt 961: .Pa /etc/ssh/ssh_known_hosts .
1.2 deraadt 962: See
963: .Xr sshd 8 .
1.207 djm 964: .It Pa ~/.ssh/identity, ~/.ssh/id_dsa, ~/.ssh/id_rsa
1.102 itojun 965: Contains the authentication identity of the user.
966: They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively.
1.48 markus 967: These files
968: contain sensitive data and should be readable by the user but not
1.15 markus 969: accessible by others (read/write/execute).
970: Note that
971: .Nm
1.48 markus 972: ignores a private key file if it is accessible by others.
1.15 markus 973: It is possible to specify a passphrase when
1.1 deraadt 974: generating the key; the passphrase will be used to encrypt the
1.8 deraadt 975: sensitive part of this file using 3DES.
1.207 djm 976: .It Pa ~/.ssh/identity.pub, ~/.ssh/id_dsa.pub, ~/.ssh/id_rsa.pub
1.1 deraadt 977: Contains the public key for authentication (public part of the
1.40 aaron 978: identity file in human-readable form).
1.48 markus 979: The contents of the
1.207 djm 980: .Pa ~/.ssh/identity.pub
1.176 jmc 981: file should be added to the file
1.207 djm 982: .Pa ~/.ssh/authorized_keys
1.2 deraadt 983: on all machines
1.137 deraadt 984: where the user wishes to log in using protocol version 1 RSA authentication.
1.48 markus 985: The contents of the
1.207 djm 986: .Pa ~/.ssh/id_dsa.pub
1.102 itojun 987: and
1.207 djm 988: .Pa ~/.ssh/id_rsa.pub
1.48 markus 989: file should be added to
1.207 djm 990: .Pa ~/.ssh/authorized_keys
1.48 markus 991: on all machines
1.137 deraadt 992: where the user wishes to log in using protocol version 2 DSA/RSA authentication.
1.48 markus 993: These files are not
1.40 aaron 994: sensitive and can (but need not) be readable by anyone.
1.48 markus 995: These files are
1.84 markus 996: never used automatically and are not necessary; they are only provided for
1.1 deraadt 997: the convenience of the user.
1.207 djm 998: .It Pa ~/.ssh/config
1.40 aaron 999: This is the per-user configuration file.
1.158 stevesk 1000: The file format and configuration options are described in
1001: .Xr ssh_config 5 .
1.183 djm 1002: Because of the potential for abuse, this file must have strict permissions:
1003: read/write for the user, and not accessible by others.
1.207 djm 1004: .It Pa ~/.ssh/authorized_keys
1.115 markus 1005: Lists the public keys (RSA/DSA) that can be used for logging in as this user.
1.40 aaron 1006: The format of this file is described in the
1.2 deraadt 1007: .Xr sshd 8
1.40 aaron 1008: manual page.
1.176 jmc 1009: In the simplest form the format is the same as the
1010: .Pa .pub
1.116 markus 1011: identity files.
1.48 markus 1012: This file is not highly sensitive, but the recommended
1013: permissions are read/write for the user, and not accessible by others.
1.147 deraadt 1014: .It Pa /etc/ssh/ssh_known_hosts
1.40 aaron 1015: Systemwide list of known host keys.
1.116 markus 1016: This file should be prepared by the
1.1 deraadt 1017: system administrator to contain the public host keys of all machines in the
1.40 aaron 1018: organization.
1019: This file should be world-readable.
1020: This file contains
1.1 deraadt 1021: public keys, one per line, in the following format (fields separated
1.116 markus 1022: by spaces): system name, public key and optional comment field.
1.40 aaron 1023: When different names are used
1.1 deraadt 1024: for the same machine, all such names should be listed, separated by
1.40 aaron 1025: commas.
1.176 jmc 1026: The format is described in the
1.2 deraadt 1027: .Xr sshd 8
1.1 deraadt 1028: manual page.
1.2 deraadt 1029: .Pp
1.1 deraadt 1030: The canonical system name (as returned by name servers) is used by
1.2 deraadt 1031: .Xr sshd 8
1.1 deraadt 1032: to verify the client host when logging in; other names are needed because
1.2 deraadt 1033: .Nm
1.1 deraadt 1034: does not convert the user-supplied name to a canonical name before
1035: checking the key, because someone with access to the name servers
1036: would then be able to fool host authentication.
1.147 deraadt 1037: .It Pa /etc/ssh/ssh_config
1.40 aaron 1038: Systemwide configuration file.
1.158 stevesk 1039: The file format and configuration options are described in
1040: .Xr ssh_config 5 .
1.147 deraadt 1041: .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
1.141 markus 1042: These three files contain the private parts of the host keys
1043: and are used for
1044: .Cm RhostsRSAAuthentication
1045: and
1046: .Cm HostbasedAuthentication .
1.155 stevesk 1047: If the protocol version 1
1048: .Cm RhostsRSAAuthentication
1.157 deraadt 1049: method is used,
1.155 stevesk 1050: .Nm
1051: must be setuid root, since the host key is readable only by root.
1052: For protocol version 2,
1053: .Nm
1054: uses
1055: .Xr ssh-keysign 8
1056: to access the host keys for
1057: .Cm HostbasedAuthentication .
1058: This eliminates the requirement that
1059: .Nm
1060: be setuid root when that authentication method is used.
1061: By default
1.141 markus 1062: .Nm
1.155 stevesk 1063: is not setuid root.
1.207 djm 1064: .It Pa ~/.rhosts
1.2 deraadt 1065: This file is used in
1.195 markus 1066: .Cm RhostsRSAAuthentication
1067: and
1068: .Cm HostbasedAuthentication
1.2 deraadt 1069: authentication to list the
1.40 aaron 1070: host/user pairs that are permitted to log in.
1071: (Note that this file is
1.1 deraadt 1072: also used by rlogin and rsh, which makes using this file insecure.)
1073: Each line of the file contains a host name (in the canonical form
1074: returned by name servers), and then a user name on that host,
1.40 aaron 1075: separated by a space.
1.92 markus 1076: On some machines this file may need to be
1.1 deraadt 1077: world-readable if the user's home directory is on a NFS partition,
1078: because
1.2 deraadt 1079: .Xr sshd 8
1.40 aaron 1080: reads it as root.
1081: Additionally, this file must be owned by the user,
1082: and must not have write permissions for anyone else.
1083: The recommended
1.1 deraadt 1084: permission for most machines is read/write for the user, and not
1085: accessible by others.
1.2 deraadt 1086: .Pp
1.195 markus 1087: Note that
1.2 deraadt 1088: .Xr sshd 8
1.195 markus 1089: allows authentication only in combination with client host key
1090: authentication before permitting log in.
1.137 deraadt 1091: If the server machine does not have the client's host key in
1.147 deraadt 1092: .Pa /etc/ssh/ssh_known_hosts ,
1.137 deraadt 1093: it can be stored in
1.207 djm 1094: .Pa ~/.ssh/known_hosts .
1.2 deraadt 1095: The easiest way to do this is to
1.1 deraadt 1096: connect back to the client from the server machine using ssh; this
1.48 markus 1097: will automatically add the host key to
1.207 djm 1098: .Pa ~/.ssh/known_hosts .
1099: .It Pa ~/.shosts
1.2 deraadt 1100: This file is used exactly the same way as
1.176 jmc 1101: .Pa .rhosts .
1.2 deraadt 1102: The purpose for
1.195 markus 1103: having this file is to be able to use
1104: .Cm RhostsRSAAuthentication
1105: and
1106: .Cm HostbasedAuthentication
1107: authentication without permitting login with
1.176 jmc 1108: .Xr rlogin
1.2 deraadt 1109: or
1110: .Xr rsh 1 .
1111: .It Pa /etc/hosts.equiv
1112: This file is used during
1.195 markus 1113: .Cm RhostsRSAAuthentication
1114: and
1115: .Cm HostbasedAuthentication
1.173 jmc 1116: authentication.
1.40 aaron 1117: It contains
1.176 jmc 1118: canonical hosts names, one per line (the full format is described in the
1.2 deraadt 1119: .Xr sshd 8
1.40 aaron 1120: manual page).
1121: If the client host is found in this file, login is
1.1 deraadt 1122: automatically permitted provided client and server user names are the
1.40 aaron 1123: same.
1.195 markus 1124: Additionally, successful client host key authentication is required.
1.40 aaron 1125: This file should only be writable by root.
1.2 deraadt 1126: .It Pa /etc/shosts.equiv
1.44 aaron 1127: This file is processed exactly as
1.2 deraadt 1128: .Pa /etc/hosts.equiv .
1.1 deraadt 1129: This file may be useful to permit logins using
1.2 deraadt 1130: .Nm
1.1 deraadt 1131: but not using rsh/rlogin.
1.147 deraadt 1132: .It Pa /etc/ssh/sshrc
1.1 deraadt 1133: Commands in this file are executed by
1.2 deraadt 1134: .Nm
1.1 deraadt 1135: when the user logs in just before the user's shell (or command) is started.
1136: See the
1.2 deraadt 1137: .Xr sshd 8
1.1 deraadt 1138: manual page for more information.
1.207 djm 1139: .It Pa ~/.ssh/rc
1.1 deraadt 1140: Commands in this file are executed by
1.2 deraadt 1141: .Nm
1.1 deraadt 1142: when the user logs in just before the user's shell (or command) is
1143: started.
1.44 aaron 1144: See the
1.2 deraadt 1145: .Xr sshd 8
1.1 deraadt 1146: manual page for more information.
1.207 djm 1147: .It Pa ~/.ssh/environment
1.31 markus 1148: Contains additional definitions for environment variables, see section
1149: .Sx ENVIRONMENT
1150: above.
1.58 itojun 1151: .El
1.145 markus 1152: .Sh DIAGNOSTICS
1153: .Nm
1154: exits with the exit status of the remote command or with 255
1155: if an error occurred.
1.2 deraadt 1156: .Sh SEE ALSO
1.176 jmc 1157: .Xr gzip 1 ,
1.2 deraadt 1158: .Xr rsh 1 ,
1159: .Xr scp 1 ,
1.83 djm 1160: .Xr sftp 1 ,
1.2 deraadt 1161: .Xr ssh-add 1 ,
1162: .Xr ssh-agent 1 ,
1163: .Xr ssh-keygen 1 ,
1164: .Xr telnet 1 ,
1.176 jmc 1165: .Xr hosts.equiv 5 ,
1.159 stevesk 1166: .Xr ssh_config 5 ,
1.160 naddy 1167: .Xr ssh-keysign 8 ,
1.87 itojun 1168: .Xr sshd 8
1.106 markus 1169: .Rs
1170: .%A T. Ylonen
1171: .%A T. Kivinen
1172: .%A M. Saarinen
1173: .%A T. Rinne
1174: .%A S. Lehtinen
1175: .%T "SSH Protocol Architecture"
1.150 markus 1176: .%N draft-ietf-secsh-architecture-12.txt
1177: .%D January 2002
1.106 markus 1178: .%O work in progress material
1179: .Re
1.173 jmc 1180: .Sh AUTHORS
1181: OpenSSH is a derivative of the original and free
1182: ssh 1.2.12 release by Tatu Ylonen.
1183: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1184: Theo de Raadt and Dug Song
1185: removed many bugs, re-added newer features and
1186: created OpenSSH.
1187: Markus Friedl contributed the support for SSH
1188: protocol versions 1.5 and 2.0.
![[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