com.absio.crypto.key

Class KeyRing

java.lang.Object

com.absio.crypto.key.KeyRing

All Implemented Interfaces:

IPublicKeySource

public class KeyRing
extends Object
implements IPublicKeySource

This represents a "users" key ring in the Absio ecosystem. A key ring is made up of the user's ID, and a historical list of their signing and derivation keys. These keys are all private elliptical curve keys - see IndexedECPrivateKey. This has a helper methods to return the latest active key of each type (signing or derivation). That will return the active key with the largest index.

Constructor Summary

Constructors

Constructor and Description
KeyRing() Default constructor.
KeyRing(ArrayList<IndexedECPrivateKey> derivationKeys, ArrayList<IndexedECPrivateKey> signingKeys) Create a key ring with the given derivation and signing keys.
KeyRing(UUID userId) Create a key ring with the given user id.
KeyRing(UUID userId, ArrayList<IndexedECPrivateKey> derivationKeys, ArrayList<IndexedECPrivateKey> signingKeys) Create a key ring with the give user id, derivation keys and signing keys.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) See if this object equals another
IndexedECPrivateKey	findPrivateKeyByIndex(int index, KeyType type) Finds the private key with the matching index and type.
IndexedECPublicKey	getByIndex(UUID userId, KeyType type, int index) This gets the public key that match the user ID, type and inde.
ArrayList<IndexedECPrivateKey>	getDerivationKeys() Get the list of IndexedECPrivateKey derivation keys for this KeyRing.
IndexedECPublicKey	getLatestActive(UUID userId, KeyType type) This gets the latest active public key that match the user ID and type.
ArrayList<IndexedECPrivateKey>	getSigningKeys() Get the list of IndexedECPrivateKey signing keys for this KeyRing.
UUID	getUserId() Get the user's id for this KeyRing.
int	hashCode() Get the unique hash code for this object.
IndexedECPrivateKey	latestActiveDerivationKey() Get the active IndexedECPrivateKey derivation key with the largest index for this KeyRing.
IndexedECPrivateKey	latestActiveSigningKey() Get the active IndexedECPrivateKey signing key with the largest index for this KeyRing.
void	setUserId(UUID userId) Set the user's id for this KeyRing.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyRing

public KeyRing(UUID userId,
               ArrayList<IndexedECPrivateKey> derivationKeys,
               ArrayList<IndexedECPrivateKey> signingKeys)

Create a key ring with the give user id, derivation keys and signing keys.

Parameters:

userId - the UUID of the user

derivationKeys - a list of derivation keys (see IndexedECPrivateKey)

signingKeys - a list of signing keys (see IndexedECPrivateKey)

KeyRing

public KeyRing()
        throws InvalidAlgorithmParameterException,
               NoSuchAlgorithmException

Default constructor.

This will create one random active signing and derivation key with an index of 0 and a null user ID.

Throws:

NoSuchAlgorithmException - thrown if the JCE does not support the algorithm of the key

InvalidAlgorithmParameterException - thrown if the parameters of the algorithm are not supported

KeyRing

public KeyRing(UUID userId)
        throws NoSuchAlgorithmException,
               InvalidAlgorithmParameterException

Create a key ring with the given user id. This will create one random active signing and and derivation key with an index of 0.

Parameters:

userId - the UUID of the user

Throws:

NoSuchAlgorithmException - thrown if the JCE does not support the algorithm of the key

InvalidAlgorithmParameterException - thrown if the parameters of the algorithm are not supported

KeyRing

public KeyRing(ArrayList<IndexedECPrivateKey> derivationKeys,
               ArrayList<IndexedECPrivateKey> signingKeys)

Create a key ring with the given derivation and signing keys. The user id will be null

Parameters:

derivationKeys - a list of derivation keys (see IndexedECPrivateKey)

signingKeys - a list of signing keys (see IndexedECPrivateKey)

Method Detail

equals

public boolean equals(Object obj)

See if this object equals another

Overrides:

equals in class Object

Parameters:

obj - the object to compare with

Returns:

true if obj is a KeyRing and the contents of the objects are the same

findPrivateKeyByIndex

public IndexedECPrivateKey findPrivateKeyByIndex(int index,
                                                 KeyType type)

Finds the private key with the matching index and type.

Parameters:

index - the index to find

type - the key type to find

Returns:

the private key with the matching index or null

getByIndex

public IndexedECPublicKey getByIndex(UUID userId,
                                     KeyType type,
                                     int index)

Description copied from interface: IPublicKeySource

This gets the public key that match the user ID, type and inde.

Specified by:

getByIndex in interface IPublicKeySource

Parameters:

userId - the user id of the key owner

type - the KeyType of the key

index - the index of the key

Returns:

the IndexedECPublicKey for the user of the specified KeyType and index

getDerivationKeys

public ArrayList<IndexedECPrivateKey> getDerivationKeys()

Get the list of IndexedECPrivateKey derivation keys for this KeyRing.

Returns:

the list of IndexedECPrivateKey derivation keys for this KeyRing

getLatestActive

public IndexedECPublicKey getLatestActive(UUID userId,
                                          KeyType type)

Description copied from interface: IPublicKeySource

This gets the latest active public key that match the user ID and type.

NOTE: if there is not an active key null will be returned.

Specified by:

getLatestActive in interface IPublicKeySource

Parameters:

userId - the user's ID

type - the KeyType of public key

Returns:

the latest active public key for the user of the specified KeyType

getSigningKeys

public ArrayList<IndexedECPrivateKey> getSigningKeys()

Get the list of IndexedECPrivateKey signing keys for this KeyRing.

Returns:

the list of IndexedECPrivateKey signing keys for this KeyRing

getUserId

public UUID getUserId()

Get the user's id for this KeyRing.

Returns:

the user's id for this KeyRing

setUserId

public void setUserId(UUID userId)

Set the user's id for this KeyRing.

Parameters:

userId - the user's id for this KeyRing

hashCode

public int hashCode()

Get the unique hash code for this object.

Overrides:

hashCode in class Object

Returns:

the unique hash code for this object

latestActiveDerivationKey

public IndexedECPrivateKey latestActiveDerivationKey()

Get the active IndexedECPrivateKey derivation key with the largest index for this KeyRing.

Returns:

the active IndexedECPrivateKey derivation key with the largest index for this KeyRing

latestActiveSigningKey

public IndexedECPrivateKey latestActiveSigningKey()

Get the active IndexedECPrivateKey signing key with the largest index for this KeyRing.

Returns:

the active IndexedECPrivateKey signing key with the largest index for this KeyRing