.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Config::Model::models::Ssh 3pm" .TH Config::Model::models::Ssh 3pm "2021-01-17" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Config::Model::models::Ssh \- Configuration class Ssh .SH "DESCRIPTION" .IX Header "DESCRIPTION" Configuration classes used by Config::Model .PP This configuration class was generated from ssh_system documentation. by parse\-man.pl .SH "Elements" .IX Header "Elements" .SS "Host" .IX Subsection "Host" Restricts the following declarations (up to the next \fBHost\fR or \&\fBMatch\fR keyword) to be only for those hosts that match one of the patterns given after the keyword. If more than one pattern is provided, they should be separated by whitespace. A single '*' as a pattern can be used to provide global defaults for all hosts. The host is usually the \fIhostname\fR argument given on the command line (see the \fBCanonicalizeHostname\fR keyword for exceptions). .PP A pattern entry may be negated by prefixing it with an exclamation mark ('!'). If a negated entry is matched, then the \&\fBHost\fR entry is ignored, regardless of whether any other patterns on the line match. Negated matches are therefore useful to provide exceptions for wildcard matches. .PP See \&\fI\s-1PATTERNS\s0\fR for more information on patterns. \fI Optional. Type hash of node of class Ssh::HostElement . \fR .SS "AddKeysToAgent" .IX Subsection "AddKeysToAgent" Specifies whether keys should be automatically added to a running \fBssh\-agent\fR\|(1). If this option is set to \fByes\fR and a key is loaded from a file, the key and its passphrase are added to the agent with the default lifetime, as if by \fBssh\-add\fR\|(1). If this option is set to \fBask\fR, \fBssh\fR\|(1) will require confirmation using the \&\s-1SSH_ASKPASS\s0 program before adding a key (see \fBssh\-add\fR\|(1) for details). If this option is set to \fBconfirm\fR, each use of the key must be confirmed, as if the \fB\-c\fR option was specified to \fBssh\-add\fR\|(1). If this option is set to \fBno\fR, no keys are added to the agent. Alternately, this option may be specified as a time interval using the format described in the \fI\s-1TIME FORMATS\s0\fR section of \fBsshd_config\fR\|(5) to specify the key's lifetime in \fBssh\-agent\fR\|(1), after which it will automatically be removed. The argument must be \&\fBno\fR (the default), \fByes\fR, \fBconfirm\fR (optionally followed by a time interval), \fBask\fR or a time interval. \fI Optional. Type enum. choice: 'yes', 'ask', 'confirm', 'no'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "AddressFamily" .IX Subsection "AddressFamily" Specifies which address family to use when connecting. Valid arguments are \fBany\fR (the default), \fBinet\fR (use IPv4 only), or \fBinet6\fR (use IPv6 only). \fI Optional. Type enum. choice: 'any', 'inet', 'inet6'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" any .SS "BatchMode" .IX Subsection "BatchMode" If set to \fByes\fR, user interaction such as password prompts and host key confirmation requests will be disabled. In addition, the \&\fBServerAliveInterval\fR option will be set to 300 seconds by default (Debian-specific). This option is useful in scripts and other batch jobs where no user is present to interact with \fBssh\fR\|(1), and where it is desirable to detect a broken network swiftly. The argument must be \fByes\fR or \&\fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "BindAddress" .IX Subsection "BindAddress" Use the specified address on the local machine as the source address of the connection. Only useful on systems with more than one address. \fI Optional. Type uniline. \fR .SS "BindInterface" .IX Subsection "BindInterface" Use the address of the specified interface on the local machine as the source address of the connection. \fI Optional. Type uniline. \fR .SS "CanonicalDomains" .IX Subsection "CanonicalDomains" When \&\fBCanonicalizeHostname\fR is enabled, this option specifies the list of domain suffixes in which to search for the specified destination host. \fI Optional. Type uniline. \fR .SS "CanonicalizeFallbackLocal" .IX Subsection "CanonicalizeFallbackLocal" Specifies whether to fail with an error when hostname canonicalization fails. The default, \&\fByes\fR, will attempt to look up the unqualified hostname using the system resolver's search rules. A value of \&\fBno\fR will cause \fBssh\fR\|(1) to fail instantly if \&\fBCanonicalizeHostname\fR is enabled and the target hostname cannot be found in any of the domains specified by \&\fBCanonicalDomains\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "CanonicalizeHostname" .IX Subsection "CanonicalizeHostname" Controls whether explicit hostname canonicalization is performed. The default, \&\fBno\fR, is not to perform any name rewriting and let the system resolver handle all hostname lookups. If set to \&\fByes\fR then, for connections that do not use a \&\fBProxyCommand\fR or \fBProxyJump\fR, \fBssh\fR\|(1) will attempt to canonicalize the hostname specified on the command line using the \fBCanonicalDomains\fR suffixes and \&\fBCanonicalizePermittedCNAMEs\fR rules. If \&\fBCanonicalizeHostname\fR is set to \fBalways\fR, then canonicalization is applied to proxied connections too. .PP If this option is enabled, then the configuration files are processed again using the new target name to pick up any new configuration in matching \fBHost\fR and \fBMatch\fR stanzas. \fI Optional. Type enum. choice: 'no', 'yes', 'always'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "CanonicalizeMaxDots" .IX Subsection "CanonicalizeMaxDots" Specifies the maximum number of dot characters in a hostname before canonicalization is disabled. The default, 1, allows a single dot (i.e. hostname.subdomain). \fI Optional. Type integer. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" 1 .SS "CanonicalizePermittedCNAMEs" .IX Subsection "CanonicalizePermittedCNAMEs" Specifies rules to determine whether CNAMEs should be followed when canonicalizing hostnames. The rules consist of one or more arguments of \&\fIsource_domain_list\fR:\fItarget_domain_list\fR, where \&\fIsource_domain_list\fR is a pattern-list of domains that may follow CNAMEs in canonicalization, and \&\fItarget_domain_list\fR is a pattern-list of domains that they may resolve to. .PP For example, \&\*(L"*.a.example.com:*.b.example.com,*.c.example.com\*(R" will allow hostnames matching \*(L"*.a.example.com\*(R" to be canonicalized to names in the \*(L"*.b.example.com\*(R" or \*(L"*.c.example.com\*(R" domains. \fI Optional. Type uniline. \fR .SS "CASignatureAlgorithms" .IX Subsection "CASignatureAlgorithms" Specifies which algorithms are allowed for signing of certificates by certificate authorities (CAs). The default is: .PP ecdsa\-sha2\-nistp256,ecdsa\-sha2\-nistp384,ecdsa\-sha2\-nistp521, .PP ssh\-ed25519,rsa\-sha2\-512,rsa\-sha2\-256,ssh\-rsa .PP \&\fBssh\fR\|(1) will not accept host certificates signed using algorithms other than those specified. \fI Optional. Type uniline. \fR .SS "CertificateFile" .IX Subsection "CertificateFile" Specifies a file from which the user's certificate is read. A corresponding private key must be provided separately in order to use this certificate either from an \fBIdentityFile\fR directive or \&\fB\-i\fR flag to \fBssh\fR\|(1), via \fBssh\-agent\fR\|(1), or via a \&\fBPKCS11Provider\fR or \fBSecurityKeyProvider\fR. .PP Arguments to \&\fBCertificateFile\fR may use the tilde syntax to refer to a user's home directory, the tokens described in the \&\fI\s-1TOKENS\s0\fR section and environment variables as described in the \fI\s-1ENVIRONMENT VARIABLES\s0\fR section. .PP It is possible to have multiple certificate files specified in configuration files; these certificates will be tried in sequence. Multiple \fBCertificateFile\fR directives will add to the list of certificates used for authentication. \fI Optional. Type uniline. \fR .SS "ChallengeResponseAuthentication" .IX Subsection "ChallengeResponseAuthentication" Specifies whether to use challenge-response authentication. The argument to this keyword must be \fByes\fR (the default) or \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "CheckHostIP" .IX Subsection "CheckHostIP" If set to \fByes\fR (the default), \fBssh\fR\|(1) will additionally check the host \s-1IP\s0 address in the \fIknown_hosts\fR file. This allows it to detect if a host key changed due to \s-1DNS\s0 spoofing and will add addresses of destination hosts to \fI~/.ssh/known_hosts\fR in the process, regardless of the setting of \&\fBStrictHostKeyChecking\fR. If the option is set to \&\fBno\fR, the check will not be executed. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "Ciphers" .IX Subsection "Ciphers" Specifies the ciphers allowed and their order of preference. Multiple ciphers must be comma-separated. If the specified list begins with a \&'+' character, then the specified ciphers will be appended to the default set instead of replacing them. If the specified list begins with a '\-' character, then the specified ciphers (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a '^' character, then the specified ciphers will be placed at the head of the default set. .PP The supported ciphers are: .PP 3des\-cbc aes128\-cbc aes192\-cbc aes256\-cbc aes128\-ctr aes192\-ctr aes256\-ctr aes128\-gcm@openssh.com aes256\-gcm@openssh.com chacha20\-poly1305@openssh.com .PP The default is: .PP chacha20\-poly1305@openssh.com, .PP aes128\-ctr,aes192\-ctr,aes256\-ctr, aes128\-gcm@openssh.com,aes256\-gcm@openssh.com .PP The list of available ciphers may also be obtained using \*(L"ssh \-Q cipher\*(R". \fI Optional. Type uniline. \fR .SS "ClearAllForwardings" .IX Subsection "ClearAllForwardings" 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\|(1) 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). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "Compression" .IX Subsection "Compression" Specifies whether to use compression. The argument must be \fByes\fR or \fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "ConnectionAttempts" .IX Subsection "ConnectionAttempts" Specifies the number of tries (one per second) to make before exiting. The argument must be an integer. This may be useful in scripts if the connection sometimes fails. The default is 1. \fI Optional. Type integer. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" 1 .SS "ConnectTimeout" .IX Subsection "ConnectTimeout" Specifies the timeout (in seconds) used when connecting to the \s-1SSH\s0 server, instead of using the default system \s-1TCP\s0 timeout. This timeout is applied both to establishing the connection and to performing the initial \s-1SSH\s0 protocol handshake and key exchange. \fI Optional. Type integer. \fR .SS "ControlMaster" .IX Subsection "ControlMaster" Enables the sharing of multiple sessions over a single network connection. When set to \&\fByes\fR, \fBssh\fR\|(1) will listen for connections on a control socket specified using the \fBControlPath\fR argument. Additional sessions can connect to this socket using the same \fBControlPath\fR with \fBControlMaster\fR set to \&\fBno\fR (the default). These sessions will try to reuse the master instance's network connection rather than initiating new ones, but will fall back to connecting normally if the control socket does not exist, or is not listening. .PP Setting this to \&\fBask\fR will cause \fBssh\fR\|(1) to listen for control connections, but require confirmation using \fBssh\-askpass\fR\|(1). If the \fBControlPath\fR cannot be opened, \fBssh\fR\|(1) will continue without connecting to a master instance. .PP X11 and \&\fBssh\-agent\fR\|(1) forwarding is supported over these multiplexed connections, however the display and agent forwarded will be the one belonging to the master connection i.e. it is not possible to forward multiple displays or agents. .PP Two additional options allow for opportunistic multiplexing: try to use a master connection but fall back to creating a new one if one does not already exist. These options are: \fBauto\fR and \&\fBautoask\fR. The latter requires confirmation like the \&\fBask\fR option. \fI Optional. Type enum. choice: 'auto', 'autoask', 'yes', 'no', 'ask'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "ControlPath" .IX Subsection "ControlPath" Specify the path to the control socket used for connection sharing as described in the \&\fBControlMaster\fR section above or the string \fBnone\fR to disable connection sharing. Arguments to \&\fBControlPath\fR may use the tilde syntax to refer to a user's home directory, the tokens described in the \&\fI\s-1TOKENS\s0\fR section and environment variables as described in the \fI\s-1ENVIRONMENT VARIABLES\s0\fR section. It is recommended that any \fBControlPath\fR used for opportunistic connection sharing include at least \f(CW%h\fR, \f(CW%p\fR, and \f(CW%r\fR (or alternatively \f(CW%C\fR) and be placed in a directory that is not writable by other users. This ensures that shared connections are uniquely identified. \fI Optional. Type uniline. \fR .SS "ControlPersist" .IX Subsection "ControlPersist" When used in conjunction with \&\fBControlMaster\fR, specifies that the master connection should remain open in the background (waiting for future client connections) after the initial client connection has been closed. If set to \fBno\fR (the default), then the master connection will not be placed into the background, and will close as soon as the initial client connection is closed. If set to \fByes\fR or 0, then the master connection will remain in the background indefinitely (until killed or closed via a mechanism such as the \*(L"ssh \-O exit\*(R"). If set to a time in seconds, or a time in any of the formats documented in \fBsshd_config\fR\|(5), then the backgrounded master connection will automatically terminate after it has remained idle (with no client connections) for the specified time. \fI Optional. Type uniline. \fR .SS "DynamicForward" .IX Subsection "DynamicForward" Specifies that a \s-1TCP\s0 port on the local machine be forwarded over the secure channel, and the application protocol is then used to determine where to connect to from the remote machine. .PP The argument must be [ .PP \&\fIbind_address\fR: ]\fIport\fR. IPv6 addresses can be specified by enclosing addresses in square brackets. By default, the local port is bound in accordance with the \&\fBGatewayPorts\fR setting. However, an explicit \&\fIbind_address\fR may 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 \&'*' indicates that the port should be available from all interfaces. .PP Currently the \&\s-1SOCKS4\s0 and \s-1SOCKS5\s0 protocols are supported, and \fBssh\fR\|(1) will act as a \s-1SOCKS\s0 server. Multiple forwardings may be specified, and additional forwardings can be given on the command line. Only the superuser can forward privileged ports. \fI Optional. Type list of uniline. \fR .SS "EnableSSHKeysign" .IX Subsection "EnableSSHKeysign" Setting this option to \&\fByes\fR in the global client configuration file \&\fI/etc/ssh/ssh_config\fR enables the use of the helper program \fBssh\-keysign\fR\|(8) during \&\fBHostbasedAuthentication\fR. The argument must be \&\fByes\fR or \fBno\fR (the default). This option should be placed in the non-hostspecific section. See \fBssh\-keysign\fR\|(8) for more information. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "EscapeChar" .IX Subsection "EscapeChar" Sets the escape character (default: '~'). The escape character can also be set on the command line. The argument should be a single character, '^' followed by a letter, or \&\fBnone\fR to disable the escape character entirely (making the connection transparent for binary data). \fI Optional. Type uniline. \fR .SS "ExitOnForwardFailure" .IX Subsection "ExitOnForwardFailure" Specifies whether \fBssh\fR\|(1) should terminate the connection if it cannot set up all requested dynamic, tunnel, local, and remote port forwardings, (e.g. if either end is unable to bind and listen on a specified port). Note that \fBExitOnForwardFailure\fR does not apply to connections made over port forwardings and will not, for example, cause \fBssh\fR\|(1) to exit if \s-1TCP\s0 connections to the ultimate forwarding destination fail. The argument must be \&\fByes\fR or \fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "FingerprintHash" .IX Subsection "FingerprintHash" Specifies the hash algorithm used when displaying key fingerprints. Valid options are: \&\fBmd5\fR and \fBsha256\fR (the default). \fI Optional. Type enum. choice: 'md5', 'sha256'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" sha256 .SS "ForwardAgent" .IX Subsection "ForwardAgent" Specifies whether the connection to the authentication agent (if any) will be forwarded to the remote machine. The argument may be \&\fByes\fR, \fBno\fR (the default), an explicit path to an agent socket or the name of an environment variable (beginning with '$') in which to find the path. .PP 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 they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "ForwardX11" .IX Subsection "ForwardX11" Specifies whether X11 connections will be automatically redirected over the secure channel and \s-1DISPLAY\s0 set. The argument must be \fByes\fR or \&\fBno\fR (the default). .PP X11 forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the user's X11 authorization database) can access the local X11 display through the forwarded connection. An attacker may then be able to perform activities such as keystroke monitoring if the \fBForwardX11Trusted\fR option is also enabled. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "ForwardX11Timeout" .IX Subsection "ForwardX11Timeout" Specify a timeout for untrusted X11 forwarding using the format described in the \fI\s-1TIME FORMATS\s0\fR section of \fBsshd_config\fR\|(5). X11 connections received by \fBssh\fR\|(1) after this time will be refused. Setting \&\fBForwardX11Timeout\fR to zero will disable the timeout and permit X11 forwarding for the life of the connection. The default is to disable untrusted X11 forwarding after twenty minutes has elapsed. \fI Optional. Type integer. \fR .SS "ForwardX11Trusted" .IX Subsection "ForwardX11Trusted" If this option is set to \&\fByes\fR, (the Debian-specific default), remote X11 clients will have full access to the original X11 display. .PP If this option is set to \fBno\fR (the upstream default), remote X11 clients will be 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 will be set to expire after 20 minutes. Remote clients will be refused access after this time. .PP See the X11 \&\s-1SECURITY\s0 extension specification for full details on the restrictions imposed on untrusted clients. \fI Optional. Type boolean. \fR .SS "GatewayPorts" .IX Subsection "GatewayPorts" Specifies whether remote hosts are allowed to connect to local forwarded ports. By default, \&\fBssh\fR\|(1) 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 ssh 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). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "GlobalKnownHostsFile" .IX Subsection "GlobalKnownHostsFile" Specifies one or more files to use for the global host key database, separated by whitespace. The default is \fI/etc/ssh/ssh_known_hosts\fR, \&\fI/etc/ssh/ssh_known_hosts2\fR. \fI Optional. Type uniline. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" /etc/ssh/ssh_known_hosts .SS "GSSAPIAuthentication" .IX Subsection "GSSAPIAuthentication" Specifies whether user authentication based on \s-1GSSAPI\s0 is allowed. The default is \&\fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "GSSAPIClientIdentity" .IX Subsection "GSSAPIClientIdentity" If set, specifies the \s-1GSSAPI\s0 client identity that ssh should use when connecting to the server. The default is unset, which means that the default identity will be used. \fI Optional. Type uniline. \fR .SS "GSSAPIDelegateCredentials" .IX Subsection "GSSAPIDelegateCredentials" Forward (delegate) credentials to the server. The default is \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "GSSAPIKeyExchange" .IX Subsection "GSSAPIKeyExchange" Specifies whether key exchange based on \s-1GSSAPI\s0 may be used. When using \s-1GSSAPI\s0 key exchange the server need not have a host key. The default is \&\fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "GSSAPIRenewalForcesRekey" .IX Subsection "GSSAPIRenewalForcesRekey" If set to \fByes\fR then renewal of the client's \s-1GSSAPI\s0 credentials will force the rekeying of the ssh connection. With a compatible server, this will delegate the renewed credentials to a session on the server. .PP Checks are made to ensure that credentials are only propagated when the new credentials match the old ones on the originating client and where the receiving server still has the old set in its cache. .PP The default is \&\fBno\fR. .PP For this to work \fBGSSAPIKeyExchange\fR needs to be enabled in the server and also used by the client. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "GSSAPIServerIdentity" .IX Subsection "GSSAPIServerIdentity" If set, specifies the \s-1GSSAPI\s0 server identity that ssh should expect when connecting to the server. The default is unset, which means that the expected \s-1GSSAPI\s0 server identity will be determined from the target hostname. \fI Optional. Type uniline. \fR .SS "GSSAPITrustDns" .IX Subsection "GSSAPITrustDns" Set to \fByes\fR to indicate that the \s-1DNS\s0 is trusted to securely canonicalize the name of the host being connected to. If \&\fBno\fR, the hostname entered on the command line will be passed untouched to the \s-1GSSAPI\s0 library. The default is \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "GSSAPIKexAlgorithms" .IX Subsection "GSSAPIKexAlgorithms" The list of key exchange algorithms that are offered for \s-1GSSAPI\s0 key exchange. Possible values are .PP gss\-gex\-sha1\-, .PP gss\-group1\-sha1\-, gss\-group14\-sha1\-, gss\-group14\-sha256\-, gss\-group16\-sha512\-, gss\-nistp256\-sha256\-, gss\-curve25519\-sha256\- .PP The default is Xgss\-group14\-sha256\-,gss\-group16\-sha512\-,gss\-nistp256\-sha256\-,gss\-curve25519\-sha256\-,gss\-gex\-sha1\-,gss\-group14\-sha1\-X. This option only applies to connections using \s-1GSSAPI.\s0 \fI Optional. Type uniline. \fR .SS "HashKnownHosts" .IX Subsection "HashKnownHosts" Indicates that \fBssh\fR\|(1) should hash host names and addresses when they are added to \&\fI~/.ssh/known_hosts\fR. These hashed names may be used normally by \fBssh\fR\|(1) and \fBsshd\fR\|(8), but they do not visually reveal identifying information if the file's contents are disclosed. The default is \fBno\fR. Note that existing names and addresses in known hosts files will not be converted automatically, but may be manually hashed using \&\fBssh\-keygen\fR\|(1). Use of this option may break facilities such as tab-completion that rely on being able to read unhashed host names from \fI~/.ssh/known_hosts\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "HostbasedAuthentication" .IX Subsection "HostbasedAuthentication" Specifies whether to try rhosts based authentication with public key authentication. The argument must be \fByes\fR or \fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "HostbasedKeyTypes" .IX Subsection "HostbasedKeyTypes" Specifies the key types that will be used for hostbased authentication as a comma-separated list of patterns. Alternately if the specified list begins with a '+' character, then the specified key types will be appended to the default set instead of replacing them. If the specified list begins with a '\-' character, then the specified key types (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a '^' character, then the specified key types will be placed at the head of the default set. The default for this option is: .PP ecdsa\-sha2\-nistp256\-cert\-v01@openssh.com, .PP ecdsa\-sha2\-nistp384\-cert\-v01@openssh.com, ecdsa\-sha2\-nistp521\-cert\-v01@openssh.com, sk\-ecdsa\-sha2\-nistp256\-cert\-v01@openssh.com, ssh\-ed25519\-cert\-v01@openssh.com, sk\-ssh\-ed25519\-cert\-v01@openssh.com, rsa\-sha2\-512\-cert\-v01@openssh.com, rsa\-sha2\-256\-cert\-v01@openssh.com, ssh\-rsa\-cert\-v01@openssh.com, .PP ecdsa\-sha2\-nistp256,ecdsa\-sha2\-nistp384,ecdsa\-sha2\-nistp521, .PP sk\-ecdsa\-sha2\-nistp256@openssh.com, ssh\-ed25519,sk\-ssh\-ed25519@openssh.com, rsa\-sha2\-512,rsa\-sha2\-256,ssh\-rsa .PP The \fB\-Q\fR option of \fBssh\fR\|(1) may be used to list supported key types. \fI Optional. Type uniline. \fR .SS "HostKeyAlgorithms" .IX Subsection "HostKeyAlgorithms" Specifies the host key algorithms that the client wants to use in order of preference. Alternately if the specified list begins with a \&'+' character, then the specified key types will be appended to the default set instead of replacing them. If the specified list begins with a '\-' character, then the specified key types (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a '^' character, then the specified key types will be placed at the head of the default set. The default for this option is: .PP ecdsa\-sha2\-nistp256\-cert\-v01@openssh.com, .PP ecdsa\-sha2\-nistp384\-cert\-v01@openssh.com, ecdsa\-sha2\-nistp521\-cert\-v01@openssh.com, sk\-ecdsa\-sha2\-nistp256\-cert\-v01@openssh.com, ssh\-ed25519\-cert\-v01@openssh.com, sk\-ssh\-ed25519\-cert\-v01@openssh.com, rsa\-sha2\-512\-cert\-v01@openssh.com, rsa\-sha2\-256\-cert\-v01@openssh.com, ssh\-rsa\-cert\-v01@openssh.com, .PP ecdsa\-sha2\-nistp256,ecdsa\-sha2\-nistp384,ecdsa\-sha2\-nistp521, .PP sk\-ecdsa\-sha2\-nistp256@openssh.com, ssh\-ed25519,sk\-ssh\-ed25519@openssh.com, rsa\-sha2\-512,rsa\-sha2\-256,ssh\-rsa .PP If hostkeys are known for the destination host then this default is modified to prefer their algorithms. .PP The list of available key types may also be obtained using \*(L"ssh \-Q HostKeyAlgorithms\*(R". \fI Optional. Type uniline. \fR .SS "HostKeyAlias" .IX Subsection "HostKeyAlias" 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 and when validating host certificates. This option is useful for tunneling \s-1SSH\s0 connections or for multiple servers running on a single host. \fI Optional. Type uniline. \fR .SS "Hostname" .IX Subsection "Hostname" Specifies the real host name to log into. This can be used to specify nicknames or abbreviations for hosts. Arguments to \fBHostname\fR accept the tokens described in the \fI\s-1TOKENS\s0\fR section. Numeric \&\s-1IP\s0 addresses are also permitted (both on the command line and in \fBHostname\fR specifications). The default is the name given on the command line. \fI Optional. Type uniline. \fR .SS "IdentitiesOnly" .IX Subsection "IdentitiesOnly" Specifies that \fBssh\fR\|(1) should only use the configured authentication identity and certificate files (either the default files, or those explicitly configured in the \fBssh_config\fR files or passed on the \fBssh\fR\|(1) command-line), even if \fBssh\-agent\fR\|(1) or a \fBPKCS11Provider\fR or \fBSecurityKeyProvider\fR offers more identities. The argument to this keyword must be \&\fByes\fR or \fBno\fR (the default). This option is intended for situations where ssh-agent offers many different identities. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "IdentityAgent" .IX Subsection "IdentityAgent" Specifies the UNIX-domain socket used to communicate with the authentication agent. .PP This option overrides the \s-1SSH_AUTH_SOCK\s0 environment variable and can be used to select a specific agent. Setting the socket name to \&\fBnone\fR disables the use of an authentication agent. If the string \*(L"\s-1SSH_AUTH_SOCK\*(R"\s0 is specified, the location of the socket will be read from the \s-1SSH_AUTH_SOCK\s0 environment variable. Otherwise if the specified value begins with a '$' character, then it will be treated as an environment variable containing the location of the socket. .PP Arguments to \&\fBIdentityAgent\fR may use the tilde syntax to refer to a user's home directory, the tokens described in the \&\fI\s-1TOKENS\s0\fR section and environment variables as described in the \fI\s-1ENVIRONMENT VARIABLES\s0\fR section. \fI Optional. Type uniline. \fR .SS "IdentityFile" .IX Subsection "IdentityFile" Specifies a file from which the user's \s-1DSA, ECDSA,\s0 authenticator-hosted \s-1ECDSA,\s0 Ed25519, authenticator-hosted Ed25519 or \s-1RSA\s0 authentication identity is read. The default is \fI~/.ssh/id_dsa\fR, \&\fI~/.ssh/id_ecdsa\fR, \fI~/.ssh/id_ecdsa_sk\fR, \&\fI~/.ssh/id_ed25519\fR, \fI~/.ssh/id_ed25519_sk\fR and \&\fI~/.ssh/id_rsa\fR. Additionally, any identities represented by the authentication agent will be used for authentication unless \fBIdentitiesOnly\fR is set. If no certificates have been explicitly specified by \&\fBCertificateFile\fR, \fBssh\fR\|(1) will try to load certificate information from the filename obtained by appending \&\fI\-cert.pub\fR to the path of a specified \&\fBIdentityFile\fR. .PP Arguments to \&\fBIdentityFile\fR may use the tilde syntax to refer to a user's home directory or the tokens described in the \&\fI\s-1TOKENS\s0\fR section. .PP It is possible to have multiple identity files specified in configuration files; all these identities will be tried in sequence. Multiple \fBIdentityFile\fR directives will add to the list of identities tried (this behaviour differs from that of other configuration directives). .PP \&\fBIdentityFile\fR may be used in conjunction with \fBIdentitiesOnly\fR to select which identities in an agent are offered during authentication. \fBIdentityFile\fR may also be used in conjunction with \fBCertificateFile\fR in order to provide any certificate also needed for authentication with the identity. \fI Optional. Type list of uniline. \fR .SS "IgnoreUnknown" .IX Subsection "IgnoreUnknown" Specifies a pattern-list of unknown options to be ignored if they are encountered in configuration parsing. This may be used to suppress errors if \fBssh_config\fR contains options that are unrecognised by \fBssh\fR\|(1). It is recommended that \fBIgnoreUnknown\fR be listed early in the configuration file as it will not be applied to unknown options that appear before it. \fI Optional. Type uniline. \fR .SS "Include" .IX Subsection "Include" Include the specified configuration file(s). Multiple pathnames may be specified and each pathname may contain \fBglob\fR\|(7) wildcards and, for user configurations, shell-like '~' references to user home directories. Wildcards will be expanded and processed in lexical order. Files without absolute paths are assumed to be in \fI~/.ssh\fR if included in a user configuration file or \fI/etc/ssh\fR if included from the system configuration file. \fBInclude\fR directive may appear inside a \fBMatch\fR or \fBHost\fR block to perform conditional inclusion. \fI Optional. Type list of uniline. \fR .SS "IPQoS" .IX Subsection "IPQoS" Specifies the IPv4 type-of-service or \s-1DSCP\s0 class for connections. Accepted values are \fBaf11\fR, \fBaf12\fR, \fBaf13\fR, \&\fBaf21\fR, \fBaf22\fR, \fBaf23\fR, \fBaf31\fR, \&\fBaf32\fR, \fBaf33\fR, \fBaf41\fR, \fBaf42\fR, \&\fBaf43\fR, \fBcs0\fR, \fBcs1\fR, \fBcs2\fR, \fBcs3\fR, \&\fBcs4\fR, \fBcs5\fR, \fBcs6\fR, \fBcs7\fR, \fBef\fR, \&\fBle\fR, \fBlowdelay\fR, \fBthroughput\fR, \&\fBreliability\fR, a numeric value, or \fBnone\fR to use the operating system default. This option may take one or two arguments, separated by whitespace. If one argument is specified, it is used as the packet class unconditionally. If two values are specified, the first is automatically selected for interactive sessions and the second for non-interactive sessions. The default is \fBlowdelay\fR for interactive sessions and \fBthroughput\fR for non-interactive sessions. \fI Optional. Type uniline. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" af21 cs1 .SS "KbdInteractiveAuthentication" .IX Subsection "KbdInteractiveAuthentication" Specifies whether to use keyboard-interactive authentication. The argument to this keyword must be \fByes\fR (the default) or \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "KbdInteractiveDevices" .IX Subsection "KbdInteractiveDevices" Specifies the list of methods to use in keyboard-interactive authentication. Multiple method names must be comma-separated. The default is to use the server specified list. The methods available vary depending on what the server supports. For an OpenSSH server, it may be zero or more of: \fBbsdauth\fR and \&\fBpam\fR. \fI Optional. Type list of uniline. \fR .SS "KexAlgorithms" .IX Subsection "KexAlgorithms" Specifies the available \s-1KEX\s0 (Key Exchange) algorithms. Multiple algorithms must be comma-separated. If the specified list begins with a \&'+' character, then the specified methods will be appended to the default set instead of replacing them. If the specified list begins with a '\-' character, then the specified methods (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a '^' character, then the specified methods will be placed at the head of the default set. The default is: .PP curve25519\-sha256,curve25519\-sha256@libssh.org, .PP ecdh\-sha2\-nistp256,ecdh\-sha2\-nistp384,ecdh\-sha2\-nistp521, .PP diffie\-hellman\-group\-exchange\-sha256, diffie\-hellman\-group16\-sha512, diffie\-hellman\-group18\-sha512, diffie\-hellman\-group14\-sha256 .PP The list of available key exchange algorithms may also be obtained using \&\*(L"ssh \-Q kex\*(R". \fI Optional. Type uniline. \fR .SS "LocalCommand" .IX Subsection "LocalCommand" Specifies a command to execute on the local machine after successfully connecting to the server. The command string extends to the end of the line, and is executed with the user's shell. Arguments to \&\fBLocalCommand\fR accept the tokens described in the \&\fI\s-1TOKENS\s0\fR section. .PP The command is run synchronously and does not have access to the session of the \fBssh\fR\|(1) that spawned it. It should not be used for interactive commands. .PP This directive is ignored unless \fBPermitLocalCommand\fR has been enabled. \fI Optional. Type uniline. \fR .SS "LocalForward" .IX Subsection "LocalForward" Specifies that a \s-1TCP\s0 port on the local machine be forwarded over the secure channel to the specified host and port from the remote machine. The first argument specifies the listener and may be [ .PP \&\fIbind_address\fR: ]\fIport\fR or a Unix domain socket path. The second argument is the destination and may be \fIhost\fR:\fIhostport\fR or a Unix domain socket path if the remote host supports it. .PP IPv6 addresses can be specified by enclosing addresses in square brackets. Multiple forwardings may be specified, and additional forwardings can be given on the command line. Only the superuser can forward privileged ports. By default, the local port is bound in accordance with the \&\fBGatewayPorts\fR setting. However, an explicit \&\fIbind_address\fR may 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 \&'*' indicates that the port should be available from all interfaces. Unix domain socket paths may use the tokens described in the \fI\s-1TOKENS\s0\fR section and environment variables as described in the \fI\s-1ENVIRONMENT VARIABLES\s0\fR section. \fI Optional. Type list of node of class Ssh::PortForward . \fR .SS "LogLevel" .IX Subsection "LogLevel" Gives the verbosity level that is used when logging messages from \fBssh\fR\|(1). The possible values are: \s-1QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2,\s0 and \s-1DEBUG3.\s0 The default is \s-1INFO. DEBUG\s0 and \&\s-1DEBUG1\s0 are equivalent. \s-1DEBUG2\s0 and \s-1DEBUG3\s0 each specify higher levels of verbose output. \fI Optional. Type enum. choice: '\s-1QUIET\s0', '\s-1FATAL\s0', '\s-1ERROR\s0', '\s-1INFO\s0', '\s-1VERBOSE\s0', '\s-1DEBUG\s0', '\s-1DEBUG1\s0', '\s-1DEBUG2\s0', '\s-1DEBUG3\s0'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" \&\s-1INFO\s0 .SS "MACs" .IX Subsection "MACs" Specifies the \&\s-1MAC\s0 (message authentication code) algorithms in order of preference. The \s-1MAC\s0 algorithm is used for data integrity protection. Multiple algorithms must be comma-separated. If the specified list begins with a '+' character, then the specified algorithms will be appended to the default set instead of replacing them. If the specified list begins with a '\-' character, then the specified algorithms (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a '^' character, then the specified algorithms will be placed at the head of the default set. .PP The algorithms that contain \*(L"\-etm\*(R" calculate the \s-1MAC\s0 after encryption (encrypt-then-mac). These are considered safer and their use recommended. .PP The default is: .PP umac\-64\-etm@openssh.com,umac\-128\-etm@openssh.com, .PP hmac\-sha2\-256\-etm@openssh.com,hmac\-sha2\-512\-etm@openssh.com, .PP hmac\-sha1\-etm@openssh.com, umac\-64@openssh.com,umac\-128@openssh.com, hmac\-sha2\-256,hmac\-sha2\-512,hmac\-sha1 .PP The list of available \s-1MAC\s0 algorithms may also be obtained using \&\*(L"ssh \-Q mac\*(R". \fI Optional. Type uniline. \fR .SS "NoHostAuthenticationForLocalhost" .IX Subsection "NoHostAuthenticationForLocalhost" Disable host authentication for localhost (loopback addresses). The argument to this keyword must be \fByes\fR or \fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "NumberOfPasswordPrompts" .IX Subsection "NumberOfPasswordPrompts" Specifies the number of password prompts before giving up. The argument to this keyword must be an integer. The default is 3. \fI Optional. Type integer. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" 3 .SS "PasswordAuthentication" .IX Subsection "PasswordAuthentication" Specifies whether to use password authentication. The argument to this keyword must be \fByes\fR (the default) or \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "PermitLocalCommand" .IX Subsection "PermitLocalCommand" Allow local command execution via the \fBLocalCommand\fR option or using the \&\fB!\fR\fIcommand\fR escape sequence in \fBssh\fR\|(1). The argument must be \fByes\fR or \fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "PKCS11Provider" .IX Subsection "PKCS11Provider" Specifies which PKCS#11 provider to use or \fBnone\fR to indicate that no provider should be used (the default). The argument to this keyword is a path to the PKCS#11 shared library \fBssh\fR\|(1) should use to communicate with a PKCS#11 token providing keys for user authentication. \fI Optional. Type uniline. \fR .SS "Port" .IX Subsection "Port" Specifies the port number to connect on the remote host. The default is 22. \fI Optional. Type uniline. \fR .SS "PreferredAuthentications" .IX Subsection "PreferredAuthentications" Specifies the order in which the client should try authentication methods. This allows a client to prefer one method (e.g. \&\fBkeyboard-interactive\fR) over another method (e.g. \&\fBpassword\fR). The default is: .PP gssapi\-with\-mic,hostbased,publickey, .PP keyboard\-interactive,password. \fI Optional. Type list of uniline. \fR .SS "ProxyCommand" .IX Subsection "ProxyCommand" Specifies the command to use to connect to the server. The command string extends to the end of the line, and is executed using the user's shell \&'exec' directive to avoid a lingering shell process. .PP Arguments to \&\fBProxyCommand\fR accept the tokens described in the \&\fI\s-1TOKENS\s0\fR section. The command can be basically anything, and should read from its standard input and write to its standard output. It should eventually connect an \&\fBsshd\fR\|(8) server running on some machine, or execute \fBsshd \&\-i\fR somewhere. Host key management will be done using the \&\fBHostname\fR of the host being connected (defaulting to the name typed by the user). Setting the command to \&\fBnone\fR disables this option entirely. Note that \&\fBCheckHostIP\fR is not available for connects with a proxy command. .PP This directive is useful in conjunction with \fBnc\fR\|(1) and its proxy support. For example, the following directive would connect via an \&\s-1HTTP\s0 proxy at 192.0.2.0: .PP ProxyCommand /usr/bin/nc \-X connect \-x 192.0.2.0:8080 \f(CW%h\fR \f(CW%p\fR. \fI Optional. Type uniline. \fR .SS "ProxyJump" .IX Subsection "ProxyJump" Specifies one or more jump proxies as either .PP [\fIuser\fR@]\fIhost\fR[:\fIport\fR] or an ssh \s-1URI .\s0 Multiple proxies may be separated by comma characters and will be visited sequentially. Setting this option will cause \&\fBssh\fR\|(1) to connect to the target host by first making a \&\fBssh\fR\|(1) connection to the specified \fBProxyJump\fR host and then establishing a \s-1TCP\s0 forwarding to the ultimate target from there. .PP Note that this option will compete with the \fBProxyCommand\fR option \- whichever is specified first will prevent later instances of the other from taking effect. .PP Note also that the configuration for the destination host (either supplied via the command-line or the configuration file) is not generally applied to jump hosts. \fI~/.ssh/config\fR should be used if specific configuration is required for jump hosts. \fI Optional. Type list of uniline. \fR .SS "ProxyUseFdpass" .IX Subsection "ProxyUseFdpass" Specifies that \&\fBProxyCommand\fR will pass a connected file descriptor back to \fBssh\fR\|(1) instead of continuing to execute and pass data. The default is \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "PubkeyAcceptedKeyTypes" .IX Subsection "PubkeyAcceptedKeyTypes" Specifies the key types that will be used for public key authentication as a comma-separated list of patterns. If the specified list begins with a '+' character, then the key types after it will be appended to the default instead of replacing it. If the specified list begins with a \&'\-' character, then the specified key types (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a '^' character, then the specified key types will be placed at the head of the default set. The default for this option is: .PP ecdsa\-sha2\-nistp256\-cert\-v01@openssh.com, .PP ecdsa\-sha2\-nistp384\-cert\-v01@openssh.com, ecdsa\-sha2\-nistp521\-cert\-v01@openssh.com, sk\-ecdsa\-sha2\-nistp256\-cert\-v01@openssh.com, ssh\-ed25519\-cert\-v01@openssh.com, sk\-ssh\-ed25519\-cert\-v01@openssh.com, rsa\-sha2\-512\-cert\-v01@openssh.com, rsa\-sha2\-256\-cert\-v01@openssh.com, ssh\-rsa\-cert\-v01@openssh.com, .PP ecdsa\-sha2\-nistp256,ecdsa\-sha2\-nistp384,ecdsa\-sha2\-nistp521, .PP sk\-ecdsa\-sha2\-nistp256@openssh.com, ssh\-ed25519,sk\-ssh\-ed25519@openssh.com, rsa\-sha2\-512,rsa\-sha2\-256,ssh\-rsa .PP The list of available key types may also be obtained using \*(L"ssh \-Q PubkeyAcceptedKeyTypes\*(R". \fI Optional. Type uniline. \fR .SS "PubkeyAuthentication" .IX Subsection "PubkeyAuthentication" Specifies whether to try public key authentication. The argument to this keyword must be \&\fByes\fR (the default) or \fBno\fR. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "RekeyLimit" .IX Subsection "RekeyLimit" Specifies the maximum amount of data that may be transmitted before the session key is renegotiated, optionally followed a maximum amount of time that may pass before the session key is renegotiated. The first argument is specified in bytes and may have a suffix of 'K', 'M', or 'G' to indicate Kilobytes, Megabytes, or Gigabytes, respectively. The default is between '1G' and \&'4G', depending on the cipher. The optional second value is specified in seconds and may use any of the units documented in the \s-1TIME FORMATS\s0 section of \&\fBsshd_config\fR\|(5). The default value for \fBRekeyLimit\fR is \&\fBdefault none\fR, which means that rekeying is performed after the cipher's default amount of data has been sent or received and no time based rekeying is done. \fI Optional. Type uniline. \fR .SS "RemoteCommand" .IX Subsection "RemoteCommand" Specifies a command to execute on the remote machine after successfully connecting to the server. The command string extends to the end of the line, and is executed with the user's shell. Arguments to \&\fBRemoteCommand\fR accept the tokens described in the \&\fI\s-1TOKENS\s0\fR section. \fI Optional. Type uniline. \fR .SS "RemoteForward" .IX Subsection "RemoteForward" Specifies that a \s-1TCP\s0 port on the remote machine be forwarded over the secure channel. The remote port may either be forwarded to a specified host and port from the local machine, or may act as a \s-1SOCKS 4/5\s0 proxy that allows a remote client to connect to arbitrary destinations from the local machine. The first argument is the listening specification and may be [ .PP \&\fIbind_address\fR: ]\fIport\fR or, if the remote host supports it, a Unix domain socket path. If forwarding to a specific destination then the second argument must be \&\fIhost\fR:\fIhostport\fR or a Unix domain socket path, otherwise if no destination argument is specified then the remote forwarding will be established as a \s-1SOCKS\s0 proxy. .PP IPv6 addresses can be specified by enclosing addresses in square brackets. Multiple forwardings may be specified, and additional forwardings can be given on the command line. Privileged ports can be forwarded only when logging in as root on the remote machine. Unix domain socket paths may use the tokens described in the \fI\s-1TOKENS\s0\fR section and environment variables as described in the \fI\s-1ENVIRONMENT VARIABLES\s0\fR section. .PP If the \&\fIport\fR argument is 0, the listen port will be dynamically allocated on the server and reported to the client at run time. .PP If the \&\fIbind_address\fR is not specified, the default is to only bind to loopback addresses. If the \fIbind_address\fR is \&'*' or an empty string, then the forwarding is requested to listen on all interfaces. Specifying a remote \&\fIbind_address\fR will only succeed if the server's \&\fBGatewayPorts\fR option is enabled (see \&\fBsshd_config\fR\|(5)). \fI Optional. Type list of node of class Ssh::PortForward . \fR .SS "RequestTTY" .IX Subsection "RequestTTY" Specifies whether to request a pseudo-tty for the session. The argument may be one of: \&\fBno\fR (never request a \s-1TTY\s0), \fByes\fR (always request a \s-1TTY\s0 when standard input is a \s-1TTY\s0), \fBforce\fR (always request a \s-1TTY\s0) or \fBauto\fR (request a \s-1TTY\s0 when opening a login session). This option mirrors the \fB\-t\fR and \&\fB\-T\fR flags for \fBssh\fR\|(1). \fI Optional. Type enum. choice: 'no', 'yes', 'force', 'auto'. \fR .SS "RevokedHostKeys" .IX Subsection "RevokedHostKeys" Specifies revoked host public keys. Keys listed in this file will be refused for host authentication. Note that if this file does not exist or is not readable, then host authentication will be refused for all hosts. Keys may be specified as a text file, listing one public key per line, or as an OpenSSH Key Revocation List (\s-1KRL\s0) as generated by \fBssh\-keygen\fR\|(1). For more information on KRLs, see the \s-1KEY REVOCATION LISTS\s0 section in \&\fBssh\-keygen\fR\|(1). \fI Optional. Type uniline. \fR .SS "SecurityKeyProvider" .IX Subsection "SecurityKeyProvider" Specifies a path to a library that will be used when loading any \s-1FIDO\s0 authenticator-hosted keys, overriding the default of using the built-in \s-1USB HID\s0 support. .PP If the specified value begins with a '$' character, then it will be treated as an environment variable containing the path to the library. \fI Optional. Type uniline. \fR .SS "SendEnv" .IX Subsection "SendEnv" Specifies what variables from the local \fBenviron\fR\|(7) should be sent to the server. The server must also support it, and the server must be configured to accept these environment variables. Note that the \s-1TERM\s0 environment variable is always sent whenever a pseudo-terminal is requested as it is required by the protocol. Refer to \fBAcceptEnv\fR in \fBsshd_config\fR\|(5) for how to configure the server. Variables are specified by name, which may contain wildcard characters. Multiple environment variables may be separated by whitespace or spread across multiple \fBSendEnv\fR directives. .PP See \&\fI\s-1PATTERNS\s0\fR for more information on patterns. .PP It is possible to clear previously set \fBSendEnv\fR variable names by prefixing patterns with \fI\-\fR. The default is not to send any environment variables. \fI Optional. Type list of uniline. \fR .SS "ServerAliveCountMax" .IX Subsection "ServerAliveCountMax" Sets the number of server alive messages (see below) which may be sent without \fBssh\fR\|(1) receiving any messages back from the server. If this threshold is reached while server alive messages are being sent, ssh will disconnect from the server, terminating the session. It is important to note that the use of server alive messages is very different from \fBTCPKeepAlive\fR (below). The server alive messages are sent through the encrypted channel and therefore will not be spoofable. The \&\s-1TCP\s0 keepalive 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 unresponsive. .PP The default value is 3. If, for example, \fBServerAliveInterval\fR (see below) is set to 15 and \fBServerAliveCountMax\fR is left at the default, if the server becomes unresponsive, ssh will disconnect after approximately 45 seconds. \fI Optional. Type integer. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" 3 .SS "ServerAliveInterval" .IX Subsection "ServerAliveInterval" Sets a timeout interval in seconds after which if no data has been received from the server, \fBssh\fR\|(1) will send a message through the encrypted channel to request a response from the server. The default is 0, indicating that these messages will not be sent to the server, or 300 if the \fBBatchMode\fR option is set (Debian-specific). \fBProtocolKeepAlives\fR and \&\fBSetupTimeOut\fR are Debian-specific compatibility aliases for this option. \fI Optional. Type integer. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" 0 .SS "SetEnv" .IX Subsection "SetEnv" Directly specify one or more environment variables and their contents to be sent to the server. Similarly to \fBSendEnv\fR, the server must be prepared to accept the environment variable. \fI Optional. Type uniline. \fR .SS "StreamLocalBindMask" .IX Subsection "StreamLocalBindMask" Sets the octal file creation mode mask (umask) used when creating a Unix-domain socket file for local or remote port forwarding. This option is only used for port forwarding to a Unix-domain socket file. .PP The default value is 0177, which creates a Unix-domain socket file that is readable and writable only by the owner. Note that not all operating systems honor the file mode on Unix-domain socket files. \fI Optional. Type uniline. \fR .SS "StreamLocalBindUnlink" .IX Subsection "StreamLocalBindUnlink" Specifies whether to remove an existing Unix-domain socket file for local or remote port forwarding before creating a new one. If the socket file already exists and \fBStreamLocalBindUnlink\fR is not enabled, \fBssh\fR will be unable to forward the port to the Unix-domain socket file. This option is only used for port forwarding to a Unix-domain socket file. .PP The argument must be \fByes\fR or \fBno\fR (the default). \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "StrictHostKeyChecking" .IX Subsection "StrictHostKeyChecking" If this flag is set to \&\fByes\fR, \fBssh\fR\|(1) will never automatically add host keys to the \fI~/.ssh/known_hosts\fR file, and refuses to connect to hosts whose host key has changed. This provides maximum protection against man-in-the-middle (\s-1MITM\s0) attacks, though it can be annoying when the \fI/etc/ssh/ssh_known_hosts\fR file is poorly maintained or when connections to new hosts are frequently made. This option forces the user to manually add all new hosts. .PP If this flag is set to Xaccept-newX then ssh will automatically add new host keys to the user known hosts files, but will not permit connections to hosts with changed host keys. If this flag is set to \fBno\fR or \fBoff\fR, ssh will automatically add new host keys to the user known hosts files and allow connections to hosts with changed hostkeys to proceed, subject to some restrictions. If this flag is set to \fBask\fR (the default), new host keys will be added to the user known host files only after the user has confirmed that is what they really want to do, and ssh will refuse to connect to hosts whose host key has changed. The host keys of known hosts will be verified automatically in all cases. \fI Optional. Type enum. choice: 'yes', 'accept\-new', 'no', 'off', 'ask'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" ask .SS "SyslogFacility" .IX Subsection "SyslogFacility" Gives the facility code that is used when logging messages from \fBssh\fR\|(1). The possible values are: \s-1DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.\s0 The default is \s-1USER.\s0 \fI Optional. Type enum. choice: '\s-1DAEMON\s0', '\s-1USER\s0', '\s-1AUTH\s0', '\s-1LOCAL0\s0', '\s-1LOCAL1\s0', '\s-1LOCAL2\s0', '\s-1LOCAL3\s0', '\s-1LOCAL4\s0', '\s-1LOCAL5\s0', '\s-1LOCAL6\s0', '\s-1LOCAL7\s0'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" \&\s-1USER\s0 .SS "TCPKeepAlive" .IX Subsection "TCPKeepAlive" Specifies whether the system should send \s-1TCP\s0 keepalive messages to the other side. If they are sent, death of the connection or crash of one of the machines will be properly noticed. This option only uses \&\s-1TCP\s0 keepalives (as opposed to using ssh level keepalives), so takes a long time to notice when the connection dies. As such, you probably want the \fBServerAliveInterval\fR option as well. However, this means that connections will die if the route is down temporarily, and some people find it annoying. .PP The default is \&\fByes\fR (to send \s-1TCP\s0 keepalive messages), and the client will notice if the network goes down or the remote host dies. This is important in scripts, and many users want it too. .PP To disable \s-1TCP\s0 keepalive messages, the value should be set to \fBno\fR. See also \fBServerAliveInterval\fR for protocol-level keepalives. \fI Optional. Type boolean. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" yes .SS "Tunnel" .IX Subsection "Tunnel" Request \fBtun\fR\|(4) device forwarding between the client and the server. The argument must be \fByes\fR, \fBpoint-to-point\fR (layer 3), \fBethernet\fR (layer 2), or \fBno\fR (the default). Specifying \fByes\fR requests the default tunnel mode, which is \fBpoint-to-point\fR. \fI Optional. Type enum. choice: 'yes', 'point\-to\-point', 'ethernet', 'no'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "TunnelDevice" .IX Subsection "TunnelDevice" Specifies the \fBtun\fR\|(4) devices to open on the client (\fIlocal_tun\fR) and the server (\fIremote_tun\fR). .PP The argument must be \fIlocal_tun\fR[:\fIremote_tun\fR]. The devices may be specified by numerical \s-1ID\s0 or the keyword \fBany\fR, which uses the next available tunnel device. If \&\fIremote_tun\fR is not specified, it defaults to \&\fBany\fR. The default is \fBany:any\fR. \fI Optional. Type uniline. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" any:any .SS "UpdateHostKeys" .IX Subsection "UpdateHostKeys" Specifies whether \fBssh\fR\|(1) should accept notifications of additional hostkeys from the server sent after authentication has completed and add them to \&\fBUserKnownHostsFile\fR. The argument must be \fByes\fR, \&\fBno\fR or \fBask\fR. This option allows learning alternate hostkeys for a server and supports graceful key rotation by allowing a server to send replacement public keys before old ones are removed. Additional hostkeys are only accepted if the key used to authenticate the host was already trusted or explicitly accepted by the user. .PP \&\fBUpdateHostKeys\fR is enabled by default if the user has not overridden the default \fBUserKnownHostsFile\fR setting, otherwise \&\fBUpdateHostKeys\fR will be set to \fBask\fR. .PP If \&\fBUpdateHostKeys\fR is set to \fBask\fR, then the user is asked to confirm the modifications to the known_hosts file. Confirmation is currently incompatible with \&\fBControlPersist\fR, and will be disabled if it is enabled. .PP Presently, only \&\fBsshd\fR\|(8) from OpenSSH 6.8 and greater support the \&\*(L"hostkeys@openssh.com\*(R" protocol extension used to inform the client of all the server's hostkeys. \fI Optional. Type enum. choice: 'yes', 'no', 'ask'. \fR .SS "User" .IX Subsection "User" Specifies the user to log in as. This can be useful when a different user name is used on different machines. This saves the trouble of having to remember to give the user name on the command line. \fI Optional. Type uniline. \fR .SS "UserKnownHostsFile" .IX Subsection "UserKnownHostsFile" Specifies one or more files to use for the user host key database, separated by whitespace. Each filename may use tilde notation to refer to the user's home directory, the tokens described in the \&\fI\s-1TOKENS\s0\fR section and environment variables as described in the \fI\s-1ENVIRONMENT VARIABLES\s0\fR section. The default is \&\fI~/.ssh/known_hosts\fR, \fI~/.ssh/known_hosts2\fR. \fI Optional. Type uniline. \fR .SS "VerifyHostKeyDNS" .IX Subsection "VerifyHostKeyDNS" Specifies whether to verify the remote key using \s-1DNS\s0 and \s-1SSHFP\s0 resource records. If this option is set to \fByes\fR, the client will implicitly trust keys that match a secure fingerprint from \s-1DNS.\s0 Insecure fingerprints will be handled as if this option was set to \fBask\fR. If this option is set to \fBask\fR, information on fingerprint match will be displayed, but the user will still need to confirm new host keys according to the \fBStrictHostKeyChecking\fR option. The default is \&\fBno\fR. .PP See also \&\fI\s-1VERIFYING HOST KEYS\s0\fR in \fBssh\fR\|(1). \fI Optional. Type enum. choice: 'yes', 'ask', 'no'. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "VisualHostKey" .IX Subsection "VisualHostKey" If this flag is set to \&\fByes\fR, an \s-1ASCII\s0 art representation of the remote host key fingerprint is printed in addition to the fingerprint string at login and for unknown host keys. If this flag is set to \fBno\fR (the default), no fingerprint strings are printed at login and only the fingerprint string will be printed for unknown host keys. \fI Optional. Type uniline. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" no .SS "XAuthLocation" .IX Subsection "XAuthLocation" Specifies the full pathname of the \fBxauth\fR\|(1) program. The default is \&\fI/usr/bin/xauth\fR. \fI Optional. Type uniline. \fR .IP "upstream_default value :" 4 .IX Item "upstream_default value :" /usr/bin/xauth .SS "FallBackToRsh" .IX Subsection "FallBackToRsh" This parameter is now ignored by Ssh. \fBDeprecated\fR \fI Optional. Type uniline. \fR .SS "UseRsh" .IX Subsection "UseRsh" This parameter is now ignored by Ssh. \fBDeprecated\fR \fI Optional. Type uniline. \fR .SS "Match" .IX Subsection "Match" Restricts the following declarations (up to the next \fBHost\fR or \&\fBMatch\fR keyword) to be used only when the conditions following the \fBMatch\fR keyword are satisfied. Match conditions are specified using one or more criteria or the single token \fBall\fR which always matches. The available criteria keywords are: \fBcanonical\fR, \fBfinal\fR, \&\fBexec\fR, \fBhost\fR, \fBoriginalhost\fR, \fBuser\fR, and \fBlocaluser\fR. The \fBall\fR criteria must appear alone or immediately after \fBcanonical\fR or \fBfinal\fR. Other criteria may be combined arbitrarily. All criteria but \&\fBall\fR, \fBcanonical\fR, and \fBfinal\fR require an argument. Criteria may be negated by prepending an exclamation mark ('!'). .PP The \&\fBcanonical\fR keyword matches only when the configuration file is being re-parsed after hostname canonicalization (see the \fBCanonicalizeHostname\fR option). This may be useful to specify conditions that work with canonical host names only. .PP The \&\fBfinal\fR keyword requests that the configuration be re-parsed (regardless of whether \fBCanonicalizeHostname\fR is enabled), and matches only during this final pass. If \&\fBCanonicalizeHostname\fR is enabled, then \&\fBcanonical\fR and \fBfinal\fR match during the same pass. .PP The \fBexec\fR keyword executes the specified command under the user's shell. If the command returns a zero exit status then the condition is considered true. Commands containing whitespace characters must be quoted. Arguments to \fBexec\fR accept the tokens described in the \&\fI\s-1TOKENS\s0\fR section. .PP The other keywords' criteria must be single entries or comma-separated lists and may use the wildcard and negation operators described in the \fI\s-1PATTERNS\s0\fR section. The criteria for the \fBhost\fR keyword are matched against the target hostname, after any substitution by the \&\fBHostname\fR or \fBCanonicalizeHostname\fR options. The \&\fBoriginalhost\fR keyword matches against the hostname as it was specified on the command-line. The \fBuser\fR keyword matches against the target username on the remote host. The \fBlocaluser\fR keyword matches against the name of the local user running \fBssh\fR\|(1) (this keyword may be useful in system-wide \fBssh_config\fR files). \fI Optional. Type hash of node of class Ssh::HostElement . \fR .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 cme .IP "\(bu" 4 Config::Model::models::Ssh::HostElement .IP "\(bu" 4 Config::Model::models::Ssh::PortForward .SH "LICENSE" .IX Header "LICENSE" .IP "\s-1LGPL2\s0" 4 .IX Item "LGPL2"