Package com.ongres.scram.client

Class ScramSession

java.lang.Object

com.ongres.scram.client.ScramSession

public class ScramSession
extends java.lang.Object

A class that represents a SCRAM client. Use this class to perform a SCRAM negotiation with a SCRAM server. This class performs an authentication execution for a given user, and has state related to it. Thus, it cannot be shared across users or authentication executions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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.
class	ScramSession.ServerFirstProcessor	Process a received server-first-message.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ScramSession(ScramMechanism scramMechanism, StringPreparation stringPreparation, java.lang.String user, java.lang.String nonce)	Constructs a SCRAM client, to perform an authentication for a given user.

Method Summary

Modifier and Type	Method	Description
java.lang.String	clientFirstMessage()	Returns the text representation of a SCRAM client-first-message, with no channel binding nor authzid.
java.lang.String	clientFirstMessage(Gs2CbindFlag gs2CbindFlag, java.lang.String cbindName, java.lang.String authzid)	Returns the text representation of a SCRAM client-first-message, with the GSS-API header values indicated.
ScramSession.ServerFirstProcessor	receiveServerFirstMessage(java.lang.String serverFirstMessage)	Constructs a handler for the server-first-message, from its String representation.
private java.lang.String	setAndReturnClientFirstMessage(ClientFirstMessage clientFirstMessage)

Methods inherited from class java.lang.Object

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

Field Detail

scramMechanism

private final ScramMechanism scramMechanism

stringPreparation

private final StringPreparation stringPreparation

user

private final java.lang.String user

nonce

private final java.lang.String nonce

clientFirstMessage

private ClientFirstMessage clientFirstMessage

serverFirstMessageString

private java.lang.String serverFirstMessageString

Constructor Detail

ScramSession

public ScramSession(ScramMechanism scramMechanism,
                    StringPreparation stringPreparation,
                    java.lang.String user,
                    java.lang.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 - The SCRAM mechanism that will be using this client

stringPreparation -

user -

nonce -

Method Detail

setAndReturnClientFirstMessage

private java.lang.String setAndReturnClientFirstMessage(ClientFirstMessage clientFirstMessage)

clientFirstMessage

public java.lang.String clientFirstMessage(Gs2CbindFlag gs2CbindFlag,
                                           java.lang.String cbindName,
                                           java.lang.String authzid)

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

Parameters:

gs2CbindFlag - The channel binding flag

cbindName - The channel binding algorithm name, if channel binding is supported, or null

authzid - The optional

Returns:

The message

clientFirstMessage

public java.lang.String clientFirstMessage()

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

Returns:

The message

receiveServerFirstMessage

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

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

Parameters:

serverFirstMessage - The message

Returns:

The handler

Throws:

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

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