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