java.lang.Object
- org.eclipse.jgit.transport.SshConstants

public final class SshConstants
extends Object

Constants relating to ssh.

Since:: 5.2

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADD_KEYS_TO_AGENT`	Property to control whether private keys are added to an SSH agent, if one is running, after having been loaded.
`static String`	`BATCH_MODE`	Key in an ssh config file.
`static String`	`CANONICAL_DOMAINS`	Key in an ssh config file.
`static String`	`CERTIFICATE_FILE`	Key in an ssh config file.
`static String`	`CIPHERS`	Key in an ssh config file.
`static String`	`COMPRESSION`	Key in an ssh config file.
`static String`	`CONFIG`	Name of the ssh config file.
`static String`	`CONNECT_TIMEOUT`	An OpenSSH time value for the connection timeout.
`static String`	`CONNECTION_ATTEMPTS`	Key in an ssh config file.
`static String`	`CONTROL_PATH`	Key in an ssh config file.
`static String[]`	`DEFAULT_IDENTITIES`	All known default identity file names.
`static String`	`ENV_SSH_AUTH_SOCKET`	Name of the environment variable holding the Unix domain socket for communication with an SSH agent.
`static String`	`FALSE`	Flag value.
`static String`	`GLOBAL_KNOWN_HOSTS_FILE`	Key in an ssh config file.
`static String`	`HASH_KNOWN_HOSTS`	Key in an ssh config file.
`static String`	`HOST`	Key in an ssh config file.
`static String`	`HOST_KEY_ALGORITHMS`	Key in an ssh config file.
`static String`	`HOST_NAME`	Key in an ssh config file.
`static String`	`ID_DSA`	Name of the default DSA private identity file.
`static String`	`ID_ECDSA`	Name of the default ECDSA private identity file.
`static String`	`ID_ED25519`	Name of the default ED25519 private identity file.
`static String`	`ID_RSA`	Name of the default RSA private identity file.
`static String`	`IDENTITIES_ONLY`	Key in an ssh config file.
`static String`	`IDENTITY_AGENT`	Key in an ssh config file.
`static String`	`IDENTITY_FILE`	Key in an ssh config file.
`static String`	`KEX_ALGORITHMS`	Key in an ssh config file.
`static String`	`KNOWN_HOSTS`	Default name of the user "known hosts" file.
`static String`	`LOCAL_COMMAND`	Key in an ssh config file.
`static String`	`LOCAL_FORWARD`	Key in an ssh config file.
`static String`	`MACS`	Key in an ssh config file.
`static String`	`NO`	Flag value.
`static String`	`NONE`	Property value.
`static String`	`NUMBER_OF_PASSWORD_PROMPTS`	Key in an ssh config file.
`static String`	`OFF`	Flag value.
`static String`	`ON`	Flag value.
`static String`	`PORT`	Key in an ssh config file.
`static String`	`PREFERRED_AUTHENTICATIONS`	Key in an ssh config file.
`static String`	`PROXY_COMMAND`	Key in an ssh config file.
`static String`	`PROXY_JUMP`	Comma-separated list of jump hosts, defining a jump host chain in reverse order.
`static String`	`PUBKEY_ACCEPTED_ALGORITHMS`	Key in an ssh config file; defines signature algorithms for public key authentication as a comma-separated list.
`static String`	`REMOTE_COMMAND`	Key in an ssh config file.
`static String`	`REMOTE_FORWARD`	Key in an ssh config file.
`static String`	`SECURITY_KEY_PROVIDER`	(Absolute) path to a middleware library the SSH agent shall use to load SK (U2F) keys.
`static String`	`SEND_ENV`	Key in an ssh config file.
`static String`	`SFTP_SCHEME`	URI scheme for sftp.
`static int`	`SSH_DEFAULT_PORT`	IANA assigned port number for ssh.
`static String`	`SSH_DIR`	Default name for a ssh directory.
`static String`	`SSH_SCHEME`	URI scheme for ssh.
`static String`	`STRICT_HOST_KEY_CHECKING`	Key in an ssh config file.
`static String`	`TRUE`	Flag value.
`static String`	`USER`	Key in an ssh config file.
`static String`	`USER_KNOWN_HOSTS_FILE`	Key in an ssh config file.
`static String`	`YES`	Flag value.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SSH_DEFAULT_PORT
```
public static final int SSH_DEFAULT_PORT
```
    IANA assigned port number for ssh.
    
    See Also:
    
    Constant Field Values
  - SSH_SCHEME
```
public static final String SSH_SCHEME
```
    URI scheme for ssh.
    
    See Also:
    
    Constant Field Values
  - SFTP_SCHEME
```
public static final String SFTP_SCHEME
```
    URI scheme for sftp.
    
    See Also:
    
    Constant Field Values
  - SSH_DIR
```
public static final String SSH_DIR
```
    Default name for a ssh directory.
    
    See Also:
    
    Constant Field Values
  - CONFIG
```
public static final String CONFIG
```
    Name of the ssh config file.
    
    See Also:
    
    Constant Field Values
  - KNOWN_HOSTS
```
public static final String KNOWN_HOSTS
```
    Default name of the user "known hosts" file.
    
    See Also:
    
    Constant Field Values
  - ADD_KEYS_TO_AGENT
```
public static final String ADD_KEYS_TO_AGENT
```
    Property to control whether private keys are added to an SSH agent, if one is running, after having been loaded.
    
    Since:
    
    6.1
    
    See Also:
    
    Constant Field Values
  - BATCH_MODE
```
public static final String BATCH_MODE
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - CANONICAL_DOMAINS
```
public static final String CANONICAL_DOMAINS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - CERTIFICATE_FILE
```
public static final String CERTIFICATE_FILE
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - CIPHERS
```
public static final String CIPHERS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION
```
public static final String COMPRESSION
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_ATTEMPTS
```
public static final String CONNECTION_ATTEMPTS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - CONNECT_TIMEOUT
```
public static final String CONNECT_TIMEOUT
```
    An OpenSSH time value for the connection timeout. In OpenSSH, this includes everything until the end of the initial key exchange; in JGit it covers only the underlying TCP connect.
    
    Since:
    
    6.1
    
    See Also:
    
    Constant Field Values
  - CONTROL_PATH
```
public static final String CONTROL_PATH
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - GLOBAL_KNOWN_HOSTS_FILE
```
public static final String GLOBAL_KNOWN_HOSTS_FILE
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - HASH_KNOWN_HOSTS
```
public static final String HASH_KNOWN_HOSTS
```
    Key in an ssh config file.
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - HOST
```
public static final String HOST
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - HOST_KEY_ALGORITHMS
```
public static final String HOST_KEY_ALGORITHMS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - HOST_NAME
```
public static final String HOST_NAME
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - IDENTITIES_ONLY
```
public static final String IDENTITIES_ONLY
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - IDENTITY_AGENT
```
public static final String IDENTITY_AGENT
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - IDENTITY_FILE
```
public static final String IDENTITY_FILE
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - KEX_ALGORITHMS
```
public static final String KEX_ALGORITHMS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - LOCAL_COMMAND
```
public static final String LOCAL_COMMAND
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - LOCAL_FORWARD
```
public static final String LOCAL_FORWARD
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - MACS
```
public static final String MACS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - NUMBER_OF_PASSWORD_PROMPTS
```
public static final String NUMBER_OF_PASSWORD_PROMPTS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - PORT
```
public static final String PORT
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - PREFERRED_AUTHENTICATIONS
```
public static final String PREFERRED_AUTHENTICATIONS
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - PUBKEY_ACCEPTED_ALGORITHMS
```
public static final String PUBKEY_ACCEPTED_ALGORITHMS
```
    Key in an ssh config file; defines signature algorithms for public key authentication as a comma-separated list.
    
    Since:
    
    5.11.1
    
    See Also:
    
    Constant Field Values
  - PROXY_COMMAND
