summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.567
1 files changed, 63 insertions, 4 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 91c2cd2c6..2f0cd8c83 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -72,6 +72,22 @@ Since the first obtained value for each parameter is used, more
72host-specific declarations should be given near the beginning of the 72host-specific declarations should be given near the beginning of the
73file, and general defaults at the end. 73file, and general defaults at the end.
74.Pp 74.Pp
75Note that the Debian
76.Ic openssh-client
77package sets several options as standard in
78.Pa /etc/ssh/ssh_config
79which are not the default in
80.Xr ssh 1 :
81.Pp
82.Bl -bullet -offset indent -compact
83.It
84.Cm SendEnv No LANG LC_*
85.It
86.Cm HashKnownHosts No yes
87.It
88.Cm GSSAPIAuthentication No yes
89.El
90.Pp
75The configuration file has the following format: 91The configuration file has the following format:
76.Pp 92.Pp
77Empty lines and lines starting with 93Empty lines and lines starting with
@@ -128,8 +144,12 @@ Valid arguments are
128If set to 144If set to
129.Dq yes , 145.Dq yes ,
130passphrase/password querying will be disabled. 146passphrase/password querying will be disabled.
147In addition, the
148.Cm ServerAliveInterval
149option will be set to 300 seconds by default.
131This option is useful in scripts and other batch jobs where no user 150This option is useful in scripts and other batch jobs where no user
132is present to supply the password. 151is present to supply the password,
152and where it is desirable to detect a broken network swiftly.
133The argument must be 153The argument must be
134.Dq yes 154.Dq yes
135or 155or
@@ -479,7 +499,8 @@ token used for the session will be set to expire after 20 minutes.
479Remote clients will be refused access after this time. 499Remote clients will be refused access after this time.
480.Pp 500.Pp
481The default is 501The default is
482.Dq no . 502.Dq yes
503(Debian-specific).
483.Pp 504.Pp
484See the X11 SECURITY extension specification for full details on 505See the X11 SECURITY extension specification for full details on
485the restrictions imposed on untrusted clients. 506the restrictions imposed on untrusted clients.
@@ -558,6 +579,9 @@ Note that existing names and addresses in known hosts files
558will not be converted automatically, 579will not be converted automatically,
559but may be manually hashed using 580but may be manually hashed using
560.Xr ssh-keygen 1 . 581.Xr ssh-keygen 1 .
582Use of this option may break facilities such as tab-completion that rely
583on being able to read unhashed host names from
584.Pa ~/.ssh/known_hosts .
561.It Cm HostbasedAuthentication 585.It Cm HostbasedAuthentication
562Specifies whether to try rhosts based authentication with public key 586Specifies whether to try rhosts based authentication with public key
563authentication. 587authentication.
@@ -983,7 +1007,10 @@ If, for example,
983.Cm ServerAliveCountMax 1007.Cm ServerAliveCountMax
984is left at the default, if the server becomes unresponsive, 1008is left at the default, if the server becomes unresponsive,
985ssh will disconnect after approximately 45 seconds. 1009ssh will disconnect after approximately 45 seconds.
986This option applies to protocol version 2 only. 1010This option applies to protocol version 2 only; in protocol version
10111 there is no mechanism to request a response from the server to the
1012server alive messages, so disconnection is the responsibility of the TCP
1013stack.
987.It Cm ServerAliveInterval 1014.It Cm ServerAliveInterval
988Sets a timeout interval in seconds after which if no data has been received 1015Sets a timeout interval in seconds after which if no data has been received
989from the server, 1016from the server,
@@ -991,8 +1018,15 @@ from the server,
991will send a message through the encrypted 1018will send a message through the encrypted
992channel to request a response from the server. 1019channel to request a response from the server.
993The default 1020The default
994is 0, indicating that these messages will not be sent to the server. 1021is 0, indicating that these messages will not be sent to the server,
1022or 300 if the
1023.Cm BatchMode
1024option is set.
995This option applies to protocol version 2 only. 1025This option applies to protocol version 2 only.
1026.Cm ProtocolKeepAlives
1027and
1028.Cm SetupTimeOut
1029are Debian-specific compatibility aliases for this option.
996.It Cm StrictHostKeyChecking 1030.It Cm StrictHostKeyChecking
997If this flag is set to 1031If this flag is set to
998.Dq yes , 1032.Dq yes ,
@@ -1031,6 +1065,12 @@ Specifies whether the system should send TCP keepalive messages to the
1031other side. 1065other side.
1032If they are sent, death of the connection or crash of one 1066If they are sent, death of the connection or crash of one
1033of the machines will be properly noticed. 1067of the machines will be properly noticed.
1068This option only uses TCP keepalives (as opposed to using ssh level
1069keepalives), so takes a long time to notice when the connection dies.
1070As such, you probably want
1071the
1072.Cm ServerAliveInterval
1073option as well.
1034However, this means that 1074However, this means that
1035connections will die if the route is down temporarily, and some people 1075connections will die if the route is down temporarily, and some people
1036find it annoying. 1076find it annoying.
@@ -1082,6 +1122,23 @@ is not specified, it defaults to
1082.Dq any . 1122.Dq any .
1083The default is 1123The default is
1084.Dq any:any . 1124.Dq any:any .
1125.It Cm UseBlacklistedKeys
1126Specifies whether
1127.Xr ssh 1
1128should use keys recorded in its blacklist of known-compromised keys (see
1129.Xr ssh-vulnkey 1 )
1130for authentication.
1131If
1132.Dq yes ,
1133then attempts to use compromised keys for authentication will be logged but
1134accepted.
1135It is strongly recommended that this be used only to install new authorized
1136keys on the remote system, and even then only with the utmost care.
1137If
1138.Dq no ,
1139then attempts to use compromised keys for authentication will be prevented.
1140The default is
1141.Dq no .
1085.It Cm UsePrivilegedPort 1142.It Cm UsePrivilegedPort
1086Specifies whether to use a privileged port for outgoing connections. 1143Specifies whether to use a privileged port for outgoing connections.
1087The argument must be 1144The argument must be
@@ -1198,6 +1255,8 @@ The format of this file is described above.
1198This file is used by the SSH client. 1255This file is used by the SSH client.
1199Because of the potential for abuse, this file must have strict permissions: 1256Because of the potential for abuse, this file must have strict permissions:
1200read/write for the user, and not accessible by others. 1257read/write for the user, and not accessible by others.
1258It may be group-writable provided that the group in question contains only
1259the user.
1201.It Pa /etc/ssh/ssh_config 1260.It Pa /etc/ssh/ssh_config
1202Systemwide configuration file. 1261Systemwide configuration file.
1203This file provides defaults for those 1262This file provides defaults for those