Class SshConstants


  • public final class SshConstants
    extends java.lang.Object
    This interface defines constants for the SSH protocol.
    • Field Detail

      • TO_EFFECTIVE_PORT

        public static final java.util.function.IntUnaryOperator TO_EFFECTIVE_PORT
        Converts non-positive port value to 22
      • SSH_MSG_SERVICE_REQUEST

        public static final byte SSH_MSG_SERVICE_REQUEST
        See Also:
        Constant Field Values
      • SSH_MSG_SERVICE_ACCEPT

        public static final byte SSH_MSG_SERVICE_ACCEPT
        See Also:
        Constant Field Values
      • SSH_MSG_KEX_DH_GEX_REQUEST_OLD

        public static final byte SSH_MSG_KEX_DH_GEX_REQUEST_OLD
        See Also:
        Constant Field Values
      • SSH_MSG_KEX_DH_GEX_GROUP

        public static final byte SSH_MSG_KEX_DH_GEX_GROUP
        See Also:
        Constant Field Values
      • SSH_MSG_KEX_DH_GEX_INIT

        public static final byte SSH_MSG_KEX_DH_GEX_INIT
        See Also:
        Constant Field Values
      • SSH_MSG_KEX_DH_GEX_REPLY

        public static final byte SSH_MSG_KEX_DH_GEX_REPLY
        See Also:
        Constant Field Values
      • SSH_MSG_KEX_DH_GEX_REQUEST

        public static final byte SSH_MSG_KEX_DH_GEX_REQUEST
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_REQUEST

        public static final byte SSH_MSG_USERAUTH_REQUEST
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_FAILURE

        public static final byte SSH_MSG_USERAUTH_FAILURE
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_SUCCESS

        public static final byte SSH_MSG_USERAUTH_SUCCESS
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_BANNER

        public static final byte SSH_MSG_USERAUTH_BANNER
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_INFO_REQUEST

        public static final byte SSH_MSG_USERAUTH_INFO_REQUEST
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_INFO_RESPONSE

        public static final byte SSH_MSG_USERAUTH_INFO_RESPONSE
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_PK_OK

        public static final byte SSH_MSG_USERAUTH_PK_OK
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_PASSWD_CHANGEREQ

        public static final byte SSH_MSG_USERAUTH_PASSWD_CHANGEREQ
        See Also:
        Constant Field Values
      • SSH_MSG_USERAUTH_GSSAPI_MIC

        public static final byte SSH_MSG_USERAUTH_GSSAPI_MIC
        See Also:
        Constant Field Values
      • SSH_MSG_GLOBAL_REQUEST

        public static final byte SSH_MSG_GLOBAL_REQUEST
        See Also:
        Constant Field Values
      • SSH_MSG_REQUEST_SUCCESS

        public static final byte SSH_MSG_REQUEST_SUCCESS
        See Also:
        Constant Field Values
      • SSH_MSG_REQUEST_FAILURE

        public static final byte SSH_MSG_REQUEST_FAILURE
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_OPEN_CONFIRMATION

        public static final byte SSH_MSG_CHANNEL_OPEN_CONFIRMATION
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_OPEN_FAILURE

        public static final byte SSH_MSG_CHANNEL_OPEN_FAILURE
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_WINDOW_ADJUST

        public static final byte SSH_MSG_CHANNEL_WINDOW_ADJUST
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_EXTENDED_DATA

        public static final byte SSH_MSG_CHANNEL_EXTENDED_DATA
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_REQUEST

        public static final byte SSH_MSG_CHANNEL_REQUEST
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_SUCCESS

        public static final byte SSH_MSG_CHANNEL_SUCCESS
        See Also:
        Constant Field Values
      • SSH_MSG_CHANNEL_FAILURE

        public static final byte SSH_MSG_CHANNEL_FAILURE
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT

        public static final int SSH2_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_PROTOCOL_ERROR

        public static final int SSH2_DISCONNECT_PROTOCOL_ERROR
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_KEY_EXCHANGE_FAILED

        public static final int SSH2_DISCONNECT_KEY_EXCHANGE_FAILED
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_HOST_AUTHENTICATION_FAILED

        public static final int SSH2_DISCONNECT_HOST_AUTHENTICATION_FAILED
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_RESERVED

        public static final int SSH2_DISCONNECT_RESERVED
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_MAC_ERROR

        public static final int SSH2_DISCONNECT_MAC_ERROR
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_COMPRESSION_ERROR

        public static final int SSH2_DISCONNECT_COMPRESSION_ERROR
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_SERVICE_NOT_AVAILABLE

        public static final int SSH2_DISCONNECT_SERVICE_NOT_AVAILABLE
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED

        public static final int SSH2_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_HOST_KEY_NOT_VERIFIABLE

        public static final int SSH2_DISCONNECT_HOST_KEY_NOT_VERIFIABLE
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_CONNECTION_LOST

        public static final int SSH2_DISCONNECT_CONNECTION_LOST
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_BY_APPLICATION

        public static final int SSH2_DISCONNECT_BY_APPLICATION
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_TOO_MANY_CONNECTIONS

        public static final int SSH2_DISCONNECT_TOO_MANY_CONNECTIONS
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_AUTH_CANCELLED_BY_USER

        public static final int SSH2_DISCONNECT_AUTH_CANCELLED_BY_USER
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE

        public static final int SSH2_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE
        See Also:
        Constant Field Values
      • SSH2_DISCONNECT_ILLEGAL_USER_NAME

        public static final int SSH2_DISCONNECT_ILLEGAL_USER_NAME
        See Also:
        Constant Field Values
      • SSH_OPEN_ADMINISTRATIVELY_PROHIBITED

        public static final int SSH_OPEN_ADMINISTRATIVELY_PROHIBITED
        See Also:
        Constant Field Values
      • SSH_OPEN_CONNECT_FAILED

        public static final int SSH_OPEN_CONNECT_FAILED
        See Also:
        Constant Field Values
      • SSH_OPEN_UNKNOWN_CHANNEL_TYPE

        public static final int SSH_OPEN_UNKNOWN_CHANNEL_TYPE
        See Also:
        Constant Field Values
      • SSH_OPEN_RESOURCE_SHORTAGE

        public static final int SSH_OPEN_RESOURCE_SHORTAGE
        See Also:
        Constant Field Values
      • SSH_EXTENDED_DATA_STDERR

        public static final int SSH_EXTENDED_DATA_STDERR
        See Also:
        Constant Field Values
      • SSH_REQUIRED_PAYLOAD_PACKET_LENGTH_SUPPORT

        public static final int SSH_REQUIRED_PAYLOAD_PACKET_LENGTH_SUPPORT
        See Also:
        Constant Field Values
      • SSH_REQUIRED_TOTAL_PACKET_LENGTH_SUPPORT

        public static final int SSH_REQUIRED_TOTAL_PACKET_LENGTH_SUPPORT
        See Also:
        Constant Field Values
    • Constructor Detail

      • SshConstants

        private SshConstants()
    • Method Detail

      • isAmbiguousOpcode

        public static boolean isAmbiguousOpcode​(int cmd)
        Parameters:
        cmd - The command value
        Returns:
        true if this value is used by several different messages
        See Also:
        getAmbiguousOpcodes()
      • getAmbiguousOpcodes

        public static java.util.Set<java.lang.Integer> getAmbiguousOpcodes()
        Returns:
        A Set of opcodes that are used by several different messages
      • getCommandMessageName

        public static java.lang.String getCommandMessageName​(int cmd)
        Converts a command value to a user-friendly name
        Parameters:
        cmd - The command value
        Returns:
        The user-friendly name - if not one of the defined SSH_MSG_XXX values then returns the string representation of the command's value
      • getDisconnectReasonName

        public static java.lang.String getDisconnectReasonName​(int reason)
        Converts a disconnect reason value to a user-friendly name
        Parameters:
        reason - The disconnect reason value
        Returns:
        The user-friendly name - if not one of the defined SSH2_DISCONNECT_ values then returns the string representation of the reason's value
      • getOpenErrorCodeName

        public static java.lang.String getOpenErrorCodeName​(int code)
        Converts an open error value to a user-friendly name
        Parameters:
        code - The open error value
        Returns:
        The user-friendly name - if not one of the defined SSH_OPEN_ values then returns the string representation of the reason's value