]> andersk Git - gssapi-openssh.git/blame - openssh/sshd_config.5
initialize pointers to avoid compiler warnings
[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.\"
2ce0bfe4 37.\" $OpenBSD: sshd_config.5,v 1.44 2005/07/25 11:59:40 markus 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
184Sets the number of client alive messages (see above) which may be
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
206(above) is set to 15, and
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.
94b7f692 280.It Cm GSSAPICleanupCredentials
7cac2b65 281Specifies whether to automatically destroy the user's credentials cache
282on logout.
283The default is
284.Dq yes .
285Note that this option applies to protocol version 2 only.
c5448518 286.It Cm GSSAPIKeyExchange
44a053a3 287Specifies whether key exchange based on GSSAPI may be used. When using
288GSSAPI key exchange the server need not have a host key.
289The default is
290.Dq yes .
c5448518 291Note that this option applies to protocol version 2 only.
292.It Cm GSSAPIUseSessionCredCache
44a053a3 293Specifies whether a unique credentials cache name should be generated per
294session for storing delegated credentials.
295The default is
296.Dq yes .
c5448518 297Note that this option applies to protocol version 2 only.
298.It Cm HostbasedAuthentication
299Specifies whether rhosts or /etc/hosts.equiv authentication together
300with successful public key client host authentication is allowed
301(hostbased authentication).
302This option is similar to
303.Cm RhostsRSAAuthentication
304and applies to protocol version 2 only.
52b36949 305The default is
c5448518 306.Dq no .
884dc78b 307.It Cm HostKey
308Specifies a file containing a private host key
309used by SSH.
310The default is
311.Pa /etc/ssh/ssh_host_key
312for protocol version 1, and
313.Pa /etc/ssh/ssh_host_rsa_key
314and
315.Pa /etc/ssh/ssh_host_dsa_key
316for protocol version 2.
317Note that
318.Nm sshd
319will refuse to use a file if it is group/world-accessible.
320It is possible to have multiple host key files.
321.Dq rsa1
322keys are used for version 1 and
323.Dq dsa
324or
325.Dq rsa
326are used for version 2 of the SSH protocol.
327.It Cm IgnoreRhosts
328Specifies that
329.Pa .rhosts
330and
331.Pa .shosts
332files will not be used in
884dc78b 333.Cm RhostsRSAAuthentication
334or
335.Cm HostbasedAuthentication .
336.Pp
337.Pa /etc/hosts.equiv
338and
339.Pa /etc/shosts.equiv
340are still used.
341The default is
342.Dq yes .
343.It Cm IgnoreUserKnownHosts
344Specifies whether
345.Nm sshd
346should ignore the user's
2ce0bfe4 347.Pa ~/.ssh/known_hosts
884dc78b 348during
349.Cm RhostsRSAAuthentication
350or
351.Cm HostbasedAuthentication .
352The default is
353.Dq no .
884dc78b 354.It Cm KerberosAuthentication
7cac2b65 355Specifies whether the password provided by the user for
884dc78b 356.Cm PasswordAuthentication
7cac2b65 357will be validated through the Kerberos KDC.
884dc78b 358To use this option, the server needs a
359Kerberos servtab which allows the verification of the KDC's identity.
360Default is
361.Dq no .
12a403af 362.It Cm KerberosGetAFSToken
363If AFS is active and the user has a Kerberos 5 TGT, attempt to aquire
364an AFS token before accessing the user's home directory.
365Default is
366.Dq no .
884dc78b 367.It Cm KerberosOrLocalPasswd
368If set then if password authentication through Kerberos fails then
369the password will be validated via any additional local mechanism
370such as
371.Pa /etc/passwd .
372Default is
373.Dq yes .
884dc78b 374.It Cm KerberosTicketCleanup
375Specifies whether to automatically destroy the user's ticket cache
376file on logout.
377Default is
378.Dq yes .
379.It Cm KeyRegenerationInterval
380In protocol version 1, the ephemeral server key is automatically regenerated
381after this many seconds (if it has been used).
382The purpose of regeneration is to prevent
383decrypting captured sessions by later breaking into the machine and
384stealing the keys.
385The key is never stored anywhere.
386If the value is 0, the key is never regenerated.
387The default is 3600 (seconds).
388.It Cm ListenAddress
389Specifies the local addresses
390.Nm sshd
391should listen on.
392The following forms may be used:
393.Pp
394.Bl -item -offset indent -compact
395.It
396.Cm ListenAddress
397.Sm off
398.Ar host No | Ar IPv4_addr No | Ar IPv6_addr
399.Sm on
400.It
401.Cm ListenAddress
402.Sm off
403.Ar host No | Ar IPv4_addr No : Ar port
404.Sm on
405.It
406.Cm ListenAddress
407.Sm off
408.Oo
409.Ar host No | Ar IPv6_addr Oc : Ar port
410.Sm on
411.El
412.Pp
413If
414.Ar port
415is not specified,
416.Nm sshd
417will listen on the address and all prior
418.Cm Port
7cac2b65 419options specified.
420The default is to listen on all local addresses.
bfe49944 421Multiple
884dc78b 422.Cm ListenAddress
7cac2b65 423options are permitted.
424Additionally, any
884dc78b 425.Cm Port
426options must precede this option for non port qualified addresses.
427.It Cm LoginGraceTime
428The server disconnects after this time if the user has not
429successfully logged in.
430If the value is 0, there is no time limit.
d03f4262 431The default is 120 seconds.
884dc78b 432.It Cm LogLevel
433Gives the verbosity level that is used when logging messages from
434.Nm sshd .
435The possible values are:
436QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
bfe49944 437The default is INFO.
438DEBUG and DEBUG1 are equivalent.
439DEBUG2 and DEBUG3 each specify higher levels of debugging output.
440Logging with a DEBUG level violates the privacy of users and is not recommended.
884dc78b 441.It Cm MACs
442Specifies the available MAC (message authentication code) algorithms.
443The MAC algorithm is used in protocol version 2
444for data integrity protection.
445Multiple algorithms must be comma-separated.
446The default is
447.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
7e82606e 448.It Cm MaxAuthTries
449Specifies the maximum number of authentication attempts permitted per
450connection.
451Once the number of failures reaches half this value,
452additional failures are logged.
453The default is 6.
884dc78b 454.It Cm MaxStartups
455Specifies the maximum number of concurrent unauthenticated connections to the
456.Nm sshd
457daemon.
458Additional connections will be dropped until authentication succeeds or the
459.Cm LoginGraceTime
460expires for a connection.
461The default is 10.
462.Pp
463Alternatively, random early drop can be enabled by specifying
464the three colon separated values
465.Dq start:rate:full
466(e.g., "10:30:60").
467.Nm sshd
468will refuse connection attempts with a probability of
469.Dq rate/100
470(30%)
471if there are currently
472.Dq start
473(10)
474unauthenticated connections.
475The probability increases linearly and all connection attempts
476are refused if the number of unauthenticated connections reaches
477.Dq full
478(60).
479.It Cm PasswordAuthentication
480Specifies whether password authentication is allowed.
481The default is
482.Dq yes .
483.It Cm PermitEmptyPasswords
484When password authentication is allowed, it specifies whether the
485server allows login to accounts with empty password strings.
486The default is
487.Dq no .
488.It Cm PermitRootLogin
dfddba3d 489Specifies whether root can log in using
884dc78b 490.Xr ssh 1 .
491The argument must be
492.Dq yes ,
493.Dq without-password ,
494.Dq forced-commands-only
495or
496.Dq no .
497The default is
498.Dq yes .
499.Pp
500If this option is set to
501.Dq without-password
dfddba3d 502password authentication is disabled for root.
884dc78b 503.Pp
504If this option is set to
505.Dq forced-commands-only
506root login with public key authentication will be allowed,
507but only if the
508.Ar command
509option has been specified
510(which may be useful for taking remote backups even if root login is
7cac2b65 511normally not allowed).
512All other authentication methods are disabled for root.
884dc78b 513.Pp
514If this option is set to
515.Dq no
dfddba3d 516root is not allowed to log in.
d03f4262 517.It Cm PermitUserEnvironment
518Specifies whether
519.Pa ~/.ssh/environment
520and
521.Cm environment=
522options in
523.Pa ~/.ssh/authorized_keys
524are processed by
525.Nm sshd .
526The default is
527.Dq no .
528Enabling environment processing may enable users to bypass access
529restrictions in some configurations using mechanisms such as
530.Ev LD_PRELOAD .
884dc78b 531.It Cm PidFile
276b07a3 532Specifies the file that contains the process ID of the
884dc78b 533.Nm sshd
534daemon.
535The default is
536.Pa /var/run/sshd.pid .
537.It Cm Port
538Specifies the port number that
539.Nm sshd
540listens on.
541The default is 22.
542Multiple options of this type are permitted.
543See also
544.Cm ListenAddress .
545.It Cm PrintLastLog
546Specifies whether
547.Nm sshd
dfddba3d 548should print the date and time of the last user login when a user logs
549in interactively.
884dc78b 550The default is
551.Dq yes .
552.It Cm PrintMotd
553Specifies whether
554.Nm sshd
555should print
556.Pa /etc/motd
557when a user logs in interactively.
558(On some systems it is also printed by the shell,
559.Pa /etc/profile ,
560or equivalent.)
561The default is
562.Dq yes .
563.It Cm Protocol
564Specifies the protocol versions
565.Nm sshd
d03f4262 566supports.
884dc78b 567The possible values are
568.Dq 1
569and
570.Dq 2 .
571Multiple versions must be comma-separated.
572The default is
573.Dq 2,1 .
d03f4262 574Note that the order of the protocol list does not indicate preference,
575because the client selects among multiple protocol versions offered
576by the server.
577Specifying
578.Dq 2,1
579is identical to
580.Dq 1,2 .
884dc78b 581.It Cm PubkeyAuthentication
582Specifies whether public key authentication is allowed.
583The default is
584.Dq yes .
585Note that this option applies to protocol version 2 only.
884dc78b 586.It Cm RhostsRSAAuthentication
587Specifies whether rhosts or /etc/hosts.equiv authentication together
588with successful RSA host authentication is allowed.
589The default is
590.Dq no .
591This option applies to protocol version 1 only.
592.It Cm RSAAuthentication
593Specifies whether pure RSA authentication is allowed.
594The default is
595.Dq yes .
596This option applies to protocol version 1 only.
597.It Cm ServerKeyBits
598Defines the number of bits in the ephemeral protocol version 1 server key.
599The minimum value is 512, and the default is 768.
600.It Cm StrictModes
601Specifies whether
602.Nm sshd
603should check file modes and ownership of the
604user's files and home directory before accepting login.
605This is normally desirable because novices sometimes accidentally leave their
606directory or files world-writable.
607The default is
608.Dq yes .
609.It Cm Subsystem
610Configures an external subsystem (e.g., file transfer daemon).
611Arguments should be a subsystem name and a command to execute upon subsystem
612request.
613The command
614.Xr sftp-server 8
615implements the
616.Dq sftp
617file transfer subsystem.
618By default no subsystems are defined.
619Note that this option applies to protocol version 2 only.
620.It Cm SyslogFacility
621Gives the facility code that is used when logging messages from
622.Nm sshd .
623The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
624LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
625The default is AUTH.
540d72c3 626.It Cm TCPKeepAlive
627Specifies whether the system should send TCP keepalive messages to the
628other side.
629If they are sent, death of the connection or crash of one
630of the machines will be properly noticed.
631However, this means that
632connections will die if the route is down temporarily, and some people
633find it annoying.
634On the other hand, if TCP keepalives are not sent,
635sessions may hang indefinitely on the server, leaving
636.Dq ghost
637users and consuming server resources.
638.Pp
639The default is
640.Dq yes
641(to send TCP keepalive messages), and the server will notice
642if the network goes down or the client host crashes.
643This avoids infinitely hanging sessions.
644.Pp
645To disable TCP keepalive messages, the value should be set to
646.Dq no .
7cac2b65 647.It Cm UseDNS
648Specifies whether
649.Nm sshd
8b32eddc 650should look up the remote host name and check that
7cac2b65 651the resolved host name for the remote IP address maps back to the
652very same IP address.
653The default is
654.Dq yes .
884dc78b 655.It Cm UseLogin
656Specifies whether
657.Xr login 1
658is used for interactive login sessions.
659The default is
660.Dq no .
661Note that
662.Xr login 1
663is never used for remote command execution.
664Note also, that if this is enabled,
665.Cm X11Forwarding
666will be disabled because
667.Xr login 1
668does not know how to handle
669.Xr xauth 1
bfe49944 670cookies.
671If
884dc78b 672.Cm UsePrivilegeSeparation
673is specified, it will be disabled after authentication.
7cac2b65 674.It Cm UsePAM
7e82606e 675Enables the Pluggable Authentication Module interface.
676If set to
677.Dq yes
678this will enable PAM authentication using
679.Cm ChallengeResponseAuthentication
680and PAM account and session module processing for all authentication types.
681.Pp
682Because PAM challenge-response authentication usually serves an equivalent
683role to password authentication, you should disable either
684.Cm PasswordAuthentication
685or
686.Cm ChallengeResponseAuthentication.
687.Pp
688If
689.Cm UsePAM
690is enabled, you will not be able to run
691.Xr sshd 8
692as a non-root user.
693The default is
540d72c3 694.Dq no .
884dc78b 695.It Cm UsePrivilegeSeparation
696Specifies whether
697.Nm sshd
698separates privileges by creating an unprivileged child process
bfe49944 699to deal with incoming network traffic.
700After successful authentication, another process will be created that has
701the privilege of the authenticated user.
702The goal of privilege separation is to prevent privilege
884dc78b 703escalation by containing any corruption within the unprivileged processes.
704The default is
705.Dq yes .
884dc78b 706.It Cm X11DisplayOffset
707Specifies the first display number available for
708.Nm sshd Ns 's
709X11 forwarding.
710This prevents
711.Nm sshd
712from interfering with real X11 servers.
713The default is 10.
714.It Cm X11Forwarding
715Specifies whether X11 forwarding is permitted.
d03f4262 716The argument must be
717.Dq yes
718or
719.Dq no .
884dc78b 720The default is
721.Dq no .
d03f4262 722.Pp
723When X11 forwarding is enabled, there may be additional exposure to
724the server and to client displays if the
725.Nm sshd
726proxy display is configured to listen on the wildcard address (see
727.Cm X11UseLocalhost
728below), however this is not the default.
729Additionally, the authentication spoofing and authentication data
730verification and substitution occur on the client side.
731The security risk of using X11 forwarding is that the client's X11
732display server may be exposed to attack when the ssh client requests
733forwarding (see the warnings for
734.Cm ForwardX11
735in
7cac2b65 736.Xr ssh_config 5 ) .
d03f4262 737A system administrator may have a stance in which they want to
738protect clients that may expose themselves to attack by unwittingly
739requesting X11 forwarding, which can warrant a
740.Dq no
741setting.
742.Pp
743Note that disabling X11 forwarding does not prevent users from
744forwarding X11 traffic, as users can always install their own forwarders.
884dc78b 745X11 forwarding is automatically disabled if
746.Cm UseLogin
747is enabled.
748.It Cm X11UseLocalhost
749Specifies whether
750.Nm sshd
751should bind the X11 forwarding server to the loopback address or to
bfe49944 752the wildcard address.
753By default,
884dc78b 754.Nm sshd
755binds the forwarding server to the loopback address and sets the
756hostname part of the
757.Ev DISPLAY
758environment variable to
759.Dq localhost .
d03f4262 760This prevents remote hosts from connecting to the proxy display.
884dc78b 761However, some older X11 clients may not function with this
762configuration.
763.Cm X11UseLocalhost
764may be set to
765.Dq no
766to specify that the forwarding server should be bound to the wildcard
767address.
768The argument must be
769.Dq yes
770or
771.Dq no .
772The default is
773.Dq yes .
774.It Cm XAuthLocation
d03f4262 775Specifies the full pathname of the
884dc78b 776.Xr xauth 1
777program.
778The default is
779.Pa /usr/X11R6/bin/xauth .
780.El
781.Ss Time Formats
884dc78b 782.Nm sshd
783command-line arguments and configuration file options that specify time
784may be expressed using a sequence of the form:
785.Sm off
d03f4262 786.Ar time Op Ar qualifier ,
884dc78b 787.Sm on
788where
789.Ar time
790is a positive integer value and
791.Ar qualifier
792is one of the following:
793.Pp
794.Bl -tag -width Ds -compact -offset indent
795.It Cm <none>
796seconds
797.It Cm s | Cm S
798seconds
799.It Cm m | Cm M
800minutes
801.It Cm h | Cm H
802hours
803.It Cm d | Cm D
804days
805.It Cm w | Cm W
806weeks
807.El
808.Pp
809Each member of the sequence is added together to calculate
810the total time value.
811.Pp
812Time format examples:
813.Pp
814.Bl -tag -width Ds -compact -offset indent
815.It 600
816600 seconds (10 minutes)
817.It 10m
81810 minutes
819.It 1h30m
8201 hour 30 minutes (90 minutes)
821.El
822.Sh FILES
823.Bl -tag -width Ds
824.It Pa /etc/ssh/sshd_config
825Contains configuration data for
826.Nm sshd .
827This file should be writable by root only, but it is recommended
828(though not necessary) that it be world-readable.
829.El
7cac2b65 830.Sh SEE ALSO
831.Xr sshd 8
884dc78b 832.Sh AUTHORS
833OpenSSH is a derivative of the original and free
834ssh 1.2.12 release by Tatu Ylonen.
835Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
836Theo de Raadt and Dug Song
837removed many bugs, re-added newer features and
838created OpenSSH.
839Markus Friedl contributed the support for SSH
840protocol versions 1.5 and 2.0.
841Niels Provos and Markus Friedl contributed support
842for privilege separation.
This page took 0.197151 seconds and 5 git commands to generate.