Keywords in Secure Shell

The following tables list the keywords and their default values, if any. The keywords are in alphabetical order. The location of keywords on the client is the ssh_config file. Keywords that apply to the server are in the sshd_config file. Some keywords are set in both files. If the keyword applies to only one protocol version, the version is listed.

Table 20-1 Keywords in Secure Shell Configuration Files (A to Escape)

Keyword	Default Value	Location	Protocol
`AllowGroups`	No default.	Server
`AllowTcpForwarding`	`yes`	Server
`AllowUsers`	No default.	Server
`AuthorizedKeysFile`	`~/.ssh/authorized_keys`	Server
`Banner`	`/etc/issue`	Server
`Batchmode`	`no`	Client
`BindAddress`	No default.	Client
`CheckHostIP`	`yes`	Client
`ChrootDirectory`	`no`	Server	v2
`Cipher`	`blowfish`, `3des`	Client	v1
`Ciphers`	`aes128-ctr, aes128-cbc, 3des-cbc, blowfish-cbc, arcfour`	Both	v2
`ClearAllForwardings`	`no`	Client
`ClientAliveCountMax`	`3`	Server	v2
`ClientAliveInterval`	`0`	Server	v2
`Compression`	`no`	Both
`CompressionLevel`	No default.	Client	v1
`ConnectionAttempts`	`1`	Client
`DenyGroups`	No default	Server
`DenyUsers`	No default	Server
`DynamicForward`	No default.	Client
`EscapeChar`	`~`	Client

Table 20-2 Keywords in Secure Shell Configuration Files (Fall to Local)

Keyword	Default Value	Location	Protocol
`FallBackToRsh`	`no`	Client
`ForwardAgent`	`no`	Client
`ForwardX11`	`no`	Client
`GatewayPorts`	`no`	Both
`GlobalKnownHostsFile`	`/etc/ssh/ssh_known_hosts`	Client
`GSSAPIAuthentication`	`yes`	Both	v2
`GSSAPIDelegateCredentials`	`no`	Client	v2
`GSSAPIKeyExchange`	`yes`	Both	v2
`GSSAPIStoreDelegateCredentials`	`yes`	Server	v2
`Host`	`*` For more information, see Host-Specific Parameters in Secure Shell.	Client
`HostbasedAuthentication`	`no`	Both	v2
`HostbasedUsesNameFromPacketOnly`	`no`	Server	v2
`HostKey`	`/etc/ssh/ssh_host_key`	Server	v1
`HostKey`	`/etc/ssh/host_rsa_key`, `/etc/ssh/host_dsa_key`	Server	v2
`HostKeyAlgorithms`	`ssh-rsa, ssh-dss`	Client	v2
`HostKeyAlias`	No default.	Client	v2
`HostName`	No default.	Client	v2
`IdentityFile`	`~/.ssh/identity`	Client	v1
`IdentityFile`	`~/.ssh/id_dsa, ~/.ssh/id_rsa`	Client	v2
`IgnoreRhosts`	`yes`	Server
`IgnoreUserKnownHosts`	`yes`	Server
`KbdInteractiveAuthentication`	`yes`	Both
`KeepAlive`	`yes`	Both
`KeyRegenerationInterval`	`3600` (seconds)	Server
`ListenAddress`	No default.	Server
`LocalForward`	No default.	Client

Table 20-3 Keywords in Secure Shell Configuration Files (Login to R)

