Package org.gcube.common.keycloak.model

Class ModelUtils

java.lang.Object

org.gcube.common.keycloak.model.ModelUtils

public class ModelUtils
extends Object

Author:

Mauro Mugnaini

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelUtils.GcubeJacksonDeserializer

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
ModelUtils()

Method Summary

Modifier and Type	Method	Description
static PublicKey	createPublicKey(String publicKeyPem, String algorithm)	Creates a PublicKey instance from its string PEM representation
static RSAPublicKey	createRSAPublicKey(String publicKeyPem)	Creates a RSAPublicKey instance from its string PEM representation
static AccessToken	getAccessTokenFrom(String authorizationHeaderOrBase64EncodedJWT)
static AccessToken	getAccessTokenFrom(TokenResponse tokenResponse)
static String	getAccessTokenPayloadJSONStringFrom(TokenResponse tokenResponse)
static String	getAccessTokenPayloadJSONStringFrom(TokenResponse tokenResponse, boolean prettyPrint)
protected static byte[]	getBase64Decoded(String string)
static String	getClientIdFromToken(AccessToken accessToken)
static byte[]	getDecodedHeader(String value)
static byte[]	getDecodedPayload(String value)
static byte[]	getDecodedSignature(String value)
static String	getEncodedHeader(String encodedJWT)
static String	getEncodedPayload(String encodedJWT)
static String	getEncodedSignature(String encodedJWT)
static RefreshToken	getRefreshTokenFrom(String base64EncodedJWT)
static RefreshToken	getRefreshTokenFrom(TokenResponse tokenResponse)
static String	getRefreshTokenPayloadStringFrom(TokenResponse tokenResponse)
static String	getRefreshTokenPayloadStringFrom(TokenResponse tokenResponse, boolean prettyPrint)
static boolean	isValid(String token, PublicKey publicKey)	Verifies the token validity
static boolean	isValid(String token, PublicKey publicKey, boolean checkExpiration)	Verifies the token validity
protected static String	splitAndGet(String encodedJWT, int index)
static String	toJSONString(Object object)
static String	toJSONString(Object object, boolean prettyPrint)
static void	verify(String token, PublicKey publicKey)	Verifies the token signature and expiration

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

ModelUtils

public ModelUtils()

Method Detail

toJSONString

public static String toJSONString(Object object)

toJSONString

public static String toJSONString(Object object,
                                  boolean prettyPrint)

createRSAPublicKey

public static RSAPublicKey createRSAPublicKey(String publicKeyPem)
                                       throws Exception

Creates a RSAPublicKey instance from its string PEM representation

Parameters:

publicKeyPem - the public key PEM string

Returns:

the RSA public key

Throws:

Exception - if it's not possible to create the RSA public key from the PEM string

createPublicKey

public static PublicKey createPublicKey(String publicKeyPem,
                                        String algorithm)
                                 throws Exception

Creates a PublicKey instance from its string PEM representation

Parameters:

publicKeyPem - the public key PEM string

algorithm - the key type (e.g. RSA)

Returns:

the public key

Throws:

Exception - if it's not possible to create the public key from the PEM string

isValid

public static boolean isValid(String token,
                              PublicKey publicKey)
                       throws Exception

Verifies the token validity

Parameters:

token - the base64 JWT token string

publicKey - the realm's public key on server

Returns:

true if the token is valid, false otherwise

Throws:

Exception - if an error occurs constructing the verifier

isValid

public static boolean isValid(String token,
                              PublicKey publicKey,
                              boolean checkExpiration)
                       throws Exception

Verifies the token validity

Parameters:

token - the base64 JWT token string

publicKey - the public key to use for verification

checkExpiration - if false token expiration check is disabled

Returns:

true if the token is valid, false otherwise

Throws:

Exception - if an unexpected error occurs (e.g. constructing the verifier)

verify

public static void verify(String token,
                          PublicKey publicKey)
                   throws org.gcube.io.jsonwebtoken.security.SignatureException,
                          org.gcube.io.jsonwebtoken.ExpiredJwtException,
                          org.gcube.io.jsonwebtoken.JwtException,
                          Exception

Verifies the token signature and expiration

Parameters:

token - the base64 JWT token string

publicKey - the public key to use for verification

Throws:

org.gcube.io.jsonwebtoken.security.SignatureException - if the token signature is invalid

org.gcube.io.jsonwebtoken.ExpiredJwtException - if the token is expired

org.gcube.io.jsonwebtoken.JwtException - if a JWT related problem is found

Exception - if an unexpected error occurs (e.g. constructing the verifier)

getAccessTokenPayloadJSONStringFrom

public static String getAccessTokenPayloadJSONStringFrom(TokenResponse tokenResponse)
                                                  throws Exception

Throws:

Exception

getAccessTokenPayloadJSONStringFrom

public static String getAccessTokenPayloadJSONStringFrom(TokenResponse tokenResponse,
                                                         boolean prettyPrint)
                                                  throws Exception

Throws:

Exception

getAccessTokenFrom

public static AccessToken getAccessTokenFrom(TokenResponse tokenResponse)
                                      throws Exception

Throws:

Exception

getAccessTokenFrom

public static AccessToken getAccessTokenFrom(String authorizationHeaderOrBase64EncodedJWT)
                                      throws Exception

Throws:

Exception

getRefreshTokenPayloadStringFrom

public static String getRefreshTokenPayloadStringFrom(TokenResponse tokenResponse)
                                               throws Exception

Throws:

Exception

getRefreshTokenPayloadStringFrom

public static String getRefreshTokenPayloadStringFrom(TokenResponse tokenResponse,
                                                      boolean prettyPrint)
                                               throws Exception

Throws:

Exception

getRefreshTokenFrom

public static RefreshToken getRefreshTokenFrom(TokenResponse tokenResponse)
                                        throws Exception

Throws:

Exception

getRefreshTokenFrom

public static RefreshToken getRefreshTokenFrom(String base64EncodedJWT)
                                        throws Exception

Throws:

Exception

getBase64Decoded

protected static byte[] getBase64Decoded(String string)

splitAndGet

protected static String splitAndGet(String encodedJWT,
                                    int index)

getDecodedHeader

public static byte[] getDecodedHeader(String value)

getEncodedHeader

public static String getEncodedHeader(String encodedJWT)

getDecodedPayload

public static byte[] getDecodedPayload(String value)

getEncodedPayload

public static String getEncodedPayload(String encodedJWT)

getDecodedSignature

public static byte[] getDecodedSignature(String value)

getEncodedSignature

public static String getEncodedSignature(String encodedJWT)

getClientIdFromToken

public static String getClientIdFromToken(AccessToken accessToken)