cookbook 'openssl', '= 4.2.0'
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.
openssl
(32) Versions
4.2.0
-
Follow138
Resources and libraries for interacting with certificates, keys, passwords, and dhparam files.
cookbook 'openssl', '= 4.2.0', :supermarket
knife supermarket install openssl
knife supermarket download openssl
OpenSSL Cookbook
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 x509 certificates.
- An LWRP for generating dhparam.pem files.
- An attribute-driven recipe for upgrading OpenSSL packages.
Requirements
The random_password mixin works on any platform with the Ruby SecureRandom module. This module are already included with Chef.
The openssl_x509 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:
- Ubuntu 12.04, 14.04
- Debian 7.4
- CentOS 6.5
The recipe may work on other platforms or different versions of the above platforms, but this has not been tested.
Dependencies
This cookbook depends on the Chef Sugar cookbook. Chef Sugar is used to make the default attribute settings easier to reason about. (See Attributes)
Attributes
-
node['openssl']['packages']- An array of packages required to use openssl. The default attributes attempt to be smart about which packages are the default, but this may need to be changed by users of theopenssl::upgraderecipe. -
node['openssl']['restart_services']- An array of service resources that depend on the packages listed in thenode['openssl']['packages']attribute. 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.set['my_secure_attribute'] = random_password node.set_unless['my_secure_attribute'] = random_password node.set['my_secure_attribute'] = random_password(length: 50) node.set['my_secure_attribute'] = random_password(length: 50, mode: :base64) node.set['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)
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.set_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. |
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 is the 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/mdhparam.pem.
License and Author
Author:: Jesse Nelson (spheromak@gmail.com)
Author:: Seth Vargo (sethvargo@gmail.com)
Author:: Charles Johnson (charles@chef.io)
Author:: Joshua Timberman (joshua@chef.io)
=======
Copyright:: 2009-2015, Chef Software, Inc <lega@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.
openssl Cookbook CHANGELOG
This file is used to list changes made in each version of the openssl cookbook.
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::Passwordmodule asChef::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
Foodcritic Metric
4.2.0 failed this metric
FC031: Cookbook without metadata file: /tmp/cook/0448ae4e31f5d9ada5da2d66/openssl/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/0448ae4e31f5d9ada5da2d66/openssl/metadata.rb:1
4.2.0 failed this metric
FC045: Consider setting cookbook name in metadata: /tmp/cook/0448ae4e31f5d9ada5da2d66/openssl/metadata.rb:1
