com.hissenit.crypto.compactencryption

Class EncryptionKey

java.lang.Object

com.hissenit.crypto.compactencryption.EncryptionKey

All Implemented Interfaces:

ISecretKey

public class EncryptionKey
extends java.lang.Object
implements ISecretKey

This class uses a raw key (byte array) to store and read a plain symmetric encryption key (default for AES). Storing a plain key somewhere requires other security measures to store the key securely!

Constructor Summary

Constructors

Constructor and Description
EncryptionKey() Creates an uninitialized key.
EncryptionKey(byte[] key)

Method Summary

Methods

Modifier and Type	Method and Description
static EncryptionKey	generateNewKey()
static EncryptionKey	generateNewKey(int keyLengthInBytes)
javax.crypto.spec.SecretKeySpec	getJCESecretKeySpec()
byte[]	getKeyCloneInBytes() Returns a new copy of the key
byte[]	getKeyInBytes()
EncryptionKey	readFromBase64(java.lang.String base64)
EncryptionKey	readFromFile(java.io.File file)
EncryptionKey	readFromFile(java.lang.String file)
EncryptionKey	readFromHex(java.lang.String hex)
EncryptionKey	readFromJsonObject(morg.json.JSONObject json)
EncryptionKey	readFromJsonString(java.lang.String json)
EncryptionKey	readFromStream(java.io.InputStream in)
void	wipe() Wipes the key (bytes) in this object - meaning overwrites it with arbitrary data.
java.lang.String	writeToBase64()
byte[]	writeToBytes() Returns a new copy of the key
void	writeToFile(java.io.File file)
void	writeToFile(java.lang.String file)
java.lang.String	writeToHex()
morg.json.JSONObject	writeToJsonObject()
java.lang.String	writeToJsonString()
void	writeToStream(java.io.OutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptionKey

public EncryptionKey(byte[] key)

EncryptionKey

public EncryptionKey()

Creates an uninitialized key. The key has to be loaded by one of the read* methods.

Method Detail

getKeyInBytes

public byte[] getKeyInBytes()

Specified by:

getKeyInBytes in interface ISecretKey

getKeyCloneInBytes

public byte[] getKeyCloneInBytes()

Returns a new copy of the key

Returns:

the symmetric encryption key as byte array

writeToBytes

public byte[] writeToBytes()

Returns a new copy of the key

Returns:

the symmetric encryption key as byte array

writeToBase64

public java.lang.String writeToBase64()

writeToHex

public java.lang.String writeToHex()

writeToJsonString

public java.lang.String writeToJsonString()

writeToJsonObject

public morg.json.JSONObject writeToJsonObject()

writeToStream

public void writeToStream(java.io.OutputStream out)

writeToFile

public void writeToFile(java.lang.String file)

writeToFile

public void writeToFile(java.io.File file)

readFromBase64

public EncryptionKey readFromBase64(java.lang.String base64)

readFromHex

public EncryptionKey readFromHex(java.lang.String hex)

readFromJsonString

public EncryptionKey readFromJsonString(java.lang.String json)

readFromJsonObject

public EncryptionKey readFromJsonObject(morg.json.JSONObject json)

readFromStream

public EncryptionKey readFromStream(java.io.InputStream in)

readFromFile

public EncryptionKey readFromFile(java.lang.String file)

readFromFile

public EncryptionKey readFromFile(java.io.File file)

getJCESecretKeySpec

public javax.crypto.spec.SecretKeySpec getJCESecretKeySpec()

wipe

public void wipe()

Wipes the key (bytes) in this object - meaning overwrites it with arbitrary data. This does not apply for external clones.

Specified by:

wipe in interface ISecretKey

generateNewKey

public static final EncryptionKey generateNewKey()

generateNewKey

public static final EncryptionKey generateNewKey(int keyLengthInBytes)