org.jivesoftware.smack

Class SASLAuthentication

java.lang.Object

org.jivesoftware.smack.SASLAuthentication

public final class SASLAuthentication
extends Object

This class is responsible authenticating the user using SASL, binding the resource to the connection and establishing a session with the server.

Once TLS has been negotiated (i.e. the connection has been secured) it is possible to register with the server or authenticate using SASL. If the server supports SASL then Smack will try to authenticate using SASL..

The server may support many SASL mechanisms to use for authenticating. Out of the box Smack provides several SASL mechanisms, but it is possible to register new SASL Mechanisms. Use registerSASLMechanism(SASLMechanism) to register a new mechanisms.

See Also:

SASLMechanism

Method Summary

Modifier and Type	Method and Description
void	authenticate(String username, String password, EntityBareJid authzid, SSLSession sslSession) Performs SASL authentication of the specified user.
void	authenticated(SaslStreamElements.Success success) Notification message saying that SASL authentication was successful.
void	authenticationFailed(Exception exception)
void	authenticationFailed(SaslStreamElements.SASLFailure saslFailure) Notification message saying that SASL authentication has failed.
boolean	authenticationSuccessful()
static boolean	blacklistSASLMechanism(String mechanism)
void	challengeReceived(String challenge) Wrapper for challengeReceived(String, boolean), with finalChallenge set to false.
void	challengeReceived(String challenge, boolean finalChallenge) The server is challenging the SASL authentication we just sent.
static Set<String>	getBlacklistedSASLMechanisms()
static Map<String,String>	getRegisterdSASLMechanisms() Returns the registered SASLMechanism sorted by the level of preference.
static boolean	isSaslMechanismRegistered(String saslMechanism)
static void	registerSASLMechanism(SASLMechanism mechanism) Registers a new SASL mechanism.
static boolean	unBlacklistSASLMechanism(String mechanism)
static boolean	unregisterSASLMechanism(String clazz) Unregister a SASLMechanism by it's full class name.

Methods inherited from class java.lang.Object

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

Method Detail

registerSASLMechanism

public static void registerSASLMechanism(SASLMechanism mechanism)

Registers a new SASL mechanism.

Parameters:

mechanism - a SASLMechanism subclass.

getRegisterdSASLMechanisms

public static Map<String,String> getRegisterdSASLMechanisms()

Returns the registered SASLMechanism sorted by the level of preference.

Returns:

the registered SASLMechanism sorted by the level of preference.

isSaslMechanismRegistered

public static boolean isSaslMechanismRegistered(String saslMechanism)

unregisterSASLMechanism

public static boolean unregisterSASLMechanism(String clazz)

Unregister a SASLMechanism by it's full class name. For example "org.jivesoftware.smack.sasl.javax.SASLCramMD5Mechanism".

Parameters:

clazz - the SASLMechanism class's name

Returns:

true if the given SASLMechanism was removed, false otherwise

blacklistSASLMechanism

public static boolean blacklistSASLMechanism(String mechanism)

unBlacklistSASLMechanism

public static boolean unBlacklistSASLMechanism(String mechanism)

getBlacklistedSASLMechanisms

public static Set<String> getBlacklistedSASLMechanisms()

authenticate

public void authenticate(String username,
                         String password,
                         EntityBareJid authzid,
                         SSLSession sslSession)
                  throws XMPPException.XMPPErrorException,
                         SASLErrorException,
                         IOException,
                         SmackException,
                         InterruptedException

Performs SASL authentication of the specified user. If SASL authentication was successful then resource binding and session establishment will be performed. This method will return the full JID provided by the server while binding a resource to the connection.

The server may assign a full JID with a username or resource different than the requested by this method.

Parameters:

username - the username that is authenticating with the server.

password - the password to send to the server.

authzid - the authorization identifier (typically null).

sslSession - the optional SSL/TLS session (if one was established)

Throws:

XMPPException.XMPPErrorException

SASLErrorException

IOException

SmackException

InterruptedException

challengeReceived

public void challengeReceived(String challenge)
                       throws SmackException,
                              InterruptedException

Wrapper for challengeReceived(String, boolean), with finalChallenge set to false.

Parameters:

challenge - a base64 encoded string representing the challenge.

Throws:

SmackException

InterruptedException

challengeReceived

public void challengeReceived(String challenge,
                              boolean finalChallenge)
                       throws SmackException,
                              InterruptedException

The server is challenging the SASL authentication we just sent. Forward the challenge to the current SASLMechanism we are using. The SASLMechanism will eventually send a response to the server. The length of the challenge-response sequence varies according to the SASLMechanism in use.

Parameters:

challenge - a base64 encoded string representing the challenge.

finalChallenge - true if this is the last challenge send by the server within the success stanza

Throws:

SmackException

InterruptedException

authenticated

public void authenticated(SaslStreamElements.Success success)
                   throws SmackException,
                          InterruptedException

Notification message saying that SASL authentication was successful. The next step would be to bind the resource.

Parameters:

success - result of the authentication.

Throws:

SmackException

InterruptedException

authenticationFailed

public void authenticationFailed(SaslStreamElements.SASLFailure saslFailure)

Notification message saying that SASL authentication has failed. The server may have closed the connection depending on the number of possible retries.

Parameters:

saslFailure - the SASL failure as reported by the server

See Also:

RFC6120 6.5

authenticationFailed

public void authenticationFailed(Exception exception)

authenticationSuccessful

public boolean authenticationSuccessful()