THIS REPOSITORY IS DEPRECATED. ALL OF ITS CONTENT AND HISTORY HAS BEEN MOVED TO GOOGLE-CLOUD-NODE
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:
npm install @google-cloud/kms
//
// 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 are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Create Key Asymmetric Decrypt | source code | |
Create Key Asymmetric Sign | source code | |
Create Key Hsm | source code | |
Create Key Labels | source code | |
Create Key Mac | source code | |
Create Key Ring | source code | |
Create Key Rotation Schedule | source code | |
Create Key Symmetric Encrypt Decrypt | source code | |
Create Key Version | source code | |
Decrypt Asymmetric | source code | |
Decrypt Symmetric | source code | |
Destroy Key Version | source code | |
Disable Key Version | source code | |
Enable Key Version | source code | |
Encrypt Asymmetric | source code | |
Encrypt Symmetric | source code | |
Generate Random Bytes | source code | |
Get Key Labels | source code | |
Get Key Version Attestation | source code | |
Get Public Key | source code | |
Iam Add Member | source code | |
Iam Get Policy | source code | |
Iam Remove Member | source code | |
Quickstart | source code | |
Restore Key Version | source code | |
Sign Asymmetric | source code | |
Sign Mac | source code | |
Update Key Add Rotation | source code | |
Update Key Remove Labels | source code | |
Update Key Remove Rotation | source code | |
Update Key Set Primary | source code | |
Update Key Update Labels | source code | |
Verify Asymmetric Ec | source code | |
Verify Asymmetric Rsa | source code | |
Verify Mac | source code |
The Google Cloud Key Management Service Node.js Client API Reference documentation also contains samples.
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:
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.
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
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.
Apache Version 2.0
See LICENSE