Package io.quarkus.oidc.runtime

Class OidcUtils

java.lang.Object

io.quarkus.oidc.runtime.OidcUtils

public final class OidcUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_TOKEN_COOKIE_SUFFIX
static final String	ANNOTATION_BASED_TENANT_RESOLUTION_ENABLED
(package private) static final String	CODE_ACCESS_TOKEN_FAILURE
(package private) static final String	CODE_ACCESS_TOKEN_RESULT
(package private) static final String	COMMA
static final String	CONFIG_METADATA_ATTRIBUTE
static final String	DEFAULT_SCOPE_SEPARATOR
static final String	DEFAULT_TENANT_ID
(package private) static final BlockingTaskRunner<Void>	deleteTokensRequestContext
static final String	INTROSPECTION_ATTRIBUTE
static final Integer	MAX_COOKIE_VALUE_LENGTH
static final String	POST_LOGOUT_COOKIE_NAME
static final String	QUARKUS_IDENTITY_EXPIRE_TIME
static final String	REFRESH_TOKEN_COOKIE_SUFFIX
static final String	SESSION_AT_COOKIE_NAME
static final String	SESSION_COOKIE_CHUNK
static final String	SESSION_COOKIE_CHUNK_START
static final String	SESSION_COOKIE_NAME
static final String	SESSION_RT_COOKIE_NAME
static final String	STATE_COOKIE_NAME
static final String	STATE_COOKIE_RESTORE_PATH
static final String	TENANT_ID_ATTRIBUTE
static final String	TENANT_ID_SET_BY_ANNOTATION
static final String	TENANT_ID_SET_BY_SESSION_COOKIE
static final String	TENANT_ID_SET_BY_STATE_COOKIE
(package private) static final String	UNDERSCORE
static final String	USER_INFO_ATTRIBUTE
(package private) static final io.smallrye.mutiny.Uni<Void>	VOID_UNI

Method Summary

Modifier and Type	Method	Description
(package private) static void	addTokenScopesAsPermissions(QuarkusSecurityIdentity.Builder builder, Collection<String> scopes)
static String	base64UrlDecode(String encodedContent)
static boolean	cacheUserInfoInIdToken(DefaultTenantConfigResolver resolver, OidcTenantConfig oidcConfig)
static io.vertx.core.http.impl.ServerCookie	createCookie(io.vertx.ext.web.RoutingContext context, OidcTenantConfig oidcConfig, String name, String value, long maxAge)
static SecretKey	createSecretKeyFromDigest(byte[] secretBytes)
static io.vertx.core.json.JsonObject	decodeJwtContent(String jwt)
static String	decodeJwtContentAsString(String jwt)
static io.vertx.core.json.JsonObject	decodeJwtHeaders(String jwt)
static String	decodeJwtHeadersAsString(String jwt)
static io.vertx.core.json.JsonObject	decryptJson(String jweString, Key key)
static String	decryptString(String jweString, Key key)
static String	decryptString(String jweString, Key key, io.smallrye.jwt.algorithm.KeyEncryptionAlgorithm algorithm)
static String	encodeScopes(OidcTenantConfig oidcConfig)
static String	encryptJson(io.vertx.core.json.JsonObject json, SecretKey key)
static String	encryptString(String jweString, SecretKey key)
static String	encryptString(String jweString, SecretKey key, io.smallrye.jwt.algorithm.KeyEncryptionAlgorithm algorithm)
(package private) static String	extractBearerToken(io.vertx.ext.web.RoutingContext context, OidcTenantConfig oidcConfig)
static List<String>	findRoles(String clientId, OidcTenantConfig.Roles rolesConfig, io.vertx.core.json.JsonObject json)
static List<String>	getAllScopes(OidcTenantConfig oidcConfig)
static String	getCookieSuffix(OidcTenantConfig oidcConfig)
static io.smallrye.mutiny.Uni<io.vertx.core.MultiMap>	getFormUrlEncodedData(io.vertx.ext.web.RoutingContext context)
static String	getJwtContentPart(String jwt)
static String	getSessionCookie(io.vertx.ext.web.RoutingContext context, OidcTenantConfig oidcTenantConfig)
static String	getSessionCookie(Map<String,Object> context, Map<String,io.vertx.core.http.Cookie> cookies, OidcTenantConfig oidcTenantConfig)
static String	getSessionCookieName(OidcTenantConfig oidcConfig)
static byte[]	getSha256Digest(byte[] value)
static String	getTenantIdFromCookie(String cookiePrefix, String cookieName, boolean sessionCookie)
static boolean	isEncryptedToken(String token)
static boolean	isFormUrlEncodedRequest(io.vertx.ext.web.RoutingContext context)
static boolean	isOpaqueToken(String token)
static boolean	isServiceApp(OidcTenantConfig oidcConfig)
static boolean	isSessionCookie(String cookieName)
static boolean	isWebApp(OidcTenantConfig oidcConfig)
(package private) static OidcTenantConfig	mergeTenantConfig(OidcTenantConfig tenant, OidcTenantConfig provider)	Merge the current tenant and well-known OpenId Connect provider configurations.
static String	removeCookie(io.vertx.ext.web.RoutingContext context, OidcTenantConfig oidcConfig, String cookieName)
(package private) static void	removeCookie(io.vertx.ext.web.RoutingContext context, io.vertx.core.http.impl.ServerCookie cookie, OidcTenantConfig oidcConfig)
(package private) static io.smallrye.mutiny.Uni<Void>	removeSessionCookie(io.vertx.ext.web.RoutingContext context, OidcTenantConfig oidcConfig, TokenStateManager tokenStateManager)
(package private) static OidcTenantConfig	resolveProviderConfig(OidcTenantConfig oidcTenantConfig)
static void	setBlockingApiAttribute(QuarkusSecurityIdentity.Builder builder, io.vertx.ext.web.RoutingContext vertxContext)
(package private) static void	setCookiePath(io.vertx.ext.web.RoutingContext context, OidcTenantConfig.Authentication auth, io.vertx.core.http.impl.ServerCookie cookie)
static void	setRoutingContextAttribute(QuarkusSecurityIdentity.Builder builder, io.vertx.ext.web.RoutingContext routingContext)
static void	setSecurityIdentityConfigMetadata(QuarkusSecurityIdentity.Builder builder, TenantConfigContext resolvedContext)
static void	setSecurityIdentityIntrospection(QuarkusSecurityIdentity.Builder builder, TokenIntrospection introspectionResult)
(package private) static void	setSecurityIdentityPermissions(QuarkusSecurityIdentity.Builder builder, OidcTenantConfig config, io.vertx.core.json.JsonObject permissionsJson)
static void	setSecurityIdentityRoles(QuarkusSecurityIdentity.Builder builder, OidcTenantConfig config, io.vertx.core.json.JsonObject rolesJson)
static void	setSecurityIdentityUserInfo(QuarkusSecurityIdentity.Builder builder, UserInfo userInfo)
static void	setTenantIdAttribute(QuarkusSecurityIdentity.Builder builder, OidcTenantConfig config)
(package private) static void	storeExtractedBearerToken(io.vertx.ext.web.RoutingContext context, String token)
(package private) static Permission[]	transformScopesToPermissions(Collection<String> scopes)
(package private) static QuarkusSecurityIdentity	validateAndCreateIdentity(Map<String,Object> requestData, io.quarkus.security.credential.TokenCredential credential, TenantConfigContext resolvedContext, io.vertx.core.json.JsonObject tokenJson, io.vertx.core.json.JsonObject rolesJson, UserInfo userInfo, TokenIntrospection introspectionResult, io.quarkus.security.identity.request.TokenAuthenticationRequest request)
static void	validatePrimaryJwtTokenType(OidcTenantConfig.Token tokenConfig, io.vertx.core.json.JsonObject tokenJson)

Methods inherited from class java.lang.Object

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

Field Details

STATE_COOKIE_RESTORE_PATH

public static final String STATE_COOKIE_RESTORE_PATH

See Also:

• Constant Field Values

CONFIG_METADATA_ATTRIBUTE

public static final String CONFIG_METADATA_ATTRIBUTE

See Also:

• Constant Field Values

USER_INFO_ATTRIBUTE

public static final String USER_INFO_ATTRIBUTE

See Also:

• Constant Field Values

INTROSPECTION_ATTRIBUTE

public static final String INTROSPECTION_ATTRIBUTE

See Also:

• Constant Field Values

TENANT_ID_ATTRIBUTE

public static final String TENANT_ID_ATTRIBUTE

See Also:

• Constant Field Values

TENANT_ID_SET_BY_ANNOTATION

public static final String TENANT_ID_SET_BY_ANNOTATION

See Also:

• Constant Field Values

TENANT_ID_SET_BY_SESSION_COOKIE

public static final String TENANT_ID_SET_BY_SESSION_COOKIE

See Also:

• Constant Field Values

TENANT_ID_SET_BY_STATE_COOKIE

public static final String TENANT_ID_SET_BY_STATE_COOKIE

See Also:

• Constant Field Values

DEFAULT_TENANT_ID

public static final String DEFAULT_TENANT_ID

See Also:

• Constant Field Values

SESSION_COOKIE_NAME

public static final String SESSION_COOKIE_NAME

See Also:

• Constant Field Values

SESSION_COOKIE_CHUNK_START

public static final String SESSION_COOKIE_CHUNK_START

See Also:

• Constant Field Values

SESSION_COOKIE_CHUNK

public static final String SESSION_COOKIE_CHUNK

See Also:

• Constant Field Values

ACCESS_TOKEN_COOKIE_SUFFIX

public static final String ACCESS_TOKEN_COOKIE_SUFFIX

See Also:

• Constant Field Values

REFRESH_TOKEN_COOKIE_SUFFIX

public static final String REFRESH_TOKEN_COOKIE_SUFFIX

See Also:

• Constant Field Values

SESSION_AT_COOKIE_NAME

public static final String SESSION_AT_COOKIE_NAME

See Also:

• Constant Field Values

SESSION_RT_COOKIE_NAME

public static final String SESSION_RT_COOKIE_NAME

See Also:

• Constant Field Values

STATE_COOKIE_NAME

public static final String STATE_COOKIE_NAME

See Also:

• Constant Field Values

MAX_COOKIE_VALUE_LENGTH

public static final Integer MAX_COOKIE_VALUE_LENGTH

POST_LOGOUT_COOKIE_NAME

public static final String POST_LOGOUT_COOKIE_NAME

See Also:

• Constant Field Values

DEFAULT_SCOPE_SEPARATOR

public static final String DEFAULT_SCOPE_SEPARATOR

See Also:

• Constant Field Values

ANNOTATION_BASED_TENANT_RESOLUTION_ENABLED

public static final String ANNOTATION_BASED_TENANT_RESOLUTION_ENABLED

See Also:

• Constant Field Values

UNDERSCORE

static final String UNDERSCORE

See Also:

• Constant Field Values

CODE_ACCESS_TOKEN_RESULT

static final String CODE_ACCESS_TOKEN_RESULT

See Also:

• Constant Field Values

CODE_ACCESS_TOKEN_FAILURE

static final String CODE_ACCESS_TOKEN_FAILURE

See Also:

• Constant Field Values

COMMA

static final String COMMA

See Also:

• Constant Field Values

VOID_UNI

static final io.smallrye.mutiny.Uni<Void> VOID_UNI

deleteTokensRequestContext

static final BlockingTaskRunner<Void> deleteTokensRequestContext

QUARKUS_IDENTITY_EXPIRE_TIME

public static final String QUARKUS_IDENTITY_EXPIRE_TIME

See Also:

• Constant Field Values

Method Details

getSessionCookie

