@maxim_mazurok/gapi.client.cloudkms-v1 0.0.20230614 → 0.0.20230625

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://cloudkms.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230614
+// Revision: 20230625
 
 /// <reference types="gapi.client" />
 
@@ -858,6 +858,192 @@ declare namespace gapi.client {
             protectionLevel?:
                 string;
         }
+        interface RawDecryptRequest {
+            /** Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data. */
+            additionalAuthenticatedData?:
+                string;
+            /**
+             * Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received
+             * additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should
+             * verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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.
+             */
+            additionalAuthenticatedDataCrc32c?:
+                string;
+            /** Required. The encrypted data originally returned in RawEncryptResponse.ciphertext. */
+            ciphertext?:
+                string;
+            /**
+             * Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this
+             * checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal
+             * to ciphertext_crc32c, and if so, 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.
+             */
+            ciphertextCrc32c?:
+                string;
+            /** Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector. */
+            initializationVector?:
+                string;
+            /**
+             * Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received
+             * initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify
+             * that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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.
+             */
+            initializationVectorCrc32c?:
+                string;
+            /**
+             * The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the
+             * default value is 16).
+             */
+            tagLength?:
+                number;
+        }
+        interface RawDecryptResponse {
+            /** The decrypted data. */
+            plaintext?:
+                string;
+            /**
+             * Integrity verification field. A CRC32C checksum of the returned RawDecryptResponse.plaintext. An integrity check of plaintext can be performed by computing the CRC32C checksum of
+             * plaintext 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the
+             * ciphertext. 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.
+             */
+            plaintextCrc32c?:
+                string;
+            /** The ProtectionLevel of the CryptoKeyVersion used in decryption. */
+            protectionLevel?:
+                string;
+            /**
+             * Integrity verification field. A flag indicating whether RawDecryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity
+             * verification of additional_authenticated_data. A false value of this field indicates either that // RawDecryptRequest.additional_authenticated_data_crc32c was left unset or that it
+             * was not delivered to KeyManagementService. If you've set RawDecryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a
+             * limited number of retries.
+             */
+            verifiedAdditionalAuthenticatedDataCrc32c?:
+                boolean;
+            /**
+             * Integrity verification field. A flag indicating whether RawDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the
+             * ciphertext. A false value of this field indicates either that RawDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set
+             * RawDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
+             */
+            verifiedCiphertextCrc32c?:
+                boolean;
+            /**
+             * Integrity verification field. A flag indicating whether RawDecryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification
+             * of initialization_vector. A false value of this field indicates either that RawDecryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to
+             * KeyManagementService. If you've set RawDecryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.
+             */
+            verifiedInitializationVectorCrc32c?:
+                boolean;
+        }
+        interface RawEncryptRequest {
+            /**
+             * Optional. Optional data that, if specified, must also be provided during decryption through RawDecryptRequest.additional_authenticated_data. This field may only be used in
+             * conjunction with an algorithm that accepts additional authenticated data (for example, AES-GCM). The maximum size depends on the key version's protection_level. For SOFTWARE keys,
+             * the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
+             */
+            additionalAuthenticatedData?:
+                string;
+            /**
+             * Optional. An optional CRC32C checksum of the RawEncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received
+             * additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should
+             * verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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.
+             */
+            additionalAuthenticatedDataCrc32c?:
+                string;
+            /**
+             * Optional. A customer-supplied initialization vector that will be used for encryption. If it is not provided for AES-CBC and AES-CTR, one will be generated. It will be returned in
+             * RawEncryptResponse.initialization_vector.
+             */
+            initializationVector?:
+                string;
+            /**
+             * Optional. An optional CRC32C checksum of the RawEncryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received
+             * initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify
+             * that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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.
+             */
+            initializationVectorCrc32c?:
+                string;
+            /**
+             * Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than
+             * 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
+             */
+            plaintext?:
+                string;
+            /**
+             * Optional. An optional CRC32C checksum of the RawEncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received plaintext using this checksum.
+             * KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(plaintext) is equal to
+             * plaintext_crc32c, and if so, 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.
+             */
+            plaintextCrc32c?:
+                string;
+        }
+        interface RawEncryptResponse {
+            /** The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field. */
+            ciphertext?:
+                string;
+            /**
+             * Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of
+             * ciphertext 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.
+             */
+            ciphertextCrc32c?:
+                string;
+            /** The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time. */
+            initializationVector?:
+                string;
+            /**
+             * Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing
+             * the CRC32C checksum of initialization_vector 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.
+             */
+            initializationVectorCrc32c?:
+                string;
+            /** The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption. */
+            name?:
+                string;
+            /** The ProtectionLevel of the CryptoKeyVersion used in encryption. */
+            protectionLevel?:
+                string;
+            /** The length of the authentication tag that is appended to the end of the ciphertext. */
+            tagLength?:
+                number;
+            /**
+             * Integrity verification field. A flag indicating whether RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity
+             * verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it
+             * was not delivered to KeyManagementService. If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a
+             * limited number of retries.
+             */
+            verifiedAdditionalAuthenticatedDataCrc32c?:
+                boolean;
+            /**
+             * Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification
+             * of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to
+             * KeyManagementService. If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.
+             */
+            verifiedInitializationVectorCrc32c?:
+                boolean;
+            /**
+             * Integrity verification field. A flag indicating whether RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the
+             * plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set
+             * RawEncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
+             */
+            verifiedPlaintextCrc32c?:
+                boolean;
+        }
         // tslint:disable-next-line:no-empty-interface
         interface RestoreCryptoKeyVersionRequest {
         }
