Uses of Enum
com.ongres.scram.common.ScramMechanism

Packages that use ScramMechanism

Package	Description
com.ongres.scram.client	This module expose the client implementation of Salted Challenge Response Authentication Mechanism (SCRAM).
com.ongres.scram.common	This package expose the messages used to implement a client/server of Salted Challenge Response Authentication Mechanism (SCRAM).

Uses of ScramMechanism in com.ongres.scram.client

Fields in com.ongres.scram.client declared as ScramMechanism

Modifier and Type	Field	Description
private final ScramMechanism	ClientFinalProcessor.scramMechanism
private final ScramMechanism	ScramClient.scramMechanism
private final ScramMechanism	ServerFirstProcessor.scramMechanism
(package private) ScramMechanism	ScramClient.Builder.selectedScramMechanism

Methods in com.ongres.scram.client that return ScramMechanism

Modifier and Type	Method	Description
ScramMechanism	ScramClient.getScramMechanism()	Returns the scram mechanism negotiated by this SASL client.
private ScramMechanism	ScramClient.Builder.mechanismNegotiation()
private static @Nullable ScramMechanism	ScramClient.Builder.selectMechanism(@NotNull Collection<@NotNull String> scramMechanisms, boolean channelBinding)	This method classifies SCRAM mechanisms by two properties: whether they support channel binding; and a priority, which is higher for safer algorithms (like SHA-256 vs SHA-1).

Constructors in com.ongres.scram.client with parameters of type ScramMechanism

Modifier	Constructor	Description
private	ClientFinalProcessor(ScramMechanism scramMechanism, byte[] clientKey, byte[] storedKey, byte[] serverKey, ClientFirstMessage clientFirstMessage, ServerFirstMessage serverFirstMessage)
(package private)	ClientFinalProcessor(ScramMechanism scramMechanism, byte[] clientKey, byte[] serverKey, ClientFirstMessage clientFirstMessage, ServerFirstMessage serverFirstMessage)
(package private)	ClientFinalProcessor(ScramMechanism scramMechanism, byte[] saltedPassword, ClientFirstMessage clientFirstMessage, ServerFirstMessage serverFirstMessage)
(package private)	ClientFinalProcessor(ScramMechanism scramMechanism, StringPreparation stringPreparation, char[] password, byte[] salt, ClientFirstMessage clientFirstMessage, ServerFirstMessage serverFirstMessage)
(package private)	ServerFirstProcessor(ScramMechanism scramMechanism, StringPreparation stringPreparation, @NotNull String receivedServerFirstMessage, @NotNull String nonce, @NotNull ClientFirstMessage clientFirstMessage)

Uses of ScramMechanism in com.ongres.scram.common

Subclasses with type arguments of type ScramMechanism in com.ongres.scram.common

Modifier and Type	Class	Description
enum	ScramMechanism	SCRAM Mechanisms supported by this library.

Fields in com.ongres.scram.common with type parameters of type ScramMechanism

Modifier and Type	Field	Description
private static final @Unmodifiable Map<String, ScramMechanism>	ScramMechanism.BY_NAME_MAPPING

Methods in com.ongres.scram.common that return ScramMechanism

Modifier and Type	Method	Description
static @Nullable ScramMechanism	ScramMechanism.byName(@NotNull String name)	Gets a SCRAM mechanism given its standard IANA name, supported by the Java security provider.
static ScramMechanism	ScramMechanism.valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScramMechanism[]	ScramMechanism.values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods in com.ongres.scram.common with parameters of type ScramMechanism

Modifier and Type	Method	Description
static byte[]	ScramFunctions.clientKey(@NotNull ScramMechanism scramMechanism, byte @NotNull [] saltedPassword)	Generates a client key, from the salted password.
static byte @NotNull []	ScramFunctions.clientSignature(@NotNull ScramMechanism scramMechanism, byte @NotNull [] storedKey, @NotNull String authMessage)	Computes the SCRAM client signature.
static byte[]	ScramFunctions.hash(@NotNull ScramMechanism scramMechanism, byte @NotNull [] message)	Computes the hash function of a given value, based on the SCRAM mechanism hash function.
static byte @NotNull []	ScramFunctions.hmac(@NotNull ScramMechanism scramMechanism, byte @NotNull [] key, byte @NotNull [] message)	Computes the HMAC of the message and key, using the given SCRAM mechanism.
private static boolean	ScramMechanism.isAlgorithmSupported(@NotNull ScramMechanism mechanism)
static byte @NotNull []	ScramFunctions.saltedPassword(@NotNull ScramMechanism scramMechanism, @NotNull StringPreparation stringPreparation, char @NotNull [] password, byte @NotNull [] salt, int iterationCount)	Compute the salted password, based on the given SCRAM mechanism, the String preparation algorithm, the provided salt and the number of iterations.
static byte[]	ScramFunctions.serverKey(@NotNull ScramMechanism scramMechanism, byte @NotNull [] saltedPassword)	Generates a server key, from the salted password.
static byte @NotNull []	ScramFunctions.serverSignature(@NotNull ScramMechanism scramMechanism, byte @NotNull [] serverKey, @NotNull String authMessage)	Compute the SCRAM server signature.
static byte[]	ScramFunctions.storedKey(@NotNull ScramMechanism scramMechanism, byte @NotNull [] clientKey)	Generates a stored key, from the salted password.
static boolean	ScramFunctions.verifyClientProof(@NotNull ScramMechanism scramMechanism, byte @NotNull [] clientProof, byte @NotNull [] storedKey, @NotNull String authMessage)	Verifies that a provided client proof is correct.
static boolean	ScramFunctions.verifyServerSignature(ScramMechanism scramMechanism, byte[] serverKey, String authMessage, byte[] serverSignature)	Verifies that a provided server proof is correct.