public static String getSessionCookie(io.vertx.ext.web.RoutingContext context,
 OidcTenantConfig oidcTenantConfig)

getSessionCookie

public static String getSessionCookie(Map<String,Object> context,
 Map<String,io.vertx.core.http.Cookie> cookies,
 OidcTenantConfig oidcTenantConfig)

getSessionCookieName

public static String getSessionCookieName(OidcTenantConfig oidcConfig)

getCookieSuffix

public static String getCookieSuffix(OidcTenantConfig oidcConfig)

isServiceApp

public static boolean isServiceApp(OidcTenantConfig oidcConfig)

isWebApp

public static boolean isWebApp(OidcTenantConfig oidcConfig)

isEncryptedToken

public static boolean isEncryptedToken(String token)

isOpaqueToken

public static boolean isOpaqueToken(String token)

decodeJwtContent

public static io.vertx.core.json.JsonObject decodeJwtContent(String jwt)

decodeJwtContentAsString

public static String decodeJwtContentAsString(String jwt)

getJwtContentPart

public static String getJwtContentPart(String jwt)

base64UrlDecode

public static String base64UrlDecode(String encodedContent)

decodeJwtHeaders

public static io.vertx.core.json.JsonObject decodeJwtHeaders(String jwt)

decodeJwtHeadersAsString

public static String decodeJwtHeadersAsString(String jwt)

findRoles

public static List<String> findRoles(String clientId,
 OidcTenantConfig.Roles rolesConfig,
 io.vertx.core.json.JsonObject json)

validateAndCreateIdentity

static QuarkusSecurityIdentity validateAndCreateIdentity(Map<String,Object> requestData,
 io.quarkus.security.credential.TokenCredential credential,
 TenantConfigContext resolvedContext,
 io.vertx.core.json.JsonObject tokenJson,
 io.vertx.core.json.JsonObject rolesJson,
 UserInfo userInfo,
 TokenIntrospection introspectionResult,
 io.quarkus.security.identity.request.TokenAuthenticationRequest request)

setSecurityIdentityPermissions

static void setSecurityIdentityPermissions(QuarkusSecurityIdentity.Builder builder,
 OidcTenantConfig config,
 io.vertx.core.json.JsonObject permissionsJson)

addTokenScopesAsPermissions

static void addTokenScopesAsPermissions(QuarkusSecurityIdentity.Builder builder,
 Collection<String> scopes)

transformScopesToPermissions

static Permission[] transformScopesToPermissions(Collection<String> scopes)

setSecurityIdentityRoles

public static void setSecurityIdentityRoles(QuarkusSecurityIdentity.Builder builder,
 OidcTenantConfig config,
 io.vertx.core.json.JsonObject rolesJson)

setBlockingApiAttribute

public static void setBlockingApiAttribute(QuarkusSecurityIdentity.Builder builder,
 io.vertx.ext.web.RoutingContext vertxContext)

setTenantIdAttribute

public static void setTenantIdAttribute(QuarkusSecurityIdentity.Builder builder,
 OidcTenantConfig config)

setRoutingContextAttribute

public static void setRoutingContextAttribute(QuarkusSecurityIdentity.Builder builder,
 io.vertx.ext.web.RoutingContext routingContext)

setSecurityIdentityUserInfo

public static void setSecurityIdentityUserInfo(QuarkusSecurityIdentity.Builder builder,
 UserInfo userInfo)

setSecurityIdentityIntrospection

public static void setSecurityIdentityIntrospection(QuarkusSecurityIdentity.Builder builder,
 TokenIntrospection introspectionResult)

setSecurityIdentityConfigMetadata

public static void setSecurityIdentityConfigMetadata(QuarkusSecurityIdentity.Builder builder,
 TenantConfigContext resolvedContext)

validatePrimaryJwtTokenType

public static void validatePrimaryJwtTokenType(OidcTenantConfig.Token tokenConfig,
 io.vertx.core.json.JsonObject tokenJson)

removeSessionCookie

