org.apereo.cas.util

Class EncodingUtils

java.lang.Object

org.apereo.cas.util.EncodingUtils

public final class EncodingUtils
extends java.lang.Object

This is EncodingUtils that encapsulates common base64, signing and encryption calls and operations in one spot.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_ENCRYPTION_ALGORITHM Default content encryption algorithm.
static java.lang.String	JSON_WEB_KEY JSON web key parameter that identifies the key..

Method Summary

Modifier and Type	Method and Description
static byte[]	decodeBase64(byte[] data) Base64-decode the given string as byte[].
static byte[]	decodeBase64(java.lang.String data) Base64-decode the given string as byte[].
static java.lang.String	decodeBase64ToString(java.lang.String data) Base64-decode the given string as String.
static byte[]	decodeUrlSafeBase64(java.lang.String data) Base64-decode the given string as byte[].
static java.lang.String	decryptJwtValue(java.security.Key secretKeyEncryptionKey, java.lang.String value) Decrypt value based on the key created.
static java.lang.String	encodeBase64(byte[] data) Base64-encode the given byte[] as a string.
static java.lang.String	encodeBase64(java.lang.String data) Base64-encode the given string as a string.
static byte[]	encodeBase64ToByteArray(byte[] data) Base64-encode the given byte[] as a byte[].
static java.lang.String	encodeUrlSafeBase64(byte[] data) Base64-encode the given byte[] as a string.
static java.lang.String	encryptValueAsJwt(java.security.Key secretKeyEncryptionKey, java.io.Serializable value, java.lang.String algorithmHeaderValue, java.lang.String contentEncryptionAlgorithmIdentifier) Encrypt the value based on the seed array whose length was given during afterPropertiesSet, and the key and content encryption ids.
static java.lang.String	encryptValueAsJwtDirectAes128Sha256(java.security.Key key, java.io.Serializable value) Encrypt value as jwt with direct algorithm and encryption content alg aes-128-sha-256.
static java.lang.String	encryptValueAsJwtRsaOeap256Aes256Sha512(java.security.Key key, java.io.Serializable value) Encrypt value as jwt rsa oeap 256 aes 256 sha 512 string.
static java.lang.String	generateJsonWebKey(int size) Generate octet json web key of given size .
static java.security.Key	generateJsonWebKey(java.lang.String secret) Prepare json web token key.
static java.lang.String	hexDecode(char[] data) Hex decode string.
static java.lang.String	hexDecode(java.lang.String data) Hex decode string.
static java.lang.String	hexEncode(byte[] data) Hex encode string.
static java.lang.String	hexEncode(java.lang.String data) Hex encode string.
static boolean	isBase64(java.lang.String value) Validates Base64 encoding.
static byte[]	signJws(java.security.Key key, byte[] value, java.lang.String algHeaderValue) Sign jws.
static byte[]	signJwsHMACSha512(java.security.Key key, byte[] value) Sign jws.
static byte[]	signJwsRSASha512(java.security.PrivateKey key, byte[] value) Sign jws.
static java.lang.String	urlDecode(java.lang.String value) Url decode a value.
static java.lang.String	urlEncode(java.lang.String value) Url encode a value via UTF-8.
static java.lang.String	urlEncode(java.lang.String value, java.lang.String encoding) Url encode a value.
static byte[]	verifyJwsSignature(java.security.Key signingKey, byte[] value) Verify jws signature byte [ ].

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_ENCRYPTION_ALGORITHM

public static final java.lang.String DEFAULT_CONTENT_ENCRYPTION_ALGORITHM

Default content encryption algorithm.

See Also:

Constant Field Values

JSON_WEB_KEY

public static final java.lang.String JSON_WEB_KEY

JSON web key parameter that identifies the key..

See Also:

Constant Field Values

Method Detail

hexDecode

public static java.lang.String hexDecode(java.lang.String data)

Hex decode string.

Parameters:

data - the data

Returns:

the string

hexDecode

public static java.lang.String hexDecode(char[] data)

Hex decode string.

Parameters:

data - the data

Returns:

the string

hexEncode

public static java.lang.String hexEncode(java.lang.String data)

Hex encode string.

Parameters:

data - the data

Returns:

the string

hexEncode

public static java.lang.String hexEncode(byte[] data)

Hex encode string.

Parameters:

data - the data

Returns:

the string

encodeUrlSafeBase64

public static java.lang.String encodeUrlSafeBase64(byte[] data)

Base64-encode the given byte[] as a string.

Parameters:

data - the byte array to encode

Returns:

the encoded string

decodeUrlSafeBase64

public static byte[] decodeUrlSafeBase64(java.lang.String data)

Base64-decode the given string as byte[].

Parameters:

