Class ClientFinalProcessor

java.lang.Object

com.ongres.scram.client.ClientFinalProcessor

final class ClientFinalProcessor
extends Object

Processor that allows to generate the client-final-message, as well as process the server-final-message and verify server's signature. Generate the processor by calling either ServerFirstProcessor#clientFinalProcessor(char[]) or ServerFirstProcessor#clientFinalProcessor(byte[], byte[]).

Field Summary

Fields

Modifier and Type	Field	Description
private String	authMessage
private final ClientFirstMessage	clientFirstMessage
private final byte[]	clientKey
private final ScramMechanism	scramMechanism
private final ServerFirstMessage	serverFirstMessage
private final byte[]	serverKey
private final byte[]	storedKey

Constructor Summary

Constructors

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)

Method Summary

Modifier and Type	Method	Description
(package private) @NotNull ClientFinalMessage	clientFinalMessage(byte @Nullable [] cbindData)	Generates the SCRAM representation of the client-final-message, including the given channel-binding data.
private void	generateAndCacheAuthMessage(byte[] cbindData)
(package private) @NotNull ServerFinalMessage	receiveServerFinalMessage(@NotNull String serverFinalMessage)	Receive and process the server-final-message.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

clientKey

private final byte[] clientKey

storedKey

private final byte[] storedKey

serverKey

private final byte[] serverKey

scramMechanism

private final ScramMechanism scramMechanism

clientFirstMessage

private final ClientFirstMessage clientFirstMessage

serverFirstMessage

private final ServerFirstMessage serverFirstMessage

authMessage

private String authMessage

Constructor Details

ClientFinalProcessor

private ClientFinalProcessor(ScramMechanism scramMechanism,
 byte[] clientKey,
 byte[] storedKey,
 byte[] serverKey,
 ClientFirstMessage clientFirstMessage,
 ServerFirstMessage serverFirstMessage)

ClientFinalProcessor

ClientFinalProcessor(ScramMechanism scramMechanism,
 byte[] clientKey,
 byte[] serverKey,
 ClientFirstMessage clientFirstMessage,
 ServerFirstMessage serverFirstMessage)

ClientFinalProcessor

ClientFinalProcessor(ScramMechanism scramMechanism,
 byte[] saltedPassword,
 ClientFirstMessage clientFirstMessage,
 ServerFirstMessage serverFirstMessage)

ClientFinalProcessor

ClientFinalProcessor(ScramMechanism scramMechanism,
 StringPreparation stringPreparation,
 char[] password,
 byte[] salt,
 ClientFirstMessage clientFirstMessage,
 ServerFirstMessage serverFirstMessage)

Method Details

generateAndCacheAuthMessage

private void generateAndCacheAuthMessage(byte[] cbindData)

clientFinalMessage

@NotNull
@NotNull ClientFinalMessage clientFinalMessage(byte @Nullable [] cbindData)

Generates the SCRAM representation of the client-final-message, including the given channel-binding data.

Parameters:

cbindData - The bytes of the channel-binding data

Returns:

The message

receiveServerFinalMessage

@NotNull
@NotNull ServerFinalMessage receiveServerFinalMessage(@NotNull
 @NotNull String serverFinalMessage)
                                               throws ScramParseException,
ScramServerErrorException,
ScramInvalidServerSignatureException

Receive and process the server-final-message. Server SCRAM signatures is verified.

Parameters:

serverFinalMessage - The received server-final-message

Throws:

ScramParseException - If the message is not a valid server-final-message

ScramServerErrorException - If the server-final-message contained an error

ScramInvalidServerSignatureException - If the server signature is invalid

IllegalArgumentException - If the message is null or empty