Skip to content

Commit f7f2a64

Browse files
authored
Merge pull request #337 from puppetlabs/release
(Maint) Release version 3.3.0
2 parents 958e40c + e5cbbb5 commit f7f2a64

File tree

3 files changed

+82
-61
lines changed

3 files changed

+82
-61
lines changed

CHANGELOG.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,22 @@
22

33
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).
44

5-
## [v3.2.0](https://github.com/puppetlabs/puppetlabs-java_ks/tree/v3.2.0) (2020-06-30)
5+
## [v3.3.0](https://github.com/puppetlabs/puppetlabs-java_ks/tree/v3.3.0) (2020-11-16)
6+
7+
[Full Changelog](https://github.com/puppetlabs/puppetlabs-java_ks/compare/v3.2.0...v3.3.0)
8+
9+
### Added
10+
11+
- \(IAC-994\) Removal of inappropriate terminology [\#335](https://github.com/puppetlabs/puppetlabs-java_ks/pull/335) ([pmcmaw](https://github.com/pmcmaw))
12+
- pdksync - \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#327](https://github.com/puppetlabs/puppetlabs-java_ks/pull/327) ([david22swan](https://github.com/david22swan))
13+
14+
### Fixed
15+
16+
- Change latest/current comparison to account for chains [\#336](https://github.com/puppetlabs/puppetlabs-java_ks/pull/336) ([mwpower](https://github.com/mwpower))
17+
- add storetype parameter comparison to 'destroy' method [\#333](https://github.com/puppetlabs/puppetlabs-java_ks/pull/333) ([mwpower](https://github.com/mwpower))
18+
- Correct jceks symbol comparison [\#332](https://github.com/puppetlabs/puppetlabs-java_ks/pull/332) ([mwpower](https://github.com/mwpower))
19+
20+
## [v3.2.0](https://github.com/puppetlabs/puppetlabs-java_ks/tree/v3.2.0) (2020-07-01)
621

722
[Full Changelog](https://github.com/puppetlabs/puppetlabs-java_ks/compare/v3.1.0...v3.2.0)
823

REFERENCE.md

+65-59
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# Reference
2+
23
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
34

45
## Table of Contents
56

6-
**Classes**
7+
### Classes
78

89
* [`java_ks::config`](#java_ksconfig): java_ks configuration
910

10-
**Resource types**
11+
### Resource types
1112

1213
* [`java_ks`](#java_ks): Manages the entries in a java keystore, and uses composite namevars to accomplish the same alias spread across multiple target keystores.
1314

1415
## Classes
1516

16-
### java_ks::config
17+
### `java_ks::config`
1718

1819
java_ks configuration
1920

@@ -27,11 +28,11 @@ Data type: `Any`
2728

2829

2930

30-
Default value: {}
31+
Default value: `{}`
3132

3233
## Resource types
3334

34-
### java_ks
35+
### `java_ks`
3536

3637
Manages the entries in a java keystore, and uses composite namevars to
3738
accomplish the same alias spread across multiple target keystores.
@@ -42,43 +43,72 @@ The following properties are available in the `java_ks` type.
4243

4344
##### `ensure`
4445

45-
Valid values: present, absent, latest
46+
Valid values: `present`, `absent`, `latest`
4647

4748
Has three states: present, absent, and latest. Latest
4849
will compare the on disk SHA1 fingerprint of the certificate to that
4950
in keytool to determine if insync? returns true or false. We redefine
5051
insync? for this parameter to accomplish this.
5152

52-
Default value: present
53+
Default value: `present`
5354

5455
#### Parameters
5556

5657
The following parameters are available in the `java_ks` type.
5758

59+
##### `certificate`
60+
61+
A server certificate, followed by zero or more intermediate certificate authorities.
62+
All certificates will be placed in the keystore. This will autorequire the specified file.
63+
64+
##### `chain`
65+
66+
The intermediate certificate authorities, if they are to be taken
67+
from a file separate from the server certificate. This will autorequire the specified file.
68+
69+
##### `destkeypass`
70+
71+
The password used to protect the key in keystore.
72+
73+
##### `keytool_timeout`
74+
75+
Timeout for the keytool command in seconds.
76+
77+
Default value: `120`
78+
5879
##### `name`
5980

6081
namevar
6182

6283
The alias that is used to identify the entry in the keystore. This will be
6384
converted to lowercase.
6485

65-
##### `target`
86+
##### `password`
6687

67-
namevar
88+
The password used to protect the keystore. If private keys are
89+
subsequently also protected this password will be used to attempt
90+
unlocking. Must be six or more characters in length. Cannot be used
91+
together with :password_file, but you must pass at least one of these parameters.
6892

69-
Destination file for the keystore. This will autorequire the parent directory of the file.
93+
##### `password_fail_reset`
7094

71-
##### `certificate`
95+
Valid values: ``true``, ``false``
7296

73-
A server certificate, followed by zero or more intermediate certificate authorities.
74-
All certificates will be placed in the keystore. This will autorequire the specified file.
97+
If the supplied password does not succeed in unlocking the
98+
keystore file, then delete the keystore file and create a new one.
99+
Default: false.
75100

76-
##### `storetype`
101+
Default value: ``false``
77102

78-
Valid values: jceks, pkcs12, jks
103+
##### `password_file`
79104

80-
Optional storetype
81-
Valid options: <jceks>, <pkcs12>, <jks>
105+
The path to a file containing the password used to protect the
106+
keystore. This cannot be used together with :password, but you must pass at least one of these parameters.
107+
108+
##### `path`
109+
110+
The search path used for command (keytool, openssl) execution.
111+
Paths can be specified as an array or as a '
82112

83113
##### `private_key`
84114

@@ -88,70 +118,46 @@ accompanied by a signed certificate for the keytool provider. This will autorequ
88118

89119
##### `private_key_type`
90120

91-
Valid values: rsa, dsa, ec
121+
Valid values: `rsa`, `dsa`, `ec`
92122

93123
The type of the private key. Usually the private key is of type RSA
94124
key but it can also be an Elliptic Curve key (EC) or DSA.
95125
Valid options: <rsa>, <dsa>, <ec>. Defaults to <rsa>
96126

97-
Default value: rsa
127+
Default value: `rsa`
98128

99-
##### `chain`
129+
##### `provider`
100130

101-
The intermediate certificate authorities, if they are to be taken
102-
from a file separate from the server certificate. This will autorequire the specified file.
131+
The specific backend to use for this `java_ks` resource. You will seldom need to specify this --- Puppet will usually
132+
discover the appropriate provider for your platform.
103133

104-
##### `password`
134+
##### `source_alias`
105135

106-
The password used to protect the keystore. If private keys are
107-
subsequently also protected this password will be used to attempt
108-
unlocking. Must be six or more characters in length. Cannot be used
109-
together with :password_file, but you must pass at least one of these parameters.
136+
The source certificate alias
110137

111-
##### `password_file`
138+
##### `source_password`
112139

113-
The path to a file containing the password used to protect the
114-
keystore. This cannot be used together with :password, but you must pass at least one of these parameters.
140+
The source keystore password
115141

116-
##### `password_fail_reset`
142+
##### `storetype`
117143

118-
Valid values: `true`, `false`
144+
Valid values: `jceks`, `pkcs12`, `jks`
119145

120-
If the supplied password does not succeed in unlocking the
121-
keystore file, then delete the keystore file and create a new one.
122-
Default: false.
146+
Optional storetype
147+
Valid options: <jceks>, <pkcs12>, <jks>
123148

124-
Default value: `false`
149+
##### `target`
125150

126-
##### `destkeypass`
151+
namevar
127152

128-
The password used to protect the key in keystore.
153+
Destination file for the keystore. This will autorequire the parent directory of the file.
129154

130155
##### `trustcacerts`
131156

132-
Valid values: `true`, `false`
157+
Valid values: ``true``, ``false``
133158

134159
Certificate authorities aren't by default trusted so if you are adding a CA you need to set this to true.
135160
Defaults to :false.
136161

137-
Default value: `false`
138-
139-
##### `path`
140-
141-
The search path used for command (keytool, openssl) execution.
142-
Paths can be specified as an array or as a '
143-
144-
##### `keytool_timeout`
145-
146-
Timeout for the keytool command in seconds.
147-
148-
Default value: 120
149-
150-
##### `source_password`
151-
152-
The source keystore password
153-
154-
##### `source_alias`
155-
156-
The source certificate alias
162+
Default value: ``false``
157163

metadata.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-java_ks",
3-
"version": "3.2.0",
3+
"version": "3.3.0",
44
"author": "puppetlabs",
55
"summary": "Manage arbitrary Java keystore files",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)