Package org.jivesoftware.smack.sasl.provided

Class SASLDigestMD5Mechanism

java.lang.Object

org.jivesoftware.smack.sasl.SASLMechanism

org.jivesoftware.smack.sasl.provided.SASLDigestMD5Mechanism

All Implemented Interfaces:

Comparable<SASLMechanism>

public class SASLDigestMD5Mechanism
extends SASLMechanism

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

Constructor	Description
SASLDigestMD5Mechanism()

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.
String	getName()	Returns the common name of the SASL mechanism.
int	getPriority()	Get the priority of this SASL mechanism.
SASLDigestMD5Mechanism	newInstance()
static String	quoteBackslash(String string)	Quote the backslash in the given String.
static void	setVerifyServerResponse(boolean verifyServerResponse)

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

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

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

SASLDigestMD5Mechanism

public SASLDigestMD5Mechanism()

Method Details

setVerifyServerResponse

public static void setVerifyServerResponse(boolean verifyServerResponse)

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.

getPriority

public int getPriority()

Description copied from class: SASLMechanism

Get the priority of this SASL mechanism. Lower values mean higher priority.

Specified by:

getPriority in class SASLMechanism

Returns:

the priority of this SASL mechanism.

newInstance

public SASLDigestMD5Mechanism newInstance()

Specified by:

newInstance in class SASLMechanism

authzidSupported

public boolean authzidSupported()

Overrides:

authzidSupported in class SASLMechanism

checkIfSuccessfulOrThrow

public void checkIfSuccessfulOrThrow()
                              throws SmackException.SmackSaslException

Specified by:

checkIfSuccessfulOrThrow in class SASLMechanism

Throws:

SmackException.SmackSaslException

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.

quoteBackslash

public static String quoteBackslash(String string)

Quote the backslash in the given String. Replaces all occurrences of "\" with "\\".

According to RFC 2831 § 7.2 a quoted-string consists either of qdtext or quoted-pair. And since quoted-pair is a backslash followed by a char, every backslash in qdtext must be quoted, since it otherwise would be treated as qdtext.

Parameters:

string - the input string.

Returns:

the input string where the every backslash is quoted.