Package org.apache.qpid.server.security.auth.manager.oauth2

Class OAuth2AuthenticationProviderImpl

java.lang.Object

org.apache.qpid.server.model.AbstractConfiguredObject<T>

org.apache.qpid.server.security.auth.manager.AbstractAuthenticationManager<OAuth2AuthenticationProviderImpl>

org.apache.qpid.server.security.auth.manager.oauth2.OAuth2AuthenticationProviderImpl

All Implemented Interfaces:

EventLoggerProvider, AuthenticationProvider<OAuth2AuthenticationProviderImpl>, ConfiguredObject<OAuth2AuthenticationProviderImpl>, ContextProvider, PermissionedObject, TaskExecutorProvider, CachingAuthenticationProvider<OAuth2AuthenticationProviderImpl>, OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

public class OAuth2AuthenticationProviderImpl
extends AbstractAuthenticationManager<OAuth2AuthenticationProviderImpl>
implements OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

AbstractConfiguredObject.CallableWithArgument<V,A>, AbstractConfiguredObject.ChainedListenableFuture<V>, AbstractConfiguredObject.ChainedSettableFuture<V>, AbstractConfiguredObject.DuplicateIdException, AbstractConfiguredObject.DuplicateNameException

Field Summary

Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

SECURED_STRING_VALUE

Fields inherited from interface org.apache.qpid.server.security.auth.manager.CachingAuthenticationProvider

AUTHENTICATION_CACHE_EXPIRATION_TIME, AUTHENTICATION_CACHE_ITERATION_COUNT, AUTHENTICATION_CACHE_MAX_SIZE, DEFAULT_AUTHENTICATION_CACHE_EXPIRATION_TIME, DEFAULT_AUTHENTICATION_CACHE_ITERATION_COUNT, DEFAULT_AUTHENTICATION_CACHE_MAX_SIZE

Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject

AWAIT_ATTAINMENT_TIMEOUT, CONTEXT, CREATED_BY, CREATED_TIME, DEFAULT_AWAIT_ATTAINMENT_TIMEOUT, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE

Fields inherited from interface org.apache.qpid.server.security.auth.manager.oauth2.OAuth2AuthenticationProvider

AUTHENTICATION_OAUTH2_CONNECT_TIMEOUT, AUTHENTICATION_OAUTH2_READ_TIMEOUT, DEFAULT_AUTHENTICATION_OAUTH2_CONNECT_TIMEOUT, DEFAULT_AUTHENTICATION_OAUTH2_READ_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OAuth2AuthenticationProviderImpl(Map<String,Object> attributes, Container<?> container)

Method Summary

Modifier and Type	Method	Description
AuthenticationResult	authenticateViaAccessToken(String accessToken, NamedAddressSpace addressSpace)
AuthenticationResult	authenticateViaAuthorizationCode(String authorizationCode, String redirectUri, NamedAddressSpace addressSpace)
SaslNegotiator	createSaslNegotiator(String mechanism, SaslSettings saslSettings, NamedAddressSpace addressSpace)
URI	getAuthorizationEndpointURI()
URI	getAuthorizationEndpointURI(NamedAddressSpace addressSpace)
String	getClientId()
String	getClientSecret()
int	getConnectTimeout()
URI	getDefaultAuthorizationEndpointURI()
URI	getDefaultIdentityResolverEndpointURI()
String	getDefaultScope()
URI	getDefaultTokenEndpointURI()
URI	getIdentityResolverEndpointURI()
URI	getIdentityResolverEndpointURI(NamedAddressSpace addressSpace)
String	getIdentityResolverType()
List<String>	getMechanisms()	Gets the SASL mechanisms known to this manager.
URI	getPostLogoutURI()
int	getReadTimeout()
String	getScope()
List<String>	getTlsCipherSuiteAllowList()
List<String>	getTlsCipherSuiteDenyList()
List<String>	getTlsProtocolAllowList()
List<String>	getTlsProtocolDenyList()
boolean	getTokenEndpointNeedsAuth()
URI	getTokenEndpointURI()
URI	getTokenEndpointURI(NamedAddressSpace addressSpace)
TrustStore	getTrustStore()
protected void	onOpen()
void	onValidate()	Validation performed for configured object creation and opening.
protected void	validateChange(ConfiguredObject<?> proxyForValidation, Set<String> changedAttributes)
static Collection<String>	validIdentityResolvers()

Methods inherited from class org.apache.qpid.server.security.auth.manager.AbstractAuthenticationManager

activate, getAvailableMechanisms, getDisabledMechanisms, getEventLogger, getSecureOnlyMechanisms, logCreated, logDeleted, logOperation, logRecovered, logUpdated, startQuiesced

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

addChangeListener, addChildAsync, addFutureCallback, applyToChildren, asObjectRecord, attainState, attributesAsString, attributeSet, authorise, authorise, authorise, authoriseCreateChild, awaitChildClassToAttainState, awaitChildClassToAttainState, beforeClose, beforeDelete, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleteChildren, deleteNoChecks, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getAccessControl, getActualAttributes, getAncestor, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getStatistics, getSubjectWithAddedSystemRights, getSystemPrincipal, getSystemTaskControllerContext, getSystemTaskSubject, getSystemTaskSubject, getTaskExecutor, getType, getTypeClass, getUserPreferences, handleExceptionOnOpen, hasEncrypter, isDurable, isSystemProcess, isSystemSubject, managesChildStorage, newToken, notifyStateChanged, onClose, onCreate, onDelete, onExceptionInOpen, onResolve, open, openAsync, postResolve, postResolveChildren, postSetAttributes, registerWithParents, removeChangeListener, removeContextVariable, rethrowRuntimeExceptionsOnOpen, runTask, setAttributes, setAttributesAsync, setContextVariable, setEncrypter, setState, setUserPreferences, start, startAsync, stop, toString, updateModel, validateChildDelete, validateOnCreate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.server.model.AuthenticationProvider

getAvailableMechanisms, getDisabledMechanisms

Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject

addChangeListener, asObjectRecord, authorise, authorise, authorise, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getStatistics, getType, getTypeClass, getUserPreferences, hasEncrypter, isDurable, managesChildStorage, newToken, open, openAsync, removeChangeListener, removeContextVariable, setAttributes, setAttributesAsync, setContextVariable, setUserPreferences

Methods inherited from interface org.apache.qpid.server.model.ContextProvider

getContextKeys, getContextValue, getContextValue

Methods inherited from interface org.apache.qpid.server.logging.EventLoggerProvider

getEventLogger

Methods inherited from interface org.apache.qpid.server.security.auth.manager.oauth2.OAuth2AuthenticationProvider

getSecureOnlyMechanisms

Methods inherited from interface org.apache.qpid.server.model.TaskExecutorProvider

getTaskExecutor

Constructor Detail

OAuth2AuthenticationProviderImpl

protected OAuth2AuthenticationProviderImpl(Map<String,Object> attributes,
                                           Container<?> container)

Method Detail

onOpen

protected void onOpen()

Overrides:

onOpen in class AbstractConfiguredObject<OAuth2AuthenticationProviderImpl>

validateChange

protected void validateChange(ConfiguredObject<?> proxyForValidation,
                              Set<String> changedAttributes)

Overrides:

validateChange in class AbstractConfiguredObject<OAuth2AuthenticationProviderImpl>

onValidate

public void onValidate()

Description copied from class: AbstractConfiguredObject

Validation performed for configured object creation and opening.

Overrides:

onValidate in class AbstractAuthenticationManager<OAuth2AuthenticationProviderImpl>

getMechanisms

public List<String> getMechanisms()

Description copied from interface: AuthenticationProvider

Gets the SASL mechanisms known to this manager.

Specified by:

getMechanisms in interface AuthenticationProvider<OAuth2AuthenticationProviderImpl>

Returns:

SASL mechanism names, space separated.

createSaslNegotiator

public SaslNegotiator createSaslNegotiator(String mechanism,
                                           SaslSettings saslSettings,
                                           NamedAddressSpace addressSpace)

Specified by:

createSaslNegotiator in interface AuthenticationProvider<OAuth2AuthenticationProviderImpl>

authenticateViaAuthorizationCode

public AuthenticationResult authenticateViaAuthorizationCode(String authorizationCode,
                                                             String redirectUri,
                                                             NamedAddressSpace addressSpace)

Specified by:

authenticateViaAuthorizationCode in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

authenticateViaAccessToken

public AuthenticationResult authenticateViaAccessToken(String accessToken,
                                                       NamedAddressSpace addressSpace)

Specified by:

authenticateViaAccessToken in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getAuthorizationEndpointURI

public URI getAuthorizationEndpointURI()

Specified by:

getAuthorizationEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getAuthorizationEndpointURI

public URI getAuthorizationEndpointURI(NamedAddressSpace addressSpace)

Specified by:

getAuthorizationEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTokenEndpointURI

public URI getTokenEndpointURI()

Specified by:

getTokenEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTokenEndpointURI

public URI getTokenEndpointURI(NamedAddressSpace addressSpace)

Specified by:

getTokenEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getIdentityResolverEndpointURI

public URI getIdentityResolverEndpointURI()

Specified by:

getIdentityResolverEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getIdentityResolverEndpointURI

public URI getIdentityResolverEndpointURI(NamedAddressSpace addressSpace)

Specified by:

getIdentityResolverEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getPostLogoutURI

public URI getPostLogoutURI()

Specified by:

getPostLogoutURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTokenEndpointNeedsAuth

public boolean getTokenEndpointNeedsAuth()

Specified by:

getTokenEndpointNeedsAuth in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getIdentityResolverType

public String getIdentityResolverType()

Specified by:

getIdentityResolverType in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getClientId

public String getClientId()

Specified by:

getClientId in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getClientSecret

public String getClientSecret()

Specified by:

getClientSecret in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTrustStore

public TrustStore getTrustStore()

Specified by:

getTrustStore in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getScope

public String getScope()

Specified by:

getScope in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getDefaultAuthorizationEndpointURI

public URI getDefaultAuthorizationEndpointURI()

Specified by:

getDefaultAuthorizationEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getDefaultTokenEndpointURI

public URI getDefaultTokenEndpointURI()

Specified by:

getDefaultTokenEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getDefaultIdentityResolverEndpointURI

public URI getDefaultIdentityResolverEndpointURI()

Specified by:

getDefaultIdentityResolverEndpointURI in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getDefaultScope

public String getDefaultScope()

Specified by:

getDefaultScope in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTlsProtocolAllowList

public List<String> getTlsProtocolAllowList()

Specified by:

getTlsProtocolAllowList in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTlsProtocolDenyList

public List<String> getTlsProtocolDenyList()

Specified by:

getTlsProtocolDenyList in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTlsCipherSuiteAllowList

public List<String> getTlsCipherSuiteAllowList()

Specified by:

getTlsCipherSuiteAllowList in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getTlsCipherSuiteDenyList

public List<String> getTlsCipherSuiteDenyList()

Specified by:

getTlsCipherSuiteDenyList in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getConnectTimeout

public int getConnectTimeout()

Specified by:

getConnectTimeout in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

getReadTimeout

public int getReadTimeout()

Specified by:

getReadTimeout in interface OAuth2AuthenticationProvider<OAuth2AuthenticationProviderImpl>

validIdentityResolvers

public static Collection<String> validIdentityResolvers()