| Modifier and Type | Method and Description |
|---|---|
KeysetManager |
KeysetManager.add(KeyTemplate keyTemplate)
Deprecated.
This method takes a KeyTemplate proto, which is an internal implementation detail.
Please use the add method that takes a
KeyTemplate POJO. |
int |
KeysetManager.addNewKey(KeyTemplate keyTemplate,
boolean asPrimary)
Deprecated.
Please use
KeysetManager.add(com.google.crypto.tink.proto.KeyTemplate). This method adds a new key and when asPrimary is
true immediately promotes it to primary. However, when you do keyset rotation, you almost
never want to make the new key primary, because old binaries don't know the new key yet. |
static KeyData |
PrivilegedRegistry.deriveKey(KeyTemplate keyTemplate,
InputStream randomStream)
Method to derive a key, using the given , with the randomness as provided
by the second argument.
|
static KeysetHandle |
KeysetHandle.generateNew(KeyTemplate keyTemplate)
Deprecated.
This method takes a KeyTemplate proto, which is an internal implementation detail.
Please use the generateNew method that takes a
KeyTemplate POJO. |
static com.google.protobuf.MessageLite |
Registry.newKey(KeyTemplate keyTemplate)
Convenience method for generating a new key for the specified
keyTemplate. |
static KeyData |
Registry.newKeyData(KeyTemplate keyTemplate)
Convenience method for generating a new
KeyData for the specified template. |
KeysetManager |
KeysetManager.rotate(KeyTemplate keyTemplate)
Deprecated.
Please use
KeysetManager.add(com.google.crypto.tink.proto.KeyTemplate). This method adds a new key and immediately promotes it to
primary. However, when you do keyset rotation, you almost never want to make the new key
primary, because old binaries don't know the new key yet. |
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
AeadKeyTemplates.AES128_CTR_HMAC_SHA256
A
KeyTemplate that generates new instances of AesCtrHmacAeadKey with the following parameters:
AES key size: 16 bytes
AES CTR IV size: 16 byte
HMAC key size: 32 bytes
HMAC tag size: 16 bytes
HMAC hash function: SHA256
|
static KeyTemplate |
AeadKeyTemplates.AES128_EAX
A
KeyTemplate that generates new instances of com.google.crypto.tink.proto.AesEaxKey with the following parameters:
Key size: 16 bytes
IV size: 16 bytes
|
static KeyTemplate |
AeadKeyTemplates.AES128_GCM
A
KeyTemplate that generates new instances of AesGcmKey with the following parameters:
Key size: 16 bytes
|
static KeyTemplate |
AeadKeyTemplates.AES256_CTR_HMAC_SHA256
A
KeyTemplate that generates new instances of AesCtrHmacAeadKey with the following parameters:
AES key size: 32 bytes
AES CTR IV size: 16 byte
HMAC key size: 32 bytes
HMAC tag size: 32 bytes
HMAC hash function: SHA256
|
static KeyTemplate |
AeadKeyTemplates.AES256_EAX
A
KeyTemplate that generates new instances of AesEaxKey with the following parameters:
Key size: 32 bytes
IV size: 16 bytes
|
static KeyTemplate |
AeadKeyTemplates.AES256_GCM
A
KeyTemplate that generates new instances of AesGcmKey with the following parameters:
Key size: 32 bytes
|
static KeyTemplate |
AeadKeyTemplates.CHACHA20_POLY1305
A
KeyTemplate that generates new instances of ChaCha20Poly1305Key. |
static KeyTemplate |
AeadKeyTemplates.XCHACHA20_POLY1305
A
KeyTemplate that generates new instances of XChaCha20Poly1305Key. |
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
AeadKeyTemplates.createAesCtrHmacAeadKeyTemplate(int aesKeySize,
int ivSize,
int hmacKeySize,
int tagSize,
HashType hashType) |
static KeyTemplate |
AeadKeyTemplates.createAesEaxKeyTemplate(int keySize,
int ivSize) |
static KeyTemplate |
AeadKeyTemplates.createAesGcmKeyTemplate(int keySize) |
static KeyTemplate |
AeadKeyTemplates.createKmsAeadKeyTemplate(String keyUri) |
static KeyTemplate |
AeadKeyTemplates.createKmsEnvelopeAeadKeyTemplate(String kekUri,
KeyTemplate dekTemplate) |
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
AeadKeyTemplates.createKmsEnvelopeAeadKeyTemplate(String kekUri,
KeyTemplate dekTemplate) |
| Constructor and Description |
|---|
KmsEnvelopeAead(KeyTemplate dekTemplate,
Aead remote) |
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
DeterministicAeadKeyTemplates.AES256_SIV
A
KeyTemplate that generates new instances of AesSivKey with a 64-byte key. |
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
DeterministicAeadKeyTemplates.createAesSivKeyTemplate(int keySize) |
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
HybridKeyTemplates.ECIES_P256_HKDF_HMAC_SHA256_AES128_CTR_HMAC_SHA256
A
KeyTemplate that generates new instances of EciesAeadHkdfPrivateKey with the following parameters:
KEM: ECDH over NIST P-256
DEM: AES128-CTR-HMAC-SHA256 with the following parameters
AES key size: 16 bytes
AES CTR IV size: 16 bytes
HMAC key size: 32 bytes
HMAC tag size: 16 bytes
KDF: HKDF-HMAC-SHA256 with an empty salt
|
static KeyTemplate |
HybridKeyTemplates.ECIES_P256_HKDF_HMAC_SHA256_AES128_GCM
A
KeyTemplate that generates new instances of EciesAeadHkdfPrivateKey with the following parameters:
KEM: ECDH over NIST P-256
DEM: AES128-GCM
KDF: HKDF-HMAC-SHA256 with an empty salt
|
static KeyTemplate |
HybridKeyTemplates.ECIES_P256_HKDF_HMAC_SHA256_AES128_GCM_COMPRESSED_WITHOUT_PREFIX
A
KeyTemplate that generates new instances of EciesAeadHkdfPrivateKey with the following parameters:
KEM: ECDH over NIST P-256
DEM: AES128-GCM
KDF: HKDF-HMAC-SHA256 with an empty salt
EC Point Format: Compressed
OutputPrefixType: RAW
|
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
HybridKeyTemplates.createEciesAeadHkdfKeyTemplate(EllipticCurveType curve,
HashType hashType,
EcPointFormat ecPointFormat,
KeyTemplate demKeyTemplate,
OutputPrefixType outputPrefixType,
byte[] salt) |
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
HybridKeyTemplates.createEciesAeadHkdfKeyTemplate(EllipticCurveType curve,
HashType hashType,
EcPointFormat ecPointFormat,
KeyTemplate demKeyTemplate,
OutputPrefixType outputPrefixType,
byte[] salt) |
static EciesAeadHkdfParams |
HybridKeyTemplates.createEciesAeadHkdfParams(EllipticCurveType curve,
HashType hashType,
EcPointFormat ecPointFormat,
KeyTemplate demKeyTemplate,
byte[] salt) |
| Modifier and Type | Method and Description |
|---|---|
AndroidKeysetManager |
AndroidKeysetManager.add(KeyTemplate keyTemplate)
Deprecated.
This method takes a KeyTemplate proto, which is an internal implementation detail.
Please use the add method that takes a
KeyTemplate POJO. |
AndroidKeysetManager |
AndroidKeysetManager.rotate(KeyTemplate keyTemplate)
Deprecated.
Please use
AndroidKeysetManager.add(com.google.crypto.tink.proto.KeyTemplate). This method adds a new key and immediately promotes it to
primary. However, when you do keyset rotation, you almost never want to make the new key
primary, because old binaries don't know the new key yet. |
AndroidKeysetManager.Builder |
AndroidKeysetManager.Builder.withKeyTemplate(KeyTemplate val)
Deprecated.
This method takes a KeyTemplate proto, which is an internal implementation
detail. Please use the withKeyTemplate method that takes a
KeyTemplate POJO. |
| Modifier and Type | Method and Description |
|---|---|
KeyTemplate |
ProtoParametersSerialization.getKeyTemplate()
The contents of the field value in the message com.google.crypto.tink.proto.KeyData.
|
static KeyTemplate |
KeyTemplateProtoConverter.toProto(KeyTemplate keyTemplate) |
| Modifier and Type | Method and Description |
|---|---|
static ProtoParametersSerialization |
ProtoParametersSerialization.create(KeyTemplate keyTemplate)
Creates a new
ProtoParametersSerialization object. |
static KeyTemplate |
KeyTemplateProtoConverter.fromProto(KeyTemplate proto) |
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
MacKeyTemplates.AES_CMAC
A
KeyTemplate that generates new instances of com.google.crypto.tink.proto.CmacKey with the following parameters:
Key size: 32 bytes
Tag size: 16 bytes
OutputPrefixType: TINK
|
static KeyTemplate |
MacKeyTemplates.HMAC_SHA256_128BITTAG
A
KeyTemplate that generates new instances of HmacKey with the following parameters:
Key size: 32 bytes
Tag size: 16 bytes
Hash function: SHA256
OutputPrefixType: TINK
|
static KeyTemplate |
MacKeyTemplates.HMAC_SHA256_256BITTAG
A
KeyTemplate that generates new instances of HmacKey with the following parameters:
Key size: 32 bytes
Tag size: 32 bytes
Hash function: SHA256
OutputPrefixType: TINK
|
static KeyTemplate |
MacKeyTemplates.HMAC_SHA512_256BITTAG
A
KeyTemplate that generates new instances of HmacKey with the following parameters:
Key size: 64 bytes
Tag size: 32 bytes
Hash function: SHA512
OutputPrefixType: TINK
|
static KeyTemplate |
MacKeyTemplates.HMAC_SHA512_512BITTAG
A
KeyTemplate that generates new instances of HmacKey with the following parameters:
Key size: 64 bytes
Tag size: 64 bytes
Hash function: SHA512
OutputPrefixType: TINK
|
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
MacKeyTemplates.createHmacKeyTemplate(int keySize,
int tagSize,
HashType hashType) |
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
PrfKeyTemplates.AES_CMAC_PRF |
static KeyTemplate |
PrfKeyTemplates.HKDF_SHA256
Generates a
KeyTemplate for a HkdfPrfKey key with
the following parameters. |
static KeyTemplate |
PrfKeyTemplates.HMAC_SHA256_PRF |
static KeyTemplate |
PrfKeyTemplates.HMAC_SHA512_PRF |
| Modifier and Type | Method and Description |
|---|---|
KeyTemplate |
EciesAeadDemParamsOrBuilder.getAeadDem()
Required.
|
KeyTemplate |
EciesAeadDemParams.getAeadDem()
Required.
|
KeyTemplate |
EciesAeadDemParams.Builder.getAeadDem()
Required.
|
static KeyTemplate |
KeyTemplate.getDefaultInstance() |
KeyTemplate |
KmsEnvelopeAeadKeyFormatOrBuilder.getDekTemplate()
Key template of the Data Encryption Key, e.g., AesCtrHmacAeadKeyFormat.
|
KeyTemplate |
KmsEnvelopeAeadKeyFormat.getDekTemplate()
Key template of the Data Encryption Key, e.g., AesCtrHmacAeadKeyFormat.
|
KeyTemplate |
KmsEnvelopeAeadKeyFormat.Builder.getDekTemplate()
Key template of the Data Encryption Key, e.g., AesCtrHmacAeadKeyFormat.
|
static KeyTemplate |
KeyTemplate.parseDelimitedFrom(InputStream input) |
static KeyTemplate |
KeyTemplate.parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static KeyTemplate |
KeyTemplate.parseFrom(byte[] data) |
static KeyTemplate |
KeyTemplate.parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static KeyTemplate |
KeyTemplate.parseFrom(ByteBuffer data) |
static KeyTemplate |
KeyTemplate.parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static KeyTemplate |
KeyTemplate.parseFrom(com.google.protobuf.ByteString data) |
static KeyTemplate |
KeyTemplate.parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static KeyTemplate |
KeyTemplate.parseFrom(com.google.protobuf.CodedInputStream input) |
static KeyTemplate |
KeyTemplate.parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static KeyTemplate |
KeyTemplate.parseFrom(InputStream input) |
static KeyTemplate |
KeyTemplate.parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
| Modifier and Type | Method and Description |
|---|---|
static com.google.protobuf.Parser<KeyTemplate> |
KeyTemplate.parser() |
| Modifier and Type | Method and Description |
|---|---|
EciesAeadDemParams.Builder |
EciesAeadDemParams.Builder.mergeAeadDem(KeyTemplate value)
Required.
|
KmsEnvelopeAeadKeyFormat.Builder |
KmsEnvelopeAeadKeyFormat.Builder.mergeDekTemplate(KeyTemplate value)
Key template of the Data Encryption Key, e.g., AesCtrHmacAeadKeyFormat.
|
static KeyTemplate.Builder |
KeyTemplate.newBuilder(KeyTemplate prototype) |
EciesAeadDemParams.Builder |
EciesAeadDemParams.Builder.setAeadDem(KeyTemplate value)
Required.
|
KmsEnvelopeAeadKeyFormat.Builder |
KmsEnvelopeAeadKeyFormat.Builder.setDekTemplate(KeyTemplate value)
Key template of the Data Encryption Key, e.g., AesCtrHmacAeadKeyFormat.
|
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P256
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA256
Curve: NIST P-256
Signature encoding: DER (this is the encoding that Java uses). |
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P256_IEEE_P1363
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA256
Curve: NIST P-256
Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P256_IEEE_P1363_WITHOUT_PREFIX
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA256
Curve: NIST P-256
Signature encoding: DER (this is the encoding that Java uses). |
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P384
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA512
Curve: NIST P-384
Signature encoding: DER (this is the encoding that Java uses). |
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P384_IEEE_P1363
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA512
Curve: NIST P-384
Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P521
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA512
Curve: NIST P-521
Signature encoding: DER (this is the encoding that Java uses). |
static KeyTemplate |
SignatureKeyTemplates.ECDSA_P521_IEEE_P1363
A
KeyTemplate that generates new instances of EcdsaPrivateKey with the following parameters:
Hash function: SHA512
Curve: NIST P-521
Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
static KeyTemplate |
SignatureKeyTemplates.ED25519
A
KeyTemplate that generates new instances of Ed25519PrivateKey. |
static KeyTemplate |
SignatureKeyTemplates.ED25519WithRawOutput
A
KeyTemplate that generates new instances of com.google.crypto.tink.proto.ED25519PrivateKey. |
static KeyTemplate |
SignatureKeyTemplates.RSA_SSA_PKCS1_3072_SHA256_F4
A
KeyTemplate that generates new instances of RsaSsaPkcs1PrivateKey with the following parameters:
Hash function: SHA256. |
static KeyTemplate |
SignatureKeyTemplates.RSA_SSA_PKCS1_3072_SHA256_F4_WITHOUT_PREFIX
A
KeyTemplate that generates new instances of RsaSsaPkcs1PrivateKey with the following parameters:
Hash function: SHA256. |
static KeyTemplate |
SignatureKeyTemplates.RSA_SSA_PKCS1_4096_SHA512_F4
A
KeyTemplate that generates new instances of RsaSsaPkcs1PrivateKey with the following parameters:
Hash function: SHA512. |
static KeyTemplate |
SignatureKeyTemplates.RSA_SSA_PSS_3072_SHA256_SHA256_32_F4
A
KeyTemplate that generates new instances of RsaSsaPssPrivateKey with the following parameters:
Signature hash: SHA256. |
static KeyTemplate |
SignatureKeyTemplates.RSA_SSA_PSS_4096_SHA512_SHA512_64_F4
A
KeyTemplate that generates new instances of RsaSsaPssPrivateKey with the following parameters:
Signature hash: SHA512. |
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
SignatureKeyTemplates.createEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
OutputPrefixType prefixType) |
static KeyTemplate |
SignatureKeyTemplates.createRsaSsaPkcs1KeyTemplate(HashType hashType,
int modulusSize,
BigInteger publicExponent,
OutputPrefixType prefixType) |
static KeyTemplate |
SignatureKeyTemplates.createRsaSsaPssKeyTemplate(HashType sigHash,
HashType mgf1Hash,
int saltLength,
int modulusSize,
BigInteger publicExponent) |
| Modifier and Type | Field and Description |
|---|---|
static KeyTemplate |
StreamingAeadKeyTemplates.AES128_CTR_HMAC_SHA256_1MB
A
KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
Size of the main key: 16 bytes
HKDF algo: HMAC-SHA256
Size of AES-CTR derived keys: 16 bytes
Tag algo: HMAC-SHA256
Tag size: 32 bytes
Ciphertext segment size: 1048576 bytes (1 MB)
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES128_CTR_HMAC_SHA256_4KB
A
KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
Size of the main key: 16 bytes
HKDF algo: HMAC-SHA256
Size of AES-CTR derived keys: 16 bytes
Tag algo: HMAC-SHA256
Tag size: 32 bytes
Ciphertext segment size: 4096
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES128_GCM_HKDF_1MB
A
KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
Size of the main key: 16 bytes
HKDF algo: HMAC-SHA256
Size of AES-GCM derived keys: 16 bytes
Ciphertext segment size: 1048576 bytes (1 MB)
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES128_GCM_HKDF_4KB
A
KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
Size of the main key: 16 bytes
HKDF algo: HMAC-SHA256
Size of AES-GCM derived keys: 16 bytes
Ciphertext segment size: 4096 bytes
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES256_CTR_HMAC_SHA256_1MB
A
KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
Size of the main key: 32 bytes
HKDF algo: HMAC-SHA256
Size of AES-CTR derived keys: 32 bytes
Tag algo: HMAC-SHA256
Tag size: 32 bytes
Ciphertext segment size: 1048576 bytes (1 MB)
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES256_CTR_HMAC_SHA256_4KB
A
KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
Size of the main key: 32 bytes
HKDF algo: HMAC-SHA256
Size of AES-CTR derived keys: 32 bytes
Tag algo: HMAC-SHA256
Tag size: 32 bytes
Ciphertext segment size: 4096
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES256_GCM_HKDF_1MB
A
KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
Size of the main key: 32 bytes
HKDF algo: HMAC-SHA256
Size of AES-GCM derived keys: 32 bytes
Ciphertext segment size: 1048576 bytes (1 MB)
|
static KeyTemplate |
StreamingAeadKeyTemplates.AES256_GCM_HKDF_4KB
A
KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
Size of the main key: 32 bytes
HKDF algo: HMAC-SHA256
Size of AES-GCM derived keys: 32 bytes
Ciphertext segment size: 4096 bytes
|
| Modifier and Type | Method and Description |
|---|---|
static KeyTemplate |
StreamingAeadKeyTemplates.createAesCtrHmacStreamingKeyTemplate(int mainKeySize,
HashType hkdfHashType,
int derivedKeySize,
HashType macHashType,
int tagSize,
int ciphertextSegmentSize) |
static KeyTemplate |
StreamingAeadKeyTemplates.createAesGcmHkdfStreamingKeyTemplate(int mainKeySize,
HashType hkdfHashType,
int derivedKeySize,
int ciphertextSegmentSize) |