Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status

The openssl cookbook has been deprecated

Author provided reason for deprecation:

The openssl cookbook has been deprecated and is no longer being maintained by its authors. Use of the openssl cookbook is no longer recommended.

RSS

openssl (32) Versions 6.1.0

Resources and libraries for interacting with certificates, keys, passwords, and dhparam files.

Policyfile
Berkshelf
Knife
cookbook 'openssl', '= 6.1.0', :supermarket
cookbook 'openssl', '= 6.1.0'
knife supermarket install openssl
knife supermarket download openssl
README
Dependencies
Changelog
Quality 100%

OpenSSL Cookbook

Build Status Cookbook Version

This cookbook provides tools for working with the Ruby OpenSSL library. It includes:

  • A library method to generate secure random passwords in recipes, using the Ruby SecureRandom library.
  • An LWRP for generating RSA private keys.
  • An LWRP for generating x509 certificates.
  • An LWRP for generating dhparam.pem files.
  • An attribute-driven recipe for upgrading OpenSSL packages.

Platforms

The random_password mixin works on any platform with the Ruby SecureRandom module. This module is already included with Chef.

The openssl_x509, openssl_rsa_key and openssl_dhparam LWRPs work on any platform with the OpenSSL Ruby bindings installed. These bindings are already included with Chef.

The upgrade recipe has been tested on the following platforms:

  • Debian / Ubuntu derivatives
  • RHEL and derivatives
  • Fedora
  • openSUSE / SUSE Linux Enterprises

Chef

  • Chef 12.1+

Cookbooks

  • none

Attributes

  • node['openssl']['restart_services'] - An array of service resources that depend on the openssl packages. This array is empty by default, as Chef has no reasonable way to detect which applications or services are compiled against these packages. Note Each service listed in this array should represent a "service" resource specified in the recipes of the node's run list.

Recipes

default

An empty placeholder recipe. Takes no action.

upgrade

The upgrade recipe iterates over the list of packages in the node['openssl']['packages'] attribute, and manages them with the :upgrade action. Each package will send a :restart notification to service resources named in the node['openssl']['restart_services'] attribute.

Example Usage

In this example, assume the node is running the stats_collector daemon, which depends on the openssl library. Imagine that a new openssl vulnerability has been disclosed, and the operating system vendor has released an update to openssl to address this vulnerability. In order to protect the node, an administrator crafts this recipe:

node.default['openssl']['restart_services'] = ['stats_collector']

# other recipe code here...
service 'stats_collector' do
  action [:enable, :start]
end

include_recipe 'openssl::upgrade'

When executed, this recipe will ensure that openssl is upgraded to the latest version, and that the stats_collector service is restarted to pick up the latest security fixes released in the openssl package.

Libraries & LWRPs

There are two mixins packaged with this cookbook.

random_password (OpenSSLCookbook::RandomPassword)

The RandomPassword mixin can be used to generate secure random passwords in Chef cookbooks, usually for assignment to a variable or an attribute. random_password uses Ruby's SecureRandom library and is customizable.

Example Usage

Chef::Recipe.send(:include, OpenSSLCookbook::RandomPassword)
node.normal['my_secure_attribute'] = random_password
node.normal_unless['my_secure_attribute'] = random_password
node.normal['my_secure_attribute'] = random_password(length: 50)
node.normal['my_secure_attribute'] = random_password(length: 50, mode: :base64)
node.normal['my_secure_attribute'] = random_password(length: 50, mode: :base64, encoding: 'ASCII')

Note that node attributes are widely accessible. Storing unencrypted passwords in node attributes, as in this example, carries risk.

secure_password (Opscode::OpenSSL::Password)

This library should be considered deprecated and will be removed in a future version. Please use OpenSSLCookbook::RandomPassword instead. The documentation is kept here for historical reasons.

Example Usage

::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
node.normal_unless['my_password'] = secure_password

Note that node attributes are widely accessible. Storing unencrypted passwords in node attributes, as in this example, carries risk.

openssl_x509

This LWRP generates self-signed, PEM-formatted x509 certificates. If no existing key is specified, the LWRP will automatically generate a passwordless key with the certificate.

Attributes

Name Type Description
common_name String (Required) Value for the CN certificate field.
org String (Required) Value for the O certificate field.
org_unit String (Required) Value for the OU certificate field.
country String (Required) Value for the C ssl field.
expire Fixnum (Optional) Value representing the number of days from now through which the issued certificate cert will remain valid. The certificate will expire after this period.
subject_alt_name Array (Optional) Array of Subject Alternative Name entries, in format DNS:example.com or IP:1.2.3.4 Default: empty
key_file String (Optional) The path to a certificate key file on the filesystem. If the key_file attribute is specified, the LWRP will attempt to source a key from this location. If no key file is found, the LWRP will generate a new key file at this location. If the key_file attribute is not specified, the LWRP will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate.
key_pass String (Optional) The passphrase for an existing key's passphrase
key_length Fixnum (Optional) The desired Bit Length of the generated key. Default: 2048
owner String (optional) The owner of all files created by the LWRP. Default: "root"
group String (optional) The group of all files created by the LWRP. Default: "root"
mode String or Fixnum (Optional) The permission mode of all files created by the LWRP. Default: "0400"

