Annotation of src/usr.bin/ssh/sshd_config.5, Revision 1.254
1.1 stevesk 1: .\"
2: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
3: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4: .\" All rights reserved
5: .\"
6: .\" As far as I am concerned, the code I have written for this software
7: .\" can be used freely for any purpose. Any derived versions of this
8: .\" software must be clearly marked as such, and if the derived work is
9: .\" incompatible with the protocol description in the RFC file, it must be
10: .\" called by a name other than "ssh" or "Secure Shell".
11: .\"
12: .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
13: .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
14: .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
15: .\"
16: .\" Redistribution and use in source and binary forms, with or without
17: .\" modification, are permitted provided that the following conditions
18: .\" are met:
19: .\" 1. Redistributions of source code must retain the above copyright
20: .\" notice, this list of conditions and the following disclaimer.
21: .\" 2. Redistributions in binary form must reproduce the above copyright
22: .\" notice, this list of conditions and the following disclaimer in the
23: .\" documentation and/or other materials provided with the distribution.
24: .\"
25: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35: .\"
1.254 ! benno 36: .\" $OpenBSD: sshd_config.5,v 1.253 2017/09/27 06:45:53 jmc Exp $
! 37: .Dd $Mdocdate: September 27 2017 $
1.1 stevesk 38: .Dt SSHD_CONFIG 5
39: .Os
40: .Sh NAME
41: .Nm sshd_config
42: .Nd OpenSSH SSH daemon configuration file
43: .Sh DESCRIPTION
1.53 jmc 44: .Xr sshd 8
1.1 stevesk 45: reads configuration data from
46: .Pa /etc/ssh/sshd_config
47: (or the file specified with
48: .Fl f
49: on the command line).
50: The file contains keyword-argument pairs, one per line.
1.254 ! benno 51: For each keyword, the first obtained value will be used.
1.1 stevesk 52: Lines starting with
53: .Ql #
54: and empty lines are interpreted as comments.
1.56 dtucker 55: Arguments may optionally be enclosed in double quotes
56: .Pq \&"
57: in order to represent arguments containing spaces.
1.1 stevesk 58: .Pp
59: The possible
60: keywords and their meanings are as follows (note that
61: keywords are case-insensitive and arguments are case-sensitive):
62: .Bl -tag -width Ds
1.30 djm 63: .It Cm AcceptEnv
64: Specifies what environment variables sent by the client will be copied into
65: the session's
66: .Xr environ 7 .
67: See
68: .Cm SendEnv
69: in
70: .Xr ssh_config 5
71: for how to configure the client.
1.219 jmc 72: The
1.197 dtucker 73: .Ev TERM
1.199 jmc 74: environment variable is always sent whenever the client
1.204 djm 75: requests a pseudo-terminal as it is required by the protocol.
1.30 djm 76: Variables are specified by name, which may contain the wildcard characters
1.51 jmc 77: .Ql *
1.30 djm 78: and
79: .Ql \&? .
1.31 djm 80: Multiple environment variables may be separated by whitespace or spread
1.30 djm 81: across multiple
82: .Cm AcceptEnv
83: directives.
1.31 djm 84: Be warned that some environment variables could be used to bypass restricted
1.30 djm 85: user environments.
86: For this reason, care should be taken in the use of this directive.
87: The default is not to accept any environment variables.
1.37 djm 88: .It Cm AddressFamily
89: Specifies which address family should be used by
1.53 jmc 90: .Xr sshd 8 .
1.37 djm 91: Valid arguments are
1.237 jmc 92: .Cm any
93: (the default),
94: .Cm inet
1.52 jmc 95: (use IPv4 only), or
1.237 jmc 96: .Cm inet6
1.37 djm 97: (use IPv6 only).
1.89 jmc 98: .It Cm AllowAgentForwarding
99: Specifies whether
100: .Xr ssh-agent 1
101: forwarding is permitted.
102: The default is
1.237 jmc 103: .Cm yes .
1.89 jmc 104: Note that disabling agent forwarding does not improve security
105: unless users are also denied shell access, as they can always install
106: their own forwarders.
1.1 stevesk 107: .It Cm AllowGroups
108: This keyword can be followed by a list of group name patterns, separated
109: by spaces.
110: If specified, login is allowed only for users whose primary
111: group or supplementary group list matches one of the patterns.
112: Only group names are valid; a numerical group ID is not recognized.
113: By default, login is allowed for all groups.
1.54 jmc 114: The allow/deny directives are processed in the following order:
115: .Cm DenyUsers ,
116: .Cm AllowUsers ,
117: .Cm DenyGroups ,
118: and finally
119: .Cm AllowGroups .
1.49 jmc 120: .Pp
1.161 jmc 121: See PATTERNS in
1.49 jmc 122: .Xr ssh_config 5
123: for more information on patterns.
1.231 jmc 124: .It Cm AllowStreamLocalForwarding
125: Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted.
1.150 djm 126: The available options are
1.237 jmc 127: .Cm yes
128: (the default)
1.150 djm 129: or
1.237 jmc 130: .Cm all
1.231 jmc 131: to allow StreamLocal forwarding,
1.237 jmc 132: .Cm no
1.231 jmc 133: to prevent all StreamLocal forwarding,
1.237 jmc 134: .Cm local
1.150 djm 135: to allow local (from the perspective of
1.151 jmc 136: .Xr ssh 1 )
137: forwarding only or
1.237 jmc 138: .Cm remote
1.150 djm 139: to allow remote forwarding only.
1.231 jmc 140: Note that disabling StreamLocal forwarding does not improve security unless
1.1 stevesk 141: users are also denied shell access, as they can always install their
142: own forwarders.
1.231 jmc 143: .It Cm AllowTcpForwarding
144: Specifies whether TCP forwarding is permitted.
1.175 millert 145: The available options are
1.237 jmc 146: .Cm yes
147: (the default)
1.175 millert 148: or
1.237 jmc 149: .Cm all
1.231 jmc 150: to allow TCP forwarding,
1.237 jmc 151: .Cm no
1.231 jmc 152: to prevent all TCP forwarding,
1.237 jmc 153: .Cm local
1.175 millert 154: to allow local (from the perspective of
155: .Xr ssh 1 )
156: forwarding only or
1.237 jmc 157: .Cm remote
1.175 millert 158: to allow remote forwarding only.
1.231 jmc 159: Note that disabling TCP forwarding does not improve security unless
1.175 millert 160: users are also denied shell access, as they can always install their
161: own forwarders.
1.1 stevesk 162: .It Cm AllowUsers
163: This keyword can be followed by a list of user name patterns, separated
164: by spaces.
1.14 jmc 165: If specified, login is allowed only for user names that
1.1 stevesk 166: match one of the patterns.
167: Only user names are valid; a numerical user ID is not recognized.
168: By default, login is allowed for all users.
169: If the pattern takes the form USER@HOST then USER and HOST
170: are separately checked, restricting logins to particular
171: users from particular hosts.
1.222 jmc 172: HOST criteria may additionally contain addresses to match in CIDR
173: address/masklen format.
1.54 jmc 174: The allow/deny directives are processed in the following order:
175: .Cm DenyUsers ,
176: .Cm AllowUsers ,
177: .Cm DenyGroups ,
178: and finally
179: .Cm AllowGroups .
1.49 jmc 180: .Pp
1.161 jmc 181: See PATTERNS in
1.49 jmc 182: .Xr ssh_config 5
183: for more information on patterns.
1.149 djm 184: .It Cm AuthenticationMethods
185: Specifies the authentication methods that must be successfully completed
186: for a user to be granted access.
187: This option must be followed by one or more comma-separated lists of
1.224 djm 188: authentication method names, or by the single string
1.237 jmc 189: .Cm any
1.224 djm 190: to indicate the default behaviour of accepting any single authentication
1.225 jmc 191: method.
1.237 jmc 192: If the default is overridden, then successful authentication requires
1.224 djm 193: completion of every method in at least one of these lists.
1.149 djm 194: .Pp
1.237 jmc 195: For example,
196: .Qq publickey,password publickey,keyboard-interactive
1.149 djm 197: would require the user to complete public key authentication, followed by
198: either password or keyboard interactive authentication.
199: Only methods that are next in one or more lists are offered at each stage,
1.237 jmc 200: so for this example it would not be possible to attempt password or
1.149 djm 201: keyboard-interactive authentication before public key.
1.157 markus 202: .Pp
203: For keyboard interactive authentication it is also possible to
204: restrict authentication to a specific device by appending a
205: colon followed by the device identifier
1.237 jmc 206: .Cm bsdauth ,
207: .Cm pam ,
1.157 markus 208: or
1.237 jmc 209: .Cm skey ,
1.157 markus 210: depending on the server configuration.
211: For example,
1.237 jmc 212: .Qq keyboard-interactive:bsdauth
1.157 markus 213: would restrict keyboard interactive authentication to the
1.237 jmc 214: .Cm bsdauth
1.157 markus 215: device.
1.185 djm 216: .Pp
1.237 jmc 217: If the publickey method is listed more than once,
1.185 djm 218: .Xr sshd 8
219: verifies that keys that have been used successfully are not reused for
220: subsequent authentications.
1.237 jmc 221: For example,
222: .Qq publickey,publickey
223: requires successful authentication using two different public keys.
1.181 djm 224: .Pp
1.149 djm 225: Note that each authentication method listed should also be explicitly enabled
226: in the configuration.
1.251 djm 227: .Pp
228: The available authentication methods are:
229: .Qq gssapi-with-mic ,
230: .Qq hostbased ,
231: .Qq keyboard-interactive ,
232: .Qq none
233: (used for access to password-less accounts when
234: .Cm PermitEmptyPassword
235: is enabled),
236: .Qq password
237: and
238: .Qq publickey .
1.146 djm 239: .It Cm AuthorizedKeysCommand
1.147 jmc 240: Specifies a program to be used to look up the user's public keys.
1.201 djm 241: The program must be owned by root, not writable by group or others and
242: specified by an absolute path.
243: Arguments to
244: .Cm AuthorizedKeysCommand
1.235 jmc 245: accept the tokens described in the
246: .Sx TOKENS
247: section.
248: If no arguments are specified then the username of the target user is used.
1.201 djm 249: .Pp
250: The program should produce on standard output zero or
1.235 jmc 251: more lines of authorized_keys output (see
252: .Sx AUTHORIZED_KEYS
253: in
1.147 jmc 254: .Xr sshd 8 ) .
1.235 jmc 255: If a key supplied by
256: .Cm AuthorizedKeysCommand
257: does not successfully authenticate
1.146 djm 258: and authorize the user then public key authentication continues using the usual
259: .Cm AuthorizedKeysFile
260: files.
1.237 jmc 261: By default, no
262: .Cm AuthorizedKeysCommand
263: is run.
1.146 djm 264: .It Cm AuthorizedKeysCommandUser
1.237 jmc 265: Specifies the user under whose account the
266: .Cm AuthorizedKeysCommand
267: is run.
1.146 djm 268: It is recommended to use a dedicated user that has no other role on the host
269: than running authorized keys commands.
1.186 djm 270: If
1.181 djm 271: .Cm AuthorizedKeysCommand
1.186 djm 272: is specified but
273: .Cm AuthorizedKeysCommandUser
274: is not, then
275: .Xr sshd 8
276: will refuse to start.
1.1 stevesk 277: .It Cm AuthorizedKeysFile
1.235 jmc 278: Specifies the file that contains the public keys used for user authentication.
1.124 djm 279: The format is described in the
1.235 jmc 280: .Sx AUTHORIZED_KEYS FILE FORMAT
1.124 djm 281: section of
282: .Xr sshd 8 .
1.235 jmc 283: Arguments to
1.1 stevesk 284: .Cm AuthorizedKeysFile
1.235 jmc 285: accept the tokens described in the
286: .Sx TOKENS
287: section.
1.1 stevesk 288: After expansion,
289: .Cm AuthorizedKeysFile
290: is taken to be an absolute path or one relative to the user's home
291: directory.
1.133 jmc 292: Multiple files may be listed, separated by whitespace.
1.212 djm 293: Alternately this option may be set to
1.237 jmc 294: .Cm none
1.212 djm 295: to skip checking for user keys in files.
1.133 jmc 296: The default is
1.237 jmc 297: .Qq .ssh/authorized_keys .ssh/authorized_keys2 .
1.202 djm 298: .It Cm AuthorizedPrincipalsCommand
299: Specifies a program to be used to generate the list of allowed
300: certificate principals as per
301: .Cm AuthorizedPrincipalsFile .
302: The program must be owned by root, not writable by group or others and
303: specified by an absolute path.
304: Arguments to
305: .Cm AuthorizedPrincipalsCommand
1.235 jmc 306: accept the tokens described in the
307: .Sx TOKENS
308: section.
309: If no arguments are specified then the username of the target user is used.
1.202 djm 310: .Pp
311: The program should produce on standard output zero or
312: more lines of
313: .Cm AuthorizedPrincipalsFile
314: output.
315: If either
316: .Cm AuthorizedPrincipalsCommand
317: or
318: .Cm AuthorizedPrincipalsFile
319: is specified, then certificates offered by the client for authentication
320: must contain a principal that is listed.
1.235 jmc 321: By default, no
322: .Cm AuthorizedPrincipalsCommand
323: is run.
1.202 djm 324: .It Cm AuthorizedPrincipalsCommandUser
1.235 jmc 325: Specifies the user under whose account the
326: .Cm AuthorizedPrincipalsCommand
327: is run.
1.202 djm 328: It is recommended to use a dedicated user that has no other role on the host
329: than running authorized principals commands.
330: If
331: .Cm AuthorizedPrincipalsCommand
332: is specified but
333: .Cm AuthorizedPrincipalsCommandUser
334: is not, then
335: .Xr sshd 8
336: will refuse to start.
1.121 djm 337: .It Cm AuthorizedPrincipalsFile
338: Specifies a file that lists principal names that are accepted for
339: certificate authentication.
340: When using certificates signed by a key listed in
341: .Cm TrustedUserCAKeys ,
342: this file lists names, one of which must appear in the certificate for it
343: to be accepted for authentication.
1.235 jmc 344: Names are listed one per line preceded by key options (as described in
345: .Sx AUTHORIZED_KEYS FILE FORMAT
346: in
1.125 jmc 347: .Xr sshd 8 ) .
1.124 djm 348: Empty lines and comments starting with
1.121 djm 349: .Ql #
350: are ignored.
351: .Pp
1.235 jmc 352: Arguments to
1.121 djm 353: .Cm AuthorizedPrincipalsFile
1.235 jmc 354: accept the tokens described in the
355: .Sx TOKENS
356: section.
1.121 djm 357: After expansion,
358: .Cm AuthorizedPrincipalsFile
1.235 jmc 359: is taken to be an absolute path or one relative to the user's home directory.
1.138 djm 360: The default is
1.237 jmc 361: .Cm none ,
1.138 djm 362: i.e. not to use a principals file \(en in this case, the username
1.121 djm 363: of the user must appear in a certificate's principals list for it to be
364: accepted.
1.235 jmc 365: .Pp
1.121 djm 366: Note that
367: .Cm AuthorizedPrincipalsFile
368: is only used when authentication proceeds using a CA listed in
369: .Cm TrustedUserCAKeys
370: and is not consulted for certification authorities trusted via
371: .Pa ~/.ssh/authorized_keys ,
372: though the
373: .Cm principals=
374: key option offers a similar facility (see
375: .Xr sshd 8
376: for details).
1.1 stevesk 377: .It Cm Banner
378: The contents of the specified file are sent to the remote user before
379: authentication is allowed.
1.78 djm 380: If the argument is
1.237 jmc 381: .Cm none
1.78 djm 382: then no banner is displayed.
1.1 stevesk 383: By default, no banner is displayed.
384: .It Cm ChallengeResponseAuthentication
1.50 jmc 385: Specifies whether challenge-response authentication is allowed.
1.1 stevesk 386: All authentication styles from
387: .Xr login.conf 5
388: are supported.
389: The default is
1.237 jmc 390: .Cm yes .
1.80 djm 391: .It Cm ChrootDirectory
1.113 stevesk 392: Specifies the pathname of a directory to
1.80 djm 393: .Xr chroot 2
394: to after authentication.
1.190 deraadt 395: At session startup
396: .Xr sshd 8
397: checks that all components of the pathname are root-owned directories
398: which are not writable by any other user or group.
1.106 stevesk 399: After the chroot,
400: .Xr sshd 8
401: changes the working directory to the user's home directory.
1.235 jmc 402: Arguments to
403: .Cm ChrootDirectory
404: accept the tokens described in the
405: .Sx TOKENS
406: section.
1.80 djm 407: .Pp
408: The
409: .Cm ChrootDirectory
410: must contain the necessary files and directories to support the
1.103 stevesk 411: user's session.
1.80 djm 412: For an interactive session this requires at least a shell, typically
413: .Xr sh 1 ,
414: and basic
415: .Pa /dev
416: nodes such as
417: .Xr null 4 ,
418: .Xr zero 4 ,
419: .Xr stdin 4 ,
420: .Xr stdout 4 ,
421: .Xr stderr 4 ,
1.180 jmc 422: and
1.80 djm 423: .Xr tty 4
424: devices.
1.237 jmc 425: For file transfer sessions using SFTP
426: no additional configuration of the environment is necessary if the in-process
427: sftp-server is used,
1.176 schwarze 428: though sessions which use logging may require
1.104 stevesk 429: .Pa /dev/log
1.176 schwarze 430: inside the chroot directory on some operating systems (see
1.104 stevesk 431: .Xr sftp-server 8
1.81 jmc 432: for details).
1.190 deraadt 433: .Pp
1.191 jmc 434: For safety, it is very important that the directory hierarchy be
1.190 deraadt 435: prevented from modification by other processes on the system (especially
436: those outside the jail).
437: Misconfiguration can lead to unsafe environments which
438: .Xr sshd 8
439: cannot detect.
1.80 djm 440: .Pp
1.215 djm 441: The default is
1.237 jmc 442: .Cm none ,
1.215 djm 443: indicating not to
1.80 djm 444: .Xr chroot 2 .
1.1 stevesk 445: .It Cm Ciphers
1.219 jmc 446: Specifies the ciphers allowed.
1.1 stevesk 447: Multiple ciphers must be comma-separated.
1.208 djm 448: If the specified value begins with a
449: .Sq +
450: character, then the specified ciphers will be appended to the default set
451: instead of replacing them.
1.242 djm 452: If the specified value begins with a
453: .Sq -
454: character, then the specified ciphers (including wildcards) will be removed
455: from the default set instead of replacing them.
1.208 djm 456: .Pp
1.167 djm 457: The supported ciphers are:
458: .Pp
1.173 naddy 459: .Bl -item -compact -offset indent
460: .It
461: 3des-cbc
462: .It
463: aes128-cbc
464: .It
465: aes192-cbc
466: .It
467: aes256-cbc
468: .It
469: aes128-ctr
470: .It
471: aes192-ctr
472: .It
473: aes256-ctr
474: .It
475: aes128-gcm@openssh.com
476: .It
477: aes256-gcm@openssh.com
478: .It
479: chacha20-poly1305@openssh.com
480: .El
1.167 djm 481: .Pp
1.52 jmc 482: The default is:
1.173 naddy 483: .Bd -literal -offset indent
1.211 jmc 484: chacha20-poly1305@openssh.com,
1.173 naddy 485: aes128-ctr,aes192-ctr,aes256-ctr,
1.211 jmc 486: aes128-gcm@openssh.com,aes256-gcm@openssh.com
1.1 stevesk 487: .Ed
1.167 djm 488: .Pp
1.237 jmc 489: The list of available ciphers may also be obtained using
490: .Qq ssh -Q cipher .
1.1 stevesk 491: .It Cm ClientAliveCountMax
1.237 jmc 492: Sets the number of client alive messages which may be sent without
1.52 jmc 493: .Xr sshd 8
1.17 jmc 494: receiving any messages back from the client.
495: If this threshold is reached while client alive messages are being sent,
1.52 jmc 496: sshd will disconnect the client, terminating the session.
1.17 jmc 497: It is important to note that the use of client alive messages is very
498: different from
1.237 jmc 499: .Cm TCPKeepAlive .
1.17 jmc 500: The client alive messages are sent through the encrypted channel
501: and therefore will not be spoofable.
502: The TCP keepalive option enabled by
1.27 markus 503: .Cm TCPKeepAlive
1.17 jmc 504: is spoofable.
505: The client alive mechanism is valuable when the client or
1.1 stevesk 506: server depend on knowing when a connection has become inactive.
507: .Pp
1.17 jmc 508: The default value is 3.
509: If
1.1 stevesk 510: .Cm ClientAliveInterval
1.237 jmc 511: is set to 15, and
1.1 stevesk 512: .Cm ClientAliveCountMax
1.52 jmc 513: is left at the default, unresponsive SSH clients
1.1 stevesk 514: will be disconnected after approximately 45 seconds.
1.42 djm 515: .It Cm ClientAliveInterval
516: Sets a timeout interval in seconds after which if no data has been received
517: from the client,
1.52 jmc 518: .Xr sshd 8
1.42 djm 519: will send a message through the encrypted
520: channel to request a response from the client.
521: The default
522: is 0, indicating that these messages will not be sent to the client.
1.3 markus 523: .It Cm Compression
1.236 djm 524: Specifies whether compression is enabled after
1.44 markus 525: the user has authenticated successfully.
1.3 markus 526: The argument must be
1.237 jmc 527: .Cm yes ,
528: .Cm delayed
1.236 djm 529: (a legacy synonym for
1.237 jmc 530: .Cm yes )
1.3 markus 531: or
1.237 jmc 532: .Cm no .
1.3 markus 533: The default is
1.237 jmc 534: .Cm yes .
1.1 stevesk 535: .It Cm DenyGroups
536: This keyword can be followed by a list of group name patterns, separated
537: by spaces.
538: Login is disallowed for users whose primary group or supplementary
539: group list matches one of the patterns.
540: Only group names are valid; a numerical group ID is not recognized.
541: By default, login is allowed for all groups.
1.54 jmc 542: The allow/deny directives are processed in the following order:
543: .Cm DenyUsers ,
544: .Cm AllowUsers ,
545: .Cm DenyGroups ,
546: and finally
547: .Cm AllowGroups .
1.49 jmc 548: .Pp
1.161 jmc 549: See PATTERNS in
1.49 jmc 550: .Xr ssh_config 5
551: for more information on patterns.
1.1 stevesk 552: .It Cm DenyUsers
553: This keyword can be followed by a list of user name patterns, separated
554: by spaces.
555: Login is disallowed for user names that match one of the patterns.
556: Only user names are valid; a numerical user ID is not recognized.
557: By default, login is allowed for all users.
558: If the pattern takes the form USER@HOST then USER and HOST
559: are separately checked, restricting logins to particular
560: users from particular hosts.
1.222 jmc 561: HOST criteria may additionally contain addresses to match in CIDR
562: address/masklen format.
1.54 jmc 563: The allow/deny directives are processed in the following order:
564: .Cm DenyUsers ,
565: .Cm AllowUsers ,
566: .Cm DenyGroups ,
567: and finally
568: .Cm AllowGroups .
1.49 jmc 569: .Pp
1.161 jmc 570: See PATTERNS in
1.49 jmc 571: .Xr ssh_config 5
572: for more information on patterns.
1.239 djm 573: .It Cm DisableForwarding
574: Disables all forwarding features, including X11,
575: .Xr ssh-agent 1 ,
576: TCP and StreamLocal.
577: This option overrides all other forwarding-related options and may
578: simplify restricted configurations.
1.246 djm 579: .It Cm ExposeAuthInfo
1.253 jmc 580: Writes a temporary file containing a list of authentication methods and
1.246 djm 581: public credentials (e.g. keys) used to authenticate the user.
1.247 jmc 582: The location of the file is exposed to the user session through the
1.248 djm 583: .Ev SSH_USER_AUTH
1.247 jmc 584: environment variable.
1.253 jmc 585: The default is
586: .Cm no .
1.183 djm 587: .It Cm FingerprintHash
588: Specifies the hash algorithm used when logging key fingerprints.
589: Valid options are:
1.237 jmc 590: .Cm md5
1.183 djm 591: and
1.237 jmc 592: .Cm sha256 .
1.183 djm 593: The default is
1.237 jmc 594: .Cm sha256 .
1.67 dtucker 595: .It Cm ForceCommand
596: Forces the execution of the command specified by
597: .Cm ForceCommand ,
1.84 djm 598: ignoring any command supplied by the client and
599: .Pa ~/.ssh/rc
600: if present.
1.67 dtucker 601: The command is invoked by using the user's login shell with the -c option.
602: This applies to shell, command, or subsystem execution.
603: It is most useful inside a
604: .Cm Match
605: block.
606: The command originally supplied by the client is available in the
607: .Ev SSH_ORIGINAL_COMMAND
608: environment variable.
1.82 djm 609: Specifying a command of
1.237 jmc 610: .Cm internal-sftp
611: will force the use of an in-process SFTP server that requires no support
1.82 djm 612: files when used with
613: .Cm ChrootDirectory .
1.215 djm 614: The default is
1.237 jmc 615: .Cm none .
1.1 stevesk 616: .It Cm GatewayPorts
617: Specifies whether remote hosts are allowed to connect to ports
618: forwarded for the client.
619: By default,
1.52 jmc 620: .Xr sshd 8
1.15 jmc 621: binds remote port forwardings to the loopback address.
622: This prevents other remote hosts from connecting to forwarded ports.
1.1 stevesk 623: .Cm GatewayPorts
1.52 jmc 624: can be used to specify that sshd
1.39 djm 625: should allow remote port forwardings to bind to non-loopback addresses, thus
626: allowing other hosts to connect.
627: The argument may be
1.237 jmc 628: .Cm no
1.39 djm 629: to force remote port forwardings to be available to the local host only,
1.237 jmc 630: .Cm yes
1.39 djm 631: to force remote port forwardings to bind to the wildcard address, or
1.237 jmc 632: .Cm clientspecified
1.39 djm 633: to allow the client to select the address to which the forwarding is bound.
1.1 stevesk 634: The default is
1.237 jmc 635: .Cm no .
1.23 markus 636: .It Cm GSSAPIAuthentication
1.25 markus 637: Specifies whether user authentication based on GSSAPI is allowed.
1.26 djm 638: The default is
1.237 jmc 639: .Cm no .
1.23 markus 640: .It Cm GSSAPICleanupCredentials
641: Specifies whether to automatically destroy the user's credentials cache
642: on logout.
643: The default is
1.237 jmc 644: .Cm yes .
1.203 djm 645: .It Cm GSSAPIStrictAcceptorCheck
646: Determines whether to be strict about the identity of the GSSAPI acceptor
647: a client authenticates against.
648: If set to
1.237 jmc 649: .Cm yes
650: then the client must authenticate against the host
1.203 djm 651: service on the current hostname.
652: If set to
1.237 jmc 653: .Cm no
1.203 djm 654: then the client may authenticate against any service key stored in the
655: machine's default store.
656: This facility is provided to assist with operation on multi homed machines.
657: The default is
1.237 jmc 658: .Cm yes .
1.189 djm 659: .It Cm HostbasedAcceptedKeyTypes
660: Specifies the key types that will be accepted for hostbased authentication
661: as a comma-separated pattern list.
1.208 djm 662: Alternately if the specified value begins with a
663: .Sq +
664: character, then the specified key types will be appended to the default set
665: instead of replacing them.
1.242 djm 666: If the specified value begins with a
667: .Sq -
668: character, then the specified key types (including wildcards) will be removed
669: from the default set instead of replacing them.
1.206 markus 670: The default for this option is:
671: .Bd -literal -offset 3n
672: ecdsa-sha2-nistp256-cert-v01@openssh.com,
673: ecdsa-sha2-nistp384-cert-v01@openssh.com,
674: ecdsa-sha2-nistp521-cert-v01@openssh.com,
675: ssh-ed25519-cert-v01@openssh.com,
676: ssh-rsa-cert-v01@openssh.com,
677: ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1.220 djm 678: ssh-ed25519,ssh-rsa
1.206 markus 679: .Ed
680: .Pp
1.237 jmc 681: The list of available key types may also be obtained using
682: .Qq ssh -Q key .
1.1 stevesk 683: .It Cm HostbasedAuthentication
684: Specifies whether rhosts or /etc/hosts.equiv authentication together
685: with successful public key client host authentication is allowed
1.50 jmc 686: (host-based authentication).
1.70 dtucker 687: The default is
1.237 jmc 688: .Cm no .
1.70 dtucker 689: .It Cm HostbasedUsesNameFromPacketOnly
690: Specifies whether or not the server will attempt to perform a reverse
691: name lookup when matching the name in the
692: .Pa ~/.shosts ,
693: .Pa ~/.rhosts ,
694: and
695: .Pa /etc/hosts.equiv
696: files during
697: .Cm HostbasedAuthentication .
698: A setting of
1.237 jmc 699: .Cm yes
1.70 dtucker 700: means that
701: .Xr sshd 8
702: uses the name supplied by the client rather than
703: attempting to resolve the name from the TCP connection itself.
1.1 stevesk 704: The default is
1.237 jmc 705: .Cm no .
1.117 djm 706: .It Cm HostCertificate
707: Specifies a file containing a public host certificate.
708: The certificate's public key must match a private host key already specified
709: by
710: .Cm HostKey .
711: The default behaviour of
712: .Xr sshd 8
713: is not to load any certificates.
1.1 stevesk 714: .It Cm HostKey
715: Specifies a file containing a private host key
716: used by SSH.
1.229 naddy 717: The defaults are
1.126 djm 718: .Pa /etc/ssh/ssh_host_dsa_key ,
1.169 naddy 719: .Pa /etc/ssh/ssh_host_ecdsa_key ,
720: .Pa /etc/ssh/ssh_host_ed25519_key
1.126 djm 721: and
1.229 naddy 722: .Pa /etc/ssh/ssh_host_rsa_key .
1.206 markus 723: .Pp
1.1 stevesk 724: Note that
1.52 jmc 725: .Xr sshd 8
1.206 markus 726: will refuse to use a file if it is group/world-accessible
727: and that the
728: .Cm HostKeyAlgorithms
729: option restricts which of the keys are actually used by
730: .Xr sshd 8 .
731: .Pp
1.1 stevesk 732: It is possible to have multiple host key files.
1.162 markus 733: It is also possible to specify public host key files instead.
734: In this case operations on the private key will be delegated
735: to an
736: .Xr ssh-agent 1 .
737: .It Cm HostKeyAgent
738: Identifies the UNIX-domain socket used to communicate
739: with an agent that has access to the private host keys.
1.223 markus 740: If the string
1.237 jmc 741: .Qq SSH_AUTH_SOCK
1.162 markus 742: is specified, the location of the socket will be read from the
743: .Ev SSH_AUTH_SOCK
744: environment variable.
1.206 markus 745: .It Cm HostKeyAlgorithms
1.219 jmc 746: Specifies the host key algorithms
1.206 markus 747: that the server offers.
748: The default for this option is:
749: .Bd -literal -offset 3n
750: ecdsa-sha2-nistp256-cert-v01@openssh.com,
751: ecdsa-sha2-nistp384-cert-v01@openssh.com,
752: ecdsa-sha2-nistp521-cert-v01@openssh.com,
753: ssh-ed25519-cert-v01@openssh.com,
754: ssh-rsa-cert-v01@openssh.com,
755: ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1.220 djm 756: ssh-ed25519,ssh-rsa
1.206 markus 757: .Ed
758: .Pp
1.237 jmc 759: The list of available key types may also be obtained using
760: .Qq ssh -Q key .
1.1 stevesk 761: .It Cm IgnoreRhosts
762: Specifies that
763: .Pa .rhosts
764: and
765: .Pa .shosts
766: files will not be used in
767: .Cm HostbasedAuthentication .
768: .Pp
769: .Pa /etc/hosts.equiv
770: and
771: .Pa /etc/shosts.equiv
772: are still used.
773: The default is
1.237 jmc 774: .Cm yes .
1.1 stevesk 775: .It Cm IgnoreUserKnownHosts
776: Specifies whether
1.52 jmc 777: .Xr sshd 8
1.1 stevesk 778: should ignore the user's
1.41 djm 779: .Pa ~/.ssh/known_hosts
1.1 stevesk 780: during
781: .Cm HostbasedAuthentication .
782: The default is
1.237 jmc 783: .Cm no .
1.129 djm 784: .It Cm IPQoS
785: Specifies the IPv4 type-of-service or DSCP class for the connection.
786: Accepted values are
1.237 jmc 787: .Cm af11 ,
788: .Cm af12 ,
789: .Cm af13 ,
790: .Cm af21 ,
791: .Cm af22 ,
792: .Cm af23 ,
793: .Cm af31 ,
794: .Cm af32 ,
795: .Cm af33 ,
796: .Cm af41 ,
797: .Cm af42 ,
798: .Cm af43 ,
799: .Cm cs0 ,
800: .Cm cs1 ,
801: .Cm cs2 ,
802: .Cm cs3 ,
803: .Cm cs4 ,
804: .Cm cs5 ,
805: .Cm cs6 ,
806: .Cm cs7 ,
807: .Cm ef ,
808: .Cm lowdelay ,
809: .Cm throughput ,
810: .Cm reliability ,
1.250 djm 811: a numeric value, or
812: .Cm none
813: to use the operating system default.
1.131 djm 814: This option may take one or two arguments, separated by whitespace.
1.129 djm 815: If one argument is specified, it is used as the packet class unconditionally.
816: If two values are specified, the first is automatically selected for
817: interactive sessions and the second for non-interactive sessions.
818: The default is
1.237 jmc 819: .Cm lowdelay
1.129 djm 820: for interactive sessions and
1.237 jmc 821: .Cm throughput
1.129 djm 822: for non-interactive sessions.
1.171 jmc 823: .It Cm KbdInteractiveAuthentication
824: Specifies whether to allow keyboard-interactive authentication.
825: The argument to this keyword must be
1.237 jmc 826: .Cm yes
1.171 jmc 827: or
1.237 jmc 828: .Cm no .
1.171 jmc 829: The default is to use whatever value
830: .Cm ChallengeResponseAuthentication
831: is set to
832: (by default
1.237 jmc 833: .Cm yes ) .
1.1 stevesk 834: .It Cm KerberosAuthentication
1.24 markus 835: Specifies whether the password provided by the user for
1.1 stevesk 836: .Cm PasswordAuthentication
1.24 markus 837: will be validated through the Kerberos KDC.
1.1 stevesk 838: To use this option, the server needs a
839: Kerberos servtab which allows the verification of the KDC's identity.
1.52 jmc 840: The default is
1.237 jmc 841: .Cm no .
1.29 dtucker 842: .It Cm KerberosGetAFSToken
1.45 djm 843: If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
1.29 dtucker 844: an AFS token before accessing the user's home directory.
1.52 jmc 845: The default is
1.237 jmc 846: .Cm no .
1.1 stevesk 847: .It Cm KerberosOrLocalPasswd
1.52 jmc 848: If password authentication through Kerberos fails then
1.1 stevesk 849: the password will be validated via any additional local mechanism
850: such as
851: .Pa /etc/passwd .
1.52 jmc 852: The default is
1.237 jmc 853: .Cm yes .
1.1 stevesk 854: .It Cm KerberosTicketCleanup
855: Specifies whether to automatically destroy the user's ticket cache
856: file on logout.
1.52 jmc 857: The default is
1.237 jmc 858: .Cm yes .
1.127 djm 859: .It Cm KexAlgorithms
860: Specifies the available KEX (Key Exchange) algorithms.
861: Multiple algorithms must be comma-separated.
1.208 djm 862: Alternately if the specified value begins with a
863: .Sq +
864: character, then the specified methods will be appended to the default set
865: instead of replacing them.
1.242 djm 866: If the specified value begins with a
867: .Sq -
868: character, then the specified methods (including wildcards) will be removed
869: from the default set instead of replacing them.
1.173 naddy 870: The supported algorithms are:
871: .Pp
872: .Bl -item -compact -offset indent
873: .It
1.234 djm 874: curve25519-sha256
875: .It
1.173 naddy 876: curve25519-sha256@libssh.org
877: .It
878: diffie-hellman-group1-sha1
879: .It
880: diffie-hellman-group14-sha1
881: .It
882: diffie-hellman-group-exchange-sha1
883: .It
884: diffie-hellman-group-exchange-sha256
885: .It
886: ecdh-sha2-nistp256
887: .It
888: ecdh-sha2-nistp384
889: .It
890: ecdh-sha2-nistp521
891: .El
892: .Pp
893: The default is:
1.170 dtucker 894: .Bd -literal -offset indent
1.234 djm 895: curve25519-sha256,curve25519-sha256@libssh.org,
1.170 dtucker 896: ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
897: diffie-hellman-group-exchange-sha256,
1.173 naddy 898: diffie-hellman-group14-sha1
1.170 dtucker 899: .Ed
1.188 djm 900: .Pp
1.237 jmc 901: The list of available key exchange algorithms may also be obtained using
902: .Qq ssh -Q kex .
1.1 stevesk 903: .It Cm ListenAddress
904: Specifies the local addresses
1.52 jmc 905: .Xr sshd 8
1.1 stevesk 906: should listen on.
907: The following forms may be used:
908: .Pp
909: .Bl -item -offset indent -compact
910: .It
911: .Cm ListenAddress
912: .Sm off
1.180 jmc 913: .Ar host | Ar IPv4_addr | Ar IPv6_addr
1.1 stevesk 914: .Sm on
915: .It
916: .Cm ListenAddress
917: .Sm off
1.180 jmc 918: .Ar host | Ar IPv4_addr : Ar port
1.1 stevesk 919: .Sm on
920: .It
921: .Cm ListenAddress
922: .Sm off
923: .Oo
1.180 jmc 924: .Ar host | Ar IPv6_addr Oc : Ar port
1.1 stevesk 925: .Sm on
926: .El
927: .Pp
928: If
929: .Ar port
930: is not specified,
1.200 dtucker 931: sshd will listen on the address and all
1.1 stevesk 932: .Cm Port
1.17 jmc 933: options specified.
934: The default is to listen on all local addresses.
1.15 jmc 935: Multiple
1.1 stevesk 936: .Cm ListenAddress
1.17 jmc 937: options are permitted.
1.1 stevesk 938: .It Cm LoginGraceTime
939: The server disconnects after this time if the user has not
940: successfully logged in.
941: If the value is 0, there is no time limit.
1.12 stevesk 942: The default is 120 seconds.
1.1 stevesk 943: .It Cm LogLevel
944: Gives the verbosity level that is used when logging messages from
1.53 jmc 945: .Xr sshd 8 .
1.1 stevesk 946: The possible values are:
1.52 jmc 947: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
1.15 jmc 948: The default is INFO.
949: DEBUG and DEBUG1 are equivalent.
950: DEBUG2 and DEBUG3 each specify higher levels of debugging output.
951: Logging with a DEBUG level violates the privacy of users and is not recommended.
1.1 stevesk 952: .It Cm MACs
953: Specifies the available MAC (message authentication code) algorithms.
1.219 jmc 954: The MAC algorithm is used for data integrity protection.
1.1 stevesk 955: Multiple algorithms must be comma-separated.
1.208 djm 956: If the specified value begins with a
957: .Sq +
958: character, then the specified algorithms will be appended to the default set
959: instead of replacing them.
1.242 djm 960: If the specified value begins with a
961: .Sq -
962: character, then the specified algorithms (including wildcards) will be removed
963: from the default set instead of replacing them.
1.208 djm 964: .Pp
1.152 markus 965: The algorithms that contain
1.237 jmc 966: .Qq -etm
1.152 markus 967: calculate the MAC after encryption (encrypt-then-mac).
968: These are considered safer and their use recommended.
1.173 naddy 969: The supported MACs are:
970: .Pp
971: .Bl -item -compact -offset indent
972: .It
973: hmac-md5
974: .It
975: hmac-md5-96
976: .It
977: hmac-sha1
978: .It
979: hmac-sha1-96
980: .It
981: hmac-sha2-256
982: .It
983: hmac-sha2-512
984: .It
985: umac-64@openssh.com
986: .It
987: umac-128@openssh.com
988: .It
989: hmac-md5-etm@openssh.com
990: .It
991: hmac-md5-96-etm@openssh.com
992: .It
993: hmac-sha1-etm@openssh.com
994: .It
995: hmac-sha1-96-etm@openssh.com
996: .It
997: hmac-sha2-256-etm@openssh.com
998: .It
999: hmac-sha2-512-etm@openssh.com
1000: .It
1001: umac-64-etm@openssh.com
1002: .It
1003: umac-128-etm@openssh.com
1004: .El
1005: .Pp
1.52 jmc 1006: The default is:
1.77 jmc 1007: .Bd -literal -offset indent
1.152 markus 1008: umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1009: hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
1.217 djm 1010: hmac-sha1-etm@openssh.com,
1.173 naddy 1011: umac-64@openssh.com,umac-128@openssh.com,
1.217 djm 1012: hmac-sha2-256,hmac-sha2-512,hmac-sha1
1.77 jmc 1013: .Ed
1.188 djm 1014: .Pp
1.237 jmc 1015: The list of available MAC algorithms may also be obtained using
1016: .Qq ssh -Q mac .
1.60 dtucker 1017: .It Cm Match
1.61 jmc 1018: Introduces a conditional block.
1.65 dtucker 1019: If all of the criteria on the
1.60 dtucker 1020: .Cm Match
1.65 dtucker 1021: line are satisfied, the keywords on the following lines override those
1022: set in the global section of the config file, until either another
1.60 dtucker 1023: .Cm Match
1.65 dtucker 1024: line or the end of the file.
1.172 djm 1025: If a keyword appears in multiple
1026: .Cm Match
1.177 sobrado 1027: blocks that are satisfied, only the first instance of the keyword is
1.172 djm 1028: applied.
1.91 djm 1029: .Pp
1.61 jmc 1030: The arguments to
1.60 dtucker 1031: .Cm Match
1.163 dtucker 1032: are one or more criteria-pattern pairs or the single token
1033: .Cm All
1034: which matches all criteria.
1.60 dtucker 1035: The available criteria are
1036: .Cm User ,
1.69 dtucker 1037: .Cm Group ,
1.60 dtucker 1038: .Cm Host ,
1.139 dtucker 1039: .Cm LocalAddress ,
1040: .Cm LocalPort ,
1.60 dtucker 1041: and
1042: .Cm Address .
1.91 djm 1043: The match patterns may consist of single entries or comma-separated
1044: lists and may use the wildcard and negation operators described in the
1.237 jmc 1045: .Sx PATTERNS
1046: section of
1.92 djm 1047: .Xr ssh_config 5 .
1.91 djm 1048: .Pp
1049: The patterns in an
1050: .Cm Address
1051: criteria may additionally contain addresses to match in CIDR
1.237 jmc 1052: address/masklen format,
1053: such as 192.0.2.0/24 or 2001:db8::/32.
1.91 djm 1054: Note that the mask length provided must be consistent with the address -
1055: it is an error to specify a mask length that is too long for the address
1.93 jmc 1056: or one with bits set in this host portion of the address.
1.237 jmc 1057: For example, 192.0.2.0/33 and 192.0.2.0/8, respectively.
1.91 djm 1058: .Pp
1.60 dtucker 1059: Only a subset of keywords may be used on the lines following a
1060: .Cm Match
1061: keyword.
1062: Available keywords are
1.142 jmc 1063: .Cm AcceptEnv ,
1.99 okan 1064: .Cm AllowAgentForwarding ,
1.142 jmc 1065: .Cm AllowGroups ,
1.193 djm 1066: .Cm AllowStreamLocalForwarding ,
1.62 dtucker 1067: .Cm AllowTcpForwarding ,
1.141 markus 1068: .Cm AllowUsers ,
1.149 djm 1069: .Cm AuthenticationMethods ,
1.146 djm 1070: .Cm AuthorizedKeysCommand ,
1071: .Cm AuthorizedKeysCommandUser ,
1.147 jmc 1072: .Cm AuthorizedKeysFile ,
1.214 djm 1073: .Cm AuthorizedPrincipalsCommand ,
1074: .Cm AuthorizedPrincipalsCommandUser ,
1.123 djm 1075: .Cm AuthorizedPrincipalsFile ,
1.72 dtucker 1076: .Cm Banner ,
1.85 djm 1077: .Cm ChrootDirectory ,
1.238 markus 1078: .Cm ClientAliveCountMax ,
1079: .Cm ClientAliveInterval ,
1.141 markus 1080: .Cm DenyGroups ,
1081: .Cm DenyUsers ,
1.67 dtucker 1082: .Cm ForceCommand ,
1.194 djm 1083: .Cm GatewayPorts ,
1.193 djm 1084: .Cm GSSAPIAuthentication ,
1.189 djm 1085: .Cm HostbasedAcceptedKeyTypes ,
1.87 djm 1086: .Cm HostbasedAuthentication ,
1.123 djm 1087: .Cm HostbasedUsesNameFromPacketOnly ,
1.193 djm 1088: .Cm IPQoS ,
1.74 jmc 1089: .Cm KbdInteractiveAuthentication ,
1.72 dtucker 1090: .Cm KerberosAuthentication ,
1.245 djm 1091: .Cm LogLevel ,
1.95 dtucker 1092: .Cm MaxAuthTries ,
1.94 dtucker 1093: .Cm MaxSessions ,
1.72 dtucker 1094: .Cm PasswordAuthentication ,
1.97 djm 1095: .Cm PermitEmptyPasswords ,
1.66 dtucker 1096: .Cm PermitOpen ,
1.79 dtucker 1097: .Cm PermitRootLogin ,
1.164 djm 1098: .Cm PermitTTY ,
1.123 djm 1099: .Cm PermitTunnel ,
1.174 djm 1100: .Cm PermitUserRC ,
1.189 djm 1101: .Cm PubkeyAcceptedKeyTypes ,
1.107 dtucker 1102: .Cm PubkeyAuthentication ,
1.159 dtucker 1103: .Cm RekeyLimit ,
1.193 djm 1104: .Cm RevokedKeys ,
1105: .Cm StreamLocalBindMask ,
1106: .Cm StreamLocalBindUnlink ,
1107: .Cm TrustedUserCAKeys ,
1.66 dtucker 1108: .Cm X11DisplayOffset ,
1.101 djm 1109: .Cm X11Forwarding
1.60 dtucker 1110: and
1.102 djm 1111: .Cm X11UseLocalHost .
1.33 dtucker 1112: .It Cm MaxAuthTries
1113: Specifies the maximum number of authentication attempts permitted per
1.35 jmc 1114: connection.
1115: Once the number of failures reaches half this value,
1116: additional failures are logged.
1117: The default is 6.
1.90 djm 1118: .It Cm MaxSessions
1.216 djm 1119: Specifies the maximum number of open shell, login or subsystem (e.g. sftp)
1120: sessions permitted per network connection.
1121: Multiple sessions may be established by clients that support connection
1122: multiplexing.
1123: Setting
1124: .Cm MaxSessions
1125: to 1 will effectively disable session multiplexing, whereas setting it to 0
1126: will prevent all shell, login and subsystem sessions while still permitting
1127: forwarding.
1.90 djm 1128: The default is 10.
1.1 stevesk 1129: .It Cm MaxStartups
1130: Specifies the maximum number of concurrent unauthenticated connections to the
1.52 jmc 1131: SSH daemon.
1.1 stevesk 1132: Additional connections will be dropped until authentication succeeds or the
1133: .Cm LoginGraceTime
1134: expires for a connection.
1.156 dtucker 1135: The default is 10:30:100.
1.1 stevesk 1136: .Pp
1137: Alternatively, random early drop can be enabled by specifying
1138: the three colon separated values
1.237 jmc 1139: start:rate:full (e.g. "10:30:60").
1.53 jmc 1140: .Xr sshd 8
1.237 jmc 1141: will refuse connection attempts with a probability of rate/100 (30%)
1142: if there are currently start (10) unauthenticated connections.
1.1 stevesk 1143: The probability increases linearly and all connection attempts
1.237 jmc 1144: are refused if the number of unauthenticated connections reaches full (60).
1.1 stevesk 1145: .It Cm PasswordAuthentication
1146: Specifies whether password authentication is allowed.
1147: The default is
1.237 jmc 1148: .Cm yes .
1.1 stevesk 1149: .It Cm PermitEmptyPasswords
1150: When password authentication is allowed, it specifies whether the
1151: server allows login to accounts with empty password strings.
1152: The default is
1.237 jmc 1153: .Cm no .
1.62 dtucker 1154: .It Cm PermitOpen
1155: Specifies the destinations to which TCP port forwarding is permitted.
1156: The forwarding specification must be one of the following forms:
1157: .Pp
1158: .Bl -item -offset indent -compact
1159: .It
1160: .Cm PermitOpen
1161: .Sm off
1162: .Ar host : port
1163: .Sm on
1164: .It
1165: .Cm PermitOpen
1166: .Sm off
1167: .Ar IPv4_addr : port
1168: .Sm on
1169: .It
1170: .Cm PermitOpen
1171: .Sm off
1172: .Ar \&[ IPv6_addr \&] : port
1173: .Sm on
1174: .El
1175: .Pp
1.68 dtucker 1176: Multiple forwards may be specified by separating them with whitespace.
1.62 dtucker 1177: An argument of
1.237 jmc 1178: .Cm any
1.62 dtucker 1179: can be used to remove all restrictions and permit any forwarding requests.
1.140 dtucker 1180: An argument of
1.237 jmc 1181: .Cm none
1.140 dtucker 1182: can be used to prohibit all forwarding requests.
1.227 jmc 1183: The wildcard
1.237 jmc 1184: .Sq *
1.227 jmc 1185: can be used for host or port to allow all hosts or ports, respectively.
1.63 jmc 1186: By default all port forwarding requests are permitted.
1.1 stevesk 1187: .It Cm PermitRootLogin
1.38 jmc 1188: Specifies whether root can log in using
1.1 stevesk 1189: .Xr ssh 1 .
1190: The argument must be
1.237 jmc 1191: .Cm yes ,
1192: .Cm prohibit-password ,
1193: .Cm without-password ,
1194: .Cm forced-commands-only ,
1.1 stevesk 1195: or
1.237 jmc 1196: .Cm no .
1.1 stevesk 1197: The default is
1.237 jmc 1198: .Cm prohibit-password .
1.1 stevesk 1199: .Pp
1200: If this option is set to
1.237 jmc 1201: .Cm prohibit-password
1.210 deraadt 1202: or
1.237 jmc 1203: .Cm without-password ,
1.210 deraadt 1204: password and keyboard-interactive authentication are disabled for root.
1.1 stevesk 1205: .Pp
1206: If this option is set to
1.237 jmc 1207: .Cm forced-commands-only ,
1.1 stevesk 1208: root login with public key authentication will be allowed,
1209: but only if the
1210: .Ar command
1211: option has been specified
1212: (which may be useful for taking remote backups even if root login is
1.17 jmc 1213: normally not allowed).
1214: All other authentication methods are disabled for root.
1.1 stevesk 1215: .Pp
1216: If this option is set to
1.237 jmc 1217: .Cm no ,
1.38 jmc 1218: root is not allowed to log in.
1.231 jmc 1219: .It Cm PermitTTY
1220: Specifies whether
1221: .Xr pty 4
1222: allocation is permitted.
1223: The default is
1.237 jmc 1224: .Cm yes .
1.46 reyk 1225: .It Cm PermitTunnel
1226: Specifies whether
1227: .Xr tun 4
1228: device forwarding is allowed.
1.47 reyk 1229: The argument must be
1.237 jmc 1230: .Cm yes ,
1231: .Cm point-to-point
1.58 stevesk 1232: (layer 3),
1.237 jmc 1233: .Cm ethernet
1.58 stevesk 1234: (layer 2), or
1.237 jmc 1235: .Cm no .
1.58 stevesk 1236: Specifying
1.237 jmc 1237: .Cm yes
1.58 stevesk 1238: permits both
1.237 jmc 1239: .Cm point-to-point
1.58 stevesk 1240: and
1.237 jmc 1241: .Cm ethernet .
1.46 reyk 1242: The default is
1.237 jmc 1243: .Cm no .
1.178 djm 1244: .Pp
1245: Independent of this setting, the permissions of the selected
1246: .Xr tun 4
1247: device must allow access to the user.
1.6 markus 1248: .It Cm PermitUserEnvironment
1249: Specifies whether
1250: .Pa ~/.ssh/environment
1.9 stevesk 1251: and
1.6 markus 1252: .Cm environment=
1253: options in
1254: .Pa ~/.ssh/authorized_keys
1.9 stevesk 1255: are processed by
1.52 jmc 1256: .Xr sshd 8 .
1.6 markus 1257: The default is
1.237 jmc 1258: .Cm no .
1.9 stevesk 1259: Enabling environment processing may enable users to bypass access
1260: restrictions in some configurations using mechanisms such as
1261: .Ev LD_PRELOAD .
1.174 djm 1262: .It Cm PermitUserRC
1263: Specifies whether any
1264: .Pa ~/.ssh/rc
1265: file is executed.
1266: The default is
1.237 jmc 1267: .Cm yes .
1.1 stevesk 1268: .It Cm PidFile
1.4 stevesk 1269: Specifies the file that contains the process ID of the
1.195 dtucker 1270: SSH daemon, or
1.237 jmc 1271: .Cm none
1.195 dtucker 1272: to not write one.
1.1 stevesk 1273: The default is
1274: .Pa /var/run/sshd.pid .
1275: .It Cm Port
1276: Specifies the port number that
1.52 jmc 1277: .Xr sshd 8
1.1 stevesk 1278: listens on.
1279: The default is 22.
1280: Multiple options of this type are permitted.
1281: See also
1282: .Cm ListenAddress .
1283: .It Cm PrintLastLog
1284: Specifies whether
1.52 jmc 1285: .Xr sshd 8
1.36 jaredy 1286: should print the date and time of the last user login when a user logs
1287: in interactively.
1.1 stevesk 1288: The default is
1.237 jmc 1289: .Cm yes .
1.1 stevesk 1290: .It Cm PrintMotd
1291: Specifies whether
1.52 jmc 1292: .Xr sshd 8
1.1 stevesk 1293: should print
1294: .Pa /etc/motd
1295: when a user logs in interactively.
1296: (On some systems it is also printed by the shell,
1297: .Pa /etc/profile ,
1298: or equivalent.)
1299: The default is
1.237 jmc 1300: .Cm yes .
1.189 djm 1301: .It Cm PubkeyAcceptedKeyTypes
1302: Specifies the key types that will be accepted for public key authentication
1303: as a comma-separated pattern list.
1.208 djm 1304: Alternately if the specified value begins with a
1305: .Sq +
1306: character, then the specified key types will be appended to the default set
1307: instead of replacing them.
1.242 djm 1308: If the specified value begins with a
1309: .Sq -
1310: character, then the specified key types (including wildcards) will be removed
1311: from the default set instead of replacing them.
1.206 markus 1312: The default for this option is:
1313: .Bd -literal -offset 3n
1314: ecdsa-sha2-nistp256-cert-v01@openssh.com,
1315: ecdsa-sha2-nistp384-cert-v01@openssh.com,
1316: ecdsa-sha2-nistp521-cert-v01@openssh.com,
1317: ssh-ed25519-cert-v01@openssh.com,
1318: ssh-rsa-cert-v01@openssh.com,
1319: ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1.220 djm 1320: ssh-ed25519,ssh-rsa
1.206 markus 1321: .Ed
1322: .Pp
1.237 jmc 1323: The list of available key types may also be obtained using
1324: .Qq ssh -Q key .
1.1 stevesk 1325: .It Cm PubkeyAuthentication
1326: Specifies whether public key authentication is allowed.
1327: The default is
1.237 jmc 1328: .Cm yes .
1.159 dtucker 1329: .It Cm RekeyLimit
1330: Specifies the maximum amount of data that may be transmitted before the
1331: session key is renegotiated, optionally followed a maximum amount of
1332: time that may pass before the session key is renegotiated.
1333: The first argument is specified in bytes and may have a suffix of
1334: .Sq K ,
1335: .Sq M ,
1336: or
1337: .Sq G
1338: to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1339: The default is between
1340: .Sq 1G
1341: and
1342: .Sq 4G ,
1343: depending on the cipher.
1344: The optional second value is specified in seconds and may use any of the
1345: units documented in the
1346: .Sx TIME FORMATS
1.160 jmc 1347: section.
1.159 dtucker 1348: The default value for
1349: .Cm RekeyLimit
1350: is
1.237 jmc 1351: .Cm default none ,
1.159 dtucker 1352: which means that rekeying is performed after the cipher's default amount
1353: of data has been sent or received and no time based rekeying is done.
1.118 djm 1354: .It Cm RevokedKeys
1.195 dtucker 1355: Specifies revoked public keys file, or
1.237 jmc 1356: .Cm none
1.195 dtucker 1357: to not use one.
1.118 djm 1358: Keys listed in this file will be refused for public key authentication.
1359: Note that if this file is not readable, then public key authentication will
1360: be refused for all users.
1.154 djm 1361: Keys may be specified as a text file, listing one public key per line, or as
1362: an OpenSSH Key Revocation List (KRL) as generated by
1.155 jmc 1363: .Xr ssh-keygen 1 .
1.161 jmc 1364: For more information on KRLs, see the KEY REVOCATION LISTS section in
1.154 djm 1365: .Xr ssh-keygen 1 .
1.175 millert 1366: .It Cm StreamLocalBindMask
1367: Sets the octal file creation mode mask
1368: .Pq umask
1369: used when creating a Unix-domain socket file for local or remote
1370: port forwarding.
1371: This option is only used for port forwarding to a Unix-domain socket file.
1372: .Pp
1373: The default value is 0177, which creates a Unix-domain socket file that is
1374: readable and writable only by the owner.
1375: Note that not all operating systems honor the file mode on Unix-domain
1376: socket files.
1377: .It Cm StreamLocalBindUnlink
1378: Specifies whether to remove an existing Unix-domain socket file for local
1379: or remote port forwarding before creating a new one.
1380: If the socket file already exists and
1381: .Cm StreamLocalBindUnlink
1382: is not enabled,
1383: .Nm sshd
1384: will be unable to forward the port to the Unix-domain socket file.
1385: This option is only used for port forwarding to a Unix-domain socket file.
1386: .Pp
1387: The argument must be
1.237 jmc 1388: .Cm yes
1.175 millert 1389: or
1.237 jmc 1390: .Cm no .
1.175 millert 1391: The default is
1.237 jmc 1392: .Cm no .
1.1 stevesk 1393: .It Cm StrictModes
1394: Specifies whether
1.52 jmc 1395: .Xr sshd 8
1.1 stevesk 1396: should check file modes and ownership of the
1397: user's files and home directory before accepting login.
1398: This is normally desirable because novices sometimes accidentally leave their
1399: directory or files world-writable.
1400: The default is
1.237 jmc 1401: .Cm yes .
1.112 djm 1402: Note that this does not apply to
1403: .Cm ChrootDirectory ,
1404: whose permissions and ownership are checked unconditionally.
1.1 stevesk 1405: .It Cm Subsystem
1.51 jmc 1406: Configures an external subsystem (e.g. file transfer daemon).
1.59 djm 1407: Arguments should be a subsystem name and a command (with optional arguments)
1408: to execute upon subsystem request.
1.80 djm 1409: .Pp
1.1 stevesk 1410: The command
1.237 jmc 1411: .Cm sftp-server
1412: implements the SFTP file transfer subsystem.
1.80 djm 1413: .Pp
1414: Alternately the name
1.237 jmc 1415: .Cm internal-sftp
1416: implements an in-process SFTP server.
1.80 djm 1417: This may simplify configurations using
1418: .Cm ChrootDirectory
1419: to force a different filesystem root on clients.
1420: .Pp
1.1 stevesk 1421: By default no subsystems are defined.
1422: .It Cm SyslogFacility
1423: Gives the facility code that is used when logging messages from
1.53 jmc 1424: .Xr sshd 8 .
1.1 stevesk 1425: The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
1426: LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
1427: The default is AUTH.
1.27 markus 1428: .It Cm TCPKeepAlive
1429: Specifies whether the system should send TCP keepalive messages to the
1430: other side.
1431: If they are sent, death of the connection or crash of one
1432: of the machines will be properly noticed.
1433: However, this means that
1434: connections will die if the route is down temporarily, and some people
1435: find it annoying.
1436: On the other hand, if TCP keepalives are not sent,
1437: sessions may hang indefinitely on the server, leaving
1.237 jmc 1438: .Qq ghost
1.27 markus 1439: users and consuming server resources.
1440: .Pp
1441: The default is
1.237 jmc 1442: .Cm yes
1.27 markus 1443: (to send TCP keepalive messages), and the server will notice
1444: if the network goes down or the client host crashes.
1445: This avoids infinitely hanging sessions.
1446: .Pp
1447: To disable TCP keepalive messages, the value should be set to
1.237 jmc 1448: .Cm no .
1.118 djm 1449: .It Cm TrustedUserCAKeys
1450: Specifies a file containing public keys of certificate authorities that are
1.195 dtucker 1451: trusted to sign user certificates for authentication, or
1.237 jmc 1452: .Cm none
1.195 dtucker 1453: to not use one.
1.119 jmc 1454: Keys are listed one per line; empty lines and comments starting with
1.118 djm 1455: .Ql #
1456: are allowed.
1457: If a certificate is presented for authentication and has its signing CA key
1458: listed in this file, then it may be used for authentication for any user
1459: listed in the certificate's principals list.
1460: Note that certificates that lack a list of principals will not be permitted
1461: for authentication using
1462: .Cm TrustedUserCAKeys .
1.161 jmc 1463: For more details on certificates, see the CERTIFICATES section in
1.118 djm 1464: .Xr ssh-keygen 1 .
1.18 markus 1465: .It Cm UseDNS
1466: Specifies whether
1.52 jmc 1467: .Xr sshd 8
1.207 djm 1468: should look up the remote host name, and to check that
1.18 markus 1469: the resolved host name for the remote IP address maps back to the
1470: very same IP address.
1.207 djm 1471: .Pp
1472: If this option is set to
1.237 jmc 1473: .Cm no
1.207 djm 1474: (the default) then only addresses and not host names may be used in
1.221 djm 1475: .Pa ~/.ssh/authorized_keys
1.207 djm 1476: .Cm from
1477: and
1.211 jmc 1478: .Nm
1.207 djm 1479: .Cm Match
1480: .Cm Host
1481: directives.
1.137 djm 1482: .It Cm VersionAddendum
1483: Optionally specifies additional text to append to the SSH protocol banner
1484: sent by the server upon connection.
1485: The default is
1.237 jmc 1486: .Cm none .
1.1 stevesk 1487: .It Cm X11DisplayOffset
1488: Specifies the first display number available for
1.52 jmc 1489: .Xr sshd 8 Ns 's
1.1 stevesk 1490: X11 forwarding.
1.52 jmc 1491: This prevents sshd from interfering with real X11 servers.
1.1 stevesk 1492: The default is 10.
1493: .It Cm X11Forwarding
1494: Specifies whether X11 forwarding is permitted.
1.13 stevesk 1495: The argument must be
1.237 jmc 1496: .Cm yes
1.13 stevesk 1497: or
1.237 jmc 1498: .Cm no .
1.1 stevesk 1499: The default is
1.237 jmc 1500: .Cm no .
1.13 stevesk 1501: .Pp
1502: When X11 forwarding is enabled, there may be additional exposure to
1503: the server and to client displays if the
1.52 jmc 1504: .Xr sshd 8
1.13 stevesk 1505: proxy display is configured to listen on the wildcard address (see
1.237 jmc 1506: .Cm X11UseLocalhost ) ,
1507: though this is not the default.
1.13 stevesk 1508: Additionally, the authentication spoofing and authentication data
1509: verification and substitution occur on the client side.
1510: The security risk of using X11 forwarding is that the client's X11
1.52 jmc 1511: display server may be exposed to attack when the SSH client requests
1.13 stevesk 1512: forwarding (see the warnings for
1513: .Cm ForwardX11
1514: in
1.19 jmc 1515: .Xr ssh_config 5 ) .
1.13 stevesk 1516: A system administrator may have a stance in which they want to
1517: protect clients that may expose themselves to attack by unwittingly
1518: requesting X11 forwarding, which can warrant a
1.237 jmc 1519: .Cm no
1.13 stevesk 1520: setting.
1521: .Pp
1522: Note that disabling X11 forwarding does not prevent users from
1523: forwarding X11 traffic, as users can always install their own forwarders.
1.1 stevesk 1524: .It Cm X11UseLocalhost
1525: Specifies whether
1.52 jmc 1526: .Xr sshd 8
1.1 stevesk 1527: should bind the X11 forwarding server to the loopback address or to
1.15 jmc 1528: the wildcard address.
1529: By default,
1.52 jmc 1530: sshd binds the forwarding server to the loopback address and sets the
1.1 stevesk 1531: hostname part of the
1532: .Ev DISPLAY
1533: environment variable to
1.237 jmc 1534: .Cm localhost .
1.8 stevesk 1535: This prevents remote hosts from connecting to the proxy display.
1.1 stevesk 1536: However, some older X11 clients may not function with this
1537: configuration.
1538: .Cm X11UseLocalhost
1539: may be set to
1.237 jmc 1540: .Cm no
1.1 stevesk 1541: to specify that the forwarding server should be bound to the wildcard
1542: address.
1543: The argument must be
1.237 jmc 1544: .Cm yes
1.1 stevesk 1545: or
1.237 jmc 1546: .Cm no .
1.1 stevesk 1547: The default is
1.237 jmc 1548: .Cm yes .
1.1 stevesk 1549: .It Cm XAuthLocation
1.11 stevesk 1550: Specifies the full pathname of the
1.1 stevesk 1551: .Xr xauth 1
1.195 dtucker 1552: program, or
1.237 jmc 1553: .Cm none
1.195 dtucker 1554: to not use one.
1.1 stevesk 1555: The default is
1556: .Pa /usr/X11R6/bin/xauth .
1557: .El
1.55 jmc 1558: .Sh TIME FORMATS
1.53 jmc 1559: .Xr sshd 8
1.1 stevesk 1560: command-line arguments and configuration file options that specify time
1561: may be expressed using a sequence of the form:
1562: .Sm off
1.7 stevesk 1563: .Ar time Op Ar qualifier ,
1.1 stevesk 1564: .Sm on
1565: where
1566: .Ar time
1567: is a positive integer value and
1568: .Ar qualifier
1569: is one of the following:
1570: .Pp
1571: .Bl -tag -width Ds -compact -offset indent
1.64 jmc 1572: .It Aq Cm none
1.1 stevesk 1573: seconds
1574: .It Cm s | Cm S
1575: seconds
1576: .It Cm m | Cm M
1577: minutes
1578: .It Cm h | Cm H
1579: hours
1580: .It Cm d | Cm D
1581: days
1582: .It Cm w | Cm W
1583: weeks
1584: .El
1585: .Pp
1586: Each member of the sequence is added together to calculate
1587: the total time value.
1588: .Pp
1589: Time format examples:
1590: .Pp
1591: .Bl -tag -width Ds -compact -offset indent
1592: .It 600
1593: 600 seconds (10 minutes)
1594: .It 10m
1595: 10 minutes
1596: .It 1h30m
1597: 1 hour 30 minutes (90 minutes)
1598: .El
1.235 jmc 1599: .Sh TOKENS
1600: Arguments to some keywords can make use of tokens,
1601: which are expanded at runtime:
1602: .Pp
1603: .Bl -tag -width XXXX -offset indent -compact
1604: .It %%
1605: A literal
1606: .Sq % .
1607: .It %F
1608: The fingerprint of the CA key.
1609: .It %f
1610: The fingerprint of the key or certificate.
1611: .It %h
1612: The home directory of the user.
1613: .It %i
1614: The key ID in the certificate.
1615: .It %K
1616: The base64-encoded CA key.
1617: .It %k
1618: The base64-encoded key or certificate for authentication.
1619: .It %s
1620: The serial number of the certificate.
1621: .It \&%T
1622: The type of the CA key.
1623: .It %t
1624: The key or certificate type.
1625: .It %u
1626: The username.
1627: .El
1628: .Pp
1629: .Cm AuthorizedKeysCommand
1.241 jmc 1630: accepts the tokens %%, %f, %h, %k, %t, and %u.
1.235 jmc 1631: .Pp
1632: .Cm AuthorizedKeysFile
1633: accepts the tokens %%, %h, and %u.
1634: .Pp
1635: .Cm AuthorizedPrincipalsCommand
1.241 jmc 1636: accepts the tokens %%, %F, %f, %h, %i, %K, %k, %s, %T, %t, and %u.
1.235 jmc 1637: .Pp
1638: .Cm AuthorizedPrincipalsFile
1639: accepts the tokens %%, %h, and %u.
1640: .Pp
1641: .Cm ChrootDirectory
1642: accepts the tokens %%, %h, and %u.
1.1 stevesk 1643: .Sh FILES
1644: .Bl -tag -width Ds
1645: .It Pa /etc/ssh/sshd_config
1646: Contains configuration data for
1.53 jmc 1647: .Xr sshd 8 .
1.1 stevesk 1648: This file should be writable by root only, but it is recommended
1649: (though not necessary) that it be world-readable.
1650: .El
1.19 jmc 1651: .Sh SEE ALSO
1.237 jmc 1652: .Xr sftp-server 8 ,
1.19 jmc 1653: .Xr sshd 8
1.1 stevesk 1654: .Sh AUTHORS
1.237 jmc 1655: .An -nosplit
1.1 stevesk 1656: OpenSSH is a derivative of the original and free
1.237 jmc 1657: ssh 1.2.12 release by
1658: .An Tatu Ylonen .
1659: .An Aaron Campbell , Bob Beck , Markus Friedl , Niels Provos ,
1660: .An Theo de Raadt
1661: and
1662: .An Dug Song
1.1 stevesk 1663: removed many bugs, re-added newer features and
1664: created OpenSSH.
1.237 jmc 1665: .An Markus Friedl
1666: contributed the support for SSH protocol versions 1.5 and 2.0.
1667: .An Niels Provos
1668: and
1669: .An Markus Friedl
1670: contributed support for privilege separation.