com.ongres.scram.common

Enum ScramMechanism

java.lang.Object

java.lang.Enum<ScramMechanism>

com.ongres.scram.common.ScramMechanism

All Implemented Interfaces:

Serializable, Comparable<ScramMechanism>

public enum ScramMechanism
extends Enum<ScramMechanism>

SCRAM Mechanisms supported by this library. At least, SCRAM-SHA-1 and SCRAM-SHA-256 are provided, since both the hash and the HMAC implementations are provided by the Java JDK version 8 or greater.

MessageDigest: "Every implementation of the Java platform is required to support the following standard MessageDigest algorithms: SHA-1, SHA-256".

Mac: "Every implementation of the Java platform is required to support the following standard Mac algorithms: HmacSHA1, HmacSHA256".

See Also:

SASL SCRAM Family Mechanisms

Enum Constant Summary

Enum Constants

Enum Constant and Description
SCRAM_SHA_1 SCRAM-SHA-1 mechanism, defined in RFC-5802.
SCRAM_SHA_1_PLUS SCRAM-SHA-1-PLUS mechanism, defined in RFC-5802.
SCRAM_SHA_224 SCRAM-SHA-224 mechanism, not defined in an RFC.
SCRAM_SHA_224_PLUS SCRAM-SHA-224-PLUS mechanism, not defined in an RFC.
SCRAM_SHA_256 SCRAM-SHA-256 mechanism, defined in RFC-7677.
SCRAM_SHA_256_PLUS SCRAM-SHA-256-PLUS mechanism, defined in RFC-7677.
SCRAM_SHA_384 SCRAM-SHA-384 mechanism, not defined in an RFC.
SCRAM_SHA_384_PLUS SCRAM-SHA-384-PLUS mechanism, not defined in an RFC.
SCRAM_SHA_512 SCRAM-SHA-512 mechanism.
SCRAM_SHA_512_PLUS SCRAM-SHA-512-PLUS mechanism.

Method Summary

Modifier and Type	Method and Description
static @Nullable ScramMechanism	byName(@NotNull String name) Gets a SCRAM mechanism given its standard IANA name, supported by the Java security provider.
@NotNull String	getName() The name of the mechanism.
boolean	isPlus() The mechanism -PLUS require channel binding.
static @Unmodifiable @NotNull List<String>	supportedMechanisms() List all the supported SCRAM mechanisms by this client implementation.
static ScramMechanism	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScramMechanism[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCRAM_SHA_1

public static final ScramMechanism SCRAM_SHA_1

SCRAM-SHA-1 mechanism, defined in RFC-5802.

SCRAM_SHA_1_PLUS

public static final ScramMechanism SCRAM_SHA_1_PLUS

SCRAM-SHA-1-PLUS mechanism, defined in RFC-5802.

SCRAM_SHA_224

public static final ScramMechanism SCRAM_SHA_224

SCRAM-SHA-224 mechanism, not defined in an RFC.

SCRAM_SHA_224_PLUS

public static final ScramMechanism SCRAM_SHA_224_PLUS

SCRAM-SHA-224-PLUS mechanism, not defined in an RFC.

SCRAM_SHA_256

public static final ScramMechanism SCRAM_SHA_256

SCRAM-SHA-256 mechanism, defined in RFC-7677.

SCRAM_SHA_256_PLUS

public static final ScramMechanism SCRAM_SHA_256_PLUS

SCRAM-SHA-256-PLUS mechanism, defined in RFC-7677.

SCRAM_SHA_384

public static final ScramMechanism SCRAM_SHA_384

SCRAM-SHA-384 mechanism, not defined in an RFC.

SCRAM_SHA_384_PLUS

public static final ScramMechanism SCRAM_SHA_384_PLUS

SCRAM-SHA-384-PLUS mechanism, not defined in an RFC.

SCRAM_SHA_512

public static final ScramMechanism SCRAM_SHA_512

SCRAM-SHA-512 mechanism.

SCRAM_SHA_512_PLUS

public static final ScramMechanism SCRAM_SHA_512_PLUS

SCRAM-SHA-512-PLUS mechanism.

Method Detail

values

public static ScramMechanism[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScramMechanism c : ScramMechanism.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScramMechanism valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

@NotNull
public @NotNull String getName()

The name of the mechanism.

Must be a value registered under IANA: SASL SCRAM Family Mechanisms

Returns:

The mechanism name

isPlus

public boolean isPlus()

The mechanism -PLUS require channel binding.

Returns:

true if the mechanism requires channel binding

byName

@Nullable
public static @Nullable ScramMechanism byName(@NotNull
                                                        @NotNull String name)

Gets a SCRAM mechanism given its standard IANA name, supported by the Java security provider.

Parameters:

name - The standard IANA full name of the mechanism.

Returns:

An instance that contains the ScramMechanism if it was found, or null otherwise.

supportedMechanisms

@NotNull
public static @Unmodifiable @NotNull List<String> supportedMechanisms()

List all the supported SCRAM mechanisms by this client implementation.

Returns:

A unmodifiable list of the IANA-registered, SCRAM supported mechanisms