org.jivesoftware.smack.sasl.core

Class SASLXOauth2Mechanism

java.lang.Object

org.jivesoftware.smack.sasl.SASLMechanism

org.jivesoftware.smack.sasl.core.SASLXOauth2Mechanism

All Implemented Interfaces:

Comparable<SASLMechanism>

public class SASLXOauth2Mechanism
extends SASLMechanism

The SASL X-OAUTH2 mechanism as described in https://developers.google .com/talk/jep_extensions/oauth

The given password will be used as OAUTH token.

Note that X-OAUTH2 is experimental in Smack. This is because Google defined, besides being a bad practice (XEP-134), custom attributes to the 'auth' stanza, as can be seen here

 
 <auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="X-OAUTH2"
    auth:service="chromiumsync" auth:allow-generated-jid="true"
    auth:client-uses-full-bind-result="true" xmlns:auth="http://www.google.com/talk/protocol/auth">
 
 

from https://developers.google.com/cloud-print/docs/rawxmpp and here

 
 <auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl"
   mechanism="X-OAUTH2"
   auth:service="oauth2"
   xmlns:auth="http://www.google.com/talk/protocol/auth">
 base64("\0" + user_name + "\0" + oauth_token)
 </auth>
 
 

from https://developers.google.com/talk/jep_extensions/oauth

Those attribute extensions are currently not supported by Smack, and it's unclear how it affects authorization and how widely they are used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

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

authenticationId, connection, CRAMMD5, DIGESTMD5, EXTERNAL, GSSAPI, host, password, PLAIN, serviceName

Constructor Summary

Constructors

Constructor and Description
SASLXOauth2Mechanism()

Method Summary

Modifier and Type	Method and Description
protected void	authenticateInternal(CallbackHandler cbh)
void	checkIfSuccessfulOrThrow()
protected byte[]	getAuthenticationText() Should return the initial response of the SASL mechanism.
String	getName() Returns the common name of the SASL mechanism.
int	getPriority()
SASLXOauth2Mechanism	newInstance()

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

authenticate, authenticate, authenticateInternal, challengeReceived, compareTo, evaluateChallenge, instanceForAuthentication, saslPrep, setSaslPrepTransformer, toBytes

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

SASLXOauth2Mechanism

public SASLXOauth2Mechanism()

Method Detail

authenticateInternal

protected void authenticateInternal(CallbackHandler cbh)
                             throws SmackException

Specified by:

authenticateInternal in class SASLMechanism

Throws:

SmackException

getAuthenticationText

protected byte[] getAuthenticationText()
                                throws SmackException

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

Throws:

SmackException

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()

Specified by:

getPriority in class SASLMechanism

newInstance

public SASLXOauth2Mechanism newInstance()

Specified by:

newInstance in class SASLMechanism

checkIfSuccessfulOrThrow

public void checkIfSuccessfulOrThrow()
                              throws SmackException

Specified by:

checkIfSuccessfulOrThrow in class SASLMechanism

Throws:

SmackException