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

Interface ScramClientFunctionality

All Known Implementing Classes:

ScramClientFunctionalityImpl

public interface ScramClientFunctionality

Provides building blocks for creating SCRAM authentication client

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScramClientFunctionality.State State of the authentication procedure

Method Summary

Modifier and Type	Method and Description
void	checkServerFinalMessage(String serverFinalMessage) Checks if the server's final message is valid
ScramClientFunctionality.State	getState() Gets the state of the authentication procedure
boolean	isEnded() Checks if authentication is completed, either successfully or not.
boolean	isSuccessful() Checks if authentication is successful.
String	prepareFinalMessage(String password, String serverFirstMessage) Prepares client's final message
String	prepareFirstMessage(String username) Prepares the first client message

Method Detail

prepareFirstMessage

String prepareFirstMessage(String username)
                    throws ScramException

Prepares the first client message

Parameters:

username - Username of the user

Returns:

First client message

Throws:

ScramException - if username contains prohibited characters

prepareFinalMessage

String prepareFinalMessage(String password,
                           String serverFirstMessage)
                    throws ScramException

Prepares client's final message

Parameters:

password - User password

serverFirstMessage - Server's first message

Returns:

Client's final message

Throws:

ScramException - if there is an error processing server's message, i.e. it violates the protocol

checkServerFinalMessage

void checkServerFinalMessage(String serverFinalMessage)
                      throws ScramException

Checks if the server's final message is valid

Parameters:

serverFinalMessage - Server's final message

Throws:

ScramException - if there is an error processing server's message, i.e. it violates the protocol

isSuccessful

boolean isSuccessful()

Checks if authentication is successful. You can call this method only if authentication is completed. Ensure that using isEnded()

Returns:

true if successful, false otherwise

isEnded

boolean isEnded()

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

Returns:

true if authentication has ended

getState

ScramClientFunctionality.State getState()

Gets the state of the authentication procedure

Returns:

Current state