iaik.security.cipher

Class ChaCha20Poly1305Parameters

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.security.cipher.ChaCha20Poly1305Parameters

public class ChaCha20Poly1305Parameters
extends java.security.AlgorithmParametersSpi

Opaque parameter representation for the ChaCha20Poly1305 AEAD algorithm.

Whereas transparent ChaCha20Poly1305 parameters may contain additional associated data and nonce value, the DER encoded opaque parameter representation contains the nonce value only according to RFC 8103 (Using ChaCha20-Poly1305 Authenticated Encryption in the Cryptographic Message Syntax (CMS)):

 AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
 

ChaCha20Poly1305Parameters can be generated by calling one of the AlgorithmParameters.getInstance methods. Subsequently the new AlgorithmParameters object must be initialized with a proper parameter specification (class ChaCha20Poly1305ParameterSpec is recommended) or a DER encoded byte array, e.g.

 ChaCha20Poly1305ParameterSpec chaCha20Poly1305ParameterSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("ChaCha20Poly1305", "IAIK");
 params.init(chaCha20Poly1305ParameterSpec);
 

The CCMParameters can also be initialized with an IvParameterSpec object. In this case, the specified IV will be used as nonce.

Version:

File Revision 5

Constructor Summary

Constructors

Constructor and Description
ChaCha20Poly1305Parameters()

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	engineGetEncoded() Returns the parameters as DER byte array.
protected byte[]	engineGetEncoded(java.lang.String format) Returns the parameters as a DER byte array.
protected java.security.spec.AlgorithmParameterSpec	engineGetParameterSpec(java.lang.Class paramSpec) Returns the parameters as transparent parameter specification of the given class type.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this parameters object using the parameters specified in paramSpec.
protected void	engineInit(byte[] params) Inits the parameters from an DER encoded byte array.
protected void	engineInit(byte[] params, java.lang.String format) Inits the parameters from an DER encoded byte array.
protected java.lang.String	engineToString() Returns a formatted string describing the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChaCha20Poly1305Parameters

public ChaCha20Poly1305Parameters()

Method Detail

engineInit

protected void engineInit(java.security.spec.AlgorithmParameterSpec paramSpec)
                   throws java.security.spec.InvalidParameterSpecException

Initializes this parameters object using the parameters specified in paramSpec.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the parameter specification - must be ChaCha20Poly1305ParameterSpec or IvParameterSpec.

Throws:

java.security.spec.InvalidParameterSpecException - if the given parameter specification is inappropriate for the initialization of this parameter object (not a ChaCha20Poly1305ParameterSpec, ChaCha20ParameterSpec or IvParameterSpec).

engineInit

protected void engineInit(byte[] params)
                   throws java.io.IOException

Inits the parameters from an DER encoded byte array.

The DER encoded parameters must represent an ASN.1 OCTET_STRING containing the nonce value as specified by RFC 8103 (Using ChaCha20-Poly1305 Authenticated Encryption in the Cryptographic Message Syntax (CMS)):

 AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
 

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the DER encoded byte array

Throws:

java.io.IOException - if an error occurs when decoding the given byte array

engineInit

protected void engineInit(byte[] params,
              java.lang.String format)
                   throws java.io.IOException

Inits the parameters from an DER encoded byte array. Format is ignored. Only calls {engineInit(params) for initializing this ChaCha20Poly1305Parameters object from the given DER encoded byte array, regardless of what is specified in the format string.

The DER encoded parameters must represent an ASN.1 OCTET_STRING containing the nonce value as specified by RFC 8103 (Using ChaCha20-Poly1305 Authenticated Encryption in the Cryptographic Message Syntax (CMS)):

 AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
 

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the DER encoded byte array

format - the encoding format; ignored

Throws:

java.io.IOException - if an error occurs when decoding the given byte array

engineGetParameterSpec

protected java.security.spec.AlgorithmParameterSpec engineGetParameterSpec(java.lang.Class paramSpec)
                                                                    throws java.security.spec.InvalidParameterSpecException

Returns the parameters as transparent parameter specification of the given class type.

Specified by:

engineGetParameterSpec in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the desired parameter specification class (ChaCha20Poly1305ParameterSpec or ChaCha20ParameterSpec or IvParameterSpec)

Returns:

the parameters as ChaCha20Poly1305ParameterSpec or ChaCha20ParameterSpec or IvParameterSpec

Throws:

java.security.spec.InvalidParameterSpecException - if the parameters cannot be converted to the desired parameter specification (must be a ChaCha20Poly1305ParameterSpec, ChaCha20ParameterSpec or IvParameterSpec).

engineGetEncoded

protected byte[] engineGetEncoded()
                           throws java.io.IOException

Returns the parameters as DER byte array.

The encoded parameters returned by this method represent an ASN.1 OCTET_STRING containing the nonce value as specified by RFC 8103 (Using ChaCha20-Poly1305 Authenticated Encryption in the Cryptographic Message Syntax (CMS)):

 AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
 

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Returns:

the ChaCha20Poly1305 parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

engineGetEncoded

protected byte[] engineGetEncoded(java.lang.String format)
                           throws java.io.IOException

Returns the parameters as a DER byte array.

Format is ignored. Only DER encoding is supported at this time. This method only calls engineGetEncoded(), regardless of what is specified in the format string.

The encoded parameters returned by this method represent an ASN.1 OCTET_STRING containing the nonce value as specified by RFC 8103 (Using ChaCha20-Poly1305 Authenticated Encryption in the Cryptographic Message Syntax (CMS)):

 AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
 

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Parameters:

format - the encoding format; ignored

Returns:

the ChaCha20Poly1305 parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

engineToString

protected java.lang.String engineToString()

Returns a formatted string describing the parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a formatted string describing the parameters.