summaryrefslogtreecommitdiff
path: root/sshd_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'sshd_config.5')
-rw-r--r--sshd_config.5105
1 files changed, 80 insertions, 25 deletions
diff --git a/sshd_config.5 b/sshd_config.5
index db1f2fd69..eb6bff85f 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
@@ -95,7 +95,11 @@ 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. 98Note that environment passing is only supported for protocol 2, and
99that the
100.Ev TERM
101environment variable is always sent whenever the client
102requests a pseudo-terminal as it is required by the protocol.
99Variables are specified by name, which may contain the wildcard characters 103Variables are specified by name, which may contain the wildcard characters
100.Ql * 104.Ql *
101and 105and
@@ -255,9 +259,21 @@ The default is not to require multiple authentication; successful completion
255of a single authentication method is sufficient. 259of a single authentication method is sufficient.
256.It Cm AuthorizedKeysCommand 260.It Cm AuthorizedKeysCommand
257Specifies a program to be used to look up the user's public keys. 261Specifies a program to be used to look up the user's public keys.
258The program must be owned by root and not writable by group or others. 262The program must be owned by root, not writable by group or others and
259It will be invoked with a single argument of the username 263specified by an absolute path.
260being authenticated, and should produce on standard output zero or 264.Pp
265Arguments to
266.Cm AuthorizedKeysCommand
267may be provided using the following tokens, which will be expanded
268at runtime: %% is replaced by a literal '%', %u is replaced by the
269username being authenticated, %h is replaced by the home directory
270of the user being authenticated, %t is replaced with the key type
271offered for authentication, %f is replaced with the fingerprint of
272the key, and %k is replaced with the key being offered for authentication.
273If no arguments are specified then the username of the target user
274will be supplied.
275.Pp
276The program should produce on standard output zero or
261more lines of authorized_keys output (see AUTHORIZED_KEYS in 277more lines of authorized_keys output (see AUTHORIZED_KEYS in
262.Xr sshd 8 ) . 278.Xr sshd 8 ) .
263If a key supplied by AuthorizedKeysCommand does not successfully authenticate 279If a key supplied by AuthorizedKeysCommand does not successfully authenticate
@@ -296,6 +312,42 @@ directory.
296Multiple files may be listed, separated by whitespace. 312Multiple files may be listed, separated by whitespace.
297The default is 313The default is
298.Dq .ssh/authorized_keys .ssh/authorized_keys2 . 314.Dq .ssh/authorized_keys .ssh/authorized_keys2 .
315.It Cm AuthorizedPrincipalsCommand
316Specifies a program to be used to generate the list of allowed
317certificate principals as per
318.Cm AuthorizedPrincipalsFile .
319The program must be owned by root, not writable by group or others and
320specified by an absolute path.
321.Pp
322Arguments to
323.Cm AuthorizedPrincipalsCommand
324may be provided using the following tokens, which will be expanded
325at runtime: %% is replaced by a literal '%', %u is replaced by the
326username being authenticated and %h is replaced by the home directory
327of the user being authenticated.
328.Pp
329The program should produce on standard output zero or
330more lines of
331.Cm AuthorizedPrincipalsFile
332output.
333If either
334.Cm AuthorizedPrincipalsCommand
335or
336.Cm AuthorizedPrincipalsFile
337is specified, then certificates offered by the client for authentication
338must contain a principal that is listed.
339By default, no AuthorizedPrincipalsCommand is run.
340.It Cm AuthorizedPrincipalsCommandUser
341Specifies the user under whose account the AuthorizedPrincipalsCommand is run.
342It is recommended to use a dedicated user that has no other role on the host
343than running authorized principals commands.
344If
345.Cm AuthorizedPrincipalsCommand
346is specified but
347.Cm AuthorizedPrincipalsCommandUser
348is not, then
349.Xr sshd 8
350will refuse to start.
299.It Cm AuthorizedPrincipalsFile 351.It Cm AuthorizedPrincipalsFile
300Specifies a file that lists principal names that are accepted for 352Specifies a file that lists principal names that are accepted for
301certificate authentication. 353certificate authentication.
@@ -606,22 +658,20 @@ The default is
606.Dq yes . 658.Dq yes .
607Note that this option applies to protocol version 2 only. 659Note that this option applies to protocol version 2 only.
608.It Cm GSSAPIStrictAcceptorCheck 660.It Cm GSSAPIStrictAcceptorCheck
609Determines whether to be strict about the identity of the GSSAPI acceptor 661Determines whether to be strict about the identity of the GSSAPI acceptor
610a client authenticates against. If 662a client authenticates against.
663If set to
611.Dq yes 664.Dq yes
612then the client must authenticate against the 665then the client must authenticate against the
613.Pa host 666.Pa host
614service on the current hostname. If 667service on the current hostname.
668If set to
615.Dq no 669.Dq no
616then the client may authenticate against any service key stored in the 670then the client may authenticate against any service key stored in the
617machine's default store. This facility is provided to assist with operation 671machine's default store.
618on multi homed machines. 672This facility is provided to assist with operation on multi homed machines.
619The default is 673The default is
620.Dq yes . 674.Dq yes .
621Note that this option applies only to protocol version 2 GSSAPI connections,
622and setting it to
623.Dq no
624may only work with recent Kerberos GSSAPI libraries.
625.It Cm GSSAPIStoreCredentialsOnRekey 675.It Cm GSSAPIStoreCredentialsOnRekey
626Controls whether the user's GSSAPI credentials should be updated following a 676Controls whether the user's GSSAPI credentials should be updated following a
627successful connection rekeying. This option can be used to accepted renewed 677successful connection rekeying. This option can be used to accepted renewed
@@ -883,16 +933,13 @@ The following forms may be used:
883If 933If
884.Ar port 934.Ar port
885is not specified, 935is not specified,
886sshd will listen on the address and all prior 936sshd will listen on the address and all
887.Cm Port 937.Cm Port
888options specified. 938options specified.
889The default is to listen on all local addresses. 939The default is to listen on all local addresses.
890Multiple 940Multiple
891.Cm ListenAddress 941.Cm ListenAddress
892options are permitted. 942options are permitted.
893Additionally, any
894.Cm Port
895options must precede this option for non-port qualified addresses.
896.It Cm LoginGraceTime 943.It Cm LoginGraceTime
897The server disconnects after this time if the user has not 944The server disconnects after this time if the user has not
898successfully logged in. 945successfully logged in.
@@ -1150,7 +1197,7 @@ The argument must be
1150or 1197or
1151.Dq no . 1198.Dq no .
1152The default is 1199The default is
1153.Dq yes . 1200.Dq no .
1154.Pp 1201.Pp
1155If this option is set to 1202If this option is set to
1156.Dq without-password , 1203.Dq without-password ,
@@ -1220,7 +1267,9 @@ The default is
1220.Dq yes . 1267.Dq yes .
1221.It Cm PidFile 1268.It Cm PidFile
1222Specifies the file that contains the process ID of the 1269Specifies the file that contains the process ID of the
1223SSH daemon. 1270SSH daemon, or
1271.Dq none
1272to not write one.
1224The default is 1273The default is
1225.Pa /var/run/sshd.pid . 1274.Pa /var/run/sshd.pid .
1226.It Cm Port 1275.It Cm Port
@@ -1310,7 +1359,9 @@ which means that rekeying is performed after the cipher's default amount
1310of data has been sent or received and no time based rekeying is done. 1359of data has been sent or received and no time based rekeying is done.
1311This option applies to protocol version 2 only. 1360This option applies to protocol version 2 only.
1312.It Cm RevokedKeys 1361.It Cm RevokedKeys
1313Specifies revoked public keys. 1362Specifies revoked public keys file, or
1363.Dq none
1364to not use one.
1314Keys listed in this file will be refused for public key authentication. 1365Keys listed in this file will be refused for public key authentication.
1315Note that if this file is not readable, then public key authentication will 1366Note that if this file is not readable, then public key authentication will
1316be refused for all users. 1367be refused for all users.
@@ -1426,7 +1477,9 @@ This option was formerly called
1426.Cm KeepAlive . 1477.Cm KeepAlive .
1427.It Cm TrustedUserCAKeys 1478.It Cm TrustedUserCAKeys
1428Specifies a file containing public keys of certificate authorities that are 1479Specifies a file containing public keys of certificate authorities that are
1429trusted to sign user certificates for authentication. 1480trusted to sign user certificates for authentication, or
1481.Dq none
1482to not use one.
1430Keys are listed one per line; empty lines and comments starting with 1483Keys are listed one per line; empty lines and comments starting with
1431.Ql # 1484.Ql #
1432are allowed. 1485are allowed.
@@ -1579,7 +1632,9 @@ The default is
1579.It Cm XAuthLocation 1632.It Cm XAuthLocation
1580Specifies the full pathname of the 1633Specifies the full pathname of the
1581.Xr xauth 1 1634.Xr xauth 1
1582program. 1635program, or
1636.Dq none
1637to not use one.
1583The default is 1638The default is
1584.Pa /usr/X11R6/bin/xauth . 1639.Pa /usr/X11R6/bin/xauth .
1585.El 1640.El