Package org.cyclos.impl.access

Class OidcServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.access.OidcServiceImpl

All Implemented Interfaces:

OidcServiceLocal, OidcService, Service

@Service
public class OidcServiceImpl
extends BaseServiceImpl
implements OidcServiceLocal

Local interface for OidcService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
OidcServiceImpl()

Method Summary

Modifier and Type	Method	Description
AuthorizeResponse	approve(ConsentParams params)	Approves the given authorization request.
AuthorizeResponse	authorize(AuthorizeRequest request)	Performs the OAuth2 / OpenID connect authorization request.
com.nimbusds.jose.jwk.RSAKey	createKey(Date date)	Creates a new signing RSA JSON Web Key with the given base date Should only be called from tests
AuthorizeResponse	deny(String locator)	Denies the given authorization request.
OidcAccessToken	findAccessToken(Network network, String remoteAddress, String accessToken)	Returns an access token using the token value
ConsentData	getConsentData(String locator)	Returns data to be displayed in a consent page.
com.nimbusds.jose.jwk.RSAKey	getKey(String kid)	Returns a signing RSA JSON Web Key by key id
OpenidConfiguration	getOpenidConfiguration()	Returns the OpenID Connect configuration to be returned on .well-known/openid-configuration
com.nimbusds.jose.jwk.JWKSet	getPublicKeys()	Returns the public keys for this network
void	initialize()
long	purgeAuthorizations()	Removes all authorizations that don't have a refresh token and don't have any access tokens (either never generated or already purged).
long	purgeExpiredTokens()	Removes all access tokens that have already expired
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	revoke(@NotNull RevokeRequest params)	Performs the OAuth2 token revocation request.
TokenResponse	token(@NotNull TokenRequest params)	Performs the OAuth2 / OpenID connect token request.
Map<String,Object>	userInfo()	Returns the authenticated user claims

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

OidcServiceImpl

public OidcServiceImpl()

Method Detail

approve

public AuthorizeResponse approve(ConsentParams params)
                          throws FrameworkException

Description copied from interface: OidcService

Approves the given authorization request. The request is obtained from the locator parameter, while the user is authenticated via user / password with any allowed principal types and access password for the main channel.

Specified by:

approve in interface OidcService

Throws:

FrameworkException

authorize

public AuthorizeResponse authorize(AuthorizeRequest request)
                            throws FrameworkException,
                                   OidcException

Description copied from interface: OidcService

Performs the OAuth2 / OpenID connect authorization request. The result is the redirect URL for the user to get the login / consent.

Specified by:

authorize in interface OidcService

Throws:

OidcException - If any parameter or state is invalid

FrameworkException

createKey

public com.nimbusds.jose.jwk.RSAKey createKey(Date date)

Description copied from interface: OidcServiceLocal

Creates a new signing RSA JSON Web Key with the given base date Should only be called from tests

Specified by:

createKey in interface OidcServiceLocal

deny

public AuthorizeResponse deny(String locator)
                       throws FrameworkException

Description copied from interface: OidcService

Denies the given authorization request. The request is obtained from the locator parameter, while the user is authenticated via user / password with any allowed principal types and access password for the main channel.

Specified by:

deny in interface OidcService

Throws:

FrameworkException

findAccessToken

public OidcAccessToken findAccessToken(Network network,
                                       String remoteAddress,
                                       String accessToken)

Description copied from interface: OidcServiceLocal

Returns an access token using the token value

Specified by:

findAccessToken in interface OidcServiceLocal

getConsentData

public ConsentData getConsentData(String locator)
                           throws FrameworkException

Description copied from interface: OidcService

Returns data to be displayed in a consent page. The request needs to be pending authorization, or an EntityNotFoundException is thrown.

Specified by:

getConsentData in interface OidcService

Throws:

FrameworkException

getKey

public com.nimbusds.jose.jwk.RSAKey getKey(String kid)

Description copied from interface: OidcServiceLocal

Returns a signing RSA JSON Web Key by key id

Specified by:

getKey in interface OidcServiceLocal

getOpenidConfiguration

public OpenidConfiguration getOpenidConfiguration()
                                           throws FrameworkException

Description copied from interface: OidcService

Returns the OpenID Connect configuration to be returned on .well-known/openid-configuration

Specified by:

getOpenidConfiguration in interface OidcService

Throws:

FrameworkException

getPublicKeys

public com.nimbusds.jose.jwk.JWKSet getPublicKeys()
                                           throws FrameworkException

Description copied from interface: OidcService

Returns the public keys for this network

Specified by:

getPublicKeys in interface OidcService

Throws:

FrameworkException

initialize

@PostConstruct
public void initialize()

purgeAuthorizations

public long purgeAuthorizations()

Description copied from interface: OidcServiceLocal

Removes all authorizations that don't have a refresh token and don't have any access tokens (either never generated or already purged).

Specified by:

purgeAuthorizations in interface OidcServiceLocal

purgeExpiredTokens

public long purgeExpiredTokens()

Description copied from interface: OidcServiceLocal

Removes all access tokens that have already expired

Specified by:

purgeExpiredTokens in interface OidcServiceLocal

revoke

public void revoke(@NotNull
                   @NotNull RevokeRequest params)

Description copied from interface: OidcService

Performs the OAuth2 token revocation request.

Specified by:

revoke in interface OidcService

token

public TokenResponse token(@NotNull
                           @NotNull TokenRequest params)
                    throws FrameworkException,
                           OidcException

Description copied from interface: OidcService

Performs the OAuth2 / OpenID connect token request.

Specified by:

token in interface OidcService

Throws:

FrameworkException

OidcException

userInfo

public Map<String,Object> userInfo()
                                  throws FrameworkException

Description copied from interface: OidcService

Returns the authenticated user claims

Specified by:

userInfo in interface OidcService

Throws:

FrameworkException

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl