com.absio.container

Class Keys

java.lang.Object

com.absio.container.Keys

public class Keys
extends Object

This represents the keys needed to property encrypt a Container or decrypt a SecuredContainer. There is a cipher key (encrypt/decrypt) and a mac key (content validation to avoid tampering).

Constructor Summary

Constructors

Constructor and Description
Keys() Create a new set of Keys using CipherTransformation.AES_CTR_NOPADDING, MacAlgorithm.HMACSHA384 and new random keys.
Keys(CipherTransformation cipherTransformation, byte[] cipherKey, MacAlgorithm macAlgorithm, byte[] macKey) Create a keys object using the parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Keys keys) Check to see if the passed in key equals this key (cipher transformation, cipher key, mac algorithm and mac key)
boolean	equals(Object obj)
byte[]	getCipherKey() Get the cipher key.
CipherTransformation	getCipherTransformation() Get the cipher transformation used when encrypting and decrypting with the cipher key.
MacAlgorithm	getMacAlgorithm() Get the mac algorithm to use when creating or verifying a digest with the mac key.
byte[]	getMacKey() Get the mac key to use when creating or verifying a digest.
UUID	getUserId() Get the user's id that created the keys.
int	hashCode()
void	setUserId(UUID userId) Set the user's id that created the keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

Keys

public Keys()

Create a new set of Keys using CipherTransformation.AES_CTR_NOPADDING, MacAlgorithm.HMACSHA384 and new random keys.

Keys

public Keys(CipherTransformation cipherTransformation,
            byte[] cipherKey,
            MacAlgorithm macAlgorithm,
            byte[] macKey)

Create a keys object using the parameters.

Parameters:

cipherTransformation - the cipher transformation to be used with the cipher key

cipherKey - the cipher key for encryption/decryption operations

macAlgorithm - the mac algorithm used with the mac key for data validation

macKey - the mac key used to create and verify digests - data validation

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(Keys keys)

Check to see if the passed in key equals this key (cipher transformation, cipher key, mac algorithm and mac key)

Parameters:

keys - the key to compare to this key

Returns:

true if the keys equals

getCipherKey

public byte[] getCipherKey()

Get the cipher key. The is the symmetric key used for encryption of a Container and decryption of a SecuredContainer.

Returns:

the cipher key

getCipherTransformation

public CipherTransformation getCipherTransformation()

Get the cipher transformation used when encrypting and decrypting with the cipher key.

Returns:

the cipher transformation

getMacAlgorithm

public MacAlgorithm getMacAlgorithm()

Get the mac algorithm to use when creating or verifying a digest with the mac key.

Returns:

the mac algorithm

getMacKey

public byte[] getMacKey()

Get the mac key to use when creating or verifying a digest.

Returns:

the mac key

getUserId

public UUID getUserId()

Get the user's id that created the keys.

Returns:

the user's id that created the keys

setUserId

public void setUserId(UUID userId)

Set the user's id that created the keys.

Parameters:

userId - the user's id that created the keys

hashCode

public int hashCode()

Overrides:

hashCode in class Object