summaryrefslogtreecommitdiff
path: root/sshd_config.5
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2020-02-21 11:57:14 +0000
committerColin Watson <cjwatson@debian.org>2020-02-21 14:27:02 +0000
commit886e47e745586c34e81cfd5c5fb9b5dbc8e84d04 (patch)
treedd6c3b4dc64a17c520af7aaf213163f8a0a63e56 /sshd_config.5
parentac2b4c0697fcac554041ab95f81736887eadf6ec (diff)
parenta2dabf35ce0228c86a288d11cc847a9d9801604f (diff)
New upstream release (8.2p1)
Diffstat (limited to 'sshd_config.5')
-rw-r--r--sshd_config.5121
1 files changed, 87 insertions, 34 deletions
diff --git a/sshd_config.5 b/sshd_config.5
index ba533af9e..fd205e418 100644
--- a/sshd_config.5
+++ b/sshd_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: sshd_config.5,v 1.290 2019/09/06 14:45:34 naddy Exp $ 36.\" $OpenBSD: sshd_config.5,v 1.307 2020/02/07 03:54:44 dtucker Exp $
37.Dd $Mdocdate: September 6 2019 $ 37.Dd $Mdocdate: February 7 2020 $
38.Dt SSHD_CONFIG 5 38.Dt SSHD_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
41.Nm sshd_config 41.Nm sshd_config
42.Nd OpenSSH SSH daemon configuration file 42.Nd OpenSSH daemon configuration file
43.Sh DESCRIPTION 43.Sh DESCRIPTION
44.Xr sshd 8 44.Xr sshd 8
45reads configuration data from 45reads configuration data from
@@ -135,11 +135,8 @@ If specified, login is allowed only for users whose primary
135group or supplementary group list matches one of the patterns. 135group or supplementary group list matches one of the patterns.
136Only group names are valid; a numerical group ID is not recognized. 136Only group names are valid; a numerical group ID is not recognized.
137By default, login is allowed for all groups. 137By default, login is allowed for all groups.
138The allow/deny directives are processed in the following order: 138The allow/deny groups directives are processed in the following order:
139.Cm DenyUsers ,
140.Cm AllowUsers ,
141.Cm DenyGroups , 139.Cm DenyGroups ,
142and finally
143.Cm AllowGroups . 140.Cm AllowGroups .
144.Pp 141.Pp
145See PATTERNS in 142See PATTERNS in
@@ -195,12 +192,9 @@ are separately checked, restricting logins to particular
195users from particular hosts. 192users from particular hosts.
196HOST criteria may additionally contain addresses to match in CIDR 193HOST criteria may additionally contain addresses to match in CIDR
197address/masklen format. 194address/masklen format.
198The allow/deny directives are processed in the following order: 195The allow/deny users directives are processed in the following order:
199.Cm DenyUsers , 196.Cm DenyUsers ,
200.Cm AllowUsers , 197.Cm AllowUsers .
201.Cm DenyGroups ,
202and finally
203.Cm AllowGroups .
204.Pp 198.Pp
205See PATTERNS in 199See PATTERNS in
206.Xr ssh_config 5 200.Xr ssh_config 5
@@ -546,6 +540,9 @@ is set to 15, and
546.Cm ClientAliveCountMax 540.Cm ClientAliveCountMax
547is left at the default, unresponsive SSH clients 541is left at the default, unresponsive SSH clients
548will be disconnected after approximately 45 seconds. 542will be disconnected after approximately 45 seconds.
543Setting a zero
544.Cm ClientAliveCountMax
545disables connection termination.
549.It Cm ClientAliveInterval 546.It Cm ClientAliveInterval
550Sets a timeout interval in seconds after which if no data has been received 547Sets a timeout interval in seconds after which if no data has been received
551from the client, 548from the client,
@@ -578,11 +575,8 @@ Login is disallowed for users whose primary group or supplementary
578group list matches one of the patterns. 575group list matches one of the patterns.
579Only group names are valid; a numerical group ID is not recognized. 576Only group names are valid; a numerical group ID is not recognized.
580By default, login is allowed for all groups. 577By default, login is allowed for all groups.
581The allow/deny directives are processed in the following order: 578The allow/deny groups directives are processed in the following order:
582.Cm DenyUsers ,
583.Cm AllowUsers ,
584.Cm DenyGroups , 579.Cm DenyGroups ,
585and finally
586.Cm AllowGroups . 580.Cm AllowGroups .
587.Pp 581.Pp
588See PATTERNS in 582See PATTERNS in
@@ -599,12 +593,9 @@ are separately checked, restricting logins to particular
599users from particular hosts. 593users from particular hosts.
600HOST criteria may additionally contain addresses to match in CIDR 594HOST criteria may additionally contain addresses to match in CIDR
601address/masklen format. 595address/masklen format.
602The allow/deny directives are processed in the following order: 596The allow/deny users directives are processed in the following order:
603.Cm DenyUsers , 597.Cm DenyUsers ,
604.Cm AllowUsers , 598.Cm AllowUsers .
605.Cm DenyGroups ,
606and finally
607.Cm AllowGroups .
608.Pp 599.Pp
609See PATTERNS in 600See PATTERNS in
610.Xr ssh_config 5 601.Xr ssh_config 5
@@ -745,15 +736,20 @@ The default for this option is:
745ecdsa-sha2-nistp256-cert-v01@openssh.com, 736ecdsa-sha2-nistp256-cert-v01@openssh.com,
746ecdsa-sha2-nistp384-cert-v01@openssh.com, 737ecdsa-sha2-nistp384-cert-v01@openssh.com,
747ecdsa-sha2-nistp521-cert-v01@openssh.com, 738ecdsa-sha2-nistp521-cert-v01@openssh.com,
739sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
748ssh-ed25519-cert-v01@openssh.com, 740ssh-ed25519-cert-v01@openssh.com,
749rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, 741sk-ssh-ed25519-cert-v01@openssh.com,
742rsa-sha2-512-cert-v01@openssh.com,
743rsa-sha2-256-cert-v01@openssh.com,
750ssh-rsa-cert-v01@openssh.com, 744ssh-rsa-cert-v01@openssh.com,
751ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 745ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
752ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 746sk-ecdsa-sha2-nistp256@openssh.com,
747ssh-ed25519,sk-ssh-ed25519@openssh.com,
748rsa-sha2-512,rsa-sha2-256,ssh-rsa
753.Ed 749.Ed
754.Pp 750.Pp
755The list of available key types may also be obtained using 751The list of available key types may also be obtained using
756.Qq ssh -Q key . 752.Qq ssh -Q HostbasedAcceptedKeyTypes .
757.It Cm HostbasedAuthentication 753.It Cm HostbasedAuthentication
758Specifies whether rhosts or /etc/hosts.equiv authentication together 754Specifies whether rhosts or /etc/hosts.equiv authentication together
759with successful public key client host authentication is allowed 755with successful public key client host authentication is allowed
@@ -823,15 +819,20 @@ The default for this option is:
823ecdsa-sha2-nistp256-cert-v01@openssh.com, 819ecdsa-sha2-nistp256-cert-v01@openssh.com,
824ecdsa-sha2-nistp384-cert-v01@openssh.com, 820ecdsa-sha2-nistp384-cert-v01@openssh.com,
825ecdsa-sha2-nistp521-cert-v01@openssh.com, 821ecdsa-sha2-nistp521-cert-v01@openssh.com,
822sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
826ssh-ed25519-cert-v01@openssh.com, 823ssh-ed25519-cert-v01@openssh.com,
827rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, 824sk-ssh-ed25519-cert-v01@openssh.com,
825rsa-sha2-512-cert-v01@openssh.com,
826rsa-sha2-256-cert-v01@openssh.com,
828ssh-rsa-cert-v01@openssh.com, 827ssh-rsa-cert-v01@openssh.com,
829ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 828ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
830ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 829sk-ecdsa-sha2-nistp256@openssh.com,
830ssh-ed25519,sk-ssh-ed25519@openssh.com,
831rsa-sha2-512,rsa-sha2-256,ssh-rsa
831.Ed 832.Ed
832.Pp 833.Pp
833The list of available key types may also be obtained using 834The list of available key types may also be obtained using
834.Qq ssh -Q key . 835.Qq ssh -Q HostKeyAlgorithms .
835.It Cm IgnoreRhosts 836.It Cm IgnoreRhosts
836Specifies that 837Specifies that
837.Pa .rhosts 838.Pa .rhosts
@@ -856,7 +857,20 @@ during
856and use only the system-wide known hosts file 857and use only the system-wide known hosts file
857.Pa /etc/ssh/known_hosts . 858.Pa /etc/ssh/known_hosts .
858The default is 859The default is
859.Cm no . 860.Dq no .
861.It Cm Include
862Include the specified configuration file(s).
863Multiple pathnames may be specified and each pathname may contain
864.Xr glob 7
865wildcards.
866Files without absolute paths are assumed to be in
867.Pa /etc/ssh .
868An
869.Cm Include
870directive may appear inside a
871.Cm Match
872block
873to perform conditional inclusion.
860.It Cm IPQoS 874.It Cm IPQoS
861Specifies the IPv4 type-of-service or DSCP class for the connection. 875Specifies the IPv4 type-of-service or DSCP class for the connection.
862Accepted values are 876Accepted values are
@@ -881,6 +895,7 @@ Accepted values are
881.Cm cs6 , 895.Cm cs6 ,
882.Cm cs7 , 896.Cm cs7 ,
883.Cm ef , 897.Cm ef ,
898.Cm le ,
884.Cm lowdelay , 899.Cm lowdelay ,
885.Cm throughput , 900.Cm throughput ,
886.Cm reliability , 901.Cm reliability ,
@@ -974,6 +989,8 @@ ecdh-sha2-nistp256
974ecdh-sha2-nistp384 989ecdh-sha2-nistp384
975.It 990.It
976ecdh-sha2-nistp521 991ecdh-sha2-nistp521
992.It
993sntrup4591761x25519-sha512@tinyssh.org
977.El 994.El
978.Pp 995.Pp
979The default is: 996The default is:
@@ -982,11 +999,11 @@ curve25519-sha256,curve25519-sha256@libssh.org,
982ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521, 999ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
983diffie-hellman-group-exchange-sha256, 1000diffie-hellman-group-exchange-sha256,
984diffie-hellman-group16-sha512,diffie-hellman-group18-sha512, 1001diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,
985diffie-hellman-group14-sha256,diffie-hellman-group14-sha1 1002diffie-hellman-group14-sha256
986.Ed 1003.Ed
987.Pp 1004.Pp
988The list of available key exchange algorithms may also be obtained using 1005The list of available key exchange algorithms may also be obtained using
989.Qq ssh -Q kex . 1006.Qq ssh -Q KexAlgorithms .
990.It Cm ListenAddress 1007.It Cm ListenAddress
991Specifies the local addresses 1008Specifies the local addresses
992.Xr sshd 8 1009.Xr sshd 8
@@ -1199,6 +1216,7 @@ Available keywords are
1199.Cm HostbasedAcceptedKeyTypes , 1216.Cm HostbasedAcceptedKeyTypes ,
1200.Cm HostbasedAuthentication , 1217.Cm HostbasedAuthentication ,
1201.Cm HostbasedUsesNameFromPacketOnly , 1218.Cm HostbasedUsesNameFromPacketOnly ,
1219.Cm Include ,
1202.Cm IPQoS , 1220.Cm IPQoS ,
1203.Cm KbdInteractiveAuthentication , 1221.Cm KbdInteractiveAuthentication ,
1204.Cm KerberosAuthentication , 1222.Cm KerberosAuthentication ,
@@ -1341,7 +1359,9 @@ An argument of
1341can be used to prohibit all forwarding requests. 1359can be used to prohibit all forwarding requests.
1342The wildcard 1360The wildcard
1343.Sq * 1361.Sq *
1344can be used for host or port to allow all hosts or ports, respectively. 1362can be used for host or port to allow all hosts or ports respectively.
1363Otherwise, no pattern matching or address lookups are performed on supplied
1364names.
1345By default all port forwarding requests are permitted. 1365By default all port forwarding requests are permitted.
1346.It Cm PermitRootLogin 1366.It Cm PermitRootLogin
1347Specifies whether root can log in using 1367Specifies whether root can log in using
@@ -1482,15 +1502,44 @@ The default for this option is:
1482ecdsa-sha2-nistp256-cert-v01@openssh.com, 1502ecdsa-sha2-nistp256-cert-v01@openssh.com,
1483ecdsa-sha2-nistp384-cert-v01@openssh.com, 1503ecdsa-sha2-nistp384-cert-v01@openssh.com,
1484ecdsa-sha2-nistp521-cert-v01@openssh.com, 1504ecdsa-sha2-nistp521-cert-v01@openssh.com,
1505sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
1485ssh-ed25519-cert-v01@openssh.com, 1506ssh-ed25519-cert-v01@openssh.com,
1486rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, 1507sk-ssh-ed25519-cert-v01@openssh.com,
1508rsa-sha2-512-cert-v01@openssh.com,
1509rsa-sha2-256-cert-v01@openssh.com,
1487ssh-rsa-cert-v01@openssh.com, 1510ssh-rsa-cert-v01@openssh.com,
1488ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, 1511ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1489ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa 1512sk-ecdsa-sha2-nistp256@openssh.com,
1513ssh-ed25519,sk-ssh-ed25519@openssh.com,
1514rsa-sha2-512,rsa-sha2-256,ssh-rsa
1490.Ed 1515.Ed
1491.Pp 1516.Pp
1492The list of available key types may also be obtained using 1517The list of available key types may also be obtained using
1493.Qq ssh -Q key . 1518.Qq ssh -Q PubkeyAcceptedKeyTypes .
1519.It Cm PubkeyAuthOptions
1520Sets one or more public key authentication options.
1521Two option keywords are currently supported:
1522.Cm none
1523(the default; indicating no additional options are enabled)
1524and
1525.Cm touch-required .
1526.Pp
1527The
1528.Cm touch-required
1529option causes public key authentication using a FIDO authenticator algorithm
1530(i.e.\&
1531.Cm ecdsa-sk
1532or
1533.Cm ed25519-sk )
1534to always require the signature to attest that a physically present user
1535explicitly confirmed the authentication (usually by touching the authenticator).
1536By default,
1537.Xr sshd 8
1538requires user presence unless overridden with an authorized_keys option.
1539The
1540.Cm touch-required
1541flag disables this override.
1542This option has no effect for other, non-authenticator public key types.
1494.It Cm PubkeyAuthentication 1543.It Cm PubkeyAuthentication
1495Specifies whether public key authentication is allowed. 1544Specifies whether public key authentication is allowed.
1496The default is 1545The default is
@@ -1541,6 +1590,10 @@ will be bound to this
1541If the routing domain is set to 1590If the routing domain is set to
1542.Cm \&%D , 1591.Cm \&%D ,
1543then the domain in which the incoming connection was received will be applied. 1592then the domain in which the incoming connection was received will be applied.
1593.It Cm SecurityKeyProvider
1594Specifies a path to a library that will be used when loading
1595FIDO authenticator-hosted keys, overriding the default of using
1596the built-in USB HID support.
1544.It Cm SetEnv 1597.It Cm SetEnv
1545Specifies one or more environment variables to set in child sessions started 1598Specifies one or more environment variables to set in child sessions started
1546by 1599by