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 15eecb6ff..1b8b8da5d 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.
@@ -517,6 +538,9 @@ Note that existing names and addresses in known hosts files
517will not be converted automatically, 538will not be converted automatically,
518but may be manually hashed using 539but may be manually hashed using
519.Xr ssh-keygen 1 . 540.Xr ssh-keygen 1 .
541Use of this option may break facilities such as tab-completion that rely
542on being able to read unhashed host names from
543.Pa ~/.ssh/known_hosts .
520.It Cm HostbasedAuthentication 544.It Cm HostbasedAuthentication
521Specifies whether to try rhosts based authentication with public key 545Specifies whether to try rhosts based authentication with public key
522authentication. 546authentication.
@@ -671,7 +695,7 @@ indicates that the port should be available from all interfaces.
671Gives the verbosity level that is used when logging messages from 695Gives the verbosity level that is used when logging messages from
672.Xr ssh 1 . 696.Xr ssh 1 .
673The possible values are: 697The possible values are:
674QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. 698SILENT, QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
675The default is INFO. 699The default is INFO.
676DEBUG and DEBUG1 are equivalent. 700DEBUG and DEBUG1 are equivalent.
677DEBUG2 and DEBUG3 each specify higher levels of verbose output. 701DEBUG2 and DEBUG3 each specify higher levels of verbose output.
@@ -917,7 +941,10 @@ If, for example,
917.Cm ServerAliveCountMax 941.Cm ServerAliveCountMax
918is left at the default, if the server becomes unresponsive, 942is left at the default, if the server becomes unresponsive,
919ssh will disconnect after approximately 45 seconds. 943ssh will disconnect after approximately 45 seconds.
920This option applies to protocol version 2 only. 944This option applies to protocol version 2 only; in protocol version
9451 there is no mechanism to request a response from the server to the
946server alive messages, so disconnection is the responsibility of the TCP
947stack.
921.It Cm ServerAliveInterval 948.It Cm ServerAliveInterval
922Sets a timeout interval in seconds after which if no data has been received 949Sets a timeout interval in seconds after which if no data has been received
923from the server, 950from the server,
@@ -925,8 +952,15 @@ from the server,
925will send a message through the encrypted 952will send a message through the encrypted
926channel to request a response from the server. 953channel to request a response from the server.
927The default 954The default
928is 0, indicating that these messages will not be sent to the server. 955is 0, indicating that these messages will not be sent to the server,
956or 300 if the
957.Cm BatchMode
958option is set.
929This option applies to protocol version 2 only. 959This option applies to protocol version 2 only.
960.Cm ProtocolKeepAlives
961and
962.Cm SetupTimeOut
963are Debian-specific compatibility aliases for this option.
930.It Cm SmartcardDevice 964.It Cm SmartcardDevice
931Specifies which smartcard device to use. 965Specifies which smartcard device to use.
932The argument to this keyword is the device 966The argument to this keyword is the device
@@ -972,6 +1006,12 @@ Specifies whether the system should send TCP keepalive messages to the
972other side. 1006other side.
973If they are sent, death of the connection or crash of one 1007If they are sent, death of the connection or crash of one
974of the machines will be properly noticed. 1008of the machines will be properly noticed.
1009This option only uses TCP keepalives (as opposed to using ssh level
1010keepalives), so takes a long time to notice when the connection dies.
1011As such, you probably want
1012the
1013.Cm ServerAliveInterval
1014option as well.
975However, this means that 1015However, this means that
976connections will die if the route is down temporarily, and some people 1016connections will die if the route is down temporarily, and some people
977find it annoying. 1017find it annoying.
@@ -1023,6 +1063,23 @@ is not specified, it defaults to
1023.Dq any . 1063.Dq any .
1024The default is 1064The default is
1025.Dq any:any . 1065.Dq any:any .
1066.It Cm UseBlacklistedKeys
1067Specifies whether
1068.Xr ssh 1
1069should use keys recorded in its blacklist of known-compromised keys (see
1070.Xr ssh-vulnkey 1 )
1071for authentication.
1072If
1073.Dq yes ,
1074then attempts to use compromised keys for authentication will be logged but
1075accepted.
1076It is strongly recommended that this be used only to install new authorized
1077keys on the remote system, and even then only with the utmost care.
1078If
1079.Dq no ,
1080then attempts to use compromised keys for authentication will be prevented.
1081The default is
1082.Dq no .
1026.It Cm UsePrivilegedPort 1083.It Cm UsePrivilegedPort
1027Specifies whether to use a privileged port for outgoing connections. 1084Specifies whether to use a privileged port for outgoing connections.
1028The argument must be 1085The argument must be
@@ -1137,6 +1194,8 @@ The format of this file is described above.
1137This file is used by the SSH client. 1194This file is used by the SSH client.
1138Because of the potential for abuse, this file must have strict permissions: 1195Because of the potential for abuse, this file must have strict permissions:
1139read/write for the user, and not accessible by others. 1196read/write for the user, and not accessible by others.
1197It may be group-writable provided that the group in question contains only
1198the user.
1140.It Pa /etc/ssh/ssh_config 1199.It Pa /etc/ssh/ssh_config
1141Systemwide configuration file. 1200Systemwide configuration file.
1142This file provides defaults for those 1201This file provides defaults for those