Class Auth0AuthenticationModule

java.lang.Object

com.kingsrook.qqq.backend.core.modules.authentication.implementations.Auth0AuthenticationModule

All Implemented Interfaces:

QAuthenticationModuleInterface

public class Auth0AuthenticationModule
extends Object
implements QAuthenticationModuleInterface

QQQ AuthenticationModule for working with Auth0. createSession can be called with the following fields in its context: System-User session use-case: 1: Takes in an "accessToken" (but doesn't store a userSession record). 1b: legacy frontend use-case does the same as system-user! Web User session use-cases: 2: creates a new session (userSession record) by taking an "accessToken" 3: looks up an existing session (userSession record) by taking a "sessionUUID" 4: takes an "apiKey" (looked up in metaData.AccessTokenTableName - refreshing accessToken with auth0 if needed). 5: takes a "basicAuthString" (encoded username:password), which make a new accessToken in auth0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_TOKEN_KEY
static final String	API_KEY
static final String	BASIC_AUTH_KEY
static final String	DO_STORE_USER_SESSION_KEY
static final int	ID_TOKEN_VALIDATION_INTERVAL_SECONDS	//////////////////////////////////////////////////////////////////////////////////////////////////////////
static final String	SESSION_UUID_KEY

Constructor Summary

Constructors

Constructor	Description
Auth0AuthenticationModule()

Method Summary

Modifier and Type	Method	Description
QSession	createAutomatedSessionForUser(QInstance qInstance, Serializable userId)	e.g., if a scheduled job needs to run as a user (say, a report)...
QSession	createSession(QInstance qInstance, Map<String,String> context)
protected String	getAccessTokenForUsernameAndPasswordFromAuth0(Auth0AuthenticationMetaData metaData, com.auth0.client.auth.AuthAPI auth, String credentials)
boolean	isSessionValid(QInstance instance, QSession session)
org.json.JSONObject	requestAccessTokenForClientIdAndSecretFromAuth0(Auth0AuthenticationMetaData auth0MetaData, String clientId, String clientSecret)	make http request to Auth0 for a new access token for an application - e.g., with a clientId and clientSecret as params

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.modules.authentication.QAuthenticationModuleInterface

getLoginRedirectUrl, usesSessionIdCookie

Field Details

ID_TOKEN_VALIDATION_INTERVAL_SECONDS

public static final int ID_TOKEN_VALIDATION_INTERVAL_SECONDS

//////////////////////////////////////////////////////////////////////////////////////////////////////////

See Also:

• Constant Field Values

ACCESS_TOKEN_KEY

public static final String ACCESS_TOKEN_KEY

See Also:

• Constant Field Values

API_KEY

public static final String API_KEY

See Also:

• Constant Field Values

SESSION_UUID_KEY

public static final String SESSION_UUID_KEY

See Also:

• Constant Field Values

BASIC_AUTH_KEY

public static final String BASIC_AUTH_KEY

See Also:

• Constant Field Values

DO_STORE_USER_SESSION_KEY

public static final String DO_STORE_USER_SESSION_KEY

See Also:

• Constant Field Values

Constructor Details

Auth0AuthenticationModule

public Auth0AuthenticationModule()

Method Details

createSession

public QSession createSession(QInstance qInstance,
 Map<String,String> context)
                       throws QAuthenticationException

Specified by:

createSession in interface QAuthenticationModuleInterface

Throws:

QAuthenticationException

getAccessTokenForUsernameAndPasswordFromAuth0

protected String getAccessTokenForUsernameAndPasswordFromAuth0(Auth0AuthenticationMetaData metaData,
 com.auth0.client.auth.AuthAPI auth,
 String credentials)
                                                        throws com.auth0.exception.Auth0Exception

Throws:

com.auth0.exception.Auth0Exception

isSessionValid

public boolean isSessionValid(QInstance instance,
 QSession session)

Specified by:

isSessionValid in interface QAuthenticationModuleInterface

requestAccessTokenForClientIdAndSecretFromAuth0

public org.json.JSONObject requestAccessTokenForClientIdAndSecretFromAuth0(Auth0AuthenticationMetaData auth0MetaData,
 String clientId,
 String clientSecret)
                                                                    throws AccessTokenException

make http request to Auth0 for a new access token for an application - e.g., with a clientId and clientSecret as params

Throws:

AccessTokenException

createAutomatedSessionForUser

public QSession createAutomatedSessionForUser(QInstance qInstance,
 Serializable userId)
                                       throws QAuthenticationException

e.g., if a scheduled job needs to run as a user (say, a report)...

Specified by:

createAutomatedSessionForUser in interface QAuthenticationModuleInterface

Throws:

QAuthenticationException