```
public static final String PROXY_COMMAND
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - PROXY_JUMP
```
public static final String PROXY_JUMP
```
    Comma-separated list of jump hosts, defining a jump host chain in reverse order. Each jump host is a SSH URI or "[user@]host[:port]".
    Reverse order means: to connect A->B->target, one can do in ~/.ssh/config either of:
    
    Host target ProxyJump B,A
    
    or
    
    Host target ProxyJump B Host B ProxyJump A
    Since:
    
    5.10
    
    See Also:
    
    Constant Field Values
  - REMOTE_COMMAND
```
public static final String REMOTE_COMMAND
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - REMOTE_FORWARD
```
public static final String REMOTE_FORWARD
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - SECURITY_KEY_PROVIDER
```
public static final String SECURITY_KEY_PROVIDER
```
    (Absolute) path to a middleware library the SSH agent shall use to load SK (U2F) keys.
    
    Since:
    
    6.1
    
    See Also:
    
    Constant Field Values
  - SEND_ENV
```
public static final String SEND_ENV
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - STRICT_HOST_KEY_CHECKING
```
public static final String STRICT_HOST_KEY_CHECKING
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - USER
```
public static final String USER
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - USER_KNOWN_HOSTS_FILE
```
public static final String USER_KNOWN_HOSTS_FILE
```
    Key in an ssh config file.
    
    See Also:
    
    Constant Field Values
  - YES
