Package org.cyclos.security.access

Class OidcServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.OidcServiceSecurity

All Implemented Interfaces:

OidcService, Service

@Security
public class OidcServiceSecurity
extends BaseServiceSecurity
implements OidcService

Security layer 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
OidcServiceSecurity()

Method Summary

Modifier and Type	Method	Description
AuthorizeResponse	approve(ConsentParams params)	Approves the given authorization request.
AuthorizeResponse	authorize(AuthorizeRequest params)	Performs the OAuth2 / OpenID connect authorization request.
AuthorizeResponse	deny(String locator)	Denies the given authorization request.
ConsentData	getConsentData(String locator)	Returns data to be displayed in a consent page.
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
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
void	revoke(RevokeRequest params)	Performs the OAuth2 token revocation request.
TokenResponse	token(TokenRequest params)	Performs the OAuth2 / OpenID connect token request.
Map<String,Object>	userInfo()	Returns the authenticated user claims

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

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

OidcServiceSecurity

public OidcServiceSecurity()

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

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

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

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

revoke

public void revoke(RevokeRequest params)

Description copied from interface: OidcService

Performs the OAuth2 token revocation request.

Specified by:

revoke in interface OidcService

token

public TokenResponse token(TokenRequest params)
                    throws FrameworkException

Description copied from interface: OidcService

Performs the OAuth2 / OpenID connect token request.

Specified by:

token in interface OidcService

Throws:

FrameworkException

userInfo

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

Description copied from interface: OidcService

Returns the authenticated user claims

Specified by:

userInfo in interface OidcService

Throws:

FrameworkException

OidcException

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity