org.waarp.common.crypto

Class DynamicKeyObject

java.lang.Object

org.waarp.common.crypto.KeyObject

org.waarp.common.crypto.DynamicKeyObject

public class DynamicKeyObject
extends KeyObject

This class handles methods to encrypt and unencrypt messages with any available algorithms in the JVM.
AES is the best compromise in term of security and efficiency.
Usage:

• Create a Key object: DynamicKey key = new DynamicKey(size,algo,instance,extension);
  As DynamicKey(56, "DES", "DES/ECB/PKCS5Padding", "des") for DES
  or through Enum class INSTANCES (minimal supported size) or INSTANCESMAX (maximal supported size) as DynamicKey(INSTANCESMAX.AES,"aes")
• Create a key:
  • Generate: key.generateKey();
    The method key.getSecretKeyInBytes() allow getting the key in Bytes.
  • From an external source: key.setSecretKey(arrayOfBytes);
• To encrypt a String in a Base64 format: String myStringCrypt = key.cryptToString(myString);
• To unencrypt one string from Base64 format to the original String: String myStringDecrypt = key.decryptStringInString(myStringCrypte);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicKeyObject.INSTANCES Minimal key size
static class	DynamicKeyObject.INSTANCESMAX Recommended key size when normal JVM installed (no extension on encrypt support)

Constructor Summary

Constructors

Constructor and Description
DynamicKeyObject(DynamicKeyObject.INSTANCESMAX instance, String eXTENSION)
DynamicKeyObject(DynamicKeyObject.INSTANCES instance, String eXTENSION)
DynamicKeyObject(int kEYSIZE, String aLGO, String iNSTANCE, String eXTENSION)

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm()
String	getFileExtension()
String	getInstance()
int	getKeySize()

Methods inherited from class org.waarp.common.crypto.KeyObject

crypt, crypt, cryptToHex, cryptToHex, decodeHex, decrypt, decryptHexFile, decryptHexInBytes, decryptHexInBytes, decryptHexInString, decryptHexInString, decryptInString, encodeHex, generateKey, getSecretKey, getSecretKeyInBytes, keyReady, saveSecretKey, setSecretKey, setSecretKey, setSecretKey, toCrypt, toDecrypt

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicKeyObject

public DynamicKeyObject(int kEYSIZE,
                        String aLGO,
                        String iNSTANCE,
                        String eXTENSION)

Parameters:

kEYSIZE - example DES: 56

aLGO - example DES: DES

iNSTANCE - example DES: DES/ECB/PKCS5Padding

eXTENSION - example DES: des

DynamicKeyObject

public DynamicKeyObject(DynamicKeyObject.INSTANCES instance,
                        String eXTENSION)

Parameters:

instance - the minimal default instance

eXTENSION - to use for files

DynamicKeyObject

public DynamicKeyObject(DynamicKeyObject.INSTANCESMAX instance,
                        String eXTENSION)

Parameters:

instance - the maximal default instance

eXTENSION - to use for files

Method Detail

getAlgorithm

public final String getAlgorithm()

Specified by:

getAlgorithm in class KeyObject

Returns:

the algorithm used (Java name)

getInstance

public final String getInstance()

Specified by:

getInstance in class KeyObject

Returns:

the instance used (Java name)

getKeySize

public final int getKeySize()

Specified by:

getKeySize in class KeyObject

Returns:

the size for the algorithm key

getFileExtension

public final String getFileExtension()

Specified by:

getFileExtension in class KeyObject

Returns:

the filename extension to use for this kind of key