From 334970b7c8744b40f21da16214a0fec834ebb8c1 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 17 Dec 2024 06:21:58 +0000 Subject: [PATCH] Release prep v5.0.1 --- CHANGELOG.md | 24 +++++-- REFERENCE.md | 172 ++++++++++++++++++++++++++++++++++++++++++++++++++ metadata.json | 2 +- 3 files changed, 190 insertions(+), 8 deletions(-) create mode 100644 REFERENCE.md diff --git a/CHANGELOG.md b/CHANGELOG.md index a8bbbf6..e9fee6d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,17 +5,26 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v5.0.1](https://github.com/puppetlabs/puppetlabs-sslcertificate/tree/v5.0.1) - 2024-12-17 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-sslcertificate/compare/v5.0.0...v5.0.1) + +### Fixed + +- (CAT-2180) Upgrade rexml to address CVE-2024-49761 [#138](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/138) ([amitkarsale](https://github.com/amitkarsale)) + ## [v5.0.0](https://github.com/puppetlabs/puppetlabs-sslcertificate/tree/v5.0.0) - 2023-08-17 [Full Changelog](https://github.com/puppetlabs/puppetlabs-sslcertificate/compare/v4.1.0...v5.0.0) +### Changed + +- Drop Puppet 6 support [#119](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/119) ([bastelfreak](https://github.com/bastelfreak)) + ### Added - Allow stdlib 8.0.0 [#112](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/112) ([smortex](https://github.com/smortex)) -### Changed -- Drop Puppet 6 support [#119](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/119) ([bastelfreak](https://github.com/bastelfreak)) - ## [v4.1.0](https://github.com/puppetlabs/puppetlabs-sslcertificate/tree/v4.1.0) - 2020-01-14 [Full Changelog](https://github.com/puppetlabs/puppetlabs-sslcertificate/compare/v4.0.0...v4.1.0) @@ -32,17 +41,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a [Full Changelog](https://github.com/puppetlabs/puppetlabs-sslcertificate/compare/v3.4.0...v4.0.0) +### Changed + +- modulesync 2.5.1 & drop Puppet 4 [#88](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/88) ([bastelfreak](https://github.com/bastelfreak)) + ### Added - modulesync 2.2.0 and allow puppet 6.x [#85](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/85) ([bastelfreak](https://github.com/bastelfreak)) - Add wildcard & bypass Intermediate Store support [#84](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/84) ([arthurbarton](https://github.com/arthurbarton)) -### Changed -- modulesync 2.5.1 & drop Puppet 4 [#88](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/88) ([bastelfreak](https://github.com/bastelfreak)) - ### Fixed -- Checks if the certificate is installed without creating an object [#70](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/70) ([crmezzet](https://github.com/crmezzet)) +- Checks if the certificate is installed without creating an object [#70](https://github.com/puppetlabs/puppetlabs-sslcertificate/pull/70) ([cmezzetti](https://github.com/cmezzetti)) ## [v3.4.0](https://github.com/puppetlabs/puppetlabs-sslcertificate/tree/v3.4.0) - 2018-09-07 diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..571f8b9 --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,172 @@ +# Reference + + + +## Table of Contents + +### Defined types + +* [`sslcertificate`](#sslcertificate): Author:: Paul Stack (mailto:pstack@opentable.com) Copyright:: Copyright (c) 2013 OpenTable Inc License:: MIT == Define: sslcertificate + +## Defined types + +### `sslcertificate` + +Author:: Paul Stack (mailto:pstack@opentable.com) +Copyright:: Copyright (c) 2013 OpenTable Inc +License:: MIT +== Define: sslcertificate + +This defined type will install SSL Certs on windows + +=== Requirements/Dependencies + +Currently reequires the puppetlabs/stdlib module on the Puppet Forge in +order to validate much of the the provided configuration. + +=== Parameters + +[*password*] +The password for the given certificate +By default is undef + +[*location*] +The location to store intermediate certificates. +Do not end the string with any forward or backslash. + +[*thumbprint*] +The thumbprint used to verify the certificate + +[*store_dir*] +The certificate 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 is no longer used. + +[*exportable*] +This parameter determines whether the certificate key is exportable or not. + +[*wildcard*] +This parameter determines whether the certificate is a wildcard certificate or not. + +[*interstore*] +This parameter determines whether the certificate is an intermediate certificate or not. + + +=== Examples + +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 certifcate 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 + } + +#### Parameters + +The following parameters are available in the `sslcertificate` defined type: + +* [`location`](#-sslcertificate--location) +* [`thumbprint`](#-sslcertificate--thumbprint) +* [`password`](#-sslcertificate--password) +* [`root_store`](#-sslcertificate--root_store) +* [`store_dir`](#-sslcertificate--store_dir) +* [`scripts_dir`](#-sslcertificate--scripts_dir) +* [`exportable`](#-sslcertificate--exportable) +* [`wildcard`](#-sslcertificate--wildcard) +* [`interstore`](#-sslcertificate--interstore) + +##### `location` + +Data type: `String[1]` + + + +##### `thumbprint` + +Data type: `String[1]` + + + +##### `password` + +Data type: `Optional[String[1]]` + + + +Default value: `undef` + +##### `root_store` + +Data type: `String[1]` + + + +Default value: `'LocalMachine'` + +##### `store_dir` + +Data type: `String[1]` + + + +Default value: `'My'` + +##### `scripts_dir` + +Data type: `Stdlib::Windowspath` + + + +Default value: `'C:\temp'` + +##### `exportable` + +Data type: `Boolean` + + + +Default value: `true` + +##### `wildcard` + +Data type: `Boolean` + + + +Default value: `false` + +##### `interstore` + +Data type: `Boolean` + + + +Default value: `false` + diff --git a/metadata.json b/metadata.json index c5eab1b..c0aea4e 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-sslcertificate", - "version": "5.0.0", + "version": "5.0.1", "author": "puppetlabs", "summary": "Module to manage SSL Certificates on Windows Server 2008 and upwards", "license": "MIT",