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 1c118eefc..9d4b38aa8 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.
@@ -1088,7 +1112,10 @@ If, for example,
1088.Cm ServerAliveCountMax 1112.Cm ServerAliveCountMax
1089is left at the default, if the server becomes unresponsive, 1113is left at the default, if the server becomes unresponsive,
1090ssh will disconnect after approximately 45 seconds. 1114ssh will disconnect after approximately 45 seconds.
1091This option applies to protocol version 2 only. 1115This option applies to protocol version 2 only; in protocol version
11161 there is no mechanism to request a response from the server to the
1117server alive messages, so disconnection is the responsibility of the TCP
1118stack.
1092.It Cm ServerAliveInterval 1119.It Cm ServerAliveInterval
1093Sets a timeout interval in seconds after which if no data has been received 1120Sets a timeout interval in seconds after which if no data has been received
1094from the server, 1121from the server,
@@ -1096,8 +1123,15 @@ from the server,
1096will send a message through the encrypted 1123will send a message through the encrypted
1097channel to request a response from the server. 1124channel to request a response from the server.
1098The default 1125The default
1099is 0, indicating that these messages will not be sent to the server. 1126is 0, indicating that these messages will not be sent to the server,
1127or 300 if the
1128.Cm BatchMode
1129option is set.
1100This option applies to protocol version 2 only. 1130This option applies to protocol version 2 only.
1131.Cm ProtocolKeepAlives
1132and
1133.Cm SetupTimeOut
1134are Debian-specific compatibility aliases for this option.
1101.It Cm StrictHostKeyChecking 1135.It Cm StrictHostKeyChecking
1102If this flag is set to 1136If this flag is set to
1103.Dq yes , 1137.Dq yes ,
@@ -1136,6 +1170,12 @@ Specifies whether the system should send TCP keepalive messages to the
1136other side. 1170other side.
1137If they are sent, death of the connection or crash of one 1171If they are sent, death of the connection or crash of one
1138of the machines will be properly noticed. 1172of the machines will be properly noticed.
1173This option only uses TCP keepalives (as opposed to using ssh level
1174keepalives), so takes a long time to notice when the connection dies.
1175As such, you probably want
1176the
1177.Cm ServerAliveInterval
1178option as well.
1139However, this means that 1179However, this means that
1140connections will die if the route is down temporarily, and some people 1180connections will die if the route is down temporarily, and some people
1141find it annoying. 1181find it annoying.
@@ -1187,6 +1227,23 @@ is not specified, it defaults to
1187.Dq any . 1227.Dq any .
1188The default is 1228The default is
1189.Dq any:any . 1229.Dq any:any .
1230.It Cm UseBlacklistedKeys
1231Specifies whether
1232.Xr ssh 1
1233should use keys recorded in its blacklist of known-compromised keys (see
1234.Xr ssh-vulnkey 1 )
1235for authentication.
1236If
1237.Dq yes ,
1238then attempts to use compromised keys for authentication will be logged but
1239accepted.
1240It is strongly recommended that this be used only to install new authorized
1241keys on the remote system, and even then only with the utmost care.
1242If
1243.Dq no ,
1244then attempts to use compromised keys for authentication will be prevented.
1245The default is
1246.Dq no .
1190.It Cm UsePrivilegedPort 1247.It Cm UsePrivilegedPort
1191Specifies whether to use a privileged port for outgoing connections. 1248Specifies whether to use a privileged port for outgoing connections.
1192The argument must be 1249The argument must be
@@ -1305,6 +1362,8 @@ The format of this file is described above.
1305This file is used by the SSH client. 1362This file is used by the SSH client.
1306Because of the potential for abuse, this file must have strict permissions: 1363Because of the potential for abuse, this file must have strict permissions:
1307read/write for the user, and not accessible by others. 1364read/write for the user, and not accessible by others.
1365It may be group-writable provided that the group in question contains only
1366the user.
1308.It Pa /etc/ssh/ssh_config 1367.It Pa /etc/ssh/ssh_config
1309Systemwide configuration file. 1368Systemwide configuration file.
1310This file provides defaults for those 1369This file provides defaults for those