xref: /freebsd/crypto/openssh/ssh.1 (revision 56b17de1e8360fe131d425de20b5e75ff3ea897c)
1.\"
2.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
3.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4.\"                    All rights reserved
5.\"
6.\" As far as I am concerned, the code I have written for this software
7.\" can be used freely for any purpose.  Any derived versions of this
8.\" software must be clearly marked as such, and if the derived work is
9.\" incompatible with the protocol description in the RFC file, it must be
10.\" called by a name other than "ssh" or "Secure Shell".
11.\"
12.\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
13.\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
14.\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
15.\"
16.\" Redistribution and use in source and binary forms, with or without
17.\" modification, are permitted provided that the following conditions
18.\" are met:
19.\" 1. Redistributions of source code must retain the above copyright
20.\"    notice, this list of conditions and the following disclaimer.
21.\" 2. Redistributions in binary form must reproduce the above copyright
22.\"    notice, this list of conditions and the following disclaimer in the
23.\"    documentation and/or other materials provided with the distribution.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35.\"
36.\" $OpenBSD: ssh.1,v 1.438 2023/10/11 23:14:33 djm Exp $
37.Dd $Mdocdate: October 11 2023 $
38.Dt SSH 1
39.Os
40.Sh NAME
41.Nm ssh
42.Nd OpenSSH remote login client
43.Sh SYNOPSIS
44.Nm ssh
45.Op Fl 46AaCfGgKkMNnqsTtVvXxYy
46.Op Fl B Ar bind_interface
47.Op Fl b Ar bind_address
48.Op Fl c Ar cipher_spec
49.Op Fl D Oo Ar bind_address : Oc Ns Ar port
50.Op Fl E Ar log_file
51.Op Fl e Ar escape_char
52.Op Fl F Ar configfile
53.Op Fl I Ar pkcs11
54.Op Fl i Ar identity_file
55.Op Fl J Ar destination
56.Op Fl L Ar address
57.Op Fl l Ar login_name
58.Op Fl m Ar mac_spec
59.Op Fl O Ar ctl_cmd
60.Op Fl o Ar option
61.Op Fl P Ar tag
62.Op Fl p Ar port
63.Op Fl R Ar address
64.Op Fl S Ar ctl_path
65.Op Fl W Ar host : Ns Ar port
66.Op Fl w Ar local_tun Ns Op : Ns Ar remote_tun
67.Ar destination
68.Op Ar command Op Ar argument ...
69.Nm
70.Op Fl Q Ar query_option
71.Sh DESCRIPTION
72.Nm
73(SSH client) is a program for logging into a remote machine and for
74executing commands on a remote machine.
75It is intended to provide secure encrypted communications between
76two untrusted hosts over an insecure network.
77X11 connections, arbitrary TCP ports and
78.Ux Ns -domain
79sockets can also be forwarded over the secure channel.
80.Pp
81.Nm
82connects and logs into the specified
83.Ar destination ,
84which may be specified as either
85.Sm off
86.Oo user @ Oc hostname
87.Sm on
88or a URI of the form
89.Sm off
90.No ssh:// Oo user @ Oc hostname Op : port .
91.Sm on
92The user must prove
93their identity to the remote machine using one of several methods
94(see below).
95.Pp
96If a
97.Ar command
98is specified,
99it will be executed on the remote host instead of a login shell.
100A complete command line may be specified as
101.Ar command ,
102or it may have additional arguments.
103If supplied, the arguments will be appended to the command, separated by
104spaces, before it is sent to the server to be executed.
105.Pp
106The options are as follows:
107.Pp
108.Bl -tag -width Ds -compact
109.It Fl 4
110Forces
111.Nm
112to use IPv4 addresses only.
113.Pp
114.It Fl 6
115Forces
116.Nm
117to use IPv6 addresses only.
118.Pp
119.It Fl A
120Enables forwarding of connections from an authentication agent such as
121.Xr ssh-agent 1 .
122This can also be specified on a per-host basis in a configuration file.
123.Pp
124Agent forwarding should be enabled with caution.
125Users with the ability to bypass file permissions on the remote host
126(for the agent's
127.Ux Ns -domain
128socket) can access the local agent through the forwarded connection.
129An attacker cannot obtain key material from the agent,
130however they can perform operations on the keys that enable them to
131authenticate using the identities loaded into the agent.
132A safer alternative may be to use a jump host
133(see
134.Fl J ) .
135.Pp
136.It Fl a
137Disables forwarding of the authentication agent connection.
138.Pp
139.It Fl B Ar bind_interface
140Bind to the address of
141.Ar bind_interface
142before attempting to connect to the destination host.
143This is only useful on systems with more than one address.
144.Pp
145.It Fl b Ar bind_address
146Use
147.Ar bind_address
148on the local machine as the source address
149of the connection.
150Only useful on systems with more than one address.
151.Pp
152.It Fl C
153Requests compression of all data (including stdin, stdout, stderr, and
154data for forwarded X11, TCP and
155.Ux Ns -domain
156connections).
157The compression algorithm is the same used by
158.Xr gzip 1 .
159Compression is desirable on modem lines and other
160slow connections, but will only slow down things on fast networks.
161The default value can be set on a host-by-host basis in the
162configuration files; see the
163.Cm Compression
164option in
165.Xr ssh_config 5 .
166.Pp
167.It Fl c Ar cipher_spec
168Selects the cipher specification for encrypting the session.
169.Ar cipher_spec
170is a comma-separated list of ciphers
171listed in order of preference.
172See the
173.Cm Ciphers
174keyword in
175.Xr ssh_config 5
176for more information.
177.Pp
178.It Fl D Xo
179.Sm off
180.Oo Ar bind_address : Oc
181.Ar port
182.Sm on
183.Xc
184Specifies a local
185.Dq dynamic
186application-level port forwarding.
187This works by allocating a socket to listen to
188.Ar port
189on the local side, optionally bound to the specified
190.Ar bind_address .
191Whenever a connection is made to this port, the
192connection is forwarded over the secure channel, and the application
193protocol is then used to determine where to connect to from the
194remote machine.
195Currently the SOCKS4 and SOCKS5 protocols are supported, and
196.Nm
197will act as a SOCKS server.
198Only root can forward privileged ports.
199Dynamic port forwardings can also be specified in the configuration file.
200.Pp
201IPv6 addresses can be specified by enclosing the address in square brackets.
202Only the superuser can forward privileged ports.
203By default, the local port is bound in accordance with the
204.Cm GatewayPorts
205setting.
206However, an explicit
207.Ar bind_address
208may be used to bind the connection to a specific address.
209The
210.Ar bind_address
211of
212.Dq localhost
213indicates that the listening port be bound for local use only, while an
214empty address or
215.Sq *
216indicates that the port should be available from all interfaces.
217.Pp
218.It Fl E Ar log_file
219Append debug logs to
220.Ar log_file
221instead of standard error.
222.Pp
223.It Fl e Ar escape_char
224Sets the escape character for sessions with a pty (default:
225.Ql ~ ) .
226The escape character is only recognized at the beginning of a line.
227The escape character followed by a dot
228.Pq Ql \&.
229closes the connection;
230followed by control-Z suspends the connection;
231and followed by itself sends the escape character once.
232Setting the character to
233.Dq none
234disables any escapes and makes the session fully transparent.
235.Pp
236.It Fl F Ar configfile
237Specifies an alternative per-user configuration file.
238If a configuration file is given on the command line,
239the system-wide configuration file
240.Pq Pa /etc/ssh/ssh_config
241will be ignored.
242The default for the per-user configuration file is
243.Pa ~/.ssh/config .
244If set to
245.Dq none ,
246no configuration files will be read.
247.Pp
248.It Fl f
249Requests
250.Nm
251to go to background just before command execution.
252This is useful if
253.Nm
254is going to ask for passwords or passphrases, but the user
255wants it in the background.
256This implies
257.Fl n .
258The recommended way to start X11 programs at a remote site is with
259something like
260.Ic ssh -f host xterm .
261.Pp
262If the
263.Cm ExitOnForwardFailure
264configuration option is set to
265.Dq yes ,
266then a client started with
267.Fl f
268will wait for all remote port forwards to be successfully established
269before placing itself in the background.
270Refer to the description of
271.Cm ForkAfterAuthentication
272in
273.Xr ssh_config 5
274for details.
275.Pp
276.It Fl G
277Causes
278.Nm
279to print its configuration after evaluating
280.Cm Host
281and
282.Cm Match
283blocks and exit.
284.Pp
285.It Fl g
286Allows remote hosts to connect to local forwarded ports.
287If used on a multiplexed connection, then this option must be specified
288on the master process.
289.Pp
290.It Fl I Ar pkcs11
291Specify the PKCS#11 shared library
292.Nm
293should use to communicate with a PKCS#11 token providing keys for user
294authentication.
295.Pp
296.It Fl i Ar identity_file
297Selects a file from which the identity (private key) for
298public key authentication is read.
299You can also specify a public key file to use the corresponding
300private key that is loaded in
301.Xr ssh-agent 1
302when the private key file is not present locally.
303The default is
304.Pa ~/.ssh/id_rsa ,
305.Pa ~/.ssh/id_ecdsa ,
306.Pa ~/.ssh/id_ecdsa_sk ,
307.Pa ~/.ssh/id_ed25519 ,
308.Pa ~/.ssh/id_ed25519_sk
309and
310.Pa ~/.ssh/id_dsa .
311Identity files may also be specified on
312a per-host basis in the configuration file.
313It is possible to have multiple
314.Fl i
315options (and multiple identities specified in
316configuration files).
317If no certificates have been explicitly specified by the
318.Cm CertificateFile
319directive,
320.Nm
321will also try to load certificate information from the filename obtained
322by appending
323.Pa -cert.pub
324to identity filenames.
325.Pp
326.It Fl J Ar destination
327Connect to the target host by first making an
328.Nm
329connection to the jump host described by
330.Ar destination
331and then establishing a TCP forwarding to the ultimate destination from
332there.
333Multiple jump hops may be specified separated by comma characters.
334This is a shortcut to specify a
335.Cm ProxyJump
336configuration directive.
337Note that configuration directives supplied on the command-line generally
338apply to the destination host and not any specified jump hosts.
339Use
340.Pa ~/.ssh/config
341to specify configuration for jump hosts.
342.Pp
343.It Fl K
344Enables GSSAPI-based authentication and forwarding (delegation) of GSSAPI
345credentials to the server.
346.Pp
347.It Fl k
348Disables forwarding (delegation) of GSSAPI credentials to the server.
349.Pp
350.It Fl L Xo
351.Sm off
352.Oo Ar bind_address : Oc
353.Ar port : host : hostport
354.Sm on
355.Xc
356.It Fl L Xo
357.Sm off
358.Oo Ar bind_address : Oc
359.Ar port : remote_socket
360.Sm on
361.Xc
362.It Fl L Xo
363.Sm off
364.Ar local_socket : host : hostport
365.Sm on
366.Xc
367.It Fl L Xo
368.Sm off
369.Ar local_socket : remote_socket
370.Sm on
371.Xc
372Specifies that connections to the given TCP port or Unix socket on the local
373(client) host are to be forwarded to the given host and port, or Unix socket,
374on the remote side.
375This works by allocating a socket to listen to either a TCP
376.Ar port
377on the local side, optionally bound to the specified
378.Ar bind_address ,
379or to a Unix socket.
380Whenever a connection is made to the local port or socket, the
381connection is forwarded over the secure channel, and a connection is
382made to either
383.Ar host
384port
385.Ar hostport ,
386or the Unix socket
387.Ar remote_socket ,
388from the remote machine.
389.Pp
390Port forwardings can also be specified in the configuration file.
391Only the superuser can forward privileged ports.
392IPv6 addresses can be specified by enclosing the address in square brackets.
393.Pp
394By default, the local port is bound in accordance with the
395.Cm GatewayPorts
396setting.
397However, an explicit
398.Ar bind_address
399may be used to bind the connection to a specific address.
400The
401.Ar bind_address
402of
403.Dq localhost
404indicates that the listening port be bound for local use only, while an
405empty address or
406.Sq *
407indicates that the port should be available from all interfaces.
408.Pp
409.It Fl l Ar login_name
410Specifies the user to log in as on the remote machine.
411This also may be specified on a per-host basis in the configuration file.
412.Pp
413.It Fl M
414Places the
415.Nm
416client into
417.Dq master
418mode for connection sharing.
419Multiple
420.Fl M
421options places
422.Nm
423into
424.Dq master
425mode but with confirmation required using
426.Xr ssh-askpass 1
427before each operation that changes the multiplexing state
428(e.g. opening a new session).
429Refer to the description of
430.Cm ControlMaster
431in
432.Xr ssh_config 5
433for details.
434.Pp
435.It Fl m Ar mac_spec
436A comma-separated list of MAC (message authentication code) algorithms,
437specified in order of preference.
438See the
439.Cm MACs
440keyword in
441.Xr ssh_config 5
442for more information.
443.Pp
444.It Fl N
445Do not execute a remote command.
446This is useful for just forwarding ports.
447Refer to the description of
448.Cm SessionType
449in
450.Xr ssh_config 5
451for details.
452.Pp
453.It Fl n
454Redirects stdin from
455.Pa /dev/null
456(actually, prevents reading from stdin).
457This must be used when
458.Nm
459is run in the background.
460A common trick is to use this to run X11 programs on a remote machine.
461For example,
462.Ic ssh -n shadows.cs.hut.fi emacs &
463will start an emacs on shadows.cs.hut.fi, and the X11
464connection will be automatically forwarded over an encrypted channel.
465The
466.Nm
467program will be put in the background.
468(This does not work if
469.Nm
470needs to ask for a password or passphrase; see also the
471.Fl f
472option.)
473Refer to the description of
474.Cm StdinNull
475in
476.Xr ssh_config 5
477for details.
478.Pp
479.It Fl O Ar ctl_cmd
480Control an active connection multiplexing master process.
481When the
482.Fl O
483option is specified, the
484.Ar ctl_cmd
485argument is interpreted and passed to the master process.
486Valid commands are:
487.Dq check
488(check that the master process is running),
489.Dq forward
490(request forwardings without command execution),
491.Dq cancel
492(cancel forwardings),
493.Dq exit
494(request the master to exit), and
495.Dq stop
496(request the master to stop accepting further multiplexing requests).
497.Pp
498.It Fl o Ar option
499Can be used to give options in the format used in the configuration file.
500This is useful for specifying options for which there is no separate
501command-line flag.
502For full details of the options listed below, and their possible values, see
503.Xr ssh_config 5 .
504.Pp
505.Bl -tag -width Ds -offset indent -compact
506.It AddKeysToAgent
507.It AddressFamily
508.It BatchMode
509.It BindAddress
510.It CanonicalDomains
511.It CanonicalizeFallbackLocal
512.It CanonicalizeHostname
513.It CanonicalizeMaxDots
514.It CanonicalizePermittedCNAMEs
515.It CASignatureAlgorithms
516.It CertificateFile
517.It CheckHostIP
518.It Ciphers
519.It ClearAllForwardings
520.It Compression
521.It ConnectionAttempts
522.It ConnectTimeout
523.It ControlMaster
524.It ControlPath
525.It ControlPersist
526.It DynamicForward
527.It EnableEscapeCommandline
528.It EscapeChar
529.It ExitOnForwardFailure
530.It FingerprintHash
531.It ForkAfterAuthentication
532.It ForwardAgent
533.It ForwardX11
534.It ForwardX11Timeout
535.It ForwardX11Trusted
536.It GatewayPorts
537.It GlobalKnownHostsFile
538.It GSSAPIAuthentication
539.It GSSAPIDelegateCredentials
540.It HashKnownHosts
541.It Host
542.It HostbasedAcceptedAlgorithms
543.It HostbasedAuthentication
544.It HostKeyAlgorithms
545.It HostKeyAlias
546.It Hostname
547.It IdentitiesOnly
548.It IdentityAgent
549.It IdentityFile
550.It IPQoS
551.It KbdInteractiveAuthentication
552.It KbdInteractiveDevices
553.It KexAlgorithms
554.It KnownHostsCommand
555.It LocalCommand
556.It LocalForward
557.It LogLevel
558.It MACs
559.It Match
560.It NoHostAuthenticationForLocalhost
561.It NumberOfPasswordPrompts
562.It PasswordAuthentication
563.It PermitLocalCommand
564.It PermitRemoteOpen
565.It PKCS11Provider
566.It Port
567.It PreferredAuthentications
568.It ProxyCommand
569.It ProxyJump
570.It ProxyUseFdpass
571.It PubkeyAcceptedAlgorithms
572.It PubkeyAuthentication
573.It RekeyLimit
574.It RemoteCommand
575.It RemoteForward
576.It RequestTTY
577.It RequiredRSASize
578.It SendEnv
579.It ServerAliveInterval
580.It ServerAliveCountMax
581.It SessionType
582.It SetEnv
583.It StdinNull
584.It StreamLocalBindMask
585.It StreamLocalBindUnlink
586.It StrictHostKeyChecking
587.It TCPKeepAlive
588.It Tunnel
589.It TunnelDevice
590.It UpdateHostKeys
591.It User
592.It UserKnownHostsFile
593.It VerifyHostKeyDNS
594.It VisualHostKey
595.It XAuthLocation
596.El
597.Pp
598.It Fl P Ar tag
599Specify a tag name that may be used to select configuration in
600.Xr ssh_config 5 .
601Refer to the
602.Cm Tag
603and
604.Cm Match
605keywords in
606.Xr ssh_config 5
607for more information.
608.It Fl p Ar port
609Port to connect to on the remote host.
610This can be specified on a
611per-host basis in the configuration file.
612.Pp
613.It Fl Q Ar query_option
614Queries for the algorithms supported by one of the following features:
615.Ar cipher
616(supported symmetric ciphers),
617.Ar cipher-auth
618(supported symmetric ciphers that support authenticated encryption),
619.Ar help
620(supported query terms for use with the
621.Fl Q
622flag),
623.Ar mac
624(supported message integrity codes),
625.Ar kex
626(key exchange algorithms),
627.Ar key
628(key types),
629.Ar key-ca-sign
630(valid CA signature algorithms for certificates),
631.Ar key-cert
632(certificate key types),
633.Ar key-plain
634(non-certificate key types),
635.Ar key-sig
636(all key types and signature algorithms),
637.Ar protocol-version
638(supported SSH protocol versions), and
639.Ar sig
640(supported signature algorithms).
641Alternatively, any keyword from
642.Xr ssh_config 5
643or
644.Xr sshd_config 5
645that takes an algorithm list may be used as an alias for the corresponding
646query_option.
647.Pp
648.It Fl q
649Quiet mode.
650Causes most warning and diagnostic messages to be suppressed.
651.Pp
652.It Fl R Xo
653.Sm off
654.Oo Ar bind_address : Oc
655.Ar port : host : hostport
656.Sm on
657.Xc
658.It Fl R Xo
659.Sm off
660.Oo Ar bind_address : Oc
661.Ar port : local_socket
662.Sm on
663.Xc
664.It Fl R Xo
665.Sm off
666.Ar remote_socket : host : hostport
667.Sm on
668.Xc
669.It Fl R Xo
670.Sm off
671.Ar remote_socket : local_socket
672.Sm on
673.Xc
674.It Fl R Xo
675.Sm off
676.Oo Ar bind_address : Oc
677.Ar port
678.Sm on
679.Xc
680Specifies that connections to the given TCP port or Unix socket on the remote
681(server) host are to be forwarded to the local side.
682.Pp
683This works by allocating a socket to listen to either a TCP
684.Ar port
685or to a Unix socket on the remote side.
686Whenever a connection is made to this port or Unix socket, the
687connection is forwarded over the secure channel, and a connection
688is made from the local machine to either an explicit destination specified by
689.Ar host
690port
691.Ar hostport ,
692or
693.Ar local_socket ,
694or, if no explicit destination was specified,
695.Nm
696will act as a SOCKS 4/5 proxy and forward connections to the destinations
697requested by the remote SOCKS client.
698.Pp
699Port forwardings can also be specified in the configuration file.
700Privileged ports can be forwarded only when
701logging in as root on the remote machine.
702IPv6 addresses can be specified by enclosing the address in square brackets.
703.Pp
704By default, TCP listening sockets on the server will be bound to the loopback
705interface only.
706This may be overridden by specifying a
707.Ar bind_address .
708An empty
709.Ar bind_address ,
710or the address
711.Ql * ,
712indicates that the remote socket should listen on all interfaces.
713Specifying a remote
714.Ar bind_address
715will only succeed if the server's
716.Cm GatewayPorts
717option is enabled (see
718.Xr sshd_config 5 ) .
719.Pp
720If the
721.Ar port
722argument is
723.Ql 0 ,
724the listen port will be dynamically allocated on the server and reported
725to the client at run time.
726When used together with
727.Ic -O forward ,
728the allocated port will be printed to the standard output.
729.Pp
730.It Fl S Ar ctl_path
731Specifies the location of a control socket for connection sharing,
732or the string
733.Dq none
734to disable connection sharing.
735Refer to the description of
736.Cm ControlPath
737and
738.Cm ControlMaster
739in
740.Xr ssh_config 5
741for details.
742.Pp
743.It Fl s
744May be used to request invocation of a subsystem on the remote system.
745Subsystems facilitate the use of SSH
746as a secure transport for other applications (e.g.\&
747.Xr sftp 1 ) .
748The subsystem is specified as the remote command.
749Refer to the description of
750.Cm SessionType
751in
752.Xr ssh_config 5
753for details.
754.Pp
755.It Fl T
756Disable pseudo-terminal allocation.
757.Pp
758.It Fl t
759Force pseudo-terminal allocation.
760This can be used to execute arbitrary
761screen-based programs on a remote machine, which can be very useful,
762e.g. when implementing menu services.
763Multiple
764.Fl t
765options force tty allocation, even if
766.Nm
767has no local tty.
768.Pp
769.It Fl V
770Display the version number and exit.
771.Pp
772.It Fl v
773Verbose mode.
774Causes
775.Nm
776to print debugging messages about its progress.
777This is helpful in
778debugging connection, authentication, and configuration problems.
779Multiple
780.Fl v
781options increase the verbosity.
782The maximum is 3.
783.Pp
784.It Fl W Ar host : Ns Ar port
785Requests that standard input and output on the client be forwarded to
786.Ar host
787on
788.Ar port
789over the secure channel.
790Implies
791.Fl N ,
792.Fl T ,
793.Cm ExitOnForwardFailure
794and
795.Cm ClearAllForwardings ,
796though these can be overridden in the configuration file or using
797.Fl o
798command line options.
799.Pp
800.It Fl w Xo
801.Ar local_tun Ns Op : Ns Ar remote_tun
802.Xc
803Requests
804tunnel
805device forwarding with the specified
806.Xr tun 4
807devices between the client
808.Pq Ar local_tun
809and the server
810.Pq Ar remote_tun .
811.Pp
812The devices may be specified by numerical ID or the keyword
813.Dq any ,
814which uses the next available tunnel device.
815If
816.Ar remote_tun
817is not specified, it defaults to
818.Dq any .
819See also the
820.Cm Tunnel
821and
822.Cm TunnelDevice
823directives in
824.Xr ssh_config 5 .
825.Pp
826If the
827.Cm Tunnel
828directive is unset, it will be set to the default tunnel mode, which is
829.Dq point-to-point .
830If a different
831.Cm Tunnel
832forwarding mode it desired, then it should be specified before
833.Fl w .
834.Pp
835.It Fl X
836Enables X11 forwarding.
837This can also be specified on a per-host basis in a configuration file.
838.Pp
839X11 forwarding should be enabled with caution.
840Users with the ability to bypass file permissions on the remote host
841(for the user's X authorization database)
842can access the local X11 display through the forwarded connection.
843An attacker may then be able to perform activities such as keystroke monitoring.
844.Pp
845For this reason, X11 forwarding is subjected to X11 SECURITY extension
846restrictions by default.
847Refer to the
848.Nm
849.Fl Y
850option and the
851.Cm ForwardX11Trusted
852directive in
853.Xr ssh_config 5
854for more information.
855.Pp
856.It Fl x
857Disables X11 forwarding.
858.Pp
859.It Fl Y
860Enables trusted X11 forwarding.
861Trusted X11 forwardings are not subjected to the X11 SECURITY extension
862controls.
863.Pp
864.It Fl y
865Send log information using the
866.Xr syslog 3
867system module.
868By default this information is sent to stderr.
869.El
870.Pp
871.Nm
872may additionally obtain configuration data from
873a per-user configuration file and a system-wide configuration file.
874The file format and configuration options are described in
875.Xr ssh_config 5 .
876.Sh AUTHENTICATION
877The OpenSSH SSH client supports SSH protocol 2.
878.Pp
879The methods available for authentication are:
880GSSAPI-based authentication,
881host-based authentication,
882public key authentication,
883keyboard-interactive authentication,
884and password authentication.
885Authentication methods are tried in the order specified above,
886though
887.Cm PreferredAuthentications
888can be used to change the default order.
889.Pp
890Host-based authentication works as follows:
891If the machine the user logs in from is listed in
892.Pa /etc/hosts.equiv
893or
894.Pa /etc/shosts.equiv
895on the remote machine, the user is non-root and the user names are
896the same on both sides, or if the files
897.Pa ~/.rhosts
898or
899.Pa ~/.shosts
900exist in the user's home directory on the
901remote machine and contain a line containing the name of the client
902machine and the name of the user on that machine, the user is
903considered for login.
904Additionally, the server
905.Em must
906be able to verify the client's
907host key (see the description of
908.Pa /etc/ssh/ssh_known_hosts
909and
910.Pa ~/.ssh/known_hosts ,
911below)
912for login to be permitted.
913This authentication method closes security holes due to IP
914spoofing, DNS spoofing, and routing spoofing.
915[Note to the administrator:
916.Pa /etc/hosts.equiv ,
917.Pa ~/.rhosts ,
918and the rlogin/rsh protocol in general, are inherently insecure and should be
919disabled if security is desired.]
920.Pp
921Public key authentication works as follows:
922The scheme is based on public-key cryptography,
923using cryptosystems
924where encryption and decryption are done using separate keys,
925and it is unfeasible to derive the decryption key from the encryption key.
926The idea is that each user creates a public/private
927key pair for authentication purposes.
928The server knows the public key, and only the user knows the private key.
929.Nm
930implements public key authentication protocol automatically,
931using one of the DSA, ECDSA, Ed25519 or RSA algorithms.
932The HISTORY section of
933.Xr ssl 8
934contains a brief discussion of the DSA and RSA algorithms.
935.Pp
936The file
937.Pa ~/.ssh/authorized_keys
938lists the public keys that are permitted for logging in.
939When the user logs in, the
940.Nm
941program tells the server which key pair it would like to use for
942authentication.
943The client proves that it has access to the private key
944and the server checks that the corresponding public key
945is authorized to accept the account.
946.Pp
947The server may inform the client of errors that prevented public key
948authentication from succeeding after authentication completes using a
949different method.
950These may be viewed by increasing the
951.Cm LogLevel
952to
953.Cm DEBUG
954or higher (e.g. by using the
955.Fl v
956flag).
957.Pp
958The user creates their key pair by running
959.Xr ssh-keygen 1 .
960This stores the private key in
961.Pa ~/.ssh/id_dsa
962(DSA),
963.Pa ~/.ssh/id_ecdsa
964(ECDSA),
965.Pa ~/.ssh/id_ecdsa_sk
966(authenticator-hosted ECDSA),
967.Pa ~/.ssh/id_ed25519
968(Ed25519),
969.Pa ~/.ssh/id_ed25519_sk
970(authenticator-hosted Ed25519),
971or
972.Pa ~/.ssh/id_rsa
973(RSA)
974and stores the public key in
975.Pa ~/.ssh/id_dsa.pub
976(DSA),
977.Pa ~/.ssh/id_ecdsa.pub
978(ECDSA),
979.Pa ~/.ssh/id_ecdsa_sk.pub
980(authenticator-hosted ECDSA),
981.Pa ~/.ssh/id_ed25519.pub
982(Ed25519),
983.Pa ~/.ssh/id_ed25519_sk.pub
984(authenticator-hosted Ed25519),
985or
986.Pa ~/.ssh/id_rsa.pub
987(RSA)
988in the user's home directory.
989The user should then copy the public key
990to
991.Pa ~/.ssh/authorized_keys
992in their home directory on the remote machine.
993The
994.Pa authorized_keys
995file corresponds to the conventional
996.Pa ~/.rhosts
997file, and has one key
998per line, though the lines can be very long.
999After this, the user can log in without giving the password.
1000.Pp
1001A variation on public key authentication
1002is available in the form of certificate authentication:
1003instead of a set of public/private keys,
1004signed certificates are used.
1005This has the advantage that a single trusted certification authority
1006can be used in place of many public/private keys.
1007See the CERTIFICATES section of
1008.Xr ssh-keygen 1
1009for more information.
1010.Pp
1011The most convenient way to use public key or certificate authentication
1012may be with an authentication agent.
1013See
1014.Xr ssh-agent 1
1015and (optionally) the
1016.Cm AddKeysToAgent
1017directive in
1018.Xr ssh_config 5
1019for more information.
1020.Pp
1021Keyboard-interactive authentication works as follows:
1022The server sends an arbitrary
1023.Qq challenge
1024text and prompts for a response, possibly multiple times.
1025Examples of keyboard-interactive authentication include
1026.Bx
1027Authentication (see
1028.Xr login.conf 5 )
1029and PAM (some
1030.Pf non- Ox
1031systems).
1032.Pp
1033Finally, if other authentication methods fail,
1034.Nm
1035prompts the user for a password.
1036The password is sent to the remote
1037host for checking; however, since all communications are encrypted,
1038the password cannot be seen by someone listening on the network.
1039.Pp
1040.Nm
1041automatically maintains and checks a database containing
1042identification for all hosts it has ever been used with.
1043Host keys are stored in
1044.Pa ~/.ssh/known_hosts
1045in the user's home directory.
1046Additionally, the file
1047.Pa /etc/ssh/ssh_known_hosts
1048is automatically checked for known hosts.
1049Any new hosts are automatically added to the user's file.
1050If a host's identification ever changes,
1051.Nm
1052warns about this and disables password authentication to prevent
1053server spoofing or man-in-the-middle attacks,
1054which could otherwise be used to circumvent the encryption.
1055The
1056.Cm StrictHostKeyChecking
1057option can be used to control logins to machines whose
1058host key is not known or has changed.
1059.Pp
1060When the user's identity has been accepted by the server, the server
1061either executes the given command in a non-interactive session or,
1062if no command has been specified, logs into the machine and gives
1063the user a normal shell as an interactive session.
1064All communication with
1065the remote command or shell will be automatically encrypted.
1066.Pp
1067If an interactive session is requested,
1068.Nm
1069by default will only request a pseudo-terminal (pty) for interactive
1070sessions when the client has one.
1071The flags
1072.Fl T
1073and
1074.Fl t
1075can be used to override this behaviour.
1076.Pp
1077If a pseudo-terminal has been allocated, the
1078user may use the escape characters noted below.
1079.Pp
1080If no pseudo-terminal has been allocated,
1081the session is transparent and can be used to reliably transfer binary data.
1082On most systems, setting the escape character to
1083.Dq none
1084will also make the session transparent even if a tty is used.
1085.Pp
1086The session terminates when the command or shell on the remote
1087machine exits and all X11 and TCP connections have been closed.
1088.Sh ESCAPE CHARACTERS
1089When a pseudo-terminal has been requested,
1090.Nm
1091supports a number of functions through the use of an escape character.
1092.Pp
1093A single tilde character can be sent as
1094.Ic ~~
1095or by following the tilde by a character other than those described below.
1096The escape character must always follow a newline to be interpreted as
1097special.
1098The escape character can be changed in configuration files using the
1099.Cm EscapeChar
1100configuration directive or on the command line by the
1101.Fl e
1102option.
1103.Pp
1104The supported escapes (assuming the default
1105.Ql ~ )
1106are:
1107.Bl -tag -width Ds
1108.It Cm ~.
1109Disconnect.
1110.It Cm ~^Z
1111Background
1112.Nm .
1113.It Cm ~#
1114List forwarded connections.
1115.It Cm ~&
1116Background
1117.Nm
1118at logout when waiting for forwarded connection / X11 sessions to terminate.
1119.It Cm ~?
1120Display a list of escape characters.
1121.It Cm ~B
1122Send a BREAK to the remote system
1123(only useful if the peer supports it).
1124.It Cm ~C
1125Open command line.
1126Currently this allows the addition of port forwardings using the
1127.Fl L ,
1128.Fl R
1129and
1130.Fl D
1131options (see above).
1132It also allows the cancellation of existing port-forwardings
1133with
1134.Sm off
1135.Fl KL Oo Ar bind_address : Oc Ar port
1136.Sm on
1137for local,
1138.Sm off
1139.Fl KR Oo Ar bind_address : Oc Ar port
1140.Sm on
1141for remote and
1142.Sm off
1143.Fl KD Oo Ar bind_address : Oc Ar port
1144.Sm on
1145for dynamic port-forwardings.
1146.Ic !\& Ns Ar command
1147allows the user to execute a local command if the
1148.Ic PermitLocalCommand
1149option is enabled in
1150.Xr ssh_config 5 .
1151Basic help is available, using the
1152.Fl h
1153option.
1154.It Cm ~R
1155Request rekeying of the connection
1156(only useful if the peer supports it).
1157.It Cm ~V
1158Decrease the verbosity
1159.Pq Ic LogLevel
1160when errors are being written to stderr.
1161.It Cm ~v
1162Increase the verbosity
1163.Pq Ic LogLevel
1164when errors are being written to stderr.
1165.El
1166.Sh TCP FORWARDING
1167Forwarding of arbitrary TCP connections over a secure channel
1168can be specified either on the command line or in a configuration file.
1169One possible application of TCP forwarding is a secure connection to a
1170mail server; another is going through firewalls.
1171.Pp
1172In the example below, we look at encrypting communication for an IRC client,
1173even though the IRC server it connects to does not directly
1174support encrypted communication.
1175This works as follows:
1176the user connects to the remote host using
1177.Nm ,
1178specifying the ports to be used to forward the connection.
1179After that it is possible to start the program locally,
1180and
1181.Nm
1182will encrypt and forward the connection to the remote server.
1183.Pp
1184The following example tunnels an IRC session from the client
1185to an IRC server at
1186.Dq server.example.com ,
1187joining channel
1188.Dq #users ,
1189nickname
1190.Dq pinky ,
1191using the standard IRC port, 6667:
1192.Bd -literal -offset 4n
1193$ ssh -f -L 6667:localhost:6667 server.example.com sleep 10
1194$ irc -c '#users' pinky IRC/127.0.0.1
1195.Ed
1196.Pp
1197The
1198.Fl f
1199option backgrounds
1200.Nm
1201and the remote command
1202.Dq sleep 10
1203is specified to allow an amount of time
1204(10 seconds, in the example)
1205to start the program which is going to use the tunnel.
1206If no connections are made within the time specified,
1207.Nm
1208will exit.
1209.Sh X11 FORWARDING
1210If the
1211.Cm ForwardX11
1212variable is set to
1213.Dq yes
1214(or see the description of the
1215.Fl X ,
1216.Fl x ,
1217and
1218.Fl Y
1219options above)
1220and the user is using X11 (the
1221.Ev DISPLAY
1222environment variable is set), the connection to the X11 display is
1223automatically forwarded to the remote side in such a way that any X11
1224programs started from the shell (or command) will go through the
1225encrypted channel, and the connection to the real X server will be made
1226from the local machine.
1227The user should not manually set
1228.Ev DISPLAY .
1229Forwarding of X11 connections can be
1230configured on the command line or in configuration files.
1231.Pp
1232The
1233.Ev DISPLAY
1234value set by
1235.Nm
1236will point to the server machine, but with a display number greater than zero.
1237This is normal, and happens because
1238.Nm
1239creates a
1240.Dq proxy
1241X server on the server machine for forwarding the
1242connections over the encrypted channel.
1243.Pp
1244.Nm
1245will also automatically set up Xauthority data on the server machine.
1246For this purpose, it will generate a random authorization cookie,
1247store it in Xauthority on the server, and verify that any forwarded
1248connections carry this cookie and replace it by the real cookie when
1249the connection is opened.
1250The real authentication cookie is never
1251sent to the server machine (and no cookies are sent in the plain).
1252.Pp
1253If the
1254.Cm ForwardAgent
1255variable is set to
1256.Dq yes
1257(or see the description of the
1258.Fl A
1259and
1260.Fl a
1261options above) and
1262the user is using an authentication agent, the connection to the agent
1263is automatically forwarded to the remote side.
1264.Sh VERIFYING HOST KEYS
1265When connecting to a server for the first time,
1266a fingerprint of the server's public key is presented to the user
1267(unless the option
1268.Cm StrictHostKeyChecking
1269has been disabled).
1270Fingerprints can be determined using
1271.Xr ssh-keygen 1 :
1272.Pp
1273.Dl $ ssh-keygen -l -f /etc/ssh/ssh_host_rsa_key
1274.Pp
1275If the fingerprint is already known, it can be matched
1276and the key can be accepted or rejected.
1277If only legacy (MD5) fingerprints for the server are available, the
1278.Xr ssh-keygen 1
1279.Fl E
1280option may be used to downgrade the fingerprint algorithm to match.
1281.Pp
1282Because of the difficulty of comparing host keys
1283just by looking at fingerprint strings,
1284there is also support to compare host keys visually,
1285using
1286.Em random art .
1287By setting the
1288.Cm VisualHostKey
1289option to
1290.Dq yes ,
1291a small ASCII graphic gets displayed on every login to a server, no matter
1292if the session itself is interactive or not.
1293By learning the pattern a known server produces, a user can easily
1294find out that the host key has changed when a completely different pattern
1295is displayed.
1296Because these patterns are not unambiguous however, a pattern that looks
1297similar to the pattern remembered only gives a good probability that the
1298host key is the same, not guaranteed proof.
1299.Pp
1300To get a listing of the fingerprints along with their random art for
1301all known hosts, the following command line can be used:
1302.Pp
1303.Dl $ ssh-keygen -lv -f ~/.ssh/known_hosts
1304.Pp
1305If the fingerprint is unknown,
1306an alternative method of verification is available:
1307SSH fingerprints verified by DNS.
1308An additional resource record (RR),
1309SSHFP,
1310is added to a zonefile
1311and the connecting client is able to match the fingerprint
1312with that of the key presented.
1313.Pp
1314In this example, we are connecting a client to a server,
1315.Dq host.example.com .
1316The SSHFP resource records should first be added to the zonefile for
1317host.example.com:
1318.Bd -literal -offset indent
1319$ ssh-keygen -r host.example.com.
1320.Ed
1321.Pp
1322The output lines will have to be added to the zonefile.
1323To check that the zone is answering fingerprint queries:
1324.Pp
1325.Dl $ dig -t SSHFP host.example.com
1326.Pp
1327Finally the client connects:
1328.Bd -literal -offset indent
1329$ ssh -o "VerifyHostKeyDNS ask" host.example.com
1330[...]
1331Matching host key fingerprint found in DNS.
1332Are you sure you want to continue connecting (yes/no)?
1333.Ed
1334.Pp
1335See the
1336.Cm VerifyHostKeyDNS
1337option in
1338.Xr ssh_config 5
1339for more information.
1340.Sh SSH-BASED VIRTUAL PRIVATE NETWORKS
1341.Nm
1342contains support for Virtual Private Network (VPN) tunnelling
1343using the
1344.Xr tun 4
1345network pseudo-device,
1346allowing two networks to be joined securely.
1347The
1348.Xr sshd_config 5
1349configuration option
1350.Cm PermitTunnel
1351controls whether the server supports this,
1352and at what level (layer 2 or 3 traffic).
1353.Pp
1354The following example would connect client network 10.0.50.0/24
1355with remote network 10.0.99.0/24 using a point-to-point connection
1356from 10.1.1.1 to 10.1.1.2,
1357provided that the SSH server running on the gateway to the remote network,
1358at 192.168.1.15, allows it.
1359.Pp
1360On the client:
1361.Bd -literal -offset indent
1362# ssh -f -w 0:1 192.168.1.15 true
1363# ifconfig tun0 10.1.1.1 10.1.1.2 netmask 255.255.255.252
1364# route add 10.0.99.0/24 10.1.1.2
1365.Ed
1366.Pp
1367On the server:
1368.Bd -literal -offset indent
1369# ifconfig tun1 10.1.1.2 10.1.1.1 netmask 255.255.255.252
1370# route add 10.0.50.0/24 10.1.1.1
1371.Ed
1372.Pp
1373Client access may be more finely tuned via the
1374.Pa /root/.ssh/authorized_keys
1375file (see below) and the
1376.Cm PermitRootLogin
1377server option.
1378The following entry would permit connections on
1379.Xr tun 4
1380device 1 from user
1381.Dq jane
1382and on tun device 2 from user
1383.Dq john ,
1384if
1385.Cm PermitRootLogin
1386is set to
1387.Dq forced-commands-only :
1388.Bd -literal -offset 2n
1389tunnel="1",command="sh /etc/netstart tun1" ssh-rsa ... jane
1390tunnel="2",command="sh /etc/netstart tun2" ssh-rsa ... john
1391.Ed
1392.Pp
1393Since an SSH-based setup entails a fair amount of overhead,
1394it may be more suited to temporary setups,
1395such as for wireless VPNs.
1396More permanent VPNs are better provided by tools such as
1397.Xr ipsecctl 8
1398and
1399.Xr isakmpd 8 .
1400.Sh ENVIRONMENT
1401.Nm
1402will normally set the following environment variables:
1403.Bl -tag -width "SSH_ORIGINAL_COMMAND"
1404.It Ev DISPLAY
1405The
1406.Ev DISPLAY
1407variable indicates the location of the X11 server.
1408It is automatically set by
1409.Nm
1410to point to a value of the form
1411.Dq hostname:n ,
1412where
1413.Dq hostname
1414indicates the host where the shell runs, and
1415.Sq n
1416is an integer \*(Ge 1.
1417.Nm
1418uses this special value to forward X11 connections over the secure
1419channel.
1420The user should normally not set
1421.Ev DISPLAY
1422explicitly, as that
1423will render the X11 connection insecure (and will require the user to
1424manually copy any required authorization cookies).
1425.It Ev HOME
1426Set to the path of the user's home directory.
1427.It Ev LOGNAME
1428Synonym for
1429.Ev USER ;
1430set for compatibility with systems that use this variable.
1431.It Ev MAIL
1432Set to the path of the user's mailbox.
1433.It Ev PATH
1434Set to the default
1435.Ev PATH ,
1436as specified when compiling
1437.Nm .
1438.It Ev SSH_ASKPASS
1439If
1440.Nm
1441needs a passphrase, it will read the passphrase from the current
1442terminal if it was run from a terminal.
1443If
1444.Nm
1445does not have a terminal associated with it but
1446.Ev DISPLAY
1447and
1448.Ev SSH_ASKPASS
1449are set, it will execute the program specified by
1450.Ev SSH_ASKPASS
1451and open an X11 window to read the passphrase.
1452This is particularly useful when calling
1453.Nm
1454from a
1455.Pa .xsession
1456or related script.
1457(Note that on some machines it
1458may be necessary to redirect the input from
1459.Pa /dev/null
1460to make this work.)
1461.It Ev SSH_ASKPASS_REQUIRE
1462Allows further control over the use of an askpass program.
1463If this variable is set to
1464.Dq never
1465then
1466.Nm
1467will never attempt to use one.
1468If it is set to
1469.Dq prefer ,
1470then
1471.Nm
1472will prefer to use the askpass program instead of the TTY when requesting
1473passwords.
1474Finally, if the variable is set to
1475.Dq force ,
1476then the askpass program will be used for all passphrase input regardless
1477of whether
1478.Ev DISPLAY
1479is set.
1480.It Ev SSH_AUTH_SOCK
1481Identifies the path of a
1482.Ux Ns -domain
1483socket used to communicate with the agent.
1484.It Ev SSH_CONNECTION
1485Identifies the client and server ends of the connection.
1486The variable contains
1487four space-separated values: client IP address, client port number,
1488server IP address, and server port number.
1489.It Ev SSH_ORIGINAL_COMMAND
1490This variable contains the original command line if a forced command
1491is executed.
1492It can be used to extract the original arguments.
1493.It Ev SSH_TTY
1494This is set to the name of the tty (path to the device) associated
1495with the current shell or command.
1496If the current session has no tty,
1497this variable is not set.
1498.It Ev SSH_TUNNEL
1499Optionally set by
1500.Xr sshd 8
1501to contain the interface names assigned if tunnel forwarding was
1502requested by the client.
1503.It Ev SSH_USER_AUTH
1504Optionally set by
1505.Xr sshd 8 ,
1506this variable may contain a pathname to a file that lists the authentication
1507methods successfully used when the session was established, including any
1508public keys that were used.
1509.It Ev TZ
1510This variable is set to indicate the present time zone if it
1511was set when the daemon was started (i.e. the daemon passes the value
1512on to new connections).
1513.It Ev USER
1514Set to the name of the user logging in.
1515.El
1516.Pp
1517Additionally,
1518.Nm
1519reads
1520.Pa ~/.ssh/environment ,
1521and adds lines of the format
1522.Dq VARNAME=value
1523to the environment if the file exists and users are allowed to
1524change their environment.
1525For more information, see the
1526.Cm PermitUserEnvironment
1527option in
1528.Xr sshd_config 5 .
1529.Sh FILES
1530.Bl -tag -width Ds -compact
1531.It Pa ~/.rhosts
1532This file is used for host-based authentication (see above).
1533On some machines this file may need to be
1534world-readable if the user's home directory is on an NFS partition,
1535because
1536.Xr sshd 8
1537reads it as root.
1538Additionally, this file must be owned by the user,
1539and must not have write permissions for anyone else.
1540The recommended
1541permission for most machines is read/write for the user, and not
1542accessible by others.
1543.Pp
1544.It Pa ~/.shosts
1545This file is used in exactly the same way as
1546.Pa .rhosts ,
1547but allows host-based authentication without permitting login with
1548rlogin/rsh.
1549.Pp
1550.It Pa ~/.ssh/
1551This directory is the default location for all user-specific configuration
1552and authentication information.
1553There is no general requirement to keep the entire contents of this directory
1554secret, but the recommended permissions are read/write/execute for the user,
1555and not accessible by others.
1556.Pp
1557.It Pa ~/.ssh/authorized_keys
1558Lists the public keys (DSA, ECDSA, Ed25519, RSA)
1559that can be used for logging in as this user.
1560The format of this file is described in the
1561.Xr sshd 8
1562manual page.
1563This file is not highly sensitive, but the recommended
1564permissions are read/write for the user, and not accessible by others.
1565.Pp
1566.It Pa ~/.ssh/config
1567This is the per-user configuration file.
1568The file format and configuration options are described in
1569.Xr ssh_config 5 .
1570Because of the potential for abuse, this file must have strict permissions:
1571read/write for the user, and not writable by others.
1572.Pp
1573.It Pa ~/.ssh/environment
1574Contains additional definitions for environment variables; see
1575.Sx ENVIRONMENT ,
1576above.
1577.Pp
1578.It Pa ~/.ssh/id_dsa
1579.It Pa ~/.ssh/id_ecdsa
1580.It Pa ~/.ssh/id_ecdsa_sk
1581.It Pa ~/.ssh/id_ed25519
1582.It Pa ~/.ssh/id_ed25519_sk
1583.It Pa ~/.ssh/id_rsa
1584Contains the private key for authentication.
1585These files
1586contain sensitive data and should be readable by the user but not
1587accessible by others (read/write/execute).
1588.Nm
1589will simply ignore a private key file if it is accessible by others.
1590It is possible to specify a passphrase when
1591generating the key which will be used to encrypt the
1592sensitive part of this file using AES-128.
1593.Pp
1594.It Pa ~/.ssh/id_dsa.pub
1595.It Pa ~/.ssh/id_ecdsa.pub
1596.It Pa ~/.ssh/id_ecdsa_sk.pub
1597.It Pa ~/.ssh/id_ed25519.pub
1598.It Pa ~/.ssh/id_ed25519_sk.pub
1599.It Pa ~/.ssh/id_rsa.pub
1600Contains the public key for authentication.
1601These files are not
1602sensitive and can (but need not) be readable by anyone.
1603.Pp
1604.It Pa ~/.ssh/known_hosts
1605Contains a list of host keys for all hosts the user has logged into
1606that are not already in the systemwide list of known host keys.
1607See
1608.Xr sshd 8
1609for further details of the format of this file.
1610.Pp
1611.It Pa ~/.ssh/rc
1612Commands in this file are executed by
1613.Nm
1614when the user logs in, just before the user's shell (or command) is
1615started.
1616See the
1617.Xr sshd 8
1618manual page for more information.
1619.Pp
1620.It Pa /etc/hosts.equiv
1621This file is for host-based authentication (see above).
1622It should only be writable by root.
1623.Pp
1624.It Pa /etc/shosts.equiv
1625This file is used in exactly the same way as
1626.Pa hosts.equiv ,
1627but allows host-based authentication without permitting login with
1628rlogin/rsh.
1629.Pp
1630.It Pa /etc/ssh/ssh_config
1631Systemwide configuration file.
1632The file format and configuration options are described in
1633.Xr ssh_config 5 .
1634.Pp
1635.It Pa /etc/ssh/ssh_host_key
1636.It Pa /etc/ssh/ssh_host_dsa_key
1637.It Pa /etc/ssh/ssh_host_ecdsa_key
1638.It Pa /etc/ssh/ssh_host_ed25519_key
1639.It Pa /etc/ssh/ssh_host_rsa_key
1640These files contain the private parts of the host keys
1641and are used for host-based authentication.
1642.Pp
1643.It Pa /etc/ssh/ssh_known_hosts
1644Systemwide list of known host keys.
1645This file should be prepared by the
1646system administrator to contain the public host keys of all machines in the
1647organization.
1648It should be world-readable.
1649See
1650.Xr sshd 8
1651for further details of the format of this file.
1652.Pp
1653.It Pa /etc/ssh/sshrc
1654Commands in this file are executed by
1655.Nm
1656when the user logs in, just before the user's shell (or command) is started.
1657See the
1658.Xr sshd 8
1659manual page for more information.
1660.El
1661.Sh EXIT STATUS
1662.Nm
1663exits with the exit status of the remote command or with 255
1664if an error occurred.
1665.Sh SEE ALSO
1666.Xr scp 1 ,
1667.Xr sftp 1 ,
1668.Xr ssh-add 1 ,
1669.Xr ssh-agent 1 ,
1670.Xr ssh-keygen 1 ,
1671.Xr ssh-keyscan 1 ,
1672.Xr tun 4 ,
1673.Xr ssh_config 5 ,
1674.Xr ssh-keysign 8 ,
1675.Xr sshd 8
1676.Sh STANDARDS
1677.Rs
1678.%A S. Lehtinen
1679.%A C. Lonvick
1680.%D January 2006
1681.%R RFC 4250
1682.%T The Secure Shell (SSH) Protocol Assigned Numbers
1683.Re
1684.Pp
1685.Rs
1686.%A T. Ylonen
1687.%A C. Lonvick
1688.%D January 2006
1689.%R RFC 4251
1690.%T The Secure Shell (SSH) Protocol Architecture
1691.Re
1692.Pp
1693.Rs
1694.%A T. Ylonen
1695.%A C. Lonvick
1696.%D January 2006
1697.%R RFC 4252
1698.%T The Secure Shell (SSH) Authentication Protocol
1699.Re
1700.Pp
1701.Rs
1702.%A T. Ylonen
1703.%A C. Lonvick
1704.%D January 2006
1705.%R RFC 4253
1706.%T The Secure Shell (SSH) Transport Layer Protocol
1707.Re
1708.Pp
1709.Rs
1710.%A T. Ylonen
1711.%A C. Lonvick
1712.%D January 2006
1713.%R RFC 4254
1714.%T The Secure Shell (SSH) Connection Protocol
1715.Re
1716.Pp
1717.Rs
1718.%A J. Schlyter
1719.%A W. Griffin
1720.%D January 2006
1721.%R RFC 4255
1722.%T Using DNS to Securely Publish Secure Shell (SSH) Key Fingerprints
1723.Re
1724.Pp
1725.Rs
1726.%A F. Cusack
1727.%A M. Forssen
1728.%D January 2006
1729.%R RFC 4256
1730.%T Generic Message Exchange Authentication for the Secure Shell Protocol (SSH)
1731.Re
1732.Pp
1733.Rs
1734.%A J. Galbraith
1735.%A P. Remaker
1736.%D January 2006
1737.%R RFC 4335
1738.%T The Secure Shell (SSH) Session Channel Break Extension
1739.Re
1740.Pp
1741.Rs
1742.%A M. Bellare
1743.%A T. Kohno
1744.%A C. Namprempre
1745.%D January 2006
1746.%R RFC 4344
1747.%T The Secure Shell (SSH) Transport Layer Encryption Modes
1748.Re
1749.Pp
1750.Rs
1751.%A B. Harris
1752.%D January 2006
1753.%R RFC 4345
1754.%T Improved Arcfour Modes for the Secure Shell (SSH) Transport Layer Protocol
1755.Re
1756.Pp
1757.Rs
1758.%A M. Friedl
1759.%A N. Provos
1760.%A W. Simpson
1761.%D March 2006
1762.%R RFC 4419
1763.%T Diffie-Hellman Group Exchange for the Secure Shell (SSH) Transport Layer Protocol
1764.Re
1765.Pp
1766.Rs
1767.%A J. Galbraith
1768.%A R. Thayer
1769.%D November 2006
1770.%R RFC 4716
1771.%T The Secure Shell (SSH) Public Key File Format
1772.Re
1773.Pp
1774.Rs
1775.%A D. Stebila
1776.%A J. Green
1777.%D December 2009
1778.%R RFC 5656
1779.%T Elliptic Curve Algorithm Integration in the Secure Shell Transport Layer
1780.Re
1781.Pp
1782.Rs
1783.%A A. Perrig
1784.%A D. Song
1785.%D 1999
1786.%O International Workshop on Cryptographic Techniques and E-Commerce (CrypTEC '99)
1787.%T Hash Visualization: a New Technique to improve Real-World Security
1788.Re
1789.Sh AUTHORS
1790OpenSSH is a derivative of the original and free
1791ssh 1.2.12 release by Tatu Ylonen.
1792Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1793Theo de Raadt and Dug Song
1794removed many bugs, re-added newer features and
1795created OpenSSH.
1796Markus Friedl contributed the support for SSH
1797protocol versions 1.5 and 2.0.
1798