Module com.aoapps.security

Package com.aoapps.security

Class Key

java.lang.Object

com.aoapps.security.Key

All Implemented Interfaces:

AutoCloseable, Cloneable, Destroyable

Direct Known Subclasses:

UnprotectedKey

public class Key
extends Object
implements Destroyable, AutoCloseable, Cloneable

Represents plaintext random keys, with support for wiping the contents. This is used in preference to byte[] as a matter of both convenience and protection.

This does not provide any access to the given key. It is a key black hole: gone forever from outside observers. The only way a key is available is through a newly generated key.

Instances of this class are thread-safe.

This class intentionally does not implement equals(java.lang.Object) and hashCode(), as it is not intended to be used in data structures or any complex manipulation. It is solely meant to safely carry a key.

This class also does not implement Serializable or Externalizable. Applications that need to send keys across the wire must use another mechanism. Applications that need to store keys should be using HashedKey.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
Key(byte[] key)

Method Summary

Modifier and Type	Method	Description
Key	clone()
void	close()	Destroys the key on auto-close.
void	destroy()
boolean	equals(Object obj)
int	hashCode()	Uses default implementation from Object.hashCode().
boolean	isDestroyed()
String	toString()
static Optional<Key>	valueOf(byte[] key)	Gets a new key or Optional.empty() when key == null || key.length == 0.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Key

public Key(byte[] key)
    throws IllegalArgumentException

Parameters:

key - Is zeroed before this method returns. If the original key is needed, pass a copy to this method.

Throws:

IllegalArgumentException - when key == null || key.length == 0 or when key is already destroyed (contains all zeroes).

See Also:

• valueOf(byte[])

Method Details

valueOf

public static Optional<Key> valueOf(byte[] key)
                             throws IllegalArgumentException

Gets a new key or Optional.empty() when key == null || key.length == 0.

Parameters:

key - Is zeroed before this method returns. If the original key is needed, pass a copy to this method.

Throws:

IllegalArgumentException - when key is already destroyed (contains all zeroes).

See Also:

• Key(byte[])

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Uses default implementation from Object.hashCode(). Any meaningful implementation could leak private key information. Use UnprotectedKey instead when needing to use in hash-based data structures.

Overrides:

hashCode in class Object

clone

public Key clone()

Overrides:

clone in class Object

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

close

public void close()

Destroys the key on auto-close. This use for support of try-with-resources.

Specified by:

close in interface AutoCloseable