Ресурс openssl_ec_private_key

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

Страница всех ресурсов Infra

Используйте ресурс 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 Infra Client.

Уведомления

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