Package org.apache.syncope.common.lib.auth

Class AbstractOIDCAuthModuleConf

java.lang.Object

org.apache.syncope.common.lib.auth.Pac4jAuthModuleConf

org.apache.syncope.common.lib.auth.AbstractOAuth20AuthModuleConf

org.apache.syncope.common.lib.auth.AbstractOIDCAuthModuleConf

All Implemented Interfaces:

Serializable, AuthModuleConf, BaseBean

Direct Known Subclasses:

AppleOIDCAuthModuleConf, AzureOIDCAuthModuleConf, GoogleOIDCAuthModuleConf, KeycloakOIDCAuthModuleConf, OIDCAuthModuleConf

public abstract class AbstractOIDCAuthModuleConf
extends AbstractOAuth20AuthModuleConf

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.syncope.common.lib.auth.AuthModuleConf

AuthModuleConf.Mapper

Field Summary

Fields

Modifier and Type	Field	Description
protected String	discoveryUri
protected boolean	expireSessionWithToken	Checks if sessions expire with token expiration.
protected String	maxClockSkew	Clock skew in order to account for drift, when validating id tokens.
protected String	preferredJwsAlgorithm	The JWS algorithm to use forcefully when validating ID tokens.
protected String	responseMode	The response mode specifies how the result of the authorization request is formatted.
protected String	tokenExpirationAdvance	Default time period advance (in seconds) for considering an access token expired.
protected boolean	useNonce	Whether an initial nonce should be to used initially for replay attack mitigation.

Fields inherited from class org.apache.syncope.common.lib.auth.AbstractOAuth20AuthModuleConf

clientId, clientSecret, customParams, enabled, responseType, scope, tokenUrl, userIdAttribute

Constructor Summary

Constructors

Constructor	Description
AbstractOIDCAuthModuleConf()

Method Summary

Modifier and Type	Method	Description
String	getDiscoveryUri()
String	getMaxClockSkew()
String	getPreferredJwsAlgorithm()
String	getResponseMode()
String	getTokenExpirationAdvance()
boolean	isExpireSessionWithToken()
boolean	isUseNonce()
void	setDiscoveryUri(String discoveryUri)
void	setExpireSessionWithToken(boolean expireSessionWithToken)
void	setMaxClockSkew(String maxClockSkew)
void	setPreferredJwsAlgorithm(String preferredJwsAlgorithm)
void	setResponseMode(String responseMode)
void	setTokenExpirationAdvance(String tokenExpirationAdvance)
void	setUseNonce(boolean useNonce)

Methods inherited from class org.apache.syncope.common.lib.auth.AbstractOAuth20AuthModuleConf

getClientId, getClientSecret, getCustomParams, getResponseType, getScope, getTokenUrl, getUserIdAttribute, isEnabled, setClientId, setClientSecret, setCustomParams, setEnabled, setId, setResponseType, setScope, setTokenUrl, setUserIdAttribute

Methods inherited from class org.apache.syncope.common.lib.auth.Pac4jAuthModuleConf

getClientName, setClientName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.syncope.common.lib.auth.AuthModuleConf

map

Field Details

discoveryUri

protected String discoveryUri

useNonce

protected boolean useNonce

Whether an initial nonce should be to used initially for replay attack mitigation.

preferredJwsAlgorithm

protected String preferredJwsAlgorithm

The JWS algorithm to use forcefully when validating ID tokens. If none is defined, the first algorithm from metadata will be used.

maxClockSkew

protected String maxClockSkew

Clock skew in order to account for drift, when validating id tokens.

responseMode

protected String responseMode

The response mode specifies how the result of the authorization request is formatted. Possible values includes "query", "fragment", "form_post", or "web_message"

expireSessionWithToken

protected boolean expireSessionWithToken

Checks if sessions expire with token expiration.

tokenExpirationAdvance

protected String tokenExpirationAdvance

Default time period advance (in seconds) for considering an access token expired. This settings supports the java.time.Duration syntax. The format of the value will be PTnHnMnS, where n is the relevant hours, minutes or seconds part of the duration. Any fractional seconds are placed after a decimal point in the seconds section. If a section has a zero value, it is omitted. The hours, minutes and seconds will all have the same sign. Example values could be in the form of PT20S, PT15M, PT10H, PT6D, P2DT3H4M. If the value is set to 0 or never, the duration will be set to zero. If the value is blank, set to -1, or infinite, the value will effectively represent an unending duration.

Constructor Details

AbstractOIDCAuthModuleConf

public AbstractOIDCAuthModuleConf()

Method Details

getDiscoveryUri

public String getDiscoveryUri()

setDiscoveryUri

public void setDiscoveryUri(String discoveryUri)

isUseNonce

public boolean isUseNonce()

setUseNonce

public void setUseNonce(boolean useNonce)

getPreferredJwsAlgorithm

public String getPreferredJwsAlgorithm()

setPreferredJwsAlgorithm

public void setPreferredJwsAlgorithm(String preferredJwsAlgorithm)

getMaxClockSkew

public String getMaxClockSkew()

setMaxClockSkew

public void setMaxClockSkew(String maxClockSkew)

getResponseMode

public String getResponseMode()

setResponseMode

public void setResponseMode(String responseMode)

isExpireSessionWithToken

public boolean isExpireSessionWithToken()

setExpireSessionWithToken

public void setExpireSessionWithToken(boolean expireSessionWithToken)

getTokenExpirationAdvance

public String getTokenExpirationAdvance()

setTokenExpirationAdvance

public void setTokenExpirationAdvance(String tokenExpirationAdvance)