org.eclipse.californium.scandium.util

Class SecretIvParameterSpec

java.lang.Object

org.eclipse.californium.scandium.util.SecretIvParameterSpec

All Implemented Interfaces:

AlgorithmParameterSpec, Destroyable

public class SecretIvParameterSpec
extends Object
implements AlgorithmParameterSpec, Destroyable

Secure initial vector parameter specification. Additional Destroyable to clear the iv after usage.

Constructor Summary

Constructors

Constructor and Description
SecretIvParameterSpec(byte[] iv) Create new secure iv parameters.
SecretIvParameterSpec(byte[] iv, int offset, int length) Create new iv parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy iv material.
byte[]	getIV() Get copy of IV.
byte[]	getIV(byte[] explicitNonce) Get iv extended by the explicit nonce.
byte[]	getIV(byte[] explicitNonce, int offset, int length) Get iv extended by the explicit nonce.
boolean	isDestroyed()

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretIvParameterSpec

public SecretIvParameterSpec(byte[] iv)

Create new secure iv parameters.

Parameters:

iv - byte array

Throws:

NullPointerException - if iv is null

IllegalArgumentException - if iv is empty.

SecretIvParameterSpec

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

Create new iv parameters.

Parameters:

iv - byte array with the iv.

offset - offset of the iv within the byte array

length - length of the iv within the byte array

Throws:

NullPointerException - if iv is null

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

Method Detail

getIV

public byte[] getIV()

Get copy of IV.

Returns:

copy of iv.

Throws:

IllegalStateException - if instance was already destroyed

getIV

public byte[] getIV(byte[] explicitNonce)

Get iv extended by the explicit nonce.

Parameters:

explicitNonce - byte array of explicit nonce.

Returns:

iv extended by explicit nonce

Throws:

NullPointerException - if explicit nonce is null

IllegalArgumentException - explicit nonce iv is empty

IllegalStateException - if instance was already destroyed

getIV

public byte[] getIV(byte[] explicitNonce,
           int offset,
           int length)

Get iv extended by the explicit nonce.

Parameters:

explicitNonce - byte array of explicit nonce.

offset - offset within byte array

length - length within byte array

Returns:

iv extended by explicit nonce

Throws:

NullPointerException - if explicit nonce is null

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

IllegalStateException - if instance was already destroyed

destroy

public void destroy()
             throws DestroyFailedException

Destroy iv material.

Specified by:

destroy in interface Destroyable

Throws:

DestroyFailedException

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable