Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 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
- , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-fetchcrl', '7.0.0'Learn more about managing modules with a PuppetfileDocumentation
FetchCRL module for Puppet
This is the fetchcrl Puppet module. It configures fetch-crl version 3 wherever it can.
Fetchcrl utility will retrieve certificate revocation lists (CRLs) for a set of installed trust anchors, based on crl_url files or IGTF-style info files.
This module obsoletes CernOps-fetchcrl-1.1.0
Examples
class { 'fetchcrl':
http_proxy => 'http:://squid.example.org:8000',
carepo => 'http://yum.example.org/yumrepo',
cache_control_request => '3600',
}
fetchcrl::ca { 'EDG-Tutorial-CA':
agingtolerance => 168,
comment => 'Increased as unreliable',
}
Facts
Two custom facts are included.
-
certissuer returns the issuer of a grid certificate located at /etc/grid-security/hostcert.pem if it exists.
-
trustedca returns an array of all the certificate authoriry subjects located at /etc/grid-security/*.pem
Refernce
See REFERENCE.md for more details
License
Apache-2.0
Copyright
Steve Traylen, steve.traylen@cern.ch, CERN, 2016.
Contact
Steve Traylen steve.traylen@cern.ch
Support
Please log tickets and issues at http://github.com/voxpupuli/puppet-fetchcrl
Reference
Table of Contents
Classes
Public Classes
fetchcrl: Main class, installs fetch-crl and configures it.
Private Classes
fetchcrl::config: Configures fetch-crlfetchcrl::install: Installs fetch-crlfetchcrl::service: Controls fetch-crl cron or timer.
Defined types
fetchcrl::ca: Creates per CA configuration files.
Classes
fetchcrl
fetchcrl
- See also
- https://wiki.nikhef.nl/grid/FetchCRL3
- FetchCRL3
- https://wiki.nikhef.nl/grid/FetchCRL3
Examples
Simple Example
class{'fetchcrl':
http_proxy => 'http:://squid.example.org:8000',
carepo => 'http://yum.example.org/yumrepo',
cache_control_request => '3600',
}
A hash of particular CA configurations
class{'fetchcrl':
cas => {
'EDG-Tutorial-CA' => {
'agingtolerance' => 168,
}
'MD-Grid-CA-T' => {
'noerrors' => true,
}
}
}
}
Parameters
The following parameters are available in the fetchcrl class:
capkgscarepocarepo_gpgkeymanage_carepocapkgs_versionpkg_versionagingtolerancenosymlinksinet6gluenoerrorsnowarningshttp_proxyhttptimeoutparallelismlogmodepkgnameruncronrunbootrandomcroncache_control_requestcas
capkgs
Data type: Array[String[1]]
CA policy packages to install.
Default value: ['ca-policy-egi-core']
carepo
Data type: Stdlib::Httpurl
Repository URL of CA packages.
Default value: 'https://repository.egi.eu/sw/production/cas/1/current/'
carepo_gpgkey
Data type: Stdlib::Httpurl
Repository URL of GPG key for CA packages.
Default value: 'https://dist.eugridpma.info/distribution/igtf/current/GPG-KEY-EUGridPMA-RPM-3'
manage_carepo
Data type: Boolean
Should package repository be configured.
Default value: true
capkgs_version
Data type: String
Version of CA packages.
Default value: 'present'
pkg_version
Data type: String
Version of fetch-crl package.
Default value: 'present'
agingtolerance
Data type: Integer
Number of hours delay time before errors are generated in case downloads consistently fail.
Default value: 24
nosymlinks
Data type: Boolean
Do not create serial number symlinks.
Default value: true
inet6glue
Data type: Boolean
use Net::INET6Glue , parameter is ignored on RedHat 9 or Debian 12 and newer.
Default value: false
noerrors
Data type: Boolean
Do not produce errors.
Default value: false
nowarnings
Data type: Boolean
Do not produce warnings.
Default value: true
http_proxy
Data type: Optional[Stdlib::Httpurl]
http proxy URLs. For example http://foobar.example.org:3218/
Default value: undef
httptimeout
Data type: Integer
Time out for http.
Default value: 30
parallelism
Data type: Integer
Number of fetchs to run concurrently.
Default value: 4
logmode
Data type: Enum['direct','qualified', 'cache','syslog']
Specify how logging is done.
Default value: 'syslog'
pkgname
Data type: String[1]
Name of fetch-crl package.
Default value: 'fetch-crl'
runcron
Data type: Boolean
Should fetch-crl be run periodically either as a cron job or timer as appropriate.
Default value: true
runboot
Data type: Boolean
Should fetch-crl be run at boot time. This parameter is only significant for fetch-crl packages that use a cron based package and not a systemd timer.
Default value: false
randomcron
Data type: Boolean
Should the every 6 hour cron be configured with a random offset. With osfamily RedHat 8 or newer the randomcron parameter is ignored. The systemd timer for fetch-crl is already very random.
Default value: true
cache_control_request
Data type: Optional[Integer]
Sends a cache-control max-age hint in seconds towards the server in the HTTP request.
Default value: undef
cas
Data type: Optional[Hash]
A hash of fetchcrl::ca defined types to load.
Default value: undef
Defined types
fetchcrl::ca
Creates per CA configuration files.
Examples
Simple Example
fetchcrl::ca{'EDG-Tutorial-CA':
agingtolerance => 168,
comment => 'Increased as unreliable',
}
Parameters
The following parameters are available in the fetchcrl::ca defined type:
name
The name of the CA to manage a configuration for.
anchorname
Data type: String[1]
The name of the CA to manage a configuration for.
Default value: $title
nowarnings
Data type: Boolean
Should warnings be supressed for this CA.
Default value: false
noerrors
Data type: Boolean
Should errors be supressed for this CA.
Default value: false
httptimeout
Data type: Optional[Integer]
The timeout for this CA.
Default value: undef
agingtolerance
Data type: Optional[Integer]
The delay if failures before it is considered an error.
Default value: undef
comment
Data type: Optional[String[1]]
Add a comment to the particular CA configuration
Default value: undef
crl_url
Data type: Array[Stdlib::Httpurl]
A list of URLs to download CAs from
Default value: []
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.
v7.0.0 (2024-02-26)
Breaking changes:
Implemented enhancements:
- Add support for Debian 12 #106 (traylenator)
- Parameter hardening for private classes #105 (zilchms)
- puppetlabs/apt: Allow 9.x #102 (zilchms)
Merged pull requests:
- Fix missing docs and simplify period_method check #109 (zilchms)
- Update Readme: fix broken links, improve formating #108 (rwaffen)
- Improve English of README #99 (traylenator)
v6.0.0 (2023-08-16)
Breaking changes:
- Drop Puppet 6 support #91 (bastelfreak)
Implemented enhancements:
- Add AlmaLinux/Rocky/OracleLinux support #96 (traylenator)
- Add Puppet 8 support #94 (bastelfreak)
- puppetlabs/stdlib: Allow 9.x #93 (bastelfreak)
- Support RHEL9, Debian11 and Ubuntu 22.04 #87 (traylenator)
- New comment parameter to fetch-crl::ca type #86 (traylenator)
- rubocop corrections for rubocop 1.22.3 #83 (traylenator)
Merged pull requests:
- RSpec/EmptyExampleGroup is no longer failing #85 (traylenator)
v5.1.0 (2021-09-27)
Implemented enhancements:
- Support hash of fetchcrl::ca as parameter #79 (traylenator)
Merged pull requests:
v5.0.0 (2021-03-23)
Breaking changes:
- Drop Puppet 5 and CentOS 6 Support #71 (traylenator)
Implemented enhancements:
- Support Puppet 7 #75 (traylenator)
- Add Ubuntu 18.04, 20.04 and Debian 10 support #74 (traylenator)
- New carepo_gpgkey parameter #73 (traylenator)
- Switch from http to https for yum repository #72 (traylenator)
- Add inet6glue flag configuration #70 (luisfdez)
Merged pull requests:
- Documentation Corrections #76 (traylenator)
v4.1.0 (2020-09-14)
Implemented enhancements:
- Enable acceptance tests for CentOS 8 #63 (traylenator)
- Allow puppetlabs/stdlib 6.x #62 (dhoppe)
Merged pull requests:
- modulesync 3.0.0 & puppet-lint updates #66 (bastelfreak)
- Use voxpupuli-acceptance #65 (ekohl)
v4.0.0 (2019-12-05)
Breaking changes:
- modulesync 2.7.0 and drop puppet 4 #52 (bastelfreak)
Implemented enhancements:
- Fact trustedcas to skip over invalid .pem files #54 (traylenator)
Fixed bugs:
- Correction of typo #55 (traylenator)
Closed issues:
- new installs only : puppet error on trustedca fact #51
Merged pull requests:
- Give examples headings #59 (traylenator)
- Remove fictitious runatboot from docs #57 (traylenator)
- Addition of RedHat 8 support #56 (traylenator)
v3.0.0 (2018-12-15)
Breaking changes:
- General code modernisation - assorted bugfixes. #46 (traylenator)
Implemented enhancements:
- New randomcron parameter, random offset of cron #47 (traylenator)
Closed issues:
- noerrors is not included in template #43
v2.1.1 (2018-10-14)
Merged pull requests:
- modulesync 2.1.0 and allow puppet 6.x #41 (bastelfreak)
- allow puppetlabs/stdlib 5.x #39 (bastelfreak)
- Remove docker nodesets #35 (bastelfreak)
- modulesync; Remove .el5 support, enable acceptance tests. #34 (traylenator)
v2.1.0 (2018-05-15)
Merged pull requests:
- lcg-CA obsoleted by ca-policy-egi-core #32 (traylenator)
v2.0.1 (2018-03-30)
Merged pull requests:
- bump puppet to latest supported version 4.10.0 #30 (bastelfreak)
v2.0.0 (2017-10-19)
Merged pull requests:
- Fix github license detection #21 (alexjfisher)
v1.2.0 (2017-02-11)
This is the last release with Puppet3 support!
- Use operatingsystemmajrelease fact instead of operatingsystemrelease + regex
- Fix several markdown issues
- Add missing badges
- Add minimum version_requirement for Puppet
2016-08-23 Release 1.1.1
- Upstream from CERNOps-fetchcrl to voxpupuli-fetchcrl.
2016-03-24 Release 1.1.0
- New optional parameter
cache_control_request.
2015-10-09 Release 1.0.0
- Drop trustedcas fact - use trustedca instead.
2015-07-17 Release 0.4.0
- Hiera variables
fetchcrl_pkg_version,fetchcrl_proxyfetchcrl_capkgsfetchcrl_carepofetchcrl_capkgs_versionare now deprecated and will print a puppet warning if used. They still work today but support will be removed at a future date. Use hiera binding instead, e.g fetchcrl::proxy.
2015-07-17 - Release 0.3.0
- New structured fact trustedca.
- The existing non structured fact trustedcas is now deprecated and will be removed next release.
2015-03-12 - Release 0.2.2
- Empty release for tag mistake.
2015-03-12 - Release 0.2.1
- Improve metadata for puppetforge.
2015-03-12 - Release 0.2.0
- Drop dangling sym links, fixes #2 and #3
- Add more and newer testing.
2013-12-11 - Release 0.1.0
- New facts certissuer and trustedcas.
- The capkgs_version and pkg_version parameters are now correctly used.
2012-11-21 - Second Release 0.0.2
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/apt (>=7.0.0 < 10.0.0)
- puppetlabs-stdlib (>= 4.13.1 < 10.0.0)
Copyright (C) 2016 CERN
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