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