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 e72919a89..127540a60 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -71,6 +71,22 @@ Since the first obtained value for each parameter is used, more
71host-specific declarations should be given near the beginning of the 71host-specific declarations should be given near the beginning of the
72file, and general defaults at the end. 72file, and general defaults at the end.
73.Pp 73.Pp
74Note that the Debian
75.Ic openssh-client
76package sets several options as standard in
77.Pa /etc/ssh/ssh_config
78which are not the default in
79.Xr ssh 1 :
80.Pp
81.Bl -bullet -offset indent -compact
82.It
83.Cm SendEnv No LANG LC_*
84.It
85.Cm HashKnownHosts No yes
86.It
87.Cm GSSAPIAuthentication No yes
88.El
89.Pp
74The configuration file has the following format: 90The configuration file has the following format:
75.Pp 91.Pp
76Empty lines and lines starting with 92Empty lines and lines starting with
@@ -136,8 +152,12 @@ Valid arguments are
136If set to 152If set to
137.Dq yes , 153.Dq yes ,
138passphrase/password querying will be disabled. 154passphrase/password querying will be disabled.
155In addition, the
156.Cm ServerAliveInterval
157option will be set to 300 seconds by default.
139This option is useful in scripts and other batch jobs where no user 158This option is useful in scripts and other batch jobs where no user
140is present to supply the password. 159is present to supply the password,
160and where it is desirable to detect a broken network swiftly.
141The argument must be 161The argument must be
142.Dq yes 162.Dq yes
143or 163or
@@ -497,7 +517,8 @@ token used for the session will be set to expire after 20 minutes.
497Remote clients will be refused access after this time. 517Remote clients will be refused access after this time.
498.Pp 518.Pp
499The default is 519The default is
500.Dq no . 520.Dq yes
521(Debian-specific).
501.Pp 522.Pp
502See the X11 SECURITY extension specification for full details on 523See the X11 SECURITY extension specification for full details on
503the restrictions imposed on untrusted clients. 524the restrictions imposed on untrusted clients.
@@ -583,6 +604,9 @@ Note that existing names and addresses in known hosts files
583will not be converted automatically, 604will not be converted automatically,
584but may be manually hashed using 605but may be manually hashed using
585.Xr ssh-keygen 1 . 606.Xr ssh-keygen 1 .
607Use of this option may break facilities such as tab-completion that rely
608on being able to read unhashed host names from
609.Pa ~/.ssh/known_hosts .
586.It Cm HostbasedAuthentication 610.It Cm HostbasedAuthentication
587Specifies whether to try rhosts based authentication with public key 611Specifies whether to try rhosts based authentication with public key
588authentication. 612authentication.
@@ -1130,7 +1154,10 @@ If, for example,
1130.Cm ServerAliveCountMax 1154.Cm ServerAliveCountMax
1131is left at the default, if the server becomes unresponsive, 1155is left at the default, if the server becomes unresponsive,
1132ssh will disconnect after approximately 45 seconds. 1156ssh will disconnect after approximately 45 seconds.
1133This option applies to protocol version 2 only. 1157This option applies to protocol version 2 only; in protocol version
11581 there is no mechanism to request a response from the server to the
1159server alive messages, so disconnection is the responsibility of the TCP
1160stack.
1134.It Cm ServerAliveInterval 1161.It Cm ServerAliveInterval
1135Sets a timeout interval in seconds after which if no data has been received 1162Sets a timeout interval in seconds after which if no data has been received
1136from the server, 1163from the server,
@@ -1138,8 +1165,15 @@ from the server,
1138will send a message through the encrypted 1165will send a message through the encrypted
1139channel to request a response from the server. 1166channel to request a response from the server.
1140The default 1167The default
1141is 0, indicating that these messages will not be sent to the server. 1168is 0, indicating that these messages will not be sent to the server,
1169or 300 if the
1170.Cm BatchMode
1171option is set.
1142This option applies to protocol version 2 only. 1172This option applies to protocol version 2 only.
1173.Cm ProtocolKeepAlives
1174and
1175.Cm SetupTimeOut
1176are Debian-specific compatibility aliases for this option.
1143.It Cm StrictHostKeyChecking 1177.It Cm StrictHostKeyChecking
1144If this flag is set to 1178If this flag is set to
1145.Dq yes , 1179.Dq yes ,
@@ -1178,6 +1212,12 @@ Specifies whether the system should send TCP keepalive messages to the
1178other side. 1212other side.
1179If they are sent, death of the connection or crash of one 1213If they are sent, death of the connection or crash of one
1180of the machines will be properly noticed. 1214of the machines will be properly noticed.
1215This option only uses TCP keepalives (as opposed to using ssh level
1216keepalives), so takes a long time to notice when the connection dies.
1217As such, you probably want
1218the
1219.Cm ServerAliveInterval
1220option as well.
1181However, this means that 1221However, this means that
1182connections will die if the route is down temporarily, and some people 1222connections will die if the route is down temporarily, and some people
1183find it annoying. 1223find it annoying.
@@ -1229,6 +1269,23 @@ is not specified, it defaults to
1229.Dq any . 1269.Dq any .
1230The default is 1270The default is
1231.Dq any:any . 1271.Dq any:any .
1272.It Cm UseBlacklistedKeys
1273Specifies whether
1274.Xr ssh 1
1275should use keys recorded in its blacklist of known-compromised keys (see
1276.Xr ssh-vulnkey 1 )
1277for authentication.
1278If
1279.Dq yes ,
1280then attempts to use compromised keys for authentication will be logged but
1281accepted.
1282It is strongly recommended that this be used only to install new authorized
1283keys on the remote system, and even then only with the utmost care.
1284If
1285.Dq no ,
1286then attempts to use compromised keys for authentication will be prevented.
1287The default is
1288.Dq no .
1232.It Cm UsePrivilegedPort 1289.It Cm UsePrivilegedPort
1233Specifies whether to use a privileged port for outgoing connections. 1290Specifies whether to use a privileged port for outgoing connections.
1234The argument must be 1291The argument must be
@@ -1345,6 +1402,8 @@ The format of this file is described above.
1345This file is used by the SSH client. 1402This file is used by the SSH client.
1346Because of the potential for abuse, this file must have strict permissions: 1403Because of the potential for abuse, this file must have strict permissions:
1347read/write for the user, and not accessible by others. 1404read/write for the user, and not accessible by others.
1405It may be group-writable provided that the group in question contains only
1406the user.
1348.It Pa /etc/ssh/ssh_config 1407.It Pa /etc/ssh/ssh_config
1349Systemwide configuration file. 1408Systemwide configuration file.
1350This file provides defaults for those 1409This file provides defaults for those