summaryrefslogtreecommitdiff
path: root/sshd_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'sshd_config.5')
-rw-r--r--sshd_config.565
1 files changed, 39 insertions, 26 deletions
diff --git a/sshd_config.5 b/sshd_config.5
index 0be7250b0..2387b51b8 100644
--- a/sshd_config.5
+++ b/sshd_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: sshd_config.5,v 1.211 2015/08/14 15:32:41 jmc Exp $ 36.\" $OpenBSD: sshd_config.5,v 1.220 2016/02/17 08:57:34 djm Exp $
37.Dd $Mdocdate: August 14 2015 $ 37.Dd $Mdocdate: February 17 2016 $
38.Dt SSHD_CONFIG 5 38.Dt SSHD_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -95,8 +95,7 @@ See
95in 95in
96.Xr ssh_config 5 96.Xr ssh_config 5
97for how to configure the client. 97for how to configure the client.
98Note that environment passing is only supported for protocol 2, and 98The
99that the
100.Ev TERM 99.Ev TERM
101environment variable is always sent whenever the client 100environment variable is always sent whenever the client
102requests a pseudo-terminal as it is required by the protocol. 101requests a pseudo-terminal as it is required by the protocol.
@@ -251,7 +250,7 @@ of
251.Dq publickey,publickey 250.Dq publickey,publickey
252will require successful authentication using two different public keys. 251will require successful authentication using two different public keys.
253.Pp 252.Pp
254This option is only available for SSH protocol 2 and will yield a fatal 253This option will yield a fatal
255error if enabled if protocol 1 is also enabled. 254error if enabled if protocol 1 is also enabled.
256Note that each authentication method listed should also be explicitly enabled 255Note that each authentication method listed should also be explicitly enabled
257in the configuration. 256in the configuration.
@@ -310,6 +309,9 @@ After expansion,
310is taken to be an absolute path or one relative to the user's home 309is taken to be an absolute path or one relative to the user's home
311directory. 310directory.
312Multiple files may be listed, separated by whitespace. 311Multiple files may be listed, separated by whitespace.
312Alternately this option may be set to
313.Dq none
314to skip checking for user keys in files.
313The default is 315The default is
314.Dq .ssh/authorized_keys .ssh/authorized_keys2 . 316.Dq .ssh/authorized_keys .ssh/authorized_keys2 .
315.It Cm AuthorizedPrincipalsCommand 317.It Cm AuthorizedPrincipalsCommand
@@ -395,7 +397,6 @@ authentication is allowed.
395If the argument is 397If the argument is
396.Dq none 398.Dq none
397then no banner is displayed. 399then no banner is displayed.
398This option is only available for protocol version 2.
399By default, no banner is displayed. 400By default, no banner is displayed.
400.It Cm ChallengeResponseAuthentication 401.It Cm ChallengeResponseAuthentication
401Specifies whether challenge-response authentication is allowed (e.g. via 402Specifies whether challenge-response authentication is allowed (e.g. via
@@ -453,10 +454,12 @@ Misconfiguration can lead to unsafe environments which
453.Xr sshd 8 454.Xr sshd 8
454cannot detect. 455cannot detect.
455.Pp 456.Pp
456The default is not to 457The default is
458.Dq none ,
459indicating not to
457.Xr chroot 2 . 460.Xr chroot 2 .
458.It Cm Ciphers 461.It Cm Ciphers
459Specifies the ciphers allowed for protocol version 2. 462Specifies the ciphers allowed.
460Multiple ciphers must be comma-separated. 463Multiple ciphers must be comma-separated.
461If the specified value begins with a 464If the specified value begins with a
462.Sq + 465.Sq +
@@ -537,7 +540,6 @@ If
537.Cm ClientAliveCountMax 540.Cm ClientAliveCountMax
538is left at the default, unresponsive SSH clients 541is left at the default, unresponsive SSH clients
539will be disconnected after approximately 45 seconds. 542will be disconnected after approximately 45 seconds.
540This option applies to protocol version 2 only.
541.It Cm ClientAliveInterval 543.It Cm ClientAliveInterval
542Sets a timeout interval in seconds after which if no data has been received 544Sets a timeout interval in seconds after which if no data has been received
543from the client, 545from the client,
@@ -546,7 +548,6 @@ will send a message through the encrypted
546channel to request a response from the client. 548channel to request a response from the client.
547The default 549The default
548is 0, indicating that these messages will not be sent to the client. 550is 0, indicating that these messages will not be sent to the client.
549This option applies to protocol version 2 only.
550.It Cm Compression 551.It Cm Compression
551Specifies whether compression is allowed, or delayed until 552Specifies whether compression is allowed, or delayed until
552the user has authenticated successfully. 553the user has authenticated successfully.
@@ -625,6 +626,8 @@ Specifying a command of
625will force the use of an in-process sftp server that requires no support 626will force the use of an in-process sftp server that requires no support
626files when used with 627files when used with
627.Cm ChrootDirectory . 628.Cm ChrootDirectory .
629The default is
630.Dq none .
628.It Cm GatewayPorts 631.It Cm GatewayPorts
629Specifies whether remote hosts are allowed to connect to ports 632Specifies whether remote hosts are allowed to connect to ports
630forwarded for the client. 633forwarded for the client.
@@ -649,19 +652,16 @@ The default is
649Specifies whether user authentication based on GSSAPI is allowed. 652Specifies whether user authentication based on GSSAPI is allowed.
650The default is 653The default is
651.Dq no . 654.Dq no .
652Note that this option applies to protocol version 2 only.
653.It Cm GSSAPIKeyExchange 655.It Cm GSSAPIKeyExchange
654Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange 656Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange
655doesn't rely on ssh keys to verify host identity. 657doesn't rely on ssh keys to verify host identity.
656The default is 658The default is
657.Dq no . 659.Dq no .
658Note that this option applies to protocol version 2 only.
659.It Cm GSSAPICleanupCredentials 660.It Cm GSSAPICleanupCredentials
660Specifies whether to automatically destroy the user's credentials cache 661Specifies whether to automatically destroy the user's credentials cache
661on logout. 662on logout.
662The default is 663The default is
663.Dq yes . 664.Dq yes .
664Note that this option applies to protocol version 2 only.
665.It Cm GSSAPIStrictAcceptorCheck 665.It Cm GSSAPIStrictAcceptorCheck
666Determines whether to be strict about the identity of the GSSAPI acceptor 666Determines whether to be strict about the identity of the GSSAPI acceptor
667a client authenticates against. 667a client authenticates against.
@@ -709,9 +709,6 @@ may be used to list supported key types.
709Specifies whether rhosts or /etc/hosts.equiv authentication together 709Specifies whether rhosts or /etc/hosts.equiv authentication together
710with successful public key client host authentication is allowed 710with successful public key client host authentication is allowed
711(host-based authentication). 711(host-based authentication).
712This option is similar to
713.Cm RhostsRSAAuthentication
714and applies to protocol version 2 only.
715The default is 712The default is
716.Dq no . 713.Dq no .
717.It Cm HostbasedUsesNameFromPacketOnly 714.It Cm HostbasedUsesNameFromPacketOnly
@@ -782,7 +779,7 @@ is specified, the location of the socket will be read from the
782.Ev SSH_AUTH_SOCK 779.Ev SSH_AUTH_SOCK
783environment variable. 780environment variable.
784.It Cm HostKeyAlgorithms 781.It Cm HostKeyAlgorithms
785Specifies the protocol version 2 host key algorithms 782Specifies the host key algorithms
786that the server offers. 783that the server offers.
787The default for this option is: 784The default for this option is:
788.Bd -literal -offset 3n 785.Bd -literal -offset 3n
@@ -1003,8 +1000,7 @@ DEBUG2 and DEBUG3 each specify higher levels of debugging output.
1003Logging with a DEBUG level violates the privacy of users and is not recommended. 1000Logging with a DEBUG level violates the privacy of users and is not recommended.
1004.It Cm MACs 1001.It Cm MACs
1005Specifies the available MAC (message authentication code) algorithms. 1002Specifies the available MAC (message authentication code) algorithms.
1006The MAC algorithm is used in protocol version 2 1003The MAC algorithm is used for data integrity protection.
1007for data integrity protection.
1008Multiple algorithms must be comma-separated. 1004Multiple algorithms must be comma-separated.
1009If the specified value begins with a 1005If the specified value begins with a
1010.Sq + 1006.Sq +
@@ -1060,8 +1056,9 @@ The default is:
1060.Bd -literal -offset indent 1056.Bd -literal -offset indent
1061umac-64-etm@openssh.com,umac-128-etm@openssh.com, 1057umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1062hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com, 1058hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
1059hmac-sha1-etm@openssh.com,
1063umac-64@openssh.com,umac-128@openssh.com, 1060umac-64@openssh.com,umac-128@openssh.com,
1064hmac-sha2-256,hmac-sha2-512 1061hmac-sha2-256,hmac-sha2-512,hmac-sha1
1065.Ed 1062.Ed
1066.Pp 1063.Pp
1067The list of available MAC algorithms may also be obtained using the 1064The list of available MAC algorithms may also be obtained using the
@@ -1131,6 +1128,8 @@ Available keywords are
1131.Cm AuthorizedKeysCommand , 1128.Cm AuthorizedKeysCommand ,
1132.Cm AuthorizedKeysCommandUser , 1129.Cm AuthorizedKeysCommandUser ,
1133.Cm AuthorizedKeysFile , 1130.Cm AuthorizedKeysFile ,
1131.Cm AuthorizedPrincipalsCommand ,
1132.Cm AuthorizedPrincipalsCommandUser ,
1134.Cm AuthorizedPrincipalsFile , 1133.Cm AuthorizedPrincipalsFile ,
1135.Cm Banner , 1134.Cm Banner ,
1136.Cm ChrootDirectory , 1135.Cm ChrootDirectory ,
@@ -1174,7 +1173,15 @@ Once the number of failures reaches half this value,
1174additional failures are logged. 1173additional failures are logged.
1175The default is 6. 1174The default is 6.
1176.It Cm MaxSessions 1175.It Cm MaxSessions
1177Specifies the maximum number of open sessions permitted per network connection. 1176Specifies the maximum number of open shell, login or subsystem (e.g. sftp)
1177sessions permitted per network connection.
1178Multiple sessions may be established by clients that support connection
1179multiplexing.
1180Setting
1181.Cm MaxSessions
1182to 1 will effectively disable session multiplexing, whereas setting it to 0
1183will prevent all shell, login and subsystem sessions while still permitting
1184forwarding.
1178The default is 10. 1185The default is 10.
1179.It Cm MaxStartups 1186.It Cm MaxStartups
1180Specifies the maximum number of concurrent unauthenticated connections to the 1187Specifies the maximum number of concurrent unauthenticated connections to the
@@ -1364,6 +1371,10 @@ and
1364Multiple versions must be comma-separated. 1371Multiple versions must be comma-separated.
1365The default is 1372The default is
1366.Sq 2 . 1373.Sq 2 .
1374Protocol 1 suffers from a number of cryptographic weaknesses and should
1375not be used.
1376It is only offered to support legacy devices.
1377.Pp
1367Note that the order of the protocol list does not indicate preference, 1378Note that the order of the protocol list does not indicate preference,
1368because the client selects among multiple protocol versions offered 1379because the client selects among multiple protocol versions offered
1369by the server. 1380by the server.
@@ -1398,7 +1409,6 @@ may be used to list supported key types.
1398Specifies whether public key authentication is allowed. 1409Specifies whether public key authentication is allowed.
1399The default is 1410The default is
1400.Dq yes . 1411.Dq yes .
1401Note that this option applies to protocol version 2 only.
1402.It Cm RekeyLimit 1412.It Cm RekeyLimit
1403Specifies the maximum amount of data that may be transmitted before the 1413Specifies the maximum amount of data that may be transmitted before the
1404session key is renegotiated, optionally followed a maximum amount of 1414session key is renegotiated, optionally followed a maximum amount of
@@ -1424,7 +1434,6 @@ is
1424.Dq default none , 1434.Dq default none ,
1425which means that rekeying is performed after the cipher's default amount 1435which means that rekeying is performed after the cipher's default amount
1426of data has been sent or received and no time based rekeying is done. 1436of data has been sent or received and no time based rekeying is done.
1427This option applies to protocol version 2 only.
1428.It Cm RevokedKeys 1437.It Cm RevokedKeys
1429Specifies revoked public keys file, or 1438Specifies revoked public keys file, or
1430.Dq none 1439.Dq none
@@ -1511,7 +1520,6 @@ This may simplify configurations using
1511to force a different filesystem root on clients. 1520to force a different filesystem root on clients.
1512.Pp 1521.Pp
1513By default no subsystems are defined. 1522By default no subsystems are defined.
1514Note that this option applies to protocol version 2 only.
1515.It Cm SyslogFacility 1523.It Cm SyslogFacility
1516Gives the facility code that is used when logging messages from 1524Gives the facility code that is used when logging messages from
1517.Xr sshd 8 . 1525.Xr sshd 8 .
@@ -1627,14 +1635,19 @@ After successful authentication, another process will be created that has
1627the privilege of the authenticated user. 1635the privilege of the authenticated user.
1628The goal of privilege separation is to prevent privilege 1636The goal of privilege separation is to prevent privilege
1629escalation by containing any corruption within the unprivileged processes. 1637escalation by containing any corruption within the unprivileged processes.
1630The default is 1638The argument must be
1631.Dq yes . 1639.Dq yes ,
1640.Dq no ,
1641or
1642.Dq sandbox .
1632If 1643If
1633.Cm UsePrivilegeSeparation 1644.Cm UsePrivilegeSeparation
1634is set to 1645is set to
1635.Dq sandbox 1646.Dq sandbox
1636then the pre-authentication unprivileged process is subject to additional 1647then the pre-authentication unprivileged process is subject to additional
1637restrictions. 1648restrictions.
1649The default is
1650.Dq sandbox .
1638.It Cm VersionAddendum 1651.It Cm VersionAddendum
1639Optionally specifies additional text to append to the SSH protocol banner 1652Optionally specifies additional text to append to the SSH protocol banner
1640sent by the server upon connection. 1653sent by the server upon connection.