Ресурс azurerm_key_vault_secret

[редактировать на GitHub]

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

Версия Azure REST API

Этот ресурс взаимодействует с версией 2016-10-01 API Azure Management. Дополнительную информацию можно найти в официальной документации 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 и secret_name в качестве параметра.

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

describe azurerm_key_vault_secret('vault-101', 'secret-101') do
    it           { should exist }
    its('value') { should_not be_nil }
end

Примеры

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

describe azurerm_key_vault_secret('vault-101', 'secret-101', '7df9bf2c3b4347bab213ebe233f0e350') do
    its('value')       { should_not be_nil }
end

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

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

Параметры

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

Атрибуты

• id
• value
• attributes
• kid
• content_type
• managed
• tags

id

Идентификатор секрета.

значение

Значение секрета.

атрибуты

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

kid

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

тип_контента

Тип содержимого секрета.

управляемый

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

метки

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

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

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

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

Матчеры

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

exists

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

Разрешения Azure

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