azurerm_key_vault_key ресурс

[править на GitHub]

Используйте azurerm_key_vault_key ресурс аудита InSpec для проверки свойств и конфигурации ключа Azure в хранилище.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2016-10-01 API управления Azure. Дополнительную информацию можно найти в официальной документации Azure.

В настоящее время нет способа выбрать версию документации API Azure. Если вы заметите ссылку на новую версию в официальной документации, откройте вопрос или отправьте запрос на вытягивание с обновленной версией.

Доступность

Установка

Этот ресурс доступен в inspec-azure пакете ресурсов. Для его использования добавьте следующее в свой inspec.yml в вашем профиле верхнего уровня:

depends:
  - name: inspec-azure
    git: https://github.com/inspec/inspec-azure.git

Вам также необходимо настроить свои учетные данные Azure; см. README пакета ресурсов.

Версия

Этот ресурс впервые стал доступен в версии 1.3.0 пакета ресурсов inspec-azure.

Синтаксис

vault_name и key_name должны быть указаны в качестве параметра.

Вы также можете указать key_version - если версия не указана, будет использована последняя версия ключа.

describe azurerm_key_vault_key('vault-101', 'secret-key') do
  its('key.kid')            { should_not be_nil }
  its('attributes.enabled') { should eq true }
end

Примеры

Если ключ хранилища ключей ссылается на допустимое Vault Name, Key Name и Key Version

describe azurerm_key_vault_key('vault-101', 'secret-key', '7df9bf2c3b4347bab213ebe233f0e350') do
    it                        { should exist }
    its('key.kid')            { should_not be_nil }
    its('attributes.enabled') { should eq true }
end

Если ключ хранилища ключей ссылается на недопустимое Vault Name или Key Name

describe azurerm_key_vault_key('vault-101', 'incorrect-key') do
    it { should_not exist }
end

Параметры

• vault_name - Имя хранилища ключей.
• key_name - Имя ключа.
• key_version (необязательно) - Версия ключа, например 7df9bf2c3b4347bab213ebe233f0e350.

Атрибуты

• attributes
• key
• managed
• tags

атрибуты

Атрибуты управления ключом.

ключ

JSON веб-ключ.

управляемый

Истина, если срок действия ключа управляется хранилищем ключей. Если это ключ, поддерживающий сертификат, то управляемый будет истинным.

метки

Метки ресурсов, примененные к ключу.

Другие атрибуты

Существуют дополнительные атрибуты, к которым можно получить доступ, которые мы не задокументировали. Пожалуйста, ознакомьтесь с документацией Azure. Любой атрибут в ответе можно получить, используя имена ключей, разделенные точками (.).

API не всегда возвращает ключи, не имеющие связанных данных. В некоторых случаях вложенное свойство может не иметь нужного атрибута в цепочке вызовов. Если вы пишете тесты на свойства, которые могут быть пустыми, разделите этот пакет ресурсов и добавьте обработчик к ресурсу. В этом обработчике вы сможете защитить пустые ключи. Запросы на вытягивание всегда приветствуются.

Сопоставители

Этот ресурс аудита InSpec имеет следующие специальные сопоставители. Полный список доступных сопоставителей см. на нашей странице Универсальных сопоставителей.

существует

describe azurerm_key_vault_key('vault-101', 'secret-key') do
  it { should exist }
end

Разрешения Azure

Ваш службовый принцип должен быть настроен с ролью contributor на подписке, которую вы хотите протестировать. Ваше хранилище ключей Azure также должно содержать этот Службовый принцип в политике доступа с разрешениями keys/get и keys/list.