diff options
Diffstat (limited to 'usr/src/man/man4')
| -rw-r--r-- | usr/src/man/man4/Makefile | 6 | ||||
| -rw-r--r-- | usr/src/man/man4/ssh_config.sunssh.4 | 909 | ||||
| -rw-r--r-- | usr/src/man/man4/sshd_config.sunssh.4 | 1006 |
3 files changed, 0 insertions, 1921 deletions
diff --git a/usr/src/man/man4/Makefile b/usr/src/man/man4/Makefile index a4a64fbd8f..26e46b0532 100644 --- a/usr/src/man/man4/Makefile +++ b/usr/src/man/man4/Makefile @@ -187,8 +187,6 @@ _MANFILES= Intro.4 \ sndr.4 \ sock2path.d.4 \ space.4 \ - ssh_config.sunssh.4 \ - sshd_config.sunssh.4 \ sulog.4 \ syslog.conf.4 \ system.4 \ @@ -243,8 +241,6 @@ _MANLINKS= addresses.4 \ rhosts.4 \ sendmail.cf.4 \ snapshot_cache.4 \ - ssh_config.4 \ - sshd_config.4 \ submit.cf.4 \ volume-defaults.4 \ wtmp.4 \ @@ -296,8 +292,6 @@ pcie.4 := LINKSRC = pci.4 sendmail.cf.4 := LINKSRC = sendmail.4 submit.cf.4 := LINKSRC = sendmail.4 -ssh_config.4 := LINKSRC = ssh_config.sunssh.4 -sshd_config.4 := LINKSRC = sshd_config.sunssh.4 isa.4 := LINKSRC = sysbus.4 diff --git a/usr/src/man/man4/ssh_config.sunssh.4 b/usr/src/man/man4/ssh_config.sunssh.4 deleted file mode 100644 index 57a94dd03c..0000000000 --- a/usr/src/man/man4/ssh_config.sunssh.4 +++ /dev/null @@ -1,909 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 2013, Joyent, Inc. All Rights Reserved. -.\" To view Portions Copyright for OpenSSH, the default path is /var/sadm/pkg/SUNWsshdr/install/copyright. If the Solaris operating environment has been installed anywhere other than the default, modify the specified path to access the file at the installed location. -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. -.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with -.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SSH_CONFIG 4 "Jan 17, 2013" -.SH NAME -ssh_config \- ssh configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/ssh/ssh_config\fR -.fi - -.LP -.nf -\fB$HOME/.ssh/config\fR -.fi - -.SH DESCRIPTION -.LP -The first \fBssh_config\fR path, above, provides the system-wide defaults for -\fBssh\fR(1). The second version is user-specific defaults for \fBssh\fR. -.sp -.LP -\fBssh\fR obtains configuration data from the following sources, in this order: -command line options, user's configuration file (\fB$HOME/.ssh/config\fR), and -system-wide configuration file (\fB/etc/ssh/ssh_config\fR). For each parameter, -the first obtained value is used. The configuration files contain sections -bracketed by \fBHost\fR specifications, and that section is applied only for -hosts that match one of the patterns given in the specification. The matched -host name is the one given on the command line. -.sp -.LP -Since the first obtained value for each parameter is used, host-specific -declarations should be given near the beginning of the file, and general -defaults at the end. -.sp -.LP -The configuration file has the following format and syntax: -.RS +4 -.TP -.ie t \(bu -.el o -Empty lines and lines starting with \fB#\fR are comments. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Non-commented lines are of the form: -.sp -.in +2 -.nf -\fIkeyword\fR \fIarguments\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Configuration options can be separated by white space or optional whitespace -and exactly one equal sign. The latter format allows you to avoid the need to -quote white space when specifying configuration options using the \fB-o\fR -option to \fBssh\fR, \fBscp\fR, and \fBsftp\fR. -.RE -.sp -.LP -The possible keywords and their meanings are listed in the following -list.Keywords are case-insensitive and arguments are case-sensitive. -.sp -.ne 2 -.na -\fB\fBBatchMode\fR\fR -.ad -.sp .6 -.RS 4n -The argument must be \fByes\fR or \fBno\fR. If set to \fByes\fR, -passphrase/password querying is disabled. This option is useful in scripts and -other batch jobs where you have no user to supply the password. -.RE - -.sp -.ne 2 -.na -\fB\fBBindAddress\fR\fR -.ad -.sp .6 -.RS 4n -Specify the interface to transmit from on machines with multiple interfaces or -aliased addresses. This option does not work if \fBUsePrivilegedPort\fR is set -to \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBCheckHostIP\fR\fR -.ad -.sp .6 -.RS 4n -If this flag is set to \fByes\fR, \fBssh\fR additionally checks the host IP -address in the \fBknown_hosts\fR file. This allows \fBssh\fR to detect if a -host key changed due to DNS spoofing. If the option is set to \fBno\fR, the -check is not executed. -.RE - -.sp -.ne 2 -.na -\fB\fBCipher\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the cipher to use for encrypting the session in protocol version 1. -Only a single cipher can be specified. Currently, \fBblowfish, 3des,\fR and -\fBdes\fR are supported. \fB3des\fR (triple-\fBdes\fR) is an -encrypt-decrypt-encrypt triple with three different keys. It is believed to be -secure. \fBblowfish\fR is a fast block cipher. It appears very secure and is -much faster than \fB3des\fR. \fBdes\fR is only supported in the \fBssh\fR -client for interoperability with legacy protocol 1 implementations that do not -support the \fB3des\fR cipher. Its use is strongly discouraged due to -cryptographic weaknesses. The default is \fB3des\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBCiphers\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the ciphers allowed for protocol version 2 in order of preference. -Multiple ciphers must be comma separated. -.sp -The default cipher list contains all supported ciphers in this order: -.sp -.in +2 -.nf -aes128-ctr, aes192-ctr, aes256-ctr, arcfour128, arcfour256, arcfour, aes128-cbc, -aes192-cbc, aes256-cbc, arcfour, 3des-cbc,blowfish-cbc -.fi -.in -2 -.sp - -While CBC modes are not considered as secure as other modes in connection with -the SSH protocol 2 they are present at the back of the default client cipher -list for backward compatibility with SSH servers that do not support other -cipher modes. -.RE - -.sp -.ne 2 -.na -\fB\fBClearAllForwardings\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that all local, remote, and dynamic port forwardings specified in the -configuration files or on the command line be cleared. This option is primarily -useful when used from the \fBssh\fR command line to clear port forwardings set -in configuration files and is automatically set by \fBscp\fR(1) and -\fBsftp\fR(1). The argument must be \fByes\fR or \fBno\fR. The default is -\fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBCompression\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to use compression. The argument must be \fByes\fR or -\fBno\fR. Defaults to \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBCompressionLevel\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the compression level to use if compression is enabled. The argument -must be an integer from 1 (fast) to 9 (slow, best). The default level is 6, -which is good for most applications. This option applies to protocol version 1 -only. -.RE - -.sp -.ne 2 -.na -\fB\fBConnectionAttempts\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the number of tries (one per second) to make before falling back to -\fBrsh\fR or exiting. The argument must be an integer. This can be useful in -scripts if the connection sometimes fails. The default is 1. -.RE - -.sp -.ne 2 -.na -\fB\fBConnectTimeout\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the timeout (in seconds) used when connecting to the \fBssh\fR -server, instead of using the default system TCP timeout. This value is used -only when the target is down or truly unreachable, not when it refuses the -connection. -.RE - -.sp -.ne 2 -.na -\fB\fBDisableBanner\fR\fR -.ad -.sp .6 -.RS 4n -If set to \fByes\fR, disables the display of the banner message. If set to -\fBin-exec-mode\fR, disables the display of banner message when in remote -command mode only. -.sp -The default value is \fBno\fR, which means that the banner is displayed unless -the log level is \fBQUIET\fR, \fBFATAL\fR, or \fBERROR\fR. See also the -\fBBanner\fR option in \fBsshd_config\fR(4). This option applies to protocol -version 2 only. -.RE - -.sp -.ne 2 -.na -\fB\fBDynamicForward\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that a TCP/IP port on the local machine be forwarded over the secure -channel. The application protocol is then used to determine where to connect to -from the remote machine. -.sp -The argument must be \fB[\fR\fIbind_address\fR\fB:]\fR\fIport\fR. IPv6 -addresses can be specified by enclosing addresses in square brackets or by -using an alternative syntax: \fB[\fR\fIbind_address\fR\fB/]\fR\fIport\fR. By -default, the local port is bound in accordance with the \fBGatewayPorts\fR -setting. However, an explicit \fIbind_address\fR can be used to bind the -connection to a specific address. The \fIbind_address\fR of \fBlocalhost\fR -indicates that the listening port be bound for local use only, while an empty -address or \fB*\fR indicates that the port should be available from all -interfaces. -.sp -Currently the \fBSOCKS4\fR and \fBSOCKS5\fR protocols are supported, and -\fBssh\fR acts as a \fBSOCKS\fR server. Multiple forwardings can be specified -and additional forwardings can be specified on the command line. Only a user -with enough privileges can forward privileged ports. -.RE - -.sp -.ne 2 -.na -\fB\fBEscapeChar\fR\fR -.ad -.sp .6 -.RS 4n -Sets the escape character. The default is tilde (\fB~\fR). The escape character -can also be set on the command line. The argument should be a single character, -\fB^\fR, followed by a letter, or \fBnone\fR to disable the escape character -entirely (making the connection transparent for binary data). -.RE - -.sp -.ne 2 -.na -\fB\fBFallBackToRsh\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that if connecting with \fBssh\fR fails due to a connection refused -error (there is no \fBsshd\fR(1M) listening on the remote host), \fBrsh\fR(1) -should automatically be used instead (after a suitable warning about the -session being unencrypted). The argument must be \fByes\fR or \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBForwardAgent\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether the connection to the authentication agent (if any) is -forwarded to the remote machine. The argument must be \fByes\fR or \fBno\fR. -The default is \fBno\fR. -.sp -Agent forwarding should be enabled with caution. Users with the ability to -bypass file permissions on the remote host (for the agent's Unix-domain socket) -can access the local agent through the forwarded connection. An attacker cannot -obtain key material from the agent, however he can perform operations on the -keys that enable him to authenticate using the identities loaded into the -agent. -.RE - -.sp -.ne 2 -.na -\fB\fBForwardX11\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether X11 connections are automatically redirected over the secure -channel and \fBDISPLAY\fR set. The argument must be \fByes\fR or \fBno\fR. The -default is \fBno\fR. -.sp -X11 forwarding should be enabled with caution. Users with the ability to bypass -file permissions on the remote host (for the user's X authorization database) -can access the local \fBX11\fR display through the forwarded connection. An -attacker might then be able to perform activities such as keystroke monitoring. -See the \fBForwardX11Trusted\fR option for more information how to prevent -this. -.RE - -.sp -.ne 2 -.na -\fB\fBForwardX11Trusted\fR\fR -.ad -.sp .6 -.RS 4n -If this option is set to \fByes\fR, remote X11 clients have full access to the -original X11 display. This option is set to \fByes\fR by default. -.sp -If this option is set to \fBno\fR, remote X11 clients are considered untrusted -and prevented from stealing or tampering with data belonging to trusted X11 -clients. Furthermore, the \fBxauth\fR(1) token used for the session is set to -expire after 20 minutes. Remote clients are refused access after this time. -.sp -See the X11 SECURITY extension specification for full details on the -restrictions imposed on untrusted clients. -.RE - -.sp -.ne 2 -.na -\fB\fBGatewayPorts\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether remote hosts are allowed to connect to local forwarded ports. -By default, \fBssh\fR binds local port forwardings to the loopback address. -This prevents other remote hosts from connecting to forwarded ports. -\fBGatewayPorts\fR can be used to specify that \fBssh\fR should bind local port -forwardings to the wildcard address, thus allowing remote hosts to connect to -forwarded ports. The argument must be \fByes\fR or \fBno\fR. The default is -\fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBGlobalKnownHostsFile\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a file to use instead of \fB/etc/ssh/ssh_known_hosts\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBGSSAPIAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Enables/disables GSS-API user authentication. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBGSSAPIDelegateCredentials\fR\fR -.ad -.sp .6 -.RS 4n -Enables/disables GSS-API credential forwarding. The default is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBGSSAPIKeyExchange\fR\fR -.ad -.sp .6 -.RS 4n -Enables/disables GSS-API-authenticated key exchanges. The default is \fByes\fR. -.sp -This option is intended primarily to allow users to disable the use of GSS-API -key exchange for SSHv2 when it would otherwise be selected and then fail (due -to server misconfiguration, for example). SSHv2 key exchange failure always -results in disconnection. -.sp -This option also enables the use of the GSS-API to authenticate the user to the -server after the key exchange. GSS-API key exchange can succeed but the -subsequent authentication using the GSS-API fail if the server does not -authorize the user's GSS principal name to the target user account. -.RE - -.sp -.ne 2 -.na -\fB\fBHashKnownHosts\fR\fR -.ad -.sp .6 -.RS 4n -Indicates that \fBssh\fR(1), should hash host names and addresses when they are -added to \fB~/.ssh/known_hosts\fR. These hashed names can be used normally by -\fBssh\fR(1) and \fBsshd\fR(1M), but they do not reveal identifying information -should the file's contents be disclosed. The default is \fBno\fR. Existing -names and addresses in known hosts files are not be converted automatically, -but can be manually hashed using \fBssh-keygen\fR(1). -.RE - -.sp -.ne 2 -.na -\fB\fBHost\fR\fR -.ad -.sp .6 -.RS 4n -Restricts the following declarations (up to the next \fBHost\fR keyword) to be -only for those hosts that match one of the patterns given after the keyword. An -asterisk (\fB*\fR) and a question mark (\fB?\fR) can be used as wildcards in -the patterns. A single asterisk as a pattern can be used to provide global -defaults for all hosts. The host is the host name argument given on the command -line (that is, the name is not converted to a canonicalized host name before -matching). -.RE - -.sp -.ne 2 -.na -\fB\fBHostbasedAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to try \fBrhosts\fR-based authentication with public key -authentication. The argument must be \fByes\fR or \fBno\fR. The default is -\fBno\fR. This option applies to protocol version 2 only and is similar to -\fBRhostsRSAAuthentication\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBHostKeyAlgorithms\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the protocol version 2 host key algorithms that the client wants to -use in order of preference. The default for this option is: -\fBssh-rsa,ssh-dss\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBHostKeyAlias\fR\fR -.ad -.sp .6 -.RS 4n -Specifies an alias that should be used instead of the real host name when -looking up or saving the host key in the host key database files. This option -is useful for tunneling \fBssh\fR connections or for multiple servers running -on a single host. -.RE - -.sp -.ne 2 -.na -\fB\fBHostName\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the real host name to log into. This can be used to specify nicknames -or abbreviations for hosts. Default is the name given on the command line. -Numeric IP addresses are also permitted (both on the command line and in -\fBHostName\fR specifications). -.RE - -.sp -.ne 2 -.na -\fB\fBIdentityFile\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a file from which the user's RSA or DSA authentication identity is -read. The default is \fB$HOME/.ssh/identity\fR for protocol version 1 and -\fB$HOME/.ssh/id_rsa\fR and \fB$HOME/.ssh/id_dsa\fR for protocol version 2. -Additionally, any identities represented by the authentication agent is used -for authentication. The file name can use the tilde syntax to refer to a user's -home directory. It is possible to have multiple identity files specified in -configuration files; all these identities is tried in sequence. -.RE - -.sp -.ne 2 -.na -\fB\fBIgnoreIfUnknown\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a comma-separated list of \fBssh_config\fR parameters, which, if -unknown to \fBssh\fR(1), are to be ignored by \fBssh\fR. -.sp -This parameter is primarily intended to be used in the per-user -\fBssh_config\fR, \fB~/.ssh/config\fR. While this parameter can also be used in -the system wide \fB/etc/ssh/ssh_config\fR file, it is generally useless as the -capabilities of the \fBssh\fR(1) client on that host should match that file. -.RE - -.sp -.ne 2 -.na -\fB\fBTCPKeepAlive\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether the system should send TCP keepalive messages to the other -side. If they are sent, death of the connection or crash of one of the machines -is properly noticed. However, this means that connections die if the route is -down temporarily, which can be a source of annoyance. -.sp -The default is \fByes\fR (to send keepalives), which means the client notices -if the network goes down or the remote host dies. This is important in scripts, -and many users want it too. To disable keepalives, the value should be set to -\fBno\fR in both the server and the client configuration files. -.RE - -.sp -.ne 2 -.na -\fB\fBLocalForward\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that a TCP/IP port on the local machine be forwarded over the secure -channel to a given \fIhost\fR:\fIport\fR from the remote machine. The first -argument must be \fB[\fR\fIbind_address\fR\fB:]\fR\fIport\fR and the second -must be \fIhost\fR\fB:\fR\fIport\fR. IPv6 addresses can be specified by -enclosing addresses in square brackets or by using an alternative syntax: -\fB[\fR\fIbind_address\fR\fB/]\fR\fIport\fR and \fIhost\fR\fB/\fR\fIport\fR. -Multiple forwardings can be specified and additional forwardings can be given -on the command line. Only a user with enough privileges can forward privileged -ports. By default, the local port is bound in accordance with the -\fBGatewayPorts\fR setting. However, an explicit \fIbind_address\fR can be used -to bind the connection to a specific address. The \fIbind_address\fR of -\fIlocalhost\fR indicates that the listening port be bound for local use only, -while an empty address or \fB*\fR indicates that the port should be available -from all interfaces. -.RE - -.sp -.ne 2 -.na -\fB\fBLogLevel\fR\fR -.ad -.sp .6 -.RS 4n -Gives the verbosity level that is used when logging messages from \fBssh\fR. -The possible values are: \fBFATAL\fR, \fBERROR\fR, \fBQUIET\fR, \fBINFO\fR, -\fBVERBOSE\fR, \fBDEBUG\fR, \fBDEBUG1\fR, \fBDEBUG2\fR, and \fBDEBUG3\fR. The -default is \fBINFO\fR. \fBDEBUG\fR and \fBDEBUG1\fR are equivalent. -\fBDEBUG2\fR and \fBDEBUG3\fR each specify higher levels of verbose output. -.RE - -.sp -.ne 2 -.na -\fB\fBMACs\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the MAC (message authentication code) algorithms in order of -preference. The MAC algorithm is used in protocol version 2 for data integrity -protection. Multiple algorithms must be comma-separated. The default is -\fBhmac-md5,hmac-sha1,hmac-sha1-96,hmac-md5-96\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBNoHostAuthenticationForLocalhost\fR\fR -.ad -.sp .6 -.RS 4n -This option can be used if the home directory is shared across machines. In -this case \fBlocalhost\fR refers to a different machine on each of the machines -and the user gets many warnings about changed host keys. However, this option -disables host authentication for \fBlocalhost\fR. The argument to this keyword -must be \fByes\fR or \fBno\fR. The default is to check the host key for -\fBlocalhost\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBNumberOfPasswordPrompts\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the number of attempts before giving up for password and -keyboard-interactive methods. Attempts for each method are counted separately. -The argument to this keyword must be an integer. The default is 3. -.RE - -.sp -.ne 2 -.na -\fB\fBPasswordAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to use password authentication. The argument to this keyword -must be \fByes\fR or \fBno\fR. This option applies to both protocol versions 1 -and 2. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBPort\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the port number to connect on the remote host. The default is 22. -.RE - -.sp -.ne 2 -.na -\fB\fBPreferredAuthentications\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the order in which the client should try protocol 2 authentication -methods. This allows a client to prefer one method (for example, -\fBkeyboard-interactive\fR) over another method (for example, \fBpassword\fR). -The default for this option is: -\fBhostbased,publickey,keyboard-interactive,password\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBProtocol\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the protocol versions \fBssh\fR should support in order of -preference. The possible values are \fB1\fR and \fB2\fR. Multiple versions must -be comma-separated. The default is \fB2,1\fR. This means that \fBssh\fR tries -version 2 and falls back to version 1 if version 2 is not available. -.RE - -.sp -.ne 2 -.na -\fB\fBProxyCommand\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the command to use to connect to the server. The command string -extends to the end of the line, and is executed with \fB/bin/sh\fR. In the -command string, \fB%h\fR is substituted by the host name to connect and -\fB%p\fR by the port. The string can be any valid command, and should read from -its standard input and write to its standard output. It should eventually -connect an \fBsshd\fR(1M) server running on some machine, or execute \fBsshd\fR -\fB-i\fR somewhere. Host key management is done using the \fBHostName\fR of the -host being connected (defaulting to the name typed by the user). -\fBCheckHostIP\fR is not available for connects with a proxy command. -.RE - -.sp -.ne 2 -.na -\fB\fBPubkeyAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to try public key authentication. The argument to this -keyword must be \fByes\fR or \fBno\fR. The default is \fByes\fR. This option -applies to protocol version 2 only. -.RE - -.sp -.ne 2 -.na -\fB\fBRekeyLimit\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the maximum amount of data that can be transmitted before the session -key is renegotiated. The argument is the number of bytes, with an optional -suffix of \fBK\fR, \fBM\fR, or \fBG\fR to indicate Kilobytes, Megabytes, or -Gigabytes, respectively. The default is between \fB1G\fR and \fB4G\fR, -depending on the cipher. This option applies to protocol version 2 only. -.RE - -.sp -.ne 2 -.na -\fB\fBRemoteForward\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that a TCP/IP port on the remote machine be forwarded over the secure -channel to a given \fB\fIhost\fR:\fIport\fR\fR from the local machine. The -first argument must be \fB[\fR\fIbind_address\fR\fB:]\fR\fIport\fR and the -second argument must be \fIhost\fR\fB:\fR\fIport\fR. IPv6 addresses can be -specified by enclosing addresses in square brackets or by using an alternative -syntax: \fB[\fR\fIbind_address\fR\fB/]\fR\fIport\fR and -\fIhost\fR\fB/\fR\fIport\fR. You can specify multiple forwardings and give -additional forwardings on the command line. Only a user with enough privileges -can forward privileged ports. -.sp -If the \fIbind_address\fR is not specified, the default is to only bind to -loopback addresses. If the \fIbind_address\fR is \fB*\fR or an empty string, -then the forwarding is requested to listen on all interfaces. Specifying a -remote \fIbind_address\fR only succeeds if the server's \fBGatewayPorts\fR -option is enabled. See \fBsshd_config\fR(4). -.RE - -.sp -.ne 2 -.na -\fB\fBRhostsAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to try \fBrhosts\fR-based authentication. This declaration -affects only the client side and has no effect whatsoever on security. -Disabling \fBrhosts\fR authentication can reduce authentication time on slow -connections when \fBrhosts\fR authentication is not used. Most servers do not -permit \fBRhostsAuthentication\fR because it is not secure (see -\fBRhostsRSAAuthentication\fR). The argument to this keyword must be \fByes\fR -or \fBno\fR. This option applies only to the protocol version 1 and requires -that \fBssh\fR be \fBsetuid\fR root and that \fBUsePrivilegedPort\fR be set to -\fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBRhostsRSAAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to try \fBrhosts\fR-based authentication with RSA host -authentication. This is the primary authentication method for most sites. The -argument must be \fByes\fR or \fBno\fR. This option applies only to the -protocol version 1 and requires that \fBssh\fR be \fBsetuid\fR root and that -\fBUsePrivilegedPort\fR be set to \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBServerAliveCountMax\fR\fR -.ad -.sp .6 -.RS 4n -Sets the number of server alive messages which can be sent without \fBssh\fR(1) -receiving messages back from the server. If this threshold is reached while -server alive messages are being sent, \fBssh\fR disconnects from the server, -terminating the session. The use of server alive messages differs from -\fBTCPKeepAlive\fR. Server alive messages are sent through the encrypted -channel and are not spoofable. The TCP keep alive option enabled by -\fBTCPKeepAlive\fR is spoofable. The server alive mechanism is valuable when -the client or server depend on knowing when a connection has become inactive. -.sp -The default value is 3. If, for example, \fBServerAliveInterval\fR is set to 15 -and \fBServerAliveCountMax\fR is left at the default, \fBssh\fR disconnects in -45-60 seconds if the server becomes unresponsive. This option applies to -protocol version 2 only. -.RE - -.sp -.ne 2 -.na -\fB\fBServerAliveInterval\fR\fR -.ad -.sp .6 -.RS 4n -Sets a timeout interval in seconds after which if no data has been received -from the server, \fBssh\fR(1) sends a message through the encrypted channel to -request a response from the server. The default is 0, indicating that these -messages are not sent to the server. This option applies to protocol version 2 -only. -.RE - -.sp -.ne 2 -.na -\fB\fBStrictHostKeyChecking\fR\fR -.ad -.sp .6 -.RS 4n -If this flag is set to \fByes\fR, \fBssh\fR never automatically adds host keys -to the \fB$HOME/.ssh/known_hosts\fR file, and refuses to connect hosts whose -host key has changed. This provides maximum protection against trojan horse -attacks. However, it can be a source of inconvenience if you do not have good -\fB/etc/ssh/ssh_known_hosts\fR files installed and frequently connect new -hosts. This option forces the user to manually add any new hosts. Normally this -option is disabled, and new hosts are automatically added to the known host -files. The host keys of known hosts are verified automatically in either case. -The argument must be \fByes\fR or \fBno\fR or \fBask\fR. The default is -\fBask\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBUseOpenSSLEngine\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBssh\fR should use the OpenSSL PKCS#11 engine for -offloading cryptographic operations to the Cryptographic Framework. -Cryptographic operations are accelerated according to the available installed -plug-ins. When no suitable plug-ins are present this option does not have an -effect. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBUsePrivilegedPort\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to use a privileged port for outgoing connections. The -argument must be \fByes\fR or \fBno\fR. The default is \fByes\fR. Setting this -option to \fBno\fR turns off \fBRhostsAuthentication\fR and -\fBRhostsRSAAuthentication\fR. If set to \fByes\fR \fBssh\fR must be -\fBsetuid\fR root. Defaults to \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBUser\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the user to log in as. This can be useful if you have different user -names on different machines. This saves you the trouble of having to remember -to enter the user name on the command line. -.RE - -.sp -.ne 2 -.na -\fB\fBUserKnownHostsFile\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a file to use instead of \fB$HOME/.ssh/known_hosts\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBUseRsh\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that \fBrlogin\fR or \fBrsh\fR should be used for this host. It is -possible that the host does not support the \fBssh\fR protocol. This causes -\fBssh\fR to immediately execute \fBrsh\fR(1). All other options (except -\fBHostName\fR) are ignored if this has been specified. The argument must be -\fByes\fR or \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBXAuthLocation\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the location of the \fBxauth\fR(1) program. The default is -\fB/usr/openwin/bin/xauth\fR. -.RE - -.SH SEE ALSO -.LP -\fBrsh\fR(1), \fBssh\fR(1), \fBssh-http-proxy-connect\fR(1), -\fBssh-keygen\fR(1), \fBssh-socks5-proxy-connect\fR(1), \fBsshd\fR(1M), -\fBsshd_config\fR(4), \fBkerberos\fR(5) -.sp -.LP -\fIRFC 4252\fR diff --git a/usr/src/man/man4/sshd_config.sunssh.4 b/usr/src/man/man4/sshd_config.sunssh.4 deleted file mode 100644 index ef134886a2..0000000000 --- a/usr/src/man/man4/sshd_config.sunssh.4 +++ /dev/null @@ -1,1006 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 2013, Joyent, Inc. All Rights Reserved. -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. -.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the -.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SSHD_CONFIG 4 "Jan 17, 2013" -.SH NAME -sshd_config \- sshd configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/ssh/sshd_config\fR -.fi - -.SH DESCRIPTION -.LP -The \fBsshd\fR(1M) daemon reads configuration data from -\fB/etc/ssh/sshd_config\fR (or the file specified with \fBsshd\fR \fB-f\fR on -the command line). The file contains keyword-value pairs, one per line. A line -starting with a hash mark (\fB#\fR) and empty lines are interpreted as -comments. -.sp -.LP -The \fBsshd_config\fR file supports the following keywords. Unless otherwise -noted, keywords and their arguments are case-insensitive. -.sp -.ne 2 -.na -\fB\fBAllowGroups\fR\fR -.ad -.sp .6 -.RS 4n -This keyword can be followed by a number of group names, separated by spaces. -If specified, login is allowed only for users whose primary group or -supplementary group list matches one of the patterns. Asterisk (\fB*\fR) and -question mark (\fB?\fR) can be used as wildcards in the patterns. Only group -names are valid; a numerical group ID is not recognized. By default, login is -allowed regardless of the primary group. -.RE - -.sp -.ne 2 -.na -\fB\fBAllowTcpForwarding\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether TCP forwarding is permitted. The default is \fByes\fR. -Disabling TCP forwarding does not improve security unless users are also denied -shell access, as they can always install their own forwarders. -.RE - -.sp -.ne 2 -.na -\fB\fBAllowUsers\fR\fR -.ad -.sp .6 -.RS 4n -This keyword can be followed by a number of user names, separated by spaces. If -specified, login is allowed only for user names that match one of the patterns. -Asterisk (\fB*\fR) and question mark (\fB?\fR) can be used as wildcards in the -patterns. Only user names are valid; a numerical user ID is not recognized. By -default login is allowed regardless of the user name. -.sp -If a specified pattern takes the form \fIuser\fR@\fIhost\fR then \fIuser\fR and -\fIhost\fR are checked separately, restricting logins to particular users from -particular hosts. -.RE - -.sp -.ne 2 -.na -\fB\fBAuthorizedKeysFile\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the file that contains the public keys that can be used for user -authentication. \fBAuthorizedKeysFile\fR can contain tokens of the form -\fB%T\fR, which are substituted during connection set-up. The following tokens -are defined: \fB%%\fR is replaced by a literal \fB%\fR, \fB%h\fR is replaced by -the home directory of the user being authenticated and \fB%u\fR is replaced by -the username of that user. After expansion, \fBAuthorizedKeysFile\fR is taken -to be an absolute path or one relative to the user's home directory. The -default is \fB\&.ssh/authorized_keys\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBBanner\fR\fR -.ad -.sp .6 -.RS 4n -In some jurisdictions, sending a warning message before authentication can be -relevant for getting legal protection. The contents of the specified file are -sent to the remote user before authentication is allowed. This option is only -available for protocol version 2. By default, no banner is displayed. -.RE - -.sp -.ne 2 -.na -\fB\fBChrootDirectory\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a path to \fBchroot\fR(2) to after authentication. This path, and all -its components, must be root-owned directories that are not writable by any -other user or group. -.sp -The server always tries to change to the user's home directory locally under -the chrooted environment but a failure to do so is not considered an error. In -addition, the path might contain the following tokens that are expanded at -runtime once the connecting user has been authenticated: \fB%%\fR is replaced -by a literal \fB%\fR, \fB%h\fR is replaced by the home directory of the user -being authenticated, and \fB%u\fR is replaced by the username of that user. -.sp -The \fBChrootDirectory\fR must contain the necessary files and directories to -support the user's session. For an interactive SSH session this requires at -least a user's shell, shared libraries needed by the shell, dynamic linker, and -possibly basic \fB/dev\fR nodes such as \fBnull\fR, \fBzero\fR, \fBstdin\fR, -\fBstdout\fR, \fBstderr\fR, \fBrandom\fR, and \fBtty\fR. Additionally, terminal -databases are needed for screen oriented applications. For file transfer -sessions using \fBsftp\fR with the SSH protocol version 2, no additional -configuration of the environment is necessary if the in-process \fBsftp\fR -server is used. See \fBSubsystem\fR for details. -.sp -The default is not to \fBchroot\fR(2). -.RE - -.sp -.ne 2 -.na -\fB\fBCiphers\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the ciphers allowed for protocol version 2. Cipher ordering on the -server side is not relevant. Multiple ciphers must be comma separated. -.sp -Valid ciphers are: \fBaes128-ctr, aes192-ctr, aes256-ctr, aes128-cbc, -aes192-cbc, aes256-cbc, arcfour, arcfour128, arcfour256, 3des-cbc\fR, and -\fBblowfish-cbc\fR. -.sp -The default cipher list is: -.sp -.in +2 -.nf -aes128-ctr,aes192-ctr,aes256-ctr,arcfour128, -arcfour256,arcfour -.fi -.in -2 -.sp - -Using CBC modes on the server side is not recommended due to potential security -issues in connection with the SSH protocol version 2. -.RE - -.sp -.ne 2 -.na -\fB\fBClientAliveCountMax\fR\fR -.ad -.sp .6 -.RS 4n -Sets the number of client alive messages, (see \fBClientAliveInterval\fR), that -can be sent without \fBsshd\fR receiving any messages back from the client. If -this threshold is reached while client alive messages are being sent, -\fBsshd\fR disconnects the client, terminating the session. The use of client -alive messages is very different from \fBTCPKeepAlive\fR. The client alive -messages are sent through the encrypted channel and therefore are not -spoofable. The TCP keepalive option enabled by \fBTCPKeepAlive\fR is spoofable. -The client alive mechanism is valuable when a client or server depend on -knowing when a connection has become inactive. -.sp -The default value is 3. If \fBClientAliveInterval\fR is set to 15, and -\fBClientAliveCountMax\fR is left at the default, unresponsive \fBssh\fR -clients are disconnected after approximately 45 seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBClientAliveInterval\fR\fR -.ad -.sp .6 -.RS 4n -Sets a timeout interval in seconds after which, if no data has been received -from the client, \fBsshd\fR sends a message through the encrypted channel to -request a response from the client. The default is 0, indicating that these -messages are not sent to the client. This option applies only to protocol -version 2. -.RE - -.sp -.ne 2 -.na -\fB\fBCompression\fR\fR -.ad -.sp .6 -.RS 4n -Controls whether the server allows the client to negotiate the use of -compression. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBDenyGroups\fR\fR -.ad -.sp .6 -.RS 4n -Can be followed by a number of group names, separated by spaces. Users whose -primary group matches one of the patterns are not allowed to log in. Asterisk -(\fB*\fR) and question mark (\fB?\fR) can be used as wildcards in the patterns. -Only group names are valid; a numerical group ID is not recognized. By default, -login is allowed regardless of the primary group. -.RE - -.sp -.ne 2 -.na -\fB\fBDenyUsers\fR\fR -.ad -.sp .6 -.RS 4n -Can be followed by a number of user names, separated by spaces. Login is -disallowed for user names that match one of the patterns. Asterisk (\fB*\fR) -and question mark (\fB?\fR) can be used as wildcards in the patterns. Only user -names are valid; a numerical user ID is not recognized. By default, login is -allowed regardless of the user name. -.sp -If a specified pattern takes the form \fIuser\fR@\fIhost\fR then \fIuser\fR and -\fIhost\fR are checked separately, disallowing logins to particular users from -particular hosts. -.RE - -.sp -.ne 2 -.na -\fB\fBGatewayPorts\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether remote hosts are allowed to connect to ports forwarded for -the client. By default, \fBsshd\fR binds remote port forwardings to the -loopback address. This prevents other remote hosts from connecting to forwarded -ports. \fBGatewayPorts\fR can be used to specify that \fBsshd\fR should bind -remote port forwardings to the wildcard address, thus allowing remote hosts to -connect to forwarded ports. -.sp -The argument can be \fBno\fR to force remote port forwardings to be available -to the local host only, \fByes\fR to force remote port forwardings to bind to -the wildcard address, or \fBclientspecified\fR to allow the client to select -the address to which the forwarding is bound. The default is \fBno\fR. See also -\fBRemoteForward\fR in \fBssh_config\fR(4). -.RE - -.sp -.ne 2 -.na -\fB\fBGSSAPIAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Enables/disables GSS-API user authentication. The default is \fByes\fR. -.sp -Currently \fBsshd\fR authorizes client user principals to user accounts as -follows: if the principal name matches the requested user account, then the -principal is authorized. Otherwise, GSS-API authentication fails. -.RE - -.sp -.ne 2 -.na -\fB\fBGSSAPIKeyExchange\fR\fR -.ad -.sp .6 -.RS 4n -Enables/disables GSS-API-authenticated key exchanges. The default is \fByes\fR. -.sp -This option also enables the use of the GSS-API to authenticate the user to -server after the key exchange. GSS-API key exchange can succeed but the -subsequent authentication using the GSS-API fail if the server does not -authorize the user's GSS principal name to the target user account. -.sp -Currently \fBsshd\fR authorizes client user principals to user accounts as -follows: if the principal name matches the requested user account, then the -principal is authorized. Otherwise, GSS-API authentication fails. -.RE - -.sp -.ne 2 -.na -\fB\fBGSSAPIStoreDelegatedCredentials\fR\fR -.ad -.sp .6 -.RS 4n -Enables/disables the use of delegated GSS-API credentials on the server-side. -The default is \fByes\fR. -.sp -Specifically, this option, when enabled, causes the server to store delegated -GSS-API credentials in the user's default GSS-API credential store (which for -the Kerberos V mechanism means \fB/tmp/krb5cc_\fI<uid>\fR\fR). -.LP -Note - -.sp -.RS 2 -\fBsshd\fR does not take any steps to explicitly destroy stored delegated -GSS-API credentials upon logout. It is the responsibility of PAM modules to -destroy credentials associated with a session. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBHostbasedAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to try \fBrhosts\fR-based authentication with public key -authentication. The argument must be \fByes\fR or \fBno\fR. The default is -\fBno\fR. This option applies to protocol version 2 only and is similar to -\fBRhostsRSAAuthentication\fR. See \fBsshd\fR(1M) for guidelines on setting up -host-based authentication. -.RE - -.sp -.ne 2 -.na -\fB\fBHostbasedUsesNameFromPacketOnly\fR\fR -.ad -.sp .6 -.RS 4n -Controls which hostname is searched for in the files \fB~/.shosts\fR, -\fB/etc/shosts.equiv\fR, and \fB/etc/hosts.equiv\fR. If this parameter is set -to \fByes\fR, the server uses the name the client claimed for itself and signed -with that host's key. If set to \fBno\fR, the default, the server uses the name -to which the client's IP address resolves. -.sp -Setting this parameter to \fBno\fR disables host-based authentication when -using NAT or when the client gets to the server indirectly through a -port-forwarding firewall. -.RE - -.sp -.ne 2 -.na -\fB\fBHostKey\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the file containing the private host key used by SSH. The default is -\fB/etc/ssh/ssh_host_key\fR for protocol version 1, and -\fB/etc/ssh/ssh_host_rsa_key\fR and \fB/etc/ssh/ssh_host_dsa_key\fR for -protocol version 2. \fBsshd\fR refuses to use a file if it is -group/world-accessible. It is possible to have multiple host key files. -\fBrsa1\fR keys are used for version 1 and \fBdsa\fR or \fBrsa\fR are used for -version 2 of the SSH protocol. -.RE - -.sp -.ne 2 -.na -\fB\fBIgnoreRhosts\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that \fB\&.rhosts\fR and \fB\&.shosts\fR files are not used in -authentication. \fB/etc/hosts.equiv\fR and \fB/etc/shosts.equiv\fR are still -used. The default is \fByes\fR. This parameter applies to both protocol -versions 1 and 2. -.RE - -.sp -.ne 2 -.na -\fB\fBIgnoreUserKnownHosts\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should ignore the user's -\fB$HOME/.ssh/known_hosts\fR during \fBRhostsRSAAuthentication\fR. The default -is \fBno\fR. This parameter applies to both protocol versions 1 and 2. -.RE - -.sp -.ne 2 -.na -\fB\fBKbdInteractiveAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether authentication by means of the "keyboard-interactive" -authentication method (and PAM) is allowed. Defaults to \fByes\fR. (Deprecated: -this parameter can only be set to \fByes\fR.) -.RE - -.sp -.ne 2 -.na -\fB\fBTCPKeepAlive\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether the system should send keepalive messages to the other side. -If they are sent, death of the connection or crash of one of the machines is -properly noticed. However, this means that connections die if the route is down -temporarily, which can be an annoyance. On the other hand, if keepalives are -not sent, sessions can hang indefinitely on the server, leaving ghost users and -consuming server resources. -.sp -The default is \fByes\fR (to send keepalives), and the server notices if the -network goes down or the client host reboots. This avoids infinitely hanging -sessions. -.sp -To disable keepalives, the value should be set to \fBno\fR in both the server -and the client configuration files. -.RE - -.sp -.ne 2 -.na -\fB\fBKeyRegenerationInterval\fR\fR -.ad -.sp .6 -.RS 4n -In protocol version 1, the ephemeral server key is automatically regenerated -after this many seconds (if it has been used). The purpose of regeneration is -to prevent decrypting captured sessions by later breaking into the machine and -stealing the keys. The key is never stored anywhere. If the value is 0, the key -is never regenerated. The default is 3600 (seconds). -.RE - -.sp -.ne 2 -.na -\fB\fBListenAddress\fR\fR -.ad -.sp .6 -.RS 4n -Specifies what local address \fBsshd\fR should listen on. The following forms -can be used: -.sp -.in +2 -.nf -ListenAddress \fIhost\fR|\fIIPv4_addr\fR|\fIIPv6_addr\fR -ListenAddress \fIhost\fR|\fIIPv4_addr\fR:\fIport\fR -ListenAddress [\fIhost\fR|\fIIPv6_addr\fR]:\fIport\fR -.fi -.in -2 - -If \fIport\fR is not specified, \fBsshd\fR listens on the address and all prior -\fBPort\fR options specified. The default is to listen on all local addresses. -Multiple \fBListenAddress\fR options are permitted. Additionally, any -\fBPort\fR options must precede this option for non-port qualified addresses. -.sp -The default is to listen on all local addresses. Multiple options of this type -are permitted. Additionally, the \fBPorts\fR options must precede this option. -.RE - -.sp -.ne 2 -.na -\fB\fBLoginGraceTime\fR\fR -.ad -.sp .6 -.RS 4n -The server disconnects after this time (in seconds) if the user has not -successfully logged in. If the value is 0, there is no time limit. The default -is 120 (seconds). -.RE - -.sp -.ne 2 -.na -\fB\fBLogLevel\fR\fR -.ad -.sp .6 -.RS 4n -Gives the verbosity level that is used when logging messages from \fBsshd\fR. -The possible values are: \fBQUIET\fR, \fBFATAL\fR, \fBERROR\fR, \fBINFO\fR, -\fBVERBOSE\fR, \fBDEBUG\fR, \fBDEBUG1\fR, \fBDEBUG2\fR, and \fBDEBUG3\fR. The -default is \fBINFO\fR. DEBUG2 and DEBUG3 each specify higher levels of -debugging output. Logging with level \fBDEBUG\fR violates the privacy of users -and is not recommended. -.RE - -.sp -.ne 2 -.na -\fB\fBLookupClientHostnames\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether or not to lookup the names of client's addresses. Defaults to -yes. -.RE - -.sp -.ne 2 -.na -\fBMACs\fR -.ad -.sp .6 -.RS 4n -Specifies the available MAC (message authentication code) algorithms. The MAC -algorithm is used in protocol version 2 for data integrity protection. Multiple -algorithms must be comma-separated. The default is -\fBhmac-md5,hmac-sha1,hmac-sha1-96,hmac-md5-96\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBMaxStartups\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the maximum number of concurrent unauthenticated connections to the -\fBsshd\fR daemon. Additional connections are dropped until authentication -succeeds or the \fBLoginGraceTime\fR expires for a connection. The default is -\fB10\fR. -.sp -Alternatively, random early drop can be enabled by specifying the three -colon-separated values \fB\fIstart\fR:\fIrate\fR:\fIfull\fR\fR (for example, -\fB10:30:60\fR). Referring to this example, \fBsshd\fR refuse connection -attempts with a probability of \fIrate\fR/100 (30% in our example) if there are -currently 10 (from the \fIstart\fR field) unauthenticated connections. The -probability increases linearly and all connection attempts are refused if the -number of unauthenticated connections reaches \fIfull\fR (60 in our example). -.RE - -.sp -.ne 2 -.na -\fB\fBPasswordAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether password authentication is allowed. The default is \fByes\fR. -This option applies to both protocol versions 1 and 2. -.RE - -.sp -.ne 2 -.na -\fB\fBPermitEmptyPasswords\fR\fR -.ad -.sp .6 -.RS 4n -When password or keyboard-interactive authentication is allowed, it specifies -whether the server allows login to accounts with empty password strings. -.sp -If not set then the \fB/etc/default/login\fR \fBPASSREQ\fR value is used -instead. -.sp -\fBPASSREQ=no\fR is equivalent to \fBPermitEmptyPasswords yes\fR. -\fBPASSREQ=yes\fR is equivalent to \fBPermitEmptyPasswords no\fR. If neither -\fBPermitEmptyPasswords\fR or \fBPASSREQ\fR are set the default is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBPermitRootLogin\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether the root can log in using \fBssh\fR(1). The argument must be -\fByes\fR, \fBwithout-password\fR, \fBforced-commands-only\fR, or \fBno\fR. -\fBwithout-password\fR means that root cannot be authenticated using the -"password" or "keyboard-interactive" methods (see description of -\fBKbdInteractiveAuthentication\fR). \fBforced-commands-only\fR means that -authentication is allowed only for \fBpublickey\fR (for SSHv2, or RSA, for -SSHv1) and only if the matching \fBauthorized_keys entry\fR for root has a -\fBcommand=\fR\fI<cmd>\fR option. -.sp -In Solaris, the default \fB/etc/ssh/sshd_config\fR file is shipped with -\fBPermitRootLogin\fR set to \fBno\fR. If unset by the administrator, then -\fBCONSOLE\fR parameter from \fB/etc/default/login\fR supplies the default -value as follows: if the \fBCONSOLE\fR parameter is not commented out (it can -even be empty, that is, "\fBCONSOLE=\fR"), then \fBwithout-password\fR is used -as default value. If \fBCONSOLE\fR is commented out, then the default for -\fBPermitRootLogin\fR is \fByes\fR. -.sp -The \fBwithout-password\fR and \fBforced-commands-only\fR settings are useful -for, for example, performing remote administration and backups using trusted -public keys for authentication of the remote client, without allowing access to -the root account using passwords. -.RE - -.sp -.ne 2 -.na -\fB\fBPermitUserEnvironment\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether a user's \fB~/.ssh/environment\fR on the server side and -\fBenvironment\fR options in the \fBAuthorizedKeysFile\fR file are processed by -\fBsshd\fR. The default is \fBno\fR. Enabling environment processing can enable -users to bypass access restrictions in some configurations using mechanisms -such as \fBLD_PRELOAD\fR. -.sp -Environment setting from a relevant entry in \fBAuthorizedKeysFile\fR file is -processed only if the user was authenticated using the public key -authentication method. Of the two files used, values of variables set in -\fB~/.ssh/environment\fR are of higher priority. -.RE - -.sp -.ne 2 -.na -\fB\fBPidFile\fR\fR -.ad -.sp .6 -.RS 4n -Allows you to specify an alternative to \fB/var/run/sshd.pid\fR, the default -file for storing the PID of the \fBsshd\fR listening for connections. See -\fBsshd\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBPort\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the port number that \fBsshd\fR listens on. The default is 22. -Multiple options of this type are permitted. See also \fBListenAddress\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBPrintLastLog\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should display the date and time when the user -last logged in. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBPrintMotd\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should display the contents of \fB/etc/motd\fR -when a user logs in interactively. (On some systems it is also displayed by the -shell or a shell startup file, such as \fB/etc/profile\fR.) The default is -\fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBProtocol\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the protocol versions \fBsshd\fR should support in order of -preference. The possible values are \fB1\fR and \fB2\fR. Multiple versions must -be comma-separated. The default is \fB2,1\fR. This means that \fBssh\fR tries -version 2 and falls back to version 1 if version 2 is not available. -.RE - -.sp -.ne 2 -.na -\fB\fBPubkeyAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether public key authentication is allowed. The default is -\fByes\fR. This option applies to protocol version 2 only. -.RE - -.sp -.ne 2 -.na -\fB\fBRhostsAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether authentication using \fBrhosts\fR or \fB/etc/hosts.equiv\fR -files is sufficient. Normally, this method should not be permitted because it -is insecure. \fBRhostsRSAAuthentication\fR should be used instead, because it -performs RSA-based host authentication in addition to normal \fBrhosts\fR or -\fB/etc/hosts.equiv\fR authentication. The default is \fBno\fR. This parameter -applies only to protocol version 1. -.RE - -.sp -.ne 2 -.na -\fB\fBRhostsRSAAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBrhosts\fR or \fB/etc/hosts.equiv\fR authentication -together with successful RSA host authentication is allowed. The default is -\fBno\fR. This parameter applies only to protocol version 1. -.RE - -.sp -.ne 2 -.na -\fB\fBRSAAuthentication\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether pure RSA authentication is allowed. The default is \fByes\fR. -This option applies to protocol version 1 only. -.RE - -.sp -.ne 2 -.na -\fB\fBServerKeyBits\fR\fR -.ad -.sp .6 -.RS 4n -Defines the number of bits in the ephemeral protocol version 1 server key. The -minimum value is 512, and the default is 768. -.RE - -.sp -.ne 2 -.na -\fB\fBStrictModes\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should check file modes and ownership of the -user's files and home directory before accepting login. This is normally -desirable because novices sometimes accidentally leave their directory or files -world-writable. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSubsystem\fR\fR -.ad -.sp .6 -.RS 4n -Configures an external subsystem (for example, a file transfer daemon). -Arguments should be a subsystem name and a command to execute upon subsystem -request. The command \fBsftp-server\fR(1M) implements the \fBsftp\fR file -transfer subsystem. -.sp -Alternately, the name \fBinternal-sftp\fR implements an in-process \fBsftp\fR -server. This can simplify configurations using \fBChrootDirectory\fR to force a -different filesystem root on clients. -.sp -By default, no subsystems are defined. This option applies to protocol version -2 only. -.RE - -.sp -.ne 2 -.na -\fB\fBSyslogFacility\fR\fR -.ad -.sp .6 -.RS 4n -Gives the facility code that is used when logging messages from \fBsshd\fR. The -possible values are: \fBDAEMON\fR, \fBUSER\fR, \fBAUTH\fR, \fBLOCAL0\fR, -\fBLOCAL1\fR, \fBLOCAL2\fR, \fBLOCAL3\fR, \fBLOCAL4\fR, \fBLOCAL5\fR, -\fBLOCAL6\fR, and \fBLOCAL7\fR. The default is \fBAUTH\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBUseOpenSSLEngine\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should use the OpenSSL PKCS#11 engine for -offloading cryptographic operations to the Cryptographic Framework. -Cryptographic operations are accelerated according to the available installed -plug-ins. When no suitable plug-ins are present this option does not have an -effect. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBVerifyReverseMapping\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should try to verify the remote host name and -check that the resolved host name for the remote IP address maps back to the -very same IP address. (A \fByes\fR setting means "verify".) Setting this -parameter to \fBno\fR can be useful where DNS servers might be down and thus -cause \fBsshd\fR to spend much time trying to resolve the client's IP address -to a name. This feature is useful for Internet-facing servers. The default is -\fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBX11DisplayOffset\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the first display number available for \fBsshd\fR's X11 forwarding. -This prevents \fBsshd\fR from interfering with real X11 servers. The default is -10. -.RE - -.sp -.ne 2 -.na -\fB\fBX11Forwarding\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether X11 forwarding is permitted. The default is \fByes\fR. -Disabling X11 forwarding does not improve security in any way, as users can -always install their own forwarders. -.sp -When X11 forwarding is enabled, there can be additional exposure to the server -and to client displays if the \fBsshd\fR proxy display is configured to listen -on the wildcard address (see \fBX11UseLocalhost\fR). However, this is not the -default. Additionally, the authentication spoofing and authentication data -verification and substitution occur on the client side. The security risk of -using X11 forwarding is that the client's X11 display server can be exposed to -attack when the \fBssh\fR client requests forwarding (see the warnings for -\fBForwardX11\fR in \fBssh_config\fR(4)). A system administrator who wants to -protect clients that expose themselves to attack by unwittingly requesting X11 -forwarding, should specify a \fBno\fR setting. -.sp -Disabling X11 forwarding does not prevent users from forwarding X11 traffic, as -users can always install their own forwarders. -.RE - -.sp -.ne 2 -.na -\fB\fBX11UseLocalhost\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether \fBsshd\fR should bind the X11 forwarding server to the -loopback address or to the wildcard address. By default, \fBsshd\fR binds the -forwarding server to the loopback address and sets the hostname part of the -\fBDISPLAY\fR environment variable to \fBlocalhost\fR. This prevents remote -hosts from connecting to the proxy display. However, some older X11 clients -might not function with this configuration. \fBX11UseLocalhost\fR can be set to -\fBno\fR to specify that the forwarding server should be bound to the wildcard -address. The argument must be \fByes\fR or \fBno\fR. The default is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBXAuthLocation\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the location of the \fBxauth\fR(1) program. The default is -\fB/usr/X11/bin/xauth\fR and \fBsshd\fR attempts to open it when X11 forwarding -is enabled. -.RE - -.SS "Time Formats" -.LP -\fBsshd\fR command-line arguments and configuration file options that specify -time can be expressed using a sequence of the form: -\fItime\fR[\fIqualifier\fR,] where \fItime\fR is a positive integer value and -\fIqualifier\fR is one of the following: -.sp -.ne 2 -.na -\fB\fI<none>\fR\fR -.ad -.RS 10n -seconds -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR | \fBS\fR\fR -.ad -.RS 10n -seconds -.RE - -.sp -.ne 2 -.na -\fB\fBm\fR | \fBM\fR\fR -.ad -.RS 10n -minutes -.RE - -.sp -.ne 2 -.na -\fB\fBh\fR | \fBH\fR\fR -.ad -.RS 10n -hours -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR | \fBD\fR\fR -.ad -.RS 10n -days -.RE - -.sp -.ne 2 -.na -\fB\fBw\fR | \fB\fR\fR -.ad -.RS 10n -weeks -.RE - -.sp -.LP -Each element of the sequence is added together to calculate the total time -value. For example: -.sp -.ne 2 -.na -\fB\fB600\fR\fR -.ad -.RS 9n -600 seconds (10 minutes) -.RE - -.sp -.ne 2 -.na -\fB\fB10m\fR\fR -.ad -.RS 9n -10 minutes -.RE - -.sp -.ne 2 -.na -\fB\fB1h30m\fR\fR -.ad -.RS 9n -1 hour, 30 minutes (90 minutes) -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/etc/ssh/sshd_config\fR\fR -.ad -.RS 24n -Contains configuration data for \fBsshd\fR. This file should be writable by -root only, but it is recommended (though not necessary) that it be -world-readable. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.LP -\fBlogin\fR(1), \fBsshd\fR(1M), \fBchroot\fR(2), \fBssh_config\fR(4), -\fBattributes\fR(5), \fBkerberos\fR(5) -.SH AUTHORS -.LP -OpenSSH is a derivative of the original and free \fBssh\fR 1.2.12 release by -Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo de -Raadt, and Dug Song removed many bugs, re-added recent features, and created -OpenSSH. Markus Friedl contributed the support for SSH protocol versions 1.5 -and 2.0. Niels Provos and Markus Friedl contributed support for privilege -separation. |