azure_key_vault_key Resource

[edit on GitHub]

Use the azure_key_vault_key InSpec audit resource to test the 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, this resource uses the latest version. For more information, refer to the azure_generic_resource document.

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

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

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

vault_name

The name of the key vault where the targeted key resides.

key_name

The name of the key to interrogate.

name

Alias for the key_name parameter.

key_version

(Optional) - The version of a key. For example, 7df9bf2c3b4347bab213ebe233f0e350.

key_id

The unique ID of the key. For example, 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

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

not_exists

# 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 set up with at least a contributor role on the subscription you wish to test.