Top Fields Constructors Methods

org.keycloak.util

public Class TokenUtil

Class Inheritance

extends Object

java.lang.Object
org.keycloak.util.TokenUtil

Imports

org.keycloak.OAuth2Constants, org.keycloak.jose.jwe.JWE, .JWEConstants, .JWEException, .JWEHeader, .JWEKeyStorage, org.keycloak.jose.jwe.alg.JWEAlgorithmProvider, org.keycloak.jose.jwe.enc.JWEEncryptionProvider, org.keycloak.jose.jws.JWSInput, .JWSInputException, org.keycloak.representations.JsonWebToken, .RefreshToken, java.io.IOException, java.security.Key

Author: Marek Posolda

Field Summary

Modifier and Type	Field and Description
public static final String	TOKEN_BACKCHANNEL_LOGOUT_EVENT
public static final String	TOKEN_BACKCHANNEL_LOGOUT_EVENT_REVOKE_OFFLINE_TOKENS
public static final String	TOKEN_TYPE_BEARER
public static final String	TOKEN_TYPE_DPOP
public static final String	TOKEN_TYPE_ID
public static final String	TOKEN_TYPE_KEYCLOAK_ID
public static final String	TOKEN_TYPE_LOGOUT
public static final String	TOKEN_TYPE_OFFLINE
public static final String	TOKEN_TYPE_REFRESH

Constructor Summary

Access	Constructor and Description
public	TokenUtil()

Method Summary

Modifier and Type	Method and Description
public static String	attachOIDCScope(String scopeParam)
public static RefreshToken	getRefreshToken(byte[] decodedToken) Return refresh token or offline token
public static RefreshToken	getRefreshToken(String refreshToken)
public static boolean	hasPrompt(String promptParam, String targetPrompt)
public static boolean	hasScope(String scopeParam, String targetScope)
public static boolean	isOfflineToken(String refreshToken) Return true if given refreshToken represents offline token
public static boolean	isOfflineTokenRequested(String scopeParam)
public static boolean	isOIDCRequest(String scopeParam)
public static String	jweDirectEncode(Key aesKey, Key hmacKey, JsonWebToken jwt)
public static String	jweDirectEncode(Key aesKey, Key hmacKey, byte[] contentBytes)
public static <T extends JsonWebToken> T	jweDirectVerifyAndDecode(Key aesKey, Key hmacKey, String jweStr, Class<T> expectedClass)
public static byte[]	jweDirectVerifyAndDecode(Key aesKey, Key hmacKey, String jweStr)
public static String	jweKeyEncryptionEncode(Key encryptionKEK, byte[] contentBytes, String algAlgorithm, String encAlgorithm, String kid, JWEAlgorithmProvider jweAlgorithmProvider, JWEEncryptionProvider jweEncryptionProvider)
public static String	jweKeyEncryptionEncode(Key encryptionKEK, byte[] contentBytes, String algAlgorithm, String encAlgorithm, String kid, JWEAlgorithmProvider jweAlgorithmProvider, JWEEncryptionProvider jweEncryptionProvider, String jweContentType)
private static String	jweKeyEncryptionEncode(Key encryptionKEK, byte[] contentBytes, JWEHeader jweHeader, JWEAlgorithmProvider jweAlgorithmProvider, JWEEncryptionProvider jweEncryptionProvider)
public static byte[]	jweKeyEncryptionVerifyAndDecode(Key decryptionKEK, String encodedContent)
public static byte[]	jweKeyEncryptionVerifyAndDecode(Key decryptionKEK, String encodedContent, JWEAlgorithmProvider algorithmProvider, JWEEncryptionProvider encryptionProvider)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

TOKEN_BACKCHANNEL_LOGOUT_EVENT	back to summary
public static final String TOKEN_BACKCHANNEL_LOGOUT_EVENT

TOKEN_BACKCHANNEL_LOGOUT_EVENT_REVOKE_OFFLINE_TOKENS	back to summary
public static final String TOKEN_BACKCHANNEL_LOGOUT_EVENT_REVOKE_OFFLINE_TOKENS

