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 19d13f5c7..45496cfbc 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -72,6 +72,22 @@ Since the first obtained value for each parameter is used, more
72host-specific declarations should be given near the beginning of the 72host-specific declarations should be given near the beginning of the
73file, and general defaults at the end. 73file, and general defaults at the end.
74.Pp 74.Pp
75Note that the Debian
76.Ic openssh-client
77package sets several options as standard in
78.Pa /etc/ssh/ssh_config
79which are not the default in
80.Xr ssh 1 :
81.Pp
82.Bl -bullet -offset indent -compact
83.It
84.Cm SendEnv No LANG LC_*
85.It
86.Cm HashKnownHosts No yes
87.It
88.Cm GSSAPIAuthentication No yes
89.El
90.Pp
75The configuration file has the following format: 91The configuration file has the following format:
76.Pp 92.Pp
77Empty lines and lines starting with 93Empty lines and lines starting with
@@ -128,8 +144,12 @@ Valid arguments are
128If set to 144If set to
129.Dq yes , 145.Dq yes ,
130passphrase/password querying will be disabled. 146passphrase/password querying will be disabled.
147In addition, the
148.Cm ServerAliveInterval
149option will be set to 300 seconds by default.
131This option is useful in scripts and other batch jobs where no user 150This option is useful in scripts and other batch jobs where no user
132is present to supply the password. 151is present to supply the password,
152and where it is desirable to detect a broken network swiftly.
133The argument must be 153The argument must be
134.Dq yes 154.Dq yes
135or 155or
@@ -448,7 +468,8 @@ token used for the session will be set to expire after 20 minutes.
448Remote clients will be refused access after this time. 468Remote clients will be refused access after this time.
449.Pp 469.Pp
450The default is 470The default is
451.Dq no . 471.Dq yes
472(Debian-specific).
452.Pp 473.Pp
453See the X11 SECURITY extension specification for full details on 474See the X11 SECURITY extension specification for full details on
454the restrictions imposed on untrusted clients. 475the restrictions imposed on untrusted clients.
@@ -527,6 +548,9 @@ Note that existing names and addresses in known hosts files
527will not be converted automatically, 548will not be converted automatically,
528but may be manually hashed using 549but may be manually hashed using
529.Xr ssh-keygen 1 . 550.Xr ssh-keygen 1 .
551Use of this option may break facilities such as tab-completion that rely
552on being able to read unhashed host names from
553.Pa ~/.ssh/known_hosts .
530.It Cm HostbasedAuthentication 554.It Cm HostbasedAuthentication
531Specifies whether to try rhosts based authentication with public key 555Specifies whether to try rhosts based authentication with public key
532authentication. 556authentication.
@@ -952,7 +976,10 @@ If, for example,
952.Cm ServerAliveCountMax 976.Cm ServerAliveCountMax
953is left at the default, if the server becomes unresponsive, 977is left at the default, if the server becomes unresponsive,
954ssh will disconnect after approximately 45 seconds. 978ssh will disconnect after approximately 45 seconds.
955This option applies to protocol version 2 only. 979This option applies to protocol version 2 only; in protocol version
9801 there is no mechanism to request a response from the server to the
981server alive messages, so disconnection is the responsibility of the TCP
982stack.
956.It Cm ServerAliveInterval 983.It Cm ServerAliveInterval
957Sets a timeout interval in seconds after which if no data has been received 984Sets a timeout interval in seconds after which if no data has been received
958from the server, 985from the server,
@@ -960,8 +987,15 @@ from the server,
960will send a message through the encrypted 987will send a message through the encrypted
961channel to request a response from the server. 988channel to request a response from the server.
962The default 989The default
963is 0, indicating that these messages will not be sent to the server. 990is 0, indicating that these messages will not be sent to the server,
991or 300 if the
992.Cm BatchMode
993option is set.
964This option applies to protocol version 2 only. 994This option applies to protocol version 2 only.
995.Cm ProtocolKeepAlives
996and
997.Cm SetupTimeOut
998are Debian-specific compatibility aliases for this option.
965.It Cm StrictHostKeyChecking 999.It Cm StrictHostKeyChecking
966If this flag is set to 1000If this flag is set to
967.Dq yes , 1001.Dq yes ,
@@ -1000,6 +1034,12 @@ Specifies whether the system should send TCP keepalive messages to the
1000other side. 1034other side.
1001If they are sent, death of the connection or crash of one 1035If they are sent, death of the connection or crash of one
1002of the machines will be properly noticed. 1036of the machines will be properly noticed.
1037This option only uses TCP keepalives (as opposed to using ssh level
1038keepalives), so takes a long time to notice when the connection dies.
1039As such, you probably want
1040the
1041.Cm ServerAliveInterval
1042option as well.
1003However, this means that 1043However, this means that
1004connections will die if the route is down temporarily, and some people 1044connections will die if the route is down temporarily, and some people
1005find it annoying. 1045find it annoying.
@@ -1051,6 +1091,23 @@ is not specified, it defaults to
1051.Dq any . 1091.Dq any .
1052The default is 1092The default is
1053.Dq any:any . 1093.Dq any:any .
1094.It Cm UseBlacklistedKeys
1095Specifies whether
1096.Xr ssh 1
1097should use keys recorded in its blacklist of known-compromised keys (see
1098.Xr ssh-vulnkey 1 )
1099for authentication.
1100If
1101.Dq yes ,
1102then attempts to use compromised keys for authentication will be logged but
1103accepted.
1104It is strongly recommended that this be used only to install new authorized
1105keys on the remote system, and even then only with the utmost care.
1106If
1107.Dq no ,
1108then attempts to use compromised keys for authentication will be prevented.
1109The default is
1110.Dq no .
1054.It Cm UsePrivilegedPort 1111.It Cm UsePrivilegedPort
1055Specifies whether to use a privileged port for outgoing connections. 1112Specifies whether to use a privileged port for outgoing connections.
1056The argument must be 1113The argument must be
@@ -1167,6 +1224,8 @@ The format of this file is described above.
1167This file is used by the SSH client. 1224This file is used by the SSH client.
1168Because of the potential for abuse, this file must have strict permissions: 1225Because of the potential for abuse, this file must have strict permissions:
1169read/write for the user, and not accessible by others. 1226read/write for the user, and not accessible by others.
1227It may be group-writable provided that the group in question contains only
1228the user.
1170.It Pa /etc/ssh/ssh_config 1229.It Pa /etc/ssh/ssh_config
1171Systemwide configuration file. 1230Systemwide configuration file.
1172This file provides defaults for those 1231This file provides defaults for those