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