Top Description Fields Constructors Methods
org.eclipse.jgit.transport

public final Class SshConstants

extends Object
Class Inheritance
Annotations
@SuppressWarnings:nls
Imports
org.eclipse.jgit.lib.Constants

Constants relating to ssh.
Since
5.2

Field Summary

Modifier and TypeField and Description
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.

public static final String
BATCH_MODE

Key in an ssh config file.

public static final String
CANONICAL_DOMAINS

Key in an ssh config file.

public static final String
CERTIFICATE_FILE

Key in an ssh config file.

public static final String
CIPHERS

Key in an ssh config file.

public static final String
COMPRESSION

Key in an ssh config file.

public static final String
CONFIG

Name of the ssh config file.

public static final String
CONNECT_TIMEOUT

An OpenSSH time value for the connection timeout.

public static final String
CONNECTION_ATTEMPTS

Key in an ssh config file.

public static final String
CONTROL_PATH

Key in an ssh config file.

public static final String[]
DEFAULT_IDENTITIES

All known default identity file names.

public static final String
ENV_SSH_AUTH_SOCKET

Name of the environment variable holding the Unix domain socket for communication with an SSH agent.

public static final String
FALSE

Flag value.

public static final String
GLOBAL_KNOWN_HOSTS_FILE

Key in an ssh config file.

public static final String
HASH_KNOWN_HOSTS

Key in an ssh config file.

public static final String
HOST

Key in an ssh config file.

public static final String
HOST_KEY_ALGORITHMS

Key in an ssh config file.

public static final String
HOST_NAME

Key in an ssh config file.

public static final String
ID_DSA

Name of the default DSA private identity file.

public static final String
ID_ECDSA

Name of the default ECDSA private identity file.

public static final String
ID_ED25519

Name of the default ED25519 private identity file.

public static final String
ID_RSA

Name of the default RSA private identity file.

public static final String
IDENTITIES_ONLY

Key in an ssh config file.

public static final String
IDENTITY_AGENT

Key in an ssh config file.

public static final String
IDENTITY_FILE

Key in an ssh config file.

public static final String
KEX_ALGORITHMS

Key in an ssh config file.

public static final String
KNOWN_HOSTS

Default name of the user "known hosts" file.

public static final String
LOCAL_COMMAND

Key in an ssh config file.

public static final String
LOCAL_FORWARD

Key in an ssh config file.

public static final String
MACS

Key in an ssh config file.

public static final String
NO

Flag value.

public static final String
NONE

Property value.

public static final String
NUMBER_OF_PASSWORD_PROMPTS

Key in an ssh config file.

public static final String
OFF

Flag value.

public static final String
ON

Flag value.

public static final String
PKCS11_PROVIDER

Path to a shared library of a PKCS11 key provider, or "none".

public static final String
PKCS11_SLOT_LIST_INDEX

Non-standard JGit addition: specify the PKCS#11 slot list index of the token to use.

public static final String
PORT

Key in an ssh config file.

public static final String
PREFERRED_AUTHENTICATIONS

Key in an ssh config file.

public static final String
PROXY_COMMAND

Key in an ssh config file.

public static final String
PROXY_JUMP

Comma-separated list of jump hosts, defining a jump host chain in reverse order.

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.

public static final String
REMOTE_COMMAND

Key in an ssh config file.

public static final String
REMOTE_FORWARD

Key in an ssh config file.

public static final String
SECURITY_KEY_PROVIDER

(Absolute) path to a middleware library the SSH agent shall use to load SK (U2F) keys.

public static final String
SEND_ENV

Key in an ssh config file.

public static final String
SFTP_SCHEME

URI scheme for sftp.

public static final int
SSH_DEFAULT_PORT

IANA assigned port number for ssh.

public static final String
SSH_DIR

Default name for a ssh directory.

public static final String
SSH_SCHEME

URI scheme for ssh.

public static final String
STRICT_HOST_KEY_CHECKING

Key in an ssh config file.

public static final String
TRUE

Flag value.

public static final String
USER

Key in an ssh config file.

public static final String
USER_KNOWN_HOSTS_FILE

Key in an ssh config file.

public static final String
YES

Flag value.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ADD_KEYS_TO_AGENTback to summary
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
BATCH_MODEback to summary
public static final String BATCH_MODE

Key in an ssh config file.

CANONICAL_DOMAINSback to summary
public static final String CANONICAL_DOMAINS

Key in an ssh config file.

CERTIFICATE_FILEback to summary
public static final String CERTIFICATE_FILE

Key in an ssh config file.

CIPHERSback to summary
public static final String CIPHERS

Key in an ssh config file.

COMPRESSIONback to summary
public static final String COMPRESSION

Key in an ssh config file.

CONFIGback to summary
public static final String CONFIG

Name of the ssh config file.

CONNECT_TIMEOUTback to summary
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
CONNECTION_ATTEMPTSback to summary
public static final String CONNECTION_ATTEMPTS

