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