de.alpharogroup.crypto.core

Class AbstractCryptor

java.lang.Object

de.alpharogroup.crypto.core.AbstractCryptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaseDecryptor, BaseEncryptor

public abstract class AbstractCryptor
extends Object
implements Serializable

A base cryptor implementation.

Version:

1.0

Author:

Asterios Raptis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Cipher	cipher The Cipher object.

Constructor Summary

Constructors

Constructor and Description
AbstractCryptor(String privateKey) Constructor with a private key.

Method Summary

Modifier and Type	Method and Description
protected String	newAlgorithm() Factory method for creating a new algorithm that will be used with the cipher object.
protected AlgorithmParameterSpec	newAlgorithmParameterSpec(byte[] salt, int iterationCount) Factory method for creating a new AlgorithmParameterSpec from the given salt and iteration count.
protected Cipher	newCipher(int operationMode, SecretKey key, AlgorithmParameterSpec paramSpec, String alg) Factory method for creating a new Cipher from the given parameters.
protected Cipher	newCipher(String privateKey) Factory method for creating a new Cipher from the given private key.
protected Cipher	newCipher(String privateKey, String algorithm, byte[] salt, int iterationCount, int operationMode) Factory method for creating a new Cipher from the given parameters.
protected int	newIterationCount() Factory method for creating a new iteration count that will be used with the cipher object.
protected KeySpec	newKeySpec(String privateKey, byte[] salt, int iterationCount) Factory method for creating a new KeySpec from the given private key.
protected abstract int	newOperationMode() Abstact callback method for get the operation mode. the operation mode can be one of the following values: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE
protected byte[]	newSalt() Factory method for creating a new salt that will be used with the cipher object.
protected SecretKeyFactory	newSecretKeyFactory(String algorithm) Factory method for creating a new SecretKeyFactory from the given algorithm.
protected void	onInitialize() This method initialize the cipher object.

Methods inherited from class java.lang.Object

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

Field Detail

cipher

protected Cipher cipher

The Cipher object.

Constructor Detail

AbstractCryptor

public AbstractCryptor(String privateKey)
                throws InvalidKeyException,
                       NoSuchAlgorithmException,
                       InvalidKeySpecException,
                       NoSuchPaddingException,
                       InvalidAlgorithmParameterException,
                       UnsupportedEncodingException

Constructor with a private key.

Parameters:

privateKey - The private key.

Throws:

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

NoSuchPaddingException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

Method Detail

onInitialize

protected void onInitialize()
                     throws InvalidKeyException,
                            NoSuchAlgorithmException,
                            InvalidKeySpecException,
                            NoSuchPaddingException,
                            InvalidAlgorithmParameterException,
                            UnsupportedEncodingException

This method initialize the cipher object.

Throws:

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

NoSuchPaddingException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

newCipher

protected Cipher newCipher(String privateKey)
                    throws NoSuchAlgorithmException,
                           InvalidKeySpecException,
                           NoSuchPaddingException,
                           InvalidKeyException,
                           InvalidAlgorithmParameterException,
                           UnsupportedEncodingException

Factory method for creating a new Cipher from the given private key. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new Cipher from the given private key.

Parameters:

privateKey - the private key

Returns:

the new Cipher from the given private key.

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchPaddingException - is thrown if instantiation of the cypher object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

newAlgorithm

protected String newAlgorithm()

Factory method for creating a new algorithm that will be used with the cipher object.

Returns:

the string

newSalt

protected byte[] newSalt()

Factory method for creating a new salt that will be used with the cipher object.

Returns:

the salt byte array

newIterationCount

protected int newIterationCount()

Factory method for creating a new iteration count that will be used with the cipher object.

Returns:

the salt byte array

newOperationMode

protected abstract int newOperationMode()

Abstact callback method for get the operation mode. the operation mode can be one of the following values: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE

Returns:

the operation mode

newCipher

protected Cipher newCipher(String privateKey,
                           String algorithm,
                           byte[] salt,
                           int iterationCount,
                           int operationMode)
                    throws NoSuchAlgorithmException,
                           InvalidKeySpecException,
                           NoSuchPaddingException,
                           InvalidKeyException,
                           InvalidAlgorithmParameterException,
                           UnsupportedEncodingException

Factory method for creating a new Cipher from the given parameters. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new Cipher from the given parameters.

Parameters:

privateKey - the private key

algorithm - the algorithm

salt - the salt.

iterationCount - the iteration count

operationMode - the operation mode for the new cipher object

Returns:

the cipher

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

InvalidKeySpecException - is thrown if generation of the SecretKey object fails.

NoSuchPaddingException - is thrown if instantiation of the cypher object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

UnsupportedEncodingException - is thrown if the named charset is not supported.

newCipher

protected Cipher newCipher(int operationMode,
                           SecretKey key,
                           AlgorithmParameterSpec paramSpec,
                           String alg)
                    throws NoSuchAlgorithmException,
                           NoSuchPaddingException,
                           InvalidKeyException,
                           InvalidAlgorithmParameterException

Factory method for creating a new Cipher from the given parameters. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new Cipher from the given parameters.

Parameters:

operationMode - the operation mode

key - the key

paramSpec - the param spec

alg - the alg

Returns:

the cipher

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.

NoSuchPaddingException - is thrown if instantiation of the cypher object fails.

InvalidKeyException - is thrown if initialization of the cypher object fails.

InvalidAlgorithmParameterException - is thrown if initialization of the cypher object fails.

newAlgorithmParameterSpec

protected AlgorithmParameterSpec newAlgorithmParameterSpec(byte[] salt,
                                                           int iterationCount)

Factory method for creating a new AlgorithmParameterSpec from the given salt and iteration count. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new AlgorithmParameterSpec from the given salt and iteration count.

Parameters:

salt - the salt

iterationCount - the iteration count

Returns:

the new AlgorithmParameterSpec from the given salt and iteration count.

newKeySpec

protected KeySpec newKeySpec(String privateKey,
                             byte[] salt,
                             int iterationCount)

Factory method for creating a new KeySpec from the given private key. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new KeySpec from the given private key.

Parameters:

privateKey - the private key

salt - the salt

iterationCount - the iteration count

Returns:

the new KeySpec from the given private key.

newSecretKeyFactory

protected SecretKeyFactory newSecretKeyFactory(String algorithm)
                                        throws NoSuchAlgorithmException

Factory method for creating a new SecretKeyFactory from the given algorithm. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new SecretKeyFactory from the given algorithm.

Parameters:

algorithm - the algorithm

Returns:

the new SecretKeyFactory from the given algorithm.

Throws:

NoSuchAlgorithmException - is thrown if instantiation of the SecretKeyFactory object fails.