private_key

[edit on GitHub]

Warning

This functionality was available with Chef Provisioning and was packaged in the ChefDK.

Chef Provisioning was officially end-of-life on August 31, 2019 and is no longer included with ChefDK. The Chef Provisioning source code and drivers have been moved into the chef-boneyard organization. If you are a current user of Chef Provisioning, please contact your Chef Customer Success Manager or Account Representative to review your options.

Use the private_key resource to create, delete, and regenerate private keys, including RSA, DSA, and .pem file keys.

Syntax

The syntax for using the private_key resource in a recipe is as follows:

private_key 'name' do
  attribute 'value' # see properties section below
  ...
  action :action # see actions section below
end

where

  • private_key tells Chef Infra Client to use the Chef::Provider::PrivateKey provider during a Chef Infra Client run

  • name is the name of the resource block; when the path property is not specified as part of a recipe, name is also the name of the private key

  • attribute is zero (or more) of the properties that are available for this resource

  • action identifies which steps Chef Infra Client will take to bring the node into the desired state

Actions

This resource has the following actions:

:create

Default. Use to create an RSA private key.

:delete

Use to delete an RSA private key.

:nothing

This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run.

:regenerate

Use to regenerate an RSA private key.

Properties

This resource has the following properties:

cipher

Use to specify the cipher for a .pem file. Default value: DES-EDE3-CBC.

exponent

Use to specify the exponent for an RSA private key. This is always an odd integer value, often a prime Fermat number, and typically 5, 17, 257, or 65537.

format

Use to specify the format of a private key. Possible values: pem and der. Default value: pem.

ignore_failure

Ruby Type: true, false | Default Value: false

Continue running a recipe if a resource fails for any reason.

notifies

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may notify another resource to take action when its state changes. Specify a 'resource[name]', the :action that resource should take, and then the :timer for that action. A resource may notify more than one resource; use a notifies statement for each resource to be notified.

A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:

:before

Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.

:delayed

Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.

:immediate, :immediately

Specifies that a notification should be run immediately, per resource notified.

The syntax for notifies is:

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

Use to specify the pass phrase for a .pem file.

path

Use to specify the path to a private key. Set to none to create a private key in-memory and not on-disk. Default value: the name of the resource block. See “Syntax” section above for more information.

public_key_format

Use to specify the format of a public key. Possible values: der, openssh, and pem. Default value: openssh.

public_key_path

The path to a public key.

regenerate_if_different

Use to regenerate a private key if it does not have the desired size, type, and so on. Default value: false.

retries

Ruby Type: Integer | Default Value: 0

The number of attempts to catch exceptions and retry the resource.

retry_delay

Ruby Type: Integer | Default Value: 2

The retry delay (in seconds).

size

Use to specify the size of an RSA or DSA private key. Default value: 2048.

source_key

Use to copy a private key, but apply a different format and password. Use in conjunction with source_key_pass_phrase and source_key_path.

source_key_pass_phrase

The pass phrase for the private key. Use in conjunction with source_key and source_key_path.

source_key_path

The path to the private key. Use in conjunction with source_key and source_key_pass_phrase.

subscribes

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]', the :action to be taken, and then the :timer for that action.

Note that subscribes does not apply the specified action to the resource that it listens to - for example:

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

In this case the subscribes property reloads the nginx service whenever its certificate file, located under /etc/nginx/ssl/example.crt, is updated. subscribes does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the :reload action for its resource (in this example nginx) when a change is detected.

A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:

:before

Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.

:delayed

Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.

:immediate, :immediately

Specifies that a notification should be run immediately, per resource notified.

The syntax for subscribes is:

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

Use to specify the type of private key. Possible values: dsa and rsa. Default value: rsa.