]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - crypto/openssh/ssh.1
This commit was generated by cvs2svn to compensate for changes in r126854,
[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 .\" $OpenBSD: ssh.1,v 1.181 2003/12/16 15:49:51 markus Exp $
38 .\" $FreeBSD$
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 LocalForward
640 .It LogLevel
641 .It MACs
642 .It NoHostAuthenticationForLocalhost
643 .It NumberOfPasswordPrompts
644 .It PasswordAuthentication
645 .It Port
646 .It PreferredAuthentications
647 .It Protocol
648 .It ProxyCommand
649 .It PubkeyAuthentication
650 .It RemoteForward
651 .It RhostsRSAAuthentication
652 .It RSAAuthentication
653 .It ServerAliveInterval
654 .It ServerAliveCountMax
655 .It SmartcardDevice
656 .It StrictHostKeyChecking
657 .It TCPKeepAlive
658 .It UsePrivilegedPort
659 .It User
660 .It UserKnownHostsFile
661 .It VerifyHostKeyDNS
662 .It XAuthLocation
663 .El
664 .It Fl p Ar port
665 Port to connect to on the remote host.
666 This can be specified on a
667 per-host basis in the configuration file.
668 .It Fl q
669 Quiet mode.
670 Causes all warning and diagnostic messages to be suppressed.
671 .It Fl R Xo
672 .Sm off
673 .Ar port : host : hostport
674 .Sm on
675 .Xc
676 Specifies that the given port on the remote (server) host is to be
677 forwarded to the given host and port on the local side.
678 This works by allocating a socket to listen to
679 .Ar port
680 on the remote side, and whenever a connection is made to this port, the
681 connection is forwarded over the secure channel, and a connection is
682 made to
683 .Ar host
684 port
685 .Ar hostport
686 from the local machine.
687 Port forwardings can also be specified in the configuration file.
688 Privileged ports can be forwarded only when
689 logging in as root on the remote machine.
690 IPv6 addresses can be specified with an alternative syntax:
691 .Sm off
692 .Xo
693 .Ar port No / Ar host No /
694 .Ar hostport .
695 .Xc
696 .Sm on
697 .It Fl s
698 May be used to request invocation of a subsystem on the remote system.
699 Subsystems are a feature of the SSH2 protocol which facilitate the use
700 of SSH as a secure transport for other applications (eg.\&
701 .Xr sftp 1 ) .
702 The subsystem is specified as the remote command.
703 .It Fl T
704 Disable pseudo-tty allocation.
705 .It Fl t
706 Force pseudo-tty allocation.
707 This can be used to execute arbitrary
708 screen-based programs on a remote machine, which can be very useful,
709 e.g., when implementing menu services.
710 Multiple
711 .Fl t
712 options force tty allocation, even if
713 .Nm
714 has no local tty.
715 .It Fl V
716 Display the version number and exit.
717 .It Fl v
718 Verbose mode.
719 Causes
720 .Nm
721 to print debugging messages about its progress.
722 This is helpful in
723 debugging connection, authentication, and configuration problems.
724 Multiple
725 .Fl v
726 options increase the verbosity.
727 The maximum is 3.
728 .It Fl X
729 Enables X11 forwarding.
730 This can also be specified on a per-host basis in a configuration file.
731 .Pp
732 X11 forwarding should be enabled with caution.
733 Users with the ability to bypass file permissions on the remote host
734 (for the user's X authorization database)
735 can access the local X11 display through the forwarded connection.
736 An attacker may then be able to perform activities such as keystroke monitoring.
737 .It Fl x
738 Disables X11 forwarding.
739 .It Fl Y
740 Enables trusted X11 forwarding.
741 .El
742 .Sh CONFIGURATION FILES
743 .Nm
744 may additionally obtain configuration data from
745 a per-user configuration file and a system-wide configuration file.
746 The file format and configuration options are described in
747 .Xr ssh_config 5 .
748 .Sh ENVIRONMENT
749 .Nm
750 will normally set the following environment variables:
751 .Bl -tag -width LOGNAME
752 .It Ev DISPLAY
753 The
754 .Ev DISPLAY
755 variable indicates the location of the X11 server.
756 It is automatically set by
757 .Nm
758 to point to a value of the form
759 .Dq hostname:n
760 where hostname indicates
761 the host where the shell runs, and n is an integer \*(Ge 1.
762 .Nm
763 uses this special value to forward X11 connections over the secure
764 channel.
765 The user should normally not set
766 .Ev DISPLAY
767 explicitly, as that
768 will render the X11 connection insecure (and will require the user to
769 manually copy any required authorization cookies).
770 .It Ev HOME
771 Set to the path of the user's home directory.
772 .It Ev LOGNAME
773 Synonym for
774 .Ev USER ;
775 set for compatibility with systems that use this variable.
776 .It Ev MAIL
777 Set to the path of the user's mailbox.
778 .It Ev PATH
779 Set to the default
780 .Ev PATH ,
781 as specified when compiling
782 .Nm ssh .
783 .It Ev SSH_ASKPASS
784 If
785 .Nm
786 needs a passphrase, it will read the passphrase from the current
787 terminal if it was run from a terminal.
788 If
789 .Nm
790 does not have a terminal associated with it but
791 .Ev DISPLAY
792 and
793 .Ev SSH_ASKPASS
794 are set, it will execute the program specified by
795 .Ev SSH_ASKPASS
796 and open an X11 window to read the passphrase.
797 This is particularly useful when calling
798 .Nm
799 from a
800 .Pa .Xsession
801 or related script.
802 (Note that on some machines it
803 may be necessary to redirect the input from
804 .Pa /dev/null
805 to make this work.)
806 .It Ev SSH_AUTH_SOCK
807 Identifies the path of a unix-domain socket used to communicate with the
808 agent.
809 .It Ev SSH_CONNECTION
810 Identifies the client and server ends of the connection.
811 The variable contains
812 four space-separated values: client ip-address, client port number,
813 server ip-address and server port number.
814 .It Ev SSH_ORIGINAL_COMMAND
815 The variable contains the original command line if a forced command
816 is executed.
817 It can be used to extract the original arguments.
818 .It Ev SSH_TTY
819 This is set to the name of the tty (path to the device) associated
820 with the current shell or command.
821 If the current session has no tty,
822 this variable is not set.
823 .It Ev TZ
824 The timezone variable is set to indicate the present timezone if it
825 was set when the daemon was started (i.e., the daemon passes the value
826 on to new connections).
827 .It Ev USER
828 Set to the name of the user logging in.
829 .El
830 .Pp
831 Additionally,
832 .Nm
833 reads
834 .Pa $HOME/.ssh/environment ,
835 and adds lines of the format
836 .Dq VARNAME=value
837 to the environment if the file exists and if users are allowed to
838 change their environment.
839 For more information, see the
840 .Cm PermitUserEnvironment
841 option in
842 .Xr sshd_config 5 .
843 .Sh FILES
844 .Bl -tag -width Ds
845 .It Pa $HOME/.ssh/known_hosts
846 Records host keys for all hosts the user has logged into that are not
847 in
848 .Pa /etc/ssh/ssh_known_hosts .
849 See
850 .Xr sshd 8 .
851 .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa
852 Contains the authentication identity of the user.
853 They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively.
854 These files
855 contain sensitive data and should be readable by the user but not
856 accessible by others (read/write/execute).
857 Note that
858 .Nm
859 ignores a private key file if it is accessible by others.
860 It is possible to specify a passphrase when
861 generating the key; the passphrase will be used to encrypt the
862 sensitive part of this file using 3DES.
863 .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub
864 Contains the public key for authentication (public part of the
865 identity file in human-readable form).
866 The contents of the
867 .Pa $HOME/.ssh/identity.pub
868 file should be added to the file
869 .Pa $HOME/.ssh/authorized_keys
870 on all machines
871 where the user wishes to log in using protocol version 1 RSA authentication.
872 The contents of the
873 .Pa $HOME/.ssh/id_dsa.pub
874 and
875 .Pa $HOME/.ssh/id_rsa.pub
876 file should be added to
877 .Pa $HOME/.ssh/authorized_keys
878 on all machines
879 where the user wishes to log in using protocol version 2 DSA/RSA authentication.
880 These files are not
881 sensitive and can (but need not) be readable by anyone.
882 These files are
883 never used automatically and are not necessary; they are only provided for
884 the convenience of the user.
885 .It Pa $HOME/.ssh/config
886 This is the per-user configuration file.
887 The file format and configuration options are described in
888 .Xr ssh_config 5 .
889 .It Pa $HOME/.ssh/authorized_keys
890 Lists the public keys (RSA/DSA) that can be used for logging in as this user.
891 The format of this file is described in the
892 .Xr sshd 8
893 manual page.
894 In the simplest form the format is the same as the
895 .Pa .pub
896 identity files.
897 This file is not highly sensitive, but the recommended
898 permissions are read/write for the user, and not accessible by others.
899 .It Pa /etc/ssh/ssh_known_hosts
900 Systemwide list of known host keys.
901 This file should be prepared by the
902 system administrator to contain the public host keys of all machines in the
903 organization.
904 This file should be world-readable.
905 This file contains
906 public keys, one per line, in the following format (fields separated
907 by spaces): system name, public key and optional comment field.
908 When different names are used
909 for the same machine, all such names should be listed, separated by
910 commas.
911 The format is described in the
912 .Xr sshd 8
913 manual page.
914 .Pp
915 The canonical system name (as returned by name servers) is used by
916 .Xr sshd 8
917 to verify the client host when logging in; other names are needed because
918 .Nm
919 does not convert the user-supplied name to a canonical name before
920 checking the key, because someone with access to the name servers
921 would then be able to fool host authentication.
922 .It Pa /etc/ssh/ssh_config
923 Systemwide configuration file.
924 The file format and configuration options are described in
925 .Xr ssh_config 5 .
926 .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
927 These three files contain the private parts of the host keys
928 and are used for
929 .Cm RhostsRSAAuthentication
930 and
931 .Cm HostbasedAuthentication .
932 If the protocol version 1
933 .Cm RhostsRSAAuthentication
934 method is used,
935 .Nm
936 must be setuid root, since the host key is readable only by root.
937 For protocol version 2,
938 .Nm
939 uses
940 .Xr ssh-keysign 8
941 to access the host keys for
942 .Cm HostbasedAuthentication .
943 This eliminates the requirement that
944 .Nm
945 be setuid root when that authentication method is used.
946 By default
947 .Nm
948 is not setuid root.
949 .It Pa $HOME/.rhosts
950 This file is used in
951 .Em rhosts
952 authentication to list the
953 host/user pairs that are permitted to log in.
954 (Note that this file is
955 also used by rlogin and rsh, which makes using this file insecure.)
956 Each line of the file contains a host name (in the canonical form
957 returned by name servers), and then a user name on that host,
958 separated by a space.
959 On some machines this file may need to be
960 world-readable if the user's home directory is on a NFS partition,
961 because
962 .Xr sshd 8
963 reads it as root.
964 Additionally, this file must be owned by the user,
965 and must not have write permissions for anyone else.
966 The recommended
967 permission for most machines is read/write for the user, and not
968 accessible by others.
969 .Pp
970 Note that by default
971 .Xr sshd 8
972 will be installed so that it requires successful RSA host
973 authentication before permitting
974 .Em rhosts
975 authentication.
976 If the server machine does not have the client's host key in
977 .Pa /etc/ssh/ssh_known_hosts ,
978 it can be stored in
979 .Pa $HOME/.ssh/known_hosts .
980 The easiest way to do this is to
981 connect back to the client from the server machine using ssh; this
982 will automatically add the host key to
983 .Pa $HOME/.ssh/known_hosts .
984 .It Pa $HOME/.shosts
985 This file is used exactly the same way as
986 .Pa .rhosts .
987 The purpose for
988 having this file is to be able to use rhosts authentication with
989 .Nm
990 without permitting login with
991 .Xr rlogin
992 or
993 .Xr rsh 1 .
994 .It Pa /etc/hosts.equiv
995 This file is used during
996 .Em rhosts
997 authentication.
998 It contains
999 canonical hosts names, one per line (the full format is described in the
1000 .Xr sshd 8
1001 manual page).
1002 If the client host is found in this file, login is
1003 automatically permitted provided client and server user names are the
1004 same.
1005 Additionally, successful RSA host authentication is normally
1006 required.
1007 This file should only be writable by root.
1008 .It Pa /etc/ssh/shosts.equiv
1009 This file is processed exactly as
1010 .Pa /etc/hosts.equiv .
1011 This file may be useful to permit logins using
1012 .Nm
1013 but not using rsh/rlogin.
1014 .It Pa /etc/ssh/sshrc
1015 Commands in this file are executed by
1016 .Nm
1017 when the user logs in just before the user's shell (or command) is started.
1018 See the
1019 .Xr sshd 8
1020 manual page for more information.
1021 .It Pa $HOME/.ssh/rc
1022 Commands in this file are executed by
1023 .Nm
1024 when the user logs in just before the user's shell (or command) is
1025 started.
1026 See the
1027 .Xr sshd 8
1028 manual page for more information.
1029 .It Pa $HOME/.ssh/environment
1030 Contains additional definitions for environment variables, see section
1031 .Sx ENVIRONMENT
1032 above.
1033 .El
1034 .Sh DIAGNOSTICS
1035 .Nm
1036 exits with the exit status of the remote command or with 255
1037 if an error occurred.
1038 .Sh SEE ALSO
1039 .Xr gzip 1 ,
1040 .Xr rsh 1 ,
1041 .Xr scp 1 ,
1042 .Xr sftp 1 ,
1043 .Xr ssh-add 1 ,
1044 .Xr ssh-agent 1 ,
1045 .Xr ssh-keygen 1 ,
1046 .Xr telnet 1 ,
1047 .Xr hosts.equiv 5 ,
1048 .Xr ssh_config 5 ,
1049 .Xr ssh-keysign 8 ,
1050 .Xr sshd 8
1051 .Rs
1052 .%A T. Ylonen
1053 .%A T. Kivinen
1054 .%A M. Saarinen
1055 .%A T. Rinne
1056 .%A S. Lehtinen
1057 .%T "SSH Protocol Architecture"
1058 .%N draft-ietf-secsh-architecture-12.txt
1059 .%D January 2002
1060 .%O work in progress material
1061 .Re
1062 .Sh AUTHORS
1063 OpenSSH is a derivative of the original and free
1064 ssh 1.2.12 release by Tatu Ylonen.
1065 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1066 Theo de Raadt and Dug Song
1067 removed many bugs, re-added newer features and
1068 created OpenSSH.
1069 Markus Friedl contributed the support for SSH
1070 protocol versions 1.5 and 2.0.