Package org.eclipse.jgit.transport

Class SshConstants

  • public final class SshConstants
extends java.lang.Object
    Constants relating to ssh.
    Since:
    5.2

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SshConstants()  

    • 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 java.lang.String SSH_SCHEME
        URI scheme for ssh.
        See Also:
        Constant Field Values

      • SFTP_SCHEME

        public static final java.lang.String SFTP_SCHEME
        URI scheme for sftp.
        See Also:
        Constant Field Values

      • SSH_DIR

        public static final java.lang.String SSH_DIR
        Default name for a ssh directory.
        See Also:
        Constant Field Values

      • CONFIG

        public static final java.lang.String CONFIG
        Name of the ssh config file.
        See Also:
        Constant Field Values

      • KNOWN_HOSTS

        public static final java.lang.String KNOWN_HOSTS
        Default name of the user "known hosts" file.
        See Also:
        Constant Field Values

      • ADD_KEYS_TO_AGENT

        public static final java.lang.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 java.lang.String BATCH_MODE
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • CANONICAL_DOMAINS

        public static final java.lang.String CANONICAL_DOMAINS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • CERTIFICATE_FILE

        public static final java.lang.String CERTIFICATE_FILE
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • CIPHERS

        public static final java.lang.String CIPHERS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • COMPRESSION

        public static final java.lang.String COMPRESSION
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • CONNECTION_ATTEMPTS

        public static final java.lang.String CONNECTION_ATTEMPTS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • CONNECT_TIMEOUT

        public static final java.lang.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 java.lang.String CONTROL_PATH
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • GLOBAL_KNOWN_HOSTS_FILE

        public static final java.lang.String GLOBAL_KNOWN_HOSTS_FILE
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • HASH_KNOWN_HOSTS

        public static final java.lang.String HASH_KNOWN_HOSTS
        Key in an ssh config file.
        Since:
        5.5
        See Also:
        Constant Field Values

      • HOST

        public static final java.lang.String HOST
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • HOST_KEY_ALGORITHMS

        public static final java.lang.String HOST_KEY_ALGORITHMS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • HOST_NAME

        public static final java.lang.String HOST_NAME
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • IDENTITIES_ONLY

        public static final java.lang.String IDENTITIES_ONLY
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • IDENTITY_AGENT

        public static final java.lang.String IDENTITY_AGENT
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • IDENTITY_FILE

        public static final java.lang.String IDENTITY_FILE
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • KEX_ALGORITHMS

        public static final java.lang.String KEX_ALGORITHMS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • LOCAL_COMMAND

        public static final java.lang.String LOCAL_COMMAND
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • LOCAL_FORWARD

        public static final java.lang.String LOCAL_FORWARD
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • MACS

        public static final java.lang.String MACS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • NUMBER_OF_PASSWORD_PROMPTS

        public static final java.lang.String NUMBER_OF_PASSWORD_PROMPTS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • PORT

        public static final java.lang.String PORT
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • PREFERRED_AUTHENTICATIONS

        public static final java.lang.String PREFERRED_AUTHENTICATIONS
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • PUBKEY_ACCEPTED_ALGORITHMS

        public static final java.lang.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 java.lang.String PROXY_COMMAND
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • PROXY_JUMP

        public static final java.lang.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 java.lang.String REMOTE_COMMAND
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • REMOTE_FORWARD

        public static final java.lang.String REMOTE_FORWARD
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • SECURITY_KEY_PROVIDER

        public static final java.lang.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 java.lang.String SEND_ENV
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • STRICT_HOST_KEY_CHECKING

        public static final java.lang.String STRICT_HOST_KEY_CHECKING
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • USER

        public static final java.lang.String USER
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • USER_KNOWN_HOSTS_FILE

        public static final java.lang.String USER_KNOWN_HOSTS_FILE
        Key in an ssh config file.
        See Also:
        Constant Field Values

      • NONE

        public static final java.lang.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 java.lang.String ID_RSA
        Name of the default RSA private identity file.
        See Also:
        Constant Field Values

      • ID_DSA

        public static final java.lang.String ID_DSA
        Name of the default DSA private identity file.
        See Also:
        Constant Field Values

      • ID_ECDSA

        public static final java.lang.String ID_ECDSA
        Name of the default ECDSA private identity file.
        See Also:
        Constant Field Values

      • ID_ED25519

        public static final java.lang.String ID_ED25519
        Name of the default ED25519 private identity file.
        See Also:
        Constant Field Values

      • DEFAULT_IDENTITIES

        public static final java.lang.String[] DEFAULT_IDENTITIES
        All known default identity file names.

      • ENV_SSH_AUTH_SOCKET

        public static final java.lang.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

    • Constructor Detail

      • SshConstants

        private SshConstants()