org.kuali.rice.core.impl.encryption

Class EncryptionServiceImpl

java.lang.Object

org.kuali.rice.core.impl.encryption.EncryptionServiceImpl

All Implemented Interfaces:

EncryptionService, org.springframework.beans.factory.InitializingBean

public class EncryptionServiceImpl
extends Object
implements EncryptionService, org.springframework.beans.factory.InitializingBean

A configurable implementation of the EncryptionService.

Leverages a configured EncryptionStrategy for determining what algorithm to use for encryption. The strategy can either be injected into this class or configured in the ConfigContext. The algorithm is configured using the "encryption.algorithm" parameter. The only two options are "DES" and "DESede".

If no encryption strategy is injected or configured, then this class will default to using "DES" as the algorithm.

This class defaults to using the UTF-8 charset, but that can be modified via setCharset(String)

Author:

Eric Westfall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncryptionServiceImpl.DESedeEncryptionStrategy An EncryptionStrategy for the DESede encryption algorithm.
static class	EncryptionServiceImpl.DESEncryptionStrategy An EncryptionStrategy for the DES encryption algorithm.

Field Summary

Fields inherited from interface org.kuali.rice.core.api.encryption.EncryptionService

ENCRYPTION_POST_PREFIX, HASH_POST_PREFIX

Constructor Summary

Constructors

Constructor and Description
EncryptionServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	checkEnabled() Performs a check to see if the encryption service is enabled.
String	decrypt(String ciphertext) Decrypts a value
byte[]	decryptBytes(byte[] ciphertext) Decrypts a value
String	encrypt(Object valueToHide) Encrypts a value
byte[]	encryptBytes(byte[] valueToHide) Encrypts a value
EncryptionStrategy	getEncryptionStrategy()
String	hash(Object valueToHide) Hash the value by converting to a string, running the hash algorithm, and then base64'ng the results.
boolean	isEnabled() Returns true if encryption is enabled within KEW, false otherwise.
void	setCharset(String charset)
void	setEncryptionStrategy(EncryptionStrategy encryptionStrategy)
void	setSecretKey(String secretKeyValue) Sets the secretKey attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptionServiceImpl

public EncryptionServiceImpl()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws GeneralSecurityException

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

GeneralSecurityException

isEnabled

public boolean isEnabled()

Description copied from interface: EncryptionService

Returns true if encryption is enabled within KEW, false otherwise.

Specified by:

isEnabled in interface EncryptionService

encrypt

public String encrypt(Object valueToHide)
               throws GeneralSecurityException

Description copied from interface: EncryptionService

Encrypts a value

Specified by:

encrypt in interface EncryptionService

Parameters:

valueToHide - - original value

Returns:

encrypted value

Throws:

GeneralSecurityException

decrypt

public String decrypt(String ciphertext)
               throws GeneralSecurityException

Description copied from interface: EncryptionService

Decrypts a value

Specified by:

decrypt in interface EncryptionService

Parameters:

ciphertext - - encrypted value

Returns:

decrypted value

Throws:

GeneralSecurityException

encryptBytes

public byte[] encryptBytes(byte[] valueToHide)
                    throws GeneralSecurityException

Description copied from interface: EncryptionService

Encrypts a value

Specified by:

encryptBytes in interface EncryptionService

Parameters:

valueToHide - - original value

Returns:

encrypted value

Throws:

GeneralSecurityException

decryptBytes

public byte[] decryptBytes(byte[] ciphertext)
                    throws GeneralSecurityException

Description copied from interface: EncryptionService

Decrypts a value

Specified by:

decryptBytes in interface EncryptionService

Parameters:

ciphertext - - encrypted value

Returns:

decrypted value

Throws:

GeneralSecurityException

setSecretKey

public void setSecretKey(String secretKeyValue)
                  throws GeneralSecurityException

Sets the secretKey attribute value.

Parameters:

secretKeyValue - The secretKey to set.

Throws:

Exception

GeneralSecurityException

getEncryptionStrategy

public EncryptionStrategy getEncryptionStrategy()

setEncryptionStrategy

public void setEncryptionStrategy(EncryptionStrategy encryptionStrategy)

hash

public String hash(Object valueToHide)
            throws GeneralSecurityException

Hash the value by converting to a string, running the hash algorithm, and then base64'ng the results. Returns a blank string if any problems occur or the input value is null or empty.

Specified by:

hash in interface EncryptionService

Parameters:

valueToHide - - original value

Returns:

encrypted value

Throws:

GeneralSecurityException

checkEnabled

protected void checkEnabled()

Performs a check to see if the encryption service is enabled. If it is not then an IllegalStateException will be thrown.

setCharset

public void setCharset(String charset)