com.google.crypto.tink.aead

Class AeadKey

java.lang.Object

com.google.crypto.tink.Key

com.google.crypto.tink.aead.AeadKey

Direct Known Subclasses:

AesEaxKey, AesGcmKey, AesGcmSivKey, ChaCha20Poly1305Key, XChaCha20Poly1305Key

public abstract class AeadKey
extends Key

Represents functions to encrypt and decrypt data using AEAD.

Constructor Summary

Constructors

Constructor and Description
AeadKey()

Method Summary

Modifier and Type	Method and Description
abstract Bytes	getOutputPrefix() Returns a Bytes instance which is prefixed to the ciphertext.
abstract AeadParameters	getParameters() Returns the parameters of this key.

Methods inherited from class com.google.crypto.tink.Key

equalsKey, getIdRequirementOrNull

Methods inherited from class java.lang.Object

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

Constructor Detail

AeadKey

public AeadKey()

Method Detail

getOutputPrefix

public abstract Bytes getOutputPrefix()

Returns a Bytes instance which is prefixed to the ciphertext.

In order to make key rotation more efficient, Tink allows every Aead key to be prefixed with a sequence of bytes. When decrypting data, only keys with matching prefix have to be tried.

Note that a priori, the output prefix may not be unique in a keyset (i.e., different keys in a keyset may have the same prefix or, one prefix may be a prefix of the other). To avoid this, built in Tink keys use the convention that the prefix is either '0x00' or '0x01'. See the Tink keys for details.

getParameters

public abstract AeadParameters getParameters()

Returns the parameters of this key.

Specified by:

getParameters in class Key