iaik.security.cipher

Class ChaCha20Poly1305ParameterSpec

java.lang.Object

javax.crypto.spec.IvParameterSpec

iaik.security.cipher.ChaCha20ParameterSpec

iaik.security.cipher.ChaCha20Poly1305ParameterSpec

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec

Direct Known Subclasses:

ChaCha20Poly1305CMSParameterSpec

public class ChaCha20Poly1305ParameterSpec
extends ChaCha20ParameterSpec

ChaCha20Poly1305 parameter specification.

The parameters are a 96 bit nonce value (also known as initialization vector) and additional associated data.

Note that associated data may be supplied to the ChaCha20Poly1305 Cipher only either by means of a ChaCha20Poly1305ParameterSpec or by calling chacha20Poly1305Cipher.updateAAD(). Supplying associated data by both ChaCha20Poly1305ParameterSpec and calling chacha20Poly1305Cipher.updateAAD() is not allowed.
If associated data is specified by a ChaCha20Poly1305ParameterSpec the associated data is also included in the parameters got from a ChaCha20Poly1305 Cipher when calling chacha20Poly1305Cipher.getParameters(). However, associated data that has been supplied by calling chacha20Poly1305Cipher.updateAAD() is not included in the parameters got from a ChaCha20Poly1305 Cipher when calling chacha20Poly1305Cipher.getParameters().

Version:

File Revision 6

Constructor Summary

Constructors

Constructor and Description
ChaCha20Poly1305ParameterSpec(byte[] nonce) Creates a ChaCha20Poly1305ParameterSpec from the given nonce value.
ChaCha20Poly1305ParameterSpec(byte[] aaData, byte[] nonce) Creates a ChaCha20Poly1305ParameterSpec from additional associated data (aad) and the nonce.
ChaCha20Poly1305ParameterSpec(byte[] aaData, byte[] nonce, int blockCounter) Creates a ChaCha20Poly1305ParameterSpec from additional associated data (aad), nonce and ChaCha20 block counter.
ChaCha20Poly1305ParameterSpec(byte[] nonce, int blockCounter) Creates a ChaCha20Poly1305ParameterSpec from the given nonce value and ChaCha20 block counter.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getAAD() Gets any additional associated data.
byte[]	getNonce() Gets the nonce value.

Methods inherited from class iaik.security.cipher.ChaCha20ParameterSpec

getBlockCounter

Methods inherited from class javax.crypto.spec.IvParameterSpec

getIV

Methods inherited from class java.lang.Object

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

Constructor Detail

ChaCha20Poly1305ParameterSpec

public ChaCha20Poly1305ParameterSpec(byte[] nonce)

Creates a ChaCha20Poly1305ParameterSpec from the given nonce value.

Parameters:

nonce - the nonce

Throws:

java.lang.IllegalArgumentException - if nonce is not 96 bit long

ChaCha20Poly1305ParameterSpec

public ChaCha20Poly1305ParameterSpec(byte[] nonce,
                             int blockCounter)

Creates a ChaCha20Poly1305ParameterSpec from the given nonce value and ChaCha20 block counter.

Parameters:

nonce - the nonce

blockCounter - the blockCounter (default: 0)

Throws:

java.lang.IllegalArgumentException - if nonce is not 96 bit long or or blockCounter is negative

ChaCha20Poly1305ParameterSpec

public ChaCha20Poly1305ParameterSpec(byte[] aaData,
                             byte[] nonce)

Creates a ChaCha20Poly1305ParameterSpec from additional associated data (aad) and the nonce.

Note that associated data may be supplied to the ChaCha20Poly1305 Cipher only either by means of a ChaCha20Poly1305ParameterSpec or by calling chacha20Poly1305Cipher.updateAAD(). Supplying associated data by both ChaCha20Poly1305ParameterSpec and calling chacha20Poly1305Cipher.updateAAD() is not allowed.
If associated data is specified by a ChaCha20Poly130ParameterSpec the associated data is also included in the parameters got from a ChaCha20Poly1305 Cipher when calling chacha20Poly1305Cipher.getParameters(). However, associated data that has been supplied by calling chacha20Poly1305Cipher.updateAAD() is not included in the parameters got from a ChaCha20Poly1305 Cipher when calling chacha20Poly1305Cipher.getParameters().

Parameters:

aaData - the additional associated data

nonce - the nonce

Throws:

java.lang.IllegalArgumentException - if nonce is not 96 bit long

ChaCha20Poly1305ParameterSpec

public ChaCha20Poly1305ParameterSpec(byte[] aaData,
                             byte[] nonce,
                             int blockCounter)

Creates a ChaCha20Poly1305ParameterSpec from additional associated data (aad), nonce and ChaCha20 block counter.

Note that associated data may be supplied to the ChaCha20Poly1305 Cipher only either by means of a ChaCha20Poly1305ParameterSpec or by calling chacha20Poly1305Cipher.updateAAD(). Supplying associated data by both ChaCha20Poly1305ParameterSpec and calling chacha20Poly1305Cipher.updateAAD() is not allowed.
If associated data is specified by a ChaCha20Poly130ParameterSpec the associated data is also included in the parameters got from a ChaCha20Poly1305 Cipher when calling chacha20Poly1305Cipher.getParameters(). However, associated data that has been supplied by calling chacha20Poly1305Cipher.updateAAD() is not included in the parameters got from a ChaCha20Poly1305 Cipher when calling chacha20Poly1305Cipher.getParameters().

Parameters:

aaData - the additional associated data

nonce - the nonce

blockCounter - the blockCounter (default: 0)

Throws:

java.lang.IllegalArgumentException - if nonce is not 96 bit long or blockCounter is not 0

Method Detail

getNonce

public byte[] getNonce()

Gets the nonce value.

Overrides:

getNonce in class ChaCha20ParameterSpec

Returns:

the nonce value

getAAD

public byte[] getAAD()

Gets any additional associated data.

Returns:

the additional associated data or null if no additional associated data has been set