TOKEN_TYPE_BEARER	back to summary
public static final String TOKEN_TYPE_BEARER

TOKEN_TYPE_DPOP	back to summary
public static final String TOKEN_TYPE_DPOP

TOKEN_TYPE_ID	back to summary
public static final String TOKEN_TYPE_ID

TOKEN_TYPE_KEYCLOAK_ID	back to summary
public static final String TOKEN_TYPE_KEYCLOAK_ID

TOKEN_TYPE_LOGOUT	back to summary
public static final String TOKEN_TYPE_LOGOUT

TOKEN_TYPE_OFFLINE	back to summary
public static final String TOKEN_TYPE_OFFLINE

TOKEN_TYPE_REFRESH	back to summary
public static final String TOKEN_TYPE_REFRESH

Constructor Detail

TokenUtil	back to summary
public TokenUtil()

Method Detail

attachOIDCScope	back to summary
public static String attachOIDCScope(String scopeParam)

getRefreshToken	back to summary
public static RefreshToken getRefreshToken(byte[] decodedToken) throws JWSInputException Return refresh token or offline token

getRefreshToken	back to summary
public static RefreshToken getRefreshToken(String refreshToken) throws JWSInputException

hasPrompt	back to summary
public static boolean hasPrompt(String promptParam, String targetPrompt)

hasScope	back to summary
public static boolean hasScope(String scopeParam, String targetScope)

isOfflineToken	back to summary
public static boolean isOfflineToken(String refreshToken) throws JWSInputException Return true if given refreshToken represents offline token

isOfflineTokenRequested	back to summary
public static boolean isOfflineTokenRequested(String scopeParam)

isOIDCRequest	back to summary
public static boolean isOIDCRequest(String scopeParam)

jweDirectEncode	back to summary
public static String jweDirectEncode(Key aesKey, Key hmacKey, JsonWebToken jwt) throws JWEException

jweDirectEncode	back to summary
public static String jweDirectEncode(Key aesKey, Key hmacKey, byte[] contentBytes) throws JWEException

jweDirectVerifyAndDecode	back to summary
public static <T extends JsonWebToken> T jweDirectVerifyAndDecode(Key aesKey, Key hmacKey, String jweStr, Class<T> expectedClass) throws JWEException

jweDirectVerifyAndDecode	back to summary
public static byte[] jweDirectVerifyAndDecode(Key aesKey, Key hmacKey, String jweStr) throws JWEException

jweKeyEncryptionEncode	back to summary
public static String jweKeyEncryptionEncode(Key encryptionKEK, byte[] contentBytes, String algAlgorithm, String encAlgorithm, String kid, JWEAlgorithmProvider jweAlgorithmProvider, JWEEncryptionProvider jweEncryptionProvider) throws JWEException

jweKeyEncryptionEncode	back to summary
public static String jweKeyEncryptionEncode(Key encryptionKEK, byte[] contentBytes, String algAlgorithm, String encAlgorithm, String kid, JWEAlgorithmProvider jweAlgorithmProvider, JWEEncryptionProvider jweEncryptionProvider, String jweContentType) throws JWEException

jweKeyEncryptionEncode	back to summary
private static String jweKeyEncryptionEncode(Key encryptionKEK, byte[] contentBytes, JWEHeader jweHeader, JWEAlgorithmProvider jweAlgorithmProvider, JWEEncryptionProvider jweEncryptionProvider) throws JWEException

jweKeyEncryptionVerifyAndDecode	back to summary
public static byte[] jweKeyEncryptionVerifyAndDecode(Key decryptionKEK, String encodedContent) throws JWEException

jweKeyEncryptionVerifyAndDecode	back to summary
public static byte[] jweKeyEncryptionVerifyAndDecode(Key decryptionKEK, String encodedContent, JWEAlgorithmProvider algorithmProvider, JWEEncryptionProvider encryptionProvider) throws JWEException