sslcertificate
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 'puppetlabs-sslcertificate', '5.0.0'Learn more about managing modules with a PuppetfileDocumentation
SSL Certificate module for Puppet
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with sslcertificate
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
Small defined type that will allow you to manage Windows certificates.
Module Description
A module that will allow you to install your certificates on Windows machines. It will manage pfx, cer, der, p7b, sst certificates.
Setup
What sslcertificate affects
- Installs certificates into your Windows key stores
Beginning with sslcertificate
To install a certificate in the My directory of the LocalMachine root store:
sslcertificate { "Install-PFX-Certificate" :
name => 'mycert.pfx',
password => 'password123',
location => 'C:\',
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B'
}
To install a certificate in an alternative directory:
sslcertificate { "Install-Intermediate-Certificate" :
name => 'go_daddy_intermediate.p7b',
location => 'C:\',
store_dir => 'CA',
root_store => 'LocalMachine',
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B'
}
To install a certificate in the My directory of the LocalMachine root store and set the key as not exportable:
sslcertificate { "Install-PFX-Certificate" :
name => 'mycert.pfx',
password => 'password123',
location => 'C:',
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B',
exportable => false
}
For more details on the different options available with certificate management directories, see Windows Dev Center.
Usage
Classes and Defined Types
Defined Type: sslcertificate
The primary definition of the sslcertificate module. This definition will install the certificates into your keystore(s).
Parameters within sslcertificate:
password
The password for the given certificate
location
The location where the file certificate is. Do not end the string with any forward or backslash. Note that in puppet manifests, double-backslashes must be re-doubled, even in single-quoted strings, e.g.
sslcertificate { "Install-PFX-Certificate from UNC path" :
name => 'mycert.pfx',
password => 'password123',
location => '\\\\StorageServer\Fileshare',
thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B'
}
thumbprint
The thumbprint used to verify the certificate
store_dir
The certifcate store where the certificate will be installed to
root_store
The store location for the given certification store. Either LocalMachine or CurrentUser
scripts_dir
This parameter has been deprecated and isn't used anymore. The scripts aren't saved to disk anymore.
exportable
Flag to set the key as exportable. true == exportable; false == not exportable. By default is set to true.
wildcard
Flag to set the MachineKeySet flag in import, used for importing wildcard certificates. Defaults to false
interstore
If this is set to true, any intermediate certificates included will be imported in the same store_dir, not the intermediate store.
Defaults to false
Reference
Definition
Public Definition
sslcertificate: Guides the installation of certificates
Limitations
This module is tested on the following platforms:
- Windows 2008 R2
It is tested with the OSS version of Puppet only.
Development
Contributing
Please read CONTRIBUTING.md for full details on contributing to this project.
Transfer notice
This module was previously maintained by Vox Pupuli. It was migrated to Puppet/Perforce in 2023.
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.
v5.0.0 - 2023-08-17
Added
Changed
- Drop Puppet 6 support #119 (bastelfreak)
v4.1.0 - 2020-01-14
Added
- Allow
puppetlabs/stdlib6.x #93 (cubiclelord)
Fixed
- ISSUE-99: Add note explaining redoubled backslashes. #100 (pillarsdotnet)
v4.0.0 - 2019-05-02
Added
- modulesync 2.2.0 and allow puppet 6.x #85 (bastelfreak)
- Add wildcard & bypass Intermediate Store support #84 (arthurbarton)
Changed
- modulesync 2.5.1 & drop Puppet 4 #88 (bastelfreak)
Fixed
v3.4.0 - 2018-09-07
Added
- allow puppetlabs/stdlib 5.x #80 (bastelfreak)
v3.3.0 - 2018-02-13
Added
- Don't store the PS1 scripts #66 (natemccurdy)
- Make the password parameter optional #65 (rnelson0)
v3.2.0 - 2017-11-20
Added
- bump puppet version dependency to >= 4.7.1 < 6.0.0 #59 (bastelfreak)
v3.1.0 - 2017-09-17
v3.0.0 - 2017-06-26
Added
- Set mode to 0600 on sensitive scripts #54 (roidelapluie)
- New argument to set exportability of the certificate #46 (ricardogaspar2)
Fixed
- Fixing typo #50 (thirumoorthir)
v2.2.0 - 2017-02-11
Fixed
- Fix references to
sslcert#30 (alexjfisher)
v2.1.1 - 2015-03-24
v2.0.2 - 2014-10-13
v2.0.1 - 2014-10-13
v1.0.1 - 2014-10-13
v2.1.0 - 2014-10-13
v2.0.0 - 2014-04-16
v1.0.0 - 2014-03-12
Dependencies
- puppetlabs/stdlib (>= 4.13.1 < 10.0.0)
- puppetlabs/powershell (>= 1.1.1 < 7.0.0)
Copyright (c) 2014 OpenTable, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select modules are also checked for malware using VirusTotal.
Please note, the information below is for guidance only and neither of these methods should be considered an endorsement by Puppet.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-sslcertificate
- Module version:
- 5.0.0
- Scan initiated:
- August 17th 2023, 5:13:06
- Detections:
- 0 / 59
- Scan stats:
- 57 undetected
- 0 harmless
- 2 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 16 unsupported
- Scan report:
- View the detailed scan report