Package org.apereo.cas.util.cipher

Class BaseBinaryCipherExecutor

java.lang.Object

org.apereo.cas.util.cipher.AbstractCipherExecutor<byte[],byte[]>

org.apereo.cas.util.cipher.BaseBinaryCipherExecutor

All Implemented Interfaces:

org.apereo.cas.util.crypto.CipherExecutor<byte[],byte[]>, org.apereo.cas.util.crypto.DecodableCipher<byte[],byte[]>, org.apereo.cas.util.crypto.EncodableCipher<byte[],byte[]>

Direct Known Subclasses:

DefaultTicketCipherExecutor, WebflowConversationStateCipherExecutor

public abstract class BaseBinaryCipherExecutor
extends AbstractCipherExecutor<byte[],byte[]>

This is BaseBinaryCipherExecutor.

A implementation that is based on algorithms provided by the default platform's JCE. By default AES encryption is used.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	cipherName	Name of the cipher/component whose keys are generated here.

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	BaseBinaryCipherExecutor(java.lang.String encryptionSecretKey, java.lang.String signingSecretKey, int signingKeySize, int encryptionKeySize, java.lang.String cipherName)

Method Summary

Modifier and Type	Method	Description
byte[]	decode(byte[] value, java.lang.Object[] parameters)
byte[]	encode(byte[] value, java.lang.Object[] parameters)
protected abstract java.lang.String	getEncryptionKeySetting()	Gets encryption key setting.
protected abstract java.lang.String	getSigningKeySetting()	Gets signing key setting.

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

Field Detail

cipherName

protected final java.lang.String cipherName

Name of the cipher/component whose keys are generated here.

Constructor Detail

BaseBinaryCipherExecutor

protected BaseBinaryCipherExecutor(java.lang.String encryptionSecretKey,
                                   java.lang.String signingSecretKey,
                                   int signingKeySize,
                                   int encryptionKeySize,
                                   java.lang.String cipherName)

Method Detail

encode

public byte[] encode(byte[] value,
                     java.lang.Object[] parameters)

decode

public byte[] decode(byte[] value,
                     java.lang.Object[] parameters)

getEncryptionKeySetting

protected abstract java.lang.String getEncryptionKeySetting()

Gets encryption key setting.

Returns:

the encryption key setting

getSigningKeySetting

protected abstract java.lang.String getSigningKeySetting()

Gets signing key setting.

Returns:

the signing key setting