Example Usage

In this example, an administrator wishes to create a self-signed x509 certificate for use with a web server. In order to create the certificate, the administrator crafts this recipe:

openssl_x509 '/etc/httpd/ssl/mycert.pem' do
  common_name 'www.f00bar.com'
  org 'Foo Bar'
  org_unit 'Lab'
  country 'US'
end

When executed, this recipe will generate a key certificate at /etc/httpd/ssl/mycert.key. It will then use that key to generate a new certificate file at /etc/httpd/ssl/mycert.pem.

openssl_dhparam

This LWRP generates dhparam.pem files. If a valid dhparam.pem file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid dhparam file, it will be overwritten.

Attributes

Name Type Description
key_length Fixnum (Optional) The desired Bit Length of the generated key. Default: 2048
generator Fixnum (Optional) The desired Diffie-Hellmann generator. Can be 2 or 5.
owner String (optional) The owner of all files created by the LWRP. Default: "root"
group String (optional) The group of all files created by the LWRP. Default: "root"
mode String or Fixnum (Optional) The permission mode of all files created by the LWRP. Default: "0644"

Example Usage

In this example, an administrator wishes to create a dhparam.pem file for use with a web server. In order to create the .pem file, the administrator crafts this recipe:

openssl_dhparam '/etc/httpd/ssl/dhparam.pem' do
  key_length 2048
  generator 2
end

When executed, this recipe will generate a dhparam file at /etc/httpd/ssl/dhparam.pem.

openssl_rsa_key

This LWRP generates rsa key files. If a valid rsa key file can be opened at the specified location, no new file will be created. If the RSA key file cannot be opened, either because it does not exist or because the password to the RSA key file does not match the password in the recipe, it will be overwritten.

Attributes

Name Type Description
key_length Fixnum (Optional) The desired Bit Length of the generated key. Default: 2048
key_pass String (Optional) The desired passphrase for the key.
owner String (optional) The owner of all files created by the LWRP. Default: "root"
group String (optional) The group of all files created by the LWRP. Default: "root"
mode String or Fixnum (Optional) The permission mode of all files created by the LWRP. Default: "0644"

Example Usage

In this example, an administrator wishes to create a new RSA private key file in order to generate other certificates and public keys. In order to create the key file, the administrator crafts this recipe:

openssl_rsa_key '/etc/httpd/ssl/server.key' do
  key_length 2048
end

When executed, this recipe will generate a passwordless RSA key file at /etc/httpd/ssl/server.key.

License and Author

Author:: Jesse Nelson (spheromak@gmail.com)<br>
Author:: Seth Vargo (sethvargo@gmail.com)<br>
Author:: Charles Johnson (charles@chef.io)<br>
Author:: Joshua Timberman (joshua@chef.io)

Copyright:: 2009-2016, Chef Software, Inc <legal@chef.io>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