Key in an ssh config file.

CONTROL_PATHback to summary
public static final String CONTROL_PATH

Key in an ssh config file.

DEFAULT_IDENTITIESback to summary
public static final String[] DEFAULT_IDENTITIES

All known default identity file names.

ENV_SSH_AUTH_SOCKETback to summary
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
FALSEback to summary
public static final String FALSE

Flag value.

GLOBAL_KNOWN_HOSTS_FILEback to summary
public static final String GLOBAL_KNOWN_HOSTS_FILE

Key in an ssh config file.

HASH_KNOWN_HOSTSback to summary
public static final String HASH_KNOWN_HOSTS

Key in an ssh config file.

Since
5.5
HOSTback to summary
public static final String HOST

Key in an ssh config file.

HOST_KEY_ALGORITHMSback to summary
public static final String HOST_KEY_ALGORITHMS

Key in an ssh config file.

HOST_NAMEback to summary
public static final String HOST_NAME

Key in an ssh config file.

ID_DSAback to summary
public static final String ID_DSA

Name of the default DSA private identity file.

ID_ECDSAback to summary
public static final String ID_ECDSA

Name of the default ECDSA private identity file.

ID_ED25519back to summary
public static final String ID_ED25519

Name of the default ED25519 private identity file.

ID_RSAback to summary
public static final String ID_RSA

Name of the default RSA private identity file.

IDENTITIES_ONLYback to summary
public static final String IDENTITIES_ONLY

Key in an ssh config file.

IDENTITY_AGENTback to summary
public static final String IDENTITY_AGENT

Key in an ssh config file.

IDENTITY_FILEback to summary
public static final String IDENTITY_FILE

Key in an ssh config file.

KEX_ALGORITHMSback to summary
public static final String KEX_ALGORITHMS

Key in an ssh config file.

KNOWN_HOSTSback to summary
public static final String KNOWN_HOSTS

Default name of the user "known hosts" file.

LOCAL_COMMANDback to summary
public static final String LOCAL_COMMAND

Key in an ssh config file.

LOCAL_FORWARDback to summary
public static final String LOCAL_FORWARD

Key in an ssh config file.

MACSback to summary
public static final String MACS

Key in an ssh config file.

NOback to summary
public static final String NO

Flag value.

NONEback to summary
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
NUMBER_OF_PASSWORD_PROMPTSback to summary
public static final String NUMBER_OF_PASSWORD_PROMPTS

Key in an ssh config file.

OFFback to summary
public static final String OFF

Flag value.

ONback to summary
public static final String ON

Flag value.

PKCS11_PROVIDERback to summary
public static final String PKCS11_PROVIDER

Path to a shared library of a PKCS11 key provider, or "none".

If set and not "none", the provider's keys should be used.

Since
6.7
PKCS11_SLOT_LIST_INDEXback to summary
public static final String PKCS11_SLOT_LIST_INDEX

Non-standard JGit addition: specify the PKCS#11 slot list index of the token to use. A positive number; defaults to zero; ignored if negative (in which case zero is used, too).

Since
6.7
PORTback to summary
public static final String PORT

Key in an ssh config file.

PREFERRED_AUTHENTICATIONSback to summary
public static final String PREFERRED_AUTHENTICATIONS

Key in an ssh config file.

PROXY_COMMANDback to summary
public static final String PROXY_COMMAND

Key in an ssh config file.

PROXY_JUMPback to summary
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
PUBKEY_ACCEPTED_ALGORITHMSback to summary
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
REMOTE_COMMANDback to summary
public static final String REMOTE_COMMAND

Key in an ssh config file.

REMOTE_FORWARDback to summary
public static final String REMOTE_FORWARD

Key in an ssh config file.

SECURITY_KEY_PROVIDERback to summary
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
SEND_ENVback to summary
public static final String SEND_ENV

Key in an ssh config file.

SFTP_SCHEMEback to summary
public static final String SFTP_SCHEME

URI scheme for sftp.

SSH_DEFAULT_PORTback to summary
public static final int SSH_DEFAULT_PORT

IANA assigned port number for ssh.

SSH_DIRback to summary
public static final String SSH_DIR

Default name for a ssh directory.

SSH_SCHEMEback to summary
public static final String SSH_SCHEME

URI scheme for ssh.

STRICT_HOST_KEY_CHECKINGback to summary
public static final String STRICT_HOST_KEY_CHECKING

Key in an ssh config file.

TRUEback to summary
public static final String TRUE

Flag value.

USERback to summary
public static final String USER

Key in an ssh config file.

USER_KNOWN_HOSTS_FILEback to summary
public static final String USER_KNOWN_HOSTS_FILE

Key in an ssh config file.

YESback to summary
public static final String YES

Flag value.

Constructor Detail

SshConstantsback to summary
private SshConstants()