Skip to content

Latest commit

 

History

History
106 lines (84 loc) · 4.72 KB

azure_key_vault_key.md

File metadata and controls

106 lines (84 loc) · 4.72 KB
Raw
title platform
About the azure_key_vault_key Resource
azure

azure_key_vault_key

Use the azure_key_vault_key InSpec audit resource to test properties and configuration of an Azure key within a vault.

Azure REST API Version, Endpoint, and HTTP Client Parameters

This resource interacts with API versions supported by the resource provider. The api_version can be defined as a resource parameter. If not provided, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint and default values for the HTTP client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

An azure_key_vault_key resource block identifies an Azure key by vault_name and key_name or the key_id. You may also specify a key_version - if no version is specified, the most recent version of the key will be used.

describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do
  it { should exist }
end
describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key', key_version: '78deebed173b48e48f55abf87ed4cf71') do
  it { should exist }
end
describe azure_key_vault_key(key_id: 'https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350') do
  it { should exist }
end

Parameters

Name Description
vault_name The name of the key vault that the targeted key resides in. my_vault
key_name The name of the key to interrogate. my_key
name Alias for the key_name parameter. my_key
key_version (Optional) - The version of a Key, e.g. 7df9bf2c3b4347bab213ebe233f0e350.
key_id The unique id of the key, e.g. https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350.

Either one of the parameter sets can be provided for a valid query:

  • vault_name and key_name
  • vault_name and name
  • key_id

Properties

Property Description
attributes The key management attributes in this format.
key The Json web key in this format.
managed true if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
tags Application specific metadata in the form of key-value pairs.

Also, refer to Azure documentation for more details. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test the Key Identifier

describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key', key_version: '7df9bf2c3b4347bab213ebe233f0e350') do
  its('key.kid') { should cmp 'https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350' }
end

Test if the Key is Enabled

describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do
  its('attributes.enabled') { should eq true }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# If we expect the key to always exist
describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do
  it { should exist }
end

# If we expect the key to never exist
describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.