Google Cloud Key Management Service: Node.js Client

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.

• Google Cloud Key Management Service Node.js Client API Reference
• Google Cloud Key Management Service Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-kms

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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. Each sample's README.md has instructions for running its sample.

| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Autokey.create_key_handle | source code | | | Autokey.get_key_handle | source code | | | Autokey.list_key_handles | source code | | | Autokey_admin.get_autokey_config | source code | | | Autokey_admin.show_effective_autokey_config | source code | | | Autokey_admin.update_autokey_config | source code | | | Ekm_service.create_ekm_connection | source code | | | Ekm_service.get_ekm_config | source code | | | Ekm_service.get_ekm_connection | source code | | | Ekm_service.list_ekm_connections | source code | | | Ekm_service.update_ekm_config | source code | | | Ekm_service.update_ekm_connection | source code | | | Ekm_service.verify_connectivity | source code | | | Key_management_service.asymmetric_decrypt | source code | | | Key_management_service.asymmetric_sign | source code | | | Key_management_service.create_crypto_key | source code | | | Key_management_service.create_crypto_key_version | source code | | | Key_management_service.create_import_job | source code | | | Key_management_service.create_key_ring | source code | | | Key_management_service.decrypt | source code | | | Key_management_service.destroy_crypto_key_version | source code | | | Key_management_service.encrypt | source code | | | Key_management_service.generate_random_bytes | source code | | | Key_management_service.get_crypto_key | source code | | | Key_management_service.get_crypto_key_version | source code | | | Key_management_service.get_import_job | source code | | | Key_management_service.get_key_ring | source code | | | Key_management_service.get_public_key | source code | | | Key_management_service.import_crypto_key_version | source code | | | Key_management_service.list_crypto_key_versions | source code | | | Key_management_service.list_crypto_keys | source code | | | Key_management_service.list_import_jobs | source code | | | Key_management_service.list_key_rings | source code | | | Key_management_service.mac_sign | source code | | | Key_management_service.mac_verify | source code | | | Key_management_service.raw_decrypt | source code | | | Key_management_service.raw_encrypt | source code | | | Key_management_service.restore_crypto_key_version | source code | | | Key_management_service.update_crypto_key | source code | | | Key_management_service.update_crypto_key_primary_version | source code | | | Key_management_service.update_crypto_key_version | source code | | | Quickstart | source code | |

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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/kms@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be 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 stable 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 templates in directory.

License

Apache Version 2.0

See LICENSE