summaryrefslogtreecommitdiff
path: root/sshd_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'sshd_config.5')
-rw-r--r--sshd_config.597
1 files changed, 67 insertions, 30 deletions
diff --git a/sshd_config.5 b/sshd_config.5
index 935bb62fa..525d9c858 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.156 2013/02/06 00:20:42 dtucker Exp $ 36.\" $OpenBSD: sshd_config.5,v 1.162 2013/07/19 07:37:48 markus Exp $
37.Dd $Mdocdate: February 6 2013 $ 37.Dd $Mdocdate: July 19 2013 $
38.Dt SSHD_CONFIG 5 38.Dt SSHD_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -117,9 +117,7 @@ The allow/deny directives are processed in the following order:
117and finally 117and finally
118.Cm AllowGroups . 118.Cm AllowGroups .
119.Pp 119.Pp
120See 120See PATTERNS in
121.Sx PATTERNS
122in
123.Xr ssh_config 5 121.Xr ssh_config 5
124for more information on patterns. 122for more information on patterns.
125.It Cm AllowTcpForwarding 123.It Cm AllowTcpForwarding
@@ -159,9 +157,7 @@ The allow/deny directives are processed in the following order:
159and finally 157and finally
160.Cm AllowGroups . 158.Cm AllowGroups .
161.Pp 159.Pp
162See 160See PATTERNS in
163.Sx PATTERNS
164in
165.Xr ssh_config 5 161.Xr ssh_config 5
166for more information on patterns. 162for more information on patterns.
167.It Cm AuthenticationMethods 163.It Cm AuthenticationMethods
@@ -180,6 +176,20 @@ Only methods that are next in one or more lists are offered at each stage,
180so for this example, it would not be possible to attempt password or 176so for this example, it would not be possible to attempt password or
181keyboard-interactive authentication before public key. 177keyboard-interactive authentication before public key.
182.Pp 178.Pp
179For keyboard interactive authentication it is also possible to
180restrict authentication to a specific device by appending a
181colon followed by the device identifier
182.Dq bsdauth ,
183.Dq pam ,
184or
185.Dq skey ,
186depending on the server configuration.
187For example,
188.Dq keyboard-interactive:bsdauth
189would restrict keyboard interactive authentication to the
190.Dq bsdauth
191device.
192.Pp
183This option is only available for SSH protocol 2 and will yield a fatal 193This option is only available for SSH protocol 2 and will yield a fatal
184error if enabled if protocol 1 is also enabled. 194error if enabled if protocol 1 is also enabled.
185Note that each authentication method listed should also be explicitly enabled 195Note that each authentication method listed should also be explicitly enabled
@@ -188,11 +198,10 @@ The default is not to require multiple authentication; successful completion
188of a single authentication method is sufficient. 198of a single authentication method is sufficient.
189.It Cm AuthorizedKeysCommand 199.It Cm AuthorizedKeysCommand
190Specifies a program to be used to look up the user's public keys. 200Specifies a program to be used to look up the user's public keys.
191The program will be invoked with a single argument of the username 201The program must be owned by root and not writable by group or others.
202It will be invoked with a single argument of the username
192being authenticated, and should produce on standard output zero or 203being authenticated, and should produce on standard output zero or
193more lines of authorized_keys output (see 204more lines of authorized_keys output (see AUTHORIZED_KEYS in
194.Sx AUTHORIZED_KEYS
195in
196.Xr sshd 8 ) . 205.Xr sshd 8 ) .
197If a key supplied by AuthorizedKeysCommand does not successfully authenticate 206If a key supplied by AuthorizedKeysCommand does not successfully authenticate
198and authorize the user then public key authentication continues using the usual 207and authorize the user then public key authentication continues using the usual
@@ -207,7 +216,7 @@ than running authorized keys commands.
207Specifies the file that contains the public keys that can be used 216Specifies the file that contains the public keys that can be used
208for user authentication. 217for user authentication.
209The format is described in the 218The format is described in the
210.Sx AUTHORIZED_KEYS FILE FORMAT 219AUTHORIZED_KEYS FILE FORMAT
211section of 220section of
212.Xr sshd 8 . 221.Xr sshd 8 .
213.Cm AuthorizedKeysFile 222.Cm AuthorizedKeysFile
@@ -231,9 +240,7 @@ When using certificates signed by a key listed in
231this file lists names, one of which must appear in the certificate for it 240this file lists names, one of which must appear in the certificate for it
232to be accepted for authentication. 241to be accepted for authentication.
233Names are listed one per line preceded by key options (as described 242Names are listed one per line preceded by key options (as described
234in 243in AUTHORIZED_KEYS FILE FORMAT in
235.Sx AUTHORIZED_KEYS FILE FORMAT
236in
237.Xr sshd 8 ) . 244.Xr sshd 8 ) .
238Empty lines and comments starting with 245Empty lines and comments starting with
239.Ql # 246.Ql #
@@ -411,9 +418,7 @@ The allow/deny directives are processed in the following order:
411and finally 418and finally
412.Cm AllowGroups . 419.Cm AllowGroups .
413.Pp 420.Pp
414See 421See PATTERNS in
415.Sx PATTERNS
416in
417.Xr ssh_config 5 422.Xr ssh_config 5
418for more information on patterns. 423for more information on patterns.
419.It Cm DenyUsers 424.It Cm DenyUsers
@@ -432,9 +437,7 @@ The allow/deny directives are processed in the following order:
432and finally 437and finally
433.Cm AllowGroups . 438.Cm AllowGroups .
434.Pp 439.Pp
435See 440See PATTERNS in
436.Sx PATTERNS
437in
438.Xr ssh_config 5 441.Xr ssh_config 5
439for more information on patterns. 442for more information on patterns.
440.It Cm ForceCommand 443.It Cm ForceCommand
@@ -571,6 +574,18 @@ keys are used for version 1 and
571or 574or
572.Dq rsa 575.Dq rsa
573are used for version 2 of the SSH protocol. 576are used for version 2 of the SSH protocol.
577It is also possible to specify public host key files instead.
578In this case operations on the private key will be delegated
579to an
580.Xr ssh-agent 1 .
581.It Cm HostKeyAgent
582Identifies the UNIX-domain socket used to communicate
583with an agent that has access to the private host keys.
584If
585.Dq SSH_AUTH_SOCK
586is specified, the location of the socket will be read from the
587.Ev SSH_AUTH_SOCK
588environment variable.
574.It Cm IgnoreRhosts 589.It Cm IgnoreRhosts
575Specifies that 590Specifies that
576.Pa .rhosts 591.Pa .rhosts
@@ -774,8 +789,7 @@ and
774.Cm Address . 789.Cm Address .
775The match patterns may consist of single entries or comma-separated 790The match patterns may consist of single entries or comma-separated
776lists and may use the wildcard and negation operators described in the 791lists and may use the wildcard and negation operators described in the
777.Sx PATTERNS 792PATTERNS section of
778section of
779.Xr ssh_config 5 . 793.Xr ssh_config 5 .
780.Pp 794.Pp
781The patterns in an 795The patterns in an
@@ -827,6 +841,7 @@ Available keywords are
827.Cm PermitRootLogin , 841.Cm PermitRootLogin ,
828.Cm PermitTunnel , 842.Cm PermitTunnel ,
829.Cm PubkeyAuthentication , 843.Cm PubkeyAuthentication ,
844.Cm RekeyLimit ,
830.Cm RhostsRSAAuthentication , 845.Cm RhostsRSAAuthentication ,
831.Cm RSAAuthentication , 846.Cm RSAAuthentication ,
832.Cm X11DisplayOffset , 847.Cm X11DisplayOffset ,
@@ -1021,6 +1036,32 @@ Specifies whether public key authentication is allowed.
1021The default is 1036The default is
1022.Dq yes . 1037.Dq yes .
1023Note that this option applies to protocol version 2 only. 1038Note that this option applies to protocol version 2 only.
1039.It Cm RekeyLimit
1040Specifies the maximum amount of data that may be transmitted before the
1041session key is renegotiated, optionally followed a maximum amount of
1042time that may pass before the session key is renegotiated.
1043The first argument is specified in bytes and may have a suffix of
1044.Sq K ,
1045.Sq M ,
1046or
1047.Sq G
1048to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1049The default is between
1050.Sq 1G
1051and
1052.Sq 4G ,
1053depending on the cipher.
1054The optional second value is specified in seconds and may use any of the
1055units documented in the
1056.Sx TIME FORMATS
1057section.
1058The default value for
1059.Cm RekeyLimit
1060is
1061.Dq default none ,
1062which means that rekeying is performed after the cipher's default amount
1063of data has been sent or received and no time based rekeying is done.
1064This option applies to protocol version 2 only.
1024.It Cm RevokedKeys 1065.It Cm RevokedKeys
1025Specifies revoked public keys. 1066Specifies revoked public keys.
1026Keys listed in this file will be refused for public key authentication. 1067Keys listed in this file will be refused for public key authentication.
@@ -1029,9 +1070,7 @@ be refused for all users.
1029Keys may be specified as a text file, listing one public key per line, or as 1070Keys may be specified as a text file, listing one public key per line, or as
1030an OpenSSH Key Revocation List (KRL) as generated by 1071an OpenSSH Key Revocation List (KRL) as generated by
1031.Xr ssh-keygen 1 . 1072.Xr ssh-keygen 1 .
1032For more information on KRLs, see the 1073For more information on KRLs, see the KEY REVOCATION LISTS section in
1033.Sx KEY REVOCATION LISTS
1034section in
1035.Xr ssh-keygen 1 . 1074.Xr ssh-keygen 1 .
1036.It Cm RhostsRSAAuthentication 1075.It Cm RhostsRSAAuthentication
1037Specifies whether rhosts or /etc/hosts.equiv authentication together 1076Specifies whether rhosts or /etc/hosts.equiv authentication together
@@ -1120,9 +1159,7 @@ listed in the certificate's principals list.
1120Note that certificates that lack a list of principals will not be permitted 1159Note that certificates that lack a list of principals will not be permitted
1121for authentication using 1160for authentication using
1122.Cm TrustedUserCAKeys . 1161.Cm TrustedUserCAKeys .
1123For more details on certificates, see the 1162For more details on certificates, see the CERTIFICATES section in
1124.Sx CERTIFICATES
1125section in
1126.Xr ssh-keygen 1 . 1163.Xr ssh-keygen 1 .
1127.It Cm UseDNS 1164.It Cm UseDNS
1128Specifies whether 1165Specifies whether