1545d5ecaSDag-Erling Smørgrav.\" 2545d5ecaSDag-Erling Smørgrav.\" Author: Tatu Ylonen <ylo@cs.hut.fi> 3545d5ecaSDag-Erling Smørgrav.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 4545d5ecaSDag-Erling Smørgrav.\" All rights reserved 5545d5ecaSDag-Erling Smørgrav.\" 6545d5ecaSDag-Erling Smørgrav.\" As far as I am concerned, the code I have written for this software 7545d5ecaSDag-Erling Smørgrav.\" can be used freely for any purpose. Any derived versions of this 8545d5ecaSDag-Erling Smørgrav.\" software must be clearly marked as such, and if the derived work is 9545d5ecaSDag-Erling Smørgrav.\" incompatible with the protocol description in the RFC file, it must be 10545d5ecaSDag-Erling Smørgrav.\" called by a name other than "ssh" or "Secure Shell". 11545d5ecaSDag-Erling Smørgrav.\" 12545d5ecaSDag-Erling Smørgrav.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. 13545d5ecaSDag-Erling Smørgrav.\" Copyright (c) 1999 Aaron Campbell. All rights reserved. 14545d5ecaSDag-Erling Smørgrav.\" Copyright (c) 1999 Theo de Raadt. All rights reserved. 15545d5ecaSDag-Erling Smørgrav.\" 16545d5ecaSDag-Erling Smørgrav.\" Redistribution and use in source and binary forms, with or without 17545d5ecaSDag-Erling Smørgrav.\" modification, are permitted provided that the following conditions 18545d5ecaSDag-Erling Smørgrav.\" are met: 19545d5ecaSDag-Erling Smørgrav.\" 1. Redistributions of source code must retain the above copyright 20545d5ecaSDag-Erling Smørgrav.\" notice, this list of conditions and the following disclaimer. 21545d5ecaSDag-Erling Smørgrav.\" 2. Redistributions in binary form must reproduce the above copyright 22545d5ecaSDag-Erling Smørgrav.\" notice, this list of conditions and the following disclaimer in the 23545d5ecaSDag-Erling Smørgrav.\" documentation and/or other materials provided with the distribution. 24545d5ecaSDag-Erling Smørgrav.\" 25545d5ecaSDag-Erling Smørgrav.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 26545d5ecaSDag-Erling Smørgrav.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 27545d5ecaSDag-Erling Smørgrav.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 28545d5ecaSDag-Erling Smørgrav.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 29545d5ecaSDag-Erling Smørgrav.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 30545d5ecaSDag-Erling Smørgrav.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 31545d5ecaSDag-Erling Smørgrav.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 32545d5ecaSDag-Erling Smørgrav.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 33545d5ecaSDag-Erling Smørgrav.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 34545d5ecaSDag-Erling Smørgrav.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 35545d5ecaSDag-Erling Smørgrav.\" 36*acc1a9efSDag-Erling Smørgrav.\" $OpenBSD: sshd_config.5,v 1.220 2016/02/17 08:57:34 djm Exp $ 3735d4ccfbSDag-Erling Smørgrav.\" $FreeBSD$ 38*acc1a9efSDag-Erling Smørgrav.Dd $Mdocdate: February 17 2016 $ 39545d5ecaSDag-Erling Smørgrav.Dt SSHD_CONFIG 5 40545d5ecaSDag-Erling Smørgrav.Os 41545d5ecaSDag-Erling Smørgrav.Sh NAME 42545d5ecaSDag-Erling Smørgrav.Nm sshd_config 43545d5ecaSDag-Erling Smørgrav.Nd OpenSSH SSH daemon configuration file 44545d5ecaSDag-Erling Smørgrav.Sh SYNOPSIS 45d4af9e69SDag-Erling Smørgrav.Nm /etc/ssh/sshd_config 46545d5ecaSDag-Erling Smørgrav.Sh DESCRIPTION 47333ee039SDag-Erling Smørgrav.Xr sshd 8 48545d5ecaSDag-Erling Smørgravreads configuration data from 49545d5ecaSDag-Erling Smørgrav.Pa /etc/ssh/sshd_config 50545d5ecaSDag-Erling Smørgrav(or the file specified with 51545d5ecaSDag-Erling Smørgrav.Fl f 52545d5ecaSDag-Erling Smørgravon the command line). 53545d5ecaSDag-Erling SmørgravThe file contains keyword-argument pairs, one per line. 54545d5ecaSDag-Erling SmørgravLines starting with 55545d5ecaSDag-Erling Smørgrav.Ql # 56545d5ecaSDag-Erling Smørgravand empty lines are interpreted as comments. 57333ee039SDag-Erling SmørgravArguments may optionally be enclosed in double quotes 58333ee039SDag-Erling Smørgrav.Pq \&" 59333ee039SDag-Erling Smørgravin order to represent arguments containing spaces. 60545d5ecaSDag-Erling Smørgrav.Pp 61545d5ecaSDag-Erling SmørgravThe possible 62545d5ecaSDag-Erling Smørgravkeywords and their meanings are as follows (note that 63545d5ecaSDag-Erling Smørgravkeywords are case-insensitive and arguments are case-sensitive): 64545d5ecaSDag-Erling Smørgrav.Bl -tag -width Ds 6521e764dfSDag-Erling Smørgrav.It Cm AcceptEnv 6621e764dfSDag-Erling SmørgravSpecifies what environment variables sent by the client will be copied into 6721e764dfSDag-Erling Smørgravthe session's 6821e764dfSDag-Erling Smørgrav.Xr environ 7 . 6921e764dfSDag-Erling SmørgravSee 7021e764dfSDag-Erling Smørgrav.Cm SendEnv 7121e764dfSDag-Erling Smørgravin 7221e764dfSDag-Erling Smørgrav.Xr ssh_config 5 7321e764dfSDag-Erling Smørgravfor how to configure the client. 74*acc1a9efSDag-Erling SmørgravThe 75557f75e5SDag-Erling Smørgrav.Ev TERM 76557f75e5SDag-Erling Smørgravenvironment variable is always sent whenever the client 77557f75e5SDag-Erling Smørgravrequests a pseudo-terminal as it is required by the protocol. 7821e764dfSDag-Erling SmørgravVariables are specified by name, which may contain the wildcard characters 79333ee039SDag-Erling Smørgrav.Ql * 8021e764dfSDag-Erling Smørgravand 8121e764dfSDag-Erling Smørgrav.Ql \&? . 8221e764dfSDag-Erling SmørgravMultiple environment variables may be separated by whitespace or spread 8321e764dfSDag-Erling Smørgravacross multiple 8421e764dfSDag-Erling Smørgrav.Cm AcceptEnv 8521e764dfSDag-Erling Smørgravdirectives. 8621e764dfSDag-Erling SmørgravBe warned that some environment variables could be used to bypass restricted 8721e764dfSDag-Erling Smørgravuser environments. 8821e764dfSDag-Erling SmørgravFor this reason, care should be taken in the use of this directive. 8921e764dfSDag-Erling SmørgravThe default is not to accept any environment variables. 90aa49c926SDag-Erling Smørgrav.It Cm AddressFamily 91aa49c926SDag-Erling SmørgravSpecifies which address family should be used by 92333ee039SDag-Erling Smørgrav.Xr sshd 8 . 93aa49c926SDag-Erling SmørgravValid arguments are 94aa49c926SDag-Erling Smørgrav.Dq any , 95aa49c926SDag-Erling Smørgrav.Dq inet 96333ee039SDag-Erling Smørgrav(use IPv4 only), or 97aa49c926SDag-Erling Smørgrav.Dq inet6 98aa49c926SDag-Erling Smørgrav(use IPv6 only). 99aa49c926SDag-Erling SmørgravThe default is 100aa49c926SDag-Erling Smørgrav.Dq any . 101d4af9e69SDag-Erling Smørgrav.It Cm AllowAgentForwarding 102d4af9e69SDag-Erling SmørgravSpecifies whether 103d4af9e69SDag-Erling Smørgrav.Xr ssh-agent 1 104d4af9e69SDag-Erling Smørgravforwarding is permitted. 105d4af9e69SDag-Erling SmørgravThe default is 106d4af9e69SDag-Erling Smørgrav.Dq yes . 107d4af9e69SDag-Erling SmørgravNote that disabling agent forwarding does not improve security 108d4af9e69SDag-Erling Smørgravunless users are also denied shell access, as they can always install 109d4af9e69SDag-Erling Smørgravtheir own forwarders. 110545d5ecaSDag-Erling Smørgrav.It Cm AllowGroups 111545d5ecaSDag-Erling SmørgravThis keyword can be followed by a list of group name patterns, separated 112545d5ecaSDag-Erling Smørgravby spaces. 113545d5ecaSDag-Erling SmørgravIf specified, login is allowed only for users whose primary 114545d5ecaSDag-Erling Smørgravgroup or supplementary group list matches one of the patterns. 115545d5ecaSDag-Erling SmørgravOnly group names are valid; a numerical group ID is not recognized. 116545d5ecaSDag-Erling SmørgravBy default, login is allowed for all groups. 117333ee039SDag-Erling SmørgravThe allow/deny directives are processed in the following order: 118333ee039SDag-Erling Smørgrav.Cm DenyUsers , 119333ee039SDag-Erling Smørgrav.Cm AllowUsers , 120333ee039SDag-Erling Smørgrav.Cm DenyGroups , 121333ee039SDag-Erling Smørgravand finally 122333ee039SDag-Erling Smørgrav.Cm AllowGroups . 123333ee039SDag-Erling Smørgrav.Pp 124e4a9863fSDag-Erling SmørgravSee PATTERNS in 125333ee039SDag-Erling Smørgrav.Xr ssh_config 5 126333ee039SDag-Erling Smørgravfor more information on patterns. 127545d5ecaSDag-Erling Smørgrav.It Cm AllowTcpForwarding 128545d5ecaSDag-Erling SmørgravSpecifies whether TCP forwarding is permitted. 1296888a9beSDag-Erling SmørgravThe available options are 1306888a9beSDag-Erling Smørgrav.Dq yes 1316888a9beSDag-Erling Smørgravor 1326888a9beSDag-Erling Smørgrav.Dq all 1336888a9beSDag-Erling Smørgravto allow TCP forwarding, 1346888a9beSDag-Erling Smørgrav.Dq no 1356888a9beSDag-Erling Smørgravto prevent all TCP forwarding, 1366888a9beSDag-Erling Smørgrav.Dq local 1376888a9beSDag-Erling Smørgravto allow local (from the perspective of 1386888a9beSDag-Erling Smørgrav.Xr ssh 1 ) 1396888a9beSDag-Erling Smørgravforwarding only or 1406888a9beSDag-Erling Smørgrav.Dq remote 1416888a9beSDag-Erling Smørgravto allow remote forwarding only. 142545d5ecaSDag-Erling SmørgravThe default is 143545d5ecaSDag-Erling Smørgrav.Dq yes . 144545d5ecaSDag-Erling SmørgravNote that disabling TCP forwarding does not improve security unless 145545d5ecaSDag-Erling Smørgravusers are also denied shell access, as they can always install their 146545d5ecaSDag-Erling Smørgravown forwarders. 147a0ee8cc6SDag-Erling Smørgrav.It Cm AllowStreamLocalForwarding 148a0ee8cc6SDag-Erling SmørgravSpecifies whether StreamLocal (Unix-domain socket) forwarding is permitted. 149a0ee8cc6SDag-Erling SmørgravThe available options are 150a0ee8cc6SDag-Erling Smørgrav.Dq yes 151a0ee8cc6SDag-Erling Smørgravor 152a0ee8cc6SDag-Erling Smørgrav.Dq all 153a0ee8cc6SDag-Erling Smørgravto allow StreamLocal forwarding, 154a0ee8cc6SDag-Erling Smørgrav.Dq no 155a0ee8cc6SDag-Erling Smørgravto prevent all StreamLocal forwarding, 156a0ee8cc6SDag-Erling Smørgrav.Dq local 157a0ee8cc6SDag-Erling Smørgravto allow local (from the perspective of 158a0ee8cc6SDag-Erling Smørgrav.Xr ssh 1 ) 159a0ee8cc6SDag-Erling Smørgravforwarding only or 160a0ee8cc6SDag-Erling Smørgrav.Dq remote 161a0ee8cc6SDag-Erling Smørgravto allow remote forwarding only. 162a0ee8cc6SDag-Erling SmørgravThe default is 163a0ee8cc6SDag-Erling Smørgrav.Dq yes . 164a0ee8cc6SDag-Erling SmørgravNote that disabling StreamLocal forwarding does not improve security unless 165a0ee8cc6SDag-Erling Smørgravusers are also denied shell access, as they can always install their 166a0ee8cc6SDag-Erling Smørgravown forwarders. 167545d5ecaSDag-Erling Smørgrav.It Cm AllowUsers 168545d5ecaSDag-Erling SmørgravThis keyword can be followed by a list of user name patterns, separated 169545d5ecaSDag-Erling Smørgravby spaces. 170e73e9afaSDag-Erling SmørgravIf specified, login is allowed only for user names that 171545d5ecaSDag-Erling Smørgravmatch one of the patterns. 172545d5ecaSDag-Erling SmørgravOnly user names are valid; a numerical user ID is not recognized. 173545d5ecaSDag-Erling SmørgravBy default, login is allowed for all users. 174545d5ecaSDag-Erling SmørgravIf the pattern takes the form USER@HOST then USER and HOST 175545d5ecaSDag-Erling Smørgravare separately checked, restricting logins to particular 176545d5ecaSDag-Erling Smørgravusers from particular hosts. 177333ee039SDag-Erling SmørgravThe allow/deny directives are processed in the following order: 178333ee039SDag-Erling Smørgrav.Cm DenyUsers , 179333ee039SDag-Erling Smørgrav.Cm AllowUsers , 180333ee039SDag-Erling Smørgrav.Cm DenyGroups , 181333ee039SDag-Erling Smørgravand finally 182333ee039SDag-Erling Smørgrav.Cm AllowGroups . 183333ee039SDag-Erling Smørgrav.Pp 184e4a9863fSDag-Erling SmørgravSee PATTERNS in 185333ee039SDag-Erling Smørgrav.Xr ssh_config 5 186333ee039SDag-Erling Smørgravfor more information on patterns. 1876888a9beSDag-Erling Smørgrav.It Cm AuthenticationMethods 1886888a9beSDag-Erling SmørgravSpecifies the authentication methods that must be successfully completed 1896888a9beSDag-Erling Smørgravfor a user to be granted access. 1906888a9beSDag-Erling SmørgravThis option must be followed by one or more comma-separated lists of 1916888a9beSDag-Erling Smørgravauthentication method names. 1926888a9beSDag-Erling SmørgravSuccessful authentication requires completion of every method in at least 1936888a9beSDag-Erling Smørgravone of these lists. 1946888a9beSDag-Erling Smørgrav.Pp 1956888a9beSDag-Erling SmørgravFor example, an argument of 1966888a9beSDag-Erling Smørgrav.Dq publickey,password publickey,keyboard-interactive 1976888a9beSDag-Erling Smørgravwould require the user to complete public key authentication, followed by 1986888a9beSDag-Erling Smørgraveither password or keyboard interactive authentication. 1996888a9beSDag-Erling SmørgravOnly methods that are next in one or more lists are offered at each stage, 2006888a9beSDag-Erling Smørgravso for this example, it would not be possible to attempt password or 2016888a9beSDag-Erling Smørgravkeyboard-interactive authentication before public key. 2026888a9beSDag-Erling Smørgrav.Pp 203e4a9863fSDag-Erling SmørgravFor keyboard interactive authentication it is also possible to 204e4a9863fSDag-Erling Smørgravrestrict authentication to a specific device by appending a 205e4a9863fSDag-Erling Smørgravcolon followed by the device identifier 206e4a9863fSDag-Erling Smørgrav.Dq bsdauth , 207e4a9863fSDag-Erling Smørgrav.Dq pam , 208e4a9863fSDag-Erling Smørgravor 209e4a9863fSDag-Erling Smørgrav.Dq skey , 210e4a9863fSDag-Erling Smørgravdepending on the server configuration. 211e4a9863fSDag-Erling SmørgravFor example, 212e4a9863fSDag-Erling Smørgrav.Dq keyboard-interactive:bsdauth 213e4a9863fSDag-Erling Smørgravwould restrict keyboard interactive authentication to the 214e4a9863fSDag-Erling Smørgrav.Dq bsdauth 215e4a9863fSDag-Erling Smørgravdevice. 216e4a9863fSDag-Erling Smørgrav.Pp 217bc5531deSDag-Erling SmørgravIf the 218bc5531deSDag-Erling Smørgrav.Dq publickey 219bc5531deSDag-Erling Smørgravmethod is listed more than once, 220bc5531deSDag-Erling Smørgrav.Xr sshd 8 221bc5531deSDag-Erling Smørgravverifies that keys that have been used successfully are not reused for 222bc5531deSDag-Erling Smørgravsubsequent authentications. 223bc5531deSDag-Erling SmørgravFor example, an 224bc5531deSDag-Erling Smørgrav.Cm AuthenticationMethods 225bc5531deSDag-Erling Smørgravof 226bc5531deSDag-Erling Smørgrav.Dq publickey,publickey 227bc5531deSDag-Erling Smørgravwill require successful authentication using two different public keys. 228bc5531deSDag-Erling Smørgrav.Pp 229*acc1a9efSDag-Erling SmørgravThis option will yield a fatal 2306888a9beSDag-Erling Smørgraverror if enabled if protocol 1 is also enabled. 2316888a9beSDag-Erling SmørgravNote that each authentication method listed should also be explicitly enabled 2326888a9beSDag-Erling Smørgravin the configuration. 2336888a9beSDag-Erling SmørgravThe default is not to require multiple authentication; successful completion 2346888a9beSDag-Erling Smørgravof a single authentication method is sufficient. 2356888a9beSDag-Erling Smørgrav.It Cm AuthorizedKeysCommand 2366888a9beSDag-Erling SmørgravSpecifies a program to be used to look up the user's public keys. 237557f75e5SDag-Erling SmørgravThe program must be owned by root, not writable by group or others and 238557f75e5SDag-Erling Smørgravspecified by an absolute path. 239557f75e5SDag-Erling Smørgrav.Pp 240557f75e5SDag-Erling SmørgravArguments to 241557f75e5SDag-Erling Smørgrav.Cm AuthorizedKeysCommand 242557f75e5SDag-Erling Smørgravmay be provided using the following tokens, which will be expanded 243557f75e5SDag-Erling Smørgravat runtime: %% is replaced by a literal '%', %u is replaced by the 244557f75e5SDag-Erling Smørgravusername being authenticated, %h is replaced by the home directory 245557f75e5SDag-Erling Smørgravof the user being authenticated, %t is replaced with the key type 246557f75e5SDag-Erling Smørgravoffered for authentication, %f is replaced with the fingerprint of 247557f75e5SDag-Erling Smørgravthe key, and %k is replaced with the key being offered for authentication. 248557f75e5SDag-Erling SmørgravIf no arguments are specified then the username of the target user 249557f75e5SDag-Erling Smørgravwill be supplied. 250557f75e5SDag-Erling Smørgrav.Pp 251557f75e5SDag-Erling SmørgravThe program should produce on standard output zero or 252e4a9863fSDag-Erling Smørgravmore lines of authorized_keys output (see AUTHORIZED_KEYS in 2536888a9beSDag-Erling Smørgrav.Xr sshd 8 ) . 2546888a9beSDag-Erling SmørgravIf a key supplied by AuthorizedKeysCommand does not successfully authenticate 2556888a9beSDag-Erling Smørgravand authorize the user then public key authentication continues using the usual 2566888a9beSDag-Erling Smørgrav.Cm AuthorizedKeysFile 2576888a9beSDag-Erling Smørgravfiles. 2586888a9beSDag-Erling SmørgravBy default, no AuthorizedKeysCommand is run. 2596888a9beSDag-Erling Smørgrav.It Cm AuthorizedKeysCommandUser 2606888a9beSDag-Erling SmørgravSpecifies the user under whose account the AuthorizedKeysCommand is run. 2616888a9beSDag-Erling SmørgravIt is recommended to use a dedicated user that has no other role on the host 2626888a9beSDag-Erling Smørgravthan running authorized keys commands. 263bc5531deSDag-Erling SmørgravIf 264bc5531deSDag-Erling Smørgrav.Cm AuthorizedKeysCommand 265bc5531deSDag-Erling Smørgravis specified but 266bc5531deSDag-Erling Smørgrav.Cm AuthorizedKeysCommandUser 267bc5531deSDag-Erling Smørgravis not, then 268bc5531deSDag-Erling Smørgrav.Xr sshd 8 269bc5531deSDag-Erling Smørgravwill refuse to start. 270545d5ecaSDag-Erling Smørgrav.It Cm AuthorizedKeysFile 271545d5ecaSDag-Erling SmørgravSpecifies the file that contains the public keys that can be used 272545d5ecaSDag-Erling Smørgravfor user authentication. 273e2f6069cSDag-Erling SmørgravThe format is described in the 274e4a9863fSDag-Erling SmørgravAUTHORIZED_KEYS FILE FORMAT 275e2f6069cSDag-Erling Smørgravsection of 276e2f6069cSDag-Erling Smørgrav.Xr sshd 8 . 277545d5ecaSDag-Erling Smørgrav.Cm AuthorizedKeysFile 278545d5ecaSDag-Erling Smørgravmay contain tokens of the form %T which are substituted during connection 279333ee039SDag-Erling Smørgravsetup. 280cf2b5f3bSDag-Erling SmørgravThe following tokens are defined: %% is replaced by a literal '%', 281333ee039SDag-Erling Smørgrav%h is replaced by the home directory of the user being authenticated, and 282545d5ecaSDag-Erling Smørgrav%u is replaced by the username of that user. 283545d5ecaSDag-Erling SmørgravAfter expansion, 284545d5ecaSDag-Erling Smørgrav.Cm AuthorizedKeysFile 285545d5ecaSDag-Erling Smørgravis taken to be an absolute path or one relative to the user's home 286545d5ecaSDag-Erling Smørgravdirectory. 287e146993eSDag-Erling SmørgravMultiple files may be listed, separated by whitespace. 288*acc1a9efSDag-Erling SmørgravAlternately this option may be set to 289*acc1a9efSDag-Erling Smørgrav.Dq none 290*acc1a9efSDag-Erling Smørgravto skip checking for user keys in files. 291545d5ecaSDag-Erling SmørgravThe default is 292e146993eSDag-Erling Smørgrav.Dq .ssh/authorized_keys .ssh/authorized_keys2 . 293557f75e5SDag-Erling Smørgrav.It Cm AuthorizedPrincipalsCommand 294557f75e5SDag-Erling SmørgravSpecifies a program to be used to generate the list of allowed 295557f75e5SDag-Erling Smørgravcertificate principals as per 296557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile . 297557f75e5SDag-Erling SmørgravThe program must be owned by root, not writable by group or others and 298557f75e5SDag-Erling Smørgravspecified by an absolute path. 299557f75e5SDag-Erling Smørgrav.Pp 300557f75e5SDag-Erling SmørgravArguments to 301557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsCommand 302557f75e5SDag-Erling Smørgravmay be provided using the following tokens, which will be expanded 303557f75e5SDag-Erling Smørgravat runtime: %% is replaced by a literal '%', %u is replaced by the 304557f75e5SDag-Erling Smørgravusername being authenticated and %h is replaced by the home directory 305557f75e5SDag-Erling Smørgravof the user being authenticated. 306557f75e5SDag-Erling Smørgrav.Pp 307557f75e5SDag-Erling SmørgravThe program should produce on standard output zero or 308557f75e5SDag-Erling Smørgravmore lines of 309557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile 310557f75e5SDag-Erling Smørgravoutput. 311557f75e5SDag-Erling SmørgravIf either 312557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsCommand 313557f75e5SDag-Erling Smørgravor 314557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile 315557f75e5SDag-Erling Smørgravis specified, then certificates offered by the client for authentication 316557f75e5SDag-Erling Smørgravmust contain a principal that is listed. 317557f75e5SDag-Erling SmørgravBy default, no AuthorizedPrincipalsCommand is run. 318557f75e5SDag-Erling Smørgrav.It Cm AuthorizedPrincipalsCommandUser 319557f75e5SDag-Erling SmørgravSpecifies the user under whose account the AuthorizedPrincipalsCommand is run. 320557f75e5SDag-Erling SmørgravIt is recommended to use a dedicated user that has no other role on the host 321557f75e5SDag-Erling Smørgravthan running authorized principals commands. 322557f75e5SDag-Erling SmørgravIf 323557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsCommand 324557f75e5SDag-Erling Smørgravis specified but 325557f75e5SDag-Erling Smørgrav.Cm AuthorizedPrincipalsCommandUser 326557f75e5SDag-Erling Smørgravis not, then 327557f75e5SDag-Erling Smørgrav.Xr sshd 8 328557f75e5SDag-Erling Smørgravwill refuse to start. 329e2f6069cSDag-Erling Smørgrav.It Cm AuthorizedPrincipalsFile 330e2f6069cSDag-Erling SmørgravSpecifies a file that lists principal names that are accepted for 331e2f6069cSDag-Erling Smørgravcertificate authentication. 332e2f6069cSDag-Erling SmørgravWhen using certificates signed by a key listed in 333e2f6069cSDag-Erling Smørgrav.Cm TrustedUserCAKeys , 334e2f6069cSDag-Erling Smørgravthis file lists names, one of which must appear in the certificate for it 335e2f6069cSDag-Erling Smørgravto be accepted for authentication. 336e2f6069cSDag-Erling SmørgravNames are listed one per line preceded by key options (as described 337e4a9863fSDag-Erling Smørgravin AUTHORIZED_KEYS FILE FORMAT in 338e2f6069cSDag-Erling Smørgrav.Xr sshd 8 ) . 339e2f6069cSDag-Erling SmørgravEmpty lines and comments starting with 340e2f6069cSDag-Erling Smørgrav.Ql # 341e2f6069cSDag-Erling Smørgravare ignored. 342e2f6069cSDag-Erling Smørgrav.Pp 343e2f6069cSDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile 344e2f6069cSDag-Erling Smørgravmay contain tokens of the form %T which are substituted during connection 345e2f6069cSDag-Erling Smørgravsetup. 346e2f6069cSDag-Erling SmørgravThe following tokens are defined: %% is replaced by a literal '%', 347e2f6069cSDag-Erling Smørgrav%h is replaced by the home directory of the user being authenticated, and 348e2f6069cSDag-Erling Smørgrav%u is replaced by the username of that user. 349e2f6069cSDag-Erling SmørgravAfter expansion, 350e2f6069cSDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile 351e2f6069cSDag-Erling Smørgravis taken to be an absolute path or one relative to the user's home 352e2f6069cSDag-Erling Smørgravdirectory. 353e2f6069cSDag-Erling Smørgrav.Pp 354462c32cbSDag-Erling SmørgravThe default is 355462c32cbSDag-Erling Smørgrav.Dq none , 356462c32cbSDag-Erling Smørgravi.e. not to use a principals file \(en in this case, the username 357e2f6069cSDag-Erling Smørgravof the user must appear in a certificate's principals list for it to be 358e2f6069cSDag-Erling Smørgravaccepted. 359e2f6069cSDag-Erling SmørgravNote that 360e2f6069cSDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile 361e2f6069cSDag-Erling Smørgravis only used when authentication proceeds using a CA listed in 362e2f6069cSDag-Erling Smørgrav.Cm TrustedUserCAKeys 363e2f6069cSDag-Erling Smørgravand is not consulted for certification authorities trusted via 364e2f6069cSDag-Erling Smørgrav.Pa ~/.ssh/authorized_keys , 365e2f6069cSDag-Erling Smørgravthough the 366e2f6069cSDag-Erling Smørgrav.Cm principals= 367e2f6069cSDag-Erling Smørgravkey option offers a similar facility (see 368e2f6069cSDag-Erling Smørgrav.Xr sshd 8 369e2f6069cSDag-Erling Smørgravfor details). 370545d5ecaSDag-Erling Smørgrav.It Cm Banner 371545d5ecaSDag-Erling SmørgravThe contents of the specified file are sent to the remote user before 372545d5ecaSDag-Erling Smørgravauthentication is allowed. 373d4af9e69SDag-Erling SmørgravIf the argument is 374d4af9e69SDag-Erling Smørgrav.Dq none 375d4af9e69SDag-Erling Smørgravthen no banner is displayed. 376545d5ecaSDag-Erling SmørgravBy default, no banner is displayed. 377545d5ecaSDag-Erling Smørgrav.It Cm ChallengeResponseAuthentication 3787aee6ffeSDag-Erling SmørgravSpecifies whether challenge-response authentication is allowed (e.g. via 379a0ee8cc6SDag-Erling SmørgravPAM or through authentication styles supported in 3807aee6ffeSDag-Erling Smørgrav.Xr login.conf 5 ) 381545d5ecaSDag-Erling SmørgravThe default is 382545d5ecaSDag-Erling Smørgrav.Dq yes . 383d4af9e69SDag-Erling Smørgrav.It Cm ChrootDirectory 384b15c8340SDag-Erling SmørgravSpecifies the pathname of a directory to 385d4af9e69SDag-Erling Smørgrav.Xr chroot 2 386d4af9e69SDag-Erling Smørgravto after authentication. 387bc5531deSDag-Erling SmørgravAt session startup 388bc5531deSDag-Erling Smørgrav.Xr sshd 8 389bc5531deSDag-Erling Smørgravchecks that all components of the pathname are root-owned directories 390bc5531deSDag-Erling Smørgravwhich are not writable by any other user or group. 3917aee6ffeSDag-Erling SmørgravAfter the chroot, 3927aee6ffeSDag-Erling Smørgrav.Xr sshd 8 3937aee6ffeSDag-Erling Smørgravchanges the working directory to the user's home directory. 394d4af9e69SDag-Erling Smørgrav.Pp 395b15c8340SDag-Erling SmørgravThe pathname may contain the following tokens that are expanded at runtime once 396d4af9e69SDag-Erling Smørgravthe connecting user has been authenticated: %% is replaced by a literal '%', 397d4af9e69SDag-Erling Smørgrav%h is replaced by the home directory of the user being authenticated, and 398d4af9e69SDag-Erling Smørgrav%u is replaced by the username of that user. 399d4af9e69SDag-Erling Smørgrav.Pp 400d4af9e69SDag-Erling SmørgravThe 401d4af9e69SDag-Erling Smørgrav.Cm ChrootDirectory 402d4af9e69SDag-Erling Smørgravmust contain the necessary files and directories to support the 4037aee6ffeSDag-Erling Smørgravuser's session. 404d4af9e69SDag-Erling SmørgravFor an interactive session this requires at least a shell, typically 405d4af9e69SDag-Erling Smørgrav.Xr sh 1 , 406d4af9e69SDag-Erling Smørgravand basic 407d4af9e69SDag-Erling Smørgrav.Pa /dev 408d4af9e69SDag-Erling Smørgravnodes such as 409d4af9e69SDag-Erling Smørgrav.Xr null 4 , 410d4af9e69SDag-Erling Smørgrav.Xr zero 4 , 411d4af9e69SDag-Erling Smørgrav.Xr stdin 4 , 412d4af9e69SDag-Erling Smørgrav.Xr stdout 4 , 413d4af9e69SDag-Erling Smørgrav.Xr stderr 4 , 414d4af9e69SDag-Erling Smørgravand 415d4af9e69SDag-Erling Smørgrav.Xr tty 4 416d4af9e69SDag-Erling Smørgravdevices. 417d4af9e69SDag-Erling SmørgravFor file transfer sessions using 418d4af9e69SDag-Erling Smørgrav.Dq sftp , 419d4af9e69SDag-Erling Smørgravno additional configuration of the environment is necessary if the 4207aee6ffeSDag-Erling Smørgravin-process sftp server is used, 421a0ee8cc6SDag-Erling Smørgravthough sessions which use logging may require 4227aee6ffeSDag-Erling Smørgrav.Pa /dev/log 423a0ee8cc6SDag-Erling Smørgravinside the chroot directory on some operating systems (see 4247aee6ffeSDag-Erling Smørgrav.Xr sftp-server 8 425d4af9e69SDag-Erling Smørgravfor details). 426d4af9e69SDag-Erling Smørgrav.Pp 427bc5531deSDag-Erling SmørgravFor safety, it is very important that the directory hierarchy be 428bc5531deSDag-Erling Smørgravprevented from modification by other processes on the system (especially 429bc5531deSDag-Erling Smørgravthose outside the jail). 430bc5531deSDag-Erling SmørgravMisconfiguration can lead to unsafe environments which 431bc5531deSDag-Erling Smørgrav.Xr sshd 8 432bc5531deSDag-Erling Smørgravcannot detect. 433bc5531deSDag-Erling Smørgrav.Pp 434*acc1a9efSDag-Erling SmørgravThe default is 435*acc1a9efSDag-Erling Smørgrav.Dq none , 436*acc1a9efSDag-Erling Smørgravindicating not to 437d4af9e69SDag-Erling Smørgrav.Xr chroot 2 . 438545d5ecaSDag-Erling Smørgrav.It Cm Ciphers 439*acc1a9efSDag-Erling SmørgravSpecifies the ciphers allowed. 440545d5ecaSDag-Erling SmørgravMultiple ciphers must be comma-separated. 441eccfee6eSDag-Erling SmørgravIf the specified value begins with a 442eccfee6eSDag-Erling Smørgrav.Sq + 443eccfee6eSDag-Erling Smørgravcharacter, then the specified ciphers will be appended to the default set 444eccfee6eSDag-Erling Smørgravinstead of replacing them. 445eccfee6eSDag-Erling Smørgrav.Pp 446f7167e0eSDag-Erling SmørgravThe supported ciphers are: 447f7167e0eSDag-Erling Smørgrav.Pp 448a0ee8cc6SDag-Erling Smørgrav.Bl -item -compact -offset indent 449a0ee8cc6SDag-Erling Smørgrav.It 450a0ee8cc6SDag-Erling Smørgrav3des-cbc 451a0ee8cc6SDag-Erling Smørgrav.It 452a0ee8cc6SDag-Erling Smørgravaes128-cbc 453a0ee8cc6SDag-Erling Smørgrav.It 454a0ee8cc6SDag-Erling Smørgravaes192-cbc 455a0ee8cc6SDag-Erling Smørgrav.It 456a0ee8cc6SDag-Erling Smørgravaes256-cbc 457a0ee8cc6SDag-Erling Smørgrav.It 458a0ee8cc6SDag-Erling Smørgravaes128-ctr 459a0ee8cc6SDag-Erling Smørgrav.It 460a0ee8cc6SDag-Erling Smørgravaes192-ctr 461a0ee8cc6SDag-Erling Smørgrav.It 462a0ee8cc6SDag-Erling Smørgravaes256-ctr 463a0ee8cc6SDag-Erling Smørgrav.It 464a0ee8cc6SDag-Erling Smørgravaes128-gcm@openssh.com 465a0ee8cc6SDag-Erling Smørgrav.It 466a0ee8cc6SDag-Erling Smørgravaes256-gcm@openssh.com 467a0ee8cc6SDag-Erling Smørgrav.It 468a0ee8cc6SDag-Erling Smørgravarcfour 469a0ee8cc6SDag-Erling Smørgrav.It 470a0ee8cc6SDag-Erling Smørgravarcfour128 471a0ee8cc6SDag-Erling Smørgrav.It 472a0ee8cc6SDag-Erling Smørgravarcfour256 473a0ee8cc6SDag-Erling Smørgrav.It 474a0ee8cc6SDag-Erling Smørgravblowfish-cbc 475a0ee8cc6SDag-Erling Smørgrav.It 476a0ee8cc6SDag-Erling Smørgravcast128-cbc 477a0ee8cc6SDag-Erling Smørgrav.It 478a0ee8cc6SDag-Erling Smørgravchacha20-poly1305@openssh.com 479a0ee8cc6SDag-Erling Smørgrav.El 480f7167e0eSDag-Erling Smørgrav.Pp 481333ee039SDag-Erling SmørgravThe default is: 482a0ee8cc6SDag-Erling Smørgrav.Bd -literal -offset indent 483fc1ba28aSDag-Erling Smørgravchacha20-poly1305@openssh.com, 484a0ee8cc6SDag-Erling Smørgravaes128-ctr,aes192-ctr,aes256-ctr, 485fc1ba28aSDag-Erling Smørgravaes128-gcm@openssh.com,aes256-gcm@openssh.com 486545d5ecaSDag-Erling Smørgrav.Ed 487f7167e0eSDag-Erling Smørgrav.Pp 488f7167e0eSDag-Erling SmørgravThe list of available ciphers may also be obtained using the 489f7167e0eSDag-Erling Smørgrav.Fl Q 490f7167e0eSDag-Erling Smørgravoption of 491bc5531deSDag-Erling Smørgrav.Xr ssh 1 492bc5531deSDag-Erling Smørgravwith an argument of 493bc5531deSDag-Erling Smørgrav.Dq cipher . 494545d5ecaSDag-Erling Smørgrav.It Cm ClientAliveCountMax 495b74df5b2SDag-Erling SmørgravSets the number of client alive messages (see below) which may be 496545d5ecaSDag-Erling Smørgravsent without 497333ee039SDag-Erling Smørgrav.Xr sshd 8 498cf2b5f3bSDag-Erling Smørgravreceiving any messages back from the client. 499cf2b5f3bSDag-Erling SmørgravIf this threshold is reached while client alive messages are being sent, 500333ee039SDag-Erling Smørgravsshd will disconnect the client, terminating the session. 501cf2b5f3bSDag-Erling SmørgravIt is important to note that the use of client alive messages is very 502cf2b5f3bSDag-Erling Smørgravdifferent from 5031ec0d754SDag-Erling Smørgrav.Cm TCPKeepAlive 504cf2b5f3bSDag-Erling Smørgrav(below). 505cf2b5f3bSDag-Erling SmørgravThe client alive messages are sent through the encrypted channel 506cf2b5f3bSDag-Erling Smørgravand therefore will not be spoofable. 507cf2b5f3bSDag-Erling SmørgravThe TCP keepalive option enabled by 5081ec0d754SDag-Erling Smørgrav.Cm TCPKeepAlive 509cf2b5f3bSDag-Erling Smørgravis spoofable. 510cf2b5f3bSDag-Erling SmørgravThe client alive mechanism is valuable when the client or 511545d5ecaSDag-Erling Smørgravserver depend on knowing when a connection has become inactive. 512545d5ecaSDag-Erling Smørgrav.Pp 513cf2b5f3bSDag-Erling SmørgravThe default value is 3. 514cf2b5f3bSDag-Erling SmørgravIf 515545d5ecaSDag-Erling Smørgrav.Cm ClientAliveInterval 516b74df5b2SDag-Erling Smørgrav(see below) is set to 15, and 517545d5ecaSDag-Erling Smørgrav.Cm ClientAliveCountMax 518333ee039SDag-Erling Smørgravis left at the default, unresponsive SSH clients 519545d5ecaSDag-Erling Smørgravwill be disconnected after approximately 45 seconds. 520d4ecd108SDag-Erling Smørgrav.It Cm ClientAliveInterval 521d4ecd108SDag-Erling SmørgravSets a timeout interval in seconds after which if no data has been received 522d4ecd108SDag-Erling Smørgravfrom the client, 523333ee039SDag-Erling Smørgrav.Xr sshd 8 524d4ecd108SDag-Erling Smørgravwill send a message through the encrypted 525d4ecd108SDag-Erling Smørgravchannel to request a response from the client. 526d4ecd108SDag-Erling SmørgravThe default 527d4ecd108SDag-Erling Smørgravis 0, indicating that these messages will not be sent to the client. 528545d5ecaSDag-Erling Smørgrav.It Cm Compression 529d4ecd108SDag-Erling SmørgravSpecifies whether compression is allowed, or delayed until 530d4ecd108SDag-Erling Smørgravthe user has authenticated successfully. 531545d5ecaSDag-Erling SmørgravThe argument must be 532d4ecd108SDag-Erling Smørgrav.Dq yes , 533d4ecd108SDag-Erling Smørgrav.Dq delayed , 534545d5ecaSDag-Erling Smørgravor 535545d5ecaSDag-Erling Smørgrav.Dq no . 536545d5ecaSDag-Erling SmørgravThe default is 537d4ecd108SDag-Erling Smørgrav.Dq delayed . 538545d5ecaSDag-Erling Smørgrav.It Cm DenyGroups 539545d5ecaSDag-Erling SmørgravThis keyword can be followed by a list of group name patterns, separated 540545d5ecaSDag-Erling Smørgravby spaces. 541545d5ecaSDag-Erling SmørgravLogin is disallowed for users whose primary group or supplementary 542545d5ecaSDag-Erling Smørgravgroup list matches one of the patterns. 543545d5ecaSDag-Erling SmørgravOnly group names are valid; a numerical group ID is not recognized. 544545d5ecaSDag-Erling SmørgravBy default, login is allowed for all groups. 545333ee039SDag-Erling SmørgravThe allow/deny directives are processed in the following order: 546333ee039SDag-Erling Smørgrav.Cm DenyUsers , 547333ee039SDag-Erling Smørgrav.Cm AllowUsers , 548333ee039SDag-Erling Smørgrav.Cm DenyGroups , 549333ee039SDag-Erling Smørgravand finally 550333ee039SDag-Erling Smørgrav.Cm AllowGroups . 551333ee039SDag-Erling Smørgrav.Pp 552e4a9863fSDag-Erling SmørgravSee PATTERNS in 553333ee039SDag-Erling Smørgrav.Xr ssh_config 5 554333ee039SDag-Erling Smørgravfor more information on patterns. 555545d5ecaSDag-Erling Smørgrav.It Cm DenyUsers 556545d5ecaSDag-Erling SmørgravThis keyword can be followed by a list of user name patterns, separated 557545d5ecaSDag-Erling Smørgravby spaces. 558545d5ecaSDag-Erling SmørgravLogin is disallowed for user names that match one of the patterns. 559545d5ecaSDag-Erling SmørgravOnly user names are valid; a numerical user ID is not recognized. 560545d5ecaSDag-Erling SmørgravBy default, login is allowed for all users. 561545d5ecaSDag-Erling SmørgravIf the pattern takes the form USER@HOST then USER and HOST 562545d5ecaSDag-Erling Smørgravare separately checked, restricting logins to particular 563545d5ecaSDag-Erling Smørgravusers from particular hosts. 564333ee039SDag-Erling SmørgravThe allow/deny directives are processed in the following order: 565333ee039SDag-Erling Smørgrav.Cm DenyUsers , 566333ee039SDag-Erling Smørgrav.Cm AllowUsers , 567333ee039SDag-Erling Smørgrav.Cm DenyGroups , 568333ee039SDag-Erling Smørgravand finally 569333ee039SDag-Erling Smørgrav.Cm AllowGroups . 570333ee039SDag-Erling Smørgrav.Pp 571e4a9863fSDag-Erling SmørgravSee PATTERNS in 572333ee039SDag-Erling Smørgrav.Xr ssh_config 5 573333ee039SDag-Erling Smørgravfor more information on patterns. 574bc5531deSDag-Erling Smørgrav.It Cm FingerprintHash 575bc5531deSDag-Erling SmørgravSpecifies the hash algorithm used when logging key fingerprints. 576bc5531deSDag-Erling SmørgravValid options are: 577bc5531deSDag-Erling Smørgrav.Dq md5 578bc5531deSDag-Erling Smørgravand 579bc5531deSDag-Erling Smørgrav.Dq sha256 . 580bc5531deSDag-Erling SmørgravThe default is 581bc5531deSDag-Erling Smørgrav.Dq sha256 . 582333ee039SDag-Erling Smørgrav.It Cm ForceCommand 583333ee039SDag-Erling SmørgravForces the execution of the command specified by 584333ee039SDag-Erling Smørgrav.Cm ForceCommand , 585d4af9e69SDag-Erling Smørgravignoring any command supplied by the client and 586d4af9e69SDag-Erling Smørgrav.Pa ~/.ssh/rc 587d4af9e69SDag-Erling Smørgravif present. 588333ee039SDag-Erling SmørgravThe command is invoked by using the user's login shell with the -c option. 589333ee039SDag-Erling SmørgravThis applies to shell, command, or subsystem execution. 590333ee039SDag-Erling SmørgravIt is most useful inside a 591333ee039SDag-Erling Smørgrav.Cm Match 592333ee039SDag-Erling Smørgravblock. 593333ee039SDag-Erling SmørgravThe command originally supplied by the client is available in the 594333ee039SDag-Erling Smørgrav.Ev SSH_ORIGINAL_COMMAND 595333ee039SDag-Erling Smørgravenvironment variable. 596d4af9e69SDag-Erling SmørgravSpecifying a command of 597d4af9e69SDag-Erling Smørgrav.Dq internal-sftp 598d4af9e69SDag-Erling Smørgravwill force the use of an in-process sftp server that requires no support 599d4af9e69SDag-Erling Smørgravfiles when used with 600d4af9e69SDag-Erling Smørgrav.Cm ChrootDirectory . 601*acc1a9efSDag-Erling SmørgravThe default is 602*acc1a9efSDag-Erling Smørgrav.Dq none . 603545d5ecaSDag-Erling Smørgrav.It Cm GatewayPorts 604545d5ecaSDag-Erling SmørgravSpecifies whether remote hosts are allowed to connect to ports 605545d5ecaSDag-Erling Smørgravforwarded for the client. 606545d5ecaSDag-Erling SmørgravBy default, 607333ee039SDag-Erling Smørgrav.Xr sshd 8 608e73e9afaSDag-Erling Smørgravbinds remote port forwardings to the loopback address. 609e73e9afaSDag-Erling SmørgravThis prevents other remote hosts from connecting to forwarded ports. 610545d5ecaSDag-Erling Smørgrav.Cm GatewayPorts 611333ee039SDag-Erling Smørgravcan be used to specify that sshd 612aa49c926SDag-Erling Smørgravshould allow remote port forwardings to bind to non-loopback addresses, thus 613aa49c926SDag-Erling Smørgravallowing other hosts to connect. 614aa49c926SDag-Erling SmørgravThe argument may be 615aa49c926SDag-Erling Smørgrav.Dq no 616aa49c926SDag-Erling Smørgravto force remote port forwardings to be available to the local host only, 617545d5ecaSDag-Erling Smørgrav.Dq yes 618aa49c926SDag-Erling Smørgravto force remote port forwardings to bind to the wildcard address, or 619aa49c926SDag-Erling Smørgrav.Dq clientspecified 620aa49c926SDag-Erling Smørgravto allow the client to select the address to which the forwarding is bound. 621545d5ecaSDag-Erling SmørgravThe default is 622545d5ecaSDag-Erling Smørgrav.Dq no . 623cf2b5f3bSDag-Erling Smørgrav.It Cm GSSAPIAuthentication 624cf2b5f3bSDag-Erling SmørgravSpecifies whether user authentication based on GSSAPI is allowed. 625cf2b5f3bSDag-Erling SmørgravThe default is 626cf2b5f3bSDag-Erling Smørgrav.Dq no . 627cf2b5f3bSDag-Erling Smørgrav.It Cm GSSAPICleanupCredentials 628cf2b5f3bSDag-Erling SmørgravSpecifies whether to automatically destroy the user's credentials cache 629cf2b5f3bSDag-Erling Smørgravon logout. 630cf2b5f3bSDag-Erling SmørgravThe default is 631cf2b5f3bSDag-Erling Smørgrav.Dq yes . 632557f75e5SDag-Erling Smørgrav.It Cm GSSAPIStrictAcceptorCheck 633557f75e5SDag-Erling SmørgravDetermines whether to be strict about the identity of the GSSAPI acceptor 634557f75e5SDag-Erling Smørgrava client authenticates against. 635557f75e5SDag-Erling SmørgravIf set to 636557f75e5SDag-Erling Smørgrav.Dq yes 637557f75e5SDag-Erling Smørgravthen the client must authenticate against the 638557f75e5SDag-Erling Smørgrav.Pa host 639557f75e5SDag-Erling Smørgravservice on the current hostname. 640557f75e5SDag-Erling SmørgravIf set to 641557f75e5SDag-Erling Smørgrav.Dq no 642557f75e5SDag-Erling Smørgravthen the client may authenticate against any service key stored in the 643557f75e5SDag-Erling Smørgravmachine's default store. 644557f75e5SDag-Erling SmørgravThis facility is provided to assist with operation on multi homed machines. 645557f75e5SDag-Erling SmørgravThe default is 646557f75e5SDag-Erling Smørgrav.Dq yes . 647bc5531deSDag-Erling Smørgrav.It Cm HostbasedAcceptedKeyTypes 648bc5531deSDag-Erling SmørgravSpecifies the key types that will be accepted for hostbased authentication 649bc5531deSDag-Erling Smørgravas a comma-separated pattern list. 650eccfee6eSDag-Erling SmørgravAlternately if the specified value begins with a 651eccfee6eSDag-Erling Smørgrav.Sq + 652eccfee6eSDag-Erling Smørgravcharacter, then the specified key types will be appended to the default set 653eccfee6eSDag-Erling Smørgravinstead of replacing them. 654eccfee6eSDag-Erling SmørgravThe default for this option is: 655eccfee6eSDag-Erling Smørgrav.Bd -literal -offset 3n 656eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp256-cert-v01@openssh.com, 657eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp384-cert-v01@openssh.com, 658eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp521-cert-v01@openssh.com, 659eccfee6eSDag-Erling Smørgravssh-ed25519-cert-v01@openssh.com, 660eccfee6eSDag-Erling Smørgravssh-rsa-cert-v01@openssh.com, 661acf8e75eSDag-Erling Smørgravssh-dss-cert-v01@openssh.com, 662acf8e75eSDag-Erling Smørgravecdsa-sha2-nistp256,ecdsa-sha2-nistp384, 663acf8e75eSDag-Erling Smørgravecdsa-sha2-nistp521,ssh-ed25519, 664acf8e75eSDag-Erling Smørgravssh-rsa,ssh-dss 665eccfee6eSDag-Erling Smørgrav.Ed 666eccfee6eSDag-Erling Smørgrav.Pp 667bc5531deSDag-Erling SmørgravThe 668bc5531deSDag-Erling Smørgrav.Fl Q 669bc5531deSDag-Erling Smørgravoption of 670bc5531deSDag-Erling Smørgrav.Xr ssh 1 671bc5531deSDag-Erling Smørgravmay be used to list supported key types. 672545d5ecaSDag-Erling Smørgrav.It Cm HostbasedAuthentication 673545d5ecaSDag-Erling SmørgravSpecifies whether rhosts or /etc/hosts.equiv authentication together 674545d5ecaSDag-Erling Smørgravwith successful public key client host authentication is allowed 675333ee039SDag-Erling Smørgrav(host-based authentication). 676545d5ecaSDag-Erling SmørgravThe default is 677545d5ecaSDag-Erling Smørgrav.Dq no . 678333ee039SDag-Erling Smørgrav.It Cm HostbasedUsesNameFromPacketOnly 679333ee039SDag-Erling SmørgravSpecifies whether or not the server will attempt to perform a reverse 680333ee039SDag-Erling Smørgravname lookup when matching the name in the 681333ee039SDag-Erling Smørgrav.Pa ~/.shosts , 682333ee039SDag-Erling Smørgrav.Pa ~/.rhosts , 683333ee039SDag-Erling Smørgravand 684333ee039SDag-Erling Smørgrav.Pa /etc/hosts.equiv 685333ee039SDag-Erling Smørgravfiles during 686333ee039SDag-Erling Smørgrav.Cm HostbasedAuthentication . 687333ee039SDag-Erling SmørgravA setting of 688333ee039SDag-Erling Smørgrav.Dq yes 689333ee039SDag-Erling Smørgravmeans that 690333ee039SDag-Erling Smørgrav.Xr sshd 8 691333ee039SDag-Erling Smørgravuses the name supplied by the client rather than 692333ee039SDag-Erling Smørgravattempting to resolve the name from the TCP connection itself. 693333ee039SDag-Erling SmørgravThe default is 694333ee039SDag-Erling Smørgrav.Dq no . 695b15c8340SDag-Erling Smørgrav.It Cm HostCertificate 696b15c8340SDag-Erling SmørgravSpecifies a file containing a public host certificate. 697b15c8340SDag-Erling SmørgravThe certificate's public key must match a private host key already specified 698b15c8340SDag-Erling Smørgravby 699b15c8340SDag-Erling Smørgrav.Cm HostKey . 700b15c8340SDag-Erling SmørgravThe default behaviour of 701b15c8340SDag-Erling Smørgrav.Xr sshd 8 702b15c8340SDag-Erling Smørgravis not to load any certificates. 703545d5ecaSDag-Erling Smørgrav.It Cm HostKey 704545d5ecaSDag-Erling SmørgravSpecifies a file containing a private host key 705545d5ecaSDag-Erling Smørgravused by SSH. 706545d5ecaSDag-Erling SmørgravThe default is 707545d5ecaSDag-Erling Smørgrav.Pa /etc/ssh/ssh_host_key 708545d5ecaSDag-Erling Smørgravfor protocol version 1, and 7094a421b63SDag-Erling Smørgrav.Pa /etc/ssh/ssh_host_dsa_key , 710f7167e0eSDag-Erling Smørgrav.Pa /etc/ssh/ssh_host_ecdsa_key , 711f7167e0eSDag-Erling Smørgrav.Pa /etc/ssh/ssh_host_ed25519_key 712d4af9e69SDag-Erling Smørgravand 7134a421b63SDag-Erling Smørgrav.Pa /etc/ssh/ssh_host_rsa_key 714545d5ecaSDag-Erling Smørgravfor protocol version 2. 715eccfee6eSDag-Erling Smørgrav.Pp 716545d5ecaSDag-Erling SmørgravNote that 717333ee039SDag-Erling Smørgrav.Xr sshd 8 718eccfee6eSDag-Erling Smørgravwill refuse to use a file if it is group/world-accessible 719eccfee6eSDag-Erling Smørgravand that the 720eccfee6eSDag-Erling Smørgrav.Cm HostKeyAlgorithms 721eccfee6eSDag-Erling Smørgravoption restricts which of the keys are actually used by 722eccfee6eSDag-Erling Smørgrav.Xr sshd 8 . 723eccfee6eSDag-Erling Smørgrav.Pp 724545d5ecaSDag-Erling SmørgravIt is possible to have multiple host key files. 725545d5ecaSDag-Erling Smørgrav.Dq rsa1 726545d5ecaSDag-Erling Smørgravkeys are used for version 1 and 7274a421b63SDag-Erling Smørgrav.Dq dsa , 728f7167e0eSDag-Erling Smørgrav.Dq ecdsa , 729f7167e0eSDag-Erling Smørgrav.Dq ed25519 730545d5ecaSDag-Erling Smørgravor 731545d5ecaSDag-Erling Smørgrav.Dq rsa 732545d5ecaSDag-Erling Smørgravare used for version 2 of the SSH protocol. 733e4a9863fSDag-Erling SmørgravIt is also possible to specify public host key files instead. 734e4a9863fSDag-Erling SmørgravIn this case operations on the private key will be delegated 735e4a9863fSDag-Erling Smørgravto an 736e4a9863fSDag-Erling Smørgrav.Xr ssh-agent 1 . 737e4a9863fSDag-Erling Smørgrav.It Cm HostKeyAgent 738e4a9863fSDag-Erling SmørgravIdentifies the UNIX-domain socket used to communicate 739e4a9863fSDag-Erling Smørgravwith an agent that has access to the private host keys. 740e4a9863fSDag-Erling SmørgravIf 741e4a9863fSDag-Erling Smørgrav.Dq SSH_AUTH_SOCK 742e4a9863fSDag-Erling Smørgravis specified, the location of the socket will be read from the 743e4a9863fSDag-Erling Smørgrav.Ev SSH_AUTH_SOCK 744e4a9863fSDag-Erling Smørgravenvironment variable. 745eccfee6eSDag-Erling Smørgrav.It Cm HostKeyAlgorithms 746*acc1a9efSDag-Erling SmørgravSpecifies the host key algorithms 747eccfee6eSDag-Erling Smørgravthat the server offers. 748eccfee6eSDag-Erling SmørgravThe default for this option is: 749eccfee6eSDag-Erling Smørgrav.Bd -literal -offset 3n 750eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp256-cert-v01@openssh.com, 751eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp384-cert-v01@openssh.com, 752eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp521-cert-v01@openssh.com, 753eccfee6eSDag-Erling Smørgravssh-ed25519-cert-v01@openssh.com, 754eccfee6eSDag-Erling Smørgravssh-rsa-cert-v01@openssh.com, 755acf8e75eSDag-Erling Smørgravssh-dss-cert-v01@openssh.com, 756acf8e75eSDag-Erling Smørgravecdsa-sha2-nistp256,ecdsa-sha2-nistp384, 757acf8e75eSDag-Erling Smørgravecdsa-sha2-nistp521,ssh-ed25519, 758acf8e75eSDag-Erling Smørgravssh-rsa,ssh-dss 759eccfee6eSDag-Erling Smørgrav.Ed 760eccfee6eSDag-Erling Smørgrav.Pp 761eccfee6eSDag-Erling SmørgravThe list of available key types may also be obtained using the 762eccfee6eSDag-Erling Smørgrav.Fl Q 763eccfee6eSDag-Erling Smørgravoption of 764eccfee6eSDag-Erling Smørgrav.Xr ssh 1 765eccfee6eSDag-Erling Smørgravwith an argument of 766eccfee6eSDag-Erling Smørgrav.Dq key . 767545d5ecaSDag-Erling Smørgrav.It Cm IgnoreRhosts 768545d5ecaSDag-Erling SmørgravSpecifies that 769545d5ecaSDag-Erling Smørgrav.Pa .rhosts 770545d5ecaSDag-Erling Smørgravand 771545d5ecaSDag-Erling Smørgrav.Pa .shosts 772545d5ecaSDag-Erling Smørgravfiles will not be used in 773545d5ecaSDag-Erling Smørgrav.Cm RhostsRSAAuthentication 774545d5ecaSDag-Erling Smørgravor 775545d5ecaSDag-Erling Smørgrav.Cm HostbasedAuthentication . 776545d5ecaSDag-Erling Smørgrav.Pp 777545d5ecaSDag-Erling Smørgrav.Pa /etc/hosts.equiv 778545d5ecaSDag-Erling Smørgravand 77935d4ccfbSDag-Erling Smørgrav.Pa /etc/ssh/shosts.equiv 780545d5ecaSDag-Erling Smørgravare still used. 781545d5ecaSDag-Erling SmørgravThe default is 782545d5ecaSDag-Erling Smørgrav.Dq yes . 783545d5ecaSDag-Erling Smørgrav.It Cm IgnoreUserKnownHosts 784545d5ecaSDag-Erling SmørgravSpecifies whether 785333ee039SDag-Erling Smørgrav.Xr sshd 8 786545d5ecaSDag-Erling Smørgravshould ignore the user's 787d4ecd108SDag-Erling Smørgrav.Pa ~/.ssh/known_hosts 788545d5ecaSDag-Erling Smørgravduring 789545d5ecaSDag-Erling Smørgrav.Cm RhostsRSAAuthentication 790545d5ecaSDag-Erling Smørgravor 791545d5ecaSDag-Erling Smørgrav.Cm HostbasedAuthentication . 792545d5ecaSDag-Erling SmørgravThe default is 793545d5ecaSDag-Erling Smørgrav.Dq no . 7944a421b63SDag-Erling Smørgrav.It Cm IPQoS 7954a421b63SDag-Erling SmørgravSpecifies the IPv4 type-of-service or DSCP class for the connection. 7964a421b63SDag-Erling SmørgravAccepted values are 7974a421b63SDag-Erling Smørgrav.Dq af11 , 7984a421b63SDag-Erling Smørgrav.Dq af12 , 7994a421b63SDag-Erling Smørgrav.Dq af13 , 800462c32cbSDag-Erling Smørgrav.Dq af21 , 8014a421b63SDag-Erling Smørgrav.Dq af22 , 8024a421b63SDag-Erling Smørgrav.Dq af23 , 8034a421b63SDag-Erling Smørgrav.Dq af31 , 8044a421b63SDag-Erling Smørgrav.Dq af32 , 8054a421b63SDag-Erling Smørgrav.Dq af33 , 8064a421b63SDag-Erling Smørgrav.Dq af41 , 8074a421b63SDag-Erling Smørgrav.Dq af42 , 8084a421b63SDag-Erling Smørgrav.Dq af43 , 8094a421b63SDag-Erling Smørgrav.Dq cs0 , 8104a421b63SDag-Erling Smørgrav.Dq cs1 , 8114a421b63SDag-Erling Smørgrav.Dq cs2 , 8124a421b63SDag-Erling Smørgrav.Dq cs3 , 8134a421b63SDag-Erling Smørgrav.Dq cs4 , 8144a421b63SDag-Erling Smørgrav.Dq cs5 , 8154a421b63SDag-Erling Smørgrav.Dq cs6 , 8164a421b63SDag-Erling Smørgrav.Dq cs7 , 8174a421b63SDag-Erling Smørgrav.Dq ef , 8184a421b63SDag-Erling Smørgrav.Dq lowdelay , 8194a421b63SDag-Erling Smørgrav.Dq throughput , 8204a421b63SDag-Erling Smørgrav.Dq reliability , 8214a421b63SDag-Erling Smørgravor a numeric value. 8224a421b63SDag-Erling SmørgravThis option may take one or two arguments, separated by whitespace. 8234a421b63SDag-Erling SmørgravIf one argument is specified, it is used as the packet class unconditionally. 8244a421b63SDag-Erling SmørgravIf two values are specified, the first is automatically selected for 8254a421b63SDag-Erling Smørgravinteractive sessions and the second for non-interactive sessions. 8264a421b63SDag-Erling SmørgravThe default is 8274a421b63SDag-Erling Smørgrav.Dq lowdelay 8284a421b63SDag-Erling Smørgravfor interactive sessions and 8294a421b63SDag-Erling Smørgrav.Dq throughput 8304a421b63SDag-Erling Smørgravfor non-interactive sessions. 831b83788ffSDag-Erling Smørgrav.It Cm KbdInteractiveAuthentication 832b83788ffSDag-Erling SmørgravSpecifies whether to allow keyboard-interactive authentication. 833b83788ffSDag-Erling SmørgravThe argument to this keyword must be 834b83788ffSDag-Erling Smørgrav.Dq yes 835b83788ffSDag-Erling Smørgravor 836b83788ffSDag-Erling Smørgrav.Dq no . 837b83788ffSDag-Erling SmørgravThe default is to use whatever value 838b83788ffSDag-Erling Smørgrav.Cm ChallengeResponseAuthentication 839b83788ffSDag-Erling Smørgravis set to 840b83788ffSDag-Erling Smørgrav(by default 841b83788ffSDag-Erling Smørgrav.Dq yes ) . 842545d5ecaSDag-Erling Smørgrav.It Cm KerberosAuthentication 843cf2b5f3bSDag-Erling SmørgravSpecifies whether the password provided by the user for 844545d5ecaSDag-Erling Smørgrav.Cm PasswordAuthentication 845cf2b5f3bSDag-Erling Smørgravwill be validated through the Kerberos KDC. 846545d5ecaSDag-Erling SmørgravTo use this option, the server needs a 847545d5ecaSDag-Erling SmørgravKerberos servtab which allows the verification of the KDC's identity. 848333ee039SDag-Erling SmørgravThe default is 849545d5ecaSDag-Erling Smørgrav.Dq no . 8505962c0e9SDag-Erling Smørgrav.It Cm KerberosGetAFSToken 851b74df5b2SDag-Erling SmørgravIf AFS is active and the user has a Kerberos 5 TGT, attempt to acquire 8525962c0e9SDag-Erling Smørgravan AFS token before accessing the user's home directory. 853333ee039SDag-Erling SmørgravThe default is 8545962c0e9SDag-Erling Smørgrav.Dq no . 855545d5ecaSDag-Erling Smørgrav.It Cm KerberosOrLocalPasswd 856333ee039SDag-Erling SmørgravIf password authentication through Kerberos fails then 857545d5ecaSDag-Erling Smørgravthe password will be validated via any additional local mechanism 858545d5ecaSDag-Erling Smørgravsuch as 859545d5ecaSDag-Erling Smørgrav.Pa /etc/passwd . 860333ee039SDag-Erling SmørgravThe default is 861545d5ecaSDag-Erling Smørgrav.Dq yes . 862545d5ecaSDag-Erling Smørgrav.It Cm KerberosTicketCleanup 863545d5ecaSDag-Erling SmørgravSpecifies whether to automatically destroy the user's ticket cache 864545d5ecaSDag-Erling Smørgravfile on logout. 865333ee039SDag-Erling SmørgravThe default is 866545d5ecaSDag-Erling Smørgrav.Dq yes . 8674a421b63SDag-Erling Smørgrav.It Cm KexAlgorithms 8684a421b63SDag-Erling SmørgravSpecifies the available KEX (Key Exchange) algorithms. 8694a421b63SDag-Erling SmørgravMultiple algorithms must be comma-separated. 870eccfee6eSDag-Erling SmørgravAlternately if the specified value begins with a 871eccfee6eSDag-Erling Smørgrav.Sq + 872eccfee6eSDag-Erling Smørgravcharacter, then the specified methods will be appended to the default set 873eccfee6eSDag-Erling Smørgravinstead of replacing them. 874a0ee8cc6SDag-Erling SmørgravThe supported algorithms are: 875a0ee8cc6SDag-Erling Smørgrav.Pp 876a0ee8cc6SDag-Erling Smørgrav.Bl -item -compact -offset indent 877a0ee8cc6SDag-Erling Smørgrav.It 878a0ee8cc6SDag-Erling Smørgravcurve25519-sha256@libssh.org 879a0ee8cc6SDag-Erling Smørgrav.It 880a0ee8cc6SDag-Erling Smørgravdiffie-hellman-group1-sha1 881a0ee8cc6SDag-Erling Smørgrav.It 882a0ee8cc6SDag-Erling Smørgravdiffie-hellman-group14-sha1 883a0ee8cc6SDag-Erling Smørgrav.It 884a0ee8cc6SDag-Erling Smørgravdiffie-hellman-group-exchange-sha1 885a0ee8cc6SDag-Erling Smørgrav.It 886a0ee8cc6SDag-Erling Smørgravdiffie-hellman-group-exchange-sha256 887a0ee8cc6SDag-Erling Smørgrav.It 888a0ee8cc6SDag-Erling Smørgravecdh-sha2-nistp256 889a0ee8cc6SDag-Erling Smørgrav.It 890a0ee8cc6SDag-Erling Smørgravecdh-sha2-nistp384 891a0ee8cc6SDag-Erling Smørgrav.It 892a0ee8cc6SDag-Erling Smørgravecdh-sha2-nistp521 893a0ee8cc6SDag-Erling Smørgrav.El 894a0ee8cc6SDag-Erling Smørgrav.Pp 895a0ee8cc6SDag-Erling SmørgravThe default is: 896f7167e0eSDag-Erling Smørgrav.Bd -literal -offset indent 897f7167e0eSDag-Erling Smørgravcurve25519-sha256@libssh.org, 898f7167e0eSDag-Erling Smørgravecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521, 899f7167e0eSDag-Erling Smørgravdiffie-hellman-group-exchange-sha256, 900a0ee8cc6SDag-Erling Smørgravdiffie-hellman-group14-sha1 901f7167e0eSDag-Erling Smørgrav.Ed 902bc5531deSDag-Erling Smørgrav.Pp 903bc5531deSDag-Erling SmørgravThe list of available key exchange algorithms may also be obtained using the 904bc5531deSDag-Erling Smørgrav.Fl Q 905bc5531deSDag-Erling Smørgravoption of 906bc5531deSDag-Erling Smørgrav.Xr ssh 1 907bc5531deSDag-Erling Smørgravwith an argument of 908bc5531deSDag-Erling Smørgrav.Dq kex . 909545d5ecaSDag-Erling Smørgrav.It Cm KeyRegenerationInterval 910545d5ecaSDag-Erling SmørgravIn protocol version 1, the ephemeral server key is automatically regenerated 911545d5ecaSDag-Erling Smørgravafter this many seconds (if it has been used). 912545d5ecaSDag-Erling SmørgravThe purpose of regeneration is to prevent 913545d5ecaSDag-Erling Smørgravdecrypting captured sessions by later breaking into the machine and 914545d5ecaSDag-Erling Smørgravstealing the keys. 915545d5ecaSDag-Erling SmørgravThe key is never stored anywhere. 916545d5ecaSDag-Erling SmørgravIf the value is 0, the key is never regenerated. 917545d5ecaSDag-Erling SmørgravThe default is 3600 (seconds). 918545d5ecaSDag-Erling Smørgrav.It Cm ListenAddress 919545d5ecaSDag-Erling SmørgravSpecifies the local addresses 920333ee039SDag-Erling Smørgrav.Xr sshd 8 921545d5ecaSDag-Erling Smørgravshould listen on. 922545d5ecaSDag-Erling SmørgravThe following forms may be used: 923545d5ecaSDag-Erling Smørgrav.Pp 924545d5ecaSDag-Erling Smørgrav.Bl -item -offset indent -compact 925545d5ecaSDag-Erling Smørgrav.It 926545d5ecaSDag-Erling Smørgrav.Cm ListenAddress 927545d5ecaSDag-Erling Smørgrav.Sm off 928bc5531deSDag-Erling Smørgrav.Ar host | Ar IPv4_addr | Ar IPv6_addr 929545d5ecaSDag-Erling Smørgrav.Sm on 930545d5ecaSDag-Erling Smørgrav.It 931545d5ecaSDag-Erling Smørgrav.Cm ListenAddress 932545d5ecaSDag-Erling Smørgrav.Sm off 933bc5531deSDag-Erling Smørgrav.Ar host | Ar IPv4_addr : Ar port 934545d5ecaSDag-Erling Smørgrav.Sm on 935545d5ecaSDag-Erling Smørgrav.It 936545d5ecaSDag-Erling Smørgrav.Cm ListenAddress 937545d5ecaSDag-Erling Smørgrav.Sm off 938545d5ecaSDag-Erling Smørgrav.Oo 939bc5531deSDag-Erling Smørgrav.Ar host | Ar IPv6_addr Oc : Ar port 940545d5ecaSDag-Erling Smørgrav.Sm on 941545d5ecaSDag-Erling Smørgrav.El 942545d5ecaSDag-Erling Smørgrav.Pp 943545d5ecaSDag-Erling SmørgravIf 944545d5ecaSDag-Erling Smørgrav.Ar port 945545d5ecaSDag-Erling Smørgravis not specified, 946557f75e5SDag-Erling Smørgravsshd will listen on the address and all 947545d5ecaSDag-Erling Smørgrav.Cm Port 948cf2b5f3bSDag-Erling Smørgravoptions specified. 949cf2b5f3bSDag-Erling SmørgravThe default is to listen on all local addresses. 950e73e9afaSDag-Erling SmørgravMultiple 951545d5ecaSDag-Erling Smørgrav.Cm ListenAddress 952cf2b5f3bSDag-Erling Smørgravoptions are permitted. 953545d5ecaSDag-Erling Smørgrav.It Cm LoginGraceTime 954545d5ecaSDag-Erling SmørgravThe server disconnects after this time if the user has not 955545d5ecaSDag-Erling Smørgravsuccessfully logged in. 956545d5ecaSDag-Erling SmørgravIf the value is 0, there is no time limit. 957f388f5efSDag-Erling SmørgravThe default is 120 seconds. 958545d5ecaSDag-Erling Smørgrav.It Cm LogLevel 959545d5ecaSDag-Erling SmørgravGives the verbosity level that is used when logging messages from 960333ee039SDag-Erling Smørgrav.Xr sshd 8 . 961545d5ecaSDag-Erling SmørgravThe possible values are: 962333ee039SDag-Erling SmørgravQUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. 963e73e9afaSDag-Erling SmørgravThe default is INFO. 964e73e9afaSDag-Erling SmørgravDEBUG and DEBUG1 are equivalent. 965e73e9afaSDag-Erling SmørgravDEBUG2 and DEBUG3 each specify higher levels of debugging output. 966e73e9afaSDag-Erling SmørgravLogging with a DEBUG level violates the privacy of users and is not recommended. 967545d5ecaSDag-Erling Smørgrav.It Cm MACs 968545d5ecaSDag-Erling SmørgravSpecifies the available MAC (message authentication code) algorithms. 969*acc1a9efSDag-Erling SmørgravThe MAC algorithm is used for data integrity protection. 970545d5ecaSDag-Erling SmørgravMultiple algorithms must be comma-separated. 971eccfee6eSDag-Erling SmørgravIf the specified value begins with a 972eccfee6eSDag-Erling Smørgrav.Sq + 973eccfee6eSDag-Erling Smørgravcharacter, then the specified algorithms will be appended to the default set 974eccfee6eSDag-Erling Smørgravinstead of replacing them. 975eccfee6eSDag-Erling Smørgrav.Pp 9766888a9beSDag-Erling SmørgravThe algorithms that contain 9776888a9beSDag-Erling Smørgrav.Dq -etm 9786888a9beSDag-Erling Smørgravcalculate the MAC after encryption (encrypt-then-mac). 9796888a9beSDag-Erling SmørgravThese are considered safer and their use recommended. 980a0ee8cc6SDag-Erling SmørgravThe supported MACs are: 981a0ee8cc6SDag-Erling Smørgrav.Pp 982a0ee8cc6SDag-Erling Smørgrav.Bl -item -compact -offset indent 983a0ee8cc6SDag-Erling Smørgrav.It 984a0ee8cc6SDag-Erling Smørgravhmac-md5 985a0ee8cc6SDag-Erling Smørgrav.It 986a0ee8cc6SDag-Erling Smørgravhmac-md5-96 987a0ee8cc6SDag-Erling Smørgrav.It 988a0ee8cc6SDag-Erling Smørgravhmac-ripemd160 989a0ee8cc6SDag-Erling Smørgrav.It 990a0ee8cc6SDag-Erling Smørgravhmac-sha1 991a0ee8cc6SDag-Erling Smørgrav.It 992a0ee8cc6SDag-Erling Smørgravhmac-sha1-96 993a0ee8cc6SDag-Erling Smørgrav.It 994a0ee8cc6SDag-Erling Smørgravhmac-sha2-256 995a0ee8cc6SDag-Erling Smørgrav.It 996a0ee8cc6SDag-Erling Smørgravhmac-sha2-512 997a0ee8cc6SDag-Erling Smørgrav.It 998a0ee8cc6SDag-Erling Smørgravumac-64@openssh.com 999a0ee8cc6SDag-Erling Smørgrav.It 1000a0ee8cc6SDag-Erling Smørgravumac-128@openssh.com 1001a0ee8cc6SDag-Erling Smørgrav.It 1002a0ee8cc6SDag-Erling Smørgravhmac-md5-etm@openssh.com 1003a0ee8cc6SDag-Erling Smørgrav.It 1004a0ee8cc6SDag-Erling Smørgravhmac-md5-96-etm@openssh.com 1005a0ee8cc6SDag-Erling Smørgrav.It 1006a0ee8cc6SDag-Erling Smørgravhmac-ripemd160-etm@openssh.com 1007a0ee8cc6SDag-Erling Smørgrav.It 1008a0ee8cc6SDag-Erling Smørgravhmac-sha1-etm@openssh.com 1009a0ee8cc6SDag-Erling Smørgrav.It 1010a0ee8cc6SDag-Erling Smørgravhmac-sha1-96-etm@openssh.com 1011a0ee8cc6SDag-Erling Smørgrav.It 1012a0ee8cc6SDag-Erling Smørgravhmac-sha2-256-etm@openssh.com 1013a0ee8cc6SDag-Erling Smørgrav.It 1014a0ee8cc6SDag-Erling Smørgravhmac-sha2-512-etm@openssh.com 1015a0ee8cc6SDag-Erling Smørgrav.It 1016a0ee8cc6SDag-Erling Smørgravumac-64-etm@openssh.com 1017a0ee8cc6SDag-Erling Smørgrav.It 1018a0ee8cc6SDag-Erling Smørgravumac-128-etm@openssh.com 1019a0ee8cc6SDag-Erling Smørgrav.El 1020a0ee8cc6SDag-Erling Smørgrav.Pp 1021333ee039SDag-Erling SmørgravThe default is: 1022d4af9e69SDag-Erling Smørgrav.Bd -literal -offset indent 10236888a9beSDag-Erling Smørgravumac-64-etm@openssh.com,umac-128-etm@openssh.com, 10246888a9beSDag-Erling Smørgravhmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com, 1025*acc1a9efSDag-Erling Smørgravhmac-sha1-etm@openssh.com, 1026a0ee8cc6SDag-Erling Smørgravumac-64@openssh.com,umac-128@openssh.com, 1027*acc1a9efSDag-Erling Smørgravhmac-sha2-256,hmac-sha2-512,hmac-sha1 1028d4af9e69SDag-Erling Smørgrav.Ed 1029bc5531deSDag-Erling Smørgrav.Pp 1030bc5531deSDag-Erling SmørgravThe list of available MAC algorithms may also be obtained using the 1031bc5531deSDag-Erling Smørgrav.Fl Q 1032bc5531deSDag-Erling Smørgravoption of 1033bc5531deSDag-Erling Smørgrav.Xr ssh 1 1034bc5531deSDag-Erling Smørgravwith an argument of 1035bc5531deSDag-Erling Smørgrav.Dq mac . 1036333ee039SDag-Erling Smørgrav.It Cm Match 1037333ee039SDag-Erling SmørgravIntroduces a conditional block. 1038333ee039SDag-Erling SmørgravIf all of the criteria on the 1039333ee039SDag-Erling Smørgrav.Cm Match 1040333ee039SDag-Erling Smørgravline are satisfied, the keywords on the following lines override those 1041333ee039SDag-Erling Smørgravset in the global section of the config file, until either another 1042333ee039SDag-Erling Smørgrav.Cm Match 1043333ee039SDag-Erling Smørgravline or the end of the file. 1044b83788ffSDag-Erling SmørgravIf a keyword appears in multiple 1045b83788ffSDag-Erling Smørgrav.Cm Match 1046bc5531deSDag-Erling Smørgravblocks that are satisfied, only the first instance of the keyword is 1047b83788ffSDag-Erling Smørgravapplied. 1048d4af9e69SDag-Erling Smørgrav.Pp 1049333ee039SDag-Erling SmørgravThe arguments to 1050333ee039SDag-Erling Smørgrav.Cm Match 1051f7167e0eSDag-Erling Smørgravare one or more criteria-pattern pairs or the single token 1052f7167e0eSDag-Erling Smørgrav.Cm All 1053f7167e0eSDag-Erling Smørgravwhich matches all criteria. 1054333ee039SDag-Erling SmørgravThe available criteria are 1055333ee039SDag-Erling Smørgrav.Cm User , 1056333ee039SDag-Erling Smørgrav.Cm Group , 1057333ee039SDag-Erling Smørgrav.Cm Host , 1058462c32cbSDag-Erling Smørgrav.Cm LocalAddress , 1059462c32cbSDag-Erling Smørgrav.Cm LocalPort , 1060333ee039SDag-Erling Smørgravand 1061333ee039SDag-Erling Smørgrav.Cm Address . 1062d4af9e69SDag-Erling SmørgravThe match patterns may consist of single entries or comma-separated 1063d4af9e69SDag-Erling Smørgravlists and may use the wildcard and negation operators described in the 1064e4a9863fSDag-Erling SmørgravPATTERNS section of 1065d4af9e69SDag-Erling Smørgrav.Xr ssh_config 5 . 1066d4af9e69SDag-Erling Smørgrav.Pp 1067d4af9e69SDag-Erling SmørgravThe patterns in an 1068d4af9e69SDag-Erling Smørgrav.Cm Address 1069d4af9e69SDag-Erling Smørgravcriteria may additionally contain addresses to match in CIDR 1070d4af9e69SDag-Erling Smørgravaddress/masklen format, e.g.\& 1071d4af9e69SDag-Erling Smørgrav.Dq 192.0.2.0/24 1072d4af9e69SDag-Erling Smørgravor 1073d4af9e69SDag-Erling Smørgrav.Dq 3ffe:ffff::/32 . 1074d4af9e69SDag-Erling SmørgravNote that the mask length provided must be consistent with the address - 1075d4af9e69SDag-Erling Smørgravit is an error to specify a mask length that is too long for the address 1076d4af9e69SDag-Erling Smørgravor one with bits set in this host portion of the address. 1077d4af9e69SDag-Erling SmørgravFor example, 1078d4af9e69SDag-Erling Smørgrav.Dq 192.0.2.0/33 1079d4af9e69SDag-Erling Smørgravand 1080d4af9e69SDag-Erling Smørgrav.Dq 192.0.2.0/8 1081d4af9e69SDag-Erling Smørgravrespectively. 1082d4af9e69SDag-Erling Smørgrav.Pp 1083333ee039SDag-Erling SmørgravOnly a subset of keywords may be used on the lines following a 1084333ee039SDag-Erling Smørgrav.Cm Match 1085333ee039SDag-Erling Smørgravkeyword. 1086333ee039SDag-Erling SmørgravAvailable keywords are 1087462c32cbSDag-Erling Smørgrav.Cm AcceptEnv , 1088cce7d346SDag-Erling Smørgrav.Cm AllowAgentForwarding , 1089462c32cbSDag-Erling Smørgrav.Cm AllowGroups , 1090bc5531deSDag-Erling Smørgrav.Cm AllowStreamLocalForwarding , 1091333ee039SDag-Erling Smørgrav.Cm AllowTcpForwarding , 1092462c32cbSDag-Erling Smørgrav.Cm AllowUsers , 10936888a9beSDag-Erling Smørgrav.Cm AuthenticationMethods , 10946888a9beSDag-Erling Smørgrav.Cm AuthorizedKeysCommand , 10956888a9beSDag-Erling Smørgrav.Cm AuthorizedKeysCommandUser , 1096e2f6069cSDag-Erling Smørgrav.Cm AuthorizedKeysFile , 1097*acc1a9efSDag-Erling Smørgrav.Cm AuthorizedPrincipalsCommand , 1098*acc1a9efSDag-Erling Smørgrav.Cm AuthorizedPrincipalsCommandUser , 1099e2f6069cSDag-Erling Smørgrav.Cm AuthorizedPrincipalsFile , 1100d4af9e69SDag-Erling Smørgrav.Cm Banner , 1101d4af9e69SDag-Erling Smørgrav.Cm ChrootDirectory , 1102462c32cbSDag-Erling Smørgrav.Cm DenyGroups , 1103462c32cbSDag-Erling Smørgrav.Cm DenyUsers , 1104333ee039SDag-Erling Smørgrav.Cm ForceCommand , 1105333ee039SDag-Erling Smørgrav.Cm GatewayPorts , 1106d4af9e69SDag-Erling Smørgrav.Cm GSSAPIAuthentication , 1107bc5531deSDag-Erling Smørgrav.Cm HostbasedAcceptedKeyTypes , 1108d4af9e69SDag-Erling Smørgrav.Cm HostbasedAuthentication , 1109e2f6069cSDag-Erling Smørgrav.Cm HostbasedUsesNameFromPacketOnly , 1110bc5531deSDag-Erling Smørgrav.Cm IPQoS , 1111d4af9e69SDag-Erling Smørgrav.Cm KbdInteractiveAuthentication , 1112d4af9e69SDag-Erling Smørgrav.Cm KerberosAuthentication , 1113d4af9e69SDag-Erling Smørgrav.Cm MaxAuthTries , 1114d4af9e69SDag-Erling Smørgrav.Cm MaxSessions , 1115d4af9e69SDag-Erling Smørgrav.Cm PasswordAuthentication , 1116cce7d346SDag-Erling Smørgrav.Cm PermitEmptyPasswords , 1117333ee039SDag-Erling Smørgrav.Cm PermitOpen , 1118d4af9e69SDag-Erling Smørgrav.Cm PermitRootLogin , 1119f7167e0eSDag-Erling Smørgrav.Cm PermitTTY , 1120e2f6069cSDag-Erling Smørgrav.Cm PermitTunnel , 1121a0ee8cc6SDag-Erling Smørgrav.Cm PermitUserRC , 1122bc5531deSDag-Erling Smørgrav.Cm PubkeyAcceptedKeyTypes , 1123b15c8340SDag-Erling Smørgrav.Cm PubkeyAuthentication , 1124e4a9863fSDag-Erling Smørgrav.Cm RekeyLimit , 1125bc5531deSDag-Erling Smørgrav.Cm RevokedKeys , 1126d4af9e69SDag-Erling Smørgrav.Cm RhostsRSAAuthentication , 1127d4af9e69SDag-Erling Smørgrav.Cm RSAAuthentication , 1128bc5531deSDag-Erling Smørgrav.Cm StreamLocalBindMask , 1129bc5531deSDag-Erling Smørgrav.Cm StreamLocalBindUnlink , 1130bc5531deSDag-Erling Smørgrav.Cm TrustedUserCAKeys , 1131333ee039SDag-Erling Smørgrav.Cm X11DisplayOffset , 1132cce7d346SDag-Erling Smørgrav.Cm X11Forwarding 1133333ee039SDag-Erling Smørgravand 1134333ee039SDag-Erling Smørgrav.Cm X11UseLocalHost . 113521e764dfSDag-Erling Smørgrav.It Cm MaxAuthTries 113621e764dfSDag-Erling SmørgravSpecifies the maximum number of authentication attempts permitted per 113721e764dfSDag-Erling Smørgravconnection. 113821e764dfSDag-Erling SmørgravOnce the number of failures reaches half this value, 113921e764dfSDag-Erling Smørgravadditional failures are logged. 114021e764dfSDag-Erling SmørgravThe default is 6. 1141d4af9e69SDag-Erling Smørgrav.It Cm MaxSessions 1142*acc1a9efSDag-Erling SmørgravSpecifies the maximum number of open shell, login or subsystem (e.g. sftp) 1143*acc1a9efSDag-Erling Smørgravsessions permitted per network connection. 1144*acc1a9efSDag-Erling SmørgravMultiple sessions may be established by clients that support connection 1145*acc1a9efSDag-Erling Smørgravmultiplexing. 1146*acc1a9efSDag-Erling SmørgravSetting 1147*acc1a9efSDag-Erling Smørgrav.Cm MaxSessions 1148*acc1a9efSDag-Erling Smørgravto 1 will effectively disable session multiplexing, whereas setting it to 0 1149*acc1a9efSDag-Erling Smørgravwill prevent all shell, login and subsystem sessions while still permitting 1150*acc1a9efSDag-Erling Smørgravforwarding. 1151d4af9e69SDag-Erling SmørgravThe default is 10. 1152545d5ecaSDag-Erling Smørgrav.It Cm MaxStartups 1153545d5ecaSDag-Erling SmørgravSpecifies the maximum number of concurrent unauthenticated connections to the 1154333ee039SDag-Erling SmørgravSSH daemon. 1155545d5ecaSDag-Erling SmørgravAdditional connections will be dropped until authentication succeeds or the 1156545d5ecaSDag-Erling Smørgrav.Cm LoginGraceTime 1157545d5ecaSDag-Erling Smørgravexpires for a connection. 11586888a9beSDag-Erling SmørgravThe default is 10:30:100. 1159545d5ecaSDag-Erling Smørgrav.Pp 1160545d5ecaSDag-Erling SmørgravAlternatively, random early drop can be enabled by specifying 1161545d5ecaSDag-Erling Smørgravthe three colon separated values 1162545d5ecaSDag-Erling Smørgrav.Dq start:rate:full 1163333ee039SDag-Erling Smørgrav(e.g. "10:30:60"). 1164333ee039SDag-Erling Smørgrav.Xr sshd 8 1165545d5ecaSDag-Erling Smørgravwill refuse connection attempts with a probability of 1166545d5ecaSDag-Erling Smørgrav.Dq rate/100 1167545d5ecaSDag-Erling Smørgrav(30%) 1168545d5ecaSDag-Erling Smørgravif there are currently 1169545d5ecaSDag-Erling Smørgrav.Dq start 1170545d5ecaSDag-Erling Smørgrav(10) 1171545d5ecaSDag-Erling Smørgravunauthenticated connections. 1172545d5ecaSDag-Erling SmørgravThe probability increases linearly and all connection attempts 1173545d5ecaSDag-Erling Smørgravare refused if the number of unauthenticated connections reaches 1174545d5ecaSDag-Erling Smørgrav.Dq full 1175545d5ecaSDag-Erling Smørgrav(60). 1176545d5ecaSDag-Erling Smørgrav.It Cm PasswordAuthentication 1177545d5ecaSDag-Erling SmørgravSpecifies whether password authentication is allowed. 1178d4af9e69SDag-Erling SmørgravSee also 1179d4af9e69SDag-Erling Smørgrav.Cm UsePAM . 1180545d5ecaSDag-Erling SmørgravThe default is 1181d4af9e69SDag-Erling Smørgrav.Dq no . 1182545d5ecaSDag-Erling Smørgrav.It Cm PermitEmptyPasswords 1183545d5ecaSDag-Erling SmørgravWhen password authentication is allowed, it specifies whether the 1184545d5ecaSDag-Erling Smørgravserver allows login to accounts with empty password strings. 1185545d5ecaSDag-Erling SmørgravThe default is 1186545d5ecaSDag-Erling Smørgrav.Dq no . 1187333ee039SDag-Erling Smørgrav.It Cm PermitOpen 1188333ee039SDag-Erling SmørgravSpecifies the destinations to which TCP port forwarding is permitted. 1189333ee039SDag-Erling SmørgravThe forwarding specification must be one of the following forms: 1190333ee039SDag-Erling Smørgrav.Pp 1191333ee039SDag-Erling Smørgrav.Bl -item -offset indent -compact 1192333ee039SDag-Erling Smørgrav.It 1193333ee039SDag-Erling Smørgrav.Cm PermitOpen 1194333ee039SDag-Erling Smørgrav.Sm off 1195333ee039SDag-Erling Smørgrav.Ar host : port 1196333ee039SDag-Erling Smørgrav.Sm on 1197333ee039SDag-Erling Smørgrav.It 1198333ee039SDag-Erling Smørgrav.Cm PermitOpen 1199333ee039SDag-Erling Smørgrav.Sm off 1200333ee039SDag-Erling Smørgrav.Ar IPv4_addr : port 1201333ee039SDag-Erling Smørgrav.Sm on 1202333ee039SDag-Erling Smørgrav.It 1203333ee039SDag-Erling Smørgrav.Cm PermitOpen 1204333ee039SDag-Erling Smørgrav.Sm off 1205333ee039SDag-Erling Smørgrav.Ar \&[ IPv6_addr \&] : port 1206333ee039SDag-Erling Smørgrav.Sm on 1207333ee039SDag-Erling Smørgrav.El 1208333ee039SDag-Erling Smørgrav.Pp 1209333ee039SDag-Erling SmørgravMultiple forwards may be specified by separating them with whitespace. 1210333ee039SDag-Erling SmørgravAn argument of 1211333ee039SDag-Erling Smørgrav.Dq any 1212333ee039SDag-Erling Smørgravcan be used to remove all restrictions and permit any forwarding requests. 1213462c32cbSDag-Erling SmørgravAn argument of 1214462c32cbSDag-Erling Smørgrav.Dq none 1215462c32cbSDag-Erling Smørgravcan be used to prohibit all forwarding requests. 1216333ee039SDag-Erling SmørgravBy default all port forwarding requests are permitted. 1217545d5ecaSDag-Erling Smørgrav.It Cm PermitRootLogin 1218545d5ecaSDag-Erling SmørgravSpecifies whether root can log in using 1219545d5ecaSDag-Erling Smørgrav.Xr ssh 1 . 1220545d5ecaSDag-Erling SmørgravThe argument must be 1221545d5ecaSDag-Erling Smørgrav.Dq yes , 1222eccfee6eSDag-Erling Smørgrav.Dq prohibit-password , 1223545d5ecaSDag-Erling Smørgrav.Dq without-password , 1224333ee039SDag-Erling Smørgrav.Dq forced-commands-only , 1225545d5ecaSDag-Erling Smørgravor 1226545d5ecaSDag-Erling Smørgrav.Dq no . 1227545d5ecaSDag-Erling SmørgravThe default is 1228b4245df0SDag-Erling Smørgrav.Dq no . 1229810a15b1SDag-Erling SmørgravNote that if 1230810a15b1SDag-Erling Smørgrav.Cm ChallengeResponseAuthentication 1231810a15b1SDag-Erling Smørgravis 1232810a15b1SDag-Erling Smørgrav.Dq yes , 1233810a15b1SDag-Erling Smørgravthe root user may be allowed in with its password even if 1234810a15b1SDag-Erling Smørgrav.Cm PermitRootLogin is set to 1235810a15b1SDag-Erling Smørgrav.Dq without-password . 1236545d5ecaSDag-Erling Smørgrav.Pp 1237545d5ecaSDag-Erling SmørgravIf this option is set to 1238eccfee6eSDag-Erling Smørgrav.Dq prohibit-password 1239eccfee6eSDag-Erling Smørgravor 1240333ee039SDag-Erling Smørgrav.Dq without-password , 1241eccfee6eSDag-Erling Smørgravpassword and keyboard-interactive authentication are disabled for root. 1242545d5ecaSDag-Erling Smørgrav.Pp 1243545d5ecaSDag-Erling SmørgravIf this option is set to 1244333ee039SDag-Erling Smørgrav.Dq forced-commands-only , 1245545d5ecaSDag-Erling Smørgravroot login with public key authentication will be allowed, 1246545d5ecaSDag-Erling Smørgravbut only if the 1247545d5ecaSDag-Erling Smørgrav.Ar command 1248545d5ecaSDag-Erling Smørgravoption has been specified 1249545d5ecaSDag-Erling Smørgrav(which may be useful for taking remote backups even if root login is 1250cf2b5f3bSDag-Erling Smørgravnormally not allowed). 1251cf2b5f3bSDag-Erling SmørgravAll other authentication methods are disabled for root. 1252545d5ecaSDag-Erling Smørgrav.Pp 1253545d5ecaSDag-Erling SmørgravIf this option is set to 1254333ee039SDag-Erling Smørgrav.Dq no , 1255545d5ecaSDag-Erling Smørgravroot is not allowed to log in. 1256b74df5b2SDag-Erling Smørgrav.It Cm PermitTunnel 1257b74df5b2SDag-Erling SmørgravSpecifies whether 1258b74df5b2SDag-Erling Smørgrav.Xr tun 4 1259b74df5b2SDag-Erling Smørgravdevice forwarding is allowed. 1260b74df5b2SDag-Erling SmørgravThe argument must be 1261b74df5b2SDag-Erling Smørgrav.Dq yes , 1262333ee039SDag-Erling Smørgrav.Dq point-to-point 1263333ee039SDag-Erling Smørgrav(layer 3), 1264b74df5b2SDag-Erling Smørgrav.Dq ethernet 1265333ee039SDag-Erling Smørgrav(layer 2), or 1266b74df5b2SDag-Erling Smørgrav.Dq no . 1267333ee039SDag-Erling SmørgravSpecifying 1268333ee039SDag-Erling Smørgrav.Dq yes 1269333ee039SDag-Erling Smørgravpermits both 1270333ee039SDag-Erling Smørgrav.Dq point-to-point 1271333ee039SDag-Erling Smørgravand 1272333ee039SDag-Erling Smørgrav.Dq ethernet . 1273b74df5b2SDag-Erling SmørgravThe default is 1274b74df5b2SDag-Erling Smørgrav.Dq no . 1275bc5531deSDag-Erling Smørgrav.Pp 1276bc5531deSDag-Erling SmørgravIndependent of this setting, the permissions of the selected 1277bc5531deSDag-Erling Smørgrav.Xr tun 4 1278bc5531deSDag-Erling Smørgravdevice must allow access to the user. 1279f7167e0eSDag-Erling Smørgrav.It Cm PermitTTY 1280f7167e0eSDag-Erling SmørgravSpecifies whether 1281f7167e0eSDag-Erling Smørgrav.Xr pty 4 1282f7167e0eSDag-Erling Smørgravallocation is permitted. 1283f7167e0eSDag-Erling SmørgravThe default is 1284f7167e0eSDag-Erling Smørgrav.Dq yes . 1285f388f5efSDag-Erling Smørgrav.It Cm PermitUserEnvironment 1286f388f5efSDag-Erling SmørgravSpecifies whether 1287f388f5efSDag-Erling Smørgrav.Pa ~/.ssh/environment 1288f388f5efSDag-Erling Smørgravand 1289f388f5efSDag-Erling Smørgrav.Cm environment= 1290f388f5efSDag-Erling Smørgravoptions in 1291f388f5efSDag-Erling Smørgrav.Pa ~/.ssh/authorized_keys 1292f388f5efSDag-Erling Smørgravare processed by 1293333ee039SDag-Erling Smørgrav.Xr sshd 8 . 1294f388f5efSDag-Erling SmørgravThe default is 1295f388f5efSDag-Erling Smørgrav.Dq no . 1296f388f5efSDag-Erling SmørgravEnabling environment processing may enable users to bypass access 1297f388f5efSDag-Erling Smørgravrestrictions in some configurations using mechanisms such as 1298f388f5efSDag-Erling Smørgrav.Ev LD_PRELOAD . 1299a0ee8cc6SDag-Erling Smørgrav.It Cm PermitUserRC 1300a0ee8cc6SDag-Erling SmørgravSpecifies whether any 1301a0ee8cc6SDag-Erling Smørgrav.Pa ~/.ssh/rc 1302a0ee8cc6SDag-Erling Smørgravfile is executed. 1303a0ee8cc6SDag-Erling SmørgravThe default is 1304a0ee8cc6SDag-Erling Smørgrav.Dq yes . 1305545d5ecaSDag-Erling Smørgrav.It Cm PidFile 1306a82e551fSDag-Erling SmørgravSpecifies the file that contains the process ID of the 1307557f75e5SDag-Erling SmørgravSSH daemon, or 1308557f75e5SDag-Erling Smørgrav.Dq none 1309557f75e5SDag-Erling Smørgravto not write one. 1310545d5ecaSDag-Erling SmørgravThe default is 1311545d5ecaSDag-Erling Smørgrav.Pa /var/run/sshd.pid . 1312545d5ecaSDag-Erling Smørgrav.It Cm Port 1313545d5ecaSDag-Erling SmørgravSpecifies the port number that 1314333ee039SDag-Erling Smørgrav.Xr sshd 8 1315545d5ecaSDag-Erling Smørgravlistens on. 1316545d5ecaSDag-Erling SmørgravThe default is 22. 1317545d5ecaSDag-Erling SmørgravMultiple options of this type are permitted. 1318545d5ecaSDag-Erling SmørgravSee also 1319545d5ecaSDag-Erling Smørgrav.Cm ListenAddress . 1320545d5ecaSDag-Erling Smørgrav.It Cm PrintLastLog 1321545d5ecaSDag-Erling SmørgravSpecifies whether 1322333ee039SDag-Erling Smørgrav.Xr sshd 8 1323aa49c926SDag-Erling Smørgravshould print the date and time of the last user login when a user logs 1324aa49c926SDag-Erling Smørgravin interactively. 1325545d5ecaSDag-Erling SmørgravThe default is 1326545d5ecaSDag-Erling Smørgrav.Dq yes . 1327545d5ecaSDag-Erling Smørgrav.It Cm PrintMotd 1328545d5ecaSDag-Erling SmørgravSpecifies whether 1329333ee039SDag-Erling Smørgrav.Xr sshd 8 1330545d5ecaSDag-Erling Smørgravshould print 1331545d5ecaSDag-Erling Smørgrav.Pa /etc/motd 1332545d5ecaSDag-Erling Smørgravwhen a user logs in interactively. 1333545d5ecaSDag-Erling Smørgrav(On some systems it is also printed by the shell, 1334545d5ecaSDag-Erling Smørgrav.Pa /etc/profile , 1335545d5ecaSDag-Erling Smørgravor equivalent.) 1336545d5ecaSDag-Erling SmørgravThe default is 1337545d5ecaSDag-Erling Smørgrav.Dq yes . 1338545d5ecaSDag-Erling Smørgrav.It Cm Protocol 1339545d5ecaSDag-Erling SmørgravSpecifies the protocol versions 1340333ee039SDag-Erling Smørgrav.Xr sshd 8 1341f388f5efSDag-Erling Smørgravsupports. 1342545d5ecaSDag-Erling SmørgravThe possible values are 1343333ee039SDag-Erling Smørgrav.Sq 1 1344545d5ecaSDag-Erling Smørgravand 1345333ee039SDag-Erling Smørgrav.Sq 2 . 1346545d5ecaSDag-Erling SmørgravMultiple versions must be comma-separated. 1347545d5ecaSDag-Erling SmørgravThe default is 1348b15c8340SDag-Erling Smørgrav.Sq 2 . 1349*acc1a9efSDag-Erling SmørgravProtocol 1 suffers from a number of cryptographic weaknesses and should 1350*acc1a9efSDag-Erling Smørgravnot be used. 1351*acc1a9efSDag-Erling SmørgravIt is only offered to support legacy devices. 1352*acc1a9efSDag-Erling Smørgrav.Pp 1353f388f5efSDag-Erling SmørgravNote that the order of the protocol list does not indicate preference, 1354f388f5efSDag-Erling Smørgravbecause the client selects among multiple protocol versions offered 1355f388f5efSDag-Erling Smørgravby the server. 1356f388f5efSDag-Erling SmørgravSpecifying 1357f388f5efSDag-Erling Smørgrav.Dq 2,1 1358f388f5efSDag-Erling Smørgravis identical to 1359f388f5efSDag-Erling Smørgrav.Dq 1,2 . 1360bc5531deSDag-Erling Smørgrav.It Cm PubkeyAcceptedKeyTypes 1361bc5531deSDag-Erling SmørgravSpecifies the key types that will be accepted for public key authentication 1362bc5531deSDag-Erling Smørgravas a comma-separated pattern list. 1363eccfee6eSDag-Erling SmørgravAlternately if the specified value begins with a 1364eccfee6eSDag-Erling Smørgrav.Sq + 1365eccfee6eSDag-Erling Smørgravcharacter, then the specified key types will be appended to the default set 1366eccfee6eSDag-Erling Smørgravinstead of replacing them. 1367eccfee6eSDag-Erling SmørgravThe default for this option is: 1368eccfee6eSDag-Erling Smørgrav.Bd -literal -offset 3n 1369eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp256-cert-v01@openssh.com, 1370eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp384-cert-v01@openssh.com, 1371eccfee6eSDag-Erling Smørgravecdsa-sha2-nistp521-cert-v01@openssh.com, 1372eccfee6eSDag-Erling Smørgravssh-ed25519-cert-v01@openssh.com, 1373eccfee6eSDag-Erling Smørgravssh-rsa-cert-v01@openssh.com, 1374acf8e75eSDag-Erling Smørgravssh-dss-cert-v01@openssh.com, 1375acf8e75eSDag-Erling Smørgravecdsa-sha2-nistp256,ecdsa-sha2-nistp384, 1376acf8e75eSDag-Erling Smørgravecdsa-sha2-nistp521,ssh-ed25519, 1377acf8e75eSDag-Erling Smørgravssh-rsa,ssh-dss 1378eccfee6eSDag-Erling Smørgrav.Ed 1379eccfee6eSDag-Erling Smørgrav.Pp 1380bc5531deSDag-Erling SmørgravThe 1381bc5531deSDag-Erling Smørgrav.Fl Q 1382bc5531deSDag-Erling Smørgravoption of 1383bc5531deSDag-Erling Smørgrav.Xr ssh 1 1384bc5531deSDag-Erling Smørgravmay be used to list supported key types. 1385545d5ecaSDag-Erling Smørgrav.It Cm PubkeyAuthentication 1386545d5ecaSDag-Erling SmørgravSpecifies whether public key authentication is allowed. 1387545d5ecaSDag-Erling SmørgravThe default is 1388545d5ecaSDag-Erling Smørgrav.Dq yes . 1389e4a9863fSDag-Erling Smørgrav.It Cm RekeyLimit 1390e4a9863fSDag-Erling SmørgravSpecifies the maximum amount of data that may be transmitted before the 1391e4a9863fSDag-Erling Smørgravsession key is renegotiated, optionally followed a maximum amount of 1392e4a9863fSDag-Erling Smørgravtime that may pass before the session key is renegotiated. 1393e4a9863fSDag-Erling SmørgravThe first argument is specified in bytes and may have a suffix of 1394e4a9863fSDag-Erling Smørgrav.Sq K , 1395e4a9863fSDag-Erling Smørgrav.Sq M , 1396e4a9863fSDag-Erling Smørgravor 1397e4a9863fSDag-Erling Smørgrav.Sq G 1398e4a9863fSDag-Erling Smørgravto indicate Kilobytes, Megabytes, or Gigabytes, respectively. 1399e4a9863fSDag-Erling SmørgravThe default is between 1400e4a9863fSDag-Erling Smørgrav.Sq 1G 1401e4a9863fSDag-Erling Smørgravand 1402e4a9863fSDag-Erling Smørgrav.Sq 4G , 1403e4a9863fSDag-Erling Smørgravdepending on the cipher. 1404e4a9863fSDag-Erling SmørgravThe optional second value is specified in seconds and may use any of the 1405e4a9863fSDag-Erling Smørgravunits documented in the 1406e4a9863fSDag-Erling Smørgrav.Sx TIME FORMATS 1407e4a9863fSDag-Erling Smørgravsection. 1408e4a9863fSDag-Erling SmørgravThe default value for 1409e4a9863fSDag-Erling Smørgrav.Cm RekeyLimit 1410e4a9863fSDag-Erling Smørgravis 1411e4a9863fSDag-Erling Smørgrav.Dq default none , 1412e4a9863fSDag-Erling Smørgravwhich means that rekeying is performed after the cipher's default amount 1413e4a9863fSDag-Erling Smørgravof data has been sent or received and no time based rekeying is done. 1414b15c8340SDag-Erling Smørgrav.It Cm RevokedKeys 1415557f75e5SDag-Erling SmørgravSpecifies revoked public keys file, or 1416557f75e5SDag-Erling Smørgrav.Dq none 1417557f75e5SDag-Erling Smørgravto not use one. 1418b15c8340SDag-Erling SmørgravKeys listed in this file will be refused for public key authentication. 1419b15c8340SDag-Erling SmørgravNote that if this file is not readable, then public key authentication will 1420b15c8340SDag-Erling Smørgravbe refused for all users. 14216888a9beSDag-Erling SmørgravKeys may be specified as a text file, listing one public key per line, or as 14226888a9beSDag-Erling Smørgravan OpenSSH Key Revocation List (KRL) as generated by 14236888a9beSDag-Erling Smørgrav.Xr ssh-keygen 1 . 1424e4a9863fSDag-Erling SmørgravFor more information on KRLs, see the KEY REVOCATION LISTS section in 14256888a9beSDag-Erling Smørgrav.Xr ssh-keygen 1 . 1426545d5ecaSDag-Erling Smørgrav.It Cm RhostsRSAAuthentication 142735d4ccfbSDag-Erling SmørgravSpecifies whether rhosts or 142835d4ccfbSDag-Erling Smørgrav.Pa /etc/hosts.equiv 142935d4ccfbSDag-Erling Smørgravauthentication together 1430545d5ecaSDag-Erling Smørgravwith successful RSA host authentication is allowed. 1431545d5ecaSDag-Erling SmørgravThe default is 1432545d5ecaSDag-Erling Smørgrav.Dq no . 1433545d5ecaSDag-Erling SmørgravThis option applies to protocol version 1 only. 1434545d5ecaSDag-Erling Smørgrav.It Cm RSAAuthentication 1435545d5ecaSDag-Erling SmørgravSpecifies whether pure RSA authentication is allowed. 1436545d5ecaSDag-Erling SmørgravThe default is 1437545d5ecaSDag-Erling Smørgrav.Dq yes . 1438545d5ecaSDag-Erling SmørgravThis option applies to protocol version 1 only. 1439545d5ecaSDag-Erling Smørgrav.It Cm ServerKeyBits 1440545d5ecaSDag-Erling SmørgravDefines the number of bits in the ephemeral protocol version 1 server key. 1441eccfee6eSDag-Erling SmørgravThe default and minimum value is 1024. 1442a0ee8cc6SDag-Erling Smørgrav.It Cm StreamLocalBindMask 1443a0ee8cc6SDag-Erling SmørgravSets the octal file creation mode mask 1444a0ee8cc6SDag-Erling Smørgrav.Pq umask 1445a0ee8cc6SDag-Erling Smørgravused when creating a Unix-domain socket file for local or remote 1446a0ee8cc6SDag-Erling Smørgravport forwarding. 1447a0ee8cc6SDag-Erling SmørgravThis option is only used for port forwarding to a Unix-domain socket file. 1448a0ee8cc6SDag-Erling Smørgrav.Pp 1449a0ee8cc6SDag-Erling SmørgravThe default value is 0177, which creates a Unix-domain socket file that is 1450a0ee8cc6SDag-Erling Smørgravreadable and writable only by the owner. 1451a0ee8cc6SDag-Erling SmørgravNote that not all operating systems honor the file mode on Unix-domain 1452a0ee8cc6SDag-Erling Smørgravsocket files. 1453a0ee8cc6SDag-Erling Smørgrav.It Cm StreamLocalBindUnlink 1454a0ee8cc6SDag-Erling SmørgravSpecifies whether to remove an existing Unix-domain socket file for local 1455a0ee8cc6SDag-Erling Smørgravor remote port forwarding before creating a new one. 1456a0ee8cc6SDag-Erling SmørgravIf the socket file already exists and 1457a0ee8cc6SDag-Erling Smørgrav.Cm StreamLocalBindUnlink 1458a0ee8cc6SDag-Erling Smørgravis not enabled, 1459a0ee8cc6SDag-Erling Smørgrav.Nm sshd 1460a0ee8cc6SDag-Erling Smørgravwill be unable to forward the port to the Unix-domain socket file. 1461a0ee8cc6SDag-Erling SmørgravThis option is only used for port forwarding to a Unix-domain socket file. 1462a0ee8cc6SDag-Erling Smørgrav.Pp 1463a0ee8cc6SDag-Erling SmørgravThe argument must be 1464a0ee8cc6SDag-Erling Smørgrav.Dq yes 1465a0ee8cc6SDag-Erling Smørgravor 1466a0ee8cc6SDag-Erling Smørgrav.Dq no . 1467a0ee8cc6SDag-Erling SmørgravThe default is 1468a0ee8cc6SDag-Erling Smørgrav.Dq no . 1469545d5ecaSDag-Erling Smørgrav.It Cm StrictModes 1470545d5ecaSDag-Erling SmørgravSpecifies whether 1471333ee039SDag-Erling Smørgrav.Xr sshd 8 1472545d5ecaSDag-Erling Smørgravshould check file modes and ownership of the 1473545d5ecaSDag-Erling Smørgravuser's files and home directory before accepting login. 1474545d5ecaSDag-Erling SmørgravThis is normally desirable because novices sometimes accidentally leave their 1475545d5ecaSDag-Erling Smørgravdirectory or files world-writable. 1476545d5ecaSDag-Erling SmørgravThe default is 1477545d5ecaSDag-Erling Smørgrav.Dq yes . 1478b15c8340SDag-Erling SmørgravNote that this does not apply to 1479b15c8340SDag-Erling Smørgrav.Cm ChrootDirectory , 1480b15c8340SDag-Erling Smørgravwhose permissions and ownership are checked unconditionally. 1481545d5ecaSDag-Erling Smørgrav.It Cm Subsystem 1482333ee039SDag-Erling SmørgravConfigures an external subsystem (e.g. file transfer daemon). 1483333ee039SDag-Erling SmørgravArguments should be a subsystem name and a command (with optional arguments) 1484333ee039SDag-Erling Smørgravto execute upon subsystem request. 1485d4af9e69SDag-Erling Smørgrav.Pp 1486545d5ecaSDag-Erling SmørgravThe command 1487545d5ecaSDag-Erling Smørgrav.Xr sftp-server 8 1488545d5ecaSDag-Erling Smørgravimplements the 1489545d5ecaSDag-Erling Smørgrav.Dq sftp 1490545d5ecaSDag-Erling Smørgravfile transfer subsystem. 1491d4af9e69SDag-Erling Smørgrav.Pp 1492d4af9e69SDag-Erling SmørgravAlternately the name 1493d4af9e69SDag-Erling Smørgrav.Dq internal-sftp 1494d4af9e69SDag-Erling Smørgravimplements an in-process 1495d4af9e69SDag-Erling Smørgrav.Dq sftp 1496d4af9e69SDag-Erling Smørgravserver. 1497d4af9e69SDag-Erling SmørgravThis may simplify configurations using 1498d4af9e69SDag-Erling Smørgrav.Cm ChrootDirectory 1499d4af9e69SDag-Erling Smørgravto force a different filesystem root on clients. 1500d4af9e69SDag-Erling Smørgrav.Pp 1501545d5ecaSDag-Erling SmørgravBy default no subsystems are defined. 1502545d5ecaSDag-Erling Smørgrav.It Cm SyslogFacility 1503545d5ecaSDag-Erling SmørgravGives the facility code that is used when logging messages from 1504333ee039SDag-Erling Smørgrav.Xr sshd 8 . 1505545d5ecaSDag-Erling SmørgravThe possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, 1506545d5ecaSDag-Erling SmørgravLOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. 1507545d5ecaSDag-Erling SmørgravThe default is AUTH. 15081ec0d754SDag-Erling Smørgrav.It Cm TCPKeepAlive 15091ec0d754SDag-Erling SmørgravSpecifies whether the system should send TCP keepalive messages to the 15101ec0d754SDag-Erling Smørgravother side. 15111ec0d754SDag-Erling SmørgravIf they are sent, death of the connection or crash of one 15121ec0d754SDag-Erling Smørgravof the machines will be properly noticed. 15131ec0d754SDag-Erling SmørgravHowever, this means that 15141ec0d754SDag-Erling Smørgravconnections will die if the route is down temporarily, and some people 15151ec0d754SDag-Erling Smørgravfind it annoying. 15161ec0d754SDag-Erling SmørgravOn the other hand, if TCP keepalives are not sent, 15171ec0d754SDag-Erling Smørgravsessions may hang indefinitely on the server, leaving 15181ec0d754SDag-Erling Smørgrav.Dq ghost 15191ec0d754SDag-Erling Smørgravusers and consuming server resources. 15201ec0d754SDag-Erling Smørgrav.Pp 15211ec0d754SDag-Erling SmørgravThe default is 15221ec0d754SDag-Erling Smørgrav.Dq yes 15231ec0d754SDag-Erling Smørgrav(to send TCP keepalive messages), and the server will notice 15241ec0d754SDag-Erling Smørgravif the network goes down or the client host crashes. 15251ec0d754SDag-Erling SmørgravThis avoids infinitely hanging sessions. 15261ec0d754SDag-Erling Smørgrav.Pp 15271ec0d754SDag-Erling SmørgravTo disable TCP keepalive messages, the value should be set to 15281ec0d754SDag-Erling Smørgrav.Dq no . 1529b15c8340SDag-Erling Smørgrav.It Cm TrustedUserCAKeys 1530b15c8340SDag-Erling SmørgravSpecifies a file containing public keys of certificate authorities that are 1531557f75e5SDag-Erling Smørgravtrusted to sign user certificates for authentication, or 1532557f75e5SDag-Erling Smørgrav.Dq none 1533557f75e5SDag-Erling Smørgravto not use one. 1534b15c8340SDag-Erling SmørgravKeys are listed one per line; empty lines and comments starting with 1535b15c8340SDag-Erling Smørgrav.Ql # 1536b15c8340SDag-Erling Smørgravare allowed. 1537b15c8340SDag-Erling SmørgravIf a certificate is presented for authentication and has its signing CA key 1538b15c8340SDag-Erling Smørgravlisted in this file, then it may be used for authentication for any user 1539b15c8340SDag-Erling Smørgravlisted in the certificate's principals list. 1540b15c8340SDag-Erling SmørgravNote that certificates that lack a list of principals will not be permitted 1541b15c8340SDag-Erling Smørgravfor authentication using 1542b15c8340SDag-Erling Smørgrav.Cm TrustedUserCAKeys . 1543e4a9863fSDag-Erling SmørgravFor more details on certificates, see the CERTIFICATES section in 1544b15c8340SDag-Erling Smørgrav.Xr ssh-keygen 1 . 1545cf2b5f3bSDag-Erling Smørgrav.It Cm UseDNS 1546cf2b5f3bSDag-Erling SmørgravSpecifies whether 1547333ee039SDag-Erling Smørgrav.Xr sshd 8 1548eccfee6eSDag-Erling Smørgravshould look up the remote host name, and to check that 1549cf2b5f3bSDag-Erling Smørgravthe resolved host name for the remote IP address maps back to the 1550cf2b5f3bSDag-Erling Smørgravvery same IP address. 1551eccfee6eSDag-Erling Smørgrav.Pp 1552eccfee6eSDag-Erling SmørgravIf this option is set to 1553c4cd1fa4SDag-Erling Smørgrav.Dq no , 1554c4cd1fa4SDag-Erling Smørgravthen only addresses and not host names may be used in 1555eccfee6eSDag-Erling Smørgrav.Pa ~/.ssh/known_hosts 1556eccfee6eSDag-Erling Smørgrav.Cm from 1557eccfee6eSDag-Erling Smørgravand 1558fc1ba28aSDag-Erling Smørgrav.Nm 1559eccfee6eSDag-Erling Smørgrav.Cm Match 1560eccfee6eSDag-Erling Smørgrav.Cm Host 1561eccfee6eSDag-Erling Smørgravdirectives. 1562c4cd1fa4SDag-Erling SmørgravThe default is 1563c4cd1fa4SDag-Erling Smørgrav.Dq yes . 1564545d5ecaSDag-Erling Smørgrav.It Cm UseLogin 1565545d5ecaSDag-Erling SmørgravSpecifies whether 1566545d5ecaSDag-Erling Smørgrav.Xr login 1 1567545d5ecaSDag-Erling Smørgravis used for interactive login sessions. 1568545d5ecaSDag-Erling SmørgravThe default is 1569545d5ecaSDag-Erling Smørgrav.Dq no . 1570545d5ecaSDag-Erling SmørgravNote that 1571545d5ecaSDag-Erling Smørgrav.Xr login 1 1572545d5ecaSDag-Erling Smørgravis never used for remote command execution. 1573545d5ecaSDag-Erling SmørgravNote also, that if this is enabled, 1574545d5ecaSDag-Erling Smørgrav.Cm X11Forwarding 1575545d5ecaSDag-Erling Smørgravwill be disabled because 1576545d5ecaSDag-Erling Smørgrav.Xr login 1 1577545d5ecaSDag-Erling Smørgravdoes not know how to handle 1578545d5ecaSDag-Erling Smørgrav.Xr xauth 1 1579e73e9afaSDag-Erling Smørgravcookies. 1580e73e9afaSDag-Erling SmørgravIf 1581545d5ecaSDag-Erling Smørgrav.Cm UsePrivilegeSeparation 1582545d5ecaSDag-Erling Smørgravis specified, it will be disabled after authentication. 1583cf2b5f3bSDag-Erling Smørgrav.It Cm UsePAM 158421e764dfSDag-Erling SmørgravEnables the Pluggable Authentication Module interface. 158521e764dfSDag-Erling SmørgravIf set to 158621e764dfSDag-Erling Smørgrav.Dq yes 158721e764dfSDag-Erling Smørgravthis will enable PAM authentication using 158821e764dfSDag-Erling Smørgrav.Cm ChallengeResponseAuthentication 1589333ee039SDag-Erling Smørgravand 1590333ee039SDag-Erling Smørgrav.Cm PasswordAuthentication 1591333ee039SDag-Erling Smørgravin addition to PAM account and session module processing for all 1592333ee039SDag-Erling Smørgravauthentication types. 159321e764dfSDag-Erling Smørgrav.Pp 159421e764dfSDag-Erling SmørgravBecause PAM challenge-response authentication usually serves an equivalent 159521e764dfSDag-Erling Smørgravrole to password authentication, you should disable either 159621e764dfSDag-Erling Smørgrav.Cm PasswordAuthentication 159721e764dfSDag-Erling Smørgravor 159821e764dfSDag-Erling Smørgrav.Cm ChallengeResponseAuthentication. 159921e764dfSDag-Erling Smørgrav.Pp 160021e764dfSDag-Erling SmørgravIf 160121e764dfSDag-Erling Smørgrav.Cm UsePAM 160221e764dfSDag-Erling Smørgravis enabled, you will not be able to run 160321e764dfSDag-Erling Smørgrav.Xr sshd 8 160421e764dfSDag-Erling Smørgravas a non-root user. 160521e764dfSDag-Erling SmørgravThe default is 1606d2b1b4f3SDag-Erling Smørgrav.Dq yes . 1607545d5ecaSDag-Erling Smørgrav.It Cm UsePrivilegeSeparation 1608545d5ecaSDag-Erling SmørgravSpecifies whether 1609333ee039SDag-Erling Smørgrav.Xr sshd 8 1610545d5ecaSDag-Erling Smørgravseparates privileges by creating an unprivileged child process 1611e73e9afaSDag-Erling Smørgravto deal with incoming network traffic. 1612e73e9afaSDag-Erling SmørgravAfter successful authentication, another process will be created that has 1613e73e9afaSDag-Erling Smørgravthe privilege of the authenticated user. 1614e73e9afaSDag-Erling SmørgravThe goal of privilege separation is to prevent privilege 1615545d5ecaSDag-Erling Smørgravescalation by containing any corruption within the unprivileged processes. 1616*acc1a9efSDag-Erling SmørgravThe argument must be 1617*acc1a9efSDag-Erling Smørgrav.Dq yes , 1618*acc1a9efSDag-Erling Smørgrav.Dq no , 1619*acc1a9efSDag-Erling Smørgravor 16202b1970f3SDag-Erling Smørgrav.Dq sandbox . 1621e146993eSDag-Erling SmørgravIf 1622e146993eSDag-Erling Smørgrav.Cm UsePrivilegeSeparation 1623e146993eSDag-Erling Smørgravis set to 1624e146993eSDag-Erling Smørgrav.Dq sandbox 1625e146993eSDag-Erling Smørgravthen the pre-authentication unprivileged process is subject to additional 1626e146993eSDag-Erling Smørgravrestrictions. 1627*acc1a9efSDag-Erling SmørgravThe default is 1628*acc1a9efSDag-Erling Smørgrav.Dq sandbox . 162935d4ccfbSDag-Erling Smørgrav.It Cm VersionAddendum 1630462c32cbSDag-Erling SmørgravOptionally specifies additional text to append to the SSH protocol banner 1631462c32cbSDag-Erling Smørgravsent by the server upon connection. 1632ee8aeb14SDag-Erling SmørgravThe default is 1633*acc1a9efSDag-Erling Smørgrav.Dq FreeBSD-20160310 . 16346e571081SBryan DreweryThe value 16356e571081SBryan Drewery.Dq none 16366e571081SBryan Drewerymay be used to disable this. 1637545d5ecaSDag-Erling Smørgrav.It Cm X11DisplayOffset 1638545d5ecaSDag-Erling SmørgravSpecifies the first display number available for 1639333ee039SDag-Erling Smørgrav.Xr sshd 8 Ns 's 1640545d5ecaSDag-Erling SmørgravX11 forwarding. 1641333ee039SDag-Erling SmørgravThis prevents sshd from interfering with real X11 servers. 1642545d5ecaSDag-Erling SmørgravThe default is 10. 1643545d5ecaSDag-Erling Smørgrav.It Cm X11Forwarding 1644545d5ecaSDag-Erling SmørgravSpecifies whether X11 forwarding is permitted. 1645f388f5efSDag-Erling SmørgravThe argument must be 1646f388f5efSDag-Erling Smørgrav.Dq yes 1647f388f5efSDag-Erling Smørgravor 1648f388f5efSDag-Erling Smørgrav.Dq no . 1649545d5ecaSDag-Erling SmørgravThe default is 1650ee8aeb14SDag-Erling Smørgrav.Dq yes . 1651f388f5efSDag-Erling Smørgrav.Pp 1652f388f5efSDag-Erling SmørgravWhen X11 forwarding is enabled, there may be additional exposure to 1653f388f5efSDag-Erling Smørgravthe server and to client displays if the 1654333ee039SDag-Erling Smørgrav.Xr sshd 8 1655f388f5efSDag-Erling Smørgravproxy display is configured to listen on the wildcard address (see 1656f388f5efSDag-Erling Smørgrav.Cm X11UseLocalhost 1657333ee039SDag-Erling Smørgravbelow), though this is not the default. 1658f388f5efSDag-Erling SmørgravAdditionally, the authentication spoofing and authentication data 1659f388f5efSDag-Erling Smørgravverification and substitution occur on the client side. 1660f388f5efSDag-Erling SmørgravThe security risk of using X11 forwarding is that the client's X11 1661333ee039SDag-Erling Smørgravdisplay server may be exposed to attack when the SSH client requests 1662f388f5efSDag-Erling Smørgravforwarding (see the warnings for 1663f388f5efSDag-Erling Smørgrav.Cm ForwardX11 1664f388f5efSDag-Erling Smørgravin 1665f388f5efSDag-Erling Smørgrav.Xr ssh_config 5 ) . 1666f388f5efSDag-Erling SmørgravA system administrator may have a stance in which they want to 1667f388f5efSDag-Erling Smørgravprotect clients that may expose themselves to attack by unwittingly 1668f388f5efSDag-Erling Smørgravrequesting X11 forwarding, which can warrant a 1669f388f5efSDag-Erling Smørgrav.Dq no 1670f388f5efSDag-Erling Smørgravsetting. 1671f388f5efSDag-Erling Smørgrav.Pp 1672f388f5efSDag-Erling SmørgravNote that disabling X11 forwarding does not prevent users from 1673f388f5efSDag-Erling Smørgravforwarding X11 traffic, as users can always install their own forwarders. 1674545d5ecaSDag-Erling SmørgravX11 forwarding is automatically disabled if 1675545d5ecaSDag-Erling Smørgrav.Cm UseLogin 1676545d5ecaSDag-Erling Smørgravis enabled. 1677545d5ecaSDag-Erling Smørgrav.It Cm X11UseLocalhost 1678545d5ecaSDag-Erling SmørgravSpecifies whether 1679333ee039SDag-Erling Smørgrav.Xr sshd 8 1680545d5ecaSDag-Erling Smørgravshould bind the X11 forwarding server to the loopback address or to 1681e73e9afaSDag-Erling Smørgravthe wildcard address. 1682e73e9afaSDag-Erling SmørgravBy default, 1683333ee039SDag-Erling Smørgravsshd binds the forwarding server to the loopback address and sets the 1684545d5ecaSDag-Erling Smørgravhostname part of the 1685545d5ecaSDag-Erling Smørgrav.Ev DISPLAY 1686545d5ecaSDag-Erling Smørgravenvironment variable to 1687545d5ecaSDag-Erling Smørgrav.Dq localhost . 1688f388f5efSDag-Erling SmørgravThis prevents remote hosts from connecting to the proxy display. 1689545d5ecaSDag-Erling SmørgravHowever, some older X11 clients may not function with this 1690545d5ecaSDag-Erling Smørgravconfiguration. 1691545d5ecaSDag-Erling Smørgrav.Cm X11UseLocalhost 1692545d5ecaSDag-Erling Smørgravmay be set to 1693545d5ecaSDag-Erling Smørgrav.Dq no 1694545d5ecaSDag-Erling Smørgravto specify that the forwarding server should be bound to the wildcard 1695545d5ecaSDag-Erling Smørgravaddress. 1696545d5ecaSDag-Erling SmørgravThe argument must be 1697545d5ecaSDag-Erling Smørgrav.Dq yes 1698545d5ecaSDag-Erling Smørgravor 1699545d5ecaSDag-Erling Smørgrav.Dq no . 1700545d5ecaSDag-Erling SmørgravThe default is 1701545d5ecaSDag-Erling Smørgrav.Dq yes . 1702545d5ecaSDag-Erling Smørgrav.It Cm XAuthLocation 1703f388f5efSDag-Erling SmørgravSpecifies the full pathname of the 1704545d5ecaSDag-Erling Smørgrav.Xr xauth 1 1705557f75e5SDag-Erling Smørgravprogram, or 1706557f75e5SDag-Erling Smørgrav.Dq none 1707557f75e5SDag-Erling Smørgravto not use one. 1708545d5ecaSDag-Erling SmørgravThe default is 1709ffea3f5aSDag-Erling Smørgrav.Pa /usr/local/bin/xauth . 1710545d5ecaSDag-Erling Smørgrav.El 1711333ee039SDag-Erling Smørgrav.Sh TIME FORMATS 1712333ee039SDag-Erling Smørgrav.Xr sshd 8 1713545d5ecaSDag-Erling Smørgravcommand-line arguments and configuration file options that specify time 1714545d5ecaSDag-Erling Smørgravmay be expressed using a sequence of the form: 1715545d5ecaSDag-Erling Smørgrav.Sm off 1716f388f5efSDag-Erling Smørgrav.Ar time Op Ar qualifier , 1717545d5ecaSDag-Erling Smørgrav.Sm on 1718545d5ecaSDag-Erling Smørgravwhere 1719545d5ecaSDag-Erling Smørgrav.Ar time 1720545d5ecaSDag-Erling Smørgravis a positive integer value and 1721545d5ecaSDag-Erling Smørgrav.Ar qualifier 1722545d5ecaSDag-Erling Smørgravis one of the following: 1723545d5ecaSDag-Erling Smørgrav.Pp 1724545d5ecaSDag-Erling Smørgrav.Bl -tag -width Ds -compact -offset indent 1725333ee039SDag-Erling Smørgrav.It Aq Cm none 1726545d5ecaSDag-Erling Smørgravseconds 1727545d5ecaSDag-Erling Smørgrav.It Cm s | Cm S 1728545d5ecaSDag-Erling Smørgravseconds 1729545d5ecaSDag-Erling Smørgrav.It Cm m | Cm M 1730545d5ecaSDag-Erling Smørgravminutes 1731545d5ecaSDag-Erling Smørgrav.It Cm h | Cm H 1732545d5ecaSDag-Erling Smørgravhours 1733545d5ecaSDag-Erling Smørgrav.It Cm d | Cm D 1734545d5ecaSDag-Erling Smørgravdays 1735545d5ecaSDag-Erling Smørgrav.It Cm w | Cm W 1736545d5ecaSDag-Erling Smørgravweeks 1737545d5ecaSDag-Erling Smørgrav.El 1738545d5ecaSDag-Erling Smørgrav.Pp 1739545d5ecaSDag-Erling SmørgravEach member of the sequence is added together to calculate 1740545d5ecaSDag-Erling Smørgravthe total time value. 1741545d5ecaSDag-Erling Smørgrav.Pp 1742545d5ecaSDag-Erling SmørgravTime format examples: 1743545d5ecaSDag-Erling Smørgrav.Pp 1744545d5ecaSDag-Erling Smørgrav.Bl -tag -width Ds -compact -offset indent 1745545d5ecaSDag-Erling Smørgrav.It 600 1746545d5ecaSDag-Erling Smørgrav600 seconds (10 minutes) 1747545d5ecaSDag-Erling Smørgrav.It 10m 1748545d5ecaSDag-Erling Smørgrav10 minutes 1749545d5ecaSDag-Erling Smørgrav.It 1h30m 1750545d5ecaSDag-Erling Smørgrav1 hour 30 minutes (90 minutes) 1751545d5ecaSDag-Erling Smørgrav.El 1752545d5ecaSDag-Erling Smørgrav.Sh FILES 1753545d5ecaSDag-Erling Smørgrav.Bl -tag -width Ds 1754545d5ecaSDag-Erling Smørgrav.It Pa /etc/ssh/sshd_config 1755545d5ecaSDag-Erling SmørgravContains configuration data for 1756333ee039SDag-Erling Smørgrav.Xr sshd 8 . 1757545d5ecaSDag-Erling SmørgravThis file should be writable by root only, but it is recommended 1758545d5ecaSDag-Erling Smørgrav(though not necessary) that it be world-readable. 1759545d5ecaSDag-Erling Smørgrav.El 1760cf2b5f3bSDag-Erling Smørgrav.Sh SEE ALSO 1761cf2b5f3bSDag-Erling Smørgrav.Xr sshd 8 1762545d5ecaSDag-Erling Smørgrav.Sh AUTHORS 1763545d5ecaSDag-Erling SmørgravOpenSSH is a derivative of the original and free 1764545d5ecaSDag-Erling Smørgravssh 1.2.12 release by Tatu Ylonen. 1765545d5ecaSDag-Erling SmørgravAaron Campbell, Bob Beck, Markus Friedl, Niels Provos, 1766545d5ecaSDag-Erling SmørgravTheo de Raadt and Dug Song 1767545d5ecaSDag-Erling Smørgravremoved many bugs, re-added newer features and 1768545d5ecaSDag-Erling Smørgravcreated OpenSSH. 1769545d5ecaSDag-Erling SmørgravMarkus Friedl contributed the support for SSH 1770545d5ecaSDag-Erling Smørgravprotocol versions 1.5 and 2.0. 1771545d5ecaSDag-Erling SmørgravNiels Provos and Markus Friedl contributed support 1772545d5ecaSDag-Erling Smørgravfor privilege separation. 1773