summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.5121
1 files changed, 65 insertions, 56 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index d0ea33918..2ca7ce02f 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -34,7 +34,7 @@
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 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. 35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\" 36.\"
37.\" $OpenBSD: ssh_config.5,v 1.7 2003/03/28 10:11:43 jmc Exp $ 37.\" $OpenBSD: ssh_config.5,v 1.20 2003/09/02 18:50:06 jmc Exp $
38.Dd September 25, 1999 38.Dd September 25, 1999
39.Dt SSH_CONFIG 5 39.Dt SSH_CONFIG 5
40.Os 40.Os
@@ -104,7 +104,7 @@ keyword) to be only for those hosts that match one of the patterns
104given after the keyword. 104given after the keyword.
105.Ql \&* 105.Ql \&*
106and 106and
107.Ql ? 107.Ql \&?
108can be used as wildcards in the 108can be used as wildcards in the
109patterns. 109patterns.
110A single 110A single
@@ -115,13 +115,14 @@ The host is the
115.Ar hostname 115.Ar hostname
116argument given on the command line (i.e., the name is not converted to 116argument given on the command line (i.e., the name is not converted to
117a canonicalized host name before matching). 117a canonicalized host name before matching).
118.It Cm AFSTokenPassing 118.It Cm AddressFamily
119Specifies whether to pass AFS tokens to remote host. 119Specifies which address family to use when connecting.
120The argument to this keyword must be 120Valid arguments are
121.Dq yes 121.Dq any ,
122or 122.Dq inet
123.Dq no . 123(Use IPv4 only) or
124This option applies to protocol version 1 only. 124.Dq inet6
125(Use IPv6 only.)
125.It Cm BatchMode 126.It Cm BatchMode
126If set to 127If set to
127.Dq yes , 128.Dq yes ,
@@ -234,18 +235,41 @@ Specifies the number of tries (one per second) to make before exiting.
234The argument must be an integer. 235The argument must be an integer.
235This may be useful in scripts if the connection sometimes fails. 236This may be useful in scripts if the connection sometimes fails.
236The default is 1. 237The default is 1.
238.It Cm ConnectTimeout
239Specifies the timeout (in seconds) used when connecting to the ssh
240server, instead of using the default system TCP timeout.
241This value is used only when the target is down or really unreachable,
242not when it refuses the connection.
237.It Cm DynamicForward 243.It Cm DynamicForward
238Specifies that a TCP/IP port on the local machine be forwarded 244Specifies that a TCP/IP port on the local machine be forwarded
239over the secure channel, and the application 245over the secure channel, and the application
240protocol is then used to determine where to connect to from the 246protocol is then used to determine where to connect to from the
241remote machine. 247remote machine.
242The argument must be a port number. 248The argument must be a port number.
243Currently the SOCKS4 protocol is supported, and 249Currently the SOCKS4 and SOCKS5 protocols are supported, and
244.Nm ssh 250.Nm ssh
245will act as a SOCKS4 server. 251will act as a SOCKS server.
246Multiple forwardings may be specified, and 252Multiple forwardings may be specified, and
247additional forwardings can be given on the command line. 253additional forwardings can be given on the command line.
248Only the superuser can forward privileged ports. 254Only the superuser can forward privileged ports.
255.It Cm EnableSSHKeysign
256Setting this option to
257.Dq yes
258in the global client configuration file
259.Pa /etc/ssh/ssh_config
260enables the use of the helper program
261.Xr ssh-keysign 8
262during
263.Cm HostbasedAuthentication .
264The argument must be
265.Dq yes
266or
267.Dq no .
268The default is
269.Dq no .
270See
271.Xr ssh-keysign 8
272for more information.
249.It Cm EscapeChar 273.It Cm EscapeChar
250Sets the escape character (default: 274Sets the escape character (default:
251.Ql ~ ) . 275.Ql ~ ) .
@@ -314,6 +338,18 @@ The default is
314Specifies a file to use for the global 338Specifies a file to use for the global
315host key database instead of 339host key database instead of
316.Pa /etc/ssh/ssh_known_hosts . 340.Pa /etc/ssh/ssh_known_hosts .
341.It Cm GSSAPIAuthentication
342Specifies whether authentication based on GSSAPI may be used, either using
343the result of a successful key exchange, or using GSSAPI user
344authentication.
345The default is
346.Dq yes .
347Note that this option applies to protocol version 2 only.
348.It Cm GSSAPIDelegateCredentials
349Forward (delegate) credentials to the server.
350The default is
351.Dq no .
352Note that this option applies to protocol version 2 only.
317.It Cm HostbasedAuthentication 353.It Cm HostbasedAuthentication
318Specifies whether to try rhosts based authentication with public key 354Specifies whether to try rhosts based authentication with public key
319authentication. 355authentication.
@@ -346,7 +382,8 @@ Numeric IP addresses are also permitted (both on the command line and in
346specifications). 382specifications).
347.It Cm IdentityFile 383.It Cm IdentityFile
348Specifies a file from which the user's RSA or DSA authentication identity 384Specifies a file from which the user's RSA or DSA authentication identity
349is read. The default is 385is read.
386The default is
350.Pa $HOME/.ssh/identity 387.Pa $HOME/.ssh/identity
351for protocol version 1, and 388for protocol version 1, and
352.Pa $HOME/.ssh/id_rsa 389.Pa $HOME/.ssh/id_rsa
@@ -383,19 +420,6 @@ This is important in scripts, and many users want it too.
383.Pp 420.Pp
384To disable keepalives, the value should be set to 421To disable keepalives, the value should be set to
385.Dq no . 422.Dq no .
386.It Cm KerberosAuthentication
387Specifies whether Kerberos authentication will be used.
388The argument to this keyword must be
389.Dq yes
390or
391.Dq no .
392.It Cm KerberosTgtPassing
393Specifies whether a Kerberos TGT will be forwarded to the server.
394This will only work if the Kerberos server is actually an AFS kaserver.
395The argument to this keyword must be
396.Dq yes
397or
398.Dq no .
399.It Cm LocalForward 423.It Cm LocalForward
400Specifies that a TCP/IP port on the local machine be forwarded over 424Specifies that a TCP/IP port on the local machine be forwarded over
401the secure channel to the specified host and port from the remote machine. 425the secure channel to the specified host and port from the remote machine.
@@ -449,7 +473,8 @@ Specifies the port number to connect on the remote host.
449Default is 22. 473Default is 22.
450.It Cm PreferredAuthentications 474.It Cm PreferredAuthentications
451Specifies the order in which the client should try protocol 2 475Specifies the order in which the client should try protocol 2
452authentication methods. This allows a client to prefer one method (e.g. 476authentication methods.
477This allows a client to prefer one method (e.g.
453.Cm keyboard-interactive ) 478.Cm keyboard-interactive )
454over another method (e.g. 479over another method (e.g.
455.Cm password ) 480.Cm password )
@@ -525,26 +550,6 @@ IPv6 addresses can be specified with an alternative syntax:
525Multiple forwardings may be specified, and additional 550Multiple forwardings may be specified, and additional
526forwardings can be given on the command line. 551forwardings can be given on the command line.
527Only the superuser can forward privileged ports. 552Only the superuser can forward privileged ports.
528.It Cm RhostsAuthentication
529Specifies whether to try rhosts based authentication.
530Note that this
531declaration only affects the client side and has no effect whatsoever
532on security.
533Most servers do not permit RhostsAuthentication because it
534is not secure (see
535.Cm RhostsRSAAuthentication ) .
536The argument to this keyword must be
537.Dq yes
538or
539.Dq no .
540The default is
541.Dq no .
542This option applies to protocol version 1 only and requires
543.Nm ssh
544to be setuid root and
545.Cm UsePrivilegedPort
546to be set to
547.Dq yes .
548.It Cm RhostsRSAAuthentication 553.It Cm RhostsRSAAuthentication
549Specifies whether to try rhosts based authentication with RSA host 554Specifies whether to try rhosts based authentication with RSA host
550authentication. 555authentication.
@@ -586,12 +591,12 @@ The default is 0 (disabled), or 300 if
586.Cm BatchMode 591.Cm BatchMode
587is set. 592is set.
588.It Cm SmartcardDevice 593.It Cm SmartcardDevice
589Specifies which smartcard device to use. The argument to this keyword is 594Specifies which smartcard device to use.
590the device 595The argument to this keyword is the device
591.Nm ssh 596.Nm ssh
592should use to communicate with a smartcard used for storing the user's 597should use to communicate with a smartcard used for storing the user's
593private RSA key. By default, no device is specified and smartcard support 598private RSA key.
594is not activated. 599By default, no device is specified and smartcard support is not activated.
595.It Cm StrictHostKeyChecking 600.It Cm StrictHostKeyChecking
596If this flag is set to 601If this flag is set to
597.Dq yes , 602.Dq yes ,
@@ -641,11 +646,9 @@ If set to
641must be setuid root. 646must be setuid root.
642Note that this option must be set to 647Note that this option must be set to
643.Dq yes 648.Dq yes
644if 649for
645.Cm RhostsAuthentication
646and
647.Cm RhostsRSAAuthentication 650.Cm RhostsRSAAuthentication
648authentications are needed with older servers. 651with older servers.
649.It Cm User 652.It Cm User
650Specifies the user to log in as. 653Specifies the user to log in as.
651This can be useful when a different user name is used on different machines. 654This can be useful when a different user name is used on different machines.
@@ -655,6 +658,12 @@ having to remember to give the user name on the command line.
655Specifies a file to use for the user 658Specifies a file to use for the user
656host key database instead of 659host key database instead of
657.Pa $HOME/.ssh/known_hosts . 660.Pa $HOME/.ssh/known_hosts .
661.It Cm VerifyHostKeyDNS
662Specifies whether to verify the remote key using DNS and SSHFP resource
663records.
664The default is
665.Dq no .
666Note that this option applies to protocol version 2 only.
658.It Cm XAuthLocation 667.It Cm XAuthLocation
659Specifies the full pathname of the 668Specifies the full pathname of the
660.Xr xauth 1 669.Xr xauth 1
@@ -680,6 +689,8 @@ values that are not specified in the user's configuration file, and
680for those users who do not have a configuration file. 689for those users who do not have a configuration file.
681This file must be world-readable. 690This file must be world-readable.
682.El 691.El
692.Sh SEE ALSO
693.Xr ssh 1
683.Sh AUTHORS 694.Sh AUTHORS
684OpenSSH is a derivative of the original and free 695OpenSSH is a derivative of the original and free
685ssh 1.2.12 release by Tatu Ylonen. 696ssh 1.2.12 release by Tatu Ylonen.
@@ -689,5 +700,3 @@ removed many bugs, re-added newer features and
689created OpenSSH. 700created OpenSSH.
690Markus Friedl contributed the support for SSH 701Markus Friedl contributed the support for SSH
691protocol versions 1.5 and 2.0. 702protocol versions 1.5 and 2.0.
692.Sh SEE ALSO
693.Xr ssh 1