Modifier and Type	Class and Description
public class	ScramSession.ClientFinalProcessor Processor that allows to generate the client-final-message, as well as process the server-final-message and verify server's signature.
public class	ScramSession.ServerFirstProcessor Process a received server-first-message.

Modifier and Type	Field and Description
private ClientFirstMessage	clientFirstMessage
private final String	nonce
private final ScramMechanism	scramMechanism
private String	serverFirstMessageString
private final StringPreparation	stringPreparation
private final String	user

Access	Constructor and Description
public	ScramSession(ScramMechanism The SCRAM mechanism that will be using this client scramMechanism, StringPreparation stringPreparation, String user, String nonce) Constructs a SCRAM client, to perform an authentication for a given user.

Method Summary

Modifier and Type	Method and Description
public String	Returns: The message clientFirstMessage(Gs2CbindFlag The channel binding flag gs2CbindFlag, String The channel binding algorithm name, if channel binding is supported, or null cbindName, String The optional authzid) Returns the text representation of a SCRAM client-first-message, with the GSS-API header values indicated.
public String	Returns: The message clientFirstMessage() Returns the text representation of a SCRAM client-first-message, with no channel binding nor authzid.
public ScramSession.ServerFirstProcessor	Returns: The handler receiveServerFirstMessage(String The message serverFirstMessage) Constructs a handler for the server-first-message, from its String representation.
private String	setAndReturnClientFirstMessage(ClientFirstMessage clientFirstMessage)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

clientFirstMessage	back to summary
private ClientFirstMessage clientFirstMessage

nonce	back to summary
private final String nonce

scramMechanism	back to summary
private final ScramMechanism scramMechanism

serverFirstMessageString	back to summary
private String serverFirstMessageString

stringPreparation	back to summary
private final StringPreparation stringPreparation

user	back to summary
private final String user

Constructor Detail

ScramSession back to summary

ScramSession	back to summary
public ScramSession(ScramMechanism scramMechanism, StringPreparation stringPreparation, String user, String nonce) Constructs a SCRAM client, to perform an authentication for a given user. This class can be instantiated directly, but it is recommended that a `ScramClient` is used instead. Parameters scramMechanism:ScramMechanism The SCRAM mechanism that will be using this client

public ScramSession(ScramMechanism scramMechanism, StringPreparation stringPreparation, String user, String nonce)

Constructs a SCRAM client, to perform an authentication for a given user. This class can be instantiated directly, but it is recommended that a ScramClient is used instead.

Parameters

scramMechanism:ScramMechanism: The SCRAM mechanism that will be using this client

Method Detail

clientFirstMessage	back to summary
public String clientFirstMessage(Gs2CbindFlag gs2CbindFlag, String cbindName, String authzid) Returns the text representation of a SCRAM client-first-message, with the GSS-API header values indicated. Parameters gs2CbindFlag:Gs2CbindFlag The channel binding flag cbindName:String The channel binding algorithm name, if channel binding is supported, or null authzid:String The optional Returns:String The message

clientFirstMessage

back to summary

public String clientFirstMessage(Gs2CbindFlag gs2CbindFlag, String cbindName, String authzid)

Returns the text representation of a SCRAM client-first-message, with the GSS-API header values indicated.

Parameters

gs2CbindFlag:Gs2CbindFlag: The channel binding flag
cbindName:String: The channel binding algorithm name, if channel binding is supported, or null
authzid:String: The optional

Returns:String

The message

clientFirstMessage	back to summary
public String clientFirstMessage() Returns the text representation of a SCRAM client-first-message, with no channel binding nor authzid. Returns:String The message

clientFirstMessage

back to summary

public String clientFirstMessage()

Returns the text representation of a SCRAM client-first-message, with no channel binding nor authzid.

Returns:String: The message

receiveServerFirstMessage	back to summary
public ScramSession.ServerFirstProcessor receiveServerFirstMessage(String serverFirstMessage) throws ScramParseException, IllegalArgumentException Constructs a handler for the server-first-message, from its String representation. Parameters serverFirstMessage:String The message Returns:ScramSession.ServerFirstProcessor The handler Exceptions ScramParseException: If the message is not a valid server-first-message IllegalArgumentException: If the message is null or empty

