Page History
Authentication providers
...
Note |
---|
The Blueriq Runtime delivers an out-of-the-box in-memory authentication provider. These default implementations should only be used for development purposes as they may store the credentials in plain text on the filesystem. |
Runtime configuration
The Runtime reads the authentication configuration from Spring environment properties, under the covers Spring Security is used. In the Runtime one Spring Security AuthenticationManager bean named blueriqAuthenticationManager
is registered, defined in
com.aquima.web.boot.SecurityConfiguration
...
. An anonymous authentication provider is added by default (hardcoded), this is used for anonymous access.
Blueriq supports an in-memory
authentication provider type and a customBean
authentication provider type for custom authentication needs. Multiple authentication providers can be chained. Every authentication provider
...
must have a unique name
...
, this name is also used in
...
the auth-providers-chain
...
property to determine the order of the authentication providers in the chain.
...
Properties
...
Like all security properties, the authentication properties are prefixed
...
with blueriq.security
...
An in-memory authentication provider
In the application.properties file two properties are expected. Example of an 'in-memory' authentication provider configuration:
...
. For every authentication provider a type must be specified,
it can be in-memory, customBean, LDAP, openid-connect
or jwt
. Checkout these pages on how it works:
Children Display |
---|
Chain: Specifying which authentication providers to use
Only authentication providers specified in the blueriq.security.auth-providers-chain
property will be used by the Blueriq Runtime. The providers will be tried in the order they are specified in the chain. A warning will appear in the Blueriq Runtime log when no authentication providers are specified in the chain.
Example of authentication providers chain using two out of three specified providers:
Code Block | ||
---|---|---|
| ||
blueriq.security.auth-providers.local01.type=in-memory
blueriq.security.auth-providers.local01.users.location=users.properties
|
...
blueriq.security |
...
.auth-providers |
...
Each authentication provider has a type, it can be "in-memory" or "customBean".
An in-memory authentication provider also needs the name of the property file. This is specified by the users.location property.
...
Code Block |
---|
admin=welcome,dcm |
A customBean authentication provider
...
.myAuthProvider01.type=customBean blueriq.security.auth-providers. |
...
myAuthProvider02.type=customBean |
...
An implementation example:
...
|
...
# add any provider to this chain, can be multiple ldap / in-memory / customBean / openid-connect, or a single jwt chain
blueriq.security.auth-providers-chain=myAuthProvider01,local01 |
Logout
Example request:
Code Block | ||
---|---|---|
| ||
POST https://localhost/runtime/api/v1/logout HTTP/1.1
|
The response will be a simple 204 status code.
For version 2 of the API, the logout endpoint can support redirect URL parameter, and if the parameter is set then the endpoint will send a 302 status code with the location to the redirect parameter instead of the normal 204 status code.
Example request without redirect URL:
Code Block | ||
---|---|---|
| ||
POST https://localhost/runtime/api/v2/logout HTTP/1.1
|
The response will be a simple 204 status code.
Example request with redirect URL:
Code Block | ||
---|---|---|
| ||
POST https://localhost/runtime/api/v2/logout?redirect_uri=https://example.frontend.com/logged-out.html HTTP/1.1
|
The response will be a 302 status code and the location will be set to the value received in the redirect_uri
parameter:
Code Block |
---|
HTTP/1.1 302 Found
Location: https://example.frontend.com/logged-out.html
|
If OpenID Connect is used in the Runtime and SSO Logout is enabled, then Runtime will redirect to the identity provider's logout endpoint and send the redirect_uri
parameter to the identity provider.
Code Block |
---|
HTTP/1.1 302 Found
Location: https://identity.example.com/sso/logout?post_logout_redirect_uri=https://example.frontend.com/logged-out.html |
After the identity provider logs out the user, it will redirect to the original URL:
Code Block |
---|
HTTP/1.1 302 Found
Location: https://example.frontend.com/logged-out.html |
Logout URL whitelist
For security reasons a property where all the allowed redirect URLs can be specified:
Code Block |
---|
blueriq.security.logout-redirect-url-whitelist = url1, url2 |
Note |
---|
The URLs specified in the whitelist are case sensitive and represent only the prefix of the URL. |
Warning |
---|
If the login type is set to |
Example of authentication providers chaining:
...