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

RSS

tls (13) Versions 4.0.1

Deploy TLS certificates

Berkshelf
Policyfile
Knife
cookbook 'tls', '~> 4.0.1'
cookbook 'tls', '~> 4.0.1', :supermarket
knife supermarket install tls
knife supermarket download tls
README
Dependencies
Changelog
Quality 75%

tls-cookbook

Chef cookbook license
Chef cookbook to deploy TLS certificates (including root ones) on a system. Certificate files are placed under a directory specified in attribute node['tls']['base_dir'] (by default /etc/chef-tls). Root certificate files are placed under system directories.

Certificate & private key data is stored either in an encrypted data bag or in HashiCorp's Vault.

Encrypted data bag format

Data is stored in the encrypted data bag which name is specified in the attribute node['tls']['data_bag_name'] (by default tls). Data bag item name matches node.chef_environment value.

{
  "id": "development",
  "ca_certificates": {
    // Trusted Root CA
    // "name": "----- certificate data -----"
    "Custom_CA": "-----BEGIN CERTIFICATE-----\nMIIF0jCC........UwhJJgNX\n-----END CERTIFICATE-----",
    // other entries
  },
  "certificates": [
    {
      "name": "domain.tld-rsa", // Certificate name (optional)
      "domains": [ // Domain list
        "domain.tld",
        "www.domain.tld"
      ],
      "chain": [ // Certificate chain (from leaf to root, PEM encoded, new lines should be escaped)
        "-----BEGIN CERTIFICATE-----\nMIIFNjCC........4PcGNXXA\n-----END CERTIFICATE-----",
        "-----BEGIN CERTIFICATE-----\nMIIEkjCC........NFu0Qg==\n-----END CERTIFICATE-----"
      ],
      "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIB........8tt8JA==\n-----END RSA PRIVATE KEY-----" // Certificate private key (PEM encoded, new lines should be escaped)
    },
    {
      // other entries
    }
  ]
}

Vault format

Each certificate entry is supposed to be placed at path <prefix>/certificate>/<entry_name> and will be obtained by vlt client. A Chef node must claim a role with read and list permissions for <prefix>/data/certificate/* and <prefix>/metadata/certificate accordingly. The format is the following:

{
  "domains": [ // Domain list
    "domain.tld",
    "www.domain.tld"
  ],
  "chain": [ // Certificate chain (from leaf to root, PEM encoded, new lines should be escaped)
    "-----BEGIN CERTIFICATE-----\nMIIFNjCC........4PcGNXXA\n-----END CERTIFICATE-----",
    "-----BEGIN CERTIFICATE-----\nMIIEkjCC........NFu0Qg==\n-----END CERTIFICATE-----"
  ],
  "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIB........8tt8JA==\n-----END RSA PRIVATE KEY-----" // Certificate private key (PEM encoded, new lines should be escaped)
}

Each CA certificate entry is supposed to be placed at path <prefix>/ca_certificate>/<ca_entry_name> and will be obtained by vlt client. A Chef node must claim a role with read permissions for <prefix>/data/ca_certificate/*. The format is the following:

{
  "data": "-----BEGIN CERTIFICATE-----\nMIIF0jCC........UwhJJgNX\n-----END CERTIFICATE-----"
}

Resources

tls_certificate

Certificate deployment is made by using tls_certificate resource. For example,

tls_vlt = ::Vlt::Client.new(::Vlt.file_auth_provider, 'tls')
tls_vlt_provider = lambda { tls_vlt }

tls_certificate 'www.domain.tld' do
  vlt_provider tls_vlt_provider  # required only when Vault is used
  action :deploy
end

Different software (e.g. Nginx, Postfix) will require paths to deployed certificates and private keys. To obtain these paths, ::ChefCookbook::TLS helper should be used. Below is the example:

tls_item = ::ChefCookbook::TLS.new(node).certificate_entry('www.domain.tld', vlt_provider: tls_vlt_provider)  # vlt_provider is required only when Vault is used

tls_item.certificate_path  # Get path to the certificate
tls_item.certificate_checksum  # Get certificate's CRC32
tls_item.certificate_private_key_path  # Get path to the certificate's private key
tls_item.certificate_private_key_checksum  # Get private key's CRC32

If there are several certificates for the same set of domains (e.g. RSA and ECDSA ones), both tls_certificate resource and certificate_entry helper method will operate with the first item found in the data bag. To pick out the exact certificate, you should use either tls_rsa_certificate resource / rsa_certificate_entry helper method or tls_ec_certificate resource / ec_certificate_entry helper method.

tls_rsa_certificate

tls_rsa_certificate 'www.domain.tld' do
  action :deploy
end

tls_item = ::ChefCookbook::TLS.new(node).rsa_certificate_entry('www.domain.tld')

tls_ec_certificate

tls = ::ChefCookbook::TLS.new(node)

if tls.has_ec_certificate?('www.domain.tld')
  tls_ec_certificate 'www.domain.tld' do
    action :deploy
  end

  tls_item = tls.ec_certificate_entry('www.domain.tld')
end

tls_ca_certificate

Installing/uninstalling CA certificates only works on Ubuntu systems. To obtain path to CA certificate bundle, ::ChefCookbook::TLS helper should be used. Below is the example:

tls_helper = ::ChefCookbook::TLS.new(node)

tls_helper.ca_bundle_path  # Get CA certificate bundle path

Installing

tls_ca_certificate 'Custom_CA' do
  action :install
end

Uninstalling

tls_ca_certificate 'Custom_CA' do
  action :uninstall
end

License

MIT @ Alexander Pyatkin

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[4.0.1] - 2020-09-28

Fixed

  • Fix Chef 16 support (provides for resources).
  • Fix FC108 warning.

[4.0.0] - 2020-09-28

Added

  • Add CHANGELOG and CONTRIBUTING files.
  • Add HashiCorp's Vault support.

Changed

  • Update README.
  • Include chef_version and supports to cookbook metadata.

Collaborator Number Metric
            

4.0.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

4.0.1 passed this metric

Foodcritic Metric
            

4.0.1 passed this metric

No Binaries Metric
            

4.0.1 passed this metric

Publish Metric
            

4.0.1 passed this metric

Supported Platforms Metric
            

4.0.1 passed this metric

Testing File Metric
            

4.0.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

4.0.1 passed this metric