openssl_ec_private_key Ресурс

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

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

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

Новинка в Chef Infra Client 14.4.

Синтаксис

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

openssl_ec_private_key 'name' do
  force           true, false # default value: false
  group           String, Integer
  key_cipher      String # default value: "des3"
  key_curve       String # default value: "prime256v1"
  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_ec_private_key — это ресурс.
• name — имя, данное блоку ресурса.
• action определяет, какие действия Chef Infra Client предпримет, чтобы привести узел в желаемое состояние.
• force, group, key_cipher, key_curve, key_pass, mode, owner, и path — доступные свойства этого ресурса.

Действия

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

:create

По умолчанию. Создать файл закрытого ключа EC.

:nothing

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

Свойства

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

force

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

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

group

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

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

key_cipher

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

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

key_curve

Тип в Ruby: Строка | Значение по умолчанию: prime256v1Допустимые значения: "prime256v1", "secp224r1", "secp256k1", "secp384r1", "secp521r1"

Желаемая кривая сгенерированного ключа (если тип ключа равен ‘ec’). Запустите openssl ecparam -list_curves, чтобы увидеть доступные варианты.

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_ec_private_key в рецептах:

Сгенерировать новый закрытый ключ ec с кривой ключа prime256v1 и шифром des3 по умолчанию

openssl_ec_private_key '/etc/ssl_files/eckey_prime256v1_des3.pem' do
  key_curve 'prime256v1'
  key_pass 'something'
  action :create
end

Сгенерировать новый закрытый ключ EC с кривой ключа prime256v1 и шифром aes-128-cbc

openssl_ec_private_key '/etc/ssl_files/eckey_prime256v1_des3.pem' do
  key_curve 'prime256v1'
  key_cipher 'aes-128-cbc'
  key_pass 'something'
  action :create
end