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 e145cc8a5..cfb11d64a 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
@@ -495,7 +515,8 @@ token used for the session will be set to expire after 20 minutes.
495Remote clients will be refused access after this time. 515Remote clients will be refused access after this time.
496.Pp 516.Pp
497The default is 517The default is
498.Dq no . 518.Dq yes
519(Debian-specific).
499.Pp 520.Pp
500See the X11 SECURITY extension specification for full details on 521See the X11 SECURITY extension specification for full details on
501the restrictions imposed on untrusted clients. 522the restrictions imposed on untrusted clients.
@@ -581,6 +602,9 @@ Note that existing names and addresses in known hosts files
581will not be converted automatically, 602will not be converted automatically,
582but may be manually hashed using 603but may be manually hashed using
583.Xr ssh-keygen 1 . 604.Xr ssh-keygen 1 .
605Use of this option may break facilities such as tab-completion that rely
606on being able to read unhashed host names from
607.Pa ~/.ssh/known_hosts .
584.It Cm HostbasedAuthentication 608.It Cm HostbasedAuthentication
585Specifies whether to try rhosts based authentication with public key 609Specifies whether to try rhosts based authentication with public key
586authentication. 610authentication.
@@ -1089,7 +1113,10 @@ If, for example,
1089.Cm ServerAliveCountMax 1113.Cm ServerAliveCountMax
1090is left at the default, if the server becomes unresponsive, 1114is left at the default, if the server becomes unresponsive,
1091ssh will disconnect after approximately 45 seconds. 1115ssh will disconnect after approximately 45 seconds.
1092This option applies to protocol version 2 only. 1116This option applies to protocol version 2 only; in protocol version
11171 there is no mechanism to request a response from the server to the
1118server alive messages, so disconnection is the responsibility of the TCP
1119stack.
1093.It Cm ServerAliveInterval 1120.It Cm ServerAliveInterval
1094Sets a timeout interval in seconds after which if no data has been received 1121Sets a timeout interval in seconds after which if no data has been received
1095from the server, 1122from the server,
@@ -1097,8 +1124,15 @@ from the server,
1097will send a message through the encrypted 1124will send a message through the encrypted
1098channel to request a response from the server. 1125channel to request a response from the server.
1099The default 1126The default
1100is 0, indicating that these messages will not be sent to the server. 1127is 0, indicating that these messages will not be sent to the server,
1128or 300 if the
1129.Cm BatchMode
1130option is set.
1101This option applies to protocol version 2 only. 1131This option applies to protocol version 2 only.
1132.Cm ProtocolKeepAlives
1133and
1134.Cm SetupTimeOut
1135are Debian-specific compatibility aliases for this option.
1102.It Cm StrictHostKeyChecking 1136.It Cm StrictHostKeyChecking
1103If this flag is set to 1137If this flag is set to
1104.Dq yes , 1138.Dq yes ,
@@ -1137,6 +1171,12 @@ Specifies whether the system should send TCP keepalive messages to the
1137other side. 1171other side.
1138If they are sent, death of the connection or crash of one 1172If they are sent, death of the connection or crash of one
1139of the machines will be properly noticed. 1173of the machines will be properly noticed.
1174This option only uses TCP keepalives (as opposed to using ssh level
1175keepalives), so takes a long time to notice when the connection dies.
1176As such, you probably want
1177the
1178.Cm ServerAliveInterval
1179option as well.
1140However, this means that 1180However, this means that
1141connections will die if the route is down temporarily, and some people 1181connections will die if the route is down temporarily, and some people
1142find it annoying. 1182find it annoying.
@@ -1188,6 +1228,23 @@ is not specified, it defaults to
1188.Dq any . 1228.Dq any .
1189The default is 1229The default is
1190.Dq any:any . 1230.Dq any:any .
1231.It Cm UseBlacklistedKeys
1232Specifies whether
1233.Xr ssh 1
1234should use keys recorded in its blacklist of known-compromised keys (see
1235.Xr ssh-vulnkey 1 )
1236for authentication.
1237If
1238.Dq yes ,
1239then attempts to use compromised keys for authentication will be logged but
1240accepted.
1241It is strongly recommended that this be used only to install new authorized
1242keys on the remote system, and even then only with the utmost care.
1243If
1244.Dq no ,
1245then attempts to use compromised keys for authentication will be prevented.
1246The default is
1247.Dq no .
1191.It Cm UsePrivilegedPort 1248.It Cm UsePrivilegedPort
1192Specifies whether to use a privileged port for outgoing connections. 1249Specifies whether to use a privileged port for outgoing connections.
1193The argument must be 1250The argument must be
@@ -1306,6 +1363,8 @@ The format of this file is described above.
1306This file is used by the SSH client. 1363This file is used by the SSH client.
1307Because of the potential for abuse, this file must have strict permissions: 1364Because of the potential for abuse, this file must have strict permissions:
1308read/write for the user, and not accessible by others. 1365read/write for the user, and not accessible by others.
1366It may be group-writable provided that the group in question contains only
1367the user.
1309.It Pa /etc/ssh/ssh_config 1368.It Pa /etc/ssh/ssh_config
1310Systemwide configuration file. 1369Systemwide configuration file.
1311This file provides defaults for those 1370This file provides defaults for those