googleapis
Version:
Google APIs Client Library for Node.js
736 lines • 196 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudkms_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
/**
* 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;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Key Management Service (KMS) API
*
* Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
*
* @example
* ```js
* const {google} = require('googleapis');
* const cloudkms = google.cloudkms('v1');
* ```
*/
export class Cloudkms {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message for KeyManagementService.AsymmetricDecrypt.
*/
export interface Schema$AsymmetricDecryptRequest {
/**
* Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.
*/
ciphertext?: string | null;
/**
* Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.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 | null;
}
/**
* Response message for KeyManagementService.AsymmetricDecrypt.
*/
export interface Schema$AsymmetricDecryptResponse {
/**
* The decrypted data originally encrypted with the matching public key.
*/
plaintext?: string | null;
/**
* Integrity verification field. A CRC32C checksum of the returned AsymmetricDecryptResponse.plaintext. An integrity check of AsymmetricDecryptResponse.plaintext can be performed by computing the CRC32C checksum of AsymmetricDecryptResponse.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: 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 | null;
/**
* The ProtectionLevel of the CryptoKeyVersion used in decryption.
*/
protectionLevel?: string | null;
/**
* Integrity verification field. A flag indicating whether AsymmetricDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
*/
verifiedCiphertextCrc32c?: boolean | null;
}
/**
* Request message for KeyManagementService.AsymmetricSign.
*/
export interface Schema$AsymmetricSignRequest {
/**
* Optional. The data to sign. It can't be supplied if AsymmetricSignRequest.digest is supplied.
*/
data?: string | null;
/**
* Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.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(AsymmetricSignRequest.data) is equal to AsymmetricSignRequest.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.
*/
dataCrc32c?: string | null;
/**
* Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm. This field may not be supplied if AsymmetricSignRequest.data is supplied.
*/
digest?: Schema$Digest;
/**
* Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest 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(AsymmetricSignRequest.digest) is equal to AsymmetricSignRequest.digest_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.
*/
digestCrc32c?: string | null;
}
/**
* Response message for KeyManagementService.AsymmetricSign.
*/
export interface Schema$AsymmetricSignResponse {
/**
* The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing.
*/
name?: string | null;
/**
* The ProtectionLevel of the CryptoKeyVersion used for signing.
*/
protectionLevel?: string | null;
/**
* The created signature.
*/
signature?: string | null;
/**
* Integrity verification field. A CRC32C checksum of the returned AsymmetricSignResponse.signature. An integrity check of AsymmetricSignResponse.signature can be performed by computing the CRC32C checksum of AsymmetricSignResponse.signature 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.
*/
signatureCrc32c?: string | null;
/**
* Integrity verification field. A flag indicating whether AsymmetricSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that AsymmetricSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.
*/
verifiedDataCrc32c?: boolean | null;
/**
* Integrity verification field. A flag indicating whether AsymmetricSignRequest.digest_crc32c was received by KeyManagementService and used for the integrity verification of the digest. A false value of this field indicates either that AsymmetricSignRequest.digest_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.digest_crc32c but this field is still false, discard the response and perform a limited number of retries.
*/
verifiedDigestCrc32c?: boolean | null;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.
*/
export interface Schema$Certificate {
/**
* Output only. The issuer distinguished name in RFC 2253 format. Only present if parsed is true.
*/
issuer?: string | null;
/**
* Output only. The certificate is not valid after this time. Only present if parsed is true.
*/
notAfterTime?: string | null;
/**
* Output only. The certificate is not valid before this time. Only present if parsed is true.
*/
notBeforeTime?: string | null;
/**
* Output only. True if the certificate was parsed successfully.
*/
parsed?: boolean | null;
/**
* Required. The raw certificate bytes in DER format.
*/
rawDer?: string | null;
/**
* Output only. The certificate serial number as a hex string. Only present if parsed is true.
*/
serialNumber?: string | null;
/**
* Output only. The SHA-256 certificate fingerprint as a hex string. Only present if parsed is true.
*/
sha256Fingerprint?: string | null;
/**
* Output only. The subject distinguished name in RFC 2253 format. Only present if parsed is true.
*/
subject?: string | null;
/**
* Output only. The subject Alternative DNS names. Only present if parsed is true.
*/
subjectAlternativeDnsNames?: string[] | null;
}
/**
* Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2.
*/
export interface Schema$CertificateChains {
/**
* Cavium certificate chain corresponding to the attestation.
*/
caviumCerts?: string[] | null;
/**
* Google card certificate chain corresponding to the attestation.
*/
googleCardCerts?: string[] | null;
/**
* Google partition certificate chain corresponding to the attestation.
*/
googlePartitionCerts?: string[] | null;
}
/**
* 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.
*/
export interface Schema$CryptoKey {
/**
* Output only. The time at which this CryptoKey was created.
*/
createTime?: string | null;
/**
* Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/x/locations/x/ekmConnections/x`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.
*/
cryptoKeyBackend?: string | null;
/**
* Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours.
*/
destroyScheduledDuration?: string | null;
/**
* Immutable. Whether this key may contain imported versions only.
*/
importOnly?: boolean | null;
/**
* Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The resource name for this CryptoKey in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`.
*/
name?: string | null;
/**
* At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
*/
nextRotationTime?: string | null;
/**
* Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.
*/
primary?: Schema$CryptoKeyVersion;
/**
* Immutable. The immutable purpose of this CryptoKey.
*/
purpose?: string | null;
/**
* next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
*/
rotationPeriod?: string | null;
/**
* A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
*/
versionTemplate?: Schema$CryptoKeyVersionTemplate;
}
/**
* A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
*/
export interface Schema$CryptoKeyVersion {
/**
* Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
*/
algorithm?: string | null;
/**
* Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
*/
attestation?: Schema$KeyOperationAttestation;
/**
* Output only. The time at which this CryptoKeyVersion was created.
*/
createTime?: string | null;
/**
* Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
*/
destroyEventTime?: string | null;
/**
* Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
*/
destroyTime?: string | null;
/**
* Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
*/
externalDestructionFailureReason?: string | null;
/**
* ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
*/
externalProtectionLevelOptions?: Schema$ExternalProtectionLevelOptions;
/**
* Output only. The time this CryptoKeyVersion's key material was generated.
*/
generateTime?: string | null;
/**
* Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
*/
generationFailureReason?: string | null;
/**
* Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
*/
importFailureReason?: string | null;
/**
* Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
*/
importJob?: string | null;
/**
* Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
*/
importTime?: string | null;
/**
* Output only. The resource name for this CryptoKeyVersion in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x`.
*/
name?: string | null;
/**
* Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
*/
protectionLevel?: string | null;
/**
* Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
*/
reimportEligible?: boolean | null;
/**
* The current state of the CryptoKeyVersion.
*/
state?: string | null;
}
/**
* A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.
*/
export interface Schema$CryptoKeyVersionTemplate {
/**
* Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT.
*/
algorithm?: string | null;
/**
* ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE.
*/
protectionLevel?: string | null;
}
/**
* Request message for KeyManagementService.Decrypt.
*/
export interface Schema$DecryptRequest {
/**
* Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.
*/
additionalAuthenticatedData?: string | null;
/**
* Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.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 | null;
/**
* Required. The encrypted data originally returned in EncryptResponse.ciphertext.
*/
ciphertext?: string | null;
/**
* Optional. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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 | null;
}
/**
* Response message for KeyManagementService.Decrypt.
*/
export interface Schema$DecryptResponse {
/**
* The decrypted data originally supplied in EncryptRequest.plaintext.
*/
plaintext?: string | null;
/**
* Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext. An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.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 | null;
/**
* The ProtectionLevel of the CryptoKeyVersion used in decryption.
*/
protectionLevel?: string | null;
/**
* Whether the Decryption was performed using the primary key version.
*/
usedPrimary?: boolean | null;
}
/**
* Request message for KeyManagementService.DestroyCryptoKeyVersion.
*/
export interface Schema$DestroyCryptoKeyVersionRequest {
}
/**
* A Digest holds a cryptographic message digest.
*/
export interface Schema$Digest {
/**
* A message digest produced with the SHA-256 algorithm.
*/
sha256?: string | null;
/**
* A message digest produced with the SHA-384 algorithm.
*/
sha384?: string | null;
/**
* A message digest produced with the SHA-512 algorithm.
*/
sha512?: string | null;
}
/**
* An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
*/
export interface Schema$EkmConfig {
/**
* Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
*/
defaultEkmConnection?: string | null;
/**
* Output only. The resource name for the EkmConfig in the format `projects/x/locations/x/ekmConfig`.
*/
name?: string | null;
}
/**
* An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
*/
export interface Schema$EkmConnection {
/**
* Output only. The time at which the EkmConnection was created.
*/
createTime?: string | null;
/**
* Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
*/
cryptoSpacePath?: string | null;
/**
* Optional. Etag of the currently stored EkmConnection.
*/
etag?: string | null;
/**
* Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
*/
keyManagementMode?: string | null;
/**
* Output only. The resource name for the EkmConnection in the format `projects/x/locations/x/ekmConnections/x`.
*/
name?: string | null;
/**
* A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
*/
serviceResolvers?: Schema$ServiceResolver[];
}
/**
* Request message for KeyManagementService.Encrypt.
*/
export interface Schema$EncryptRequest {
/**
* Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE, EXTERNAL, and EXTERNAL_VPC keys the AAD 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 | null;
/**
* Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received EncryptRequest.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(EncryptRequest.additional_authenticated_data) is equal to EncryptRequest.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 | null;
/**
* Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE, EXTERNAL, and EXTERNAL_VPC 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 | null;
/**
* Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received EncryptRequest.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(EncryptRequest.plaintext) is equal to EncryptRequest.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 | null;
}
/**
* Response message for KeyManagementService.Encrypt.
*/
export interface Schema$EncryptResponse {
/**
* The encrypted data.
*/
ciphertext?: string | null;
/**
* Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.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 | null;
/**
* The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.
*/
name?: string | null;
/**
* The ProtectionLevel of the CryptoKeyVersion used in encryption.
*/
protectionLevel?: string | null;
/**
* Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
*/
verifiedAdditionalAuthenticatedDataCrc32c?: boolean | null;
/**
* Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
*/
verifiedPlaintextCrc32c?: boolean | null;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
*/
export interface Schema$ExternalProtectionLevelOptions {
/**
* The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
*/
ekmConnectionKeyPath?: string | null;
/**
* The URI for an external resource that this CryptoKeyVersion represents.
*/
externalKeyUri?: string | null;
}
/**
* Request message for KeyManagementService.GenerateRandomBytes.
*/
export interface Schema$GenerateRandomBytesRequest {
/**
* The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes.
*/
lengthBytes?: number | null;
/**
* The ProtectionLevel to use when generating the random data. Currently, only HSM protection level is supported.
*/
protectionLevel?: string | null;
}
/**
* Response message for KeyManagementService.GenerateRandomBytes.
*/
export interface Schema$GenerateRandomBytesResponse {
/**
* The generated data.
*/
data?: string | null;
/**
* Integrity verification field. A CRC32C checksum of the returned GenerateRandomBytesResponse.data. An integrity check of GenerateRandomBytesResponse.data can be performed by computing the CRC32C checksum of GenerateRandomBytesResponse.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.
*/
dataCrc32c?: string | null;
}
/**
* Request message for KeyManagementService.ImportCryptoKeyVersion.
*/
export interface Schema$ImportCryptoKeyVersionRequest {
/**
* Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
*/
algorithm?: string | null;
/**
* Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.
*/
cryptoKeyVersion?: string | null;
/**
* Required. The name of the ImportJob that was used to wrap this key material.
*/
importJob?: string | null;
/**
* Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.
*/
rsaAesWrappedKey?: string | null;
/**
* Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.
*/
wrappedKey?: string | null;
}
/**
* An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see [Importing a key](https://cloud.google.com/kms/docs/importing-a-key).
*/
export interface Schema$ImportJob {
/**
* Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.
*/
attestation?: Schema$KeyOperationAttestation;
/**
* Output only. The time at which this ImportJob was created.
*/
createTime?: string | null;
/**
* Output only. The time this ImportJob expired. Only present if state is EXPIRED.
*/
expireEventTime?: string | null;
/**
* Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.
*/
expireTime?: string | null;
/**
* Output only. The time this ImportJob's key material was generated.
*/
generateTime?: string | null;
/**
* Required. Immutable. The wrapping method to be used for incoming key material.
*/
importMethod?: string | null;
/**
* Output only. The resource name for this ImportJob in the format `projects/x/locations/x/keyRings/x/importJobs/x`.
*/
name?: string | null;
/**
* Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.
*/
protectionLevel?: string | null;
/**
* Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.
*/
publicKey?: Schema$WrappingPublicKey;
/**
* Output only. The current state of the ImportJob, indicating if it can be used.
*/
state?: string | null;
}
/**
* Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key).
*/
export interface Schema$KeyOperationAttestation {
/**
* Output only. The certificate chains needed to validate the attestation
*/
certChains?: Schema$CertificateChains;
/**
* Output only. The attestation data provided by the HSM when the key operation was performed.
*/
content?: string | null;
/**
* Output only. The format of the attestation data.
*/
format?: string | null;
}
/**
* A KeyRing is a toplevel logical grouping of CryptoKeys.
*/
export interface Schema$KeyRing {
/**
* Output only. The time at which this KeyRing was created.
*/
createTime?: string | null;
/**
* Output only. The resource name for the KeyRing in the format `projects/x/locations/x/keyRings/x`.
*/
name?: string | null;
}
/**
* Response message for KeyManagementService.ListCryptoKeys.
*/
export interface Schema$ListCryptoKeysResponse {
/**
* The list of CryptoKeys.
*/
cryptoKeys?: Schema$CryptoKey[];
/**
* A token to retrieve next page of results. Pass this value in ListCryptoKeysRequest.page_token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The total number of CryptoKeys that matched the query.
*/
totalSize?: number | null;
}
/**
* Response message for KeyManagementService.ListCryptoKeyVersions.
*/
export interface Schema$ListCryptoKeyVersionsResponse {
/**
* The list of CryptoKeyVersions.
*/
cryptoKeyVersions?: Schema$CryptoKeyVersion[];
/**
* A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results.
*/
nextPageToke