net.krotscheck.kangaroo.authz.common.authenticator.oauth2

Class AbstractOAuth2Authenticator

java.lang.Object

net.krotscheck.kangaroo.authz.common.authenticator.oauth2.AbstractOAuth2Authenticator

All Implemented Interfaces:

IAuthenticator

Direct Known Subclasses:

FacebookAuthenticator, GoogleAuthenticator

public abstract class AbstractOAuth2Authenticator
extends Object
implements IAuthenticator

An abstract class which manages the standard OAuth2 Authorization code flow, to use as an IdP. If your IdP is reasonably compliant, you can extend this class and provide any missing parameters.

Author:

Michael Krotscheck

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ID_KEY The config storage key for the facebook client id.
static String	CLIENT_SECRET_KEY The config storage key for the facebook client secret.
static javax.ws.rs.core.GenericType<HashMap<String,String>>	MAP_TYPE Map reference, used for decoding.

Constructor Summary

Constructors

Constructor and Description
AbstractOAuth2Authenticator()

Method Summary

Modifier and Type	Method and Description
UserIdentity	authenticate(Authenticator authenticator, javax.ws.rs.core.MultivaluedMap<String,String> parameters, URI callback) Handle the response from the IdP.
javax.ws.rs.core.Response	delegate(Authenticator authenticator, URI callback) Delegate an authentication request to the oauth2 IdP.
protected abstract String	getAuthEndpoint() The path to the /authorization endpoint.
javax.ws.rs.client.Client	getClient() Get the HTTP client.
protected String	getClientId(Authenticator authenticator) Provided with an authenticator, provide the client id.
protected String	getClientSecret(Authenticator authenticator) Provided with an authenticator, extract the client secret.
protected abstract String	getScopes() The string listing out all the scopes required.
org.hibernate.Session	getSession() Get the session.
protected abstract String	getTokenEndpoint() The path to the /token endpoint.
protected abstract OAuth2User	loadUserIdentity(OAuth2IdPToken token) Provided a (presumably valid) OAuth2 token, retrieve the user's remote identity from the IdP.
void	setClient(javax.ws.rs.client.Client client) Set the HTTP client.
void	setSession(org.hibernate.Session session) Set the hibernate session.
void	validate(Authenticator authenticator) Validate that the configuration values provided are correct.

Methods inherited from class java.lang.Object

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

Field Detail

MAP_TYPE

public static final javax.ws.rs.core.GenericType<HashMap<String,String>> MAP_TYPE

Map reference, used for decoding.

CLIENT_ID_KEY

public static final String CLIENT_ID_KEY

The config storage key for the facebook client id.

See Also:

Constant Field Values

CLIENT_SECRET_KEY

public static final String CLIENT_SECRET_KEY

The config storage key for the facebook client secret.

See Also:

Constant Field Values

Constructor Detail

AbstractOAuth2Authenticator

public AbstractOAuth2Authenticator()

Method Detail

getClient

public final javax.ws.rs.client.Client getClient()

Get the HTTP client.

Returns:

The HTTP client.

setClient

public final void setClient(javax.ws.rs.client.Client client)

Set the HTTP client.

Parameters:

client - The HTTP client.

getSession

public final org.hibernate.Session getSession()

Get the session.

Returns:

The hibernate session.

setSession

public final void setSession(org.hibernate.Session session)

Set the hibernate session.

Parameters:

session - The new hibernate session.

getAuthEndpoint

protected abstract String getAuthEndpoint()

The path to the /authorization endpoint.

Returns:

The fully qualified URL to the OAuth2 authorization endpoint.

getTokenEndpoint

protected abstract String getTokenEndpoint()

The path to the /token endpoint.

Returns:

The fully qualified URL to the OAuth2 token request endpoint.

getScopes

protected abstract String getScopes()

The string listing out all the scopes required.

Returns:

A list of scopes, using the IdP appropriate separator character.

getClientSecret

protected final String getClientSecret(Authenticator authenticator)

Provided with an authenticator, extract the client secret.

Parameters:

authenticator - The authenticator.

Returns:

The client secret.

getClientId

protected final String getClientId(Authenticator authenticator)

Provided with an authenticator, provide the client id.

Parameters:

authenticator - The authenticator.

Returns:

The OAuth2 client id.

delegate

public final javax.ws.rs.core.Response delegate(Authenticator authenticator,
                                                URI callback)

Delegate an authentication request to the oauth2 IdP.

Specified by:

delegate in interface IAuthenticator

Parameters:

authenticator - The authenticator configuration.

callback - The redirect, on this server, where the response should go.

Returns:

A response indicating the initial request to facebeook.

validate

public final void validate(Authenticator authenticator)
                    throws KangarooException

Validate that the configuration values provided are correct.

Specified by:

validate in interface IAuthenticator

Parameters:

authenticator - The authenticator configuration.

Throws:

KangarooException - Thrown if we cannot use these values.

authenticate

public final UserIdentity authenticate(Authenticator authenticator,
                                       javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                       URI callback)

Handle the response from the IdP.

Specified by:

authenticate in interface IAuthenticator

Parameters:

authenticator - The authenticator configuration.

parameters - Parameters for the authenticator, retrieved from an appropriate source.

callback - The redirect, on this server, where the response should go.

Returns:

A user identity, or a runtime error that will be sent back.

loadUserIdentity

protected abstract OAuth2User loadUserIdentity(OAuth2IdPToken token)

Provided a (presumably valid) OAuth2 token, retrieve the user's remote identity from the IdP.

Parameters:

token - The OAuth token.

Returns:

The user identity.