Keyword	Default Value	Location	Protocol
`LoginGraceTime`	`600` (seconds)	Server
`LogLevel`	`info`	Both
`LookupClientHostnames`	`yes`	Server
`MACs`	`hmac-sha1,hmac-md5`	Both	v2
`MaxAuthTries`	`6`	Server
`MaxAuthTriesLog`	3	Server
`MaxStartups`	`10:30:60`	Server
`NoHostAuthenticationForLocalHost`	`no`	Client
`NumberOfPasswordPrompts`	`3`	Client
`PAMAuthenticationViaKBDInt`	`yes`	Server	v2
`PasswordAuthentication`	`yes`	Both	Both
`PermitEmptyPasswords`	`no`	Server
`PermitRootLogin`	`no`	Server
`PermitUserEnvironment`	`no`	Server
`PidFile`	`/var/run/sshd.pid`	Server
`Port`	`22`	Both
`PreferredAuthentications`	`hostbased,publickey,keyboard- interactive,passwor`	Client	v2
`PrintLastLog`	`yes`	Server	v2
`PrintMotd`	`no`	Server
`Protocol`	`2,1`	Both
`ProxyCommand`	No default.	Client
`PubkeyAuthentication`	`yes`	Both	v2
`RemoteForward`	No default.	Client
`RhostsAuthentication`	`no`	Both	v1
`RhostsRSAAuthentication`	`no`	Both	v1
`RSAAuthentication`	`no`	Both	v1

Table 20-4 Keywords in Secure Shell Configuration Files (S to X)

Keyword	Default Value	Location	Protocol
`StrictHostKeyChecking`	`ask`	Client
`StrictModes`	`yes`	Server
`Subsystem`	`sftp /usr/lib/ssh/sftp-server`	Server
`SyslogFacility`	`auth`	Server
`UseLogin`	`no` Deprecated and ignored.	Server
`UseOpenSSLEngine`	`yes`	Both	v2
`UsePrivilegedPort`	`no`	Both	v2
`User`	No default	Client
`UserKnownHostsFile`	`~/.ssh/known_hosts`	Client
`UseRsh`	`no`	Client
`VerifyReverseMapping`	`no`	Server
`X11DisplayOffset`	`10`	Server
`X11Forwarding`	`yes`	Server
`X11UseLocalHost`	`yes`	Server
`XAuthLocation`	`/usr/openwin/bin/xauth`	Both

Host-Specific Parameters in Secure Shell

If it is useful to have different Secure Shell characteristics for different local hosts, the administrator can define separate sets of parameters in the /etc/ssh/ssh_config file to be applied according to host or regular expression. This task is done by grouping entries in the file by Host keyword. If the Host keyword is not used, the entries in the client configuration file apply to whichever local host a user is working on.

Secure Shell and Login Environment Variables

When the following Secure Shell keywords are not set in the sshd_config file, they get their value from equivalent entries in the /etc/default/login file:

Entry in `/etc/default/login`	Keyword and Value in `sshd_config`
`CONSOLE=*`	`PermitRootLogin=without-password`
`#CONSOLE=*`	`PermitRootLogin=yes`
`PASSREQ=YES`	`PermitEmptyPasswords=no`
`PASSREQ=NO`	`PermitEmptyPasswords=yes`
`#PASSREQ`	`PermitEmptyPasswords=no`
`TIMEOUT=secs`	`LoginGraceTime=secs`
`#TIMEOUT`	`LoginGraceTime=300`
`RETRIES` and `SYSLOG_FAILED_LOGINS`	Apply only to `password` and `keyboard-interactive` authentication methods.

When the following variables are set by the initialization scripts from the user's login shell, the sshd daemon uses those values. When the variables are not set, the daemon uses the default value.

TIMEZONE: Controls the setting of the TZ environment variable. When not set, the sshd daemon uses value of TZ when the daemon was started.
ALTSHELL: Controls the setting of the SHELL environment variable. The default is ALTSHELL=YES, where the sshd daemon uses the value of the user's shell. When ALTSHELL=NO, the SHELL value is not set.
PATH: Controls the setting of the PATH environment variable. When the value is not set, the default path is /usr/bin.
SUPATH: Controls the setting of the PATH environment variable for root. When the value is not set, the default path is /usr/sbin:/usr/bin.

For more information, see the login(1) and sshd(1M) man pages.

Skip Navigation Links
Exit Print View
	System Administration Guide: Security Services Oracle Solaris 10 1/13 Information Library