Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 283d4b3

Browse files
committedFeb 25, 2025
feat(cloudkms): update the api
#### cloudkms:v1 The following keys were added: - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat (Total Keys: 2) - schemas.ChecksummedData (Total Keys: 6) - schemas.PublicKey.properties.publicKey (Total Keys: 2)
1 parent 527fcb6 commit 283d4b3

File tree

2 files changed

+89
-13
lines changed

2 files changed

+89
-13
lines changed
 

‎docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html

+13-3
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h2>Instance Methods</h2>
9393
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9494
<p class="firstline">Returns metadata for a given CryptoKeyVersion.</p>
9595
<p class="toc_element">
96-
<code><a href="#getPublicKey">getPublicKey(name, x__xgafv=None)</a></code></p>
96+
<code><a href="#getPublicKey">getPublicKey(name, publicKeyFormat=None, x__xgafv=None)</a></code></p>
9797
<p class="firstline">Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.</p>
9898
<p class="toc_element">
9999
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
@@ -395,11 +395,16 @@ <h3>Method Details</h3>
395395
</div>
396396

397397
<div class="method">
398-
<code class="details" id="getPublicKey">getPublicKey(name, x__xgafv=None)</code>
398+
<code class="details" id="getPublicKey">getPublicKey(name, publicKeyFormat=None, x__xgafv=None)</code>
399399
<pre>Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
400400

401401
Args:
402402
name: string, Required. The name of the CryptoKeyVersion public key to get. (required)
403+
publicKeyFormat: string, Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.
404+
Allowed values
405+
PUBLIC_KEY_FORMAT_UNSPECIFIED - If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.
406+
PEM - The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.
407+
NIST_PQC - This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).
403408
x__xgafv: string, V1 error format.
404409
Allowed values
405410
1 - v1 error format
@@ -412,8 +417,13 @@ <h3>Method Details</h3>
412417
&quot;algorithm&quot;: &quot;A String&quot;, # The Algorithm associated with this key.
413418
&quot;name&quot;: &quot;A String&quot;, # The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta.
414419
&quot;pem&quot;: &quot;A String&quot;, # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).
415-
&quot;pemCrc32c&quot;: &quot;A String&quot;, # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.
420+
&quot;pemCrc32c&quot;: &quot;A String&quot;, # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.
416421
&quot;protectionLevel&quot;: &quot;A String&quot;, # The ProtectionLevel of the CryptoKeyVersion public key.
422+
&quot;publicKey&quot;: { # Data with integrity verification field. # This field contains the public key (with integrity verification), formatted according to the public_key_format field.
423+
&quot;crc32cChecksum&quot;: &quot;A String&quot;, # Integrity verification field. A CRC32C checksum of the returned ChecksummedData.data. An integrity check of ChecksummedData.data can be performed by computing the CRC32C checksum of ChecksummedData.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type.
424+
&quot;data&quot;: &quot;A String&quot;, # Raw Data.
425+
},
426+
&quot;publicKeyFormat&quot;: &quot;A String&quot;, # The PublicKey format specified by the customer through the public_key_format field.
417427
}</pre>
418428
</div>
419429

‎googleapiclient/discovery_cache/documents/cloudkms.v1.json

+76-10
Original file line numberDiff line numberDiff line change
@@ -1615,6 +1615,21 @@
16151615
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
16161616
"required": true,
16171617
"type": "string"
1618+
},
1619+
"publicKeyFormat": {
1620+
"description": "Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.",
1621+
"enum": [
1622+
"PUBLIC_KEY_FORMAT_UNSPECIFIED",
1623+
"PEM",
1624+
"NIST_PQC"
1625+
],
1626+
"enumDescriptions": [
1627+
"If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.",
1628+
"The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.",
1629+
"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)."
1630+
],
1631+
"location": "query",
1632+
"type": "string"
16181633
}
16191634
},
16201635
"path": "v1/{+name}/publicKey",
@@ -2137,7 +2152,7 @@
21372152
}
21382153
}
21392154
},
2140-
"revision": "20250102",
2155+
"revision": "20250213",
21412156
"rootUrl": "https://cloudkms.googleapis.com/",
21422157
"schemas": {
21432158
"AsymmetricDecryptRequest": {
@@ -2456,6 +2471,23 @@
24562471
},
24572472
"type": "object"
24582473
},
2474+
"ChecksummedData": {
2475+
"description": "Data with integrity verification field.",
2476+
"id": "ChecksummedData",
2477+
"properties": {
2478+
"crc32cChecksum": {
2479+
"description": "Integrity verification field. A CRC32C checksum of the returned ChecksummedData.data. An integrity check of ChecksummedData.data can be performed by computing the CRC32C checksum of ChecksummedData.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type.",
2480+
"format": "int64",
2481+
"type": "string"
2482+
},
2483+
"data": {
2484+
"description": "Raw Data.",
2485+
"format": "byte",
2486+
"type": "string"
2487+
}
2488+
},
2489+
"type": "object"
2490+
},
24592491
"CryptoKey": {
24602492
"description": "A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.",
24612493
"id": "CryptoKey",
@@ -2579,7 +2611,9 @@
25792611
"HMAC_SHA384",
25802612
"HMAC_SHA512",
25812613
"HMAC_SHA224",
2582-
"EXTERNAL_SYMMETRIC_ENCRYPTION"
2614+
"EXTERNAL_SYMMETRIC_ENCRYPTION",
2615+
"PQ_SIGN_ML_DSA_65",
2616+
"PQ_SIGN_SLH_DSA_SHA2_128S"
25832617
],
25842618
"enumDescriptions": [
25852619
"Not specified.",
@@ -2617,7 +2651,9 @@
26172651
"HMAC-SHA384 signing with a 384 bit key.",
26182652
"HMAC-SHA512 signing with a 512 bit key.",
26192653
"HMAC-SHA224 signing with a 224 bit key.",
2620-
"Algorithm representing symmetric encryption by an external key manager."
2654+
"Algorithm representing symmetric encryption by an external key manager.",
2655+
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
2656+
"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version."
26212657
],
26222658
"readOnly": true,
26232659
"type": "string"
@@ -2785,7 +2821,9 @@
27852821
"HMAC_SHA384",
27862822
"HMAC_SHA512",
27872823
"HMAC_SHA224",
2788-
"EXTERNAL_SYMMETRIC_ENCRYPTION"
2824+
"EXTERNAL_SYMMETRIC_ENCRYPTION",
2825+
"PQ_SIGN_ML_DSA_65",
2826+
"PQ_SIGN_SLH_DSA_SHA2_128S"
27892827
],
27902828
"enumDescriptions": [
27912829
"Not specified.",
@@ -2823,7 +2861,9 @@
28232861
"HMAC-SHA384 signing with a 384 bit key.",
28242862
"HMAC-SHA512 signing with a 512 bit key.",
28252863
"HMAC-SHA224 signing with a 224 bit key.",
2826-
"Algorithm representing symmetric encryption by an external key manager."
2864+
"Algorithm representing symmetric encryption by an external key manager.",
2865+
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
2866+
"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version."
28272867
],
28282868
"type": "string"
28292869
},
@@ -3206,7 +3246,9 @@
32063246
"HMAC_SHA384",
32073247
"HMAC_SHA512",
32083248
"HMAC_SHA224",
3209-
"EXTERNAL_SYMMETRIC_ENCRYPTION"
3249+
"EXTERNAL_SYMMETRIC_ENCRYPTION",
3250+
"PQ_SIGN_ML_DSA_65",
3251+
"PQ_SIGN_SLH_DSA_SHA2_128S"
32103252
],
32113253
"enumDescriptions": [
32123254
"Not specified.",
@@ -3244,7 +3286,9 @@
32443286
"HMAC-SHA384 signing with a 384 bit key.",
32453287
"HMAC-SHA512 signing with a 512 bit key.",
32463288
"HMAC-SHA224 signing with a 224 bit key.",
3247-
"Algorithm representing symmetric encryption by an external key manager."
3289+
"Algorithm representing symmetric encryption by an external key manager.",
3290+
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
3291+
"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version."
32483292
],
32493293
"type": "string"
32503294
},
@@ -3925,7 +3969,9 @@
39253969
"HMAC_SHA384",
39263970
"HMAC_SHA512",
39273971
"HMAC_SHA224",
3928-
"EXTERNAL_SYMMETRIC_ENCRYPTION"
3972+
"EXTERNAL_SYMMETRIC_ENCRYPTION",
3973+
"PQ_SIGN_ML_DSA_65",
3974+
"PQ_SIGN_SLH_DSA_SHA2_128S"
39293975
],
39303976
"enumDescriptions": [
39313977
"Not specified.",
@@ -3963,7 +4009,9 @@
39634009
"HMAC-SHA384 signing with a 384 bit key.",
39644010
"HMAC-SHA512 signing with a 512 bit key.",
39654011
"HMAC-SHA224 signing with a 224 bit key.",
3966-
"Algorithm representing symmetric encryption by an external key manager."
4012+
"Algorithm representing symmetric encryption by an external key manager.",
4013+
"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
4014+
"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version."
39674015
],
39684016
"type": "string"
39694017
},
@@ -3976,7 +4024,7 @@
39764024
"type": "string"
39774025
},
39784026
"pemCrc32c": {
3979-
"description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.",
4027+
"description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.",
39804028
"format": "int64",
39814029
"type": "string"
39824030
},
@@ -3997,6 +4045,24 @@
39974045
"Crypto operations are performed in an EKM-over-VPC backend."
39984046
],
39994047
"type": "string"
4048+
},
4049+
"publicKey": {
4050+
"$ref": "ChecksummedData",
4051+
"description": "This field contains the public key (with integrity verification), formatted according to the public_key_format field."
4052+
},
4053+
"publicKeyFormat": {
4054+
"description": "The PublicKey format specified by the customer through the public_key_format field.",
4055+
"enum": [
4056+
"PUBLIC_KEY_FORMAT_UNSPECIFIED",
4057+
"PEM",
4058+
"NIST_PQC"
4059+
],
4060+
"enumDescriptions": [
4061+
"If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.",
4062+
"The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.",
4063+
"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)."
4064+
],
4065+
"type": "string"
40004066
}
40014067
},
40024068
"type": "object"

0 commit comments

Comments
 (0)
Please sign in to comment.