Azure Key Vault client library for JavaScript

Azure Key Vault is a Microsoft-managed service providing cloud keys, secrets, and certificate storage and utility that is highly available, secure, durable, scalable, and redundant.

This project provides client libraries in JavaScript that makes it easy to consume Microsoft Azure Key Vault service.

• Source Code - Keys
• Source Code - Secrets
• Source Code - Certificates
• Product documentation
• @azure/keyvault-keys Package (npm)
• @azure/keyvault-secrets Package (npm)
• @azure/keyvault-certificates Package (npm)
• API Reference documentation
• Azure Key Vault REST APIs

Getting started

Features

• Key Vault Keys
  • Create keys using elliptic curve or RSA encryption, optionally backed by Hardware Security Modules (HSM).
  • Import, delete and update keys.
  • Get one or more keys and deleted keys.
  • Recover a deleted key and restore a backed up key.
  • Get the versions and the attributes of a key.
  • Encrypting, decrypting, signing, verifying, wrapping and unwrapping data with keys.
• Key Vault Secrets
  • Get, set and delete a secret.
  • Update a secret and it's attributes.
  • Backup and restore a secret.
  • Get, purge or recover a deleted secret.
  • Get all the versions of a secret, or secrets, or deleted secrets.
• Key Vault Certificates
  • Get, set and delete a certificate.
  • Update a certificate, its attributes, issuer, policy, operation and contacts.
  • Backup and restore a certificate.
  • Get, purge or recover a deleted certificate.
  • Get all the versions of a certificate, or certificates, or deleted certificates.

Compatibility

This library is compatible with Node.js and browsers, and validated against LTS Node.js versions (>=8.16.0) and latest versions of Chrome, Firefox and Edge.

Compatible with IE11

You need polyfills to make this library work with IE11. The easiest way is to use @babel/polyfill, or polyfill service.

You can also load separate polyfills for missed ES feature(s). This library depends on following ES features which need external polyfills loaded.

• Promise
• String.prototype.startsWith
• String.prototype.endsWith
• String.prototype.repeat
• String.prototype.includes
• Array.prototype.includes
• Object.assign
• Object.keys (Override IE11's Object.keys with ES6 polyfill to enable ES6 behavior)
• Symbol

Getting Started

The preferred way to install the Azure Key Vault client libraries for JavaScript is to use the npm package manager. Take "@azure/keyvault-secrets" for example.

Simply type the following into a terminal window:

npm install @azure/keyvault-secrets

In your TypeScript or JavaScript file, import via following:

import * as KeyVaultSecrets from "@azure/keyvault-secrets";

Or

const KeyVaultSecrets = require("@azure/keyvault-secrets");

Examples

Code Samples

• KeyVault Keys Samples (JavaScript)
• KeyVault Keys Samples (TypeScript)
• KeyVault Keys Test Cases
• KeyVault Secrets Samples (JavaScript)
• KeyVault Secrets Samples (TypeScript)
• KeyVault Secrets Test Cases
• KeyVault Certificates Samples (JavaScript)
• KeyVault Certificates Samples (TypeScript)
• KeyVault Certificates Test Cases

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.