cookbooks/openssl/README.md in from-scratch-0.1.1 vs cookbooks/openssl/README.md in from-scratch-0.2.0

- old
+ new

@@ -1,106 +1,200 @@ -openssl Cookbook +OpenSSL Cookbook ================ +[![Build Status](https://travis-ci.org/opscode-cookbooks/openssl.svg?branch=master)](https://travis-ci.org/opscode-cookbooks/openssl) -This cookbook provides a library method to generate secure random passwords in recipes using the Ruby OpenSSL library. +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. -It also provides an attribute-driven recipe for upgrading OpenSSL packages. - Requirements ------------ -The `secure_password` works on any platform with OpenSSL Ruby bindings installed, which are a requirement for Chef anyway. +The `random_password` mixin works on any platform with the Ruby SecureRandom module. This module is already included with Chef. -The upgrade recipe works on the following tested platforms: +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: + * Ubuntu 12.04, 14.04 * Debian 7.4 * CentOS 6.5 -It may work on other platforms or versions of the above platforms with or without modification. +The recipe may work on other platforms or different versions of the above platforms, but this has not been tested. -[Chef Sugar](https://github.com/sethvargo/chef-sugar) was introduced as a dependency to provide helpers that make the default attribute settings (see Attributes) easier to reason about. +Dependencies +------------ +This cookbook depends on the [Chef Sugar](http://supermarket.chef.io/cookbooks/chef-sugar/) cookbook. [Chef Sugar](http://supermarket.chef.io/cookbooks/chef-sugar/) is used to make the default attribute settings easier to reason about. (See [Attributes](#attributes)) + Attributes ---------- -* `node['openssl']['packages']` - An array of packages of openssl. The default attributes attempt to be smart about which packages are the default, but this may need to be changed by users of the `openssl::upgrade` recipe. -* `node['openssl']['restart_services']` - An array of service resources that use the `node['openssl']['packages']`. This is empty by default as Chef has no reliably reasonable way to detect which applications or services are compiled against these packages. *Note* These each need to be "`service`" resources specified somewhere in the recipes in the node's run list. +* `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 the `openssl::upgrade` recipe. +* `node['openssl']['restart_services']` - An array of service resources that depend on the packages listed in the `node['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 `:restart` notification to service resources named by the `node['openssl']['restart_services']` attribute. +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. -Usage ------ +#### Example Usage -Most often this will be used to generate a secure password for an attribute. In a recipe: +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: ```ruby -::Chef::Recipe.send(:include, Chef::OpenSSL::Password) -node.set_unless[:my_password] = secure_password +node.default['openssl']['restart_services'] = ['stats_collector'] + +# other recipe code here... +service 'stats_collector' do + action [:enable, :start] +end + +include_recipe 'openssl::upgrade' ``` -To use the `openssl::upgrade` recipe, set the attributes as mentioned above. For example, we have a "stats_collector" service that uses openssl. It has a recipe that looks like this: +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. -LWRP -==== +Libraries & LWRPs +----------------- -This cookbook includes an LWRP for generating Self Signed Certificates +There are two mixins packaged with this cookbook. -## openssl_x509 -generate a pem formatted x509 cert + key +### random_password (`OpenSSLCookbook::RandomPassword`) -### Attributes -`common_name` A String representing the `CN` ssl field -`org` A String representing the `O` ssl field -`org_unit` A String representing the `OU` ssl field -`country` A String representing the `C` ssl field -`expire` A Fixnum reprenting the number of days from _now_ to expire the cert -`key_file` Optional A string to the key file to use. If no key is present it will generate and store one. -`key_pass` A String that is the key's passphrase -`key_length` A Fixnum reprenting your desired Bit Length _Default: 2048_ -`owner` The owner of the files _Default: "root"_ -`group` The group of the files _Default: "root"_ -`mode` The mode to store the files in _Default: "0400"_ +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 +#### Example Usage +```ruby +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') +``` - openssl_x509 "/tmp/mycert.pem" do - common_name "www.f00bar.com" - org "Foo Bar" - org_unit "Lab" - country "US" - end +Note that node attributes are widely accessible. Storing unencrypted passwords in node attributes, as in this example, carries risk. - -License and Author -================== +### ~~secure_password (`Opscode::OpenSSL::Password`)~~ -Author:: Jesse Nelson (<spheromak@gmail.com>) -Author:: Joshua Timberman (<joshua@chef.io>) -======= +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~~ +```ruby +::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 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: + ```ruby -node.default['openssl']['restart_services'] = ['stats_collector'] +openssl_x509 '/etc/httpd/ssl/mycert.pem' do + common_name 'www.f00bar.com' + org 'Foo Bar' + org_unit 'Lab' + country 'US' +end +``` -# other recipe code here... -service 'stats_collector' do - action [:enable, :start] +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: + +```ruby +openssl_dhparam '/etc/httpd/ssl/dhparam.pem' do + key_length 2048 + generator 2 end +``` -include_recipe 'openssl::upgrade' +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: + +```ruby +openssl_rsa_key '/etc/httpd/ssl/server.key' do + key_length 2048 +end ``` -This will ensure that openssl is upgraded to the latest version so the `stats_collector` service won't be exploited (hopefully!). +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>) +Author:: Seth Vargo (<sethvargo@gmail.com>) +Author:: Charles Johnson (<charles@chef.io>) +Author:: Joshua Timberman (<joshua@chef.io>) + +======= + ```text -Copyright:: 2009-2011, Chef Software, Inc -Copyright:: 2014, Chef Software, Inc <legal@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