cz.d1x.dxcrypto.encryption

Class SymmetricCryptoAlgorithmBuilder

java.lang.Object

cz.d1x.dxcrypto.encryption.SymmetricCryptoAlgorithmBuilder

public final class SymmetricCryptoAlgorithmBuilder
extends Object

Base builder for symmetric key algorithms based on SymmetricCryptoAlgorithm.

Author:

Zdenek Obst, zdenek.obst-at-gmail.com

See Also:

SymmetricCryptoAlgorithm

Constructor Summary

Constructors

Constructor and Description
SymmetricCryptoAlgorithmBuilder(byte[] keyPassword, String algorithmName, String shortAlgorithmName, int keySize, int blockSize) Creates a new builder.
SymmetricCryptoAlgorithmBuilder(KeyFactory<Key> keyFactory, String algorithmName, String shortAlgorithmName, int blockSize) Creates a new builder.

Method Summary

Modifier and Type	Method and Description
EncryptionAlgorithm	build() Builds a new instance of encryption algorithm.
SymmetricCryptoAlgorithmBuilder	bytesRepresentation(BytesRepresentation bytesRepresentation) Sets how byte arrays will be represented in strings.
SymmetricCryptoAlgorithmBuilder	combineSplitAlgorithm(CombineSplitAlgorithm combineSplitAlgorithm) Sets algorithm combining IV and cipher text in output during encryption and splitting from input during decryption.
SymmetricCryptoAlgorithmBuilder	encoding(String encoding) Sets encoding for strings in input and output.
SymmetricCryptoAlgorithmBuilder	keyHashIterations(int keyHashIterations) Sets number of keyHashIterations of hashing for key derivation.
SymmetricCryptoAlgorithmBuilder	keySalt(byte[] keySalt) Sets salt for key derivation.
SymmetricCryptoAlgorithmBuilder	keySalt(String keySalt) Sets salt for key derivation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SymmetricCryptoAlgorithmBuilder

public SymmetricCryptoAlgorithmBuilder(byte[] keyPassword,
                                       String algorithmName,
                                       String shortAlgorithmName,
                                       int keySize,
                                       int blockSize)

Creates a new builder.

Parameters:

keyPassword - key password

algorithmName - full algorithm name (used for Cipher initialization)

shortAlgorithmName - short algorithm name (typically only first part of full name)

keySize - size of the key (in bits)

blockSize - size of the block (in bits)

SymmetricCryptoAlgorithmBuilder

public SymmetricCryptoAlgorithmBuilder(KeyFactory<Key> keyFactory,
                                       String algorithmName,
                                       String shortAlgorithmName,
                                       int blockSize)

Creates a new builder.

Parameters:

keyFactory - factory for the keys

algorithmName - full algorithm name (used for Cipher initialization)

shortAlgorithmName - short algorithm name (typically only first part of full name)

blockSize - size of the block (in bits)

Method Detail

keySalt

public SymmetricCryptoAlgorithmBuilder keySalt(byte[] keySalt)
                                        throws IllegalArgumentException

Sets salt for key derivation. Recommended length is at least 8 bytes.

Parameters:

keySalt - salt to be set

Returns:

this instance

Throws:

IllegalArgumentException - exception if passed key salt is null

keySalt

public SymmetricCryptoAlgorithmBuilder keySalt(String keySalt)
                                        throws IllegalArgumentException

Sets salt for key derivation. Recommended length is at least 8 bytes.

Parameters:

keySalt - salt to be set

Returns:

this instance

Throws:

IllegalArgumentException - exception if passed key salt is null

keyHashIterations

public SymmetricCryptoAlgorithmBuilder keyHashIterations(int keyHashIterations)
                                                  throws IllegalArgumentException

Sets number of keyHashIterations of hashing for key derivation. Recommended count is at least 1000.

Parameters:

keyHashIterations - number of keyHashIterations

Returns:

this instance

Throws:

IllegalArgumentException - exception if passed iterations are lower than 1

combineSplitAlgorithm

public SymmetricCryptoAlgorithmBuilder combineSplitAlgorithm(CombineSplitAlgorithm combineSplitAlgorithm)
                                                      throws IllegalArgumentException

Sets algorithm combining IV and cipher text in output during encryption and splitting from input during decryption.

Parameters:

combineSplitAlgorithm - combine/split algorithm for IV and cipher text

Returns:

this instance

Throws:

IllegalArgumentException - exception if passed CombineSplitAlgorithm is null

bytesRepresentation

public SymmetricCryptoAlgorithmBuilder bytesRepresentation(BytesRepresentation bytesRepresentation)
                                                    throws IllegalArgumentException

Sets how byte arrays will be represented in strings. By default HexRepresentation is used.

Parameters:

bytesRepresentation - byte array representation strategy

Returns:

this instance

Throws:

IllegalArgumentException - exception if passed BytesRepresentation is null

encoding

public SymmetricCryptoAlgorithmBuilder encoding(String encoding)
                                         throws IllegalArgumentException

Sets encoding for strings in input and output.

Parameters:

encoding - encoding to be set

Returns:

this instance

Throws:

IllegalArgumentException - exception if given encoding is null or not supported

build

public EncryptionAlgorithm build()
                          throws IllegalArgumentException

Builds a new instance of encryption algorithm.

Returns:

algorithm instance

Throws:

IllegalArgumentException