@@ -2327,6 +2513,171 @@ declare namespace gapi.client {
                     string;
             },
             body: CryptoKeyVersion): Request<CryptoKeyVersion>;
+            /** Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT. */
+            rawDecrypt(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Required. The resource name of the CryptoKeyVersion to use for decryption. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    RawDecryptRequest;
+            }): Request<RawDecryptResponse>;
+            rawDecrypt(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Required. The resource name of the CryptoKeyVersion to use for decryption. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: RawDecryptRequest): Request<RawDecryptResponse>;
+            /**
+             * Encrypts data using portable cryptographic primitives. Most users should choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.purpose must be
+             * RAW_ENCRYPT_DECRYPT.
+             */
+            rawEncrypt(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Required. The resource name of the CryptoKeyVersion to use for encryption. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    RawEncryptRequest;
+            }): Request<RawEncryptResponse>;
+            rawEncrypt(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Required. The resource name of the CryptoKeyVersion to use for encryption. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: RawEncryptRequest): Request<RawEncryptResponse>;
             /** Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared. */
             restore(request: {
                 /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.cloudkms-v1",
-  "version": "0.0.20230614",
+  "version": "0.0.20230625",
   "description": "TypeScript typings for Cloud Key Management Service (KMS) API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230614
+// Revision: 20230625
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -683,6 +683,32 @@ gapi.load('client', async () => {
             reimportEligible: true,
             state: "Test string",
         });
+        /** Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT. */
+        await gapi.client.cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.rawDecrypt({
+            name: "Test string",
+        }, {
+            additionalAuthenticatedData: "Test string",
+            additionalAuthenticatedDataCrc32c: "Test string",
+            ciphertext: "Test string",
+            ciphertextCrc32c: "Test string",
+            initializationVector: "Test string",
+            initializationVectorCrc32c: "Test string",
+            tagLength: 42,
+        });
+        /**
+         * Encrypts data using portable cryptographic primitives. Most users should choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.purpose must be
+         * RAW_ENCRYPT_DECRYPT.
+         */
+        await gapi.client.cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.rawEncrypt({
+            name: "Test string",
+        }, {
+            additionalAuthenticatedData: "Test string",
+            additionalAuthenticatedDataCrc32c: "Test string",
+            initializationVector: "Test string",
+            initializationVectorCrc32c: "Test string",
+            plaintext: "Test string",
+            plaintextCrc32c: "Test string",
+        });
         /** Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared. */
         await gapi.client.cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore({
             name: "Test string",