Class CryptoKeyVersionAlgorithm (2.23.0)

Version 2.23.0

• 3.2.0 (latest)
• 3.1.1
• 3.0.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.4
• 2.20.0
• 2.19.2
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.1
• 2.13.0
• 2.12.3
• 2.11.2
• 2.10.1
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.4.3
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0

CryptoKeyVersionAlgorithm(value)

The algorithm of the CryptoKeyVersion, indicating what parameters must be used for each cryptographic operation.

The GOOGLE_SYMMETRIC_ENCRYPTION algorithm is usable with CryptoKey.purpose ENCRYPT_DECRYPT.

Algorithms beginning with RSA_SIGN_ are usable with CryptoKey.purpose ASYMMETRIC_SIGN.

The fields in the name after RSA_SIGN_ correspond to the following parameters: padding algorithm, modulus bit length, and digest algorithm.

For PSS, the salt length used is equal to the length of digest algorithm. For example, RSA_SIGN_PSS_2048_SHA256 will use PSS with a salt length of 256 bits or 32 bytes.

Algorithms beginning with RSA_DECRYPT_ are usable with CryptoKey.purpose ASYMMETRIC_DECRYPT.

The fields in the name after RSA_DECRYPT_ correspond to the following parameters: padding algorithm, modulus bit length, and digest algorithm.

Algorithms beginning with EC_SIGN_ are usable with CryptoKey.purpose ASYMMETRIC_SIGN.

The fields in the name after EC_SIGN_ correspond to the following parameters: elliptic curve, digest algorithm.

Algorithms beginning with HMAC_ are usable with CryptoKey.purpose MAC.

The suffix following HMAC_ corresponds to the hash algorithm being used (eg. SHA256).

For more information, see Key purposes and algorithms.

Enums
Name	Description
CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED	Not specified.
GOOGLE_SYMMETRIC_ENCRYPTION	Creates symmetric encryption keys.
AES_128_GCM	AES-GCM (Galois Counter Mode) using 128-bit keys.
AES_256_GCM	AES-GCM (Galois Counter Mode) using 256-bit keys.
AES_128_CBC	AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.
AES_256_CBC	AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.
AES_128_CTR	AES-CTR (Counter Mode) using 128-bit keys.
AES_256_CTR	AES-CTR (Counter Mode) using 256-bit keys.
RSA_SIGN_PSS_2048_SHA256	RSASSA-PSS 2048 bit key with a SHA256 digest.
RSA_SIGN_PSS_3072_SHA256	RSASSA-PSS 3072 bit key with a SHA256 digest.
RSA_SIGN_PSS_4096_SHA256	RSASSA-PSS 4096 bit key with a SHA256 digest.
RSA_SIGN_PSS_4096_SHA512	RSASSA-PSS 4096 bit key with a SHA512 digest.
RSA_SIGN_PKCS1_2048_SHA256	RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.
RSA_SIGN_PKCS1_3072_SHA256	RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.
RSA_SIGN_PKCS1_4096_SHA256	RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.
RSA_SIGN_PKCS1_4096_SHA512	RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.
RSA_SIGN_RAW_PKCS1_2048	RSASSA-PKCS1-v1_5 signing without encoding, with a 2048 bit key.
RSA_SIGN_RAW_PKCS1_3072	RSASSA-PKCS1-v1_5 signing without encoding, with a 3072 bit key.
RSA_SIGN_RAW_PKCS1_4096	RSASSA-PKCS1-v1_5 signing without encoding, with a 4096 bit key.
RSA_DECRYPT_OAEP_2048_SHA256	RSAES-OAEP 2048 bit key with a SHA256 digest.
RSA_DECRYPT_OAEP_3072_SHA256	RSAES-OAEP 3072 bit key with a SHA256 digest.
RSA_DECRYPT_OAEP_4096_SHA256	RSAES-OAEP 4096 bit key with a SHA256 digest.
RSA_DECRYPT_OAEP_4096_SHA512	RSAES-OAEP 4096 bit key with a SHA512 digest.
RSA_DECRYPT_OAEP_2048_SHA1	RSAES-OAEP 2048 bit key with a SHA1 digest.
RSA_DECRYPT_OAEP_3072_SHA1	RSAES-OAEP 3072 bit key with a SHA1 digest.
RSA_DECRYPT_OAEP_4096_SHA1	RSAES-OAEP 4096 bit key with a SHA1 digest.
EC_SIGN_P256_SHA256	ECDSA on the NIST P-256 curve with a SHA256 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
EC_SIGN_P384_SHA384	ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
EC_SIGN_SECP256K1_SHA256	ECDSA on the non-NIST secp256k1 curve. This curve is only supported for HSM protection level. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
EC_SIGN_ED25519	EdDSA on the Curve25519 in pure mode (taking data as input).
HMAC_SHA256	HMAC-SHA256 signing with a 256 bit key.
HMAC_SHA1	HMAC-SHA1 signing with a 160 bit key.
HMAC_SHA384	HMAC-SHA384 signing with a 384 bit key.
HMAC_SHA512	HMAC-SHA512 signing with a 512 bit key.
HMAC_SHA224	HMAC-SHA224 signing with a 224 bit key.
EXTERNAL_SYMMETRIC_ENCRYPTION	Algorithm representing symmetric encryption by an external key manager.