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