static io.smallrye.mutiny.Uni<Void> removeSessionCookie(io.vertx.ext.web.RoutingContext context,
 OidcTenantConfig oidcConfig,
 TokenStateManager tokenStateManager)

removeCookie

public static String removeCookie(io.vertx.ext.web.RoutingContext context,
 OidcTenantConfig oidcConfig,
 String cookieName)

removeCookie

static void removeCookie(io.vertx.ext.web.RoutingContext context,
 io.vertx.core.http.impl.ServerCookie cookie,
 OidcTenantConfig oidcConfig)

setCookiePath

static void setCookiePath(io.vertx.ext.web.RoutingContext context,
 OidcTenantConfig.Authentication auth,
 io.vertx.core.http.impl.ServerCookie cookie)

mergeTenantConfig

static OidcTenantConfig mergeTenantConfig(OidcTenantConfig tenant,
 OidcTenantConfig provider)

Merge the current tenant and well-known OpenId Connect provider configurations. Initialized properties take priority over uninitialized properties. Initialized properties in the current tenant configuration take priority over the same initialized properties in the well-known OpenId Connect provider configuration. Tenant id property of the current tenant must be set before the merge operation.

Parameters:

tenant - current tenant configuration

provider - well-known OpenId Connect provider configuration

Returns:

merged configuration

resolveProviderConfig

static OidcTenantConfig resolveProviderConfig(OidcTenantConfig oidcTenantConfig)

getSha256Digest

public static byte[] getSha256Digest(byte[] value)
                              throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

encryptJson

public static String encryptJson(io.vertx.core.json.JsonObject json,
 SecretKey key)
                          throws Exception

Throws:

Exception

encryptString

public static String encryptString(String jweString,
 SecretKey key)
                            throws Exception

Throws:

Exception

encryptString

public static String encryptString(String jweString,
 SecretKey key,
 io.smallrye.jwt.algorithm.KeyEncryptionAlgorithm algorithm)
                            throws Exception

Throws:

Exception

decryptJson

public static io.vertx.core.json.JsonObject decryptJson(String jweString,
 Key key)
                                                 throws Exception

Throws:

Exception

decryptString

public static String decryptString(String jweString,
 Key key)
                            throws Exception

Throws:

Exception

decryptString

public static String decryptString(String jweString,
 Key key,
 io.smallrye.jwt.algorithm.KeyEncryptionAlgorithm algorithm)
                            throws org.jose4j.lang.JoseException

Throws:

org.jose4j.lang.JoseException

isFormUrlEncodedRequest

public static boolean isFormUrlEncodedRequest(io.vertx.ext.web.RoutingContext context)

getFormUrlEncodedData

public static io.smallrye.mutiny.Uni<io.vertx.core.MultiMap> getFormUrlEncodedData(io.vertx.ext.web.RoutingContext context)

encodeScopes

public static String encodeScopes(OidcTenantConfig oidcConfig)

getAllScopes

public static List<String> getAllScopes(OidcTenantConfig oidcConfig)

isSessionCookie

public static boolean isSessionCookie(String cookieName)

extractBearerToken

static String extractBearerToken(io.vertx.ext.web.RoutingContext context,
 OidcTenantConfig oidcConfig)

storeExtractedBearerToken

static void storeExtractedBearerToken(io.vertx.ext.web.RoutingContext context,
 String token)

getTenantIdFromCookie

public static String getTenantIdFromCookie(String cookiePrefix,
 String cookieName,
 boolean sessionCookie)

cacheUserInfoInIdToken

public static boolean cacheUserInfoInIdToken(DefaultTenantConfigResolver resolver,
 OidcTenantConfig oidcConfig)

createCookie

public static io.vertx.core.http.impl.ServerCookie createCookie(io.vertx.ext.web.RoutingContext context,
 OidcTenantConfig oidcConfig,
 String name,
 String value,
 long maxAge)

createSecretKeyFromDigest

public static SecretKey createSecretKeyFromDigest(byte[] secretBytes)