openssl_rsa_public_key

[edit on GitHub]

Use the openssl_rsa_public_key resource to generate RSA public key files for a given RSA private key.

New in Chef Client 14.0.

Syntax

This resource has the following syntax:

openssl_rsa_public_key 'name' do
  group                      String, nil
  mode                       Integer, String # default value: '0640'
  notifies                   # see description
  owner                      String, nil
  path                       String
  private_key_content        String
  private_key_pass           String
  private_key_path           String
  subscribes                 # see description
  action                     Symbol # defaults to :create if not specified
end

where:

  • openssl_rsa_public_key is the name of the resource
  • name is the path to the public key file that is to be created, or the name of the resource block
  • group, mode, notifies, owner, path, private_key_content, private_key_pass, private_key_path, and subscribes are the properties available to this resource

Actions

:create
Default. Create the RSA public key.
:nothing
Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.

Properties

group

Ruby Types: String, nil

The system group of all files created by the resource.

mode

Ruby Types: Integer, String | Default Value: 0640

The permission mode of all files created by the resource.

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 the Chef 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 the Chef 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
owner

Ruby Types: String, nil

The system user that owns all files created by the resource.

path

Ruby Type: String

The path of the public key file, if it differs from the resource name.

private_key_content

Ruby Type: String

The content of the private key, including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk.

private_key_pass

Ruby Type: String

The passphrase of the private key.

private_key_path

Ruby Type: String

The path to the private key file.

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 the Chef 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 the Chef 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

Examples

Create a public key from a private key file

openssl_rsa_public_key '/etc/example/key.pub' do
  private_key_path '/etc/example/key.pem'
end

Create a public key from a private key, without writing the private key to disk

openssl_rsa_public_key '/etc/example/key.pub' do
  private_key_content File.read('/home/example/key.pem')
end