com.ongres.scram.client

Class ScramSession.ClientFinalProcessor

java.lang.Object

com.ongres.scram.client.ScramSession.ClientFinalProcessor

Enclosing class:

ScramSession

public class ScramSession.ClientFinalProcessor
extends java.lang.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 ScramSession.ServerFirstProcessor.clientFinalProcessor(String) or ScramSession.ServerFirstProcessor.clientFinalProcessor(byte[], byte[]).

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	authMessage
private byte[]	clientKey
private java.lang.String	nonce
private byte[]	serverKey
private byte[]	storedKey

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ClientFinalProcessor(java.lang.String nonce, byte[] saltedPassword)
private	ClientFinalProcessor(java.lang.String nonce, byte[] clientKey, byte[] serverKey)
private	ClientFinalProcessor(java.lang.String nonce, byte[] clientKey, byte[] storedKey, byte[] serverKey)
private	ClientFinalProcessor(java.lang.String nonce, java.lang.String password, java.lang.String salt, int iteration)

Method Summary

Modifier and Type	Method and Description
java.lang.String	clientFinalMessage() Generates the SCRAM representation of the client-final-message.
java.lang.String	clientFinalMessage(byte[] cbindData) Generates the SCRAM representation of the client-final-message, including the given channel-binding data.
private java.lang.String	clientFinalMessage(java.util.Optional<byte[]> cbindData)
private void	generateAndCacheAuthMessage(java.util.Optional<byte[]> cbindData)
void	receiveServerFinalMessage(java.lang.String serverFinalMessage) Receive and process the server-final-message.

Methods inherited from class java.lang.Object

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

Field Detail

nonce

private final java.lang.String nonce

clientKey

private final byte[] clientKey

storedKey

private final byte[] storedKey

serverKey

private final byte[] serverKey

authMessage

private java.lang.String authMessage

Constructor Detail

ClientFinalProcessor

private ClientFinalProcessor(java.lang.String nonce,
                             byte[] clientKey,
                             byte[] storedKey,
                             byte[] serverKey)

ClientFinalProcessor

private ClientFinalProcessor(java.lang.String nonce,
                             byte[] clientKey,
                             byte[] serverKey)

ClientFinalProcessor

private ClientFinalProcessor(java.lang.String nonce,
                             byte[] saltedPassword)

ClientFinalProcessor

private ClientFinalProcessor(java.lang.String nonce,
                             java.lang.String password,
                             java.lang.String salt,
                             int iteration)

Method Detail

generateAndCacheAuthMessage

private void generateAndCacheAuthMessage(java.util.Optional<byte[]> cbindData)

clientFinalMessage

private java.lang.String clientFinalMessage(java.util.Optional<byte[]> cbindData)

clientFinalMessage

public java.lang.String clientFinalMessage(byte[] cbindData)
                                    throws java.lang.IllegalArgumentException

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

Throws:

java.lang.IllegalArgumentException - If the channel binding data is null

clientFinalMessage

public java.lang.String clientFinalMessage()

Generates the SCRAM representation of the client-final-message.

Returns:

The message

receiveServerFinalMessage

public void receiveServerFinalMessage(java.lang.String serverFinalMessage)
                               throws ScramParseException,
                                      ScramServerErrorException,
                                      ScramInvalidServerSignatureException,
                                      java.lang.IllegalArgumentException

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

java.lang.IllegalArgumentException - If the message is null or empty

ScramInvalidServerSignatureException