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