Annotation of src/usr.bin/ssh/sshd_config.5, Revision 1.133
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.133 ! jmc 36: .\" $OpenBSD: sshd_config.5,v 1.132 2011/05/23 03:30:07 djm Exp $
! 37: .Dd $Mdocdate: May 23 2011 $
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 SYNOPSIS
1.71 jmc 44: .Nm /etc/ssh/sshd_config
1.1 stevesk 45: .Sh DESCRIPTION
1.53 jmc 46: .Xr sshd 8
1.1 stevesk 47: reads configuration data from
48: .Pa /etc/ssh/sshd_config
49: (or the file specified with
50: .Fl f
51: on the command line).
52: The file contains keyword-argument pairs, one per line.
53: Lines starting with
54: .Ql #
55: and empty lines are interpreted as comments.
1.56 dtucker 56: Arguments may optionally be enclosed in double quotes
57: .Pq \&"
58: in order to represent arguments containing spaces.
1.1 stevesk 59: .Pp
60: The possible
61: keywords and their meanings are as follows (note that
62: keywords are case-insensitive and arguments are case-sensitive):
63: .Bl -tag -width Ds
1.30 djm 64: .It Cm AcceptEnv
65: Specifies what environment variables sent by the client will be copied into
66: the session's
67: .Xr environ 7 .
68: See
69: .Cm SendEnv
70: in
71: .Xr ssh_config 5
72: for how to configure the client.
1.31 djm 73: Note that environment passing is only supported for protocol 2.
1.30 djm 74: Variables are specified by name, which may contain the wildcard characters
1.51 jmc 75: .Ql *
1.30 djm 76: and
77: .Ql \&? .
1.31 djm 78: Multiple environment variables may be separated by whitespace or spread
1.30 djm 79: across multiple
80: .Cm AcceptEnv
81: directives.
1.31 djm 82: Be warned that some environment variables could be used to bypass restricted
1.30 djm 83: user environments.
84: For this reason, care should be taken in the use of this directive.
85: The default is not to accept any environment variables.
1.37 djm 86: .It Cm AddressFamily
87: Specifies which address family should be used by
1.53 jmc 88: .Xr sshd 8 .
1.37 djm 89: Valid arguments are
90: .Dq any ,
91: .Dq inet
1.52 jmc 92: (use IPv4 only), or
1.37 djm 93: .Dq inet6
94: (use IPv6 only).
95: The default is
96: .Dq any .
1.89 jmc 97: .It Cm AllowAgentForwarding
98: Specifies whether
99: .Xr ssh-agent 1
100: forwarding is permitted.
101: The default is
102: .Dq yes .
103: Note that disabling agent forwarding does not improve security
104: unless users are also denied shell access, as they can always install
105: their own forwarders.
1.1 stevesk 106: .It Cm AllowGroups
107: This keyword can be followed by a list of group name patterns, separated
108: by spaces.
109: If specified, login is allowed only for users whose primary
110: group or supplementary group list matches one of the patterns.
111: Only group names are valid; a numerical group ID is not recognized.
112: By default, login is allowed for all groups.
1.54 jmc 113: The allow/deny directives are processed in the following order:
114: .Cm DenyUsers ,
115: .Cm AllowUsers ,
116: .Cm DenyGroups ,
117: and finally
118: .Cm AllowGroups .
1.49 jmc 119: .Pp
120: See
121: .Sx PATTERNS
122: in
123: .Xr ssh_config 5
124: for more information on patterns.
1.1 stevesk 125: .It Cm AllowTcpForwarding
126: Specifies whether TCP forwarding is permitted.
127: The default is
128: .Dq yes .
129: Note that disabling TCP forwarding does not improve security unless
130: users are also denied shell access, as they can always install their
131: own forwarders.
132: .It Cm AllowUsers
133: This keyword can be followed by a list of user name patterns, separated
134: by spaces.
1.14 jmc 135: If specified, login is allowed only for user names that
1.1 stevesk 136: match one of the patterns.
137: Only user names are valid; a numerical user ID is not recognized.
138: By default, login is allowed for all users.
139: If the pattern takes the form USER@HOST then USER and HOST
140: are separately checked, restricting logins to particular
141: users from particular hosts.
1.54 jmc 142: The allow/deny directives are processed in the following order:
143: .Cm DenyUsers ,
144: .Cm AllowUsers ,
145: .Cm DenyGroups ,
146: and finally
147: .Cm AllowGroups .
1.49 jmc 148: .Pp
149: See
150: .Sx PATTERNS
151: in
152: .Xr ssh_config 5
153: for more information on patterns.
1.1 stevesk 154: .It Cm AuthorizedKeysFile
155: Specifies the file that contains the public keys that can be used
156: for user authentication.
1.124 djm 157: The format is described in the
158: .Sx AUTHORIZED_KEYS FILE FORMAT
159: section of
160: .Xr sshd 8 .
1.1 stevesk 161: .Cm AuthorizedKeysFile
162: may contain tokens of the form %T which are substituted during connection
1.52 jmc 163: setup.
1.17 jmc 164: The following tokens are defined: %% is replaced by a literal '%',
1.52 jmc 165: %h is replaced by the home directory of the user being authenticated, and
1.1 stevesk 166: %u is replaced by the username of that user.
167: After expansion,
168: .Cm AuthorizedKeysFile
169: is taken to be an absolute path or one relative to the user's home
170: directory.
1.133 ! jmc 171: Multiple files may be listed, separated by whitespace.
! 172: The default is
! 173: .Dq .ssh/authorized_keys .ssh/authorized_keys2 .
1.121 djm 174: .It Cm AuthorizedPrincipalsFile
175: Specifies a file that lists principal names that are accepted for
176: certificate authentication.
177: When using certificates signed by a key listed in
178: .Cm TrustedUserCAKeys ,
179: this file lists names, one of which must appear in the certificate for it
180: to be accepted for authentication.
1.125 jmc 181: Names are listed one per line preceded by key options (as described
1.124 djm 182: in
183: .Sx AUTHORIZED_KEYS FILE FORMAT
184: in
1.125 jmc 185: .Xr sshd 8 ) .
1.124 djm 186: Empty lines and comments starting with
1.121 djm 187: .Ql #
188: are ignored.
189: .Pp
190: .Cm AuthorizedPrincipalsFile
191: may contain tokens of the form %T which are substituted during connection
192: setup.
193: The following tokens are defined: %% is replaced by a literal '%',
194: %h is replaced by the home directory of the user being authenticated, and
195: %u is replaced by the username of that user.
196: After expansion,
197: .Cm AuthorizedPrincipalsFile
198: is taken to be an absolute path or one relative to the user's home
199: directory.
200: .Pp
1.122 jmc 201: The default is not to use a principals file \(en in this case, the username
1.121 djm 202: of the user must appear in a certificate's principals list for it to be
203: accepted.
204: Note that
205: .Cm AuthorizedPrincipalsFile
206: is only used when authentication proceeds using a CA listed in
207: .Cm TrustedUserCAKeys
208: and is not consulted for certification authorities trusted via
209: .Pa ~/.ssh/authorized_keys ,
210: though the
211: .Cm principals=
212: key option offers a similar facility (see
213: .Xr sshd 8
214: for details).
1.1 stevesk 215: .It Cm Banner
216: The contents of the specified file are sent to the remote user before
217: authentication is allowed.
1.78 djm 218: If the argument is
219: .Dq none
220: then no banner is displayed.
1.1 stevesk 221: This option is only available for protocol version 2.
222: By default, no banner is displayed.
223: .It Cm ChallengeResponseAuthentication
1.50 jmc 224: Specifies whether challenge-response authentication is allowed.
1.1 stevesk 225: All authentication styles from
226: .Xr login.conf 5
227: are supported.
228: The default is
229: .Dq yes .
1.80 djm 230: .It Cm ChrootDirectory
1.113 stevesk 231: Specifies the pathname of a directory to
1.80 djm 232: .Xr chroot 2
233: to after authentication.
1.113 stevesk 234: All components of the pathname must be root-owned directories that are
1.80 djm 235: not writable by any other user or group.
1.106 stevesk 236: After the chroot,
237: .Xr sshd 8
238: changes the working directory to the user's home directory.
1.80 djm 239: .Pp
1.113 stevesk 240: The pathname may contain the following tokens that are expanded at runtime once
1.80 djm 241: the connecting user has been authenticated: %% is replaced by a literal '%',
242: %h is replaced by the home directory of the user being authenticated, and
243: %u is replaced by the username of that user.
244: .Pp
245: The
246: .Cm ChrootDirectory
247: must contain the necessary files and directories to support the
1.103 stevesk 248: user's session.
1.80 djm 249: For an interactive session this requires at least a shell, typically
250: .Xr sh 1 ,
251: and basic
252: .Pa /dev
253: nodes such as
254: .Xr null 4 ,
255: .Xr zero 4 ,
256: .Xr stdin 4 ,
257: .Xr stdout 4 ,
258: .Xr stderr 4 ,
259: .Xr arandom 4
260: and
261: .Xr tty 4
262: devices.
263: For file transfer sessions using
1.105 jmc 264: .Dq sftp ,
1.80 djm 265: no additional configuration of the environment is necessary if the
1.105 jmc 266: in-process sftp server is used,
267: though sessions which use logging do require
1.104 stevesk 268: .Pa /dev/log
269: inside the chroot directory (see
270: .Xr sftp-server 8
1.81 jmc 271: for details).
1.80 djm 272: .Pp
273: The default is not to
274: .Xr chroot 2 .
1.1 stevesk 275: .It Cm Ciphers
276: Specifies the ciphers allowed for protocol version 2.
277: Multiple ciphers must be comma-separated.
1.34 dtucker 278: The supported ciphers are
279: .Dq 3des-cbc ,
280: .Dq aes128-cbc ,
281: .Dq aes192-cbc ,
282: .Dq aes256-cbc ,
283: .Dq aes128-ctr ,
284: .Dq aes192-ctr ,
285: .Dq aes256-ctr ,
1.43 djm 286: .Dq arcfour128 ,
287: .Dq arcfour256 ,
1.34 dtucker 288: .Dq arcfour ,
289: .Dq blowfish-cbc ,
290: and
291: .Dq cast128-cbc .
1.52 jmc 292: The default is:
293: .Bd -literal -offset 3n
1.100 naddy 294: aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,
295: aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,
296: aes256-cbc,arcfour
1.1 stevesk 297: .Ed
298: .It Cm ClientAliveCountMax
1.48 jmc 299: Sets the number of client alive messages (see below) which may be
1.1 stevesk 300: sent without
1.52 jmc 301: .Xr sshd 8
1.17 jmc 302: receiving any messages back from the client.
303: If this threshold is reached while client alive messages are being sent,
1.52 jmc 304: sshd will disconnect the client, terminating the session.
1.17 jmc 305: It is important to note that the use of client alive messages is very
306: different from
1.27 markus 307: .Cm TCPKeepAlive
1.17 jmc 308: (below).
309: The client alive messages are sent through the encrypted channel
310: and therefore will not be spoofable.
311: The TCP keepalive option enabled by
1.27 markus 312: .Cm TCPKeepAlive
1.17 jmc 313: is spoofable.
314: The client alive mechanism is valuable when the client or
1.1 stevesk 315: server depend on knowing when a connection has become inactive.
316: .Pp
1.17 jmc 317: The default value is 3.
318: If
1.1 stevesk 319: .Cm ClientAliveInterval
1.48 jmc 320: (see below) is set to 15, and
1.1 stevesk 321: .Cm ClientAliveCountMax
1.52 jmc 322: is left at the default, unresponsive SSH clients
1.1 stevesk 323: will be disconnected after approximately 45 seconds.
1.57 markus 324: This option applies to protocol version 2 only.
1.42 djm 325: .It Cm ClientAliveInterval
326: Sets a timeout interval in seconds after which if no data has been received
327: from the client,
1.52 jmc 328: .Xr sshd 8
1.42 djm 329: will send a message through the encrypted
330: channel to request a response from the client.
331: The default
332: is 0, indicating that these messages will not be sent to the client.
333: This option applies to protocol version 2 only.
1.3 markus 334: .It Cm Compression
1.44 markus 335: Specifies whether compression is allowed, or delayed until
336: the user has authenticated successfully.
1.3 markus 337: The argument must be
1.44 markus 338: .Dq yes ,
339: .Dq delayed ,
1.3 markus 340: or
341: .Dq no .
342: The default is
1.44 markus 343: .Dq delayed .
1.1 stevesk 344: .It Cm DenyGroups
345: This keyword can be followed by a list of group name patterns, separated
346: by spaces.
347: Login is disallowed for users whose primary group or supplementary
348: group list matches one of the patterns.
349: Only group names are valid; a numerical group ID is not recognized.
350: By default, login is allowed for all groups.
1.54 jmc 351: The allow/deny directives are processed in the following order:
352: .Cm DenyUsers ,
353: .Cm AllowUsers ,
354: .Cm DenyGroups ,
355: and finally
356: .Cm AllowGroups .
1.49 jmc 357: .Pp
358: See
359: .Sx PATTERNS
360: in
361: .Xr ssh_config 5
362: for more information on patterns.
1.1 stevesk 363: .It Cm DenyUsers
364: This keyword can be followed by a list of user name patterns, separated
365: by spaces.
366: Login is disallowed for user names that match one of the patterns.
367: Only user names are valid; a numerical user ID is not recognized.
368: By default, login is allowed for all users.
369: If the pattern takes the form USER@HOST then USER and HOST
370: are separately checked, restricting logins to particular
371: users from particular hosts.
1.54 jmc 372: The allow/deny directives are processed in the following order:
373: .Cm DenyUsers ,
374: .Cm AllowUsers ,
375: .Cm DenyGroups ,
376: and finally
377: .Cm AllowGroups .
1.49 jmc 378: .Pp
379: See
380: .Sx PATTERNS
381: in
382: .Xr ssh_config 5
383: for more information on patterns.
1.67 dtucker 384: .It Cm ForceCommand
385: Forces the execution of the command specified by
386: .Cm ForceCommand ,
1.84 djm 387: ignoring any command supplied by the client and
388: .Pa ~/.ssh/rc
389: if present.
1.67 dtucker 390: The command is invoked by using the user's login shell with the -c option.
391: This applies to shell, command, or subsystem execution.
392: It is most useful inside a
393: .Cm Match
394: block.
395: The command originally supplied by the client is available in the
396: .Ev SSH_ORIGINAL_COMMAND
397: environment variable.
1.82 djm 398: Specifying a command of
399: .Dq internal-sftp
400: will force the use of an in-process sftp server that requires no support
401: files when used with
402: .Cm ChrootDirectory .
1.1 stevesk 403: .It Cm GatewayPorts
404: Specifies whether remote hosts are allowed to connect to ports
405: forwarded for the client.
406: By default,
1.52 jmc 407: .Xr sshd 8
1.15 jmc 408: binds remote port forwardings to the loopback address.
409: This prevents other remote hosts from connecting to forwarded ports.
1.1 stevesk 410: .Cm GatewayPorts
1.52 jmc 411: can be used to specify that sshd
1.39 djm 412: should allow remote port forwardings to bind to non-loopback addresses, thus
413: allowing other hosts to connect.
414: The argument may be
415: .Dq no
416: to force remote port forwardings to be available to the local host only,
1.1 stevesk 417: .Dq yes
1.39 djm 418: to force remote port forwardings to bind to the wildcard address, or
419: .Dq clientspecified
420: to allow the client to select the address to which the forwarding is bound.
1.1 stevesk 421: The default is
422: .Dq no .
1.23 markus 423: .It Cm GSSAPIAuthentication
1.25 markus 424: Specifies whether user authentication based on GSSAPI is allowed.
1.26 djm 425: The default is
1.23 markus 426: .Dq no .
427: Note that this option applies to protocol version 2 only.
428: .It Cm GSSAPICleanupCredentials
429: Specifies whether to automatically destroy the user's credentials cache
430: on logout.
431: The default is
432: .Dq yes .
433: Note that this option applies to protocol version 2 only.
1.1 stevesk 434: .It Cm HostbasedAuthentication
435: Specifies whether rhosts or /etc/hosts.equiv authentication together
436: with successful public key client host authentication is allowed
1.50 jmc 437: (host-based authentication).
1.1 stevesk 438: This option is similar to
439: .Cm RhostsRSAAuthentication
440: and applies to protocol version 2 only.
1.70 dtucker 441: The default is
442: .Dq no .
443: .It Cm HostbasedUsesNameFromPacketOnly
444: Specifies whether or not the server will attempt to perform a reverse
445: name lookup when matching the name in the
446: .Pa ~/.shosts ,
447: .Pa ~/.rhosts ,
448: and
449: .Pa /etc/hosts.equiv
450: files during
451: .Cm HostbasedAuthentication .
452: A setting of
453: .Dq yes
454: means that
455: .Xr sshd 8
456: uses the name supplied by the client rather than
457: attempting to resolve the name from the TCP connection itself.
1.1 stevesk 458: The default is
459: .Dq no .
1.117 djm 460: .It Cm HostCertificate
461: Specifies a file containing a public host certificate.
462: The certificate's public key must match a private host key already specified
463: by
464: .Cm HostKey .
465: The default behaviour of
466: .Xr sshd 8
467: is not to load any certificates.
1.1 stevesk 468: .It Cm HostKey
469: Specifies a file containing a private host key
470: used by SSH.
471: The default is
472: .Pa /etc/ssh/ssh_host_key
473: for protocol version 1, and
1.126 djm 474: .Pa /etc/ssh/ssh_host_dsa_key ,
475: .Pa /etc/ssh/ssh_host_ecdsa_key
476: and
1.1 stevesk 477: .Pa /etc/ssh/ssh_host_rsa_key
478: for protocol version 2.
479: Note that
1.52 jmc 480: .Xr sshd 8
1.1 stevesk 481: will refuse to use a file if it is group/world-accessible.
482: It is possible to have multiple host key files.
483: .Dq rsa1
484: keys are used for version 1 and
1.126 djm 485: .Dq dsa ,
486: .Dq ecdsa
1.1 stevesk 487: or
488: .Dq rsa
489: are used for version 2 of the SSH protocol.
490: .It Cm IgnoreRhosts
491: Specifies that
492: .Pa .rhosts
493: and
494: .Pa .shosts
495: files will not be used in
496: .Cm RhostsRSAAuthentication
497: or
498: .Cm HostbasedAuthentication .
499: .Pp
500: .Pa /etc/hosts.equiv
501: and
502: .Pa /etc/shosts.equiv
503: are still used.
504: The default is
505: .Dq yes .
506: .It Cm IgnoreUserKnownHosts
507: Specifies whether
1.52 jmc 508: .Xr sshd 8
1.1 stevesk 509: should ignore the user's
1.41 djm 510: .Pa ~/.ssh/known_hosts
1.1 stevesk 511: during
512: .Cm RhostsRSAAuthentication
513: or
514: .Cm HostbasedAuthentication .
515: The default is
516: .Dq no .
1.129 djm 517: .It Cm IPQoS
518: Specifies the IPv4 type-of-service or DSCP class for the connection.
519: Accepted values are
520: .Dq af11 ,
521: .Dq af12 ,
522: .Dq af13 ,
523: .Dq af14 ,
524: .Dq af22 ,
525: .Dq af23 ,
526: .Dq af31 ,
527: .Dq af32 ,
528: .Dq af33 ,
529: .Dq af41 ,
530: .Dq af42 ,
531: .Dq af43 ,
532: .Dq cs0 ,
533: .Dq cs1 ,
534: .Dq cs2 ,
535: .Dq cs3 ,
536: .Dq cs4 ,
537: .Dq cs5 ,
538: .Dq cs6 ,
539: .Dq cs7 ,
540: .Dq ef ,
541: .Dq lowdelay ,
542: .Dq throughput ,
543: .Dq reliability ,
544: or a numeric value.
1.131 djm 545: This option may take one or two arguments, separated by whitespace.
1.129 djm 546: If one argument is specified, it is used as the packet class unconditionally.
547: If two values are specified, the first is automatically selected for
548: interactive sessions and the second for non-interactive sessions.
549: The default is
550: .Dq lowdelay
551: for interactive sessions and
552: .Dq throughput
553: for non-interactive sessions.
1.1 stevesk 554: .It Cm KerberosAuthentication
1.24 markus 555: Specifies whether the password provided by the user for
1.1 stevesk 556: .Cm PasswordAuthentication
1.24 markus 557: will be validated through the Kerberos KDC.
1.1 stevesk 558: To use this option, the server needs a
559: Kerberos servtab which allows the verification of the KDC's identity.
1.52 jmc 560: The default is
1.29 dtucker 561: .Dq no .
562: .It Cm KerberosGetAFSToken
1.45 djm 563: If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
1.29 dtucker 564: an AFS token before accessing the user's home directory.
1.52 jmc 565: The default is
1.1 stevesk 566: .Dq no .
567: .It Cm KerberosOrLocalPasswd
1.52 jmc 568: If password authentication through Kerberos fails then
1.1 stevesk 569: the password will be validated via any additional local mechanism
570: such as
571: .Pa /etc/passwd .
1.52 jmc 572: The default is
1.1 stevesk 573: .Dq yes .
574: .It Cm KerberosTicketCleanup
575: Specifies whether to automatically destroy the user's ticket cache
576: file on logout.
1.52 jmc 577: The default is
1.1 stevesk 578: .Dq yes .
1.127 djm 579: .It Cm KexAlgorithms
580: Specifies the available KEX (Key Exchange) algorithms.
581: Multiple algorithms must be comma-separated.
582: The default is
583: .Dq ecdh-sha2-nistp256 ,
584: .Dq ecdh-sha2-nistp384 ,
585: .Dq ecdh-sha2-nistp521 ,
1.130 jmc 586: .Dq diffie-hellman-group-exchange-sha256 ,
1.127 djm 587: .Dq diffie-hellman-group-exchange-sha1 ,
588: .Dq diffie-hellman-group14-sha1 ,
589: .Dq diffie-hellman-group1-sha1 .
1.1 stevesk 590: .It Cm KeyRegenerationInterval
591: In protocol version 1, the ephemeral server key is automatically regenerated
592: after this many seconds (if it has been used).
593: The purpose of regeneration is to prevent
594: decrypting captured sessions by later breaking into the machine and
595: stealing the keys.
596: The key is never stored anywhere.
597: If the value is 0, the key is never regenerated.
598: The default is 3600 (seconds).
599: .It Cm ListenAddress
600: Specifies the local addresses
1.52 jmc 601: .Xr sshd 8
1.1 stevesk 602: should listen on.
603: The following forms may be used:
604: .Pp
605: .Bl -item -offset indent -compact
606: .It
607: .Cm ListenAddress
608: .Sm off
609: .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
610: .Sm on
611: .It
612: .Cm ListenAddress
613: .Sm off
614: .Ar host No | Ar IPv4_addr No : Ar port
615: .Sm on
616: .It
617: .Cm ListenAddress
618: .Sm off
619: .Oo
620: .Ar host No | Ar IPv6_addr Oc : Ar port
621: .Sm on
622: .El
623: .Pp
624: If
625: .Ar port
626: is not specified,
1.52 jmc 627: sshd will listen on the address and all prior
1.1 stevesk 628: .Cm Port
1.17 jmc 629: options specified.
630: The default is to listen on all local addresses.
1.15 jmc 631: Multiple
1.1 stevesk 632: .Cm ListenAddress
1.17 jmc 633: options are permitted.
634: Additionally, any
1.1 stevesk 635: .Cm Port
1.52 jmc 636: options must precede this option for non-port qualified addresses.
1.1 stevesk 637: .It Cm LoginGraceTime
638: The server disconnects after this time if the user has not
639: successfully logged in.
640: If the value is 0, there is no time limit.
1.12 stevesk 641: The default is 120 seconds.
1.1 stevesk 642: .It Cm LogLevel
643: Gives the verbosity level that is used when logging messages from
1.53 jmc 644: .Xr sshd 8 .
1.1 stevesk 645: The possible values are:
1.52 jmc 646: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
1.15 jmc 647: The default is INFO.
648: DEBUG and DEBUG1 are equivalent.
649: DEBUG2 and DEBUG3 each specify higher levels of debugging output.
650: Logging with a DEBUG level violates the privacy of users and is not recommended.
1.1 stevesk 651: .It Cm MACs
652: Specifies the available MAC (message authentication code) algorithms.
653: The MAC algorithm is used in protocol version 2
654: for data integrity protection.
655: Multiple algorithms must be comma-separated.
1.52 jmc 656: The default is:
1.77 jmc 657: .Bd -literal -offset indent
658: hmac-md5,hmac-sha1,umac-64@openssh.com,
659: hmac-ripemd160,hmac-sha1-96,hmac-md5-96
660: .Ed
1.60 dtucker 661: .It Cm Match
1.61 jmc 662: Introduces a conditional block.
1.65 dtucker 663: If all of the criteria on the
1.60 dtucker 664: .Cm Match
1.65 dtucker 665: line are satisfied, the keywords on the following lines override those
666: set in the global section of the config file, until either another
1.60 dtucker 667: .Cm Match
1.65 dtucker 668: line or the end of the file.
1.91 djm 669: .Pp
1.61 jmc 670: The arguments to
1.60 dtucker 671: .Cm Match
1.65 dtucker 672: are one or more criteria-pattern pairs.
1.60 dtucker 673: The available criteria are
674: .Cm User ,
1.69 dtucker 675: .Cm Group ,
1.60 dtucker 676: .Cm Host ,
677: and
678: .Cm Address .
1.91 djm 679: The match patterns may consist of single entries or comma-separated
680: lists and may use the wildcard and negation operators described in the
1.92 djm 681: .Sx PATTERNS
1.91 djm 682: section of
1.92 djm 683: .Xr ssh_config 5 .
1.91 djm 684: .Pp
685: The patterns in an
686: .Cm Address
687: criteria may additionally contain addresses to match in CIDR
1.93 jmc 688: address/masklen format, e.g.\&
1.91 djm 689: .Dq 192.0.2.0/24
690: or
691: .Dq 3ffe:ffff::/32 .
692: Note that the mask length provided must be consistent with the address -
693: it is an error to specify a mask length that is too long for the address
1.93 jmc 694: or one with bits set in this host portion of the address.
695: For example,
1.91 djm 696: .Dq 192.0.2.0/33
697: and
1.93 jmc 698: .Dq 192.0.2.0/8
1.91 djm 699: respectively.
700: .Pp
1.60 dtucker 701: Only a subset of keywords may be used on the lines following a
702: .Cm Match
703: keyword.
704: Available keywords are
1.99 okan 705: .Cm AllowAgentForwarding ,
1.62 dtucker 706: .Cm AllowTcpForwarding ,
1.123 djm 707: .Cm AuthorizedKeysFile ,
708: .Cm AuthorizedPrincipalsFile ,
1.72 dtucker 709: .Cm Banner ,
1.85 djm 710: .Cm ChrootDirectory ,
1.67 dtucker 711: .Cm ForceCommand ,
1.62 dtucker 712: .Cm GatewayPorts ,
1.87 djm 713: .Cm GSSAPIAuthentication ,
714: .Cm HostbasedAuthentication ,
1.123 djm 715: .Cm HostbasedUsesNameFromPacketOnly ,
1.74 jmc 716: .Cm KbdInteractiveAuthentication ,
1.72 dtucker 717: .Cm KerberosAuthentication ,
1.95 dtucker 718: .Cm MaxAuthTries ,
1.94 dtucker 719: .Cm MaxSessions ,
1.72 dtucker 720: .Cm PasswordAuthentication ,
1.97 djm 721: .Cm PermitEmptyPasswords ,
1.66 dtucker 722: .Cm PermitOpen ,
1.79 dtucker 723: .Cm PermitRootLogin ,
1.123 djm 724: .Cm PermitTunnel ,
1.107 dtucker 725: .Cm PubkeyAuthentication ,
1.72 dtucker 726: .Cm RhostsRSAAuthentication ,
727: .Cm RSAAuthentication ,
1.66 dtucker 728: .Cm X11DisplayOffset ,
1.101 djm 729: .Cm X11Forwarding
1.60 dtucker 730: and
1.102 djm 731: .Cm X11UseLocalHost .
1.33 dtucker 732: .It Cm MaxAuthTries
733: Specifies the maximum number of authentication attempts permitted per
1.35 jmc 734: connection.
735: Once the number of failures reaches half this value,
736: additional failures are logged.
737: The default is 6.
1.90 djm 738: .It Cm MaxSessions
739: Specifies the maximum number of open sessions permitted per network connection.
740: The default is 10.
1.1 stevesk 741: .It Cm MaxStartups
742: Specifies the maximum number of concurrent unauthenticated connections to the
1.52 jmc 743: SSH daemon.
1.1 stevesk 744: Additional connections will be dropped until authentication succeeds or the
745: .Cm LoginGraceTime
746: expires for a connection.
747: The default is 10.
748: .Pp
749: Alternatively, random early drop can be enabled by specifying
750: the three colon separated values
751: .Dq start:rate:full
1.51 jmc 752: (e.g. "10:30:60").
1.53 jmc 753: .Xr sshd 8
1.1 stevesk 754: will refuse connection attempts with a probability of
755: .Dq rate/100
756: (30%)
757: if there are currently
758: .Dq start
759: (10)
760: unauthenticated connections.
761: The probability increases linearly and all connection attempts
762: are refused if the number of unauthenticated connections reaches
763: .Dq full
764: (60).
765: .It Cm PasswordAuthentication
766: Specifies whether password authentication is allowed.
767: The default is
768: .Dq yes .
769: .It Cm PermitEmptyPasswords
770: When password authentication is allowed, it specifies whether the
771: server allows login to accounts with empty password strings.
772: The default is
773: .Dq no .
1.62 dtucker 774: .It Cm PermitOpen
775: Specifies the destinations to which TCP port forwarding is permitted.
776: The forwarding specification must be one of the following forms:
777: .Pp
778: .Bl -item -offset indent -compact
779: .It
780: .Cm PermitOpen
781: .Sm off
782: .Ar host : port
783: .Sm on
784: .It
785: .Cm PermitOpen
786: .Sm off
787: .Ar IPv4_addr : port
788: .Sm on
789: .It
790: .Cm PermitOpen
791: .Sm off
792: .Ar \&[ IPv6_addr \&] : port
793: .Sm on
794: .El
795: .Pp
1.68 dtucker 796: Multiple forwards may be specified by separating them with whitespace.
1.62 dtucker 797: An argument of
798: .Dq any
799: can be used to remove all restrictions and permit any forwarding requests.
1.63 jmc 800: By default all port forwarding requests are permitted.
1.1 stevesk 801: .It Cm PermitRootLogin
1.38 jmc 802: Specifies whether root can log in using
1.1 stevesk 803: .Xr ssh 1 .
804: The argument must be
805: .Dq yes ,
806: .Dq without-password ,
1.52 jmc 807: .Dq forced-commands-only ,
1.1 stevesk 808: or
809: .Dq no .
810: The default is
811: .Dq yes .
812: .Pp
813: If this option is set to
1.52 jmc 814: .Dq without-password ,
1.1 stevesk 815: password authentication is disabled for root.
816: .Pp
817: If this option is set to
1.52 jmc 818: .Dq forced-commands-only ,
1.1 stevesk 819: root login with public key authentication will be allowed,
820: but only if the
821: .Ar command
822: option has been specified
823: (which may be useful for taking remote backups even if root login is
1.17 jmc 824: normally not allowed).
825: All other authentication methods are disabled for root.
1.1 stevesk 826: .Pp
827: If this option is set to
1.52 jmc 828: .Dq no ,
1.38 jmc 829: root is not allowed to log in.
1.46 reyk 830: .It Cm PermitTunnel
831: Specifies whether
832: .Xr tun 4
833: device forwarding is allowed.
1.47 reyk 834: The argument must be
835: .Dq yes ,
1.58 stevesk 836: .Dq point-to-point
837: (layer 3),
838: .Dq ethernet
839: (layer 2), or
1.47 reyk 840: .Dq no .
1.58 stevesk 841: Specifying
842: .Dq yes
843: permits both
844: .Dq point-to-point
845: and
846: .Dq ethernet .
1.46 reyk 847: The default is
848: .Dq no .
1.6 markus 849: .It Cm PermitUserEnvironment
850: Specifies whether
851: .Pa ~/.ssh/environment
1.9 stevesk 852: and
1.6 markus 853: .Cm environment=
854: options in
855: .Pa ~/.ssh/authorized_keys
1.9 stevesk 856: are processed by
1.52 jmc 857: .Xr sshd 8 .
1.6 markus 858: The default is
859: .Dq no .
1.9 stevesk 860: Enabling environment processing may enable users to bypass access
861: restrictions in some configurations using mechanisms such as
862: .Ev LD_PRELOAD .
1.1 stevesk 863: .It Cm PidFile
1.4 stevesk 864: Specifies the file that contains the process ID of the
1.53 jmc 865: SSH daemon.
1.1 stevesk 866: The default is
867: .Pa /var/run/sshd.pid .
868: .It Cm Port
869: Specifies the port number that
1.52 jmc 870: .Xr sshd 8
1.1 stevesk 871: listens on.
872: The default is 22.
873: Multiple options of this type are permitted.
874: See also
875: .Cm ListenAddress .
876: .It Cm PrintLastLog
877: Specifies whether
1.52 jmc 878: .Xr sshd 8
1.36 jaredy 879: should print the date and time of the last user login when a user logs
880: in interactively.
1.1 stevesk 881: The default is
882: .Dq yes .
883: .It Cm PrintMotd
884: Specifies whether
1.52 jmc 885: .Xr sshd 8
1.1 stevesk 886: should print
887: .Pa /etc/motd
888: when a user logs in interactively.
889: (On some systems it is also printed by the shell,
890: .Pa /etc/profile ,
891: or equivalent.)
892: The default is
893: .Dq yes .
894: .It Cm Protocol
895: Specifies the protocol versions
1.52 jmc 896: .Xr sshd 8
1.5 stevesk 897: supports.
1.1 stevesk 898: The possible values are
1.52 jmc 899: .Sq 1
1.1 stevesk 900: and
1.52 jmc 901: .Sq 2 .
1.1 stevesk 902: Multiple versions must be comma-separated.
903: The default is
1.109 jmc 904: .Sq 2 .
1.5 stevesk 905: Note that the order of the protocol list does not indicate preference,
906: because the client selects among multiple protocol versions offered
907: by the server.
908: Specifying
909: .Dq 2,1
910: is identical to
911: .Dq 1,2 .
1.1 stevesk 912: .It Cm PubkeyAuthentication
913: Specifies whether public key authentication is allowed.
914: The default is
915: .Dq yes .
916: Note that this option applies to protocol version 2 only.
1.118 djm 917: .It Cm RevokedKeys
918: Specifies a list of revoked public keys.
919: Keys listed in this file will be refused for public key authentication.
920: Note that if this file is not readable, then public key authentication will
921: be refused for all users.
1.1 stevesk 922: .It Cm RhostsRSAAuthentication
923: Specifies whether rhosts or /etc/hosts.equiv authentication together
924: with successful RSA host authentication is allowed.
925: The default is
926: .Dq no .
927: This option applies to protocol version 1 only.
928: .It Cm RSAAuthentication
929: Specifies whether pure RSA authentication is allowed.
930: The default is
931: .Dq yes .
932: This option applies to protocol version 1 only.
933: .It Cm ServerKeyBits
934: Defines the number of bits in the ephemeral protocol version 1 server key.
1.96 djm 935: The minimum value is 512, and the default is 1024.
1.1 stevesk 936: .It Cm StrictModes
937: Specifies whether
1.52 jmc 938: .Xr sshd 8
1.1 stevesk 939: should check file modes and ownership of the
940: user's files and home directory before accepting login.
941: This is normally desirable because novices sometimes accidentally leave their
942: directory or files world-writable.
943: The default is
944: .Dq yes .
1.112 djm 945: Note that this does not apply to
946: .Cm ChrootDirectory ,
947: whose permissions and ownership are checked unconditionally.
1.1 stevesk 948: .It Cm Subsystem
1.51 jmc 949: Configures an external subsystem (e.g. file transfer daemon).
1.59 djm 950: Arguments should be a subsystem name and a command (with optional arguments)
951: to execute upon subsystem request.
1.80 djm 952: .Pp
1.1 stevesk 953: The command
954: .Xr sftp-server 8
955: implements the
956: .Dq sftp
957: file transfer subsystem.
1.80 djm 958: .Pp
959: Alternately the name
960: .Dq internal-sftp
961: implements an in-process
962: .Dq sftp
963: server.
964: This may simplify configurations using
965: .Cm ChrootDirectory
966: to force a different filesystem root on clients.
967: .Pp
1.1 stevesk 968: By default no subsystems are defined.
969: Note that this option applies to protocol version 2 only.
970: .It Cm SyslogFacility
971: Gives the facility code that is used when logging messages from
1.53 jmc 972: .Xr sshd 8 .
1.1 stevesk 973: The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
974: LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
975: The default is AUTH.
1.27 markus 976: .It Cm TCPKeepAlive
977: Specifies whether the system should send TCP keepalive messages to the
978: other side.
979: If they are sent, death of the connection or crash of one
980: of the machines will be properly noticed.
981: However, this means that
982: connections will die if the route is down temporarily, and some people
983: find it annoying.
984: On the other hand, if TCP keepalives are not sent,
985: sessions may hang indefinitely on the server, leaving
986: .Dq ghost
987: users and consuming server resources.
988: .Pp
989: The default is
990: .Dq yes
991: (to send TCP keepalive messages), and the server will notice
992: if the network goes down or the client host crashes.
993: This avoids infinitely hanging sessions.
994: .Pp
995: To disable TCP keepalive messages, the value should be set to
996: .Dq no .
1.118 djm 997: .It Cm TrustedUserCAKeys
998: Specifies a file containing public keys of certificate authorities that are
1.120 djm 999: trusted to sign user certificates for authentication.
1.119 jmc 1000: Keys are listed one per line; empty lines and comments starting with
1.118 djm 1001: .Ql #
1002: are allowed.
1003: If a certificate is presented for authentication and has its signing CA key
1004: listed in this file, then it may be used for authentication for any user
1005: listed in the certificate's principals list.
1006: Note that certificates that lack a list of principals will not be permitted
1007: for authentication using
1008: .Cm TrustedUserCAKeys .
1.119 jmc 1009: For more details on certificates, see the
1.118 djm 1010: .Sx CERTIFICATES
1011: section in
1012: .Xr ssh-keygen 1 .
1.18 markus 1013: .It Cm UseDNS
1014: Specifies whether
1.52 jmc 1015: .Xr sshd 8
1.40 jmc 1016: should look up the remote host name and check that
1.18 markus 1017: the resolved host name for the remote IP address maps back to the
1018: very same IP address.
1019: The default is
1020: .Dq yes .
1.1 stevesk 1021: .It Cm UseLogin
1022: Specifies whether
1023: .Xr login 1
1024: is used for interactive login sessions.
1025: The default is
1026: .Dq no .
1027: Note that
1028: .Xr login 1
1029: is never used for remote command execution.
1030: Note also, that if this is enabled,
1031: .Cm X11Forwarding
1032: will be disabled because
1033: .Xr login 1
1034: does not know how to handle
1035: .Xr xauth 1
1.15 jmc 1036: cookies.
1037: If
1.1 stevesk 1038: .Cm UsePrivilegeSeparation
1039: is specified, it will be disabled after authentication.
1040: .It Cm UsePrivilegeSeparation
1041: Specifies whether
1.52 jmc 1042: .Xr sshd 8
1.2 stevesk 1043: separates privileges by creating an unprivileged child process
1.15 jmc 1044: to deal with incoming network traffic.
1045: After successful authentication, another process will be created that has
1046: the privilege of the authenticated user.
1047: The goal of privilege separation is to prevent privilege
1.1 stevesk 1048: escalation by containing any corruption within the unprivileged processes.
1049: The default is
1050: .Dq yes .
1051: .It Cm X11DisplayOffset
1052: Specifies the first display number available for
1.52 jmc 1053: .Xr sshd 8 Ns 's
1.1 stevesk 1054: X11 forwarding.
1.52 jmc 1055: This prevents sshd from interfering with real X11 servers.
1.1 stevesk 1056: The default is 10.
1057: .It Cm X11Forwarding
1058: Specifies whether X11 forwarding is permitted.
1.13 stevesk 1059: The argument must be
1060: .Dq yes
1061: or
1062: .Dq no .
1.1 stevesk 1063: The default is
1064: .Dq no .
1.13 stevesk 1065: .Pp
1066: When X11 forwarding is enabled, there may be additional exposure to
1067: the server and to client displays if the
1.52 jmc 1068: .Xr sshd 8
1.13 stevesk 1069: proxy display is configured to listen on the wildcard address (see
1070: .Cm X11UseLocalhost
1.52 jmc 1071: below), though this is not the default.
1.13 stevesk 1072: Additionally, the authentication spoofing and authentication data
1073: verification and substitution occur on the client side.
1074: The security risk of using X11 forwarding is that the client's X11
1.52 jmc 1075: display server may be exposed to attack when the SSH client requests
1.13 stevesk 1076: forwarding (see the warnings for
1077: .Cm ForwardX11
1078: in
1.19 jmc 1079: .Xr ssh_config 5 ) .
1.13 stevesk 1080: A system administrator may have a stance in which they want to
1081: protect clients that may expose themselves to attack by unwittingly
1082: requesting X11 forwarding, which can warrant a
1083: .Dq no
1084: setting.
1085: .Pp
1086: Note that disabling X11 forwarding does not prevent users from
1087: forwarding X11 traffic, as users can always install their own forwarders.
1.1 stevesk 1088: X11 forwarding is automatically disabled if
1089: .Cm UseLogin
1090: is enabled.
1091: .It Cm X11UseLocalhost
1092: Specifies whether
1.52 jmc 1093: .Xr sshd 8
1.1 stevesk 1094: should bind the X11 forwarding server to the loopback address or to
1.15 jmc 1095: the wildcard address.
1096: By default,
1.52 jmc 1097: sshd binds the forwarding server to the loopback address and sets the
1.1 stevesk 1098: hostname part of the
1099: .Ev DISPLAY
1100: environment variable to
1101: .Dq localhost .
1.8 stevesk 1102: This prevents remote hosts from connecting to the proxy display.
1.1 stevesk 1103: However, some older X11 clients may not function with this
1104: configuration.
1105: .Cm X11UseLocalhost
1106: may be set to
1107: .Dq no
1108: to specify that the forwarding server should be bound to the wildcard
1109: address.
1110: The argument must be
1111: .Dq yes
1112: or
1113: .Dq no .
1114: The default is
1115: .Dq yes .
1116: .It Cm XAuthLocation
1.11 stevesk 1117: Specifies the full pathname of the
1.1 stevesk 1118: .Xr xauth 1
1119: program.
1120: The default is
1121: .Pa /usr/X11R6/bin/xauth .
1122: .El
1.55 jmc 1123: .Sh TIME FORMATS
1.53 jmc 1124: .Xr sshd 8
1.1 stevesk 1125: command-line arguments and configuration file options that specify time
1126: may be expressed using a sequence of the form:
1127: .Sm off
1.7 stevesk 1128: .Ar time Op Ar qualifier ,
1.1 stevesk 1129: .Sm on
1130: where
1131: .Ar time
1132: is a positive integer value and
1133: .Ar qualifier
1134: is one of the following:
1135: .Pp
1136: .Bl -tag -width Ds -compact -offset indent
1.64 jmc 1137: .It Aq Cm none
1.1 stevesk 1138: seconds
1139: .It Cm s | Cm S
1140: seconds
1141: .It Cm m | Cm M
1142: minutes
1143: .It Cm h | Cm H
1144: hours
1145: .It Cm d | Cm D
1146: days
1147: .It Cm w | Cm W
1148: weeks
1149: .El
1150: .Pp
1151: Each member of the sequence is added together to calculate
1152: the total time value.
1153: .Pp
1154: Time format examples:
1155: .Pp
1156: .Bl -tag -width Ds -compact -offset indent
1157: .It 600
1158: 600 seconds (10 minutes)
1159: .It 10m
1160: 10 minutes
1161: .It 1h30m
1162: 1 hour 30 minutes (90 minutes)
1163: .El
1164: .Sh FILES
1165: .Bl -tag -width Ds
1166: .It Pa /etc/ssh/sshd_config
1167: Contains configuration data for
1.53 jmc 1168: .Xr sshd 8 .
1.1 stevesk 1169: This file should be writable by root only, but it is recommended
1170: (though not necessary) that it be world-readable.
1171: .El
1.19 jmc 1172: .Sh SEE ALSO
1173: .Xr sshd 8
1.1 stevesk 1174: .Sh AUTHORS
1175: OpenSSH is a derivative of the original and free
1176: ssh 1.2.12 release by Tatu Ylonen.
1177: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1178: Theo de Raadt and Dug Song
1179: removed many bugs, re-added newer features and
1180: created OpenSSH.
1181: Markus Friedl contributed the support for SSH
1182: protocol versions 1.5 and 2.0.
1183: Niels Provos and Markus Friedl contributed support
1184: for privilege separation.
![[BACK]](/icons/back.gif){kind=icon}
Return to sshd_config.5 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh