Navigáció kihagyása

Getting started with Key Vault in Node.js

Utolsó frissítés: 2017. 07. 11.
Szerkesztés a GitHubon

This sample demonstrates how to create and manage a keyvault and interact with it in Node.js. We will also write an app that consumes information from the key vault.


In this sample

(a) We will learn how to create and manage a keyvault. we will perform operations on it like storing and retrieving keys and secrets. Finally, we will authorize an application and give it permissions to interact with the vault.

(b) we will write a weather application that talks to the openweathermap api to retrieve the current weather data for a given city. The app will need an API key to make the call, which we would store in the key vault we provisioned in the above step and fetch from the app.

On this page:

How to run this sample

  1. If you don't already have it, get node.js.

  2. Clone the repo.

   git clone key-vault
  1. Install the dependencies.
   cd key-vault
   npm install
  1. Create an Azure service principals, using one of the following:

    This service principal is to run the sample on your azure account.

  2. Create another Azure service principal using Azure Portal.

    We will authorize this service principal to access key vault. In this service principal, from the azure portal, create a new key and save it. note down the key value upon hitting save. Also, note down the application id and the object id for the service prinicipals, we would use them later.

  3. Set the following environment variables using the information from the service principal that you created.

   export AZURE_SUBSCRIPION_ID={your subscription id}
   export CLIENT_ID={your client id}
   export APPLICATION_SECRET={your client secret}
   export DOMAIN={your tenant id as a guid OR the domain name of your org <>}
   export OBJECT_ID={Object id of the service principal}

   export SP_KEYVAULT_OPERATIONS={application id of the app, that we want to authorize to interact with keyvault, created in step 5}
   export OBJECT_ID_KEYVAULT_OPERATIONS={Object id of the app, that we want to authorize to interact with keyvault, created in step 5}
   export WEATHER_APP_KEY={key value that we noted down in step 5}

   export KEYVAULT_SECRET_NAME=open-weather-map-key

[AZURE.NOTE] On Windows, use set instead of export.

  1. First we need to provision a key vault resource and authorize an app to use it.
   node index.js
  1. Get an API key from openweathermap and securely store it in key vault.
   azure keyvault secret set --vault-name "<key vault name>" --secret-name "open-weather-map-key" "<api key>"

Alternatively, you can accomplish this from the Azure portal as well.

[AZURE.NOTE] You should be logged in with a service principal that has access to the key vault resource. The secret-name should match the environment variable (KEYVAULT_SECRET_NAME) exported in step 6 above and is also used in weather-app.js.

  1. Run an app that displays current weather conditions for a given city.
   node weather-app.js <key vault name> <city>

key vault name: not the whole url, just the name from https://<vaultName>

city: format is e.g: redmond, us or London, uk. country is optional but it helps in disambiguating city name.

  1. To clean up and delete all the resources we created, run the cleanup script.
   node cleanup.js <resourceGroupName> <keyVaultName>

What index.js does

The sample creates a new key vault, add a key and a secret to the vault, retrieve keys and secrets from it, authorizes an app to use this keyvault's resources.

