summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.569
1 files changed, 64 insertions, 5 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index de1c71765..0ce851aa8 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.
@@ -694,7 +718,7 @@ indicates that the port should be available from all interfaces.
694Gives the verbosity level that is used when logging messages from 718Gives the verbosity level that is used when logging messages from
695.Xr ssh 1 . 719.Xr ssh 1 .
696The possible values are: 720The possible values are:
697QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. 721SILENT, QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
698The default is INFO. 722The default is INFO.
699DEBUG and DEBUG1 are equivalent. 723DEBUG and DEBUG1 are equivalent.
700DEBUG2 and DEBUG3 each specify higher levels of verbose output. 724DEBUG2 and DEBUG3 each specify higher levels of verbose output.
@@ -956,7 +980,10 @@ If, for example,
956.Cm ServerAliveCountMax 980.Cm ServerAliveCountMax
957is left at the default, if the server becomes unresponsive, 981is left at the default, if the server becomes unresponsive,
958ssh will disconnect after approximately 45 seconds. 982ssh will disconnect after approximately 45 seconds.
959This option applies to protocol version 2 only. 983This option applies to protocol version 2 only; in protocol version
9841 there is no mechanism to request a response from the server to the
985server alive messages, so disconnection is the responsibility of the TCP
986stack.
960.It Cm ServerAliveInterval 987.It Cm ServerAliveInterval
961Sets a timeout interval in seconds after which if no data has been received 988Sets a timeout interval in seconds after which if no data has been received
962from the server, 989from the server,
@@ -964,8 +991,15 @@ from the server,
964will send a message through the encrypted 991will send a message through the encrypted
965channel to request a response from the server. 992channel to request a response from the server.
966The default 993The default
967is 0, indicating that these messages will not be sent to the server. 994is 0, indicating that these messages will not be sent to the server,
995or 300 if the
996.Cm BatchMode
997option is set.
968This option applies to protocol version 2 only. 998This option applies to protocol version 2 only.
999.Cm ProtocolKeepAlives
1000and
1001.Cm SetupTimeOut
1002are Debian-specific compatibility aliases for this option.
969.It Cm StrictHostKeyChecking 1003.It Cm StrictHostKeyChecking
970If this flag is set to 1004If this flag is set to
971.Dq yes , 1005.Dq yes ,
@@ -1004,6 +1038,12 @@ Specifies whether the system should send TCP keepalive messages to the
1004other side. 1038other side.
1005If they are sent, death of the connection or crash of one 1039If they are sent, death of the connection or crash of one
1006of the machines will be properly noticed. 1040of the machines will be properly noticed.
1041This option only uses TCP keepalives (as opposed to using ssh level
1042keepalives), so takes a long time to notice when the connection dies.
1043As such, you probably want
1044the
1045.Cm ServerAliveInterval
1046option as well.
1007However, this means that 1047However, this means that
1008connections will die if the route is down temporarily, and some people 1048connections will die if the route is down temporarily, and some people
1009find it annoying. 1049find it annoying.
@@ -1055,6 +1095,23 @@ is not specified, it defaults to
1055.Dq any . 1095.Dq any .
1056The default is 1096The default is
1057.Dq any:any . 1097.Dq any:any .
1098.It Cm UseBlacklistedKeys
1099Specifies whether
1100.Xr ssh 1
1101should use keys recorded in its blacklist of known-compromised keys (see
1102.Xr ssh-vulnkey 1 )
1103for authentication.
1104If
1105.Dq yes ,
1106then attempts to use compromised keys for authentication will be logged but
1107accepted.
1108It is strongly recommended that this be used only to install new authorized
1109keys on the remote system, and even then only with the utmost care.
1110If
1111.Dq no ,
1112then attempts to use compromised keys for authentication will be prevented.
1113The default is
1114.Dq no .
1058.It Cm UsePrivilegedPort 1115.It Cm UsePrivilegedPort
1059Specifies whether to use a privileged port for outgoing connections. 1116Specifies whether to use a privileged port for outgoing connections.
1060The argument must be 1117The argument must be
@@ -1171,6 +1228,8 @@ The format of this file is described above.
1171This file is used by the SSH client. 1228This file is used by the SSH client.
1172Because of the potential for abuse, this file must have strict permissions: 1229Because of the potential for abuse, this file must have strict permissions:
1173read/write for the user, and not accessible by others. 1230read/write for the user, and not accessible by others.
1231It may be group-writable provided that the group in question contains only
1232the user.
1174.It Pa /etc/ssh/ssh_config 1233.It Pa /etc/ssh/ssh_config
1175Systemwide configuration file. 1234Systemwide configuration file.
1176This file provides defaults for those 1235This file provides defaults for those