OidcConfig (Helidon 0.10.4 API)

java.lang.Object
- io.helidon.security.oidc.common.OidcConfig

public final class OidcConfig
extends java.lang.Object

Configuration of OIDC usable from all resources that utilize OIDC specification, such as security provider, web server extension and IDCS connectivity.

Some of the configuration options below use "resource" type. The following configuration can be used for a resource (example for oidc-metadata key): oidc-metadata-path: "path/on/filesystem" oidc-metadata-resource-path: "class-path/resource" oidc-metadata-url: "URI on the net" oidc-metadata-content-plain: "Value of the resource in plain text" oidc-metadata-content: "Value in base64 encoded bytes"

Configuration options required (under security.providers[].${name}):

Mandatory configuration parameters
key	description
client-id	Client ID as generated by OIDC server
client-secret	Client secret as generated by OIDC server
identity-uri	URI of the identity server, base used to retrieve OIDC metadata
frontend-uri	Fully URI of the frontend for redirects back from OIDC server (e.g. http://myserver/myApp)

Optional configuration parameters
key	default value	description
proxy-protocol	http	Proxy protocol to use when proxy is used.
proxy-host	null	Proxy host to use. When defined, triggers usage of proxy for HTTP requests.
proxy-port	80	Port of the proxy server to use
redirect-uri	/oidc/redirect	URI to register web server component on, used by the OIDC server to redirect authorization requests to after a user logs in or approves scopes. Note that usually the redirect URI configured here must be the same one as configured on OIDC server.
scope-audience	empty string	Audience of the scope required by this application. This is prefixed to the scope name when requesting scopes from the identity server.
cookie-use	true	Whether to use cookie to store JWT. If used, redirects happen only in case the user is not authenticated or has insufficient scopes
cookie-name	JSESSIONID	Name of the cookie
cookie-domain	null	Domain the cookie is valid for. Not used by default
cookie-path	/	Path the cookie is valid for.
cookie-max-age-seconds	null	When using cookie, used to set MaxAge attribute of the cookie, defining how long the cookie is valid.
cookie-http-only	true	When using cookie, if set to true, the HttpOnly attribute will be configured .
cookie-secure	false	When using cookie, if set to true, the Secure attribute will be configured .
cookie-same-site	Strict	When using cookie, used to set the SameSite cookie value. Can be "Strict" or "Lax"
query-param-use	false	Whether to expect JWT in a query parameter
query-param-name	accessToken	Name of a query parameter that contains the JWT token when parameter is used.
header-use	false	Whether to expect JWT in a header field.
header-token	"Authorization" header with prefix "bearer "	A `TokenHandler` configuration to process header containing a JWT
oidc-metadata-well-known	true	If set to true, metadata will be loaded from default (well known) location, unless it is explicitly defined using oidc-metadata-resource. If set to false, it would not be loaded even if oidc-metadata-resource is not defined. In such a case all URIs must be explicitly defined (e.g. token-endpoint-uri).
oidc-metadata	identity-uri/.well-known/openid-configuration	Resource configuration for OIDC Metadata containing endpoints to various identity services, as well as information about the identity server
token-endpoint-uri	token_endpoint in OIDC metadata, or identity-url/oauth2/v1/token if not available	URI of a token endpoint used to obtain a JWT based on the authentication code.
authorization-endpoint-uri	"authorization_endpoint" in OIDC metadata, or identity-uri/oauth2/v1/authorize if not available	URI of an authorization endpoint used to redirect users to for logging-in.
validate-with-jwk	true	When true - validate against jwk defined by "sign-jwk", when false validate JWT through OIDC Server endpoint "validation-endpoint-uri"
sign-jwk	"jwks-uri" in OIDC metadata, or identity-uri/admin/v1/SigningCert/jwk if not available, only needed when jwt validation is done by us	A resource pointing to JWK with public keys of signing certificates used to validate JWT
introspect-endpoint-uri	"introspection_endpoint" in OIDC metadata, or identity-uri/oauth2/v1/introspect	When validate-with-jwk is set to "false", this is the endpoint used
base-scopes		Configure scopes to be requested by default. If the scope has a qualifier, it must be included here
redirect	true	Whether to redirect to identity server when authentication failed.
realm	Helidon	Realm returned in HTTP response if redirect is not enabled or possible.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OidcConfig.Builder
A fluent API Builder to build instances of OidcConfig.

Nested Classes
Modifier and Type	Class	Description
`static class`	`OidcConfig.Builder`	A fluent API `Builder` to build instances of `OidcConfig`.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String PARAM_HEADER_NAME
Default name of the header we expect JWT in.

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`PARAM_HEADER_NAME`	Default name of the header we expect JWT in.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`javax.ws.rs.client.Client`	`appClient()`	Client with configured proxy and security of this OIDC client.
`java.lang.String`	`audience()`	Expected token audience.
`java.lang.String`	`authorizationEndpointUri()`	Authorization endpoint.
`java.lang.String`	`baseScopes()`	Base scopes to require from OIDC server.
`static OidcConfig.Builder`	`builder()`	Create a builder to programmatically construct OIDC configuration.
`java.lang.String`	`clientId()`	Client id of this client.
`java.lang.String`	`cookieName()`	Cookie name.
`java.lang.String`	`cookieOptions()`	Additional options of the cookie to use.
`java.lang.String`	`cookieValuePrefix()`	Prefix of a cookie header formed by name and "=".
`static OidcConfig`	`create(Config config)`	Create a new instance from `Config`.
`static OidcConfig`	`from(Config config)`	Deprecated.
`javax.ws.rs.client.Client`	`generalClient()`	Client with configured proxy with no security.
`TokenHandler`	`headerHandler()`	`TokenHandler` to extract header information from request.
`java.net.URI`	`identityUri()`	Identity server URI.
`javax.ws.rs.client.WebTarget`	`introspectEndpoint()`	Token introspection endpoint.
`java.lang.String`	`issuer()`	Token issuer.
`java.lang.String`	`paramName()`	Query parameter name.
`java.lang.String`	`realm()`	Realm to use for WWW-Authenticate response (if needed).
`java.lang.String`	`redirectUri()`	Redirection URI.
`java.lang.String`	`redirectUriWithHost()`	Redirect URI with host information.
`java.lang.String`	`scopeAudience()`	Audience URI of custom scopes.
`boolean`	`shouldRedirect()`	Whether to redirect to identity server if user is not authenticated.
`JwkKeys`	`signJwk()`	JWK used for signature validation.
`javax.ws.rs.client.WebTarget`	`tokenEndpoint()`	Token endpoint of the OIDC server.
`boolean`	`useCookie()`	Whether to use cooke to get the information from request.
`boolean`	`useHeader()`	Whether to use HTTP header to get the information from request.
`boolean`	`useParam()`	Whether to use query parameter to get the information from request.
`boolean`	`validateJwtWithJwk()`	Whether to validate JWT with JWK information (e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_HEADER_NAME
```
public static final java.lang.String PARAM_HEADER_NAME
```
    Default name of the header we expect JWT in.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - builder
```
public static OidcConfig.Builder builder()
```
    Create a builder to programmatically construct OIDC configuration.
    
    Returns:
    
    a new builder instance usable for fluent API
  - create
```
public static OidcConfig create(Config config)
```
    Create a new instance from Config. The config instance has to be on the node containing keys used by this class (e.g. client-id).
    
    Parameters:
    
    config - configuration used to obtain OIDC integration values
    
    Returns:
    
    a new instance of this class configured from provided config
  - from
```
@Deprecated
public static OidcConfig from(Config config)
```
    Deprecated.
    
    Only for use with Config.as(Class).
    
    Parameters:
    
    config - config instance to load from
    
    Returns:
    
    a new instance of this class configured from config
  - signJwk
```
public JwkKeys signJwk()
```
    JWK used for signature validation.
    
    Returns:
    
    set of keys used use to verify tokens
    
    See Also:
    
    OidcConfig.Builder.signJwk(JwkKeys)
  - redirectUri
```
public java.lang.String redirectUri()
```
    Redirection URI.
    
    Returns:
    
    uri the OIDC server redirects back to
    
    See Also:
    
    OidcConfig.Builder.redirectUri(String)
  - tokenEndpoint
```
public javax.ws.rs.client.WebTarget tokenEndpoint()
```
    Token endpoint of the OIDC server.
    
    Returns:
    
    target the endpoint is on
    
    See Also:
    
    OidcConfig.Builder.tokenEndpointUri(URI)
  - useParam
```
public boolean useParam()
```
    Whether to use query parameter to get the information from request.
    
    Returns:
    
    if query parameter should be used
    
    See Also:
    
    OidcConfig.Builder.useParam(Boolean)
  - paramName
```
public java.lang.String paramName()
```
    Query parameter name.
    
    Returns:
    
    name of the query parameter to use
    
    See Also:
    
    OidcConfig.Builder.paramName(String)
  - useCookie
```
public boolean useCookie()
```
    Whether to use cooke to get the information from request.
    
    Returns:
    
    if cookie should be used
    
    See Also:
    
    OidcConfig.Builder.useCookie(Boolean)
  - cookieName
```
public java.lang.String cookieName()
```
    Cookie name.
    
    Returns:
    
    name of the cookie to use
    
    See Also:
    
    OidcConfig.Builder.cookieName(String)
  - cookieOptions
```
public java.lang.String cookieOptions()
```
    Additional options of the cookie to use.
    
    Returns:
    
    cookie options to use in cookie string
    
    See Also:
    
    OidcConfig.Builder.cookieHttpOnly(Boolean), OidcConfig.Builder.cookieDomain(String)
  - useHeader
```
public boolean useHeader()
```
    Whether to use HTTP header to get the information from request.
    
    Returns:
    
    if header should be used
    
    See Also:
    
    OidcConfig.Builder.useHeader(Boolean)
  - headerHandler
```
public TokenHandler headerHandler()
```
    TokenHandler to extract header information from request.
    
    Returns:
    
    handler to extract header
    
    See Also:
    
    OidcConfig.Builder.headerTokenHandler(TokenHandler)
  - cookieValuePrefix
```
public java.lang.String cookieValuePrefix()
```
    Prefix of a cookie header formed by name and "=".
    
    Returns:
    
    prefix of cookie value
    
    See Also:
    
    OidcConfig.Builder.cookieName(String)
  - scopeAudience
```
public java.lang.String scopeAudience()
```
    Audience URI of custom scopes.
    
    Returns:
    
    scope audience
    
    See Also:
    
    OidcConfig.Builder.scopeAudience(String)
  - authorizationEndpointUri
```
public java.lang.String authorizationEndpointUri()
```
    Authorization endpoint.
    
    Returns:
    
    authorization endpoint uri as a string
    
    See Also:
    
    OidcConfig.Builder.authorizationEndpointUri(URI)
  - clientId
```
public java.lang.String clientId()
```
    Client id of this client.
    
    Returns:
    
    client id
    
    See Also:
    
    OidcConfig.Builder.clientId(String)
  - redirectUriWithHost
```
public java.lang.String redirectUriWithHost()
```
    Redirect URI with host information.
    
    Returns:
    
    redirect URI
    
    See Also:
    
    OidcConfig.Builder.redirectUri(String)
  - baseScopes
```
public java.lang.String baseScopes()
```
    Base scopes to require from OIDC server.
    
    Returns:
    
    base scopes
    
    See Also:
    
    OidcConfig.Builder.baseScopes(String)
  - validateJwtWithJwk
```
public boolean validateJwtWithJwk()
```
    Whether to validate JWT with JWK information (e.g. verify signatures locally).
    
    Returns:
    
    if we should validate JWT with JWK
    
    See Also:
    
    OidcConfig.Builder.validateJwtWithJwk(Boolean)
  - introspectEndpoint
```
public javax.ws.rs.client.WebTarget introspectEndpoint()
```
    Token introspection endpoint.
    
    Returns:
    
    introspection endpoint
    
    See Also:
    
    OidcConfig.Builder.introspectEndpointUri(URI)
  - issuer
```
public java.lang.String issuer()
```
    Token issuer.
    
    Returns:
    
    token issuer
    
    See Also:
    
    OidcConfig.Builder.issuer(String)
  - audience
```
public java.lang.String audience()
```
    Expected token audience.
    
    Returns:
    
    audience
    
    See Also:
    
    OidcConfig.Builder.audience(String)
  - identityUri
```
public java.net.URI identityUri()
```
    Identity server URI.
    
    Returns:
    
    identity server URI
    
    See Also:
    
    OidcConfig.Builder.identityUri(URI)
  - generalClient
```
public javax.ws.rs.client.Client generalClient()
```
    Client with configured proxy with no security.
    
    Returns:
    
    client for general use.
  - appClient
```
public javax.ws.rs.client.Client appClient()
```
    Client with configured proxy and security of this OIDC client.
    
    Returns:
    
    client for communication with OIDC server
  - shouldRedirect
```
public boolean shouldRedirect()
```
    Whether to redirect to identity server if user is not authenticated.
    
    Returns:
    
    whether to redirect, defaults to true
  - realm
```
public java.lang.String realm()
```
    Realm to use for WWW-Authenticate response (if needed).
    
    Returns:
    
    realm name

Class OidcConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARAM_HEADER_NAME

Method Detail

builder

create

from

signJwk

redirectUri

tokenEndpoint

useParam

paramName

useCookie

cookieName

cookieOptions

useHeader

headerHandler

cookieValuePrefix

scopeAudience

authorizationEndpointUri

clientId

redirectUriWithHost

baseScopes

validateJwtWithJwk

introspectEndpoint

issuer

audience

identityUri

generalClient

appClient

shouldRedirect

realm