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 bd3a7127a..fa852acb1 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
@@ -498,7 +518,8 @@ token used for the session will be set to expire after 20 minutes.
498Remote clients will be refused access after this time. 518Remote clients will be refused access after this time.
499.Pp 519.Pp
500The default is 520The default is
501.Dq no . 521.Dq yes
522(Debian-specific).
502.Pp 523.Pp
503See the X11 SECURITY extension specification for full details on 524See the X11 SECURITY extension specification for full details on
504the restrictions imposed on untrusted clients. 525the restrictions imposed on untrusted clients.
@@ -584,6 +605,9 @@ Note that existing names and addresses in known hosts files
584will not be converted automatically, 605will not be converted automatically,
585but may be manually hashed using 606but may be manually hashed using
586.Xr ssh-keygen 1 . 607.Xr ssh-keygen 1 .
608Use of this option may break facilities such as tab-completion that rely
609on being able to read unhashed host names from
610.Pa ~/.ssh/known_hosts .
587.It Cm HostbasedAuthentication 611.It Cm HostbasedAuthentication
588Specifies whether to try rhosts based authentication with public key 612Specifies whether to try rhosts based authentication with public key
589authentication. 613authentication.
@@ -1102,7 +1126,10 @@ If, for example,
1102.Cm ServerAliveCountMax 1126.Cm ServerAliveCountMax
1103is left at the default, if the server becomes unresponsive, 1127is left at the default, if the server becomes unresponsive,
1104ssh will disconnect after approximately 45 seconds. 1128ssh will disconnect after approximately 45 seconds.
1105This option applies to protocol version 2 only. 1129This option applies to protocol version 2 only; in protocol version
11301 there is no mechanism to request a response from the server to the
1131server alive messages, so disconnection is the responsibility of the TCP
1132stack.
1106.It Cm ServerAliveInterval 1133.It Cm ServerAliveInterval
1107Sets a timeout interval in seconds after which if no data has been received 1134Sets a timeout interval in seconds after which if no data has been received
1108from the server, 1135from the server,
@@ -1110,8 +1137,15 @@ from the server,
1110will send a message through the encrypted 1137will send a message through the encrypted
1111channel to request a response from the server. 1138channel to request a response from the server.
1112The default 1139The default
1113is 0, indicating that these messages will not be sent to the server. 1140is 0, indicating that these messages will not be sent to the server,
1141or 300 if the
1142.Cm BatchMode
1143option is set.
1114This option applies to protocol version 2 only. 1144This option applies to protocol version 2 only.
1145.Cm ProtocolKeepAlives
1146and
1147.Cm SetupTimeOut
1148are Debian-specific compatibility aliases for this option.
1115.It Cm StrictHostKeyChecking 1149.It Cm StrictHostKeyChecking
1116If this flag is set to 1150If this flag is set to
1117.Dq yes , 1151.Dq yes ,
@@ -1150,6 +1184,12 @@ Specifies whether the system should send TCP keepalive messages to the
1150other side. 1184other side.
1151If they are sent, death of the connection or crash of one 1185If they are sent, death of the connection or crash of one
1152of the machines will be properly noticed. 1186of the machines will be properly noticed.
1187This option only uses TCP keepalives (as opposed to using ssh level
1188keepalives), so takes a long time to notice when the connection dies.
1189As such, you probably want
1190the
1191.Cm ServerAliveInterval
1192option as well.
1153However, this means that 1193However, this means that
1154connections will die if the route is down temporarily, and some people 1194connections will die if the route is down temporarily, and some people
1155find it annoying. 1195find it annoying.
@@ -1201,6 +1241,23 @@ is not specified, it defaults to
1201.Dq any . 1241.Dq any .
1202The default is 1242The default is
1203.Dq any:any . 1243.Dq any:any .
1244.It Cm UseBlacklistedKeys
1245Specifies whether
1246.Xr ssh 1
1247should use keys recorded in its blacklist of known-compromised keys (see
1248.Xr ssh-vulnkey 1 )
1249for authentication.
1250If
1251.Dq yes ,
1252then attempts to use compromised keys for authentication will be logged but
1253accepted.
1254It is strongly recommended that this be used only to install new authorized
1255keys on the remote system, and even then only with the utmost care.
1256If
1257.Dq no ,
1258then attempts to use compromised keys for authentication will be prevented.
1259The default is
1260.Dq no .
1204.It Cm UsePrivilegedPort 1261.It Cm UsePrivilegedPort
1205Specifies whether to use a privileged port for outgoing connections. 1262Specifies whether to use a privileged port for outgoing connections.
1206The argument must be 1263The argument must be
@@ -1319,6 +1376,8 @@ The format of this file is described above.
1319This file is used by the SSH client. 1376This file is used by the SSH client.
1320Because of the potential for abuse, this file must have strict permissions: 1377Because of the potential for abuse, this file must have strict permissions:
1321read/write for the user, and not accessible by others. 1378read/write for the user, and not accessible by others.
1379It may be group-writable provided that the group in question contains only
1380the user.
1322.It Pa /etc/ssh/ssh_config 1381.It Pa /etc/ssh/ssh_config
1323Systemwide configuration file. 1382Systemwide configuration file.
1324This file provides defaults for those 1383This file provides defaults for those