aegir Applicable Versions
apache2_odin_auth Applicable Versions
application_zf Applicable Versions
bacula Applicable Versions
bacula-backup Applicable Versions
bootstrap Applicable Versions
boxbilling Applicable Versions
cakephp Applicable Versions
chef Applicable Versions
chef-bareos Applicable Versions
chef-jellyfish Applicable Versions
chef-server Applicable Versions
confluence Applicable Versions
couchbase Applicable Versions
couchbase-ng Applicable Versions
crowd Applicable Versions
dokku Applicable Versions
drone_app Applicable Versions
drupal Applicable Versions
elefant Applicable Versions
elkstack Applicable Versions
esri-iis Applicable Versions
esri-tomcat Applicable Versions
et_haproxy Applicable Versions
frog Applicable Versions
gallery Applicable Versions
github-users Applicable Versions
gitlab-server Applicable Versions
ice Applicable Versions
jahia Applicable Versions
jenkinsstack Applicable Versions
jetty Applicable Versions
jira Applicable Versions
kagent Applicable Versions
katello Applicable Versions
liquid-feedback Applicable Versions
logserver Applicable Versions
magento Applicable Versions
magentostack Applicable Versions
mailman Applicable Versions
metarepo Applicable Versions
mysql Applicable Versions
mysql-multi Applicable Versions
mysqler Applicable Versions
nginx-hardening Applicable Versions
nodestack Applicable Versions
openbazaar Applicable Versions
openerp Applicable Versions
openldap Applicable Versions
opennebula Applicable Versions
opennms Applicable Versions
opsview Applicable Versions
owncloud Applicable Versions
paramount Applicable Versions
percona Applicable Versions
percona-tools Applicable Versions
phpstack Applicable Versions
postfixadmin Applicable Versions
postgresql Applicable Versions
postgresql91 Applicable Versions
pythonstack Applicable Versions
rainloop Applicable Versions
rancher-ha Applicable Versions
riot_mysql Applicable Versions
roundcube Applicable Versions
rundeck-node Applicable Versions
singularity Applicable Versions
sitecore Applicable Versions
sql_server Applicable Versions
sqlcipher Applicable Versions
stack_commons Applicable Versions
stackstorm Applicable Versions
strongloop Applicable Versions
sugar_crm Applicable Versions
sugarcrm Applicable Versions
sugarcrm_ce Applicable Versions
teampass Applicable Versions
testswarm Applicable Versions
tincvpn Applicable Versions
tomcat Applicable Versions
tomee Applicable Versions
transmission Applicable Versions
twindb-repo Applicable Versions
uptime Applicable Versions
webgoat Applicable Versions
wordpress Applicable Versions
wordpress-windows Applicable Versions
zabbix-pkg Applicable Versions
zarafa Applicable Versions
zenoss Applicable Versions
zf2 Applicable Versions
zncrypt Applicable Versions

openssl Cookbook CHANGELOG

This file is used to list changes made in each version of the openssl cookbook.

6.1.0 (2017-01-18)

  • [#37] Support for Subject Alternative Names on generated self-signed certificates
  • rubocop
  • Cookstyle fixes

6.0.0 (2016-09-08)

  • Update the minimum chef release to 12.1

5.0.1 (2016-09-01)

  • Update docs from node.normal as node.set has been deprecated
  • Testing updates

5.0.0 (2016-08-27)

  • Remove the need for the chef-sugar cookbook
  • Remove the default['openssl']['packages'] attribute in the upgrades recipe and instead use the correct openssl packages based on platform
  • Remove support for Debian 6 and Ubuntu 10.04 in the upgrade recipe
  • Add support for Fedora and Suse in the upgrade recipe
  • Prevent errors with unset variable in error raising within the random password helper
  • Add cookstyle and resolve all warnings
  • Add testing, contributing, and maintainers documentation
  • Add integration testing in Travis CI with kitchen-dokken
  • Add issues_url, source_url and chef_version metadata
  • Update the requirements section of the README
  • Update the Chefspecs to avoid errors and run using caching for faster runs
  • Add issues and PR templates for Github

v4.4.0 (2015-08-28)

  • NEW: x509 certificates are now signed via SHA-256 instead of SHA-1
  • FIX: gen_dhparam error now correctly fails with TypeError instead of ArgumentError if Generator argument isn't an integer

v4.3.2 (2015-08-01)

  • FIX: Updated changelog

v4.3 (2015-08-01)

  • NEW: Add rsa_key lwrp
  • FIX: dhparam lwrp now correctly honors the generator parameter

v4.2 (2015-06-23)

  • NEW: Add dhparam lwrp
  • FIX: x509 lwrp now updates resource count correctly

v4.1.2 (2015-06-20)

  • Add Serverspec suite
  • Removed update suite from .kitchen.yml
  • Add explicit license to test cookbook recipes
  • Add Whyrun support to x509 LWRP
  • Expand Chefspec tests for x509 LWRP to step_into LWRP
  • Add helper library
  • Update x509 LWRP to verify existing keys, if specified

v4.1.1 (2015-06-11)

  • README.md fixes

v4.1.0 (2015-06-11)

  • Add new random_password Mixin (Thanks, Seth!)
  • Rewritten README.md
  • Refactor specs
  • Clear Rubocop violations

v4.0.0 (2015-02-19)

  • Reverting to Opscode module namespace

v3.0.2 (2015-12-18)

  • Accidently released 2.0.2 as 3.0.2
  • Re-namespaced Opscode::OpenSSL::Password module as Chef::OpenSSL::Password

v2.0.2 (2014-12-30)

  • Call cert.to_pem before recipe DSL

v2.0.0 (2014-06-11)

  • 1 - COOK-847 - Add LWRP for generating self signed certs

  • 4 - COOK-4715 - add upgrade recipe and complete test harness

v1.1.0

Improvement

  • COOK-3222 - Allow setting length for secure_password

v1.0.2

  • Add name attribute to metadata

Collaborator Number Metric
            

6.1.0 passed this metric

Foodcritic Metric
            

6.1.0 passed this metric

License Metric
            

6.1.0 passed this metric