summaryrefslogtreecommitdiff
path: root/sshd_config.5
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2015-08-19 17:00:17 +0100
committerColin Watson <cjwatson@debian.org>2015-08-19 17:00:17 +0100
commit544df7a04ae5b5c1fc30be7c445ad685d7a02dc9 (patch)
tree33d2a87dd50fe5894ac6ec4579c83401b7ab00a4 /sshd_config.5
parentbaccdb349b31c47cd76fb63211f754ed33a9707e (diff)
parent7de4b03a6e4071d454b72927ffaf52949fa34545 (diff)
Import openssh_6.9p1.orig.tar.gz
Diffstat (limited to 'sshd_config.5')
-rw-r--r--sshd_config.5102
1 files changed, 87 insertions, 15 deletions
diff --git a/sshd_config.5 b/sshd_config.5
index 6dce0c70c..5ab431890 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.194 2015/02/20 23:46:01 djm Exp $ 36.\" $OpenBSD: sshd_config.5,v 1.204 2015/06/05 03:44:14 djm Exp $
37.Dd $Mdocdate: February 20 2015 $ 37.Dd $Mdocdate: June 5 2015 $
38.Dt SSHD_CONFIG 5 38.Dt SSHD_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -70,7 +70,11 @@ See
70in 70in
71.Xr ssh_config 5 71.Xr ssh_config 5
72for how to configure the client. 72for how to configure the client.
73Note that environment passing is only supported for protocol 2. 73Note that environment passing is only supported for protocol 2, and
74that the
75.Ev TERM
76environment variable is always sent whenever the client
77requests a pseudo-terminal as it is required by the protocol.
74Variables are specified by name, which may contain the wildcard characters 78Variables are specified by name, which may contain the wildcard characters
75.Ql * 79.Ql *
76and 80and
@@ -230,9 +234,21 @@ The default is not to require multiple authentication; successful completion
230of a single authentication method is sufficient. 234of a single authentication method is sufficient.
231.It Cm AuthorizedKeysCommand 235.It Cm AuthorizedKeysCommand
232Specifies a program to be used to look up the user's public keys. 236Specifies a program to be used to look up the user's public keys.
233The program must be owned by root and not writable by group or others. 237The program must be owned by root, not writable by group or others and
234It will be invoked with a single argument of the username 238specified by an absolute path.
235being authenticated, and should produce on standard output zero or 239.Pp
240Arguments to
241.Cm AuthorizedKeysCommand
242may be provided using the following tokens, which will be expanded
243at runtime: %% is replaced by a literal '%', %u is replaced by the
244username being authenticated, %h is replaced by the home directory
245of the user being authenticated, %t is replaced with the key type
246offered for authentication, %f is replaced with the fingerprint of
247the key, and %k is replaced with the key being offered for authentication.
248If no arguments are specified then the username of the target user
249will be supplied.
250.Pp
251The program should produce on standard output zero or
236more lines of authorized_keys output (see AUTHORIZED_KEYS in 252more lines of authorized_keys output (see AUTHORIZED_KEYS in
237.Xr sshd 8 ) . 253.Xr sshd 8 ) .
238If a key supplied by AuthorizedKeysCommand does not successfully authenticate 254If a key supplied by AuthorizedKeysCommand does not successfully authenticate
@@ -271,6 +287,42 @@ directory.
271Multiple files may be listed, separated by whitespace. 287Multiple files may be listed, separated by whitespace.
272The default is 288The default is
273.Dq .ssh/authorized_keys .ssh/authorized_keys2 . 289.Dq .ssh/authorized_keys .ssh/authorized_keys2 .
290.It Cm AuthorizedPrincipalsCommand
291Specifies a program to be used to generate the list of allowed
292certificate principals as per
293.Cm AuthorizedPrincipalsFile .
294The program must be owned by root, not writable by group or others and
295specified by an absolute path.
296.Pp
297Arguments to
298.Cm AuthorizedPrincipalsCommand
299may be provided using the following tokens, which will be expanded
300at runtime: %% is replaced by a literal '%', %u is replaced by the
301username being authenticated and %h is replaced by the home directory
302of the user being authenticated.
303.Pp
304The program should produce on standard output zero or
305more lines of
306.Cm AuthorizedPrincipalsFile
307output.
308If either
309.Cm AuthorizedPrincipalsCommand
310or
311.Cm AuthorizedPrincipalsFile
312is specified, then certificates offered by the client for authentication
313must contain a principal that is listed.
314By default, no AuthorizedPrincipalsCommand is run.
315.It Cm AuthorizedPrincipalsCommandUser
316Specifies the user under whose account the AuthorizedPrincipalsCommand is run.
317It is recommended to use a dedicated user that has no other role on the host
318than running authorized principals commands.
319If
320.Cm AuthorizedPrincipalsCommand
321is specified but
322.Cm AuthorizedPrincipalsCommandUser
323is not, then
324.Xr sshd 8
325will refuse to start.
274.It Cm AuthorizedPrincipalsFile 326.It Cm AuthorizedPrincipalsFile
275Specifies a file that lists principal names that are accepted for 327Specifies a file that lists principal names that are accepted for
276certificate authentication. 328certificate authentication.
@@ -570,6 +622,21 @@ on logout.
570The default is 622The default is
571.Dq yes . 623.Dq yes .
572Note that this option applies to protocol version 2 only. 624Note that this option applies to protocol version 2 only.
625.It Cm GSSAPIStrictAcceptorCheck
626Determines whether to be strict about the identity of the GSSAPI acceptor
627a client authenticates against.
628If set to
629.Dq yes
630then the client must authenticate against the
631.Pa host
632service on the current hostname.
633If set to
634.Dq no
635then the client may authenticate against any service key stored in the
636machine's default store.
637This facility is provided to assist with operation on multi homed machines.
638The default is
639.Dq yes .
573.It Cm HostbasedAcceptedKeyTypes 640.It Cm HostbasedAcceptedKeyTypes
574Specifies the key types that will be accepted for hostbased authentication 641Specifies the key types that will be accepted for hostbased authentication
575as a comma-separated pattern list. 642as a comma-separated pattern list.
@@ -826,16 +893,13 @@ The following forms may be used:
826If 893If
827.Ar port 894.Ar port
828is not specified, 895is not specified,
829sshd will listen on the address and all prior 896sshd will listen on the address and all
830.Cm Port 897.Cm Port
831options specified. 898options specified.
832The default is to listen on all local addresses. 899The default is to listen on all local addresses.
833Multiple 900Multiple
834.Cm ListenAddress 901.Cm ListenAddress
835options are permitted. 902options are permitted.
836Additionally, any
837.Cm Port
838options must precede this option for non-port qualified addresses.
839.It Cm LoginGraceTime 903.It Cm LoginGraceTime
840The server disconnects after this time if the user has not 904The server disconnects after this time if the user has not
841successfully logged in. 905successfully logged in.
@@ -1093,7 +1157,7 @@ The argument must be
1093or 1157or
1094.Dq no . 1158.Dq no .
1095The default is 1159The default is
1096.Dq yes . 1160.Dq no .
1097.Pp 1161.Pp
1098If this option is set to 1162If this option is set to
1099.Dq without-password , 1163.Dq without-password ,
@@ -1163,7 +1227,9 @@ The default is
1163.Dq yes . 1227.Dq yes .
1164.It Cm PidFile 1228.It Cm PidFile
1165Specifies the file that contains the process ID of the 1229Specifies the file that contains the process ID of the
1166SSH daemon. 1230SSH daemon, or
1231.Dq none
1232to not write one.
1167The default is 1233The default is
1168.Pa /var/run/sshd.pid . 1234.Pa /var/run/sshd.pid .
1169.It Cm Port 1235.It Cm Port
@@ -1253,7 +1319,9 @@ which means that rekeying is performed after the cipher's default amount
1253of data has been sent or received and no time based rekeying is done. 1319of data has been sent or received and no time based rekeying is done.
1254This option applies to protocol version 2 only. 1320This option applies to protocol version 2 only.
1255.It Cm RevokedKeys 1321.It Cm RevokedKeys
1256Specifies revoked public keys. 1322Specifies revoked public keys file, or
1323.Dq none
1324to not use one.
1257Keys listed in this file will be refused for public key authentication. 1325Keys listed in this file will be refused for public key authentication.
1258Note that if this file is not readable, then public key authentication will 1326Note that if this file is not readable, then public key authentication will
1259be refused for all users. 1327be refused for all users.
@@ -1366,7 +1434,9 @@ To disable TCP keepalive messages, the value should be set to
1366.Dq no . 1434.Dq no .
1367.It Cm TrustedUserCAKeys 1435.It Cm TrustedUserCAKeys
1368Specifies a file containing public keys of certificate authorities that are 1436Specifies a file containing public keys of certificate authorities that are
1369trusted to sign user certificates for authentication. 1437trusted to sign user certificates for authentication, or
1438.Dq none
1439to not use one.
1370Keys are listed one per line; empty lines and comments starting with 1440Keys are listed one per line; empty lines and comments starting with
1371.Ql # 1441.Ql #
1372are allowed. 1442are allowed.
@@ -1519,7 +1589,9 @@ The default is
1519.It Cm XAuthLocation 1589.It Cm XAuthLocation
1520Specifies the full pathname of the 1590Specifies the full pathname of the
1521.Xr xauth 1 1591.Xr xauth 1
1522program. 1592program, or
1593.Dq none
1594to not use one.
1523The default is 1595The default is
1524.Pa /usr/X11R6/bin/xauth . 1596.Pa /usr/X11R6/bin/xauth .
1525.El 1597.El