Package com.c4_soft.springaddons.security.oidc.starter.properties

Class SpringAddonsOidcClientProperties

java.lang.Object

com.c4_soft.springaddons.security.oidc.starter.properties.SpringAddonsOidcClientProperties

public class SpringAddonsOidcClientProperties
extends Object

Auto-configuration for an OAuth2 client (secured with session, not access token) Security(Web)FilterChain with @Order(Ordered.LOWEST_PRECEDENCE - 1). Typical use-cases are spring-cloud-gateway used as BFF and applications with Thymeleaf or another server-side rendering framework. Default configuration includes: enabled sessions, CSRF protection, "oauth2Login", "logout". securityMatchers must be set for this filter-chain @Bean and its dependencies to be defined. Properties defined here are a complement for spring.security.oauth2.client.* (which are required when enabling spring-addons client filter-chain).

Author:

Jerome Wacongne ch4mp@c4-soft.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpringAddonsOidcClientProperties.BackChannelLogoutProperties
static class	SpringAddonsOidcClientProperties.InvalidSessionProperties
static class	SpringAddonsOidcClientProperties.OAuth2LogoutProperties	Logout properties for OpenID Providers which do not implement the RP-Initiated Logout spec
static class	SpringAddonsOidcClientProperties.OAuth2RedirectionProperties
static class	SpringAddonsOidcClientProperties.RequestParam	Request parameter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	POST_AUTHENTICATION_FAILURE_CAUSE_ATTRIBUTE
static final String	POST_AUTHENTICATION_FAILURE_URI_HEADER
static final String	POST_AUTHENTICATION_FAILURE_URI_PARAM
static final String	POST_AUTHENTICATION_FAILURE_URI_SESSION_ATTRIBUTE
static final String	POST_AUTHENTICATION_SUCCESS_URI_HEADER
static final String	POST_AUTHENTICATION_SUCCESS_URI_PARAM
static final String	POST_AUTHENTICATION_SUCCESS_URI_SESSION_ATTRIBUTE
static final String	POST_LOGOUT_SUCCESS_URI_HEADER
static final String	POST_LOGOUT_SUCCESS_URI_PARAM
static final String	RESPONSE_STATUS_HEADER

Constructor Summary

Constructors

Constructor	Description
SpringAddonsOidcClientProperties()

Method Summary

Modifier and Type	Method	Description
org.springframework.util.MultiValueMap<String,String>	getExtraAuthorizationParameters(String registrationId)
org.springframework.util.MultiValueMap<String,String>	getExtraTokenParameters(String registrationId)
Optional<SpringAddonsOidcClientProperties.OAuth2LogoutProperties>	getLogoutProperties(String clientRegistrationId)
List<Pattern>	getPostLoginAllowedUriPatterns()
URI	getPostLoginRedirectHost()
URI	getPostLoginRedirectUri()
List<Pattern>	getPostLogoutAllowedUriPatterns()
URI	getPostLogoutRedirectHost()
URI	getPostLogoutRedirectUri()

Methods inherited from class java.lang.Object

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

Field Details

RESPONSE_STATUS_HEADER

public static final String RESPONSE_STATUS_HEADER

See Also:

• Constant Field Values

POST_AUTHENTICATION_SUCCESS_URI_HEADER

public static final String POST_AUTHENTICATION_SUCCESS_URI_HEADER

See Also:

• Constant Field Values

POST_AUTHENTICATION_SUCCESS_URI_PARAM

public static final String POST_AUTHENTICATION_SUCCESS_URI_PARAM

See Also:

• Constant Field Values

POST_AUTHENTICATION_SUCCESS_URI_SESSION_ATTRIBUTE

public static final String POST_AUTHENTICATION_SUCCESS_URI_SESSION_ATTRIBUTE

See Also:

• Constant Field Values

POST_AUTHENTICATION_FAILURE_URI_HEADER

public static final String POST_AUTHENTICATION_FAILURE_URI_HEADER

See Also:

• Constant Field Values

POST_AUTHENTICATION_FAILURE_URI_PARAM

public static final String POST_AUTHENTICATION_FAILURE_URI_PARAM

See Also:

• Constant Field Values

POST_AUTHENTICATION_FAILURE_URI_SESSION_ATTRIBUTE

public static final String POST_AUTHENTICATION_FAILURE_URI_SESSION_ATTRIBUTE

See Also:

• Constant Field Values

POST_AUTHENTICATION_FAILURE_CAUSE_ATTRIBUTE

public static final String POST_AUTHENTICATION_FAILURE_CAUSE_ATTRIBUTE

See Also:

• Constant Field Values

POST_LOGOUT_SUCCESS_URI_HEADER

public static final String POST_LOGOUT_SUCCESS_URI_HEADER

See Also:

• Constant Field Values

POST_LOGOUT_SUCCESS_URI_PARAM

public static final String POST_LOGOUT_SUCCESS_URI_PARAM

See Also:

• Constant Field Values

Constructor Details

SpringAddonsOidcClientProperties

public SpringAddonsOidcClientProperties()

Method Details

getPostLoginAllowedUriPatterns

public List<Pattern> getPostLoginAllowedUriPatterns()

getPostLogoutAllowedUriPatterns

public List<Pattern> getPostLogoutAllowedUriPatterns()

getPostLoginRedirectHost

public URI getPostLoginRedirectHost()

getPostLoginRedirectUri

public URI getPostLoginRedirectUri()

getPostLogoutRedirectHost

public URI getPostLogoutRedirectHost()

getPostLogoutRedirectUri

public URI getPostLogoutRedirectUri()

getExtraAuthorizationParameters

public org.springframework.util.MultiValueMap<String,String> getExtraAuthorizationParameters(String registrationId)

getExtraTokenParameters

public org.springframework.util.MultiValueMap<String,String> getExtraTokenParameters(String registrationId)

getLogoutProperties

public Optional<SpringAddonsOidcClientProperties.OAuth2LogoutProperties> getLogoutProperties(String clientRegistrationId)