[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "The comments you see below are used to generate those parts of the template in later states."

[Cloud Key Management Service (KMS) API: Nodejs Client][homepage]

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


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

[//]: # "partials.introduction"

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

* Cloud Key Management Service (KMS) API Nodejs Client API Reference

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

[explained]: https://cloud.google.com/apis/docs/client-libraries-explained

Table of contents:

* Quickstart
* Before you begin
* Installing the client library

* Versioning
* Contributing
* License

Quickstart

$3

1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Cloud Key Management Service (KMS) API API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.

$3

``bash
npm install @google-cloud/kms
`

[//]: # "partials.body"

Samples

Samples are in the [samples/][homepage_samples] directory. Each sample's README.md has instructions for running its sample.

| Sample | Source Code |
| --------------------------- | --------------------------------- |
| create key handle | source code |
| get key handle | source code |
| list key handles | source code |
| get autokey config | source code |
| show effective autokey config | source code |
| update autokey config | source code |
| create ekm connection | source code |
| get ekm config | source code |
| get ekm connection | source code |
| list ekm connections | source code |
| update ekm config | source code |
| update ekm connection | source code |
| verify connectivity | source code |
| approve single tenant hsm instance proposal | source code |
| create single tenant hsm instance | source code |
| create single tenant hsm instance proposal | source code |
| delete single tenant hsm instance proposal | source code |
| execute single tenant hsm instance proposal | source code |
| get single tenant hsm instance | source code |
| get single tenant hsm instance proposal | source code |
| list single tenant hsm instance proposals | source code |
| list single tenant hsm instances | source code |
| asymmetric decrypt | source code |
| asymmetric sign | source code |
| create crypto key | source code |
| create crypto key version | source code |
| create import job | source code |
| create key ring | source code |
| decapsulate | source code |
| decrypt | source code |
| destroy crypto key version | source code |
| encrypt | source code |
| generate random bytes | source code |
| get crypto key | source code |
| get crypto key version | source code |
| get import job | source code |
| get key ring | source code |
| get public key | source code |
| import crypto key version | source code |
| list crypto key versions | source code |
| list crypto keys | source code |
| list import jobs | source code |
| list key rings | source code |
| mac sign | source code |
| mac verify | source code |
| raw decrypt | source code |
| raw encrypt | source code |
| restore crypto key version | source code |
| update crypto key | source code |
| update crypto key primary version | source code |
| update crypto key version | source code |
| cloud | source code |

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.

More Information: [Google Cloud Platform Launch Stages][launch_stages]

[launch_stages]: https://cloud.google.com/terms/launch-stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json`)
are generated from a central template.

License

Apache Version 2.0

See LICENSE

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudkms.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-kms/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-kms/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-kms