summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.5116
1 files changed, 83 insertions, 33 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index f6c1b3b33..a9f6d906f 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -33,8 +33,8 @@
33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35.\" 35.\"
36.\" $OpenBSD: ssh_config.5,v 1.286 2018/10/03 06:38:35 djm Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.292 2019/03/01 02:16:47 djm Exp $
37.Dd $Mdocdate: October 3 2018 $ 37.Dd $Mdocdate: March 1 2019 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -155,6 +155,7 @@ or the single token
155which always matches. 155which always matches.
156The available criteria keywords are: 156The available criteria keywords are:
157.Cm canonical , 157.Cm canonical ,
158.Cm final ,
158.Cm exec , 159.Cm exec ,
159.Cm host , 160.Cm host ,
160.Cm originalhost , 161.Cm originalhost ,
@@ -164,12 +165,15 @@ and
164The 165The
165.Cm all 166.Cm all
166criteria must appear alone or immediately after 167criteria must appear alone or immediately after
167.Cm canonical . 168.Cm canonical
169or
170.Cm final .
168Other criteria may be combined arbitrarily. 171Other criteria may be combined arbitrarily.
169All criteria but 172All criteria but
170.Cm all 173.Cm all ,
174.Cm canonical ,
171and 175and
172.Cm canonical 176.Cm final
173require an argument. 177require an argument.
174Criteria may be negated by prepending an exclamation mark 178Criteria may be negated by prepending an exclamation mark
175.Pq Sq !\& . 179.Pq Sq !\& .
@@ -179,9 +183,23 @@ The
179keyword matches only when the configuration file is being re-parsed 183keyword matches only when the configuration file is being re-parsed
180after hostname canonicalization (see the 184after hostname canonicalization (see the
181.Cm CanonicalizeHostname 185.Cm CanonicalizeHostname
182option.) 186option).
183This may be useful to specify conditions that work with canonical host 187This may be useful to specify conditions that work with canonical host
184names only. 188names only.
189.Pp
190The
191.Cm final
192keyword requests that the configuration be re-parsed (regardless of whether
193.Cm CanonicalizeHostname
194is enabled), and matches only during this final pass.
195If
196.Cm CanonicalizeHostname
197is enabled, then
198.Cm canonical
199and
200.Cm final
201match during the same pass.
202.Pp
185The 203The
186.Cm exec 204.Cm exec
187keyword executes the specified command under the user's shell. 205keyword executes the specified command under the user's shell.
@@ -757,42 +775,67 @@ The default is
757Specifies whether user authentication based on GSSAPI is allowed. 775Specifies whether user authentication based on GSSAPI is allowed.
758The default is 776The default is
759.Cm no . 777.Cm no .
760.It Cm GSSAPIKeyExchange
761Specifies whether key exchange based on GSSAPI may be used. When using
762GSSAPI key exchange the server need not have a host key.
763The default is
764.Cm no .
765.It Cm GSSAPIClientIdentity 778.It Cm GSSAPIClientIdentity
766If set, specifies the GSSAPI client identity that ssh should use when 779If set, specifies the GSSAPI client identity that ssh should use when
767connecting to the server. The default is unset, which means that the default 780connecting to the server. The default is unset, which means that the default
768identity will be used. 781identity will be used.
769.It Cm GSSAPIServerIdentity
770If set, specifies the GSSAPI server identity that ssh should expect when
771connecting to the server. The default is unset, which means that the
772expected GSSAPI server identity will be determined from the target
773hostname.
774.It Cm GSSAPIDelegateCredentials 782.It Cm GSSAPIDelegateCredentials
775Forward (delegate) credentials to the server. 783Forward (delegate) credentials to the server.
776The default is 784The default is
777.Cm no . 785.Cm no .
786.It Cm GSSAPIKeyExchange
787Specifies whether key exchange based on GSSAPI may be used. When using
788GSSAPI key exchange the server need not have a host key.
789The default is
790.Dq no .
778.It Cm GSSAPIRenewalForcesRekey 791.It Cm GSSAPIRenewalForcesRekey
779If set to 792If set to
780.Cm yes 793.Dq yes
781then renewal of the client's GSSAPI credentials will force the rekeying of the 794then renewal of the client's GSSAPI credentials will force the rekeying of the
782ssh connection. With a compatible server, this can delegate the renewed 795ssh connection. With a compatible server, this will delegate the renewed
783credentials to a session on the server. 796credentials to a session on the server.
797.Pp
798Checks are made to ensure that credentials are only propagated when the new
799credentials match the old ones on the originating client and where the
800receiving server still has the old set in its cache.
801.Pp
784The default is 802The default is
785.Cm no . 803.Dq no .
804.Pp
805For this to work
806.Cm GSSAPIKeyExchange
807needs to be enabled in the server and also used by the client.
808.It Cm GSSAPIServerIdentity
809If set, specifies the GSSAPI server identity that ssh should expect when
810connecting to the server. The default is unset, which means that the
811expected GSSAPI server identity will be determined from the target
812hostname.
786.It Cm GSSAPITrustDns 813.It Cm GSSAPITrustDns
787Set to 814Set to
788.Cm yes 815.Dq yes
789to indicate that the DNS is trusted to securely canonicalize 816to indicate that the DNS is trusted to securely canonicalize
790the name of the host being connected to. If 817the name of the host being connected to. If
791.Cm no , 818.Dq no ,
792the hostname entered on the 819the hostname entered on the
793command line will be passed untouched to the GSSAPI library. 820command line will be passed untouched to the GSSAPI library.
794The default is 821The default is
795.Cm no . 822.Dq no .
823.It Cm GSSAPIKexAlgorithms
824The list of key exchange algorithms that are offered for GSSAPI
825key exchange. Possible values are
826.Bd -literal -offset 3n
827gss-gex-sha1-,
828gss-group1-sha1-,
829gss-group14-sha1-,
830gss-group14-sha256-,
831gss-group16-sha512-,
832gss-nistp256-sha256-,
833gss-curve25519-sha256-
834.Ed
835.Pp
836The default is
837.Dq gss-gex-sha1-,gss-group14-sha1- .
838This option only applies to protocol version 2 connections using GSSAPI.
796.It Cm HashKnownHosts 839.It Cm HashKnownHosts
797Indicates that 840Indicates that
798.Xr ssh 1 841.Xr ssh 1
@@ -1094,7 +1137,6 @@ ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1094diffie-hellman-group-exchange-sha256, 1137diffie-hellman-group-exchange-sha256,
1095diffie-hellman-group16-sha512, 1138diffie-hellman-group16-sha512,
1096diffie-hellman-group18-sha512, 1139diffie-hellman-group18-sha512,
1097diffie-hellman-group-exchange-sha1,
1098diffie-hellman-group14-sha256, 1140diffie-hellman-group14-sha256,
1099diffie-hellman-group14-sha1 1141diffie-hellman-group14-sha1
1100.Ed 1142.Ed
@@ -1217,11 +1259,13 @@ or
1217.Cm no 1259.Cm no
1218(the default). 1260(the default).
1219.It Cm PKCS11Provider 1261.It Cm PKCS11Provider
1220Specifies which PKCS#11 provider to use. 1262Specifies which PKCS#11 provider to use or
1221The argument to this keyword is the PKCS#11 shared library 1263.Cm none
1264to indicate that no provider should be used (the default).
1265The argument to this keyword is a path to the PKCS#11 shared library
1222.Xr ssh 1 1266.Xr ssh 1
1223should use to communicate with a PKCS#11 token providing the user's 1267should use to communicate with a PKCS#11 token providing keys for user
1224private RSA key. 1268authentication.
1225.It Cm Port 1269.It Cm Port
1226Specifies the port number to connect on the remote host. 1270Specifies the port number to connect on the remote host.
1227The default is 22. 1271The default is 22.
@@ -1299,6 +1343,12 @@ Note that this option will compete with the
1299.Cm ProxyCommand 1343.Cm ProxyCommand
1300option - whichever is specified first will prevent later instances of the 1344option - whichever is specified first will prevent later instances of the
1301other from taking effect. 1345other from taking effect.
1346.Pp
1347Note also that the configuration for the destination host (either supplied
1348via the command-line or the configuration file) is not generally applied
1349to jump hosts.
1350.Pa ~/.ssh/config
1351should be used if specific configuration is required for jump hosts.
1302.It Cm ProxyUseFdpass 1352.It Cm ProxyUseFdpass
1303Specifies that 1353Specifies that
1304.Cm ProxyCommand 1354.Cm ProxyCommand
@@ -1852,7 +1902,7 @@ This is the per-user configuration file.
1852The format of this file is described above. 1902The format of this file is described above.
1853This file is used by the SSH client. 1903This file is used by the SSH client.
1854Because of the potential for abuse, this file must have strict permissions: 1904Because of the potential for abuse, this file must have strict permissions:
1855read/write for the user, and not accessible by others. 1905read/write for the user, and not writable by others.
1856It may be group-writable provided that the group in question contains only 1906It may be group-writable provided that the group in question contains only
1857the user. 1907the user.
1858.It Pa /etc/ssh/ssh_config 1908.It Pa /etc/ssh/ssh_config