summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.584
1 files changed, 53 insertions, 31 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index a9f6d906f..b71d5ede9 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.292 2019/03/01 02:16:47 djm Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.304 2019/09/13 04:52:34 djm Exp $
37.Dd $Mdocdate: March 1 2019 $ 37.Dd $Mdocdate: September 13 2019 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -381,7 +381,7 @@ Specifies which algorithms are allowed for signing of certificates
381by certificate authorities (CAs). 381by certificate authorities (CAs).
382The default is: 382The default is:
383.Bd -literal -offset indent 383.Bd -literal -offset indent
384ecdsa-sha2-nistp256.ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 384ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
385ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 385ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa
386.Ed 386.Ed
387.Pp 387.Pp
@@ -442,14 +442,18 @@ the check will not be executed.
442.It Cm Ciphers 442.It Cm Ciphers
443Specifies the ciphers allowed and their order of preference. 443Specifies the ciphers allowed and their order of preference.
444Multiple ciphers must be comma-separated. 444Multiple ciphers must be comma-separated.
445If the specified value begins with a 445If the specified list begins with a
446.Sq + 446.Sq +
447character, then the specified ciphers will be appended to the default set 447character, then the specified ciphers will be appended to the default set
448instead of replacing them. 448instead of replacing them.
449If the specified value begins with a 449If the specified list begins with a
450.Sq - 450.Sq -
451character, then the specified ciphers (including wildcards) will be removed 451character, then the specified ciphers (including wildcards) will be removed
452from the default set instead of replacing them. 452from the default set instead of replacing them.
453If the specified list begins with a
454.Sq ^
455character, then the specified ciphers will be placed at the head of the
456default set.
453.Pp 457.Pp
454The supported ciphers are: 458The supported ciphers are:
455.Bd -literal -offset indent 459.Bd -literal -offset indent
@@ -505,8 +509,8 @@ The default is 1.
505.It Cm ConnectTimeout 509.It Cm ConnectTimeout
506Specifies the timeout (in seconds) used when connecting to the 510Specifies the timeout (in seconds) used when connecting to the
507SSH server, instead of using the default system TCP timeout. 511SSH server, instead of using the default system TCP timeout.
508This value is used only when the target is down or really unreachable, 512This timeout is applied both to establishing the connection and to performing
509not when it refuses the connection. 513the initial SSH protocol handshake and key exchange.
510.It Cm ControlMaster 514.It Cm ControlMaster
511Enables the sharing of multiple sessions over a single network connection. 515Enables the sharing of multiple sessions over a single network connection.
512When set to 516When set to
@@ -867,14 +871,18 @@ or
867.It Cm HostbasedKeyTypes 871.It Cm HostbasedKeyTypes
868Specifies the key types that will be used for hostbased authentication 872Specifies the key types that will be used for hostbased authentication
869as a comma-separated list of patterns. 873as a comma-separated list of patterns.
870Alternately if the specified value begins with a 874Alternately if the specified list begins with a
871.Sq + 875.Sq +
872character, then the specified key types will be appended to the default set 876character, then the specified key types will be appended to the default set
873instead of replacing them. 877instead of replacing them.
874If the specified value begins with a 878If the specified list begins with a
875.Sq - 879.Sq -
876character, then the specified key types (including wildcards) will be removed 880character, then the specified key types (including wildcards) will be removed
877from the default set instead of replacing them. 881from the default set instead of replacing them.
882If the specified list begins with a
883.Sq ^
884character, then the specified key types will be placed at the head of the
885default set.
878The default for this option is: 886The default for this option is:
879.Bd -literal -offset 3n 887.Bd -literal -offset 3n
880ecdsa-sha2-nistp256-cert-v01@openssh.com, 888ecdsa-sha2-nistp256-cert-v01@openssh.com,
@@ -895,14 +903,18 @@ may be used to list supported key types.
895.It Cm HostKeyAlgorithms 903.It Cm HostKeyAlgorithms
896Specifies the host key algorithms 904Specifies the host key algorithms
897that the client wants to use in order of preference. 905that the client wants to use in order of preference.
898Alternately if the specified value begins with a 906Alternately if the specified list begins with a
899.Sq + 907.Sq +
900character, then the specified key types will be appended to the default set 908character, then the specified key types will be appended to the default set
901instead of replacing them. 909instead of replacing them.
902If the specified value begins with a 910If the specified list begins with a
903.Sq - 911.Sq -
904character, then the specified key types (including wildcards) will be removed 912character, then the specified key types (including wildcards) will be removed
905from the default set instead of replacing them. 913from the default set instead of replacing them.
914If the specified list begins with a
915.Sq ^
916character, then the specified key types will be placed at the head of the
917default set.
906The default for this option is: 918The default for this option is:
907.Bd -literal -offset 3n 919.Bd -literal -offset 3n
908ecdsa-sha2-nistp256-cert-v01@openssh.com, 920ecdsa-sha2-nistp256-cert-v01@openssh.com,
@@ -926,28 +938,28 @@ real host name when looking up or saving the host key
926in the host key database files and when validating host certificates. 938in the host key database files and when validating host certificates.
927This option is useful for tunneling SSH connections 939This option is useful for tunneling SSH connections
928or for multiple servers running on a single host. 940or for multiple servers running on a single host.
929.It Cm HostName 941.It Cm Hostname
930Specifies the real host name to log into. 942Specifies the real host name to log into.
931This can be used to specify nicknames or abbreviations for hosts. 943This can be used to specify nicknames or abbreviations for hosts.
932Arguments to 944Arguments to
933.Cm HostName 945.Cm Hostname
934accept the tokens described in the 946accept the tokens described in the
935.Sx TOKENS 947.Sx TOKENS
936section. 948section.
937Numeric IP addresses are also permitted (both on the command line and in 949Numeric IP addresses are also permitted (both on the command line and in
938.Cm HostName 950.Cm Hostname
939specifications). 951specifications).
940The default is the name given on the command line. 952The default is the name given on the command line.
941.It Cm IdentitiesOnly 953.It Cm IdentitiesOnly
942Specifies that 954Specifies that
943.Xr ssh 1 955.Xr ssh 1
944should only use the authentication identity and certificate files explicitly 956should only use the configured authentication identity and certificate files
945configured in the 957(either the default files, or those explicitly configured in the
946.Nm 958.Nm
947files 959files
948or passed on the 960or passed on the
949.Xr ssh 1 961.Xr ssh 1
950command-line, 962command-line),
951even if 963even if
952.Xr ssh-agent 1 964.Xr ssh-agent 1
953or a 965or a
@@ -1122,14 +1134,18 @@ and
1122.It Cm KexAlgorithms 1134.It Cm KexAlgorithms
1123Specifies the available KEX (Key Exchange) algorithms. 1135Specifies the available KEX (Key Exchange) algorithms.
1124Multiple algorithms must be comma-separated. 1136Multiple algorithms must be comma-separated.
1125Alternately if the specified value begins with a 1137If the specified list begins with a
1126.Sq + 1138.Sq +
1127character, then the specified methods will be appended to the default set 1139character, then the specified methods will be appended to the default set
1128instead of replacing them. 1140instead of replacing them.
1129If the specified value begins with a 1141If the specified list begins with a
1130.Sq - 1142.Sq -
1131character, then the specified methods (including wildcards) will be removed 1143character, then the specified methods (including wildcards) will be removed
1132from the default set instead of replacing them. 1144from the default set instead of replacing them.
1145If the specified list begins with a
1146.Sq ^
1147character, then the specified methods will be placed at the head of the
1148default set.
1133The default is: 1149The default is:
1134.Bd -literal -offset indent 1150.Bd -literal -offset indent
1135curve25519-sha256,curve25519-sha256@libssh.org, 1151curve25519-sha256,curve25519-sha256@libssh.org,
@@ -1203,14 +1219,18 @@ Specifies the MAC (message authentication code) algorithms
1203in order of preference. 1219in order of preference.
1204The MAC algorithm is used for data integrity protection. 1220The MAC algorithm is used for data integrity protection.
1205Multiple algorithms must be comma-separated. 1221Multiple algorithms must be comma-separated.
1206If the specified value begins with a 1222If the specified list begins with a
1207.Sq + 1223.Sq +
1208character, then the specified algorithms will be appended to the default set 1224character, then the specified algorithms will be appended to the default set
1209instead of replacing them. 1225instead of replacing them.
1210If the specified value begins with a 1226If the specified list begins with a
1211.Sq - 1227.Sq -
1212character, then the specified algorithms (including wildcards) will be removed 1228character, then the specified algorithms (including wildcards) will be removed
1213from the default set instead of replacing them. 1229from the default set instead of replacing them.
1230If the specified list begins with a
1231.Sq ^
1232character, then the specified algorithms will be placed at the head of the
1233default set.
1214.Pp 1234.Pp
1215The algorithms that contain 1235The algorithms that contain
1216.Qq -etm 1236.Qq -etm
@@ -1301,8 +1321,8 @@ server running on some machine, or execute
1301.Ic sshd -i 1321.Ic sshd -i
1302somewhere. 1322somewhere.
1303Host key management will be done using the 1323Host key management will be done using the
1304HostName of the host being connected (defaulting to the name typed by 1324.Cm Hostname
1305the user). 1325of the host being connected (defaulting to the name typed by the user).
1306Setting the command to 1326Setting the command to
1307.Cm none 1327.Cm none
1308disables this option entirely. 1328disables this option entirely.
@@ -1360,14 +1380,18 @@ The default is
1360.It Cm PubkeyAcceptedKeyTypes 1380.It Cm PubkeyAcceptedKeyTypes
1361Specifies the key types that will be used for public key authentication 1381Specifies the key types that will be used for public key authentication
1362as a comma-separated list of patterns. 1382as a comma-separated list of patterns.
1363Alternately if the specified value begins with a 1383If the specified list begins with a
1364.Sq + 1384.Sq +
1365character, then the key types after it will be appended to the default 1385character, then the key types after it will be appended to the default
1366instead of replacing it. 1386instead of replacing it.
1367If the specified value begins with a 1387If the specified list begins with a
1368.Sq - 1388.Sq -
1369character, then the specified key types (including wildcards) will be removed 1389character, then the specified key types (including wildcards) will be removed
1370from the default set instead of replacing them. 1390from the default set instead of replacing them.
1391If the specified list begins with a
1392.Sq ^
1393character, then the specified key types will be placed at the head of the
1394default set.
1371The default for this option is: 1395The default for this option is:
1372.Bd -literal -offset 3n 1396.Bd -literal -offset 3n
1373ecdsa-sha2-nistp256-cert-v01@openssh.com, 1397ecdsa-sha2-nistp256-cert-v01@openssh.com,
@@ -1405,9 +1429,7 @@ and
1405.Sq 4G , 1429.Sq 4G ,
1406depending on the cipher. 1430depending on the cipher.
1407The optional second value is specified in seconds and may use any of the 1431The optional second value is specified in seconds and may use any of the
1408units documented in the 1432units documented in the TIME FORMATS section of
1409.Sx TIME FORMATS
1410section of
1411.Xr sshd_config 5 . 1433.Xr sshd_config 5 .
1412The default value for 1434The default value for
1413.Cm RekeyLimit 1435.Cm RekeyLimit
@@ -1541,7 +1563,7 @@ The TCP keepalive option enabled by
1541.Cm TCPKeepAlive 1563.Cm TCPKeepAlive
1542is spoofable. 1564is spoofable.
1543The server alive mechanism is valuable when the client or 1565The server alive mechanism is valuable when the client or
1544server depend on knowing when a connection has become inactive. 1566server depend on knowing when a connection has become unresponsive.
1545.Pp 1567.Pp
1546The default value is 3. 1568The default value is 3.
1547If, for example, 1569If, for example,
@@ -1879,7 +1901,7 @@ accepts the tokens %%, %d, %h, %i, %l, %r, and %u.
1879.Cm ControlPath 1901.Cm ControlPath
1880accepts the tokens %%, %C, %h, %i, %L, %l, %n, %p, %r, and %u. 1902accepts the tokens %%, %C, %h, %i, %L, %l, %n, %p, %r, and %u.
1881.Pp 1903.Pp
1882.Cm HostName 1904.Cm Hostname
1883accepts the tokens %% and %h. 1905accepts the tokens %% and %h.
1884.Pp 1906.Pp
1885.Cm IdentityAgent 1907.Cm IdentityAgent
@@ -1891,7 +1913,7 @@ accept the tokens %%, %d, %h, %i, %l, %r, and %u.
1891accepts the tokens %%, %C, %d, %h, %i, %l, %n, %p, %r, %T, and %u. 1913accepts the tokens %%, %C, %d, %h, %i, %l, %n, %p, %r, %T, and %u.
1892.Pp 1914.Pp
1893.Cm ProxyCommand 1915.Cm ProxyCommand
1894accepts the tokens %%, %h, %p, and %r. 1916accepts the tokens %%, %h, %n, %p, and %r.
1895.Pp 1917.Pp
1896.Cm RemoteCommand 1918.Cm RemoteCommand
1897accepts the tokens %%, %C, %d, %h, %i, %l, %n, %p, %r, and %u. 1919accepts the tokens %%, %C, %d, %h, %i, %l, %n, %p, %r, and %u.