org.eclipse.californium.scandium.util

Class SecretUtil

java.lang.Object

org.eclipse.californium.scandium.util.SecretUtil

public class SecretUtil
extends Object

Utility to use Destroyable SecretKey for java before 1.8.

Constructor Summary

Constructors

Constructor and Description
SecretUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static SecretKey	create(byte[] secret, int offset, int length, String algorithm) Create a secret key.
static SecretKey	create(byte[] secret, String algorithm) Creates a secret key.
static SecretKey	create(SecretKey key) Creates a copy of a secret key.
static SecretIvParameterSpec	createIv(byte[] iv, int offset, int length) Create secret iv paramter (with destroyable implementation).
static SecretIvParameterSpec	createIv(SecretIvParameterSpec iv) Creates copy of a secret init vector.
static void	destroy(Destroyable destroyable) Destroy provided security destroyable.
static void	destroy(SecretKey key) Destroy secret key.
static boolean	isDestroyed(Destroyable destroyable) Checks if a given destroyable has already been destroyed.
static boolean	isDestroyed(SecretKey key) Checks if a secret key has already been destroyed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretUtil

public SecretUtil()

Method Detail

destroy

public static void destroy(SecretKey key)

Destroy secret key.

Parameters:

key - secret key to destroy. If null, nothing is destroyed.

destroy

public static void destroy(Destroyable destroyable)

Destroy provided security destroyable.

Parameters:

destroyable - object to destroy. Maybe null.

isDestroyed

public static boolean isDestroyed(SecretKey key)

Checks if a secret key has already been destroyed.

Parameters:

key - secret key to check (may be null).

Returns:

true if the key either is null or has been destroyed.

isDestroyed

public static boolean isDestroyed(Destroyable destroyable)

Checks if a given destroyable has already been destroyed.

Parameters:

destroyable - The destroyable to check (may be null).

Returns:

true if the given object either is null or has been destroyed.

create

public static SecretKey create(byte[] secret,
               String algorithm)

Creates a secret key.

Parameters:

secret - The key material.

algorithm - The algorithm that the key is used for. The name PSK should be used if the key is supposed to be used with a PSK based TLS handshake.

Returns:

The newly created key which also implements javax.security.auth.Destroyable.

create

public static SecretKey create(byte[] secret,
               int offset,
               int length,
               String algorithm)

Create a secret key.

Parameters:

secret - The source to copy the key material from.

offset - The start index from which the key material should be copied.

length - The number of bytes to copy.

algorithm - The algorithm that the key is used for. The name PSK should be used if the key is supposed to be used with a PSK based TLS handshake.

Returns:

The newly created key which also implements javax.security.auth.Destroyable.

create

public static SecretKey create(SecretKey key)

Creates a copy of a secret key.

Parameters:

key - The key to copy (may be null).

Returns:

The newly created key or null if the provided key was null. The returned key also implements javax.security.auth.Destroyable.

createIv

public static SecretIvParameterSpec createIv(SecretIvParameterSpec iv)

Creates copy of a secret init vector.

Parameters:

iv - The init vector to copy (may be null).

Returns:

The newly created IV, or null if the provided IV was null.

createIv

public static SecretIvParameterSpec createIv(byte[] iv,
                             int offset,
                             int length)

Create secret iv paramter (with destroyable implementation).

Parameters:

iv - as byte array

offset - offset of iv within the provided byte array

length - length of iv

Returns:

the secreate iv

Throws:

NullPointerException - if iv is null

IllegalArgumentException - if iv is empty, or len is negative or offset and length doesn't fit into iv.