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