diff options
Diffstat (limited to 'sshd_config.5')
-rw-r--r-- | sshd_config.5 | 113 |
1 files changed, 93 insertions, 20 deletions
diff --git a/sshd_config.5 b/sshd_config.5 index e3c7c3936..e1b54ba20 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.263 2018/02/16 02:40:45 djm Exp $ | 36 | .\" $OpenBSD: sshd_config.5,v 1.281 2018/07/20 05:01:10 djm Exp $ |
37 | .Dd $Mdocdate: February 16 2018 $ | 37 | .Dd $Mdocdate: July 20 2018 $ |
38 | .Dt SSHD_CONFIG 5 | 38 | .Dt SSHD_CONFIG 5 |
39 | .Os | 39 | .Os |
40 | .Sh NAME | 40 | .Sh NAME |
@@ -66,12 +66,14 @@ the session's | |||
66 | .Xr environ 7 . | 66 | .Xr environ 7 . |
67 | See | 67 | See |
68 | .Cm SendEnv | 68 | .Cm SendEnv |
69 | and | ||
70 | .Cm SetEnv | ||
69 | in | 71 | in |
70 | .Xr ssh_config 5 | 72 | .Xr ssh_config 5 |
71 | for how to configure the client. | 73 | for how to configure the client. |
72 | The | 74 | The |
73 | .Ev TERM | 75 | .Ev TERM |
74 | environment variable is always sent whenever the client | 76 | environment variable is always accepted whenever the client |
75 | requests a pseudo-terminal as it is required by the protocol. | 77 | requests a pseudo-terminal as it is required by the protocol. |
76 | Variables are specified by name, which may contain the wildcard characters | 78 | Variables are specified by name, which may contain the wildcard characters |
77 | .Ql * | 79 | .Ql * |
@@ -184,7 +186,7 @@ for more information on patterns. | |||
184 | .It Cm AuthenticationMethods | 186 | .It Cm AuthenticationMethods |
185 | Specifies the authentication methods that must be successfully completed | 187 | Specifies the authentication methods that must be successfully completed |
186 | for a user to be granted access. | 188 | for a user to be granted access. |
187 | This option must be followed by one or more comma-separated lists of | 189 | This option must be followed by one or more lists of comma-separated |
188 | authentication method names, or by the single string | 190 | authentication method names, or by the single string |
189 | .Cm any | 191 | .Cm any |
190 | to indicate the default behaviour of accepting any single authentication | 192 | to indicate the default behaviour of accepting any single authentication |
@@ -203,10 +205,9 @@ keyboard-interactive authentication before public key. | |||
203 | For keyboard interactive authentication it is also possible to | 205 | For keyboard interactive authentication it is also possible to |
204 | restrict authentication to a specific device by appending a | 206 | restrict authentication to a specific device by appending a |
205 | colon followed by the device identifier | 207 | colon followed by the device identifier |
206 | .Cm bsdauth , | 208 | .Cm bsdauth |
207 | .Cm pam , | ||
208 | or | 209 | or |
209 | .Cm skey , | 210 | .Cm pam . |
210 | depending on the server configuration. | 211 | depending on the server configuration. |
211 | For example, | 212 | For example, |
212 | .Qq keyboard-interactive:bsdauth | 213 | .Qq keyboard-interactive:bsdauth |
@@ -231,7 +232,7 @@ The available authentication methods are: | |||
231 | .Qq keyboard-interactive , | 232 | .Qq keyboard-interactive , |
232 | .Qq none | 233 | .Qq none |
233 | (used for access to password-less accounts when | 234 | (used for access to password-less accounts when |
234 | .Cm PermitEmptyPassword | 235 | .Cm PermitEmptyPasswords |
235 | is enabled), | 236 | is enabled), |
236 | .Qq password | 237 | .Qq password |
237 | and | 238 | and |
@@ -657,7 +658,7 @@ The default is | |||
657 | .Cm yes . | 658 | .Cm yes . |
658 | .It Cm HostbasedAcceptedKeyTypes | 659 | .It Cm HostbasedAcceptedKeyTypes |
659 | Specifies the key types that will be accepted for hostbased authentication | 660 | Specifies the key types that will be accepted for hostbased authentication |
660 | as a comma-separated pattern list. | 661 | as a list of comma-separated patterns. |
661 | Alternately if the specified value begins with a | 662 | Alternately if the specified value begins with a |
662 | .Sq + | 663 | .Sq + |
663 | character, then the specified key types will be appended to the default set | 664 | character, then the specified key types will be appended to the default set |
@@ -672,9 +673,10 @@ ecdsa-sha2-nistp256-cert-v01@openssh.com, | |||
672 | ecdsa-sha2-nistp384-cert-v01@openssh.com, | 673 | ecdsa-sha2-nistp384-cert-v01@openssh.com, |
673 | ecdsa-sha2-nistp521-cert-v01@openssh.com, | 674 | ecdsa-sha2-nistp521-cert-v01@openssh.com, |
674 | ssh-ed25519-cert-v01@openssh.com, | 675 | ssh-ed25519-cert-v01@openssh.com, |
676 | rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, | ||
675 | ssh-rsa-cert-v01@openssh.com, | 677 | ssh-rsa-cert-v01@openssh.com, |
676 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, | 678 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, |
677 | ssh-ed25519,ssh-rsa | 679 | ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa |
678 | .Ed | 680 | .Ed |
679 | .Pp | 681 | .Pp |
680 | The list of available key types may also be obtained using | 682 | The list of available key types may also be obtained using |
@@ -749,9 +751,10 @@ ecdsa-sha2-nistp256-cert-v01@openssh.com, | |||
749 | ecdsa-sha2-nistp384-cert-v01@openssh.com, | 751 | ecdsa-sha2-nistp384-cert-v01@openssh.com, |
750 | ecdsa-sha2-nistp521-cert-v01@openssh.com, | 752 | ecdsa-sha2-nistp521-cert-v01@openssh.com, |
751 | ssh-ed25519-cert-v01@openssh.com, | 753 | ssh-ed25519-cert-v01@openssh.com, |
754 | rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, | ||
752 | ssh-rsa-cert-v01@openssh.com, | 755 | ssh-rsa-cert-v01@openssh.com, |
753 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, | 756 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, |
754 | ssh-ed25519,ssh-rsa | 757 | ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa |
755 | .Ed | 758 | .Ed |
756 | .Pp | 759 | .Pp |
757 | The list of available key types may also be obtained using | 760 | The list of available key types may also be obtained using |
@@ -816,9 +819,11 @@ If one argument is specified, it is used as the packet class unconditionally. | |||
816 | If two values are specified, the first is automatically selected for | 819 | If two values are specified, the first is automatically selected for |
817 | interactive sessions and the second for non-interactive sessions. | 820 | interactive sessions and the second for non-interactive sessions. |
818 | The default is | 821 | The default is |
819 | .Cm lowdelay | 822 | .Cm af21 |
823 | (Low-Latency Data) | ||
820 | for interactive sessions and | 824 | for interactive sessions and |
821 | .Cm throughput | 825 | .Cm cs1 |
826 | (Lower Effort) | ||
822 | for non-interactive sessions. | 827 | for non-interactive sessions. |
823 | .It Cm KbdInteractiveAuthentication | 828 | .It Cm KbdInteractiveAuthentication |
824 | Specifies whether to allow keyboard-interactive authentication. | 829 | Specifies whether to allow keyboard-interactive authentication. |
@@ -1123,6 +1128,7 @@ Available keywords are | |||
1123 | .Cm MaxSessions , | 1128 | .Cm MaxSessions , |
1124 | .Cm PasswordAuthentication , | 1129 | .Cm PasswordAuthentication , |
1125 | .Cm PermitEmptyPasswords , | 1130 | .Cm PermitEmptyPasswords , |
1131 | .Cm PermitListen , | ||
1126 | .Cm PermitOpen , | 1132 | .Cm PermitOpen , |
1127 | .Cm PermitRootLogin , | 1133 | .Cm PermitRootLogin , |
1128 | .Cm PermitTTY , | 1134 | .Cm PermitTTY , |
@@ -1133,6 +1139,7 @@ Available keywords are | |||
1133 | .Cm RekeyLimit , | 1139 | .Cm RekeyLimit , |
1134 | .Cm RevokedKeys , | 1140 | .Cm RevokedKeys , |
1135 | .Cm RDomain , | 1141 | .Cm RDomain , |
1142 | .Cm SetEnv , | ||
1136 | .Cm StreamLocalBindMask , | 1143 | .Cm StreamLocalBindMask , |
1137 | .Cm StreamLocalBindUnlink , | 1144 | .Cm StreamLocalBindUnlink , |
1138 | .Cm TrustedUserCAKeys , | 1145 | .Cm TrustedUserCAKeys , |
@@ -1182,6 +1189,48 @@ When password authentication is allowed, it specifies whether the | |||
1182 | server allows login to accounts with empty password strings. | 1189 | server allows login to accounts with empty password strings. |
1183 | The default is | 1190 | The default is |
1184 | .Cm no . | 1191 | .Cm no . |
1192 | .It Cm PermitListen | ||
1193 | Specifies the addresses/ports on which a remote TCP port forwarding may listen. | ||
1194 | The listen specification must be one of the following forms: | ||
1195 | .Pp | ||
1196 | .Bl -item -offset indent -compact | ||
1197 | .It | ||
1198 | .Cm PermitListen | ||
1199 | .Sm off | ||
1200 | .Ar port | ||
1201 | .Sm on | ||
1202 | .It | ||
1203 | .Cm PermitListen | ||
1204 | .Sm off | ||
1205 | .Ar host : port | ||
1206 | .Sm on | ||
1207 | .El | ||
1208 | .Pp | ||
1209 | Multiple permissions may be specified by separating them with whitespace. | ||
1210 | An argument of | ||
1211 | .Cm any | ||
1212 | can be used to remove all restrictions and permit any listen requests. | ||
1213 | An argument of | ||
1214 | .Cm none | ||
1215 | can be used to prohibit all listen requests. | ||
1216 | The host name may contain wildcards as described in the PATTERNS section in | ||
1217 | .Xr ssh_config 5 . | ||
1218 | The wildcard | ||
1219 | .Sq * | ||
1220 | can also be used in place of a port number to allow all ports. | ||
1221 | By default all port forwarding listen requests are permitted. | ||
1222 | Note that the | ||
1223 | .Cm GatewayPorts | ||
1224 | option may further restrict which addresses may be listened on. | ||
1225 | Note also that | ||
1226 | .Xr ssh 1 | ||
1227 | will request a listen host of | ||
1228 | .Dq localhost | ||
1229 | if no listen host was specifically requested, and this this name is | ||
1230 | treated differently to explicit localhost addresses of | ||
1231 | .Dq 127.0.0.1 | ||
1232 | and | ||
1233 | .Dq ::1 . | ||
1185 | .It Cm PermitOpen | 1234 | .It Cm PermitOpen |
1186 | Specifies the destinations to which TCP port forwarding is permitted. | 1235 | Specifies the destinations to which TCP port forwarding is permitted. |
1187 | The forwarding specification must be one of the following forms: | 1236 | The forwarding specification must be one of the following forms: |
@@ -1284,6 +1333,12 @@ options in | |||
1284 | .Pa ~/.ssh/authorized_keys | 1333 | .Pa ~/.ssh/authorized_keys |
1285 | are processed by | 1334 | are processed by |
1286 | .Xr sshd 8 . | 1335 | .Xr sshd 8 . |
1336 | Valid options are | ||
1337 | .Cm yes , | ||
1338 | .Cm no | ||
1339 | or a pattern-list specifying which environment variable names to accept | ||
1340 | (for example | ||
1341 | .Qq LANG,LC_* ) . | ||
1287 | The default is | 1342 | The default is |
1288 | .Cm no . | 1343 | .Cm no . |
1289 | Enabling environment processing may enable users to bypass access | 1344 | Enabling environment processing may enable users to bypass access |
@@ -1330,7 +1385,7 @@ The default is | |||
1330 | .Cm yes . | 1385 | .Cm yes . |
1331 | .It Cm PubkeyAcceptedKeyTypes | 1386 | .It Cm PubkeyAcceptedKeyTypes |
1332 | Specifies the key types that will be accepted for public key authentication | 1387 | Specifies the key types that will be accepted for public key authentication |
1333 | as a comma-separated pattern list. | 1388 | as a list of comma-separated patterns. |
1334 | Alternately if the specified value begins with a | 1389 | Alternately if the specified value begins with a |
1335 | .Sq + | 1390 | .Sq + |
1336 | character, then the specified key types will be appended to the default set | 1391 | character, then the specified key types will be appended to the default set |
@@ -1345,9 +1400,10 @@ ecdsa-sha2-nistp256-cert-v01@openssh.com, | |||
1345 | ecdsa-sha2-nistp384-cert-v01@openssh.com, | 1400 | ecdsa-sha2-nistp384-cert-v01@openssh.com, |
1346 | ecdsa-sha2-nistp521-cert-v01@openssh.com, | 1401 | ecdsa-sha2-nistp521-cert-v01@openssh.com, |
1347 | ssh-ed25519-cert-v01@openssh.com, | 1402 | ssh-ed25519-cert-v01@openssh.com, |
1403 | rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com, | ||
1348 | ssh-rsa-cert-v01@openssh.com, | 1404 | ssh-rsa-cert-v01@openssh.com, |
1349 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, | 1405 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, |
1350 | ssh-ed25519,ssh-rsa | 1406 | ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa |
1351 | .Ed | 1407 | .Ed |
1352 | .Pp | 1408 | .Pp |
1353 | The list of available key types may also be obtained using | 1409 | The list of available key types may also be obtained using |
@@ -1402,6 +1458,21 @@ will be bound to this | |||
1402 | If the routing domain is set to | 1458 | If the routing domain is set to |
1403 | .Cm \&%D , | 1459 | .Cm \&%D , |
1404 | then the domain in which the incoming connection was received will be applied. | 1460 | then the domain in which the incoming connection was received will be applied. |
1461 | .It Cm SetEnv | ||
1462 | Specifies one or more environment variables to set in child sessions started | ||
1463 | by | ||
1464 | .Xr sshd 8 | ||
1465 | as | ||
1466 | .Dq NAME=VALUE . | ||
1467 | The environment value may be quoted (e.g. if it contains whitespace | ||
1468 | characters). | ||
1469 | Environment variables set by | ||
1470 | .Cm SetEnv | ||
1471 | override the default environment and any variables specified by the user | ||
1472 | via | ||
1473 | .Cm AcceptEnv | ||
1474 | or | ||
1475 | .Cm PermitUserEnvironment . | ||
1405 | .It Cm StreamLocalBindMask | 1476 | .It Cm StreamLocalBindMask |
1406 | Sets the octal file creation mode mask | 1477 | Sets the octal file creation mode mask |
1407 | .Pq umask | 1478 | .Pq umask |
@@ -1687,24 +1758,26 @@ The serial number of the certificate. | |||
1687 | The type of the CA key. | 1758 | The type of the CA key. |
1688 | .It %t | 1759 | .It %t |
1689 | The key or certificate type. | 1760 | The key or certificate type. |
1761 | .It \&%U | ||
1762 | The numeric user ID of the target user. | ||
1690 | .It %u | 1763 | .It %u |
1691 | The username. | 1764 | The username. |
1692 | .El | 1765 | .El |
1693 | .Pp | 1766 | .Pp |
1694 | .Cm AuthorizedKeysCommand | 1767 | .Cm AuthorizedKeysCommand |
1695 | accepts the tokens %%, %f, %h, %k, %t, and %u. | 1768 | accepts the tokens %%, %f, %h, %k, %t, %U, and %u. |
1696 | .Pp | 1769 | .Pp |
1697 | .Cm AuthorizedKeysFile | 1770 | .Cm AuthorizedKeysFile |
1698 | accepts the tokens %%, %h, and %u. | 1771 | accepts the tokens %%, %h, %U, and %u. |
1699 | .Pp | 1772 | .Pp |
1700 | .Cm AuthorizedPrincipalsCommand | 1773 | .Cm AuthorizedPrincipalsCommand |
1701 | accepts the tokens %%, %F, %f, %h, %i, %K, %k, %s, %T, %t, and %u. | 1774 | accepts the tokens %%, %F, %f, %h, %i, %K, %k, %s, %T, %t, %U, and %u. |
1702 | .Pp | 1775 | .Pp |
1703 | .Cm AuthorizedPrincipalsFile | 1776 | .Cm AuthorizedPrincipalsFile |
1704 | accepts the tokens %%, %h, and %u. | 1777 | accepts the tokens %%, %h, %U, and %u. |
1705 | .Pp | 1778 | .Pp |
1706 | .Cm ChrootDirectory | 1779 | .Cm ChrootDirectory |
1707 | accepts the tokens %%, %h, and %u. | 1780 | accepts the tokens %%, %h, %U, and %u. |
1708 | .Pp | 1781 | .Pp |
1709 | .Cm RoutingDomain | 1782 | .Cm RoutingDomain |
1710 | accepts the token %D. | 1783 | accepts the token %D. |