Google Cloud Platform logo

Google Cloud Key Management Service: Node.js Client

release level npm version codecov

Google Cloud Key Management Service (KMS) API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Key Management Service API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/kms

Using the client library

//
// TODO(developer): Uncomment these variables before running the sample.
//
// const projectId = 'my-project';
// const locationId = 'us-east1';

// Imports the Cloud KMS library
const {KeyManagementServiceClient} = require('@google-cloud/kms');

// Instantiates a client
const client = new KeyManagementServiceClient();

// Build the location name
const locationName = client.locationPath(projectId, locationId);

async function listKeyRings() {
  const [keyRings] = await client.listKeyRings({
    parent: locationName,
  });

  for (const keyRing of keyRings) {
    console.log(keyRing.name);
  }

  return keyRings;
}

return listKeyRings();

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Create Key Asymmetric Decrypt source code Open in Cloud Shell
Create Key Asymmetric Sign source code Open in Cloud Shell
Create Key Hsm source code Open in Cloud Shell
Create Key Labels source code Open in Cloud Shell
Create Key Ring source code Open in Cloud Shell
Create Key Rotation Schedule source code Open in Cloud Shell
Create Key Symmetric Encrypt Decrypt source code Open in Cloud Shell
Create Key Version source code Open in Cloud Shell
Decrypt Asymmetric source code Open in Cloud Shell
Decrypt Symmetric source code Open in Cloud Shell
Destroy Key Version source code Open in Cloud Shell
Disable Key Version source code Open in Cloud Shell
Enable Key Version source code Open in Cloud Shell
Encrypt Asymmetric source code Open in Cloud Shell
Encrypt Symmetric source code Open in Cloud Shell
Get Key Labels source code Open in Cloud Shell
Get Key Version Attestation source code Open in Cloud Shell
Get Public Key source code Open in Cloud Shell
Iam Add Member source code Open in Cloud Shell
Iam Get Policy source code Open in Cloud Shell
Iam Remove Member source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Restore Key Version source code Open in Cloud Shell
Sign Asymmetric source code Open in Cloud Shell
Update Key Add Rotation source code Open in Cloud Shell
Update Key Remove Labels source code Open in Cloud Shell
Update Key Remove Rotation source code Open in Cloud Shell
Update Key Set Primary source code Open in Cloud Shell
Update Key Update Labels source code Open in Cloud Shell
Verify Asymmetric Ec source code Open in Cloud Shell
Verify Asymmetric Rsa source code Open in Cloud Shell

The Google Cloud Key Management Service Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its template in this directory.

License

Apache Version 2.0

See LICENSE