3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\" All rights reserved
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".
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.
17 .\" Redistribution and use in source and binary forms, with or without
18 .\" modification, are permitted provided that the following conditions
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.
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.
37 .\" $OpenBSD: sshd_config.5,v 1.70 2006/08/21 08:14:01 dtucker Exp $
38 .Dd September 25, 1999
43 .Nd OpenSSH SSH daemon configuration file
45 .Bl -tag -width Ds -compact
46 .It Pa /etc/ssh/sshd_config
50 reads configuration data from
51 .Pa /etc/ssh/sshd_config
52 (or the file specified with
55 The file contains keyword-argument pairs, one per line.
58 and empty lines are interpreted as comments.
59 Arguments may optionally be enclosed in double quotes
61 in order to represent arguments containing spaces.
64 keywords and their meanings are as follows (note that
65 keywords are case-insensitive and arguments are case-sensitive):
68 Specifies what environment variables sent by the client will be copied into
75 for how to configure the client.
76 Note that environment passing is only supported for protocol 2.
77 Variables are specified by name, which may contain the wildcard characters
81 Multiple environment variables may be separated by whitespace or spread
85 Be warned that some environment variables could be used to bypass restricted
87 For this reason, care should be taken in the use of this directive.
88 The default is not to accept any environment variables.
90 Specifies which address family should be used by
101 This keyword can be followed by a list of group name patterns, separated
103 If specified, login is allowed only for users whose primary
104 group or supplementary group list matches one of the patterns.
105 Only group names are valid; a numerical group ID is not recognized.
106 By default, login is allowed for all groups.
107 The allow/deny directives are processed in the following order:
118 for more information on patterns.
119 .It Cm AllowTcpForwarding
120 Specifies whether TCP forwarding is permitted.
123 Note that disabling TCP forwarding does not improve security unless
124 users are also denied shell access, as they can always install their
127 This keyword can be followed by a list of user name patterns, separated
129 If specified, login is allowed only for user names that
130 match one of the patterns.
131 Only user names are valid; a numerical user ID is not recognized.
132 By default, login is allowed for all users.
133 If the pattern takes the form USER@HOST then USER and HOST
134 are separately checked, restricting logins to particular
135 users from particular hosts.
136 The allow/deny directives are processed in the following order:
147 for more information on patterns.
148 .It Cm AuthorizedKeysFile
149 Specifies the file that contains the public keys that can be used
150 for user authentication.
151 .Cm AuthorizedKeysFile
152 may contain tokens of the form %T which are substituted during connection
154 The following tokens are defined: %% is replaced by a literal '%',
155 %h is replaced by the home directory of the user being authenticated, and
156 %u is replaced by the username of that user.
158 .Cm AuthorizedKeysFile
159 is taken to be an absolute path or one relative to the user's home
162 .Dq .ssh/authorized_keys .
164 In some jurisdictions, sending a warning message before authentication
165 may be relevant for getting legal protection.
166 The contents of the specified file are sent to the remote user before
167 authentication is allowed.
168 This option is only available for protocol version 2.
169 By default, no banner is displayed.
170 .It Cm ChallengeResponseAuthentication
171 Specifies whether challenge-response authentication is allowed.
172 All authentication styles from
178 Specifies the ciphers allowed for protocol version 2.
179 Multiple ciphers must be comma-separated.
180 The supported ciphers are
195 .Bd -literal -offset 3n
196 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
197 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
198 aes192-ctr,aes256-ctr
200 .It Cm ClientAliveCountMax
201 Sets the number of client alive messages (see below) which may be
204 receiving any messages back from the client.
205 If this threshold is reached while client alive messages are being sent,
206 sshd will disconnect the client, terminating the session.
207 It is important to note that the use of client alive messages is very
211 The client alive messages are sent through the encrypted channel
212 and therefore will not be spoofable.
213 The TCP keepalive option enabled by
216 The client alive mechanism is valuable when the client or
217 server depend on knowing when a connection has become inactive.
219 The default value is 3.
221 .Cm ClientAliveInterval
222 (see below) is set to 15, and
223 .Cm ClientAliveCountMax
224 is left at the default, unresponsive SSH clients
225 will be disconnected after approximately 45 seconds.
226 This option applies to protocol version 2 only.
227 .It Cm ClientAliveInterval
228 Sets a timeout interval in seconds after which if no data has been received
231 will send a message through the encrypted
232 channel to request a response from the client.
234 is 0, indicating that these messages will not be sent to the client.
235 This option applies to protocol version 2 only.
237 Specifies whether compression is allowed, or delayed until
238 the user has authenticated successfully.
247 This keyword can be followed by a list of group name patterns, separated
249 Login is disallowed for users whose primary group or supplementary
250 group list matches one of the patterns.
251 Only group names are valid; a numerical group ID is not recognized.
252 By default, login is allowed for all groups.
253 The allow/deny directives are processed in the following order:
264 for more information on patterns.
266 This keyword can be followed by a list of user name patterns, separated
268 Login is disallowed for user names that match one of the patterns.
269 Only user names are valid; a numerical user ID is not recognized.
270 By default, login is allowed for all users.
271 If the pattern takes the form USER@HOST then USER and HOST
272 are separately checked, restricting logins to particular
273 users from particular hosts.
274 The allow/deny directives are processed in the following order:
285 for more information on patterns.
287 Forces the execution of the command specified by
289 ignoring any command supplied by the client.
290 The command is invoked by using the user's login shell with the -c option.
291 This applies to shell, command, or subsystem execution.
292 It is most useful inside a
295 The command originally supplied by the client is available in the
296 .Ev SSH_ORIGINAL_COMMAND
297 environment variable.
299 Specifies whether remote hosts are allowed to connect to ports
300 forwarded for the client.
303 binds remote port forwardings to the loopback address.
304 This prevents other remote hosts from connecting to forwarded ports.
306 can be used to specify that sshd
307 should allow remote port forwardings to bind to non-loopback addresses, thus
308 allowing other hosts to connect.
311 to force remote port forwardings to be available to the local host only,
313 to force remote port forwardings to bind to the wildcard address, or
315 to allow the client to select the address to which the forwarding is bound.
318 .It Cm GSSAPIAuthentication
319 Specifies whether user authentication based on GSSAPI is allowed.
322 Note that this option applies to protocol version 2 only.
323 .It Cm GSSAPIKeyExchange
324 Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange
325 doesn't rely on ssh keys to verify host identity.
328 Note that this option applies to protocol version 2 only.
329 .It Cm GSSAPICleanupCredentials
330 Specifies whether to automatically destroy the user's credentials cache
334 Note that this option applies to protocol version 2 only.
335 .It Cm GSSAPIStrictAcceptorCheck
336 Determines whether to be strict about the identity of the GSSAPI acceptor
337 a client authenticates against. If
339 then the client must authenticate against the
341 service on the current hostname. If
343 then the client may authenticate against any service key stored in the
344 machine's default store. This facility is provided to assist with operation
345 on multi homed machines.
348 Note that this option applies only to protocol version 2 GSSAPI connections,
351 may only work with recent Kerberos GSSAPI libraries.
352 .It Cm GSSAPICredentialsPath
353 If specified, the delegated GSSAPI credential is stored in the
354 given path, overwriting any existing credentials.
355 Paths can be specified with syntax similar to the AuthorizedKeysFile
356 option (i.e., accepting %h and %u tokens).
357 When using this option,
358 setting 'GssapiCleanupCredentials no' is recommended,
359 so logging out of one session
360 doesn't remove the credentials in use by another session of
362 Currently only implemented for the GSI mechanism.
363 .It Cm GSIAllowLimitedProxy
364 Specifies whether to accept limited proxy credentials for
368 .It Cm HostbasedAuthentication
369 Specifies whether rhosts or /etc/hosts.equiv authentication together
370 with successful public key client host authentication is allowed
371 (host-based authentication).
372 This option is similar to
373 .Cm RhostsRSAAuthentication
374 and applies to protocol version 2 only.
377 .It Cm HostbasedUsesNameFromPacketOnly
378 Specifies whether or not the server will attempt to perform a reverse
379 name lookup when matching the name in the
385 .Cm HostbasedAuthentication .
390 uses the name supplied by the client rather than
391 attempting to resolve the name from the TCP connection itself.
395 Specifies a file containing a private host key
398 .Pa /etc/ssh/ssh_host_key
399 for protocol version 1, and
400 .Pa /etc/ssh/ssh_host_rsa_key
402 .Pa /etc/ssh/ssh_host_dsa_key
403 for protocol version 2.
406 will refuse to use a file if it is group/world-accessible.
407 It is possible to have multiple host key files.
409 keys are used for version 1 and
413 are used for version 2 of the SSH protocol.
419 files will not be used in
420 .Cm RhostsRSAAuthentication
422 .Cm HostbasedAuthentication .
426 .Pa /etc/shosts.equiv
430 .It Cm IgnoreUserKnownHosts
433 should ignore the user's
434 .Pa ~/.ssh/known_hosts
436 .Cm RhostsRSAAuthentication
438 .Cm HostbasedAuthentication .
441 .It Cm KerberosAuthentication
442 Specifies whether the password provided by the user for
443 .Cm PasswordAuthentication
444 will be validated through the Kerberos KDC.
445 To use this option, the server needs a
446 Kerberos servtab which allows the verification of the KDC's identity.
449 .It Cm KerberosGetAFSToken
450 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
451 an AFS token before accessing the user's home directory.
454 .It Cm KerberosOrLocalPasswd
455 If password authentication through Kerberos fails then
456 the password will be validated via any additional local mechanism
461 .It Cm KerberosTicketCleanup
462 Specifies whether to automatically destroy the user's ticket cache
466 .It Cm KeyRegenerationInterval
467 In protocol version 1, the ephemeral server key is automatically regenerated
468 after this many seconds (if it has been used).
469 The purpose of regeneration is to prevent
470 decrypting captured sessions by later breaking into the machine and
472 The key is never stored anywhere.
473 If the value is 0, the key is never regenerated.
474 The default is 3600 (seconds).
476 Specifies the local addresses
479 The following forms may be used:
481 .Bl -item -offset indent -compact
485 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
490 .Ar host No | Ar IPv4_addr No : Ar port
496 .Ar host No | Ar IPv6_addr Oc : Ar port
503 sshd will listen on the address and all prior
506 The default is to listen on all local addresses.
509 options are permitted.
512 options must precede this option for non-port qualified addresses.
513 .It Cm LoginGraceTime
514 The server disconnects after this time if the user has not
515 successfully logged in.
516 If the value is 0, there is no time limit.
517 The default is 120 seconds.
519 Gives the verbosity level that is used when logging messages from
521 The possible values are:
522 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
524 DEBUG and DEBUG1 are equivalent.
525 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
526 Logging with a DEBUG level violates the privacy of users and is not recommended.
528 Specifies the available MAC (message authentication code) algorithms.
529 The MAC algorithm is used in protocol version 2
530 for data integrity protection.
531 Multiple algorithms must be comma-separated.
533 .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
535 Introduces a conditional block.
536 If all of the criteria on the
538 line are satisfied, the keywords on the following lines override those
539 set in the global section of the config file, until either another
541 line or the end of the file.
544 are one or more criteria-pattern pairs.
545 The available criteria are
551 Only a subset of keywords may be used on the lines following a
554 Available keywords are
555 .Cm AllowTcpForwarding ,
559 .Cm X11DisplayOffset ,
562 .Cm X11UseLocalHost .
564 Specifies the maximum number of authentication attempts permitted per
566 Once the number of failures reaches half this value,
567 additional failures are logged.
570 Specifies the maximum number of concurrent unauthenticated connections to the
572 Additional connections will be dropped until authentication succeeds or the
574 expires for a connection.
577 Alternatively, random early drop can be enabled by specifying
578 the three colon separated values
582 will refuse connection attempts with a probability of
585 if there are currently
588 unauthenticated connections.
589 The probability increases linearly and all connection attempts
590 are refused if the number of unauthenticated connections reaches
593 .It Cm PasswordAuthentication
594 Specifies whether password authentication is allowed.
597 .It Cm PermitEmptyPasswords
598 When password authentication is allowed, it specifies whether the
599 server allows login to accounts with empty password strings.
603 Specifies the destinations to which TCP port forwarding is permitted.
604 The forwarding specification must be one of the following forms:
606 .Bl -item -offset indent -compact
620 .Ar \&[ IPv6_addr \&] : port
624 Multiple forwards may be specified by separating them with whitespace.
627 can be used to remove all restrictions and permit any forwarding requests.
628 By default all port forwarding requests are permitted.
629 .It Cm PermitRootLogin
630 Specifies whether root can log in using
634 .Dq without-password ,
635 .Dq forced-commands-only ,
641 If this option is set to
642 .Dq without-password ,
643 password authentication is disabled for root.
645 If this option is set to
646 .Dq forced-commands-only ,
647 root login with public key authentication will be allowed,
650 option has been specified
651 (which may be useful for taking remote backups even if root login is
652 normally not allowed).
653 All other authentication methods are disabled for root.
655 If this option is set to
657 root is not allowed to log in.
661 device forwarding is allowed.
677 .It Cm PermitUserEnvironment
679 .Pa ~/.ssh/environment
683 .Pa ~/.ssh/authorized_keys
688 Enabling environment processing may enable users to bypass access
689 restrictions in some configurations using mechanisms such as
692 Specifies the file that contains the process ID of the
695 .Pa /var/run/sshd.pid .
697 Specifies the port number that
701 Multiple options of this type are permitted.
707 should print the date and time of the last user login when a user logs
716 when a user logs in interactively.
717 (On some systems it is also printed by the shell,
723 Specifies the protocol versions
726 The possible values are
730 Multiple versions must be comma-separated.
733 Note that the order of the protocol list does not indicate preference,
734 because the client selects among multiple protocol versions offered
740 .It Cm PubkeyAuthentication
741 Specifies whether public key authentication is allowed.
744 Note that this option applies to protocol version 2 only.
745 .It Cm RhostsRSAAuthentication
746 Specifies whether rhosts or /etc/hosts.equiv authentication together
747 with successful RSA host authentication is allowed.
750 This option applies to protocol version 1 only.
751 .It Cm RSAAuthentication
752 Specifies whether pure RSA authentication is allowed.
755 This option applies to protocol version 1 only.
757 Defines the number of bits in the ephemeral protocol version 1 server key.
758 The minimum value is 512, and the default is 768.
762 should check file modes and ownership of the
763 user's files and home directory before accepting login.
764 This is normally desirable because novices sometimes accidentally leave their
765 directory or files world-writable.
769 Configures an external subsystem (e.g. file transfer daemon).
770 Arguments should be a subsystem name and a command (with optional arguments)
771 to execute upon subsystem request.
776 file transfer subsystem.
777 By default no subsystems are defined.
778 Note that this option applies to protocol version 2 only.
779 .It Cm SyslogFacility
780 Gives the facility code that is used when logging messages from
782 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
783 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
786 Specifies whether the system should send TCP keepalive messages to the
788 If they are sent, death of the connection or crash of one
789 of the machines will be properly noticed.
790 However, this means that
791 connections will die if the route is down temporarily, and some people
793 On the other hand, if TCP keepalives are not sent,
794 sessions may hang indefinitely on the server, leaving
796 users and consuming server resources.
800 (to send TCP keepalive messages), and the server will notice
801 if the network goes down or the client host crashes.
802 This avoids infinitely hanging sessions.
804 To disable TCP keepalive messages, the value should be set to
809 should look up the remote host name and check that
810 the resolved host name for the remote IP address maps back to the
811 very same IP address.
817 is used for interactive login sessions.
822 is never used for remote command execution.
823 Note also, that if this is enabled,
825 will be disabled because
827 does not know how to handle
831 .Cm UsePrivilegeSeparation
832 is specified, it will be disabled after authentication.
834 Enables the Pluggable Authentication Module interface.
837 this will enable PAM authentication using
838 .Cm ChallengeResponseAuthentication
840 .Cm PasswordAuthentication
841 in addition to PAM account and session module processing for all
842 authentication types.
844 Because PAM challenge-response authentication usually serves an equivalent
845 role to password authentication, you should disable either
846 .Cm PasswordAuthentication
848 .Cm ChallengeResponseAuthentication.
852 is enabled, you will not be able to run
857 .It Cm UsePrivilegeSeparation
860 separates privileges by creating an unprivileged child process
861 to deal with incoming network traffic.
862 After successful authentication, another process will be created that has
863 the privilege of the authenticated user.
864 The goal of privilege separation is to prevent privilege
865 escalation by containing any corruption within the unprivileged processes.
868 .It Cm X11DisplayOffset
869 Specifies the first display number available for
872 This prevents sshd from interfering with real X11 servers.
875 Specifies whether X11 forwarding is permitted.
883 When X11 forwarding is enabled, there may be additional exposure to
884 the server and to client displays if the
886 proxy display is configured to listen on the wildcard address (see
888 below), though this is not the default.
889 Additionally, the authentication spoofing and authentication data
890 verification and substitution occur on the client side.
891 The security risk of using X11 forwarding is that the client's X11
892 display server may be exposed to attack when the SSH client requests
893 forwarding (see the warnings for
897 A system administrator may have a stance in which they want to
898 protect clients that may expose themselves to attack by unwittingly
899 requesting X11 forwarding, which can warrant a
903 Note that disabling X11 forwarding does not prevent users from
904 forwarding X11 traffic, as users can always install their own forwarders.
905 X11 forwarding is automatically disabled if
908 .It Cm X11UseLocalhost
911 should bind the X11 forwarding server to the loopback address or to
912 the wildcard address.
914 sshd binds the forwarding server to the loopback address and sets the
917 environment variable to
919 This prevents remote hosts from connecting to the proxy display.
920 However, some older X11 clients may not function with this
925 to specify that the forwarding server should be bound to the wildcard
934 Specifies the full pathname of the
938 .Pa /usr/X11R6/bin/xauth .
942 command-line arguments and configuration file options that specify time
943 may be expressed using a sequence of the form:
945 .Ar time Op Ar qualifier ,
949 is a positive integer value and
951 is one of the following:
953 .Bl -tag -width Ds -compact -offset indent
968 Each member of the sequence is added together to calculate
969 the total time value.
971 Time format examples:
973 .Bl -tag -width Ds -compact -offset indent
975 600 seconds (10 minutes)
979 1 hour 30 minutes (90 minutes)
983 .It Pa /etc/ssh/sshd_config
984 Contains configuration data for
986 This file should be writable by root only, but it is recommended
987 (though not necessary) that it be world-readable.
992 OpenSSH is a derivative of the original and free
993 ssh 1.2.12 release by Tatu Ylonen.
994 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
995 Theo de Raadt and Dug Song
996 removed many bugs, re-added newer features and
998 Markus Friedl contributed the support for SSH
999 protocol versions 1.5 and 2.0.
1000 Niels Provos and Markus Friedl contributed support
1001 for privilege separation.
andersk / gssapi-openssh.git / blob