receiveServerFirstMessage

back to summary

public ScramSession.ServerFirstProcessor receiveServerFirstMessage(String serverFirstMessage) throws ScramParseException, IllegalArgumentException

Constructs a handler for the server-first-message, from its String representation.

Parameters

serverFirstMessage:String: The message

Returns:ScramSession.ServerFirstProcessor

The handler

Exceptions

ScramParseException:: If the message is not a valid server-first-message
IllegalArgumentException:: If the message is null or empty

setAndReturnClientFirstMessage	back to summary
private String setAndReturnClientFirstMessage(ClientFirstMessage clientFirstMessage)

com.ongres.scram.client back to summary

public Class ScramSession.ClientFinalProcessor

Class Inheritance

extends Object

java.lang.Object
com.ongres.scram.client.ScramSession.ClientFinalProcessor

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(String) or ServerFirstProcessor#clientFinalProcessor(byte[], byte[]).

Field Summary

Modifier and Type	Field and Description
private String	authMessage
private final byte[]	clientKey
private final String	nonce
private final byte[]	serverKey
private final byte[]	storedKey

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
private String	Returns: The message clientFinalMessage(byte[] The bytes of the channel-binding data cbindData) Generates the SCRAM representation of the client-final-message, including the given channel-binding data.
public String	Returns: The message clientFinalMessage() Generates the SCRAM representation of the client-final-message.
private synchronized void	generateAndCacheAuthMessage(byte[] cbindData)
public void	receiveServerFinalMessage(String The received server-final-message serverFinalMessage) Receive and process the server-final-message.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

authMessage	back to summary
private String authMessage

clientKey	back to summary
private final byte[] clientKey

nonce	back to summary
private final String nonce

serverKey	back to summary
private final byte[] serverKey

storedKey	back to summary
private final byte[] storedKey

Constructor Detail

ClientFinalProcessor	back to summary
private ClientFinalProcessor(String nonce, byte[] clientKey, byte[] storedKey, byte[] serverKey)

ClientFinalProcessor	back to summary
private ClientFinalProcessor(String nonce, byte[] clientKey, byte[] serverKey)

ClientFinalProcessor	back to summary
private ClientFinalProcessor(String nonce, byte[] saltedPassword)

ClientFinalProcessor	back to summary
private ClientFinalProcessor(String nonce, String password, String salt, int iteration)

Method Detail

clientFinalMessage	back to summary
private String clientFinalMessage(byte[] cbindData) throws IllegalArgumentException Generates the SCRAM representation of the client-final-message, including the given channel-binding data. Parameters cbindData:byte[] The bytes of the channel-binding data Returns:String The message Exceptions IllegalArgumentException: If the channel binding data is null

clientFinalMessage

back to summary

private String clientFinalMessage(byte[] cbindData) throws IllegalArgumentException

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

Parameters

cbindData:byte[]: The bytes of the channel-binding data

Returns:String

The message

Exceptions

IllegalArgumentException:: If the channel binding data is null

clientFinalMessage	back to summary
public String clientFinalMessage() Generates the SCRAM representation of the client-final-message. Returns:String The message

clientFinalMessage

back to summary

public String clientFinalMessage()

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

Returns:String: The message

generateAndCacheAuthMessage	back to summary
private synchronized void generateAndCacheAuthMessage(byte[] cbindData)

receiveServerFinalMessage	back to summary
public void receiveServerFinalMessage(String serverFinalMessage) throws ScramParseException, ScramServerErrorException, ScramInvalidServerSignatureException, IllegalArgumentException Receive and process the server-final-message. Server SCRAM signatures is verified. Parameters serverFinalMessage:String The received server-final-message Exceptions ScramParseException: If the message is not a valid server-final-message ScramServerErrorException: If the server-final-message contained an error IllegalArgumentException: If the message is null or empty

receiveServerFinalMessage

back to summary

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

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

Parameters

serverFinalMessage:String: The received server-final-message

Exceptions

ScramParseException:: If the message is not a valid server-final-message
ScramServerErrorException:: If the server-final-message contained an error
IllegalArgumentException:: If the message is null or empty

com.ongres.scram.client back to summary

public Class ScramSession.ServerFirstProcessor

Class Inheritance

extends Object

