Package io.quarkus.oidc

Class OidcTenantConfig.Token

java.lang.Object
io.quarkus.oidc.OidcTenantConfig.Token
All Implemented Interfaces:
OidcTenantConfig.Token
Enclosing class:
OidcTenantConfig
@Deprecated(since="3.18") public static class OidcTenantConfig.Token extends Object implements OidcTenantConfig.Token
Deprecated.
use the TokenConfigBuilder builder

  • Field Details

    • issuer

      public Optional<String> issuer
      Deprecated.
      The expected issuer `iss` claim value. This property overrides the `issuer` property, which might be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to `any`, but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.

    • audience

      public Optional<List<String>> audience
      Deprecated.
      The expected audience `aud` claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured.

    • subjectRequired

      public boolean subjectRequired
      Deprecated.
      Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo `sub` claims must be present and match each other.

    • requiredClaims

      public Map<String,String> requiredClaims
      Deprecated.
      A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use SecurityIdentityAugmentor to verify claims of other types or complex claims.

    • tokenType

      public Optional<String> tokenType
      Deprecated.
      Expected token type

    • lifespanGrace

      public OptionalInt lifespanGrace
      Deprecated.
      Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.

    • age

      public Optional<Duration> age
      Deprecated.
      Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with `quarkus.oidc.token.lifespan-grace` to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (`exp`) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an `exp` claim. However, even if the current logout token is allowed to have no `exp` claim, the `exp` claim is still verified if the logout token contains it.

    • issuedAtRequired

      public boolean issuedAtRequired
      Deprecated.
      Require that the token includes a `iat` (issued at) claim Set this property to `false` if your JWT token does not contain an `iat` (issued at) claim. Note that ID token is always required to have an `iat` claim and therefore this property has no impact on the ID token verification process.

    • principalClaim

      public Optional<String> principalClaim
      Deprecated.
      Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.

    • refreshExpired

      public boolean refreshExpired
      Deprecated.
      Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type OidcTenantConfig.ApplicationType.WEB_APP. This property is enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not need to enable this property manually in this case.

    • refreshTokenTimeSkew

      public Optional<Duration> refreshTokenTimeSkew
      Deprecated.
      The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time, a refresh is going to happen.

    • forcedJwkRefreshInterval

      public Duration forcedJwkRefreshInterval
      Deprecated.
      The forced JWK set refresh interval in minutes.

    • authorizationScheme

      public String authorizationScheme
      Deprecated.
      HTTP Authorization header scheme.

    • signatureAlgorithm

      public Optional<OidcTenantConfig.SignatureAlgorithm> signatureAlgorithm
      Deprecated.
      Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.

    • decryptionKeyLocation

      public Optional<String> decryptionKeyLocation
      Deprecated.
      Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the `private_key_jwt` client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens.

    • allowJwtIntrospection

      public boolean allowJwtIntrospection
      Deprecated.
      Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to `true` by default for backward-compatibility reasons. It is planned that this default value will be changed to `false` in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.

    • requireJwtIntrospectionOnly

      public boolean requireJwtIntrospectionOnly
      Deprecated.
      Require that JWT tokens are only introspected remotely.

    • allowOpaqueTokenIntrospection

      public boolean allowOpaqueTokenIntrospection
      Deprecated.
      Allow the remote introspection of the opaque tokens. Set this property to `false` if only JWT tokens are expected.

    • customizerName

      public Optional<String> customizerName
      Deprecated.
      Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using TenantFeature qualifier when registering custom TokenCustomizer. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.

    • verifyAccessTokenWithUserInfo

      public Optional<Boolean> verifyAccessTokenWithUserInfo
      Deprecated.
      Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified.

    • binding

      OidcTenantConfig.Binding binding
      Deprecated.
      Token binding options

  • Constructor Details

    • Token

      public Token()
      Deprecated.

  • Method Details

    • fromIssuer

      public static OidcTenantConfig.Token fromIssuer(String issuer)
      Deprecated.

    • fromAudience

      public static OidcTenantConfig.Token fromAudience(String... audience)
      Deprecated.

    • isVerifyAccessTokenWithUserInfo

      public Optional<Boolean> isVerifyAccessTokenWithUserInfo()
      Deprecated.

    • setVerifyAccessTokenWithUserInfo

      public void setVerifyAccessTokenWithUserInfo(boolean verify)
      Deprecated.

    • getIssuer

      public Optional<String> getIssuer()
      Deprecated.

    • setIssuer

      public void setIssuer(String issuer)
      Deprecated.

    • getHeader

      public Optional<String> getHeader()
      Deprecated.

    • setHeader

      public void setHeader(String header)
      Deprecated.

    • getAudience

      public Optional<List<String>> getAudience()
      Deprecated.

    • setAudience

      public void setAudience(List<String> audience)
      Deprecated.

    • getLifespanGrace

      public OptionalInt getLifespanGrace()
      Deprecated.

    • setLifespanGrace

      public void setLifespanGrace(int lifespanGrace)
      Deprecated.

    • getPrincipalClaim

      public Optional<String> getPrincipalClaim()
      Deprecated.

    • setPrincipalClaim

      public void setPrincipalClaim(String principalClaim)
      Deprecated.

    • isRefreshExpired

      public boolean isRefreshExpired()
      Deprecated.

    • setRefreshExpired

      public void setRefreshExpired(boolean refreshExpired)
      Deprecated.

    • getForcedJwkRefreshInterval

      public Duration getForcedJwkRefreshInterval()
      Deprecated.

    • setForcedJwkRefreshInterval

      public void setForcedJwkRefreshInterval(Duration forcedJwkRefreshInterval)
      Deprecated.

    • getTokenType

      public Optional<String> getTokenType()
      Deprecated.

    • setTokenType

      public void setTokenType(String tokenType)
      Deprecated.

    • getRefreshTokenTimeSkew

      public Optional<Duration> getRefreshTokenTimeSkew()
      Deprecated.

    • setRefreshTokenTimeSkew

      public void setRefreshTokenTimeSkew(Duration refreshTokenTimeSkew)
      Deprecated.

    • isAllowJwtIntrospection

      public boolean isAllowJwtIntrospection()
      Deprecated.

    • setAllowJwtIntrospection

      public void setAllowJwtIntrospection(boolean allowJwtIntrospection)
      Deprecated.

    • isAllowOpaqueTokenIntrospection

      public boolean isAllowOpaqueTokenIntrospection()
      Deprecated.

    • setAllowOpaqueTokenIntrospection

      public void setAllowOpaqueTokenIntrospection(boolean allowOpaqueTokenIntrospection)
      Deprecated.

    • getBinding

      public OidcTenantConfig.Binding getBinding()
      Deprecated.

    • binding

      public OidcTenantConfig.Binding binding()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Token certificate binding options.
      Specified by:
      binding in interface OidcTenantConfig.Token

    • getAge

      public Optional<Duration> getAge()
      Deprecated.

    • setAge

      public void setAge(Duration age)
      Deprecated.

    • isIssuedAtRequired

      public boolean isIssuedAtRequired()
      Deprecated.

    • setIssuedAtRequired

      public void setIssuedAtRequired(boolean issuedAtRequired)
      Deprecated.

    • getDecryptionKeyLocation

      public Optional<String> getDecryptionKeyLocation()
      Deprecated.

    • setDecryptionKeyLocation

      public void setDecryptionKeyLocation(String decryptionKeyLocation)
      Deprecated.

    • getRequiredClaims

      public Map<String,String> getRequiredClaims()
      Deprecated.

    • setRequiredClaims

      public void setRequiredClaims(Map<String,String> requiredClaims)
      Deprecated.

    • isRequireJwtIntrospectionOnly

      public boolean isRequireJwtIntrospectionOnly()
      Deprecated.

    • setRequireJwtIntrospectionOnly

      public void setRequireJwtIntrospectionOnly(boolean requireJwtIntrospectionOnly)
      Deprecated.

    • getSignatureAlgorithm

      public Optional<OidcTenantConfig.SignatureAlgorithm> getSignatureAlgorithm()
      Deprecated.

    • setSignatureAlgorithm

      public void setSignatureAlgorithm(OidcTenantConfig.SignatureAlgorithm signatureAlgorithm)
      Deprecated.

    • getCustomizerName

      public Optional<String> getCustomizerName()
      Deprecated.

    • setCustomizerName

      public void setCustomizerName(String customizerName)
      Deprecated.

    • isSubjectRequired

      public boolean isSubjectRequired()
      Deprecated.

    • setSubjectRequired

      public void setSubjectRequired(boolean subjectRequired)
      Deprecated.

    • getAuthorizationScheme

      public String getAuthorizationScheme()
      Deprecated.

    • setAuthorizationScheme

      public void setAuthorizationScheme(String authorizationScheme)
      Deprecated.

    • issuer

      public Optional<String> issuer()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      The expected issuer `iss` claim value. This property overrides the `issuer` property, which might be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to `any`, but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.
      Specified by:
      issuer in interface OidcTenantConfig.Token

    • audience

      public Optional<List<String>> audience()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      The expected audience `aud` claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured.
      Specified by:
      audience in interface OidcTenantConfig.Token

    • subjectRequired

      public boolean subjectRequired()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo `sub` claims must be present and match each other.
      Specified by:
      subjectRequired in interface OidcTenantConfig.Token

    • requiredClaims

      public Map<String,String> requiredClaims()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use SecurityIdentityAugmentor to verify claims of other types or complex claims.
      Specified by:
      requiredClaims in interface OidcTenantConfig.Token

    • tokenType

      public Optional<String> tokenType()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Expected token type
      Specified by:
      tokenType in interface OidcTenantConfig.Token

    • lifespanGrace

      public OptionalInt lifespanGrace()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.
      Specified by:
      lifespanGrace in interface OidcTenantConfig.Token

    • age

      public Optional<Duration> age()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with `quarkus.oidc.token.lifespan-grace` to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (`exp`) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an `exp` claim. However, even if the current logout token is allowed to have no `exp` claim, the `exp` claim is still verified if the logout token contains it.
      Specified by:
      age in interface OidcTenantConfig.Token

    • issuedAtRequired

      public boolean issuedAtRequired()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Require that the token includes a `iat` (issued at) claim Set this property to `false` if your JWT token does not contain an `iat` (issued at) claim. Note that ID token is always required to have an `iat` claim and therefore this property has no impact on the ID token verification process.
      Specified by:
      issuedAtRequired in interface OidcTenantConfig.Token

    • principalClaim

      public Optional<String> principalClaim()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.
      Specified by:
      principalClaim in interface OidcTenantConfig.Token

    • refreshExpired

      public boolean refreshExpired()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type OidcTenantConfig.ApplicationType.WEB_APP. This property is enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not need to enable this property manually in this case.
      Specified by:
      refreshExpired in interface OidcTenantConfig.Token

    • refreshTokenTimeSkew

      public Optional<Duration> refreshTokenTimeSkew()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time, a refresh is going to happen.
      Specified by:
      refreshTokenTimeSkew in interface OidcTenantConfig.Token

    • forcedJwkRefreshInterval

      public Duration forcedJwkRefreshInterval()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      The forced JWK set refresh interval in minutes.
      Specified by:
      forcedJwkRefreshInterval in interface OidcTenantConfig.Token

    • header

      public Optional<String> header()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Custom HTTP header that contains a bearer token. This option is valid only when the application is of type OidcTenantConfig.ApplicationType.SERVICE.
      Specified by:
      header in interface OidcTenantConfig.Token

    • authorizationScheme

      public String authorizationScheme()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      HTTP Authorization header scheme.
      Specified by:
      authorizationScheme in interface OidcTenantConfig.Token

    • signatureAlgorithm

      public Optional<OidcTenantConfig.SignatureAlgorithm> signatureAlgorithm()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.
      Specified by:
      signatureAlgorithm in interface OidcTenantConfig.Token

    • decryptionKeyLocation

      public Optional<String> decryptionKeyLocation()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the `private_key_jwt` client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens.
      Specified by:
      decryptionKeyLocation in interface OidcTenantConfig.Token

    • allowJwtIntrospection

      public boolean allowJwtIntrospection()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to `true` by default for backward-compatibility reasons. It is planned that this default value will be changed to `false` in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.
      Specified by:
      allowJwtIntrospection in interface OidcTenantConfig.Token

    • requireJwtIntrospectionOnly

      public boolean requireJwtIntrospectionOnly()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Require that JWT tokens are only introspected remotely.
      Specified by:
      requireJwtIntrospectionOnly in interface OidcTenantConfig.Token

    • allowOpaqueTokenIntrospection

      public boolean allowOpaqueTokenIntrospection()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Allow the remote introspection of the opaque tokens. Set this property to `false` if only JWT tokens are expected.
      Specified by:
      allowOpaqueTokenIntrospection in interface OidcTenantConfig.Token

    • customizerName

      public Optional<String> customizerName()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using TenantFeature qualifier when registering custom TokenCustomizer. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.
      Specified by:
      customizerName in interface OidcTenantConfig.Token

    • verifyAccessTokenWithUserInfo

      public Optional<Boolean> verifyAccessTokenWithUserInfo()
      Deprecated.
      Description copied from interface: OidcTenantConfig.Token
      Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified.
      Specified by:
      verifyAccessTokenWithUserInfo in interface OidcTenantConfig.Token