Common configuration

Authenticator commons

All authenticators are configured in the same way and share some common configuration properties.

Authenticator

Properties

Name	Description	Default value	Mandatory
id	Unique identifier of authenticator	N/A
type	Authenticator type (class name) or alias	N/A
config	Authenticator configuration object (optional)	{}

Config

Properties

Name	Description	Default value	Mandatory
context_path	The HTTP context path that the authenticator will be bound to. Use this property when configuring standalone authenticators. (mandatory unless base_path is specified)	N/A
base_path	Prefix of the context path that the authenticator will be bound to. This value is combined with the authenticator id to form a complete context path. Use this property when configuring chain and selectors. (mandatory unless context_path is specified)	N/A
success_location	Target location to where the user agent will be redirected when authentication has succeeded. Use this property when configuring standalone or top level chain authenticators.	N/A
failure_location	The target location to where the user agent will be redirected when authentication fails. Use this property when configuring standalone or top level chain authenticators.	N/A
webroot_dir	Path to directory serving as authenticator web root containing view resources.	N/A
overlay_dir	Path to directory serving as authenticator overlay containing custom view resources. Resources in overlay has precedence to resources in web root, which means that if a resource exists in both, the one from overlay will be served.	N/A
header_whitelist	List of HTTP headers to include in authentication context. This list is combined with the default list to form the complete header whitelist.	""

Advanced config

Advanced configuration properties are optional.

Name	Description	Default
context_paths	Array of context paths used for binding an authenticator to multiple context paths .
context_expr	Context path regex.
http_session_cookie_name	Name of session cookie to use for a specific authenticator	"__session"
http_session_timeout_ms	Custom HTTP session timeout in ms. When sharing context with other authenticators the value used is the value set by the first point of entry, session creation.	1800000
http_request_body_limit	Max size of the request body allowed (Default: 2MB)	2097152
http_form_attr_limit	Max size of a form. (Default: 0,5MB)	524288
header_whitelist_default	Default list of HTTP headers to include in authentication context.	"Forwarded,X-Forwarded-For,X-Forwarded-Host,X-Forwarded-Proto,X-SSL-Client-Cert,X-SSL-Client-Chain,X-SSL-Client-Subject,X-SSL-Client-Verify,X-SSL-Protocol"
standalone	Flag forcing authenticator to operate in standalone mode or not. A standalone authenticator is not part of a chain. By default this value is calculated based on current configuration.