Package org.wildfly.security.mechanism.scram

Class ScramClient

java.lang.Object

org.wildfly.security.mechanism.scram.ScramClient

public final class ScramClient
extends Object

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method	Description
String	getAuthorizationId()
byte[]	getBindingData()
String	getBindingType()
ScramInitialClientMessage	getInitialResponse()	Create an initial response.
ScramMechanism	getMechanism()
ScramFinalClientMessage	handleInitialChallenge(ScramInitialClientMessage initialResponse, ScramInitialServerMessage initialChallenge)
ScramFinalServerMessage	parseFinalServerMessage(byte[] messageBytes)
ScramInitialServerMessage	parseInitialServerMessage(ScramInitialClientMessage initialResponse, byte[] bytes)
void	verifyFinalChallenge(ScramFinalClientMessage finalResponse, ScramFinalServerMessage finalChallenge)

Methods inherited from class java.lang.Object

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

Method Detail

getMechanism

public ScramMechanism getMechanism()

getAuthorizationId

public String getAuthorizationId()

getBindingType

public String getBindingType()

getBindingData

public byte[] getBindingData()

getInitialResponse

public ScramInitialClientMessage getInitialResponse()
                                             throws AuthenticationMechanismException

Create an initial response. This will cause the callback handler to be initialized with an authentication name.

Returns:

the initial response to send to the server

Throws:

AuthenticationMechanismException - if the client authentication failed for some reason

parseInitialServerMessage

public ScramInitialServerMessage parseInitialServerMessage(ScramInitialClientMessage initialResponse,
                                                           byte[] bytes)
                                                    throws AuthenticationMechanismException

Throws:

AuthenticationMechanismException

handleInitialChallenge

public ScramFinalClientMessage handleInitialChallenge(ScramInitialClientMessage initialResponse,
                                                      ScramInitialServerMessage initialChallenge)
                                               throws AuthenticationMechanismException

Throws:

AuthenticationMechanismException

parseFinalServerMessage

public ScramFinalServerMessage parseFinalServerMessage(byte[] messageBytes)
                                                throws AuthenticationMechanismException

Throws:

AuthenticationMechanismException

verifyFinalChallenge

public void verifyFinalChallenge(ScramFinalClientMessage finalResponse,
                                 ScramFinalServerMessage finalChallenge)
                          throws AuthenticationMechanismException

Throws:

AuthenticationMechanismException