java.lang.Object
com.ongres.scram.client.ScramSession.ServerFirstProcessor

Process a received server-first-message. Generate by calling receiveServerFirstMessage(String).

Field Summary

Modifier and Type	Field and Description
private final ServerFirstMessage	serverFirstMessage

Constructor Summary

Access	Constructor and Description
private	ServerFirstProcessor(String receivedServerFirstMessage)

Method Summary

Modifier and Type	Method and Description
public ScramSession.ClientFinalProcessor	Returns: The handler clientFinalProcessor(String The user's password password) Generates a `ClientFinalProcessor`, that allows to generate the client-final-message and also receive and parse the server-first-message.
public ScramSession.ClientFinalProcessor	Returns: The handler clientFinalProcessor(byte[] The client key, as per the SCRAM algorithm. It can be generated with: `ScramFunctions#clientKey(ScramMechanism, StringPreparation, String, byte[], int)` clientKey, byte[] The stored key, as per the SCRAM algorithm. It can be generated from the client key with: `ScramFunctions#storedKey(ScramMechanism, byte[])` storedKey) Generates a `ClientFinalProcessor`, that allows to generate the client-final-message and also receive and parse the server-first-message.
public int	getIteration()
public String	getSalt()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

serverFirstMessage	back to summary
private final ServerFirstMessage serverFirstMessage

Constructor Detail

ServerFirstProcessor	back to summary
private ServerFirstProcessor(String receivedServerFirstMessage) throws ScramParseException

Method Detail

clientFinalProcessor back to summary

clientFinalProcessor	back to summary
public ScramSession.ClientFinalProcessor clientFinalProcessor(String password) throws IllegalArgumentException Generates a `ClientFinalProcessor`, that allows to generate the client-final-message and also receive and parse the server-first-message. It is based on the user's password. Parameters password:String The user's password Returns:ScramSession.ClientFinalProcessor The handler Exceptions IllegalArgumentException: If the message is null or empty

public ScramSession.ClientFinalProcessor clientFinalProcessor(String password) throws IllegalArgumentException

Generates a ClientFinalProcessor, that allows to generate the client-final-message and also receive and parse the server-first-message. It is based on the user's password.

Parameters

password:String: The user's password

Returns:ScramSession.ClientFinalProcessor

The handler

Exceptions

IllegalArgumentException:: If the message is null or empty

clientFinalProcessor back to summary

clientFinalProcessor	back to summary
public ScramSession.ClientFinalProcessor clientFinalProcessor(byte[] clientKey, byte[] storedKey) throws IllegalArgumentException Generates a `ClientFinalProcessor`, that allows to generate the client-final-message and also receive and parse the server-first-message. It is based on the clientKey and storedKey, which, if available, provide an optimized path versus providing the original user's password. Parameters clientKey:byte[] The client key, as per the SCRAM algorithm. It can be generated with: `ScramFunctions#clientKey(ScramMechanism, StringPreparation, String, byte[], int)` storedKey:byte[] The stored key, as per the SCRAM algorithm. It can be generated from the client key with: `ScramFunctions#storedKey(ScramMechanism, byte[])` Returns:ScramSession.ClientFinalProcessor The handler Exceptions IllegalArgumentException: If the message is null or empty

public ScramSession.ClientFinalProcessor clientFinalProcessor(byte[] clientKey, byte[] storedKey) throws IllegalArgumentException

Generates a ClientFinalProcessor, that allows to generate the client-final-message and also receive and parse the server-first-message. It is based on the clientKey and storedKey, which, if available, provide an optimized path versus providing the original user's password.

Parameters

clientKey:byte[]: The client key, as per the SCRAM algorithm. It can be generated with: ScramFunctions#clientKey(ScramMechanism, StringPreparation, String, byte[], int)
storedKey:byte[]: The stored key, as per the SCRAM algorithm. It can be generated from the client key with: ScramFunctions#storedKey(ScramMechanism, byte[])

Returns:ScramSession.ClientFinalProcessor

The handler

Exceptions

IllegalArgumentException:: If the message is null or empty

getIteration	back to summary
public int getIteration()

getSalt	back to summary
public String getSalt()

public Class ScramSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ScramSession.ClientFinalProcessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ScramSession.ServerFirstProcessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail