azurerm_key_vault_keys ресурс

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

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

Версия Azure REST API

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

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

Доступность

Установка

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

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

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

Версия

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

Синтаксис

Блок ресурса azurerm_key_vault_keys возвращает все ключи в хранилище.

describe azurerm_key_vault_keys('my-vault') do
  ...
end

Примеры

В следующих примерах показано, как использовать этот ресурс аудита InSpec.

Проверка ключей в хранилище

azurerm_key_vault_keys('my-vault').entries.each do |key|
   describe key do
     its('kid')                { should_not be nil }
     its('attributes.enabled') { should eq true }
   end
end

Критерии фильтрации

Все поля, описанные в Атрибутах, могут использоваться для фильтрации. Ниже приведен пример с использованием managed.

managed

Фильтры результаты, чтобы включить только те ключи, которые не управляются хранилищем. Это булевое значение.

describe azurerm_key_vault_keys('my-vault').where{ managed.eql?(false) } do
  it { should_not exist }
end

Атрибуты

• attributes
• kid
• managed
• tags

атрибуты

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

kid

Идентификатор ключа.

managed

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

метки

Теги ресурсов, применённые к ключу.

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

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

exists

Управление будет пройдено, если фильтр вернёт хотя бы один результат. Используйте should_not если ожидается ноль совпадений.

describe azurerm_key_vault_keys('my-vault') do
  it { should exist }
end

Разрешения Azure

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