azurerm_key_vault_key ресурс

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

Используйте ресурс проверки InSpec аудита azurerm_key_vault_key для проверки свойств и конфигурации 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 веб-ключ.

управляемый

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

метки

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

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

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

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

Матчеры

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

существует

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

Разрешения Azure

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