Class ScramServerFunctionalityImpl

java.lang.Object

org.apache.activemq.artemis.protocol.amqp.sasl.scram.ScramServerFunctionalityImpl

All Implemented Interfaces:

ScramServerFunctionality

public class ScramServerFunctionalityImpl
extends Object
implements ScramServerFunctionality

Provides building blocks for creating SCRAM authentication server

Nested Class Summary

Nested classes/interfaces inherited from interface ScramServerFunctionality

ScramServerFunctionality.State

Constructor Summary

Constructors

Constructor	Description
ScramServerFunctionalityImpl(String digestName, String hmacName)	Creates new ScramServerFunctionalityImpl
ScramServerFunctionalityImpl(String digestName, String hmacName, String serverPartNonce)	Creates new ScramServerFunctionalityImpl

Method Summary

Modifier and Type	Method	Description
MessageDigest	getDigest()
Mac	getHmac()
ScramServerFunctionality.State	getState()	Gets the state of the authentication procedure
String	handleClientFirstMessage(String message)	Handles client's first message
boolean	isEnded()	Checks if authentication is completed, either successfully or not.
boolean	isSuccessful()	Checks if authentication is completed, either successfully or not.
String	prepareFinalMessage(String clientFinalMessage)	Prepares server's final message
String	prepareFinalMessageUnchecked(String clientFinalMessage)
String	prepareFirstMessage(UserData userData)	Prepares server's first message

Methods inherited from class Object

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

Constructor Details

ScramServerFunctionalityImpl

public ScramServerFunctionalityImpl(String digestName,
 String hmacName)
                             throws NoSuchAlgorithmException

Creates new ScramServerFunctionalityImpl

Parameters:

digestName - Digest to be used

hmacName - HMAC to be used

Throws:

NoSuchAlgorithmException

ScramServerFunctionalityImpl

public ScramServerFunctionalityImpl(String digestName,
 String hmacName,
 String serverPartNonce)
                             throws NoSuchAlgorithmException

Creates new ScramServerFunctionalityImpl

Parameters:

digestName - Digest to be used

hmacName - HMAC to be used

serverPartNonce - Server's part of the nonce

Throws:

NoSuchAlgorithmException

Method Details

handleClientFirstMessage

public String handleClientFirstMessage(String message)
                                throws ScramException

Handles client's first message

Specified by:

handleClientFirstMessage in interface ScramServerFunctionality

Parameters:

message - Client's first message

Returns:

username extracted from the client message

Throws:

ScramException

prepareFirstMessage

public String prepareFirstMessage(UserData userData)

Description copied from interface: ScramServerFunctionality

Prepares server's first message

Specified by:

prepareFirstMessage in interface ScramServerFunctionality

Parameters:

userData - user data needed to prepare the message

Returns:

Server's first message

prepareFinalMessage

public String prepareFinalMessage(String clientFinalMessage)
                           throws ScramException

Description copied from interface: ScramServerFunctionality

Prepares server's final message

Specified by:

prepareFinalMessage in interface ScramServerFunctionality

Parameters:

clientFinalMessage - Client's final message

Returns:

Server's final message

Throws:

ScramException

prepareFinalMessageUnchecked

public String prepareFinalMessageUnchecked(String clientFinalMessage)
                                    throws ScramException

Throws:

ScramException

isSuccessful

public boolean isSuccessful()

Description copied from interface: ScramServerFunctionality

Checks if authentication is completed, either successfully or not. Authentication is completed if ScramServerFunctionality.getState() returns ENDED.

Specified by:

isSuccessful in interface ScramServerFunctionality

Returns:

true if authentication has ended

isEnded

public boolean isEnded()

Description copied from interface: ScramServerFunctionality

Checks if authentication is completed, either successfully or not. Authentication is completed if ScramServerFunctionality.getState() returns ENDED.

Specified by:

isEnded in interface ScramServerFunctionality

Returns:

true if authentication has ended

getState

public ScramServerFunctionality.State getState()

Description copied from interface: ScramServerFunctionality

Gets the state of the authentication procedure

Specified by:

getState in interface ScramServerFunctionality

Returns:

Current state

getDigest

public MessageDigest getDigest()

Specified by:

getDigest in interface ScramServerFunctionality

getHmac

public Mac getHmac()

Specified by:

getHmac in interface ScramServerFunctionality