Socket
Socket
Sign inDemoInstall

@google-cloud/kms

Package Overview
Dependencies
178
Maintainers
5
Versions
64
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 0.3.0 to 0.4.0

35

CHANGELOG.md

@@ -7,2 +7,37 @@ # Changelog

## v0.4.0
03-13-2019 16:16 PDT
### New Features
- feat: add support for the CAVIUM_V2_COMPRESSED type ([#126](https://github.com/googleapis/nodejs-kms/pull/126))
### Bug Fixes
- fix: throw on invalid credentials
- fix(deps): update dependency google-gax to ^0.25.0 ([#113](https://github.com/googleapis/nodejs-kms/pull/113))
### Documentation
- docs: update links in contrib guide ([#125](https://github.com/googleapis/nodejs-kms/pull/125))
- docs: update contributing path in README ([#119](https://github.com/googleapis/nodejs-kms/pull/119))
- docs: move CONTRIBUTING.md to root ([#118](https://github.com/googleapis/nodejs-kms/pull/118))
- docs: add lint/fix example to contributing guide ([#116](https://github.com/googleapis/nodejs-kms/pull/116))
- docs: fix example comments ([#115](https://github.com/googleapis/nodejs-kms/pull/115))
### Internal / Testing Changes
- refactor: update json import paths ([#134](https://github.com/googleapis/nodejs-kms/pull/134))
- build: Add docuploader credentials to node publish jobs ([#132](https://github.com/googleapis/nodejs-kms/pull/132))
- build: use node10 to run samples-test, system-test etc ([#131](https://github.com/googleapis/nodejs-kms/pull/131))
- build: update release configuration
- chore: sync latest proto docs
- chore(deps): update dependency mocha to v6
- build: use linkinator for docs test ([#124](https://github.com/googleapis/nodejs-kms/pull/124))
- chore(deps): update dependency yargs to v13 ([#122](https://github.com/googleapis/nodejs-kms/pull/122))
- build: create docs test npm scripts ([#121](https://github.com/googleapis/nodejs-kms/pull/121))
- build: test using @grpc/grpc-js in CI ([#120](https://github.com/googleapis/nodejs-kms/pull/120))
- refactor: improve generated code style. ([#114](https://github.com/googleapis/nodejs-kms/pull/114))
- chore(deps): update dependency eslint-config-prettier to v4 ([#112](https://github.com/googleapis/nodejs-kms/pull/112))
- test: add a system test to list global keys ([#111](https://github.com/googleapis/nodejs-kms/pull/111))
- build: ignore googleapis.com in doc link check ([#108](https://github.com/googleapis/nodejs-kms/pull/108))
- chore: sync gapic files
## v0.3.0

@@ -9,0 +44,0 @@

15

package.json
{
"name": "@google-cloud/kms",
"description": "Google Cloud Key Management Service (KMS) API client for Node.js",
"version": "0.3.0",
"version": "0.4.0",
"license": "Apache-2.0",

@@ -41,6 +41,8 @@ "author": "Google LLC",

"system-test": "mocha system-test/ smoke-test/ --timeout 600000",
"fix": "eslint '**/*.js' --fix"
"fix": "eslint '**/*.js' --fix",
"docs-test": "linkinator docs -r --skip www.googleapis.com",
"predocs-test": "npm run docs"
},
"dependencies": {
"google-gax": "^0.23.0",
"google-gax": "^0.25.0",
"lodash.merge": "^4.6.0"

@@ -52,3 +54,3 @@ },

"eslint": "^5.1.0",
"eslint-config-prettier": "^3.0.0",
"eslint-config-prettier": "^4.0.0",
"eslint-plugin-node": "^8.0.0",

@@ -59,7 +61,8 @@ "eslint-plugin-prettier": "^3.0.0",

"jsdoc": "^3.5.5",
"mocha": "^5.2.0",
"mocha": "^6.0.0",
"nyc": "^13.0.0",
"power-assert": "^1.6.0",
"prettier": "^1.13.7"
"prettier": "^1.13.7",
"linkinator": "^1.1.2"
}
}

2

README.md

@@ -91,3 +91,3 @@ [//]: # "This README.md file is auto-generated, all changes to this file will be lost."

Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-kms/blob/master/.github/CONTRIBUTING.md).
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-kms/blob/master/CONTRIBUTING.md).

@@ -94,0 +94,0 @@ ## License

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -19,10 +19,13 @@ // Licensed under the Apache License, Version 2.0 (the "License");

/**
* A KeyRing is a toplevel logical grouping of CryptoKeys.
* A KeyRing is a toplevel logical grouping of
* CryptoKeys.
*
* @property {string} name
* Output only. The resource name for the KeyRing in the format
* Output only. The resource name for the
* KeyRing in the format
* `projects/* /locations/* /keyRings/*`.
*
* @property {Object} createTime
* Output only. The time at which this KeyRing was created.
* Output only. The time at which this KeyRing
* was created.
*

@@ -40,23 +43,28 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

/**
* A CryptoKey represents a logical key that can be used for cryptographic
* operations.
* A CryptoKey represents a logical key that
* can be used for cryptographic operations.
*
* A CryptoKey is made up of one or more versions, which
* represent the actual key material used in cryptographic operations.
* A CryptoKey is made up of one or more
* versions, which represent the actual
* key material used in cryptographic operations.
*
* @property {string} name
* Output only. The resource name for this CryptoKey in the format
* Output only. The resource name for this
* CryptoKey in the format
* `projects/* /locations/* /keyRings/* /cryptoKeys/*`.
*
* @property {Object} primary
* Output only. A copy of the "primary" CryptoKeyVersion that will be used
* by Encrypt when this CryptoKey is given
* in EncryptRequest.name.
* 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
* The CryptoKey's primary version can be
* updated via
* UpdateCryptoKeyPrimaryVersion.
*
* All keys with purpose
* ENCRYPT_DECRYPT have a
* primary. For other keys, this field will be omitted.
* ENCRYPT_DECRYPT
* have a primary. For other keys, this field will be omitted.
*

@@ -71,3 +79,4 @@ * This object should have the same structure as [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion}

* @property {Object} createTime
* Output only. The time at which this CryptoKey was created.
* Output only. The time at which this
* CryptoKey was created.
*

@@ -77,3 +86,4 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

* @property {Object} nextRotationTime
* At next_rotation_time, the Key Management Service will automatically:
* At next_rotation_time,
* the Key Management Service will automatically:
*

@@ -84,9 +94,11 @@ * 1. Create a new version of this CryptoKey.

* Key rotations performed manually via
* CreateCryptoKeyVersion and
* CreateCryptoKeyVersion
* and
* UpdateCryptoKeyPrimaryVersion
* do not affect next_rotation_time.
* do not affect
* next_rotation_time.
*
* Keys with purpose
* ENCRYPT_DECRYPT support
* automatic rotation. For other keys, this field must be omitted.
* ENCRYPT_DECRYPT
* support automatic rotation. For other keys, this field must be omitted.
*

@@ -96,10 +108,14 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

* @property {Object} rotationPeriod
* next_rotation_time will be advanced by this period when the service
* automatically rotates a key. Must be at least one day.
* next_rotation_time
* will be advanced by this period when the service automatically rotates a
* key. Must be at least one day.
*
* If rotation_period is set, next_rotation_time must also be set.
* 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.
* ENCRYPT_DECRYPT
* support automatic rotation. For other keys, this field must be omitted.
*

@@ -109,6 +125,8 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* @property {Object} versionTemplate
* 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.
* 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.
*

@@ -129,5 +147,6 @@ * This object should have the same structure as [CryptoKeyVersionTemplate]{@link google.cloud.kms.v1.CryptoKeyVersionTemplate}

/**
* CryptoKeyPurpose describes the cryptographic capabilities of a
* CryptoKey. A given key can only be used for the operations allowed by
* its purpose.
* CryptoKeyPurpose
* describes the cryptographic capabilities of a
* CryptoKey. A given key can only be used
* for the operations allowed by its purpose.
*

@@ -145,4 +164,4 @@ * @enum {number}

/**
* CryptoKeys with this purpose may be used with
* Encrypt and
* CryptoKeys with this purpose may be used
* with Encrypt and
* Decrypt.

@@ -153,4 +172,6 @@ */

/**
* CryptoKeys with this purpose may be used with
* AsymmetricSign and
* CryptoKeys with this purpose may be used
* with
* AsymmetricSign
* and
* GetPublicKey.

@@ -161,4 +182,6 @@ */

/**
* CryptoKeys with this purpose may be used with
* AsymmetricDecrypt and
* CryptoKeys with this purpose may be used
* with
* AsymmetricDecrypt
* and
* GetPublicKey.

@@ -171,10 +194,14 @@ */

/**
* A CryptoKeyVersionTemplate specifies the properties to use when creating
* a new CryptoKeyVersion, either manually with
* CreateCryptoKeyVersion or
* automatically as a result of auto-rotation.
* A CryptoKeyVersionTemplate
* specifies the properties to use when creating a new
* CryptoKeyVersion, either manually
* with
* CreateCryptoKeyVersion
* or automatically as a result of auto-rotation.
*
* @property {number} protectionLevel
* ProtectionLevel to use when creating a CryptoKeyVersion based on
* this template. Immutable. Defaults to SOFTWARE.
* ProtectionLevel to use when creating
* a CryptoKeyVersion based on this
* template. Immutable. Defaults to
* SOFTWARE.
*

@@ -184,7 +211,11 @@ * The number should be among the values of [ProtectionLevel]{@link google.cloud.kms.v1.ProtectionLevel}

* @property {number} algorithm
* Required. Algorithm to use
* when creating a CryptoKeyVersion based on this template.
* 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
* this field is omitted and
* CryptoKey.purpose is
* ENCRYPT_DECRYPT.

@@ -234,3 +265,9 @@ *

*/
CAVIUM_V1_COMPRESSED: 3
CAVIUM_V1_COMPRESSED: 3,
/**
* Cavium HSM attestation V2 compressed with gzip. This is a new format
* Introduced in Cavium's version 3.2-08
*/
CAVIUM_V2_COMPRESSED: 4
}

@@ -240,19 +277,22 @@ };

/**
* A CryptoKeyVersion represents an individual cryptographic key, and the
* associated key material.
* A CryptoKeyVersion represents an
* individual cryptographic key, and the associated key material.
*
* An ENABLED version can be
* used for cryptographic operations.
* 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.
* 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.
*
* @property {string} name
* Output only. The resource name for this CryptoKeyVersion in the format
* Output only. The resource name for this
* CryptoKeyVersion in the format
* `projects/* /locations/* /keyRings/* /cryptoKeys/* /cryptoKeyVersions/*`.
*
* @property {number} state
* The current state of the CryptoKeyVersion.
* The current state of the
* CryptoKeyVersion.
*

@@ -262,4 +302,5 @@ * The number should be among the values of [CryptoKeyVersionState]{@link google.cloud.kms.v1.CryptoKeyVersionState}

* @property {number} protectionLevel
* Output only. The ProtectionLevel describing how crypto operations are
* performed with this CryptoKeyVersion.
* Output only. The ProtectionLevel
* describing how crypto operations are performed with this
* CryptoKeyVersion.
*

@@ -269,4 +310,6 @@ * The number should be among the values of [ProtectionLevel]{@link google.cloud.kms.v1.ProtectionLevel}

* @property {number} algorithm
* Output only. The CryptoKeyVersionAlgorithm that this
* CryptoKeyVersion supports.
* Output only. The
* CryptoKeyVersionAlgorithm
* that this CryptoKeyVersion
* supports.
*

@@ -279,3 +322,4 @@ * The number should be among the values of [CryptoKeyVersionAlgorithm]{@link google.cloud.kms.v1.CryptoKeyVersionAlgorithm}

* on the HSM, independently of Google. Only provided for key versions with
* protection_level HSM.
* protection_level
* HSM.
*

@@ -285,3 +329,4 @@ * This object should have the same structure as [KeyOperationAttestation]{@link google.cloud.kms.v1.KeyOperationAttestation}

* @property {Object} createTime
* Output only. The time at which this CryptoKeyVersion was created.
* Output only. The time at which this
* CryptoKeyVersion was created.
*

@@ -291,3 +336,4 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

* @property {Object} generateTime
* Output only. The time this CryptoKeyVersion's key material was
* Output only. The time this
* CryptoKeyVersion's key material was
* generated.

@@ -298,4 +344,6 @@ *

* @property {Object} destroyTime
* Output only. The time this CryptoKeyVersion's key material is scheduled
* for destruction. Only present if state is
* Output only. The time this
* CryptoKeyVersion's key material is
* scheduled for destruction. Only present if
* state is
* DESTROY_SCHEDULED.

@@ -307,3 +355,4 @@ *

* Output only. The time this CryptoKeyVersion's key material was
* destroyed. Only present if state is
* destroyed. Only present if
* state is
* DESTROYED.

@@ -321,3 +370,4 @@ *

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

@@ -327,6 +377,8 @@ *

* GOOGLE_SYMMETRIC_ENCRYPTION
* algorithm is usable with CryptoKey.purpose
* algorithm is usable with
* CryptoKey.purpose
* ENCRYPT_DECRYPT.
*
* Algorithms beginning with "RSA_SIGN_" are usable with CryptoKey.purpose
* Algorithms beginning with "RSA_SIGN_" are usable with
* CryptoKey.purpose
* ASYMMETRIC_SIGN.

@@ -349,3 +401,4 @@ *

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

@@ -428,3 +481,4 @@ *

/**
* The state of a CryptoKeyVersion, indicating if it can be used.
* The state of a CryptoKeyVersion,
* indicating if it can be used.
*

@@ -444,3 +498,5 @@ * @enum {number}

* disabled, or destroyed yet. Cloud KMS will automatically mark this
* version ENABLED as soon as the version is ready.
* version
* ENABLED
* as soon as the version is ready.
*/

@@ -456,3 +512,5 @@ PENDING_GENERATION: 5,

* This version may not be used, but the key material is still available,
* and the version can be placed back into the ENABLED state.
* and the version can be placed back into the
* ENABLED
* state.
*/

@@ -471,3 +529,5 @@ DISABLED: 2,

* RestoreCryptoKeyVersion
* to put it back into the DISABLED state.
* to put it back into the
* DISABLED
* state.
*/

@@ -478,5 +538,7 @@ DESTROY_SCHEDULED: 4

/**
* A view for CryptoKeyVersions. Controls the level of detail returned
* for CryptoKeyVersions in
* KeyManagementService.ListCryptoKeyVersions and
* A view for CryptoKeyVersions.
* Controls the level of detail returned for
* CryptoKeyVersions in
* KeyManagementService.ListCryptoKeyVersions
* and
* KeyManagementService.ListCryptoKeys.

@@ -490,4 +552,6 @@ *

/**
* Default view for each CryptoKeyVersion. Does not include
* the attestation field.
* Default view for each
* CryptoKeyVersion. Does not
* include the
* attestation field.
*/

@@ -497,3 +561,4 @@ CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED: 0,

/**
* Provides all fields in each CryptoKeyVersion, including the
* Provides all fields in each
* CryptoKeyVersion, including the
* attestation.

@@ -506,3 +571,4 @@ */

/**
* The public key for a given CryptoKeyVersion. Obtained via
* The public key for a given
* CryptoKeyVersion. Obtained via
* GetPublicKey.

@@ -518,4 +584,5 @@ *

* @property {number} algorithm
* The Algorithm associated
* with this key.
* The
* Algorithm
* associated with this key.
*

@@ -533,3 +600,4 @@ * The number should be among the values of [CryptoKeyVersionAlgorithm]{@link google.cloud.kms.v1.CryptoKeyVersionAlgorithm}

/**
* ProtectionLevel specifies how cryptographic operations are performed.
* ProtectionLevel specifies how
* cryptographic operations are performed.
*

@@ -536,0 +604,0 @@ * @enum {number}

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -19,13 +19,17 @@ // Licensed under the Apache License, Version 2.0 (the "License");

/**
* Request message for KeyManagementService.ListKeyRings.
* Request message for
* KeyManagementService.ListKeyRings.
*
* @property {string} parent
* Required. The resource name of the location associated with the
* KeyRings, in the format `projects/* /locations/*`.
* KeyRings, in the format
* `projects/* /locations/*`.
*
* @property {number} pageSize
* Optional limit on the number of KeyRings to include in the
* response. Further KeyRings can subsequently be obtained by
* including the ListKeyRingsResponse.next_page_token in a subsequent
* request. If unspecified, the server will pick an appropriate default.
* Optional limit on the number of KeyRings to
* include in the response. Further KeyRings
* can subsequently be obtained by including the
* ListKeyRingsResponse.next_page_token
* in a subsequent request. If unspecified, the server will pick an
* appropriate default.
*

@@ -45,13 +49,17 @@ * @property {string} pageToken

/**
* Request message for KeyManagementService.ListCryptoKeys.
* Request message for
* KeyManagementService.ListCryptoKeys.
*
* @property {string} parent
* Required. The resource name of the KeyRing to list, in the format
* `projects/* /locations/* /keyRings/*`.
* Required. The resource name of the KeyRing
* to list, in the format `projects/* /locations/* /keyRings/*`.
*
* @property {number} pageSize
* Optional limit on the number of CryptoKeys to include in the
* response. Further CryptoKeys can subsequently be obtained by
* including the ListCryptoKeysResponse.next_page_token in a subsequent
* request. If unspecified, the server will pick an appropriate default.
* Optional limit on the number of CryptoKeys
* to include in the response. Further
* CryptoKeys can subsequently be obtained by
* including the
* ListCryptoKeysResponse.next_page_token
* in a subsequent request. If unspecified, the server will pick an
* appropriate default.
*

@@ -76,14 +84,18 @@ * @property {string} pageToken

/**
* Request message for KeyManagementService.ListCryptoKeyVersions.
* Request message for
* KeyManagementService.ListCryptoKeyVersions.
*
* @property {string} parent
* Required. The resource name of the CryptoKey to list, in the format
* Required. The resource name of the
* CryptoKey to list, in the format
* `projects/* /locations/* /keyRings/* /cryptoKeys/*`.
*
* @property {number} pageSize
* Optional limit on the number of CryptoKeyVersions to
* include in the response. Further CryptoKeyVersions can
* subsequently be obtained by including the
* ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.
* If unspecified, the server will pick an appropriate default.
* Optional limit on the number of
* CryptoKeyVersions to include in the
* response. Further CryptoKeyVersions
* can subsequently be obtained by including the
* ListCryptoKeyVersionsResponse.next_page_token
* in a subsequent request. If unspecified, the server will pick an
* appropriate default.
*

@@ -108,3 +120,4 @@ * @property {string} pageToken

/**
* Response message for KeyManagementService.ListKeyRings.
* Response message for
* KeyManagementService.ListKeyRings.
*

@@ -118,6 +131,8 @@ * @property {Object[]} keyRings

* A token to retrieve next page of results. Pass this value in
* ListKeyRingsRequest.page_token to retrieve the next page of results.
* ListKeyRingsRequest.page_token
* to retrieve the next page of results.
*
* @property {number} totalSize
* The total number of KeyRings that matched the query.
* The total number of KeyRings that matched
* the query.
*

@@ -133,3 +148,4 @@ * @typedef ListKeyRingsResponse

/**
* Response message for KeyManagementService.ListCryptoKeys.
* Response message for
* KeyManagementService.ListCryptoKeys.
*

@@ -143,6 +159,8 @@ * @property {Object[]} cryptoKeys

* A token to retrieve next page of results. Pass this value in
* ListCryptoKeysRequest.page_token to retrieve the next page of results.
* ListCryptoKeysRequest.page_token
* to retrieve the next page of results.
*
* @property {number} totalSize
* The total number of CryptoKeys that matched the query.
* The total number of CryptoKeys that
* matched the query.
*

@@ -158,3 +176,4 @@ * @typedef ListCryptoKeysResponse

/**
* Response message for KeyManagementService.ListCryptoKeyVersions.
* Response message for
* KeyManagementService.ListCryptoKeyVersions.
*

@@ -168,7 +187,8 @@ * @property {Object[]} cryptoKeyVersions

* A token to retrieve next page of results. Pass this value in
* ListCryptoKeyVersionsRequest.page_token to retrieve the next page of
* results.
* ListCryptoKeyVersionsRequest.page_token
* to retrieve the next page of results.
*
* @property {number} totalSize
* The total number of CryptoKeyVersions that matched the
* The total number of
* CryptoKeyVersions that matched the
* query.

@@ -185,6 +205,8 @@ *

/**
* Request message for KeyManagementService.GetKeyRing.
* Request message for
* KeyManagementService.GetKeyRing.
*
* @property {string} name
* The name of the KeyRing to get.
* The name of the
* KeyRing to get.
*

@@ -200,6 +222,8 @@ * @typedef GetKeyRingRequest

/**
* Request message for KeyManagementService.GetCryptoKey.
* Request message for
* KeyManagementService.GetCryptoKey.
*
* @property {string} name
* The name of the CryptoKey to get.
* The name of the
* CryptoKey to get.
*

@@ -215,6 +239,8 @@ * @typedef GetCryptoKeyRequest

/**
* Request message for KeyManagementService.GetCryptoKeyVersion.
* Request message for
* KeyManagementService.GetCryptoKeyVersion.
*
* @property {string} name
* The name of the CryptoKeyVersion to get.
* The name of the
* CryptoKeyVersion to get.
*

@@ -230,7 +256,8 @@ * @typedef GetCryptoKeyVersionRequest

/**
* Request message for KeyManagementService.GetPublicKey.
* Request message for
* KeyManagementService.GetPublicKey.
*
* @property {string} name
* The name of the CryptoKeyVersion public key to
* get.
* The name of the
* CryptoKeyVersion public key to get.
*

@@ -246,7 +273,9 @@ * @typedef GetPublicKeyRequest

/**
* Request message for KeyManagementService.CreateKeyRing.
* Request message for
* KeyManagementService.CreateKeyRing.
*
* @property {string} parent
* Required. The resource name of the location associated with the
* KeyRings, in the format `projects/* /locations/*`.
* KeyRings, in the format
* `projects/* /locations/*`.
*

@@ -271,7 +300,8 @@ * @property {string} keyRingId

/**
* Request message for KeyManagementService.CreateCryptoKey.
* Request message for
* KeyManagementService.CreateCryptoKey.
*
* @property {string} parent
* Required. The name of the KeyRing associated with the
* CryptoKeys.
* Required. The name of the KeyRing
* associated with the CryptoKeys.
*

@@ -296,10 +326,13 @@ * @property {string} cryptoKeyId

/**
* Request message for KeyManagementService.CreateCryptoKeyVersion.
* Request message for
* KeyManagementService.CreateCryptoKeyVersion.
*
* @property {string} parent
* Required. The name of the CryptoKey associated with
* the CryptoKeyVersions.
* Required. The name of the
* CryptoKey associated with the
* CryptoKeyVersions.
*
* @property {Object} cryptoKeyVersion
* A CryptoKeyVersion with initial field values.
* A CryptoKeyVersion with initial
* field values.
*

@@ -317,3 +350,4 @@ * This object should have the same structure as [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion}

/**
* Request message for KeyManagementService.UpdateCryptoKey.
* Request message for
* KeyManagementService.UpdateCryptoKey.
*

@@ -339,6 +373,8 @@ * @property {Object} cryptoKey

/**
* Request message for KeyManagementService.UpdateCryptoKeyVersion.
* Request message for
* KeyManagementService.UpdateCryptoKeyVersion.
*
* @property {Object} cryptoKeyVersion
* CryptoKeyVersion with updated values.
* CryptoKeyVersion with updated
* values.
*

@@ -361,10 +397,13 @@ * This object should have the same structure as [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion}

/**
* Request message for KeyManagementService.Encrypt.
* Request message for
* KeyManagementService.Encrypt.
*
* @property {string} name
* Required. The resource name of the CryptoKey or CryptoKeyVersion
* to use for encryption.
* Required. The resource name of the
* CryptoKey or
* CryptoKeyVersion to use for
* encryption.
*
* If a CryptoKey is specified, the server will use its
* primary version.
* If a CryptoKey is specified, the server
* will use its primary version.
*

@@ -375,18 +414,21 @@ * @property {string} plaintext

* 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.
* 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.
*
* @property {string} additionalAuthenticatedData
* Optional data that, if specified, must also be provided during decryption
* through DecryptRequest.additional_authenticated_data.
* through
* DecryptRequest.additional_authenticated_data.
*
* The maximum size depends on the key version's
* protection_level. For
* SOFTWARE 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.
* protection_level.
* For SOFTWARE 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.
*

@@ -402,7 +444,9 @@ * @typedef EncryptRequest

/**
* Request message for KeyManagementService.Decrypt.
* Request message for
* KeyManagementService.Decrypt.
*
* @property {string} name
* Required. The resource name of the CryptoKey to use for decryption.
* The server will choose the appropriate version.
* Required. The resource name of the
* CryptoKey to use for decryption. The
* server will choose the appropriate version.
*

@@ -426,6 +470,9 @@ * @property {string} ciphertext

/**
* Request message for KeyManagementService.AsymmetricSign.
* Request message for
* KeyManagementService.AsymmetricSign.
*
* @property {string} name
* Required. The resource name of the CryptoKeyVersion to use for signing.
* Required. The resource name of the
* CryptoKeyVersion to use for
* signing.
*

@@ -448,11 +495,14 @@ * @property {Object} digest

/**
* Request message for KeyManagementService.AsymmetricDecrypt.
* Request message for
* KeyManagementService.AsymmetricDecrypt.
*
* @property {string} name
* Required. The resource name of the CryptoKeyVersion to use for
* Required. The resource name of the
* CryptoKeyVersion to use for
* decryption.
*
* @property {string} ciphertext
* Required. The data encrypted with the named CryptoKeyVersion's public
* key using OAEP.
* Required. The data encrypted with the named
* CryptoKeyVersion's public key using
* OAEP.
*

@@ -468,6 +518,8 @@ * @typedef AsymmetricDecryptRequest

/**
* Response message for KeyManagementService.Decrypt.
* Response message for
* KeyManagementService.Decrypt.
*
* @property {string} plaintext
* The decrypted data originally supplied in EncryptRequest.plaintext.
* The decrypted data originally supplied in
* EncryptRequest.plaintext.
*

@@ -483,6 +535,9 @@ * @typedef DecryptResponse

/**
* Response message for KeyManagementService.Encrypt.
* Response message for
* KeyManagementService.Encrypt.
*
* @property {string} name
* The resource name of the CryptoKeyVersion used in encryption.
* The resource name of the
* CryptoKeyVersion used in
* encryption.
*

@@ -501,3 +556,4 @@ * @property {string} ciphertext

/**
* Response message for KeyManagementService.AsymmetricSign.
* Response message for
* KeyManagementService.AsymmetricSign.
*

@@ -516,3 +572,4 @@ * @property {string} signature

/**
* Response message for KeyManagementService.AsymmetricDecrypt.
* Response message for
* KeyManagementService.AsymmetricDecrypt.
*

@@ -531,9 +588,12 @@ * @property {string} plaintext

/**
* Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.
* Request message for
* KeyManagementService.UpdateCryptoKeyPrimaryVersion.
*
* @property {string} name
* The resource name of the CryptoKey to update.
* The resource name of the CryptoKey to
* update.
*
* @property {string} cryptoKeyVersionId
* The id of the child CryptoKeyVersion to use as primary.
* The id of the child
* CryptoKeyVersion to use as primary.
*

@@ -549,6 +609,8 @@ * @typedef UpdateCryptoKeyPrimaryVersionRequest

/**
* Request message for KeyManagementService.DestroyCryptoKeyVersion.
* Request message for
* KeyManagementService.DestroyCryptoKeyVersion.
*
* @property {string} name
* The resource name of the CryptoKeyVersion to destroy.
* The resource name of the
* CryptoKeyVersion to destroy.
*

@@ -564,6 +626,8 @@ * @typedef DestroyCryptoKeyVersionRequest

/**
* Request message for KeyManagementService.RestoreCryptoKeyVersion.
* Request message for
* KeyManagementService.RestoreCryptoKeyVersion.
*
* @property {string} name
* The resource name of the CryptoKeyVersion to restore.
* The resource name of the
* CryptoKeyVersion to restore.
*

@@ -599,3 +663,4 @@ * @typedef RestoreCryptoKeyVersionRequest

/**
* Cloud KMS metadata for the given google.cloud.location.Location.
* Cloud KMS metadata for the given
* google.cloud.location.Location.
*

@@ -605,3 +670,4 @@ * @property {boolean} hsmAvailable

* protection_level
* HSM can be created in this location.
* HSM can be created in this
* location.
*

@@ -608,0 +674,0 @@ * @typedef LocationMetadata

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -3,0 +3,0 @@ // Licensed under the Apache License, Version 2.0 (the "License");

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -3,0 +3,0 @@ // Licensed under the Apache License, Version 2.0 (the "License");

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -3,0 +3,0 @@ // Licensed under the Apache License, Version 2.0 (the "License");

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -3,0 +3,0 @@ // Licensed under the Apache License, Version 2.0 (the "License");

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -3,0 +3,0 @@ // Licensed under the Apache License, Version 2.0 (the "License");

@@ -1,2 +0,2 @@

// Copyright 2018 Google LLC
// Copyright 2019 Google LLC
//

@@ -3,0 +3,0 @@ // Licensed under the Apache License, Version 2.0 (the "License");

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc