com.google.crypto.tink

Class PrimitiveSet<P>

java.lang.Object

com.google.crypto.tink.PrimitiveSet<P>

public final class PrimitiveSet<P>
extends Object

A container class for a set of primitives -- implementations of cryptographic primitives offered by Tink.

It provides also additional properties for the primitives it holds. In particular, one of the primitives in the set can be distinguished as "the primary" one.

PrimitiveSet is an auxiliary class used for supporting key rotation: primitives in a set correspond to keys in a keyset. Users will usually work with primitive instances, which essentially wrap primitive sets. For example an instance of an Aead-primitive for a given keyset holds a set of Aead-primitives corresponding to the keys in the keyset, and uses the set members to do the actual crypto operations: to encrypt data the primary Aead-primitive from the set is used, and upon decryption the ciphertext's prefix determines the id of the primitive from the set.

PrimitiveSet is a public class to allow its use in implementations of custom primitives.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrimitiveSet.Entry<P> A single entry in the set.

Method Summary

Modifier and Type	Method and Description
PrimitiveSet.Entry<P>	addPrimitive(P primitive, com.google.crypto.tink.proto.Keyset.Key key) Creates an entry in the primitive table.
Collection<List<PrimitiveSet.Entry<P>>>	getAll()
PrimitiveSet.Entry<P>	getPrimary()
List<PrimitiveSet.Entry<P>>	getPrimitive(byte[] identifier)
protected List<PrimitiveSet.Entry<P>>	getPrimitive(com.google.crypto.tink.proto.Keyset.Key key) Returns the entries with primitives identified by the ciphertext prefix of key.
Class<P>	getPrimitiveClass()
List<PrimitiveSet.Entry<P>>	getRawPrimitives()
static <P> PrimitiveSet<P>	newPrimitiveSet(Class<P> primitiveClass)
void	setPrimary(PrimitiveSet.Entry<P> primary) Sets given Entry primary as the primary one.

Methods inherited from class java.lang.Object

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

Method Detail

getPrimary

public PrimitiveSet.Entry<P> getPrimary()

Returns:

the entry with the primary primitive.

getRawPrimitives

public List<PrimitiveSet.Entry<P>> getRawPrimitives()

Returns:

all primitives using RAW prefix.

getPrimitive

public List<PrimitiveSet.Entry<P>> getPrimitive(byte[] identifier)

Returns:

the entries with primitive identifed by identifier.

getPrimitive

protected List<PrimitiveSet.Entry<P>> getPrimitive(com.google.crypto.tink.proto.Keyset.Key key)
                                            throws GeneralSecurityException

Returns the entries with primitives identified by the ciphertext prefix of key.

Throws:

GeneralSecurityException

getAll

public Collection<List<PrimitiveSet.Entry<P>>> getAll()

Returns:

all primitives

newPrimitiveSet

public static <P> PrimitiveSet<P> newPrimitiveSet(Class<P> primitiveClass)

setPrimary

public void setPrimary(PrimitiveSet.Entry<P> primary)

Sets given Entry primary as the primary one.

addPrimitive

public PrimitiveSet.Entry<P> addPrimitive(P primitive,
                                          com.google.crypto.tink.proto.Keyset.Key key)
                                   throws GeneralSecurityException

Creates an entry in the primitive table.

Returns:

the added entry

Throws:

GeneralSecurityException

getPrimitiveClass

public Class<P> getPrimitiveClass()