| Modifier and Type | Method and Description |
|---|---|
Key |
KeysetHandle.Entry.getKey()
May return an internal class
LegacyProtoKey in case
there is no implementation of the corresponding key class yet. |
Key |
PrivateKey.getPublicKey() |
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
Key.equalsKey(Key other)
Returns true if the key is guaranteed to be equal to
other. |
static KeysetHandle.Builder.Entry |
KeysetHandle.importKey(Key key)
Creates a new entry with a fixed key.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AeadKey
Represents functions to encrypt and decrypt data using AEAD.
|
class |
AesCtrHmacAeadKey
Represents an AES-CTR-HMAC key used for computing AEAD.
|
class |
AesEaxKey
Represents an AES-EAX key used for computing AEAD.
|
class |
AesGcmKey
Represents an AES-GCM key used for computing AEAD.
|
class |
AesGcmSivKey
Represents an AES-GCM-SIV key used for computing AEAD.
|
class |
ChaCha20Poly1305Key
Represents the Aead ChaCha20-Poly1305 specified in RFC 8439.
|
class |
LegacyKmsAeadKey
Describes an Aead backed by a KMS.
|
class |
LegacyKmsEnvelopeAeadKey
Describes an EnvelopeAead backed by a KMS.
|
class |
XChaCha20Poly1305Key
Represents the Aead XChaCha20-Poly1305 proposed in the RFC draft at
https://datatracker.ietf.org/doc/html/draft-arciszewski-xchacha-03.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
LegacyKmsEnvelopeAeadKey.equalsKey(Key o) |
boolean |
LegacyKmsAeadKey.equalsKey(Key o) |
boolean |
XChaCha20Poly1305Key.equalsKey(Key o) |
boolean |
ChaCha20Poly1305Key.equalsKey(Key o) |
boolean |
AesGcmSivKey.equalsKey(Key o) |
boolean |
AesEaxKey.equalsKey(Key o) |
boolean |
AesGcmKey.equalsKey(Key o) |
boolean |
AesCtrHmacAeadKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
AesSivKey
Represents an AES--SIV key used for computing deterministic AEAD, as described in
https://www.rfc-editor.org/rfc/rfc5297.
|
class |
DeterministicAeadKey
Represents functions to encrypt and decrypt data deterministically using AEAD.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
AesSivKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
EciesPrivateKey
Representation of the decryption function for an ECIES hybrid encryption primitive.
|
class |
EciesPublicKey
Represents the encryption function for an ECIES hybrid encryption primitive.
|
class |
HpkePrivateKey
Representation of the decryption function for an HPKE hybrid encryption primitive.
|
class |
HpkePublicKey
Representation of the encryption function for an HPKE hybrid encryption primitive.
|
class |
HybridPrivateKey
Representation of the decryption function for a hybrid encryption primitive.
|
class |
HybridPublicKey
Representation of the encryption function for a hybrid encryption primitive.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
HpkePublicKey.equalsKey(Key o) |
boolean |
HpkePrivateKey.equalsKey(Key o) |
boolean |
EciesPublicKey.equalsKey(Key o) |
boolean |
EciesPrivateKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
KeySerializer<KeyT extends Key,SerializationT extends Serialization>
Serializes
Key objects into Serialization objects of a certain kind. |
static interface |
KeySerializer.KeySerializationFunction<KeyT extends Key,SerializationT extends Serialization>
A function which serializes a key.
|
class |
PrimitiveConstructor<KeyT extends Key,PrimitiveT>
Create Primitive objects from
Key objects of a certain kind. |
static interface |
PrimitiveConstructor.PrimitiveConstructionFunction<KeyT extends Key,PrimitiveT>
A function which creates a Primitive object.
|
| Modifier and Type | Class and Description |
|---|---|
class |
LegacyProtoKey
Implements a Key for legacy types where no actual parser is present.
|
| Modifier and Type | Method and Description |
|---|---|
static <KeyT extends Key,SerializationT extends Serialization> |
KeySerializer.create(KeySerializer.KeySerializationFunction<KeyT,SerializationT> function,
Class<KeyT> keyClass,
Class<SerializationT> serializationClass)
Creates a KeySerializer object.
|
static <KeyT extends Key,PrimitiveT> |
PrimitiveConstructor.create(PrimitiveConstructor.PrimitiveConstructionFunction<KeyT,PrimitiveT> function,
Class<KeyT> keyClass,
Class<PrimitiveT> primitiveClass)
Creates a PrimitiveConstructor object.
|
<KeyT extends Key,PrimitiveT> |
PrimitiveRegistry.getPrimitive(KeyT key,
Class<PrimitiveT> primitiveClass)
Creates a primitive from a given key.
|
<KeyT extends Key,PrimitiveT> |
MutablePrimitiveRegistry.getPrimitive(KeyT key,
Class<PrimitiveT> primitiveClass)
Creates a primitive from a given key.
|
<KeyT extends Key,SerializationT extends Serialization> |
SerializationRegistry.hasSerializerForKey(KeyT key,
Class<SerializationT> serializationClass)
Returns true if a parser for this
serializedKey has been registered. |
<KeyT extends Key,SerializationT extends Serialization> |
MutableSerializationRegistry.hasSerializerForKey(KeyT key,
Class<SerializationT> serializationClass)
Returns true if a parser for this
serializedKey has been registered. |
<KeyT extends Key,SerializationT extends Serialization> |
SerializationRegistry.Builder.registerKeySerializer(KeySerializer<KeyT,SerializationT> serializer)
Registers a key serializer for later use in
SerializationRegistry.serializeKey(KeyT, java.lang.Class<SerializationT>, com.google.crypto.tink.SecretKeyAccess). |
<KeyT extends Key,SerializationT extends Serialization> |
MutableSerializationRegistry.registerKeySerializer(KeySerializer<KeyT,SerializationT> serializer)
Registers a key serializer for later use in
MutableSerializationRegistry.serializeKey(KeyT, java.lang.Class<SerializationT>, com.google.crypto.tink.SecretKeyAccess). |
<KeyT extends Key,PrimitiveT> |
PrimitiveRegistry.Builder.registerPrimitiveConstructor(PrimitiveConstructor<KeyT,PrimitiveT> primitiveConstructor)
Registers a primitive constructor for later use in
PrimitiveRegistry.getPrimitive(KeyT, java.lang.Class<PrimitiveT>). |
<KeyT extends Key,PrimitiveT> |
MutablePrimitiveRegistry.registerPrimitiveConstructor(PrimitiveConstructor<KeyT,PrimitiveT> constructor)
Registers a key primitive constructor for later use in
MutablePrimitiveRegistry.getPrimitive(KeyT, java.lang.Class<PrimitiveT>). |
<KeyT extends Key,SerializationT extends Serialization> |
SerializationRegistry.serializeKey(KeyT key,
Class<SerializationT> serializationClass,
SecretKeyAccess access)
Serializes a given Key into a "SerializationT" object.
|
<KeyT extends Key,SerializationT extends Serialization> |
MutableSerializationRegistry.serializeKey(KeyT key,
Class<SerializationT> serializationClass,
SecretKeyAccess access)
Serializes a given Key into a "SerializationT" object.
|
| Modifier and Type | Method and Description |
|---|---|
Key |
MutableKeyCreationRegistry.createKey(Parameters parameters,
Integer idRequirement)
Creates a
Key from a given Parameters object. |
Key |
MutableKeyCreationRegistry.KeyCreator.createKey(ParametersT parameters,
Integer idRequirement) |
Key |
MutableKeyDerivationRegistry.createKeyFromRandomness(Parameters parameters,
InputStream inputStream,
Integer idRequirement,
SecretKeyAccess access)
Creates a
Key from a given Parameters object and additional data. |
Key |
MutableKeyDerivationRegistry.InsecureKeyCreator.createKeyFromRandomness(ParametersT parameters,
InputStream inputStream,
Integer idRequirement,
SecretKeyAccess access) |
Key |
PrimitiveSet.Entry.getKey() |
abstract Key |
KeyParser.parseKey(SerializationT serialization,
SecretKeyAccess access)
Parses a serialization into a key.
|
Key |
KeyParser.KeyParsingFunction.parseKey(SerializationT serialization,
SecretKeyAccess access) |
<SerializationT extends Serialization> |
SerializationRegistry.parseKey(SerializationT serializedKey,
SecretKeyAccess access)
Parses the given serialization into a Key.
|
<SerializationT extends Serialization> |
MutableSerializationRegistry.parseKey(SerializationT serializedKey,
SecretKeyAccess access)
Parses the given serialization into a Key.
|
Key |
MutableSerializationRegistry.parseKeyWithLegacyFallback(ProtoKeySerialization protoKeySerialization,
SecretKeyAccess access)
Returns a Key object from a protoKeySerialization, even if no parser has been registered.
|
| Modifier and Type | Method and Description |
|---|---|
PrimitiveSet.Builder<P> |
PrimitiveSet.Builder.addFullPrimitive(P fullPrimitive,
Key key,
Keyset.Key protoKey)
Adds a non-primary primitive.
|
PrimitiveSet.Builder<P> |
PrimitiveSet.Builder.addPrimaryFullPrimitive(P fullPrimitive,
Key key,
Keyset.Key protoKey)
Adds the primary primitive.
|
boolean |
LegacyProtoKey.equalsKey(Key key)
Returns true if we are sure that the other key is the same.
|
abstract <P> P |
InternalConfiguration.getPrimitive(Key key,
Class<P> primitiveClass)
Given a key and a desired primitive class, creates the required primitive.
|
<P> P |
RegistryConfiguration.getPrimitive(Key key,
Class<P> primitiveClass) |
| Modifier and Type | Class and Description |
|---|---|
class |
JwtEcdsaPrivateKey
Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512).
|
class |
JwtEcdsaPublicKey
JwtEcdsaPublicKey represents the public portion of JWT ECDSA keys.
|
class |
JwtHmacKey
Represents a JWT HMAC key to create and verify JWT using HMAC.
|
class |
JwtMacKey
Represents a key to compute JWT using symmetric cryptography (i.e., using the
JwtMac
interface). |
class |
JwtRsaSsaPkcs1PrivateKey
Represents a private key for RSA SSA PKCS1 signatures (RS256, RS384, RS512).
|
class |
JwtRsaSsaPkcs1PublicKey
Represents a public key for the JWT RSA SSA PKCS1 signature primitive.
|
class |
JwtRsaSsaPssPrivateKey
Represents a private key for RSA SSA PSS signatures (PS256, PS384, PS512).
|
class |
JwtRsaSsaPssPublicKey
Represents a public key for the JWT RSA SSA PSS signature primitive.
|
class |
JwtSignaturePrivateKey
Represents a key to compute JWT using asymmetric cryptography (i.e., using the
JwtPublicKeySign interface). |
class |
JwtSignaturePublicKey
Represents a key to verify JWT using asymmetric cryptography (i.e., using the
JwtPublicKeyVerify interface). |
| Modifier and Type | Method and Description |
|---|---|
boolean |
JwtRsaSsaPssPrivateKey.equalsKey(Key o) |
boolean |
JwtRsaSsaPkcs1PrivateKey.equalsKey(Key o) |
boolean |
JwtHmacKey.equalsKey(Key o) |
boolean |
JwtEcdsaPrivateKey.equalsKey(Key o) |
boolean |
JwtRsaSsaPssPublicKey.equalsKey(Key o) |
boolean |
JwtRsaSsaPkcs1PublicKey.equalsKey(Key o) |
boolean |
JwtEcdsaPublicKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
KeyDerivationKey
Represents a function to derive a key.
|
class |
PrfBasedKeyDerivationKey
Represents a Derivation key which is based on a PRF.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
PrfBasedKeyDerivationKey.equalsKey(Key other) |
| Modifier and Type | Method and Description |
|---|---|
Key |
PrfBasedKeyDeriver.deriveKey(byte[] salt) |
Key |
KeyDeriver.deriveKey(byte[] salt) |
| Modifier and Type | Class and Description |
|---|---|
class |
AesCmacKey
Represents a key computing AES-CMAC.
|
class |
HmacKey
Represents a key computing HMAC.
|
class |
MacKey
Represents functions to compute and verify a cryptographic MAC.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
AesCmacKey.equalsKey(Key o) |
boolean |
HmacKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
AesCmacPrfKey
Represents a key computing AES CMAC PRF.
|
class |
HkdfPrfKey
Represents a key computing HKDF PRF.
|
class |
HmacPrfKey
Represents a key computing HMAC PRF.
|
class |
PrfKey
Represents functions to compute a PRF.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
HkdfPrfKey.equalsKey(Key o) |
boolean |
AesCmacPrfKey.equalsKey(Key o) |
boolean |
HmacPrfKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
EcdsaPrivateKey
Represents a key for computing ECDSA signatures.
|
class |
EcdsaPublicKey
EcdsaPublicKey represents the public portion of ECDSA signature primitive.
|
class |
Ed25519PrivateKey
The key for computing Ed25519 signatures.
|
class |
Ed25519PublicKey
Ed25519PublicKey represents the public portion of the Ed25519 signature primitive.
|
class |
RsaSsaPkcs1PrivateKey
Represents a private key for RSA SSA PKCS1 signatures.
|
class |
RsaSsaPkcs1PublicKey
Represents a public key for the RSA SSA PKCS1 signature primitive.
|
class |
RsaSsaPssPrivateKey
Represents a private key for RSA SSA PSS signatures.
|
class |
RsaSsaPssPublicKey
Represents a public key for the RSA SSA PSS signature primitive.
|
class |
SignaturePrivateKey
A
SignaturePrivateKey represents a digital signature primitive, which consists of a sign
and a verify function. |
class |
SignaturePublicKey
A SignaturePublicKey represents the verification portion of a digital signature primitive.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
RsaSsaPssPublicKey.equalsKey(Key o) |
boolean |
RsaSsaPssPrivateKey.equalsKey(Key o) |
boolean |
Ed25519PublicKey.equalsKey(Key o) |
boolean |
Ed25519PrivateKey.equalsKey(Key o) |
boolean |
RsaSsaPkcs1PublicKey.equalsKey(Key o) |
boolean |
RsaSsaPkcs1PrivateKey.equalsKey(Key o) |
boolean |
EcdsaPublicKey.equalsKey(Key o) |
boolean |
EcdsaPrivateKey.equalsKey(Key o) |
| Modifier and Type | Class and Description |
|---|---|
class |
AesCtrHmacStreamingKey
Represents a StreamingAead functions.
|
class |
AesGcmHkdfStreamingKey
Represents a StreamingAead functions.
|
class |
StreamingAeadKey
Represents functions to encrypt and decrypt data using a StreamingAead.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
AesGcmHkdfStreamingKey.equalsKey(Key o) |
boolean |
AesCtrHmacStreamingKey.equalsKey(Key o) |