acme
Version information
This version is compatible with:
- Puppet Enterprise 4.x
- Puppet >= 4.0.0 < 5.0.0
- Ubuntu, Debian, RedHat, CentOS
This module has been deprecated by its author since Jul 11th 2023.
The reason given was: new maintainer
The author has suggested markt-acme as its replacement.
Start using this module
Documentation
Table of Contents
- Overview
- Requirements
- Module Description
- Setup
- Usage
- Examples
- Reference
- Limitations
- Development
- Fork
- License
Overview
Centralized SSL certificate management using Let's Encrypt™. Keep your private keys safe on the host they belong to and let your Puppet Server sign the CSRs and distribute the certificates.
Requirements
- Puppet 4.x with Exported Resources enabled
- puppetlabs/concat
- puppetlabs/stdlib
- puppetlabs/vcsrepo
- camptocamp/openssl
Furthermore you're advised to use hiera-eyaml to protect sensitive information (such as DNS API secrets).
Module Description
This module creates private keys and CSRs, transfers the CSR to your Puppet Server where it is signed using the popular and lightweight Neilpang/acme.sh.
Signed certificates are shipped back to the appropriate host.
You just need to specify the required challenge configuration on your Puppet Server. All DNS-01 hooks that are supported by acme.sh will work immediately.
Setup
Configure your Puppet Server
The whole idea is centralized certificate management, thus you have to add some configure on your Puppet Server.
First configure the Let's Encrypt accounts that are available to issue certificates:
Class { 'acme':
accounts => ['certmaster@example.com', 'ssl@example.com']
}
Next add configuration for the challenge types you want to use, we call each configuration a "profile":
Class { 'acme':
accounts => ['certmaster@example.com', 'ssl@example.com']
profiles => {
nsupdate_example => {
challengetype => 'dns-01',
hook => 'nsupdate',
env => {
NSUPDATE_SERVER => 'bind.example.com'
},
options => {
dnssleep => 15,
nsupdate_id => 'example-key',
nsupdate_type => 'hmac-md5',
nsupdate_key => 'abcdefg1234567890',
}
}
route53_example => {
challengetype => 'dns-01',
hook => 'aws',
env => {
AWS_ACCESS_KEY_ID => 'foobar',
AWS_SECRET_ACCESS_KEY => 'secret',
},
options => {
dnssleep => 15,
}
}
}
}
In this example we create two "profiles": One is utilizing the "nsupdate" hook to communicate with a BIND DNS server and the other one uses the "aws" hook to communicate with Amazon Route53.
Note that the hook
parameter must exactly match the name of the hook that is used by Neilpang/acme.sh.
Some DNS hooks require special environment variables, simply add them to the
env
parameter.
All CSRs are collected and signed on your Puppet Server, and the resulting certificates and CA chain files are shipped back to your nodes.
Usage
Request a certificate
On the Puppet node where you need the certificate(s):
class { 'acme':
certificates => {
# issue a test certificate
test.example.com => {
use_profile => 'route53_example',
use_account => 'ssl@example.com',
letsencrypt_ca => 'staging',
}
# a cert for the current FQDN is nice too
${::fqdn} => {
use_profile => 'nsupdate_example',
use_account => 'certmaster@example.com',
letsencrypt_ca => 'production',
},
}
}
Note: The use_profile
and use_account
parameters must match the profiles
and accounts that you've previously configured on your Puppet Server. Otherwise
the module will refuse to issue the certificate.
The private key and CSR will be generated on your node and the CSR is shipped to your Puppet Server for signing. The certificate is put on your node after some time.
Instead of specifying the domains as parameter to the acme
class, it is
possible to call the acme::certificate
define directly:
::acme::certificate { 'test.example.com':
use_profile => 'route53_example',
use_account => 'ssl@example.com',
letsencrypt_ca => 'staging',
}
SAN certificates
Requesting SAN certificates is easy too. To do so pass a space seperated list
of domain names in the certificates
hash.
The first domain name in each list is used as the base domain for the request.
For example:
class { 'acme':
certificates => {
'test.example.com foo.example.com bar.example.com' => {
use_profile => 'route53_example',
use_account => 'ssl@example.com',
letsencrypt_ca => 'staging',
}
}
Or use the define directly:
::acme::certificate { 'test.example.com foo.example.com bar.example.com':
use_profile => 'route53_example',
use_account => 'ssl@example.com',
letsencrypt_ca => 'staging',
}
In both examples "test.example.com" will be used as base domain for the CSR.
Testing and Debugging
For testing purposes you should use the Let's Encrypt staging CA, otherwise
you'll hit rate limits pretty soon. It's possible to set the default CA on
your Puppet Server by using the letsencrypt_ca
parameter:
class { 'acme' :
letsencrypt_ca => 'staging'
}
Or you can use this parameter directly when configuring certificates on your Puppet nodes, as shown by the previous examples.
Examples
Apache
Using acme
in combination with puppetlabs-apache:
# request a certificate from acme
::acme::certificate { $::fqdn:
use_profile => 'nsupdate_example',
use_account => 'certmaster@example.com',
letsencrypt_ca => 'production',
# restart apache when the certificate is signed (or renewed)
notify => Class['::apache::service'],
}
# get configuration from acme::params
include ::acme::params
$base_dir = $::acme::params::base_dir
$crt_dir = $::acme::params::crt_dir
$key_dir = $::acme::params::key_dir
# where acme stores our certificate and key files
$my_key = "${key_dir}/${::fqdn}/private.key"
$my_cert = "${crt_dir}/${::fqdn}/cert.pem"
$my_chain = "${crt_dir}/${::fqdn}/chain.pem"
# configure apache
include apache
apache::vhost { $::fqdn:
port => '443',
docroot => '/var/www/example',
ssl => true,
ssl_cert => "/etc/ssl/${::fqdn}.crt",
ssl_ca => "/etc/ssl/${::fqdn}.ca",
ssl_key => "/etc/ssl/${::fqdn}.key",
}
# copy certificate files
file { "/etc/ssl/${::fqdn}.crt":
ensure => file,
owner => 'root',
group => 'root',
mode => '0644',
source => $my_cert,
subscribe => Acme::Certificate[$::fqdn],
notify => Class['::apache::service'],
}
file { "/etc/ssl/${::fqdn}.key":
ensure => file,
owner => 'root',
group => 'root',
mode => '0640',
source => $my_key,
subscribe => Acme::Certificate[$::fqdn],
notify => Class['::apache::service'],
}
file { "/etc/ssl/${::fqdn}.ca":
ensure => file,
owner => 'root',
group => 'root',
mode => '0644',
source => $my_chain,
subscribe => Acme::Certificate[$::fqdn],
notify => Class['::apache::service'],
}
Reference
Files and directories
Locations of the important certificate files (i.e. "cert.example.com"):
/etc/acme.sh/certs/cert.example.com/cert.pem
: the certificate/etc/acme.sh/certs/cert.example.com/chain.pem
: the CA chain/etc/acme.sh/certs/cert.example.com/fullchain.pem
: Certificate and CA chain in one file/etc/acme.sh/certs/cert.example.com/cert.ocsp
: OCSP Must-Staple extension data/etc/acme.sh/keys/cert.example.com/private.key
: Private key/etc/acme.sh/keys/cert.example.com/fullchain_with_key.pem
: All-in-one: certificate, CA chain, private key
Basic directory layout:
/etc/acme.sh/accounts
: (Puppet Server) Private keys and other files related to Let's Encrypt accounts/etc/acme.sh/certs
: Certificates, CA chains and OCSP files/etc/acme.sh/configs
: OpenSSL configuration and other files required for the CSR/etc/acme.sh/csrs
: Certificate signing requests (CSR)/etc/acme.sh/home
: (Puppet Server) Working directory for acme.sh/etc/acme.sh/keys
: Private keys for each certificate/opt/acme.sh
: (Puppet Server) Local copy of acme.sh (GIT repository)/var/log/acme.sh/acme.log
: (Puppet Server) acme.sh log file
Classes and parameters
Classes:
acme
acme::params
acme::request::handler
Defines:
acme::csr
acme::deploy
acme::deploy::crt
acme::request
acme::request::crt
Parameters:
acme_git_url
: URL to the acme.sh GIT repository (feel free to use a local mirror)acme_host
: Defaults to your Puppet Server; override for testing purposesdh_param_size
: DH parameter size, defaults to 2048letsencrypt_ca
: The Let's Encrypt CA that should be used, choose eitherstaging
orproduction
letsencrypt_proxy
: A proxy server that should be used when connecting to the Let's Encrypt CAmanage_packages
: Set tofalse
to disable package management. Defaults totrue
Facts:
acme_csrs
acme_csr_*
acme_crts
Limitations
Requires multiple Puppet runs
It takes several puppet runs to issue a certificate. Two Puppet runs are required to prepare the CSR on your Puppet node. Two more Puppet runs on your Puppet Server are required to sign the certificate. Now it's ready to be collected by your Puppet node.
The process is seamless for certificate renewals, but it takes a little time to issue a new certificate.
HTTP-01 challenge type untested
The HTTP-01 challenge type is supported, but it's untested with this module. Some additional parameters may be missing. Feel free to report issues or suggest enhancements.
OS Compatibility
This module was tested on CentOS/RedHat and Ubuntu/Debian. Please open a new issue if your operating system is not supported yet, and provide information about problems or missing features.
Development
Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.
Fork
This module is a fork of the excellent bzed/bzed-letsencrypt. The fork was necessary in order to support acme.sh instead of dehydrated.
License
Based on bzed/bzed-letsencrypt, Copyright 2017 Bernd Zeimetz.
Let's Encrypt is a trademark of the Internet Security Research Group. All rights reserved.
See the LICENSE
file for further information.
Dependencies
- puppetlabs-stdlib (>= 2.2.0)
- puppetlabs-concat (>= 2.1.0)
- puppetlabs-vcsrepo (>= 1.3.2)
- camptocamp-openssl (>= 1.5.1)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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.