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 269d3941b..fc994d482 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
@@ -127,8 +143,12 @@ Valid arguments are
127If set to 143If set to
128.Dq yes , 144.Dq yes ,
129passphrase/password querying will be disabled. 145passphrase/password querying will be disabled.
146In addition, the
147.Cm ServerAliveInterval
148option will be set to 300 seconds by default.
130This option is useful in scripts and other batch jobs where no user 149This option is useful in scripts and other batch jobs where no user
131is present to supply the password. 150is present to supply the password,
151and where it is desirable to detect a broken network swiftly.
132The argument must be 152The argument must be
133.Dq yes 153.Dq yes
134or 154or
@@ -478,7 +498,8 @@ token used for the session will be set to expire after 20 minutes.
478Remote clients will be refused access after this time. 498Remote clients will be refused access after this time.
479.Pp 499.Pp
480The default is 500The default is
481.Dq no . 501.Dq yes
502(Debian-specific).
482.Pp 503.Pp
483See the X11 SECURITY extension specification for full details on 504See the X11 SECURITY extension specification for full details on
484the restrictions imposed on untrusted clients. 505the restrictions imposed on untrusted clients.
@@ -562,6 +583,9 @@ Note that existing names and addresses in known hosts files
562will not be converted automatically, 583will not be converted automatically,
563but may be manually hashed using 584but may be manually hashed using
564.Xr ssh-keygen 1 . 585.Xr ssh-keygen 1 .
586Use of this option may break facilities such as tab-completion that rely
587on being able to read unhashed host names from
588.Pa ~/.ssh/known_hosts .
565.It Cm HostbasedAuthentication 589.It Cm HostbasedAuthentication
566Specifies whether to try rhosts based authentication with public key 590Specifies whether to try rhosts based authentication with public key
567authentication. 591authentication.
@@ -1047,7 +1071,10 @@ If, for example,
1047.Cm ServerAliveCountMax 1071.Cm ServerAliveCountMax
1048is left at the default, if the server becomes unresponsive, 1072is left at the default, if the server becomes unresponsive,
1049ssh will disconnect after approximately 45 seconds. 1073ssh will disconnect after approximately 45 seconds.
1050This option applies to protocol version 2 only. 1074This option applies to protocol version 2 only; in protocol version
10751 there is no mechanism to request a response from the server to the
1076server alive messages, so disconnection is the responsibility of the TCP
1077stack.
1051.It Cm ServerAliveInterval 1078.It Cm ServerAliveInterval
1052Sets a timeout interval in seconds after which if no data has been received 1079Sets a timeout interval in seconds after which if no data has been received
1053from the server, 1080from the server,
@@ -1055,8 +1082,15 @@ from the server,
1055will send a message through the encrypted 1082will send a message through the encrypted
1056channel to request a response from the server. 1083channel to request a response from the server.
1057The default 1084The default
1058is 0, indicating that these messages will not be sent to the server. 1085is 0, indicating that these messages will not be sent to the server,
1086or 300 if the
1087.Cm BatchMode
1088option is set.
1059This option applies to protocol version 2 only. 1089This option applies to protocol version 2 only.
1090.Cm ProtocolKeepAlives
1091and
1092.Cm SetupTimeOut
1093are Debian-specific compatibility aliases for this option.
1060.It Cm StrictHostKeyChecking 1094.It Cm StrictHostKeyChecking
1061If this flag is set to 1095If this flag is set to
1062.Dq yes , 1096.Dq yes ,
@@ -1095,6 +1129,12 @@ Specifies whether the system should send TCP keepalive messages to the
1095other side. 1129other side.
1096If they are sent, death of the connection or crash of one 1130If they are sent, death of the connection or crash of one
1097of the machines will be properly noticed. 1131of the machines will be properly noticed.
1132This option only uses TCP keepalives (as opposed to using ssh level
1133keepalives), so takes a long time to notice when the connection dies.
1134As such, you probably want
1135the
1136.Cm ServerAliveInterval
1137option as well.
1098However, this means that 1138However, this means that
1099connections will die if the route is down temporarily, and some people 1139connections will die if the route is down temporarily, and some people
1100find it annoying. 1140find it annoying.
@@ -1146,6 +1186,23 @@ is not specified, it defaults to
1146.Dq any . 1186.Dq any .
1147The default is 1187The default is
1148.Dq any:any . 1188.Dq any:any .
1189.It Cm UseBlacklistedKeys
1190Specifies whether
1191.Xr ssh 1
1192should use keys recorded in its blacklist of known-compromised keys (see
1193.Xr ssh-vulnkey 1 )
1194for authentication.
1195If
1196.Dq yes ,
1197then attempts to use compromised keys for authentication will be logged but
1198accepted.
1199It is strongly recommended that this be used only to install new authorized
1200keys on the remote system, and even then only with the utmost care.
1201If
1202.Dq no ,
1203then attempts to use compromised keys for authentication will be prevented.
1204The default is
1205.Dq no .
1149.It Cm UsePrivilegedPort 1206.It Cm UsePrivilegedPort
1150Specifies whether to use a privileged port for outgoing connections. 1207Specifies whether to use a privileged port for outgoing connections.
1151The argument must be 1208The argument must be
@@ -1262,6 +1319,8 @@ The format of this file is described above.
1262This file is used by the SSH client. 1319This file is used by the SSH client.
1263Because of the potential for abuse, this file must have strict permissions: 1320Because of the potential for abuse, this file must have strict permissions:
1264read/write for the user, and not accessible by others. 1321read/write for the user, and not accessible by others.
1322It may be group-writable provided that the group in question contains only
1323the user.
1265.It Pa /etc/ssh/ssh_config 1324.It Pa /etc/ssh/ssh_config
1266Systemwide configuration file. 1325Systemwide configuration file.
1267This file provides defaults for those 1326This file provides defaults for those