com.google.crypto.tink.aead

Class AeadWrapper

java.lang.Object

com.google.crypto.tink.aead.AeadWrapper

All Implemented Interfaces:

PrimitiveWrapper<Aead,Aead>

public class AeadWrapper
extends Object
implements PrimitiveWrapper<Aead,Aead>

AeadWrapper is the implementation of SetWrapper for the Aead primitive.

Key rotation works as follows: each ciphertext is prefixed with the keyId. When decrypting, we first try all primitives whose keyId starts with the prefix of the ciphertext. If none of these succeed, we try the raw primitives. If any succeeds, we return the ciphertext, otherwise we simply throw a GeneralSecurityException.

Method Summary

Modifier and Type	Method and Description
Class<Aead>	getInputPrimitiveClass() Returns the primitive class object of the primitive used to create B.
Class<Aead>	getPrimitiveClass() Returns the primitive class object of the primitive managed.
static void	register()
static void	registerToInternalPrimitiveRegistry(PrimitiveRegistry.Builder primitiveRegistryBuilder) registerToInternalPrimitiveRegistry is a non-public method (it takes an argument of an internal-only type) registering an instance of AeadWrapper to the provided PrimitiveRegistry.Builder.
Aead	wrap(PrimitiveSet<Aead> pset) Wraps a PrimitiveSet and returns a single instance.

Methods inherited from class java.lang.Object

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

Method Detail

wrap

public Aead wrap(PrimitiveSet<Aead> pset)
          throws GeneralSecurityException

Description copied from interface: PrimitiveWrapper

Wraps a PrimitiveSet and returns a single instance.

This method gets called when a new primitive is created. primitiveSet is immutable. This has to be implemented when a new primitive type is added.

Specified by:

wrap in interface PrimitiveWrapper<Aead,Aead>

Throws:

GeneralSecurityException

getPrimitiveClass

public Class<Aead> getPrimitiveClass()

Description copied from interface: PrimitiveWrapper

Returns the primitive class object of the primitive managed. Used for internal management. Should be implemented as return P.class; when implementing a wrapper creating objects of type P.

Specified by:

getPrimitiveClass in interface PrimitiveWrapper<Aead,Aead>

getInputPrimitiveClass

public Class<Aead> getInputPrimitiveClass()

Description copied from interface: PrimitiveWrapper

Returns the primitive class object of the primitive used to create B. Used for internal management. Should be implemented as return B.class;.

Specified by:

getInputPrimitiveClass in interface PrimitiveWrapper<Aead,Aead>

register

public static void register()
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

registerToInternalPrimitiveRegistry

public static void registerToInternalPrimitiveRegistry(PrimitiveRegistry.Builder primitiveRegistryBuilder)
                                                throws GeneralSecurityException

registerToInternalPrimitiveRegistry is a non-public method (it takes an argument of an internal-only type) registering an instance of AeadWrapper to the provided PrimitiveRegistry.Builder.

Throws:

GeneralSecurityException