data - the base64 string

Returns:

the encoded array

encodeBase64

public static java.lang.String encodeBase64(byte[] data)

Base64-encode the given byte[] as a string.

Parameters:

data - the byte array to encode

Returns:

the encoded string

encodeBase64

public static java.lang.String encodeBase64(java.lang.String data)

Base64-encode the given string as a string.

Parameters:

data - the String to encode

Returns:

the encoded string

decodeBase64

public static byte[] decodeBase64(java.lang.String data)

Base64-decode the given string as byte[].

Parameters:

data - the base64 string

Returns:

the decoded array

decodeBase64

public static byte[] decodeBase64(byte[] data)

Base64-decode the given string as byte[].

Parameters:

data - the base64 string

Returns:

the decoded array

decodeBase64ToString

public static java.lang.String decodeBase64ToString(java.lang.String data)

Base64-decode the given string as String.

Parameters:

data - the base64 string

Returns:

the string

encodeBase64ToByteArray

public static byte[] encodeBase64ToByteArray(byte[] data)

Base64-encode the given byte[] as a byte[].

Parameters:

data - the byte array to encode

Returns:

the byte[] in base64

urlEncode

public static java.lang.String urlEncode(java.lang.String value)

Url encode a value via UTF-8.

Parameters:

value - the value to encode

Returns:

the encoded value

urlEncode

public static java.lang.String urlEncode(java.lang.String value,
                                         java.lang.String encoding)

Url encode a value.

Parameters:

value - the value to encode

encoding - the encoding

Returns:

the encoded value

urlDecode

public static java.lang.String urlDecode(java.lang.String value)

Url decode a value.

Parameters:

value - the value to decode

Returns:

the decoded value

isBase64

public static boolean isBase64(java.lang.String value)

Validates Base64 encoding.

Parameters:

value - the value to check

Returns:

true if the string is validly Base64 encoded

verifyJwsSignature

public static byte[] verifyJwsSignature(java.security.Key signingKey,
                                        byte[] value)

Verify jws signature byte [ ].

Parameters:

value - the value

signingKey - the signing key

Returns:

the byte [ ]

generateJsonWebKey

public static java.lang.String generateJsonWebKey(int size)

Generate octet json web key of given size .

Parameters:

size - the size

Returns:

the key

generateJsonWebKey

public static java.security.Key generateJsonWebKey(java.lang.String secret)

Prepare json web token key.

Parameters:

secret - the secret

Returns:

the key

signJwsHMACSha512

public static byte[] signJwsHMACSha512(java.security.Key key,
                                       byte[] value)

Sign jws.

Parameters:

key - the key

value - the value

Returns:

the byte []

signJwsRSASha512

public static byte[] signJwsRSASha512(java.security.PrivateKey key,
                                      byte[] value)

Sign jws.

Parameters:

key - the key

value - the value

Returns:

the byte []

signJws

public static byte[] signJws(java.security.Key key,
                             byte[] value,
                             java.lang.String algHeaderValue)

Sign jws.

Parameters:

key - the key

value - the value

algHeaderValue - the alg header value

Returns:

the byte [ ]

encryptValueAsJwtDirectAes128Sha256

public static java.lang.String encryptValueAsJwtDirectAes128Sha256(java.security.Key key,
                                                                   java.io.Serializable value)

Encrypt value as jwt with direct algorithm and encryption content alg aes-128-sha-256.

Parameters:

key - the key

value - the value

Returns:

the string

encryptValueAsJwtRsaOeap256Aes256Sha512

public static java.lang.String encryptValueAsJwtRsaOeap256Aes256Sha512(java.security.Key key,
                                                                       java.io.Serializable value)

Encrypt value as jwt rsa oeap 256 aes 256 sha 512 string.

Parameters:

key - the key

value - the value

Returns:

the string

encryptValueAsJwt

public static java.lang.String encryptValueAsJwt(java.security.Key secretKeyEncryptionKey,
                                                 java.io.Serializable value,
                                                 java.lang.String algorithmHeaderValue,
                                                 java.lang.String contentEncryptionAlgorithmIdentifier)

Encrypt the value based on the seed array whose length was given during afterPropertiesSet, and the key and content encryption ids.

Parameters:

secretKeyEncryptionKey - the secret key encryption key

value - the value

algorithmHeaderValue - the algorithm header value

contentEncryptionAlgorithmIdentifier - the content encryption algorithm identifier

Returns:

the encoded value

decryptJwtValue

public static java.lang.String decryptJwtValue(java.security.Key secretKeyEncryptionKey,
                                               java.lang.String value)

Decrypt value based on the key created.

Parameters:

secretKeyEncryptionKey - the secret key encryption key

value - the value

Returns:

the decrypted value