We start by logging in using your service principal and creating ResourceManagementClient and KeyVaultManagementClient objects. We then perform an authentication handshake with the KeyVault service before creating a KeyVaultClient object.

   msRestAzure.loginWithServicePrincipalSecret(clientId, secret, domain).then((err, credentials) => {
       if (err) return console.log(err);
       resourceClient = new ResourceManagementClient(credentials, subscriptionId);
       keyVaultManagementClient = new KeyVaultManagementClient(credentials, subscriptionId);

       var kvCredentials = new KeyVault.KeyVaultCredentials(authenticator);
       keyVaultClient = new KeyVault.KeyVaultClient(kvCredentials);

We then set up a resource group in which we will create the key vault resource.

   let groupParameters = { location: location, tags: { sampletag: 'sampleValue' } };
   return resourceClient.resourceGroups.createOrUpdate(resourceGroupName, groupParameters).then( /* ... */ );

The next step is to create and provision a key vault resource.

   let keyPermissions = ['get', 'create', ...];
   let keyVaultParameters = {
       location: location,
       properties: {...},
       tags: {}

   keyVaultManagementClient.vaults.createOrUpdate(resourceGroupName, keyVaultName, keyVaultParameters).then( /* ... */ );

One a key vault has been provisioned, we interact with it by

a. adding a key.

   let attributes = { expires: new Date(...), notBefore: new Date(...) };
   let keyOperations = ['encrypt', 'decrypt', ...];
   let keyOptions = {
       keyOps: keyOperations,
       keyAttributes: attributes
   let keyName = '<name>';

   keyVaultClient.createKey(vaultUri, keyName, 'RSA', keyOptions).then( /* ... */ );

b. set a secret.

   let attributes = { expires: new Date(...), notBefore: new Date(...) };
   let secretOptions = {
       contentType: 'test secret',
       secretAttributes: attributes
   let secretName = '<name>';
   let secretValue = '<value>';

   keyVaultClient.setSecret(vaultUri, secretName, secretValue, secretOptions).then( /*  ... */ );

c. get all keys from the vault.

   keyVaultClient.getKeys(vaultUri).then( /*  ... */ );

d. get all secrets from the vault.

   keyVaultClient.getSecrets(vaultUri).then( /*  ... */ );

Finally, we authorize an app to interact with keyvault, by specifying an access policy. To accomplish this, we first get the vault we created from the resource group using a vaults.get call. We then call createOrUpdate on that vault, with updated parameters, which contains an additional access policy. The createOrUpdate call will replace the parameters, so we copy the vault's original properties into our new parameters object and append a new accessPolicyEntry to it.

   keyVaultManagementClient.vaults.get(resourceGroupName, keyVaultName)
       .then((err, result, httpRequest, response) => {
           let vault = result;

           let parameters = new keyVaultManagementClient.models.VaultCreateOrUpdateParameters();
           parameters.location = vault.location;

           let newAccessPolicyEntry = {
               tenantId: domain,
               objectId: objectIdForKeyVault,
               applicationId: keyVaultSp,
               permissions: {
                   keys: ['get', 'list', 'import'],
                   secrets: ['all']


           keyVaultManagementClient.vaults.createOrUpdate(resourceGroupName, keyVaultName, parameters).then( /* ... */ );

In case if we hit an error while executing these steps, we initiate an auto cleanup and exit.

   console.log(`performing auto cleanup on error. deleting ${keyVaultName} and ${resourceGroupName}`);

What weather-app.js does

The app starts by logging into the azure account, by using your service principal.

We then authenticate with the KeyVault service by using the service principal that was previously authorized to interact with the key vault in index.js (see: SP_KEYVAULT_OPERATIONS)

   // authenticate with key vault with a service principal that we gave access in index.js
   let kvCredentials = new KeyVault.KeyVaultCredentials(authenticator);

Once authenticated, we fetch the secret's value from the key vault, which would be our API key for

   // get the secret's value (api key for openweathermap).
   keyVaultClient.getSecret(vaultUri, (err, result) => { /* ... */ });

We then make an http request to openweathermap with the api key and city name and display the weather information.

   // query openweathermap api and get weather data.
   http.get(requestUri, res => { /* ... */ });

What cleanup js does

Running cleanup.js deletes the key vault that the sample created:

   console.log('\nDeleting key vault : ' + keyVaultName);
   return keyVaultManagementClient.vaults.deleteMethod(resourceGroupName, keyVaultName).then( /* ... */ );

It also deletes the resource group that the sample created:

   console.log('\nDeleting resource group: ' + resourceGroupName);
   return resourceClient.resourceGroups.deleteMethod(resourceGroupName).then( /* ... */ );

References and further reading