Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.

docs: Minor formatting #411

Merged
parthea merged 2 commits into from
Aug 2, 2023
Merged

docs: Minor formatting #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3e5775
docs: Minor formatting
gcf-owl-bot[bot] Aug 2, 2023
432eea5
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions google/cloud/kms_v1/types/resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,40 +553,40 @@ class CryptoKeyVersionAlgorithm(proto.Enum):
[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
[ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Algorithms beginning with "RSA_SIGN\_" are usable with
Algorithms beginning with ``RSA_SIGN_`` are usable with
[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
[ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN].

The fields in the name after "RSA_SIGN\_" correspond to the following
parameters: padding algorithm, modulus bit length, and digest
algorithm.
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][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm.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
Algorithms beginning with ``RSA_DECRYPT_`` are usable with
[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
[ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].

The fields in the name after "RSA_DECRYPT\_" correspond to the
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
Algorithms beginning with ``EC_SIGN_`` are usable with
[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
[ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN].

The fields in the name after "EC_SIGN\_" correspond to the following
parameters: elliptic curve, digest algorithm.
The fields in the name after ``EC_SIGN_`` correspond to the
following parameters: elliptic curve, digest algorithm.

Algorithms beginning with "HMAC\_" are usable with
Algorithms beginning with ``HMAC_`` are usable with
[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
[MAC][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.MAC].

The suffix following "HMAC\_" corresponds to the hash algorithm being
used (eg. SHA256).
The suffix following ``HMAC_`` corresponds to the hash algorithm
being used (eg. SHA256).

For more information, see [Key purposes and algorithms]
(https://cloud.google.com/kms/docs/algorithms).
Expand Down
2 changes: 1 addition & 1 deletion samples/generated_samples/snippet_metadata_google.cloud.kms.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-kms",
"version": "2.19.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down