azure_key_vault_keys Resource

[edit on GitHub]

Use the azure_key_vault_keys InSpec audit resource to test properties and configuration of multiple of Azure keys within vaults.

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_keys resource block returns all keys within a vault.

describe azure_key_vault_keys(vault_name: 'example_vault') do
  #...
end

Parameters

vault_name

The name of the vault.

Properties

attributes

A list of the key management attributes in this format.

Field: attributes

kids

A list of key ids.

Field: kid

managed

A list of boolean values indicating if the keys are managed by key vault or not.

Field: managed

tags

A list of tag:value pairs defined on the resources being interrogated.

Field: tags

Examples

Test that a Vault has the Named Key.

describe azure_key_vault_keys(vault_name: 'example_vault').where { kid.include?('my_key')} do
  it { should exist }
  its('count') { should be 1 }
end

Loop through Keys by the Key ID.

azure_key_vault_keys(vault_name: 'example_vault').kids.each do |kid|
  describe azure_key_vault_key(key_id: kid) do
    it { should exist }
  end 
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

The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

# If we expect to have at least one key in a vault

describe azure_key_vault_keys(vault_name: 'example_vault') do
  it { should exist }
end

# If we expect not have any keys in a vault

describe azure_key_vault_keys(vault_name: 'example_vault') 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.