Docs4dev
Docs
openjdk / 21 / java.base / javax / crypto / spec / chacha20parameterspec.html

Class ChaCha20ParameterSpec

java.lang.Object
javax.crypto.spec.ChaCha20ParameterSpec
All Implemented Interfaces:
AlgorithmParameterSpec 
public final class ChaCha20ParameterSpec extends Object implements AlgorithmParameterSpec
This class specifies the parameters used with the ChaCha20 algorithm.

The parameters consist of a 12-byte nonce and an initial counter value expressed as a 32-bit integer.

This class can be used to initialize a Cipher object that implements the ChaCha20 algorithm.

Since:
11

Constructor Summary

Constructor Description
ChaCha20ParameterSpec(byte[] nonce, int counter)
Constructs a parameter set for ChaCha20 from the given nonce and counter.

Method Summary

Modifier and Type Method Description
int getCounter()
Returns the configured counter value.
byte[] getNonce()
Returns the nonce value.

Methods declared in class java.lang.Object

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

Constructor Details

ChaCha20ParameterSpec

public ChaCha20ParameterSpec(byte[] nonce, int counter)
Constructs a parameter set for ChaCha20 from the given nonce and counter.
Parameters:
nonce - a 12-byte nonce value
counter - the initial counter value
Throws:
NullPointerException - if nonce is null
IllegalArgumentException - if nonce is not 12 bytes in length

Method Details

getNonce

public byte[] getNonce()
Returns the nonce value.
Returns:
the nonce value. This method returns a new array each time this method is called.

getCounter

public int getCounter()
Returns the configured counter value.
Returns:
the counter value

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/crypto/spec/ChaCha20ParameterSpec.html