Ресурс openssl_rsa_private_key

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

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

Используйте ресурс openssl_rsa_private_key для создания файлов с закрытыми ключами RSA. Если в указанном месте существует допустимый файл ключа RSA, новый файл не будет создан. Если файл ключа RSA открыть не удаётся (потому что он не существует или пароль к файлу ключа RSA не соответствует паролю в рецепте), он будет перезаписан.

Новая функция в Chef Infra Client 14.0.

Синтаксис

Полный синтаксис всех свойств ресурса openssl_rsa_private_key:

openssl_rsa_private_key 'name' do
  force           true, false # default value: false
  group           String, Integer
  key_cipher      String # default value: "des3"
  key_length      Integer # default value: 2048
  key_pass        String
  mode            Integer, String # default value: "0600"
  owner           String, Integer
  path            String # default value: 'name' unless specified
  action          Symbol # defaults to :create if not specified
end

где:

• openssl_rsa_private_key — это ресурс.
• name — имя блока ресурса.
• action определяет, какие действия Chef Infra Client выполнит для приведения узла в нужное состояние.
• force, group, key_cipher, key_length, key_pass, mode, owner, и path — доступные для этого ресурса свойства.

Действия

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

:create

:nothing

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

Свойства

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

force

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

Принудительно создать ключ, даже если такой же ключ уже существует на узле.

group

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

Владение группой, применяемое ко всем файлам, созданным ресурсом.

key_cipher

Тип Ruby: Строка | Значение по умолчанию: des3

Используемый шифр для генерации ключа. Запустите openssl list-cipher-algorithms для просмотра доступных вариантов.

key_length

Тип Ruby: Целое число | Значение по умолчанию: 2048Разрешенные значения: 1024, 2048, 4096, 8192

Желаемая длина ключа в битах.

key_pass

Тип Ruby: Строка

Желаемый пароль для ключа.

mode

Тип Ruby: Целое число, Строка | Значение по умолчанию: 0600

Режим разрешений, применяемый ко всем файлам, созданным ресурсом.

owner

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

Владелец, применяемый ко всем файлам, созданным ресурсом.

path

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

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

Общие функции ресурсов

Ресурсы 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[Строка]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении его состояния. Укажите '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[Строка]'

Ресурс может прослушивать другой ресурс и выполнять действие, если состояние прослушиваемого ресурса меняется. Укажите '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_rsa_private_key в рецептах:

Генерация нового 2048-битного ключа с использованием шифра des3 по умолчанию

openssl_rsa_private_key '/etc/ssl_files/rsakey_des3.pem' do
  key_length 2048
  action :create
end

Генерация нового 1024-битного ключа с использованием шифра aes-128-cbc

openssl_rsa_private_key '/etc/ssl_files/rsakey_aes128cbc.pem' do
  key_length 1024
  key_cipher 'aes-128-cbc'
  action :create
end