summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.5101
1 files changed, 73 insertions, 28 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 02a87892d..06a32d314 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -33,13 +33,13 @@
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.304 2019/09/13 04:52:34 djm Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.322 2020/02/07 03:54:44 dtucker Exp $
37.Dd $Mdocdate: September 13 2019 $ 37.Dd $Mdocdate: February 7 2020 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
41.Nm ssh_config 41.Nm ssh_config
42.Nd OpenSSH SSH client configuration files 42.Nd OpenSSH client configuration file
43.Sh DESCRIPTION 43.Sh DESCRIPTION
44.Xr ssh 1 44.Xr ssh 1
45obtains configuration data from the following sources in 45obtains configuration data from the following sources in
@@ -264,9 +264,11 @@ Valid arguments are
264.It Cm BatchMode 264.It Cm BatchMode
265If set to 265If set to
266.Cm yes , 266.Cm yes ,
267passphrase/password querying will be disabled. 267user interaction such as password prompts and host key confirmation requests
268will be disabled.
268This option is useful in scripts and other batch jobs where no user 269This option is useful in scripts and other batch jobs where no user
269is present to supply the password. 270is present to interact with
271.Xr ssh 1 .
270The argument must be 272The argument must be
271.Cm yes 273.Cm yes
272or 274or
@@ -381,7 +383,9 @@ flag to
381via 383via
382.Xr ssh-agent 1 , 384.Xr ssh-agent 1 ,
383or via a 385or via a
384.Cm PKCS11Provider . 386.Cm PKCS11Provider
387or
388.Cm SecurityKeyProvider .
385.Pp 389.Pp
386Arguments to 390Arguments to
387.Cm CertificateFile 391.Cm CertificateFile
@@ -564,7 +568,8 @@ specifies that the master connection should remain open
564in the background (waiting for future client connections) 568in the background (waiting for future client connections)
565after the initial client connection has been closed. 569after the initial client connection has been closed.
566If set to 570If set to
567.Cm no , 571.Cm no
572(the default),
568then the master connection will not be placed into the background, 573then the master connection will not be placed into the background,
569and will close as soon as the initial client connection is closed. 574and will close as soon as the initial client connection is closed.
570If set to 575If set to
@@ -667,11 +672,14 @@ and
667.It Cm ForwardAgent 672.It Cm ForwardAgent
668Specifies whether the connection to the authentication agent (if any) 673Specifies whether the connection to the authentication agent (if any)
669will be forwarded to the remote machine. 674will be forwarded to the remote machine.
670The argument must be 675The argument may be
671.Cm yes 676.Cm yes ,
672or
673.Cm no 677.Cm no
674(the default). 678(the default),
679an explicit path to an agent socket or the name of an environment variable
680(beginning with
681.Sq $ )
682in which to find the path.
675.Pp 683.Pp
676Agent forwarding should be enabled with caution. 684Agent forwarding should be enabled with caution.
677Users with the ability to bypass file permissions on the remote host 685Users with the ability to bypass file permissions on the remote host
@@ -771,8 +779,8 @@ These hashed names may be used normally by
771.Xr ssh 1 779.Xr ssh 1
772and 780and
773.Xr sshd 8 , 781.Xr sshd 8 ,
774but they do not reveal identifying information should the file's contents 782but they do not visually reveal identifying information if the
775be disclosed. 783file's contents are disclosed.
776The default is 784The default is
777.Cm no . 785.Cm no .
778Note that existing names and addresses in known hosts files 786Note that existing names and addresses in known hosts files
@@ -807,11 +815,16 @@ The default for this option is:
807ecdsa-sha2-nistp256-cert-v01@openssh.com, 815ecdsa-sha2-nistp256-cert-v01@openssh.com,
808ecdsa-sha2-nistp384-cert-v01@openssh.com, 816ecdsa-sha2-nistp384-cert-v01@openssh.com,
809ecdsa-sha2-nistp521-cert-v01@openssh.com, 817ecdsa-sha2-nistp521-cert-v01@openssh.com,
818sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
810ssh-ed25519-cert-v01@openssh.com, 819ssh-ed25519-cert-v01@openssh.com,
811rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, 820sk-ssh-ed25519-cert-v01@openssh.com,
821rsa-sha2-512-cert-v01@openssh.com,
822rsa-sha2-256-cert-v01@openssh.com,
812ssh-rsa-cert-v01@openssh.com, 823ssh-rsa-cert-v01@openssh.com,
813ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 824ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
814ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 825sk-ecdsa-sha2-nistp256@openssh.com,
826ssh-ed25519,sk-ssh-ed25519@openssh.com,
827rsa-sha2-512,rsa-sha2-256,ssh-rsa
815.Ed 828.Ed
816.Pp 829.Pp
817The 830The
@@ -839,18 +852,23 @@ The default for this option is:
839ecdsa-sha2-nistp256-cert-v01@openssh.com, 852ecdsa-sha2-nistp256-cert-v01@openssh.com,
840ecdsa-sha2-nistp384-cert-v01@openssh.com, 853ecdsa-sha2-nistp384-cert-v01@openssh.com,
841ecdsa-sha2-nistp521-cert-v01@openssh.com, 854ecdsa-sha2-nistp521-cert-v01@openssh.com,
855sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
842ssh-ed25519-cert-v01@openssh.com, 856ssh-ed25519-cert-v01@openssh.com,
843rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, 857sk-ssh-ed25519-cert-v01@openssh.com,
858rsa-sha2-512-cert-v01@openssh.com,
859rsa-sha2-256-cert-v01@openssh.com,
844ssh-rsa-cert-v01@openssh.com, 860ssh-rsa-cert-v01@openssh.com,
845ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 861ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
846ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 862sk-ecdsa-sha2-nistp256@openssh.com,
863ssh-ed25519,sk-ssh-ed25519@openssh.com,
864rsa-sha2-512,rsa-sha2-256,ssh-rsa
847.Ed 865.Ed
848.Pp 866.Pp
849If hostkeys are known for the destination host then this default is modified 867If hostkeys are known for the destination host then this default is modified
850to prefer their algorithms. 868to prefer their algorithms.
851.Pp 869.Pp
852The list of available key types may also be obtained using 870The list of available key types may also be obtained using
853.Qq ssh -Q key . 871.Qq ssh -Q HostKeyAlgorithms .
854.It Cm HostKeyAlias 872.It Cm HostKeyAlias
855Specifies an alias that should be used instead of the 873Specifies an alias that should be used instead of the
856real host name when looking up or saving the host key 874real host name when looking up or saving the host key
@@ -883,6 +901,8 @@ even if
883.Xr ssh-agent 1 901.Xr ssh-agent 1
884or a 902or a
885.Cm PKCS11Provider 903.Cm PKCS11Provider
904or
905.Cm SecurityKeyProvider
886offers more identities. 906offers more identities.
887The argument to this keyword must be 907The argument to this keyword must be
888.Cm yes 908.Cm yes
@@ -919,12 +939,14 @@ or the tokens described in the
919.Sx TOKENS 939.Sx TOKENS
920section. 940section.
921.It Cm IdentityFile 941.It Cm IdentityFile
922Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication 942Specifies a file from which the user's DSA, ECDSA, authenticator-hosted ECDSA,
923identity is read. 943Ed25519, authenticator-hosted Ed25519 or RSA authentication identity is read.
924The default is 944The default is
925.Pa ~/.ssh/id_dsa , 945.Pa ~/.ssh/id_dsa ,
926.Pa ~/.ssh/id_ecdsa , 946.Pa ~/.ssh/id_ecdsa ,
927.Pa ~/.ssh/id_ed25519 947.Pa ~/.ssh/id_ecdsa_sk ,
948.Pa ~/.ssh/id_ed25519 ,
949.Pa ~/.ssh/id_ed25519_sk
928and 950and
929.Pa ~/.ssh/id_rsa . 951.Pa ~/.ssh/id_rsa .
930Additionally, any identities represented by the authentication agent 952Additionally, any identities represented by the authentication agent
@@ -1018,6 +1040,7 @@ Accepted values are
1018.Cm cs6 , 1040.Cm cs6 ,
1019.Cm cs7 , 1041.Cm cs7 ,
1020.Cm ef , 1042.Cm ef ,
1043.Cm le ,
1021.Cm lowdelay , 1044.Cm lowdelay ,
1022.Cm throughput , 1045.Cm throughput ,
1023.Cm reliability , 1046.Cm reliability ,
@@ -1074,8 +1097,7 @@ ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1074diffie-hellman-group-exchange-sha256, 1097diffie-hellman-group-exchange-sha256,
1075diffie-hellman-group16-sha512, 1098diffie-hellman-group16-sha512,
1076diffie-hellman-group18-sha512, 1099diffie-hellman-group18-sha512,
1077diffie-hellman-group14-sha256, 1100diffie-hellman-group14-sha256
1078diffie-hellman-group14-sha1
1079.Ed 1101.Ed
1080.Pp 1102.Pp
1081The list of available key exchange algorithms may also be obtained using 1103The list of available key exchange algorithms may also be obtained using
@@ -1318,15 +1340,20 @@ The default for this option is:
1318ecdsa-sha2-nistp256-cert-v01@openssh.com, 1340ecdsa-sha2-nistp256-cert-v01@openssh.com,
1319ecdsa-sha2-nistp384-cert-v01@openssh.com, 1341ecdsa-sha2-nistp384-cert-v01@openssh.com,
1320ecdsa-sha2-nistp521-cert-v01@openssh.com, 1342ecdsa-sha2-nistp521-cert-v01@openssh.com,
1343sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
1321ssh-ed25519-cert-v01@openssh.com, 1344ssh-ed25519-cert-v01@openssh.com,
1322rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, 1345sk-ssh-ed25519-cert-v01@openssh.com,
1346rsa-sha2-512-cert-v01@openssh.com,
1347rsa-sha2-256-cert-v01@openssh.com,
1323ssh-rsa-cert-v01@openssh.com, 1348ssh-rsa-cert-v01@openssh.com,
1324ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 1349ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1325ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 1350sk-ecdsa-sha2-nistp256@openssh.com,
1351ssh-ed25519,sk-ssh-ed25519@openssh.com,
1352rsa-sha2-512,rsa-sha2-256,ssh-rsa
1326.Ed 1353.Ed
1327.Pp 1354.Pp
1328The list of available key types may also be obtained using 1355The list of available key types may also be obtained using
1329.Qq ssh -Q key . 1356.Qq ssh -Q PubkeyAcceptedKeyTypes .
1330.It Cm PubkeyAuthentication 1357.It Cm PubkeyAuthentication
1331Specifies whether to try public key authentication. 1358Specifies whether to try public key authentication.
1332The argument to this keyword must be 1359The argument to this keyword must be
@@ -1437,6 +1464,15 @@ an OpenSSH Key Revocation List (KRL) as generated by
1437.Xr ssh-keygen 1 . 1464.Xr ssh-keygen 1 .
1438For more information on KRLs, see the KEY REVOCATION LISTS section in 1465For more information on KRLs, see the KEY REVOCATION LISTS section in
1439.Xr ssh-keygen 1 . 1466.Xr ssh-keygen 1 .
1467.It Cm SecurityKeyProvider
1468Specifies a path to a library that will be used when loading any
1469FIDO authenticator-hosted keys, overriding the default of using
1470the built-in USB HID support.
1471.Pp
1472If the specified value begins with a
1473.Sq $
1474character, then it will be treated as an environment variable containing
1475the path to the library.
1440.It Cm SendEnv 1476.It Cm SendEnv
1441Specifies what variables from the local 1477Specifies what variables from the local
1442.Xr environ 7 1478.Xr environ 7
@@ -1642,13 +1678,22 @@ after authentication has completed and add them to
1642The argument must be 1678The argument must be
1643.Cm yes , 1679.Cm yes ,
1644.Cm no 1680.Cm no
1645(the default) or 1681or
1646.Cm ask . 1682.Cm ask .
1647Enabling this option allows learning alternate hostkeys for a server 1683This option allows learning alternate hostkeys for a server
1648and supports graceful key rotation by allowing a server to send replacement 1684and supports graceful key rotation by allowing a server to send replacement
1649public keys before old ones are removed. 1685public keys before old ones are removed.
1650Additional hostkeys are only accepted if the key used to authenticate the 1686Additional hostkeys are only accepted if the key used to authenticate the
1651host was already trusted or explicitly accepted by the user. 1687host was already trusted or explicitly accepted by the user.
1688.Pp
1689.Cm UpdateHostKeys
1690is enabled by default if the user has not overridden the default
1691.Cm UserKnownHostsFile
1692setting, otherwise
1693.Cm UpdateHostKeys
1694will be set to
1695.Cm ask .
1696.Pp
1652If 1697If
1653.Cm UpdateHostKeys 1698.Cm UpdateHostKeys
1654is set to 1699is set to