]> andersk Git - openssh.git/blob - ssh.1
b70102be58ac51f18510275a52d721e321c723c5
[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.190 2004/06/13 15:03:02 djm 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 1246AaCfgkMNnqSsTtVvXxY
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 AES, 3DES, Blowfish, CAST128 or Arcfour)
245 and integrity (hmac-md5, hmac-sha1, hmac-ripemd160).
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.
306 Currently this allows the addition of port forwardings using the
307 .Fl L
308 and
309 .Fl R
310 options (see below).
311 It also allows the cancellation of existing remote port-forwardings
312 using
313 .Fl KR Ar hostport .
314 Basic help is available, using the
315 .Fl h
316 option.
317 .It Cm ~R
318 Request rekeying of the connection
319 (only useful for SSH protocol version 2 and if the peer supports it).
320 .El
321 .Ss X11 and TCP forwarding
322 If the
323 .Cm ForwardX11
324 variable is set to
325 .Dq yes
326 (or see the description of the
327 .Fl X
328 and
329 .Fl x
330 options described later)
331 and the user is using X11 (the
332 .Ev DISPLAY
333 environment variable is set), the connection to the X11 display is
334 automatically forwarded to the remote side in such a way that any X11
335 programs started from the shell (or command) will go through the
336 encrypted channel, and the connection to the real X server will be made
337 from the local machine.
338 The user should not manually set
339 .Ev DISPLAY .
340 Forwarding of X11 connections can be
341 configured on the command line or in configuration files.
342 .Pp
343 The
344 .Ev DISPLAY
345 value set by
346 .Nm
347 will point to the server machine, but with a display number greater than zero.
348 This is normal, and happens because
349 .Nm
350 creates a
351 .Dq proxy
352 X server on the server machine for forwarding the
353 connections over the encrypted channel.
354 .Pp
355 .Nm
356 will also automatically set up Xauthority data on the server machine.
357 For this purpose, it will generate a random authorization cookie,
358 store it in Xauthority on the server, and verify that any forwarded
359 connections carry this cookie and replace it by the real cookie when
360 the connection is opened.
361 The real authentication cookie is never
362 sent to the server machine (and no cookies are sent in the plain).
363 .Pp
364 If the
365 .Cm ForwardAgent
366 variable is set to
367 .Dq yes
368 (or see the description of the
369 .Fl A
370 and
371 .Fl a
372 options described later) and
373 the user is using an authentication agent, the connection to the agent
374 is automatically forwarded to the remote side.
375 .Pp
376 Forwarding of arbitrary TCP/IP connections over the secure channel can
377 be specified either on the command line or in a configuration file.
378 One possible application of TCP/IP forwarding is a secure connection to an
379 electronic purse; another is going through firewalls.
380 .Ss Server authentication
381 .Nm
382 automatically maintains and checks a database containing
383 identifications for all hosts it has ever been used with.
384 Host keys are stored in
385 .Pa $HOME/.ssh/known_hosts
386 in the user's home directory.
387 Additionally, the file
388 .Pa /etc/ssh/ssh_known_hosts
389 is automatically checked for known hosts.
390 Any new hosts are automatically added to the user's file.
391 If a host's identification ever changes,
392 .Nm
393 warns about this and disables password authentication to prevent a
394 trojan horse from getting the user's password.
395 Another purpose of this mechanism is to prevent man-in-the-middle attacks
396 which could otherwise be used to circumvent the encryption.
397 The
398 .Cm StrictHostKeyChecking
399 option can be used to prevent logins to machines whose
400 host key is not known or has changed.
401 .Pp
402 The options are as follows:
403 .Bl -tag -width Ds
404 .It Fl 1
405 Forces
406 .Nm
407 to try protocol version 1 only.
408 .It Fl 2
409 Forces
410 .Nm
411 to try protocol version 2 only.
412 .It Fl 4
413 Forces
414 .Nm
415 to use IPv4 addresses only.
416 .It Fl 6
417 Forces
418 .Nm
419 to use IPv6 addresses only.
420 .It Fl A
421 Enables forwarding of the authentication agent connection.
422 This can also be specified on a per-host basis in a configuration file.
423 .Pp
424 Agent forwarding should be enabled with caution.
425 Users with the ability to bypass file permissions on the remote host
426 (for the agent's Unix-domain socket)
427 can access the local agent through the forwarded connection.
428 An attacker cannot obtain key material from the agent,
429 however they can perform operations on the keys that enable them to
430 authenticate using the identities loaded into the agent.
431 .It Fl a
432 Disables forwarding of the authentication agent connection.
433 .It Fl b Ar bind_address
434 Specify the interface to transmit from on machines with multiple
435 interfaces or aliased addresses.
436 .It Fl C
437 Requests compression of all data (including stdin, stdout, stderr, and
438 data for forwarded X11 and TCP/IP connections).
439 The compression algorithm is the same used by
440 .Xr gzip 1 ,
441 and the
442 .Dq level
443 can be controlled by the
444 .Cm CompressionLevel
445 option for protocol version 1.
446 Compression is desirable on modem lines and other
447 slow connections, but will only slow down things on fast networks.
448 The default value can be set on a host-by-host basis in the
449 configuration files; see the
450 .Cm Compression
451 option.
452 .It Fl c Ar cipher_spec
453 Selects the cipher specification for encrypting the session.
454 .Pp
455 Protocol version 1 allows specification of a single cipher.
456 The suported values are
457 .Dq 3des ,
458 .Dq blowfish
459 and
460 .Dq des .
461 .Ar 3des
462 (triple-des) is an encrypt-decrypt-encrypt triple with three different keys.
463 It is believed to be secure.
464 .Ar blowfish
465 is a fast block cipher; it appears very secure and is much faster than
466 .Ar 3des .
467 .Ar des
468 is only supported in the
469 .Nm
470 client for interoperability with legacy protocol 1 implementations
471 that do not support the
472 .Ar 3des
473 cipher.
474 Its use is strongly discouraged due to cryptographic weaknesses.
475 The default is
476 .Dq 3des .
477 .Pp
478 For protocol version 2
479 .Ar cipher_spec
480 is a comma-separated list of ciphers
481 listed in order of preference.
482 The supported ciphers are
483 .Dq 3des-cbc ,
484 .Dq aes128-cbc ,
485 .Dq aes192-cbc ,
486 .Dq aes256-cbc ,
487 .Dq aes128-ctr ,
488 .Dq aes192-ctr ,
489 .Dq aes256-ctr ,
490 .Dq arcfour ,
491 .Dq blowfish-cbc ,
492 and
493 .Dq cast128-cbc .
494 The default is
495 .Bd -literal
496   ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
497     aes192-cbc,aes256-cbc''
498 .Ed
499 .It Fl D Ar port
500 Specifies a local
501 .Dq dynamic
502 application-level port forwarding.
503 This works by allocating a socket to listen to
504 .Ar port
505 on the local side, and whenever a connection is made to this port, the
506 connection is forwarded over the secure channel, and the application
507 protocol is then used to determine where to connect to from the
508 remote machine.
509 Currently the SOCKS4 and SOCKS5 protocols are supported, and
510 .Nm
511 will act as a SOCKS server.
512 Only root can forward privileged ports.
513 Dynamic port forwardings can also be specified in the configuration file.
514 .It Fl e Ar ch | ^ch | none
515 Sets the escape character for sessions with a pty (default:
516 .Ql ~ ) .
517 The escape character is only recognized at the beginning of a line.
518 The escape character followed by a dot
519 .Pq Ql \&.
520 closes the connection;
521 followed by control-Z suspends the connection;
522 and followed by itself sends the escape character once.
523 Setting the character to
524 .Dq none
525 disables any escapes and makes the session fully transparent.
526 .It Fl F Ar configfile
527 Specifies an alternative per-user configuration file.
528 If a configuration file is given on the command line,
529 the system-wide configuration file
530 .Pq Pa /etc/ssh/ssh_config
531 will be ignored.
532 The default for the per-user configuration file is
533 .Pa $HOME/.ssh/config .
534 .It Fl f
535 Requests
536 .Nm
537 to go to background just before command execution.
538 This is useful if
539 .Nm
540 is going to ask for passwords or passphrases, but the user
541 wants it in the background.
542 This implies
543 .Fl n .
544 The recommended way to start X11 programs at a remote site is with
545 something like
546 .Ic ssh -f host xterm .
547 .It Fl g
548 Allows remote hosts to connect to local forwarded ports.
549 .It Fl I Ar smartcard_device
550 Specifies which smartcard device to use.
551 The argument is the device
552 .Nm
553 should use to communicate with a smartcard used for storing the user's
554 private RSA key.
555 .It Fl i Ar identity_file
556 Selects a file from which the identity (private key) for
557 RSA or DSA authentication is read.
558 The default is
559 .Pa $HOME/.ssh/identity
560 for protocol version 1, and
561 .Pa $HOME/.ssh/id_rsa
562 and
563 .Pa $HOME/.ssh/id_dsa
564 for protocol version 2.
565 Identity files may also be specified on
566 a per-host basis in the configuration file.
567 It is possible to have multiple
568 .Fl i
569 options (and multiple identities specified in
570 configuration files).
571 .It Fl k
572 Disables forwarding (delegation) of GSSAPI credentials to the server.
573 .It Fl L Xo
574 .Sm off
575 .Ar port : host : hostport
576 .Sm on
577 .Xc
578 Specifies that the given port on the local (client) host is to be
579 forwarded to the given host and port on the remote side.
580 This works by allocating a socket to listen to
581 .Ar port
582 on the local side, and whenever a connection is made to this port, the
583 connection is forwarded over the secure channel, and a connection is
584 made to
585 .Ar host
586 port
587 .Ar hostport
588 from the remote machine.
589 Port forwardings can also be specified in the configuration file.
590 Only root can forward privileged ports.
591 IPv6 addresses can be specified with an alternative syntax:
592 .Sm off
593 .Xo
594 .Ar port No / Ar host No /
595 .Ar hostport .
596 .Xc
597 .Sm on
598 .It Fl l Ar login_name
599 Specifies the user to log in as on the remote machine.
600 This also may be specified on a per-host basis in the configuration file.
601 .It Fl m Ar mac_spec
602 Additionally, for protocol version 2 a comma-separated list of MAC
603 (message authentication code) algorithms can
604 be specified in order of preference.
605 See the
606 .Cm MACs
607 keyword for more information.
608 .It Fl M
609 Places the
610 .Nm
611 client into
612 .Dq master
613 mode for connection sharing.
614 Refer to the description of
615 .Cm ControlMaster
616 in
617 .Xr ssh_config 5
618 for details.
619 .It Fl N
620 Do not execute a remote command.
621 This is useful for just forwarding ports
622 (protocol version 2 only).
623 .It Fl n
624 Redirects stdin from
625 .Pa /dev/null
626 (actually, prevents reading from stdin).
627 This must be used when
628 .Nm
629 is run in the background.
630 A common trick is to use this to run X11 programs on a remote machine.
631 For example,
632 .Ic ssh -n shadows.cs.hut.fi emacs &
633 will start an emacs on shadows.cs.hut.fi, and the X11
634 connection will be automatically forwarded over an encrypted channel.
635 The
636 .Nm
637 program will be put in the background.
638 (This does not work if
639 .Nm
640 needs to ask for a password or passphrase; see also the
641 .Fl f
642 option.)
643 .It Fl o Ar option
644 Can be used to give options in the format used in the configuration file.
645 This is useful for specifying options for which there is no separate
646 command-line flag.
647 For full details of the options listed below, and their possible values, see
648 .Xr ssh_config 5 .
649 .Pp
650 .Bl -tag -width Ds -offset indent -compact
651 .It AddressFamily
652 .It BatchMode
653 .It BindAddress
654 .It ChallengeResponseAuthentication
655 .It CheckHostIP
656 .It Cipher
657 .It Ciphers
658 .It ClearAllForwardings
659 .It Compression
660 .It CompressionLevel
661 .It ConnectionAttempts
662 .It ConnectTimeout
663 .It ControlMaster
664 .It ControlPath
665 .It DynamicForward
666 .It EscapeChar
667 .It ForwardAgent
668 .It ForwardX11
669 .It ForwardX11Trusted
670 .It GatewayPorts
671 .It GlobalKnownHostsFile
672 .It GSSAPIAuthentication
673 .It GSSAPIDelegateCredentials
674 .It Host
675 .It HostbasedAuthentication
676 .It HostKeyAlgorithms
677 .It HostKeyAlias
678 .It HostName
679 .It IdentityFile
680 .It IdentitiesOnly
681 .It LocalForward
682 .It LogLevel
683 .It MACs
684 .It NoHostAuthenticationForLocalhost
685 .It NumberOfPasswordPrompts
686 .It PasswordAuthentication
687 .It Port
688 .It PreferredAuthentications
689 .It Protocol
690 .It ProxyCommand
691 .It PubkeyAuthentication
692 .It RemoteForward
693 .It RhostsRSAAuthentication
694 .It RSAAuthentication
695 .It SendEnv
696 .It ServerAliveInterval
697 .It ServerAliveCountMax
698 .It SmartcardDevice
699 .It StrictHostKeyChecking
700 .It TCPKeepAlive
701 .It UsePrivilegedPort
702 .It User
703 .It UserKnownHostsFile
704 .It VerifyHostKeyDNS
705 .It XAuthLocation
706 .El
707 .It Fl p Ar port
708 Port to connect to on the remote host.
709 This can be specified on a
710 per-host basis in the configuration file.
711 .It Fl q
712 Quiet mode.
713 Causes all warning and diagnostic messages to be suppressed.
714 .It Fl R Xo
715 .Sm off
716 .Ar port : host : hostport
717 .Sm on
718 .Xc
719 Specifies that the given port on the remote (server) host is to be
720 forwarded to the given host and port on the local side.
721 This works by allocating a socket to listen to
722 .Ar port
723 on the remote side, and whenever a connection is made to this port, the
724 connection is forwarded over the secure channel, and a connection is
725 made to
726 .Ar host
727 port
728 .Ar hostport
729 from the local machine.
730 Port forwardings can also be specified in the configuration file.
731 Privileged ports can be forwarded only when
732 logging in as root on the remote machine.
733 IPv6 addresses can be specified with an alternative syntax:
734 .Sm off
735 .Xo
736 .Ar port No / Ar host No /
737 .Ar hostport .
738 .Xc
739 .Sm on
740 .It Fl S
741 Places the
742 .Nm
743 client into slave mode for connection sharing.
744 Refer to the description of
745 .Cm ControlMaster
746 in
747 .Xr ssh_config 5
748 for details.
749 .It Fl s
750 May be used to request invocation of a subsystem on the remote system.
751 Subsystems are a feature of the SSH2 protocol which facilitate the use
752 of SSH as a secure transport for other applications (eg.\&
753 .Xr sftp 1 ) .
754 The subsystem is specified as the remote command.
755 .It Fl T
756 Disable pseudo-tty allocation.
757 .It Fl t
758 Force pseudo-tty allocation.
759 This can be used to execute arbitrary
760 screen-based programs on a remote machine, which can be very useful,
761 e.g., when implementing menu services.
762 Multiple
763 .Fl t
764 options force tty allocation, even if
765 .Nm
766 has no local tty.
767 .It Fl V
768 Display the version number and exit.
769 .It Fl v
770 Verbose mode.
771 Causes
772 .Nm
773 to print debugging messages about its progress.
774 This is helpful in
775 debugging connection, authentication, and configuration problems.
776 Multiple
777 .Fl v
778 options increase the verbosity.
779 The maximum is 3.
780 .It Fl X
781 Enables X11 forwarding.
782 This can also be specified on a per-host basis in a configuration file.
783 .Pp
784 X11 forwarding should be enabled with caution.
785 Users with the ability to bypass file permissions on the remote host
786 (for the user's X authorization database)
787 can access the local X11 display through the forwarded connection.
788 An attacker may then be able to perform activities such as keystroke monitoring.
789 .It Fl x
790 Disables X11 forwarding.
791 .It Fl Y
792 Enables trusted X11 forwarding.
793 .El
794 .Sh CONFIGURATION FILES
795 .Nm
796 may additionally obtain configuration data from
797 a per-user configuration file and a system-wide configuration file.
798 The file format and configuration options are described in
799 .Xr ssh_config 5 .
800 .Sh ENVIRONMENT
801 .Nm
802 will normally set the following environment variables:
803 .Bl -tag -width LOGNAME
804 .It Ev DISPLAY
805 The
806 .Ev DISPLAY
807 variable indicates the location of the X11 server.
808 It is automatically set by
809 .Nm
810 to point to a value of the form
811 .Dq hostname:n
812 where hostname indicates
813 the host where the shell runs, and n is an integer \*(Ge 1.
814 .Nm
815 uses this special value to forward X11 connections over the secure
816 channel.
817 The user should normally not set
818 .Ev DISPLAY
819 explicitly, as that
820 will render the X11 connection insecure (and will require the user to
821 manually copy any required authorization cookies).
822 .It Ev HOME
823 Set to the path of the user's home directory.
824 .It Ev LOGNAME
825 Synonym for
826 .Ev USER ;
827 set for compatibility with systems that use this variable.
828 .It Ev MAIL
829 Set to the path of the user's mailbox.
830 .It Ev PATH
831 Set to the default
832 .Ev PATH ,
833 as specified when compiling
834 .Nm ssh .
835 .It Ev SSH_ASKPASS
836 If
837 .Nm
838 needs a passphrase, it will read the passphrase from the current
839 terminal if it was run from a terminal.
840 If
841 .Nm
842 does not have a terminal associated with it but
843 .Ev DISPLAY
844 and
845 .Ev SSH_ASKPASS
846 are set, it will execute the program specified by
847 .Ev SSH_ASKPASS
848 and open an X11 window to read the passphrase.
849 This is particularly useful when calling
850 .Nm
851 from a
852 .Pa .Xsession
853 or related script.
854 (Note that on some machines it
855 may be necessary to redirect the input from
856 .Pa /dev/null
857 to make this work.)
858 .It Ev SSH_AUTH_SOCK
859 Identifies the path of a unix-domain socket used to communicate with the
860 agent.
861 .It Ev SSH_CONNECTION
862 Identifies the client and server ends of the connection.
863 The variable contains
864 four space-separated values: client ip-address, client port number,
865 server ip-address and server port number.
866 .It Ev SSH_ORIGINAL_COMMAND
867 The variable contains the original command line if a forced command
868 is executed.
869 It can be used to extract the original arguments.
870 .It Ev SSH_TTY
871 This is set to the name of the tty (path to the device) associated
872 with the current shell or command.
873 If the current session has no tty,
874 this variable is not set.
875 .It Ev TZ
876 The timezone variable is set to indicate the present timezone if it
877 was set when the daemon was started (i.e., the daemon passes the value
878 on to new connections).
879 .It Ev USER
880 Set to the name of the user logging in.
881 .El
882 .Pp
883 Additionally,
884 .Nm
885 reads
886 .Pa $HOME/.ssh/environment ,
887 and adds lines of the format
888 .Dq VARNAME=value
889 to the environment if the file exists and if users are allowed to
890 change their environment.
891 For more information, see the
892 .Cm PermitUserEnvironment
893 option in
894 .Xr sshd_config 5 .
895 .Sh FILES
896 .Bl -tag -width Ds
897 .It Pa $HOME/.ssh/known_hosts
898 Records host keys for all hosts the user has logged into that are not
899 in
900 .Pa /etc/ssh/ssh_known_hosts .
901 See
902 .Xr sshd 8 .
903 .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa
904 Contains the authentication identity of the user.
905 They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively.
906 These files
907 contain sensitive data and should be readable by the user but not
908 accessible by others (read/write/execute).
909 Note that
910 .Nm
911 ignores a private key file if it is accessible by others.
912 It is possible to specify a passphrase when
913 generating the key; the passphrase will be used to encrypt the
914 sensitive part of this file using 3DES.
915 .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub
916 Contains the public key for authentication (public part of the
917 identity file in human-readable form).
918 The contents of the
919 .Pa $HOME/.ssh/identity.pub
920 file should be added to the file
921 .Pa $HOME/.ssh/authorized_keys
922 on all machines
923 where the user wishes to log in using protocol version 1 RSA authentication.
924 The contents of the
925 .Pa $HOME/.ssh/id_dsa.pub
926 and
927 .Pa $HOME/.ssh/id_rsa.pub
928 file should be added to
929 .Pa $HOME/.ssh/authorized_keys
930 on all machines
931 where the user wishes to log in using protocol version 2 DSA/RSA authentication.
932 These files are not
933 sensitive and can (but need not) be readable by anyone.
934 These files are
935 never used automatically and are not necessary; they are only provided for
936 the convenience of the user.
937 .It Pa $HOME/.ssh/config
938 This is the per-user configuration file.
939 The file format and configuration options are described in
940 .Xr ssh_config 5 .
941 Because of the potential for abuse, this file must have strict permissions:
942 read/write for the user, and not accessible by others.
943 .It Pa $HOME/.ssh/authorized_keys
944 Lists the public keys (RSA/DSA) that can be used for logging in as this user.
945 The format of this file is described in the
946 .Xr sshd 8
947 manual page.
948 In the simplest form the format is the same as the
949 .Pa .pub
950 identity files.
951 This file is not highly sensitive, but the recommended
952 permissions are read/write for the user, and not accessible by others.
953 .It Pa /etc/ssh/ssh_known_hosts
954 Systemwide list of known host keys.
955 This file should be prepared by the
956 system administrator to contain the public host keys of all machines in the
957 organization.
958 This file should be world-readable.
959 This file contains
960 public keys, one per line, in the following format (fields separated
961 by spaces): system name, public key and optional comment field.
962 When different names are used
963 for the same machine, all such names should be listed, separated by
964 commas.
965 The format is described in the
966 .Xr sshd 8
967 manual page.
968 .Pp
969 The canonical system name (as returned by name servers) is used by
970 .Xr sshd 8
971 to verify the client host when logging in; other names are needed because
972 .Nm
973 does not convert the user-supplied name to a canonical name before
974 checking the key, because someone with access to the name servers
975 would then be able to fool host authentication.
976 .It Pa /etc/ssh/ssh_config
977 Systemwide configuration file.
978 The file format and configuration options are described in
979 .Xr ssh_config 5 .
980 .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
981 These three files contain the private parts of the host keys
982 and are used for
983 .Cm RhostsRSAAuthentication
984 and
985 .Cm HostbasedAuthentication .
986 If the protocol version 1
987 .Cm RhostsRSAAuthentication
988 method is used,
989 .Nm
990 must be setuid root, since the host key is readable only by root.
991 For protocol version 2,
992 .Nm
993 uses
994 .Xr ssh-keysign 8
995 to access the host keys for
996 .Cm HostbasedAuthentication .
997 This eliminates the requirement that
998 .Nm
999 be setuid root when that authentication method is used.
1000 By default
1001 .Nm
1002 is not setuid root.
1003 .It Pa $HOME/.rhosts
1004 This file is used in
1005 .Em rhosts
1006 authentication to list the
1007 host/user pairs that are permitted to log in.
1008 (Note that this file is
1009 also used by rlogin and rsh, which makes using this file insecure.)
1010 Each line of the file contains a host name (in the canonical form
1011 returned by name servers), and then a user name on that host,
1012 separated by a space.
1013 On some machines this file may need to be
1014 world-readable if the user's home directory is on a NFS partition,
1015 because
1016 .Xr sshd 8
1017 reads it as root.
1018 Additionally, this file must be owned by the user,
1019 and must not have write permissions for anyone else.
1020 The recommended
1021 permission for most machines is read/write for the user, and not
1022 accessible by others.
1023 .Pp
1024 Note that by default
1025 .Xr sshd 8
1026 will be installed so that it requires successful RSA host
1027 authentication before permitting
1028 .Em rhosts
1029 authentication.
1030 If the server machine does not have the client's host key in
1031 .Pa /etc/ssh/ssh_known_hosts ,
1032 it can be stored in
1033 .Pa $HOME/.ssh/known_hosts .
1034 The easiest way to do this is to
1035 connect back to the client from the server machine using ssh; this
1036 will automatically add the host key to
1037 .Pa $HOME/.ssh/known_hosts .
1038 .It Pa $HOME/.shosts
1039 This file is used exactly the same way as
1040 .Pa .rhosts .
1041 The purpose for
1042 having this file is to be able to use rhosts authentication with
1043 .Nm
1044 without permitting login with
1045 .Xr rlogin
1046 or
1047 .Xr rsh 1 .
1048 .It Pa /etc/hosts.equiv
1049 This file is used during
1050 .Em rhosts
1051 authentication.
1052 It contains
1053 canonical hosts names, one per line (the full format is described in the
1054 .Xr sshd 8
1055 manual page).
1056 If the client host is found in this file, login is
1057 automatically permitted provided client and server user names are the
1058 same.
1059 Additionally, successful RSA host authentication is normally
1060 required.
1061 This file should only be writable by root.
1062 .It Pa /etc/shosts.equiv
1063 This file is processed exactly as
1064 .Pa /etc/hosts.equiv .
1065 This file may be useful to permit logins using
1066 .Nm
1067 but not using rsh/rlogin.
1068 .It Pa /etc/ssh/sshrc
1069 Commands in this file are executed by
1070 .Nm
1071 when the user logs in just before the user's shell (or command) is started.
1072 See the
1073 .Xr sshd 8
1074 manual page for more information.
1075 .It Pa $HOME/.ssh/rc
1076 Commands in this file are executed by
1077 .Nm
1078 when the user logs in just before the user's shell (or command) is
1079 started.
1080 See the
1081 .Xr sshd 8
1082 manual page for more information.
1083 .It Pa $HOME/.ssh/environment
1084 Contains additional definitions for environment variables, see section
1085 .Sx ENVIRONMENT
1086 above.
1087 .El
1088 .Sh DIAGNOSTICS
1089 .Nm
1090 exits with the exit status of the remote command or with 255
1091 if an error occurred.
1092 .Sh SEE ALSO
1093 .Xr gzip 1 ,
1094 .Xr rsh 1 ,
1095 .Xr scp 1 ,
1096 .Xr sftp 1 ,
1097 .Xr ssh-add 1 ,
1098 .Xr ssh-agent 1 ,
1099 .Xr ssh-keygen 1 ,
1100 .Xr telnet 1 ,
1101 .Xr hosts.equiv 5 ,
1102 .Xr ssh_config 5 ,
1103 .Xr ssh-keysign 8 ,
1104 .Xr sshd 8
1105 .Rs
1106 .%A T. Ylonen
1107 .%A T. Kivinen
1108 .%A M. Saarinen
1109 .%A T. Rinne
1110 .%A S. Lehtinen
1111 .%T "SSH Protocol Architecture"
1112 .%N draft-ietf-secsh-architecture-12.txt
1113 .%D January 2002
1114 .%O work in progress material
1115 .Re
1116 .Sh AUTHORS
1117 OpenSSH is a derivative of the original and free
1118 ssh 1.2.12 release by Tatu Ylonen.
1119 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1120 Theo de Raadt and Dug Song
1121 removed many bugs, re-added newer features and
1122 created OpenSSH.
1123 Markus Friedl contributed the support for SSH
1124 protocol versions 1.5 and 2.0.
This page took 0.114549 seconds and 3 git commands to generate.