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