Package org.apereo.cas.util.cipher

Class BaseStringCipherExecutor

java.lang.Object

org.apereo.cas.util.cipher.AbstractCipherExecutor<java.io.Serializable,java.lang.String>

org.apereo.cas.util.cipher.BaseStringCipherExecutor

All Implemented Interfaces:

org.apereo.cas.util.crypto.CipherExecutor<java.io.Serializable,java.lang.String>, org.apereo.cas.util.crypto.DecodableCipher<java.io.Serializable,java.lang.String>, org.apereo.cas.util.crypto.EncodableCipher<java.io.Serializable,java.lang.String>

Direct Known Subclasses:

JsonWebKeySetStringCipherExecutor, ProtocolTicketCipherExecutor, RsaKeyPairCipherExecutor, TicketGrantingCookieCipherExecutor

public abstract class BaseStringCipherExecutor
extends AbstractCipherExecutor<java.io.Serializable,java.lang.String>

The BaseStringCipherExecutor is the default implementation of CipherExecutor. It provides a facade API to encrypt, sign, and verify values.

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseStringCipherExecutor.CipherOperationsStrategyType	Define the order of cipher operations.

Field Summary

Fields inherited from interface org.apereo.cas.util.crypto.CipherExecutor

DEFAULT_CONTENT_ENCRYPTION_ALGORITHM, DEFAULT_STRINGABLE_ENCRYPTION_KEY_SIZE, DEFAULT_STRINGABLE_SIGNING_KEY_SIZE

Fields inherited from interface org.apereo.cas.util.crypto.DecodableCipher

LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseStringCipherExecutor(java.lang.String secretKeyEncryption, java.lang.String secretKeySigning, boolean encryptionEnabled, boolean signingEnabled, int signingKeySize, int encryptionKeySize)
protected	BaseStringCipherExecutor(java.lang.String secretKeyEncryption, java.lang.String secretKeySigning, boolean encryptionEnabled, int signingKeySize, int encryptionKeySize)
protected	BaseStringCipherExecutor(java.lang.String secretKeyEncryption, java.lang.String secretKeySigning, int signingKeySize, int encryptionKeySize)
protected	BaseStringCipherExecutor(java.lang.String secretKeyEncryption, java.lang.String secretKeySigning, java.lang.String contentEncryptionAlgorithmIdentifier, boolean encryptionEnabled, boolean signingEnabled, int signingKeyLength, int encryptionKeyLength)
protected	BaseStringCipherExecutor(java.lang.String secretKeyEncryption, java.lang.String secretKeySigning, java.lang.String contentEncryptionAlgorithmIdentifier, int signingKeySize, int encryptionKeySize)

Method Summary

Modifier and Type	Method	Description
protected void	configureEncryptionKeyFromPublicKeyResource(java.lang.String secretKeyToUse)	Configure encryption key from public key resource.
java.lang.String	decode(java.io.Serializable value, java.lang.Object[] parameters)
protected java.lang.String	decode(java.io.Serializable value, java.lang.Object[] parameters, java.security.Key encryptionKey, java.security.Key signingKey)	Decode value.
java.lang.String	encode(java.io.Serializable value, java.lang.Object[] parameters)
protected java.lang.String	getEncryptionKeySetting()	Gets encryption key setting.
protected java.lang.String	getSigningKeySetting()	Gets signing key setting.
protected boolean	isEncryptionPossible(java.security.Key key)	Is encryption possible?

Methods inherited from class org.apereo.cas.util.cipher.AbstractCipherExecutor

configureSigningKey, configureSigningKeyFromPrivateKeyResource, extractPrivateKeyFromResource, extractPublicKeyFromResource, getSigningAlgorithmFor, isEnabled, sign, signWith, signWith, verifySignature

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.util.crypto.CipherExecutor

getName, getSigningKey

Methods inherited from interface org.apereo.cas.util.crypto.DecodableCipher

decode, decode

Methods inherited from interface org.apereo.cas.util.crypto.EncodableCipher

encode

Constructor Detail

BaseStringCipherExecutor

protected BaseStringCipherExecutor(java.lang.String secretKeyEncryption,
                                   java.lang.String secretKeySigning,
                                   boolean encryptionEnabled,
                                   boolean signingEnabled,
                                   int signingKeySize,
                                   int encryptionKeySize)

BaseStringCipherExecutor

protected BaseStringCipherExecutor(java.lang.String secretKeyEncryption,
                                   java.lang.String secretKeySigning,
                                   boolean encryptionEnabled,
                                   int signingKeySize,
                                   int encryptionKeySize)

BaseStringCipherExecutor

protected BaseStringCipherExecutor(java.lang.String secretKeyEncryption,
                                   java.lang.String secretKeySigning,
                                   java.lang.String contentEncryptionAlgorithmIdentifier,
                                   int signingKeySize,
                                   int encryptionKeySize)

BaseStringCipherExecutor

protected BaseStringCipherExecutor(java.lang.String secretKeyEncryption,
                                   java.lang.String secretKeySigning,
                                   int signingKeySize,
                                   int encryptionKeySize)

BaseStringCipherExecutor

protected BaseStringCipherExecutor(java.lang.String secretKeyEncryption,
                                   java.lang.String secretKeySigning,
                                   java.lang.String contentEncryptionAlgorithmIdentifier,
                                   boolean encryptionEnabled,
                                   boolean signingEnabled,
                                   int signingKeyLength,
                                   int encryptionKeyLength)

Method Detail

encode

public java.lang.String encode(java.io.Serializable value,
                               java.lang.Object[] parameters)

decode

public java.lang.String decode(java.io.Serializable value,
                               java.lang.Object[] parameters)

decode

protected java.lang.String decode(java.io.Serializable value,
                                  java.lang.Object[] parameters,
                                  java.security.Key encryptionKey,
                                  java.security.Key signingKey)

Decode value.

Parameters:

value - the value

parameters - the parameters

encryptionKey - the encryption key

signingKey - the signing key

Returns:

the string

configureEncryptionKeyFromPublicKeyResource

protected void configureEncryptionKeyFromPublicKeyResource(java.lang.String secretKeyToUse)

Configure encryption key from public key resource.

Parameters:

secretKeyToUse - the secret key to use

isEncryptionPossible

protected boolean isEncryptionPossible(java.security.Key key)

Is encryption possible?

Parameters:

key - the key

Returns:

true /false

getEncryptionKeySetting

protected java.lang.String getEncryptionKeySetting()

Gets encryption key setting.

Returns:

the encryption key setting

getSigningKeySetting

protected java.lang.String getSigningKeySetting()

Gets signing key setting.

Returns:

the signing key setting