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