Version information
This version is compatible with:
- Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- RedHat, Windows, Debian, Ubuntu, OS X, Solaris, SLES, AIX
Start using this module
Add this module to your Puppetfile:
mod 'puppet-puppet_certificate', '1.1.0'Learn more about managing modules with a PuppetfileDocumentation
Puppet Certificate
Summary
Manage Puppet certificates as resources using the puppet_certificate type.
Usage
Example:
puppet_certificate { 'puppetmaster07.example.com':
ensure => present,
dns_alt_names => [
'puppet',
'puppet.example.com',
],
}
puppet_certificate { 'oldcert.example.com':
ensure => absent,
}
Advanced features
Refresh
When refreshed (notify, subscribe) a puppet_certificate resource will destroy and re-create the managed certificate. This enables changes to related resources to trigger a certificate to be regenerated.
To enable this functionality, you must set the onrefresh parameter to
regenerate. Otherwise, the resource will not respond to refresh events.
Note that for this to work as expected, it will need to be combined with automatic certificate cleaning (described in a following section).
file { '/etc/puppetlabs/puppet/csr_attributes.yaml':
ensure => file,
owner => 'root',
group => 'root',
mode => '0440',
content => epp('example/csr_attributes.yaml.epp'),
}
~> puppet_certificate { $certname:
ensure => present,
waitforcert => 60,
onrefresh => regenerate,
}
Ensure valid
Besides ensure=present, a puppet_certificate may be set to ensure=valid.
When configured this way, if the Puppet certificate has expired, it will be
destroyed and a new certificate created. Note that this does not automatically
handle signing of the new certificate, or cleanup of the old (expired)
certificate.
The renewal_grace_period parameter may be combined with ensure=valid to
perform certificate regeneration a configurable number of days before a
certificate is due to expire.
puppet_certificate { $certname:
ensure => valid,
renewal_grace_period => 20,
}
Automatic certificate cleaning
The clean parameter tells a puppet_certificate to try and clean a
certificate from the CA upon destroying it.
This is useful to keep the CA clean, and as a prerequisite action for generating a new certificate of the same name. To use this option effectively, it is required that a rule be added to auth.conf on the CA to allow this. For example, to allow nodes to revoke and clean their own certificates.
Example auth.conf rule:
{
name: "Allow nodes to delete their own certificates",
match-request: {
path: "^/puppet-ca/v1/certificate(_status|_request)?/([^/]+)$",
type: regex,
method: [delete]
},
allow: "$2",
sort-order: 500
}
Puppet Enterprise already has a rule for this API. You cannot have multiple
blocks in auth.conf for the same path. Therefore you need to patch
/opt/puppetlabs/puppet/modules/puppet_enterprise/manifests/profile/certificate_authority.pp
# git diff --no-index /tmp/certificate_authority.pp
/opt/puppetlabs/puppet/modules/puppet_enterprise/manifests/profile/certificate_authority.pp
diff --git a/tmp/certificate_authority.pp
b/opt/puppetlabs/puppet/modules/puppet_enterprise/manifests/profile/certificate_authority.pp
index ba4de6b..4c71dd5 100644
--- a/tmp/certificate_authority.pp
+++ b/opt/puppetlabs/puppet/modules/puppet_enterprise/manifests/profile/certificate_authority.pp
@@ -99,10 +99,10 @@ class puppet_enterprise::profile::certificate_authority (
pe_puppet_authorization::rule { 'puppetlabs certificate status':
ensure => present,
- match_request_path => '/puppet-ca/v1/certificate_status/',
- match_request_type => 'path',
+ match_request_path => '^/puppet-ca/v1/certificate_status/([^/]+)?$',
+ match_request_type => 'regex',
match_request_method => ['get','put','delete'],
- allow => $_client_allowlist << $ca_cli_extension,
+ allow => ['$1', $_client_allowlist].flatten << $ca_cli_extension,
sort_order => 500,
path => '/etc/puppetlabs/puppetserver/conf.d/auth.conf',
notify => Service['pe-puppetserver'],
puppet_certificate { $certname:
ensure => valid,
waitforcert => 60,
renewal_grace_period => 20,
clean => true,
}
Reference
Contributors
- Reid Vandewiele
- Branan Riley
- Raphaël Pinson
Transfer Notice
This module was originally authored by Reid Vandewiele. The maintainer preferred that Vox Pupuli take ownership of the module for future improvement and maintenance.
Existing pull requests and issues were transferred over. Please fork and continue to contribute here instead of the module's original home.
Reference
Table of Contents
Resource types
puppet_certificate: Manage Puppet certificates
Resource types
puppet_certificate
Manage Puppet certificates
Properties
The following properties are available in the puppet_certificate type.
dns_alt_names
Alternate DNS names by which the certificate holder may be reached
ensure
Valid values: present, absent, valid
Create or remove the Puppet certificate
Default value: present
Parameters
The following parameters are available in the puppet_certificate type.
ca_location
Valid values: local, remote
The location of the certificate authority (local or remote)
Default value: remote
ca_server
The certificate authority to use
clean
Valid values: true, false
Delete the certificate from the CA before removing it locally.
Default value: false
name
namevar
The certificate name
onrefresh
Valid values: regenerate, nothing
If set to 'regenerate', a refresh event will cause the certificate to be destroyed and recreated.
Default value: nothing
provider
The specific backend to use for this puppet_certificate resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.
renewal_grace_period
The number of days before expiration the certificate should be renewed
Default value: 0
waitforcert
The amount of time to wait for the certificate to be signed
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v1.1.0 (2024-02-01)
Implemented enhancements:
- README.md: Update code example #23 (bastelfreak)
- Document PE workaround for auth.conf #19 (bastelfreak)
- Add Puppet 8 support #17 (bastelfreak)
v1.0.0 (2023-05-24)
Release 1.0.0 is the first release of the puppet_certificate module in the Vox Pupuli namespace.
It is the first version, (under any puppetforge namespace), to support Puppet 6 and 7, (and likely also works with the upcoming Puppet 8). It is also tested with some very old Puppet versions (eg. 3.x on Ruby 2.0). There is a lot of code in the provider to make this possible and a future major release will likely drop this code.
Closed issues:
- Certificate cleaning fails if CA is missing the certificate #13
- Compatibility with Puppet 7 #10
- Puppet::SSL::Host is deprecated #9
- Uninitialized constant Puppet::Rest #8
Merged pull requests:
- Ignore
certificate unknownerror when cleaning cert #14 (alexjfisher) - Vox Pupuli migration #12 (alexjfisher)
- Big refactor and make it work with Puppet 6 and 7 #11 (alexjfisher)
- Add support for Puppet 6 #7 (m4rx0)
- Add clean parameter #5 (raphink)
- Ensure valid #4 (raphink)
- Add refresh #3 (raphink)
0.1.0 (2019-11-25)
0.0.3 (2015-03-31)
0.0.2 (2013-03-26)
Merged pull requests:
* This Changelog was automatically generated by github_changelog_generator
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.