summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.565
1 files changed, 61 insertions, 4 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index c1ad53dcf..4c46c62cb 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -127,8 +127,14 @@ Valid arguments are
127If set to 127If set to
128.Dq yes , 128.Dq yes ,
129passphrase/password querying will be disabled. 129passphrase/password querying will be disabled.
130In addition, the
131.Cm ServerAliveInterval
132and
133.Cm SetupTimeOut
134options will both be set to 300 seconds by default.
130This option is useful in scripts and other batch jobs where no user 135This option is useful in scripts and other batch jobs where no user
131is present to supply the password. 136is present to supply the password,
137and where it is desirable to detect a broken network swiftly.
132The argument must be 138The argument must be
133.Dq yes 139.Dq yes
134or 140or
@@ -447,7 +453,8 @@ token used for the session will be set to expire after 20 minutes.
447Remote clients will be refused access after this time. 453Remote clients will be refused access after this time.
448.Pp 454.Pp
449The default is 455The default is
450.Dq no . 456.Dq yes
457(Debian-specific).
451.Pp 458.Pp
452See the X11 SECURITY extension specification for full details on 459See the X11 SECURITY extension specification for full details on
453the restrictions imposed on untrusted clients. 460the restrictions imposed on untrusted clients.
@@ -477,11 +484,28 @@ Specifies whether user authentication based on GSSAPI is allowed.
477The default is 484The default is
478.Dq no . 485.Dq no .
479Note that this option applies to protocol version 2 only. 486Note that this option applies to protocol version 2 only.
487.It Cm GSSAPIKeyExchange
488Specifies whether key exchange based on GSSAPI may be used. When using
489GSSAPI key exchange the server need not have a host key.
490The default is
491.Dq no .
492Note that this option applies to protocol version 2 only.
480.It Cm GSSAPIDelegateCredentials 493.It Cm GSSAPIDelegateCredentials
481Forward (delegate) credentials to the server. 494Forward (delegate) credentials to the server.
482The default is 495The default is
483.Dq no . 496.Dq no .
484Note that this option applies to protocol version 2 only. 497Note that this option applies to protocol version 2 only.
498.It Cm GSSAPITrustDns
499Set to
500.Dq yes
501to indicate that the DNS is trusted to securely canonicalize
502the name of the host being connected to. If
503.Dq no ,
504the hostname entered on the
505command line will be passed untouched to the GSSAPI library.
506The default is
507.Dq no .
508This option only applies to protocol version 2 connections using GSSAPI.
485.It Cm HashKnownHosts 509.It Cm HashKnownHosts
486Indicates that 510Indicates that
487.Xr ssh 1 511.Xr ssh 1
@@ -873,7 +897,10 @@ If, for example,
873.Cm ServerAliveCountMax 897.Cm ServerAliveCountMax
874is left at the default, if the server becomes unresponsive, 898is left at the default, if the server becomes unresponsive,
875ssh will disconnect after approximately 45 seconds. 899ssh will disconnect after approximately 45 seconds.
876This option applies to protocol version 2 only. 900This option applies to protocol version 2 only; in protocol version
9011 there is no mechanism to request a response from the server to the
902server alive messages, so disconnection is the responsibility of the TCP
903stack.
877.It Cm ServerAliveInterval 904.It Cm ServerAliveInterval
878Sets a timeout interval in seconds after which if no data has been received 905Sets a timeout interval in seconds after which if no data has been received
879from the server, 906from the server,
@@ -881,8 +908,30 @@ from the server,
881will send a message through the encrypted 908will send a message through the encrypted
882channel to request a response from the server. 909channel to request a response from the server.
883The default 910The default
884is 0, indicating that these messages will not be sent to the server. 911is 0, indicating that these messages will not be sent to the server,
912or 300 if the
913.Cm BatchMode
914option is set.
885This option applies to protocol version 2 only. 915This option applies to protocol version 2 only.
916.Cm ProtocolKeepAlives
917is a Debian-specific compatibility alias for this option.
918.It Cm SetupTimeOut
919Normally,
920.Nm ssh
921blocks indefinitely whilst waiting to receive the ssh banner and other
922setup protocol from the server, during the session setup.
923This can cause
924.Nm ssh
925to hang under certain circumstances.
926If this option is set,
927.Nm ssh
928will give up if no data from the server is received for the specified
929number of seconds.
930The argument must be an integer.
931The default is 0 (disabled), or 300 if
932.Cm BatchMode
933is set.
934This is a Debian-specific option.
886.It Cm SmartcardDevice 935.It Cm SmartcardDevice
887Specifies which smartcard device to use. 936Specifies which smartcard device to use.
888The argument to this keyword is the device 937The argument to this keyword is the device
@@ -928,6 +977,12 @@ Specifies whether the system should send TCP keepalive messages to the
928other side. 977other side.
929If they are sent, death of the connection or crash of one 978If they are sent, death of the connection or crash of one
930of the machines will be properly noticed. 979of the machines will be properly noticed.
980This option only uses TCP keepalives (as opposed to using ssh level
981keepalives), so takes a long time to notice when the connection dies.
982As such, you probably want
983the
984.Cm ServerAliveInterval
985option as well.
931However, this means that 986However, this means that
932connections will die if the route is down temporarily, and some people 987connections will die if the route is down temporarily, and some people
933find it annoying. 988find it annoying.
@@ -1083,6 +1138,8 @@ The format of this file is described above.
1083This file is used by the SSH client. 1138This file is used by the SSH client.
1084Because of the potential for abuse, this file must have strict permissions: 1139Because of the potential for abuse, this file must have strict permissions:
1085read/write for the user, and not accessible by others. 1140read/write for the user, and not accessible by others.
1141It may be group-writable provided that the group in question contains only
1142the user.
1086.It Pa /etc/ssh/ssh_config 1143.It Pa /etc/ssh/ssh_config
1087Systemwide configuration file. 1144Systemwide configuration file.
1088This file provides defaults for those 1145This file provides defaults for those