```
public static final String YES
```
    Flag value.
    
    See Also:
    
    Constant Field Values
  - ON
```
public static final String ON
```
    Flag value.
    
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    Flag value.
    
    See Also:
    
    Constant Field Values
  - NO
```
public static final String NO
```
    Flag value.
    
    See Also:
    
    Constant Field Values
  - OFF
```
public static final String OFF
```
    Flag value.
    
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    Flag value.
    
    See Also:
    
    Constant Field Values
  - NONE
```
public static final String NONE
```
    Property value. Some keys accept a special 'none' value to override and clear a setting otherwise contributed by another host entry, for instance PROXY_COMMAND or PROXY_JUMP. Example:
    Host bastion.example.org ProxyJump none Host *.example.org ProxyJump bastion.example.org
    
    OpenSSH supports this since OpenSSH 7.8.
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - ID_RSA
```
public static final String ID_RSA
```
    Name of the default RSA private identity file.
    
    See Also:
    
    Constant Field Values
  - ID_DSA
```
public static final String ID_DSA
```
    Name of the default DSA private identity file.
    
    See Also:
    
    Constant Field Values
  - ID_ECDSA
```
public static final String ID_ECDSA
```
    Name of the default ECDSA private identity file.
    
    See Also:
    
    Constant Field Values
  - ID_ED25519
```
public static final String ID_ED25519
```
    Name of the default ED25519 private identity file.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IDENTITIES
```
public static final String[] DEFAULT_IDENTITIES
```
    All known default identity file names.
  - ENV_SSH_AUTH_SOCKET
```
public static final String ENV_SSH_AUTH_SOCKET
```
    Name of the environment variable holding the Unix domain socket for communication with an SSH agent.
    
    Since:
    
    6.1
    
    See Also:
    
    Constant Field Values

Class SshConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SSH_DEFAULT_PORT

SSH_SCHEME

SFTP_SCHEME

SSH_DIR

CONFIG

KNOWN_HOSTS

ADD_KEYS_TO_AGENT

BATCH_MODE

CANONICAL_DOMAINS

CERTIFICATE_FILE

CIPHERS

COMPRESSION

CONNECTION_ATTEMPTS

CONNECT_TIMEOUT

CONTROL_PATH

GLOBAL_KNOWN_HOSTS_FILE

HASH_KNOWN_HOSTS

HOST

HOST_KEY_ALGORITHMS

HOST_NAME

IDENTITIES_ONLY

IDENTITY_AGENT

IDENTITY_FILE

KEX_ALGORITHMS

LOCAL_COMMAND

LOCAL_FORWARD

MACS

NUMBER_OF_PASSWORD_PROMPTS

PORT

PREFERRED_AUTHENTICATIONS

PUBKEY_ACCEPTED_ALGORITHMS

PROXY_COMMAND

PROXY_JUMP

REMOTE_COMMAND

REMOTE_FORWARD

SECURITY_KEY_PROVIDER

SEND_ENV

STRICT_HOST_KEY_CHECKING

USER

USER_KNOWN_HOSTS_FILE

YES

ON

TRUE

NO

OFF

FALSE

NONE

ID_RSA

ID_DSA

ID_ECDSA

ID_ED25519

DEFAULT_IDENTITIES

ENV_SSH_AUTH_SOCKET