]> andersk Git - gssapi-openssh.git/blame - openssh/sshd_config.5
- 3.7 release
[gssapi-openssh.git] / openssh / sshd_config.5
CommitLineData
884dc78b 1.\" -*- nroff -*-
2.\"
3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
7.\" As far as I am concerned, the code I have written for this software
8.\" can be used freely for any purpose. Any derived versions of this
9.\" software must be clearly marked as such, and if the derived work is
10.\" incompatible with the protocol description in the RFC file, it must be
11.\" called by a name other than "ssh" or "Secure Shell".
12.\"
13.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
16.\"
17.\" Redistribution and use in source and binary forms, with or without
18.\" modification, are permitted provided that the following conditions
19.\" are met:
20.\" 1. Redistributions of source code must retain the above copyright
21.\" notice, this list of conditions and the following disclaimer.
22.\" 2. Redistributions in binary form must reproduce the above copyright
23.\" notice, this list of conditions and the following disclaimer in the
24.\" documentation and/or other materials provided with the distribution.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\"
08822d99 37.\" $OpenBSD: sshd_config.5,v 1.48 2006/01/02 17:09:49 jmc Exp $
884dc78b 38.Dd September 25, 1999
39.Dt SSHD_CONFIG 5
40.Os
41.Sh NAME
42.Nm sshd_config
43.Nd OpenSSH SSH daemon configuration file
44.Sh SYNOPSIS
45.Bl -tag -width Ds -compact
46.It Pa /etc/ssh/sshd_config
47.El
48.Sh DESCRIPTION
49.Nm sshd
50reads configuration data from
51.Pa /etc/ssh/sshd_config
52(or the file specified with
53.Fl f
54on the command line).
55The file contains keyword-argument pairs, one per line.
56Lines starting with
57.Ql #
58and empty lines are interpreted as comments.
59.Pp
60The possible
61keywords and their meanings are as follows (note that
62keywords are case-insensitive and arguments are case-sensitive):
63.Bl -tag -width Ds
7e82606e 64.It Cm AcceptEnv
65Specifies what environment variables sent by the client will be copied into
66the session's
67.Xr environ 7 .
68See
69.Cm SendEnv
70in
71.Xr ssh_config 5
72for how to configure the client.
73Note that environment passing is only supported for protocol 2.
74Variables are specified by name, which may contain the wildcard characters
75.Ql \&*
76and
77.Ql \&? .
78Multiple environment variables may be separated by whitespace or spread
79across multiple
80.Cm AcceptEnv
81directives.
82Be warned that some environment variables could be used to bypass restricted
83user environments.
84For this reason, care should be taken in the use of this directive.
85The default is not to accept any environment variables.
dfddba3d 86.It Cm AddressFamily
87Specifies which address family should be used by
88.Nm sshd .
89Valid arguments are
90.Dq any ,
91.Dq inet
92(use IPv4 only) or
93.Dq inet6
94(use IPv6 only).
95The default is
96.Dq any .
884dc78b 97.It Cm AllowGroups
98This keyword can be followed by a list of group name patterns, separated
99by spaces.
100If specified, login is allowed only for users whose primary
101group or supplementary group list matches one of the patterns.
102.Ql \&*
103and
7cac2b65 104.Ql \&?
884dc78b 105can be used as
106wildcards in the patterns.
107Only group names are valid; a numerical group ID is not recognized.
108By default, login is allowed for all groups.
884dc78b 109.It Cm AllowTcpForwarding
110Specifies whether TCP forwarding is permitted.
111The default is
112.Dq yes .
113Note that disabling TCP forwarding does not improve security unless
114users are also denied shell access, as they can always install their
115own forwarders.
884dc78b 116.It Cm AllowUsers
117This keyword can be followed by a list of user name patterns, separated
118by spaces.
bfe49944 119If specified, login is allowed only for user names that
884dc78b 120match one of the patterns.
121.Ql \&*
122and
7cac2b65 123.Ql \&?
884dc78b 124can be used as
125wildcards in the patterns.
126Only user names are valid; a numerical user ID is not recognized.
127By default, login is allowed for all users.
128If the pattern takes the form USER@HOST then USER and HOST
129are separately checked, restricting logins to particular
130users from particular hosts.
884dc78b 131.It Cm AuthorizedKeysFile
132Specifies the file that contains the public keys that can be used
133for user authentication.
134.Cm AuthorizedKeysFile
135may contain tokens of the form %T which are substituted during connection
7cac2b65 136set-up.
137The following tokens are defined: %% is replaced by a literal '%',
884dc78b 138%h is replaced by the home directory of the user being authenticated and
139%u is replaced by the username of that user.
140After expansion,
141.Cm AuthorizedKeysFile
142is taken to be an absolute path or one relative to the user's home
143directory.
144The default is
145.Dq .ssh/authorized_keys .
146.It Cm Banner
147In some jurisdictions, sending a warning message before authentication
148may be relevant for getting legal protection.
149The contents of the specified file are sent to the remote user before
150authentication is allowed.
151This option is only available for protocol version 2.
152By default, no banner is displayed.
884dc78b 153.It Cm ChallengeResponseAuthentication
154Specifies whether challenge response authentication is allowed.
155All authentication styles from
156.Xr login.conf 5
157are supported.
158The default is
159.Dq yes .
160.It Cm Ciphers
161Specifies the ciphers allowed for protocol version 2.
162Multiple ciphers must be comma-separated.
7e82606e 163The supported ciphers are
164.Dq 3des-cbc ,
165.Dq aes128-cbc ,
166.Dq aes192-cbc ,
167.Dq aes256-cbc ,
168.Dq aes128-ctr ,
169.Dq aes192-ctr ,
170.Dq aes256-ctr ,
2ce0bfe4 171.Dq arcfour128 ,
172.Dq arcfour256 ,
7e82606e 173.Dq arcfour ,
174.Dq blowfish-cbc ,
175and
176.Dq cast128-cbc .
884dc78b 177The default is
884dc78b 178.Bd -literal
2ce0bfe4 179 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
180 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
181 aes192-ctr,aes256-ctr''
884dc78b 182.Ed
884dc78b 183.It Cm ClientAliveCountMax
08822d99 184Sets the number of client alive messages (see below) which may be
884dc78b 185sent without
186.Nm sshd
7cac2b65 187receiving any messages back from the client.
188If this threshold is reached while client alive messages are being sent,
884dc78b 189.Nm sshd
7cac2b65 190will disconnect the client, terminating the session.
191It is important to note that the use of client alive messages is very
192different from
540d72c3 193.Cm TCPKeepAlive
7cac2b65 194(below).
195The client alive messages are sent through the encrypted channel
196and therefore will not be spoofable.
197The TCP keepalive option enabled by
540d72c3 198.Cm TCPKeepAlive
7cac2b65 199is spoofable.
200The client alive mechanism is valuable when the client or
884dc78b 201server depend on knowing when a connection has become inactive.
202.Pp
7cac2b65 203The default value is 3.
204If
884dc78b 205.Cm ClientAliveInterval
08822d99 206(see below) is set to 15, and
884dc78b 207.Cm ClientAliveCountMax
208is left at the default, unresponsive ssh clients
209will be disconnected after approximately 45 seconds.
2ce0bfe4 210.It Cm ClientAliveInterval
211Sets a timeout interval in seconds after which if no data has been received
212from the client,
213.Nm sshd
214will send a message through the encrypted
215channel to request a response from the client.
216The default
217is 0, indicating that these messages will not be sent to the client.
218This option applies to protocol version 2 only.
884dc78b 219.It Cm Compression
2ce0bfe4 220Specifies whether compression is allowed, or delayed until
221the user has authenticated successfully.
884dc78b 222The argument must be
2ce0bfe4 223.Dq yes ,
224.Dq delayed ,
884dc78b 225or
226.Dq no .
227The default is
2ce0bfe4 228.Dq delayed .
884dc78b 229.It Cm DenyGroups
230This keyword can be followed by a list of group name patterns, separated
231by spaces.
232Login is disallowed for users whose primary group or supplementary
233group list matches one of the patterns.
234.Ql \&*
235and
7cac2b65 236.Ql \&?
884dc78b 237can be used as
238wildcards in the patterns.
239Only group names are valid; a numerical group ID is not recognized.
240By default, login is allowed for all groups.
884dc78b 241.It Cm DenyUsers
242This keyword can be followed by a list of user name patterns, separated
243by spaces.
244Login is disallowed for user names that match one of the patterns.
245.Ql \&*
246and
7cac2b65 247.Ql \&?
884dc78b 248can be used as wildcards in the patterns.
249Only user names are valid; a numerical user ID is not recognized.
250By default, login is allowed for all users.
251If the pattern takes the form USER@HOST then USER and HOST
252are separately checked, restricting logins to particular
253users from particular hosts.
254.It Cm GatewayPorts
255Specifies whether remote hosts are allowed to connect to ports
256forwarded for the client.
257By default,
258.Nm sshd
bfe49944 259binds remote port forwardings to the loopback address.
260This prevents other remote hosts from connecting to forwarded ports.
884dc78b 261.Cm GatewayPorts
262can be used to specify that
263.Nm sshd
dfddba3d 264should allow remote port forwardings to bind to non-loopback addresses, thus
265allowing other hosts to connect.
266The argument may be
267.Dq no
268to force remote port forwardings to be available to the local host only,
884dc78b 269.Dq yes
dfddba3d 270to force remote port forwardings to bind to the wildcard address, or
271.Dq clientspecified
272to allow the client to select the address to which the forwarding is bound.
884dc78b 273The default is
274.Dq no .
7cac2b65 275.It Cm GSSAPIAuthentication
276Specifies whether user authentication based on GSSAPI is allowed.
540d72c3 277The default is
c5448518 278.Dq yes .
7cac2b65 279Note that this option applies to protocol version 2 only.
c5448518 280.It Cm GSSAPIKeyExchange
fe4ad273 281Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange
282doesn't rely on ssh keys to verify host identity.
44a053a3 283The default is
284.Dq yes .
c5448518 285Note that this option applies to protocol version 2 only.
fe4ad273 286.It Cm GSSAPICleanupCredentials
287Specifies whether to automatically destroy the user's credentials cache
288on logout.
44a053a3 289The default is
290.Dq yes .
c5448518 291Note that this option applies to protocol version 2 only.
292.It Cm HostbasedAuthentication
293Specifies whether rhosts or /etc/hosts.equiv authentication together
294with successful public key client host authentication is allowed
295(hostbased authentication).
296This option is similar to
297.Cm RhostsRSAAuthentication
298and applies to protocol version 2 only.
52b36949 299The default is
c5448518 300.Dq no .
884dc78b 301.It Cm HostKey
302Specifies a file containing a private host key
303used by SSH.
304The default is
305.Pa /etc/ssh/ssh_host_key
306for protocol version 1, and
307.Pa /etc/ssh/ssh_host_rsa_key
308and
309.Pa /etc/ssh/ssh_host_dsa_key
310for protocol version 2.
311Note that
312.Nm sshd
313will refuse to use a file if it is group/world-accessible.
314It is possible to have multiple host key files.
315.Dq rsa1
316keys are used for version 1 and
317.Dq dsa
318or
319.Dq rsa
320are used for version 2 of the SSH protocol.
321.It Cm IgnoreRhosts
322Specifies that
323.Pa .rhosts
324and
325.Pa .shosts
326files will not be used in
884dc78b 327.Cm RhostsRSAAuthentication
328or
329.Cm HostbasedAuthentication .
330.Pp
331.Pa /etc/hosts.equiv
332and
333.Pa /etc/shosts.equiv
334are still used.
335The default is
336.Dq yes .
337.It Cm IgnoreUserKnownHosts
338Specifies whether
339.Nm sshd
340should ignore the user's
2ce0bfe4 341.Pa ~/.ssh/known_hosts
884dc78b 342during
343.Cm RhostsRSAAuthentication
344or
345.Cm HostbasedAuthentication .
346The default is
347.Dq no .
884dc78b 348.It Cm KerberosAuthentication
7cac2b65 349Specifies whether the password provided by the user for
884dc78b 350.Cm PasswordAuthentication
7cac2b65 351will be validated through the Kerberos KDC.
884dc78b 352To use this option, the server needs a
353Kerberos servtab which allows the verification of the KDC's identity.
354Default is
355.Dq no .
12a403af 356.It Cm KerberosGetAFSToken
08822d99 357If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
12a403af 358an AFS token before accessing the user's home directory.
359Default is
360.Dq no .
884dc78b 361.It Cm KerberosOrLocalPasswd
362If set then if password authentication through Kerberos fails then
363the password will be validated via any additional local mechanism
364such as
365.Pa /etc/passwd .
366Default is
367.Dq yes .
884dc78b 368.It Cm KerberosTicketCleanup
369Specifies whether to automatically destroy the user's ticket cache
370file on logout.
371Default is
372.Dq yes .
373.It Cm KeyRegenerationInterval
374In protocol version 1, the ephemeral server key is automatically regenerated
375after this many seconds (if it has been used).
376The purpose of regeneration is to prevent
377decrypting captured sessions by later breaking into the machine and
378stealing the keys.
379The key is never stored anywhere.
380If the value is 0, the key is never regenerated.
381The default is 3600 (seconds).
382.It Cm ListenAddress
383Specifies the local addresses
384.Nm sshd
385should listen on.
386The following forms may be used:
387.Pp
388.Bl -item -offset indent -compact
389.It
390.Cm ListenAddress
391.Sm off
392.Ar host No | Ar IPv4_addr No | Ar IPv6_addr
393.Sm on
394.It
395.Cm ListenAddress
396.Sm off
397.Ar host No | Ar IPv4_addr No : Ar port
398.Sm on
399.It
400.Cm ListenAddress
401.Sm off
402.Oo
403.Ar host No | Ar IPv6_addr Oc : Ar port
404.Sm on
405.El
406.Pp
407If
408.Ar port
409is not specified,
410.Nm sshd
411will listen on the address and all prior
412.Cm Port
7cac2b65 413options specified.
414The default is to listen on all local addresses.
bfe49944 415Multiple
884dc78b 416.Cm ListenAddress
7cac2b65 417options are permitted.
418Additionally, any
884dc78b 419.Cm Port
420options must precede this option for non port qualified addresses.
421.It Cm LoginGraceTime
422The server disconnects after this time if the user has not
423successfully logged in.
424If the value is 0, there is no time limit.
d03f4262 425The default is 120 seconds.
884dc78b 426.It Cm LogLevel
427Gives the verbosity level that is used when logging messages from
428.Nm sshd .
429The possible values are:
430QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
bfe49944 431The default is INFO.
432DEBUG and DEBUG1 are equivalent.
433DEBUG2 and DEBUG3 each specify higher levels of debugging output.
434Logging with a DEBUG level violates the privacy of users and is not recommended.
884dc78b 435.It Cm MACs
436Specifies the available MAC (message authentication code) algorithms.
437The MAC algorithm is used in protocol version 2
438for data integrity protection.
439Multiple algorithms must be comma-separated.
440The default is
441.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
7e82606e 442.It Cm MaxAuthTries
443Specifies the maximum number of authentication attempts permitted per
444connection.
445Once the number of failures reaches half this value,
446additional failures are logged.
447The default is 6.
884dc78b 448.It Cm MaxStartups
449Specifies the maximum number of concurrent unauthenticated connections to the
450.Nm sshd
451daemon.
452Additional connections will be dropped until authentication succeeds or the
453.Cm LoginGraceTime
454expires for a connection.
455The default is 10.
456.Pp
457Alternatively, random early drop can be enabled by specifying
458the three colon separated values
459.Dq start:rate:full
460(e.g., "10:30:60").
461.Nm sshd
462will refuse connection attempts with a probability of
463.Dq rate/100
464(30%)
465if there are currently
466.Dq start
467(10)
468unauthenticated connections.
469The probability increases linearly and all connection attempts
470are refused if the number of unauthenticated connections reaches
471.Dq full
472(60).
473.It Cm PasswordAuthentication
474Specifies whether password authentication is allowed.
475The default is
476.Dq yes .
477.It Cm PermitEmptyPasswords
478When password authentication is allowed, it specifies whether the
479server allows login to accounts with empty password strings.
480The default is
481.Dq no .
482.It Cm PermitRootLogin
dfddba3d 483Specifies whether root can log in using
884dc78b 484.Xr ssh 1 .
485The argument must be
486.Dq yes ,
487.Dq without-password ,
488.Dq forced-commands-only
489or
490.Dq no .
491The default is
492.Dq yes .
493.Pp
494If this option is set to
495.Dq without-password
dfddba3d 496password authentication is disabled for root.
884dc78b 497.Pp
498If this option is set to
499.Dq forced-commands-only
500root login with public key authentication will be allowed,
501but only if the
502.Ar command
503option has been specified
504(which may be useful for taking remote backups even if root login is
7cac2b65 505normally not allowed).
506All other authentication methods are disabled for root.
884dc78b 507.Pp
508If this option is set to
509.Dq no
dfddba3d 510root is not allowed to log in.
08822d99 511.It Cm PermitTunnel
512Specifies whether
513.Xr tun 4
514device forwarding is allowed.
515The argument must be
516.Dq yes ,
517.Dq point-to-point ,
518.Dq ethernet
519or
520.Dq no .
521The default is
522.Dq no .
d03f4262 523.It Cm PermitUserEnvironment
524Specifies whether
525.Pa ~/.ssh/environment
526and
527.Cm environment=
528options in
529.Pa ~/.ssh/authorized_keys
530are processed by
531.Nm sshd .
532The default is
533.Dq no .
534Enabling environment processing may enable users to bypass access
535restrictions in some configurations using mechanisms such as
536.Ev LD_PRELOAD .
884dc78b 537.It Cm PidFile
276b07a3 538Specifies the file that contains the process ID of the
884dc78b 539.Nm sshd
540daemon.
541The default is
542.Pa /var/run/sshd.pid .
543.It Cm Port
544Specifies the port number that
545.Nm sshd
546listens on.
547The default is 22.
548Multiple options of this type are permitted.
549See also
550.Cm ListenAddress .
551.It Cm PrintLastLog
552Specifies whether
553.Nm sshd
dfddba3d 554should print the date and time of the last user login when a user logs
555in interactively.
884dc78b 556The default is
557.Dq yes .
558.It Cm PrintMotd
559Specifies whether
560.Nm sshd
561should print
562.Pa /etc/motd
563when a user logs in interactively.
564(On some systems it is also printed by the shell,
565.Pa /etc/profile ,
566or equivalent.)
567The default is
568.Dq yes .
569.It Cm Protocol
570Specifies the protocol versions
571.Nm sshd
d03f4262 572supports.
884dc78b 573The possible values are
574.Dq 1
575and
576.Dq 2 .
577Multiple versions must be comma-separated.
578The default is
579.Dq 2,1 .
d03f4262 580Note that the order of the protocol list does not indicate preference,
581because the client selects among multiple protocol versions offered
582by the server.
583Specifying
584.Dq 2,1
585is identical to
586.Dq 1,2 .
884dc78b 587.It Cm PubkeyAuthentication
588Specifies whether public key authentication is allowed.
589The default is
590.Dq yes .
591Note that this option applies to protocol version 2 only.
884dc78b 592.It Cm RhostsRSAAuthentication
593Specifies whether rhosts or /etc/hosts.equiv authentication together
594with successful RSA host authentication is allowed.
595The default is
596.Dq no .
597This option applies to protocol version 1 only.
598.It Cm RSAAuthentication
599Specifies whether pure RSA authentication is allowed.
600The default is
601.Dq yes .
602This option applies to protocol version 1 only.
603.It Cm ServerKeyBits
604Defines the number of bits in the ephemeral protocol version 1 server key.
605The minimum value is 512, and the default is 768.
606.It Cm StrictModes
607Specifies whether
608.Nm sshd
609should check file modes and ownership of the
610user's files and home directory before accepting login.
611This is normally desirable because novices sometimes accidentally leave their
612directory or files world-writable.
613The default is
614.Dq yes .
615.It Cm Subsystem
616Configures an external subsystem (e.g., file transfer daemon).
617Arguments should be a subsystem name and a command to execute upon subsystem
618request.
619The command
620.Xr sftp-server 8
621implements the
622.Dq sftp
623file transfer subsystem.
624By default no subsystems are defined.
625Note that this option applies to protocol version 2 only.
626.It Cm SyslogFacility
627Gives the facility code that is used when logging messages from
628.Nm sshd .
629The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
630LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
631The default is AUTH.
540d72c3 632.It Cm TCPKeepAlive
633Specifies whether the system should send TCP keepalive messages to the
634other side.
635If they are sent, death of the connection or crash of one
636of the machines will be properly noticed.
637However, this means that
638connections will die if the route is down temporarily, and some people
639find it annoying.
640On the other hand, if TCP keepalives are not sent,
641sessions may hang indefinitely on the server, leaving
642.Dq ghost
643users and consuming server resources.
644.Pp
645The default is
646.Dq yes
647(to send TCP keepalive messages), and the server will notice
648if the network goes down or the client host crashes.
649This avoids infinitely hanging sessions.
650.Pp
651To disable TCP keepalive messages, the value should be set to
652.Dq no .
7cac2b65 653.It Cm UseDNS
654Specifies whether
655.Nm sshd
8b32eddc 656should look up the remote host name and check that
7cac2b65 657the resolved host name for the remote IP address maps back to the
658very same IP address.
659The default is
660.Dq yes .
884dc78b 661.It Cm UseLogin
662Specifies whether
663.Xr login 1
664is used for interactive login sessions.
665The default is
666.Dq no .
667Note that
668.Xr login 1
669is never used for remote command execution.
670Note also, that if this is enabled,
671.Cm X11Forwarding
672will be disabled because
673.Xr login 1
674does not know how to handle
675.Xr xauth 1
bfe49944 676cookies.
677If
884dc78b 678.Cm UsePrivilegeSeparation
679is specified, it will be disabled after authentication.
7cac2b65 680.It Cm UsePAM
7e82606e 681Enables the Pluggable Authentication Module interface.
682If set to
683.Dq yes
684this will enable PAM authentication using
685.Cm ChallengeResponseAuthentication
686and PAM account and session module processing for all authentication types.
687.Pp
688Because PAM challenge-response authentication usually serves an equivalent
689role to password authentication, you should disable either
690.Cm PasswordAuthentication
691or
692.Cm ChallengeResponseAuthentication.
693.Pp
694If
695.Cm UsePAM
696is enabled, you will not be able to run
697.Xr sshd 8
698as a non-root user.
699The default is
540d72c3 700.Dq no .
884dc78b 701.It Cm UsePrivilegeSeparation
702Specifies whether
703.Nm sshd
704separates privileges by creating an unprivileged child process
bfe49944 705to deal with incoming network traffic.
706After successful authentication, another process will be created that has
707the privilege of the authenticated user.
708The goal of privilege separation is to prevent privilege
884dc78b 709escalation by containing any corruption within the unprivileged processes.
710The default is
711.Dq yes .
884dc78b 712.It Cm X11DisplayOffset
713Specifies the first display number available for
714.Nm sshd Ns 's
715X11 forwarding.
716This prevents
717.Nm sshd
718from interfering with real X11 servers.
719The default is 10.
720.It Cm X11Forwarding
721Specifies whether X11 forwarding is permitted.
d03f4262 722The argument must be
723.Dq yes
724or
725.Dq no .
884dc78b 726The default is
727.Dq no .
d03f4262 728.Pp
729When X11 forwarding is enabled, there may be additional exposure to
730the server and to client displays if the
731.Nm sshd
732proxy display is configured to listen on the wildcard address (see
733.Cm X11UseLocalhost
734below), however this is not the default.
735Additionally, the authentication spoofing and authentication data
736verification and substitution occur on the client side.
737The security risk of using X11 forwarding is that the client's X11
738display server may be exposed to attack when the ssh client requests
739forwarding (see the warnings for
740.Cm ForwardX11
741in
7cac2b65 742.Xr ssh_config 5 ) .
d03f4262 743A system administrator may have a stance in which they want to
744protect clients that may expose themselves to attack by unwittingly
745requesting X11 forwarding, which can warrant a
746.Dq no
747setting.
748.Pp
749Note that disabling X11 forwarding does not prevent users from
750forwarding X11 traffic, as users can always install their own forwarders.
884dc78b 751X11 forwarding is automatically disabled if
752.Cm UseLogin
753is enabled.
754.It Cm X11UseLocalhost
755Specifies whether
756.Nm sshd
757should bind the X11 forwarding server to the loopback address or to
bfe49944 758the wildcard address.
759By default,
884dc78b 760.Nm sshd
761binds the forwarding server to the loopback address and sets the
762hostname part of the
763.Ev DISPLAY
764environment variable to
765.Dq localhost .
d03f4262 766This prevents remote hosts from connecting to the proxy display.
884dc78b 767However, some older X11 clients may not function with this
768configuration.
769.Cm X11UseLocalhost
770may be set to
771.Dq no
772to specify that the forwarding server should be bound to the wildcard
773address.
774The argument must be
775.Dq yes
776or
777.Dq no .
778The default is
779.Dq yes .
780.It Cm XAuthLocation
d03f4262 781Specifies the full pathname of the
884dc78b 782.Xr xauth 1
783program.
784The default is
785.Pa /usr/X11R6/bin/xauth .
786.El
787.Ss Time Formats
884dc78b 788.Nm sshd
789command-line arguments and configuration file options that specify time
790may be expressed using a sequence of the form:
791.Sm off
d03f4262 792.Ar time Op Ar qualifier ,
884dc78b 793.Sm on
794where
795.Ar time
796is a positive integer value and
797.Ar qualifier
798is one of the following:
799.Pp
800.Bl -tag -width Ds -compact -offset indent
801.It Cm <none>
802seconds
803.It Cm s | Cm S
804seconds
805.It Cm m | Cm M
806minutes
807.It Cm h | Cm H
808hours
809.It Cm d | Cm D
810days
811.It Cm w | Cm W
812weeks
813.El
814.Pp
815Each member of the sequence is added together to calculate
816the total time value.
817.Pp
818Time format examples:
819.Pp
820.Bl -tag -width Ds -compact -offset indent
821.It 600
822600 seconds (10 minutes)
823.It 10m
82410 minutes
825.It 1h30m
8261 hour 30 minutes (90 minutes)
827.El
828.Sh FILES
829.Bl -tag -width Ds
830.It Pa /etc/ssh/sshd_config
831Contains configuration data for
832.Nm sshd .
833This file should be writable by root only, but it is recommended
834(though not necessary) that it be world-readable.
835.El
7cac2b65 836.Sh SEE ALSO
837.Xr sshd 8
884dc78b 838.Sh AUTHORS
839OpenSSH is a derivative of the original and free
840ssh 1.2.12 release by Tatu Ylonen.
841Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
842Theo de Raadt and Dug Song
843removed many bugs, re-added newer features and
844created OpenSSH.
845Markus Friedl contributed the support for SSH
846protocol versions 1.5 and 2.0.
847Niels Provos and Markus Friedl contributed support
848for privilege separation.
This page took 0.169056 seconds and 5 git commands to generate.