Package org.jivesoftware.smack.sasl.core

Class ScramMechanism

java.lang.Object

org.jivesoftware.smack.sasl.SASLMechanism

org.jivesoftware.smack.sasl.core.ScramMechanism

All Implemented Interfaces:

Comparable<SASLMechanism>

Direct Known Subclasses:

ScramPlusMechanism, SCRAMSHA1Mechanism

public abstract class ScramMechanism
extends SASLMechanism

Field Summary

Fields inherited from class org.jivesoftware.smack.sasl.SASLMechanism

authenticationId, authorizationId, connection, connectionConfiguration, CRAMMD5, DIGESTMD5, EXTERNAL, GSSAPI, host, password, PLAIN, serviceName, sslSession

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScramMechanism(ScramHmac scramHmac)

Method Summary

Modifier and Type	Method	Description
protected void	authenticateInternal(CallbackHandler cbh)
boolean	authzidSupported()
void	checkIfSuccessfulOrThrow()
protected byte[]	evaluateChallenge(byte[] challenge)	Evaluate the SASL challenge.
protected byte[]	getAuthenticationText()	Should return the initial response of the SASL mechanism.
protected byte[]	getChannelBindingData()	Get the channel binding data.
protected String	getGs2CbindFlag()	Get the SCRAM GSS-API Channel Binding Flag value.
String	getName()	Returns the common name of the SASL mechanism.

Methods inherited from class org.jivesoftware.smack.sasl.SASLMechanism

afterFinalSaslChallenge, authenticate, authenticate, authenticateInternal, challengeReceived, compareTo, getPriority, instanceForAuthentication, isAuthenticationSuccessful, isFinished, newInstance, requiresPassword, saslPrep, setException, throwExceptionIfRequired, toBytes, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ScramMechanism

protected ScramMechanism(ScramHmac scramHmac)

Method Details

authenticateInternal

protected void authenticateInternal(CallbackHandler cbh)

Specified by:

authenticateInternal in class SASLMechanism

getAuthenticationText

protected byte[] getAuthenticationText()

Description copied from class: SASLMechanism

Should return the initial response of the SASL mechanism. The returned byte array will be send base64 encoded to the server. SASL mechanism are free to return null or an empty array here.

Specified by:

getAuthenticationText in class SASLMechanism

Returns:

the initial response or null

getName

public String getName()

Description copied from class: SASLMechanism

Returns the common name of the SASL mechanism. E.g.: PLAIN, DIGEST-MD5 or GSSAPI.

Specified by:

getName in class SASLMechanism

Returns:

the common name of the SASL mechanism.

checkIfSuccessfulOrThrow

public void checkIfSuccessfulOrThrow()
                              throws SmackException.SmackSaslException

Specified by:

checkIfSuccessfulOrThrow in class SASLMechanism

Throws:

SmackException.SmackSaslException

authzidSupported

public boolean authzidSupported()

Overrides:

authzidSupported in class SASLMechanism

evaluateChallenge

protected byte[] evaluateChallenge(byte[] challenge)
                            throws SmackException.SmackSaslException

Description copied from class: SASLMechanism

Evaluate the SASL challenge.

Overrides:

evaluateChallenge in class SASLMechanism

Parameters:

challenge - challenge to evaluate.

Returns:

null.

Throws:

SmackException.SmackSaslException - If a SASL related error occurs.

getGs2CbindFlag

protected String getGs2CbindFlag()

Get the SCRAM GSS-API Channel Binding Flag value.

Returns:

the gs2-cbind-flag value.

See Also:

• RFC 5802 § 6.

getChannelBindingData

protected byte[] getChannelBindingData()
                                throws SmackException.SmackSaslException

Get the channel binding data.

Returns:

the Channel Binding data.

Throws:

SmackException.SmackSaslException - if a SASL specific error occurred.