Ресурс openssl_x509_crl

Редактировать эту страницу в репозитории Chef

Страница справки по ресурсам

Используйте ресурс openssl_x509_crl для генерации файлов CRL (списка отозванных сертификатов) x509 в формате PEM.

Новое в Chef Infra Client 14.4.

Синтаксис

Полный синтаксис всех свойств, доступных для ресурса openssl_x509_crl:

openssl_x509_crl 'name' do
  ca_cert_file           String
  ca_key_file            String
  ca_key_pass            String
  expire                 Integer # default value: 8
  group                  String, Integer
  mode                   Integer, String
  owner                  String, Integer
  path                   String # default value: 'name' unless specified
  renewal_threshold      Integer # default value: 1
  revocation_reason      Integer # default value: 0
  serial_to_revoke       Integer, String
  action                 Symbol # defaults to :create if not specified
end

где:

• openssl_x509_crl — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла в желаемое состояние.
• ca_cert_file, ca_key_file, ca_key_pass, expire, group, mode, owner, path, renewal_threshold, revocation_reason, и serial_to_revoke — это доступные свойства для этого ресурса.

Действия

Ресурс openssl_x509_crl имеет следующие действия:

:create

По умолчанию. Создает файл списка отозванных сертификатов.

:nothing

Этот блок ресурса не выполняет никаких действий, пока не получит уведомление от другого ресурса о необходимости действия. После уведомления этот блок либо выполняется немедленно, либо помещается в очередь для выполнения в конце выполнения Chef Infra Client.

Свойства

Ресурс openssl_x509_crl имеет следующие свойства:

ca_cert_file

Тип в Ruby: Строка | REQUIRED

Путь к сертификату CA X509 в файловой системе. Если указано свойство ca_cert_file, то необходимо также указать свойство ca_key_file, CRL будет подписан с помощью них.

ca_key_file

Тип в Ruby: Строка | REQUIRED

Путь к закрытому ключу CA в файловой системе. Если указано свойство ca_key_file, то необходимо также указать свойство ca_cert_file, CRL будет подписан с помощью них.

ca_key_pass

Тип в Ruby: Строка

Пароль к закрытому ключу CA.

expire

Тип в Ruby: Целое число | Значение по умолчанию: 8

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

group

Тип в Ruby: Строка, Целое число

Разрешение группы для файла CRL.

mode

Тип в Ruby: Целое число, Строка

Режим разрешений файла CRL.

owner

Тип в Ruby: Строка, Целое число

Разрешение владельца для файла CRL.

path

Тип в Ruby: Строка | Значение по умолчанию: The resource block's name

Необязательное свойство для указания пути записи файла, если оно отличается от имени блока ресурса.

renewal_threshold

Тип в Ruby: Целое число | Значение по умолчанию: 1

Количество дней до истечения срока действия. Если этот порог будет достигнут, CRL будет обновлен.

revocation_reason

Тип в Ruby: Целое число | Значение по умолчанию: 0

Причина отзыва.

serial_to_revoke

Тип в Ruby: Целое число, Строка

Серийный номер сертификата X509 для отзыва.

Общие функциональные возможности ресурсов

Ресурсы Chef включают общие свойства, уведомления и защитные механизмы ресурсов.

Общие свойства

Следующие свойства являются общими для всех ресурсов:

compile_time

Тип в Ruby: true, false | Значение по умолчанию: false

Управление фазой, в которой ресурс выполняется на узле. Установите в значение true, чтобы запустить во время построения коллекции ресурсов (compile phase). Установите в значение false, чтобы запустить во время конфигурации узла Chef Infra Client (converge phase).

ignore_failure

Тип в Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжать выполнение рецепта, если ресурс завершится неудачно по любой причине. :quiet не будет отображать полный стек вызовов, и рецепт будет продолжен, если ресурс завершится неудачно.

retries

Тип в Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехвата исключений и повторной попытки ресурса.

retry_delay

Тип в Ruby: Целое число | Значение по умолчанию: 2

Задержка повторной попытки (в секундах).

sensitive

Тип в Ruby: true, false | Значение по умолчанию: false

Обеспечение того, что конфиденциальные данные ресурса не будут регистрироваться Chef InfraClient.

Уведомления

notifies

Тип в Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомлять другой ресурс о выполнении действий при изменении его состояния. Укажите 'resource[name]', :action которое должен выполнить этот ресурс, а затем :timer для этого действия. Один ресурс может уведомлять несколько ресурсов; используйте инструкцию notifies для каждого уведомляемого ресурса.

Если указанный ресурс не существует, генерируется ошибка. В отличие от subscribes, который не будет завершаться ошибкой, если источник ресурса не найден.

Таймер указывает момент во время выполнения Chef Infra Client, в котором выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомлённым ресурсом должно быть выполнено до обработки блока ресурса, в котором расположено уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно для каждого уведомлённого ресурса.

Синтаксис для notifies:

notifies :action, 'resource[name]', :timer

subscribes

Тип в Ruby: Символ, 'Chef::Resource[String]'

Ресурс может следить за другим ресурсом и затем выполнять действия, если состояние отслеживаемого ресурса изменится. Укажите 'resource[name]', :action для выполнения, и :timer для этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым он следит. Например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный по адресу /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а лишь отслеживает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

Если другой ресурс не существует, подписка не сгенерирует ошибку. В отличие от более строгой семантики notifies, которая сгенерирует ошибку, если другой ресурс не существует.

Таймер указывает момент во время выполнения Chef Infra Client, в котором выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомлённым ресурсом должно быть выполнено до обработки блока ресурса, в котором расположено уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно для каждого уведомлённого ресурса.

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Защитные механизмы

Свойство защитного механизма может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. Основываясь на результатах этой оценки, свойство защитного механизма затем сообщает Chef Infra Client, следует ли продолжить выполнение ресурса. Свойство защитного механизма принимает строковое значение или значение блока Ruby:

• Строка выполняется как командная строка. Если команда возвращает 0, защитный механизм применяется. Если команда возвращает любое другое значение, то свойство защитного механизма не применяется. Строковые защитные механизмы в powershell_script запускают команды Windows PowerShell и могут возвращать true помимо 0.
• Блок выполняется как код Ruby, который должен возвращать либо true либо false . Если блок возвращает true, защитный механизм применяется. Если блок возвращает false, защитный механизм не применяется.

Свойство защитного механизма полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверять желаемое состояние по мере выполнения, а затем, если желаемое состояние присутствует, чтобы Chef Infra Client ничего не делал.

Следующие свойства могут использоваться для определения защитного механизма, который оценивается во время фазы выполнения Chef Infra Client:

not_if

Запретить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса openssl_x509_crl в рецептах:

Создание файла списка отозванных сертификатов

openssl_x509_crl '/etc/ssl_test/my_ca.crl' do
  ca_cert_file '/etc/ssl_test/my_ca.crt'
  ca_key_file '/etc/ssl_test/my_ca.key'
end

Создание файла списка отозванных сертификатов для определённого серийного номера