com.google.crypto.tink.aead.internal

Class XChaCha20Poly1305Jce

java.lang.Object

com.google.crypto.tink.aead.internal.XChaCha20Poly1305Jce

All Implemented Interfaces:

Aead

@Immutable
public final class XChaCha20Poly1305Jce
extends Object
implements Aead

ChaCha20Poly1305Jce implements an AEAD for ChaCha20Poly1305, as described in RFC 8439, section 2.8.

It uses the JCE, and requires that algorithm "ChaCha20-Poly1305" is present.

Method Summary

Modifier and Type	Method and Description
static Aead	create(XChaCha20Poly1305Key key)
byte[]	decrypt(byte[] ciphertext, byte[] associatedData) Decrypts ciphertext with associatedData as associated authenticated data.
byte[]	encrypt(byte[] plaintext, byte[] associatedData) Encrypts plaintext with associatedData as associated authenticated data.
static boolean	isSupported()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Aead create(XChaCha20Poly1305Key key)
                   throws GeneralSecurityException

Throws:

GeneralSecurityException

isSupported

public static boolean isSupported()

encrypt

public byte[] encrypt(byte[] plaintext,
                      byte[] associatedData)
               throws GeneralSecurityException

Description copied from interface: Aead

Encrypts plaintext with associatedData as associated authenticated data. The resulting ciphertext allows for checking authenticity and integrity of associated data (associatedData), but does not guarantee its secrecy.

Specified by:

encrypt in interface Aead

Parameters:

plaintext - the plaintext to be encrypted. It must be non-null, but can also be an empty (zero-length) byte array

associatedData - associated data to be authenticated, but not encrypted. Associated data is optional, so this parameter can be null. In this case the null value is equivalent to an empty (zero-length) byte array. For successful decryption the same associatedData must be provided along with the ciphertext.

Returns:

resulting ciphertext

Throws:

GeneralSecurityException

decrypt

public byte[] decrypt(byte[] ciphertext,
                      byte[] associatedData)
               throws GeneralSecurityException

Description copied from interface: Aead

Decrypts ciphertext with associatedData as associated authenticated data. The decryption verifies the authenticity and integrity of the associated data, but there are no guarantees wrt. secrecy of that data.

Specified by:

decrypt in interface Aead

Parameters:

ciphertext - the plaintext to be decrypted. It must be non-null.

associatedData - associated data to be authenticated. For successful decryption it must be the same as associatedData used during encryption. Can be null, which is equivalent to an empty (zero-length) byte array.

Returns:

resulting plaintext

Throws:

GeneralSecurityException - if decryption fails. Decryption must fail if ciphertext is not correctly authenticated for the given associatedData.