What is @google-cloud/secret-manager?
@google-cloud/secret-manager is a Node.js client library for Google Cloud Secret Manager. It allows you to securely store, manage, and access secrets, such as API keys, passwords, certificates, and other sensitive data.
What are @google-cloud/secret-manager's main functionalities?
Create a Secret
This feature allows you to create a new secret in Google Cloud Secret Manager. The code sample demonstrates how to create a secret with automatic replication.
const { SecretManagerServiceClient } = require('@google-cloud/secret-manager');
const client = new SecretManagerServiceClient();
async function createSecret() {
const [secret] = await client.createSecret({
parent: 'projects/my-project',
secretId: 'my-secret',
secret: {
replication: {
automatic: {},
},
},
});
console.log(`Created secret: ${secret.name}`);
}
createSecret();
Add a Secret Version
This feature allows you to add a new version to an existing secret. The code sample demonstrates how to add a new version with a specific payload.
const { SecretManagerServiceClient } = require('@google-cloud/secret-manager');
const client = new SecretManagerServiceClient();
async function addSecretVersion() {
const [version] = await client.addSecretVersion({
parent: 'projects/my-project/secrets/my-secret',
payload: {
data: Buffer.from('my-secret-data', 'utf8'),
},
});
console.log(`Added secret version: ${version.name}`);
}
addSecretVersion();
Access a Secret Version
This feature allows you to access the payload of a specific version of a secret. The code sample demonstrates how to access the latest version of a secret and print its payload.
const { SecretManagerServiceClient } = require('@google-cloud/secret-manager');
const client = new SecretManagerServiceClient();
async function accessSecretVersion() {
const [accessResponse] = await client.accessSecretVersion({
name: 'projects/my-project/secrets/my-secret/versions/latest',
});
const responsePayload = accessResponse.payload.data.toString('utf8');
console.log(`Accessed secret version payload: ${responsePayload}`);
}
accessSecretVersion();
Delete a Secret
This feature allows you to delete a secret from Google Cloud Secret Manager. The code sample demonstrates how to delete a specific secret.
const { SecretManagerServiceClient } = require('@google-cloud/secret-manager');
const client = new SecretManagerServiceClient();
async function deleteSecret() {
await client.deleteSecret({
name: 'projects/my-project/secrets/my-secret',
});
console.log('Deleted secret');
}
deleteSecret();
Other packages similar to @google-cloud/secret-manager
aws-sdk
The aws-sdk package for Node.js provides a comprehensive set of tools for interacting with AWS services, including AWS Secrets Manager. It allows you to store, retrieve, and manage secrets in a similar way to @google-cloud/secret-manager, but within the AWS ecosystem.
azure-keyvault-secrets
The azure-keyvault-secrets package for Node.js allows you to manage secrets in Azure Key Vault. It provides similar functionalities to @google-cloud/secret-manager, such as creating, retrieving, and deleting secrets, but is designed for use with Microsoft Azure.
vault
The vault package for Node.js is a client library for HashiCorp Vault, a tool for securely storing and accessing secrets. It offers similar functionalities to @google-cloud/secret-manager, including secret management and access control, but is designed to work with HashiCorp Vault.
Secrets 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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Secret Manager API.
- 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/secret-manager
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
The Secret Manager 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/secret-manager@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