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

Interface ScramServerFunctionality

  • All Known Implementing Classes:
    ScramServerFunctionalityImpl
    public interface ScramServerFunctionality
    Provides building blocks for creating SCRAM authentication server

    • Method Detail

      • handleClientFirstMessage

        String handleClientFirstMessage​(String message)
                         throws ScramException
        Handles client's first message
        Parameters:
        message - Client's first message
        Returns:
        username extracted from the client message
        Throws:
        ScramException

      • prepareFirstMessage

        String prepareFirstMessage​(UserData userData)
        Prepares server's first message
        Parameters:
        userData - user data needed to prepare the message
        Returns:
        Server's first message

      • prepareFinalMessage

        String prepareFinalMessage​(String clientFinalMessage)
                    throws ScramException
        Prepares server's final message
        Parameters:
        clientFinalMessage - Client's final message
        Returns:
        Server's final message
        Throws:
        ScramException

      • isSuccessful

        boolean isSuccessful()
        Checks if authentication is completed, either successfully or not. Authentication is completed if getState() returns ENDED.
        Returns:
        true if authentication has ended

      • 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

      • getHmac

        Mac getHmac()