Showing with 107 additions and 86 deletions.
  1. +3 −3 .github/workflows/release.yml
  2. +3 −3 .github/workflows/weekly.yml
  3. +1 −1 .travis.yml
  4. +16 −1 CHANGELOG.md
  5. +1 −1 CONTRIBUTING.md
  6. +3 −3 README.md
  7. +65 −59 REFERENCE.md
  8. +6 −7 Rakefile
  9. +1 −1 appveyor.yml
  10. +2 −1 lib/puppet/provider/java_ks/keytool.rb
  11. +1 −1 lib/puppet/type/java_ks.rb
  12. +4 −4 metadata.json
  13. +1 −1 spec/unit/puppet/provider/java_ks/keytool_spec.rb
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Litmus Parallel
uses: puppetlabs/action-litmus_parallel@master
uses: puppetlabs/action-litmus_parallel@main
with:
platform: ${{ matrix.platform }}
agent_family: ${{ matrix.agent_family }}
Expand All @@ -40,7 +40,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Litmus Parallel
uses: puppetlabs/action-litmus_parallel@master
uses: puppetlabs/action-litmus_parallel@main
with:
platform: ${{ matrix.platform }}
agent_family: ${{ matrix.agent_family }}
Expand All @@ -59,7 +59,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Spec Tests
uses: puppetlabs/action-litmus_spec@master
uses: puppetlabs/action-litmus_spec@main
with:
puppet_gem_version: ${{ matrix.puppet_gem_version }}
check: ${{ matrix.check }}
6 changes: 3 additions & 3 deletions .github/workflows/weekly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Litmus Parallel
uses: puppetlabs/action-litmus_parallel@master
uses: puppetlabs/action-litmus_parallel@main
with:
platform: ${{ matrix.platform }}
agent_family: ${{ matrix.agent_family }}
Expand All @@ -39,7 +39,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Litmus Parallel
uses: puppetlabs/action-litmus_parallel@master
uses: puppetlabs/action-litmus_parallel@main
with:
platform: ${{ matrix.platform }}
agent_family: ${{ matrix.agent_family }}
Expand All @@ -58,7 +58,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Spec Tests
uses: puppetlabs/action-litmus_spec@master
uses: puppetlabs/action-litmus_spec@main
with:
puppet_gem_version: ${{ matrix.puppet_gem_version }}
check: ${{ matrix.check }}
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ jobs:
stage: spec
branches:
only:
- master
- main
- /^v\d/
- release
notifications:
Expand Down
17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@

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

## [v3.2.0](https://github.com/puppetlabs/puppetlabs-java_ks/tree/v3.2.0) (2020-06-30)
## [v3.3.0](https://github.com/puppetlabs/puppetlabs-java_ks/tree/v3.3.0) (2020-11-16)

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

### Added

- \(IAC-994\) Removal of inappropriate terminology [\#335](https://github.com/puppetlabs/puppetlabs-java_ks/pull/335) ([pmcmaw](https://github.com/pmcmaw))
- 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))

### Fixed

- Change latest/current comparison to account for chains [\#336](https://github.com/puppetlabs/puppetlabs-java_ks/pull/336) ([mwpower](https://github.com/mwpower))
- add storetype parameter comparison to 'destroy' method [\#333](https://github.com/puppetlabs/puppetlabs-java_ks/pull/333) ([mwpower](https://github.com/mwpower))
- Correct jceks symbol comparison [\#332](https://github.com/puppetlabs/puppetlabs-java_ks/pull/332) ([mwpower](https://github.com/mwpower))

## [v3.2.0](https://github.com/puppetlabs/puppetlabs-java_ks/tree/v3.2.0) (2020-07-01)

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

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ process as easy as possible.

To submit your changes via a GitHub pull request, we _highly_
recommend that you have them on a topic branch, instead of
directly on "master".
directly on "main".
It makes things much easier to keep track of, especially if
you decide to work on another thing before your first change
is merged in.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# java_ks

[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-java_ks.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-java_ks)
[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-java_ks.png?branch=main)](https://travis-ci.org/puppetlabs/puppetlabs-java_ks)

#### Table of Contents

Expand Down Expand Up @@ -88,7 +88,7 @@ broker.ks keystore with the alias of broker.example.com.

## Reference

For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-java_ks/blob/master/REFERENCE.md).
For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-java_ks/blob/main/REFERENCE.md).

## Limitations

Expand All @@ -98,7 +98,7 @@ Java 7 is supported as of 1.0.0.

Developed against IBM Java 6 on AIX. Other versions may be unsupported.

For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-java_ks/blob/master/metadata.json)
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-java_ks/blob/main/metadata.json)

## Development

Expand Down
124 changes: 65 additions & 59 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Classes**
### Classes

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

**Resource types**
### Resource types

* [`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.

## Classes

### java_ks::config
### `java_ks::config`

java_ks configuration

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



Default value: {}
Default value: `{}`

## Resource types

### 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.
Expand All @@ -42,43 +43,72 @@ The following properties are available in the `java_ks` type.

##### `ensure`

Valid values: present, absent, latest
Valid values: `present`, `absent`, `latest`

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

Default value: present
Default value: `present`

#### Parameters

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

##### `certificate`

A server certificate, followed by zero or more intermediate certificate authorities.
All certificates will be placed in the keystore. This will autorequire the specified file.

##### `chain`

The intermediate certificate authorities, if they are to be taken
from a file separate from the server certificate. This will autorequire the specified file.

##### `destkeypass`

The password used to protect the key in keystore.

##### `keytool_timeout`

Timeout for the keytool command in seconds.

Default value: `120`

##### `name`

namevar

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

##### `target`
##### `password`

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

Destination file for the keystore. This will autorequire the parent directory of the file.
##### `password_fail_reset`

##### `certificate`
Valid values: ``true``, ``false``

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

##### `storetype`
Default value: ``false``

Valid values: jceks, pkcs12, jks
##### `password_file`

Optional storetype
Valid options: <jceks>, <pkcs12>, <jks>
The path to a file containing the password used to protect the
keystore. This cannot be used together with :password, but you must pass at least one of these parameters.

##### `path`

The search path used for command (keytool, openssl) execution.
Paths can be specified as an array or as a '

##### `private_key`

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

##### `private_key_type`

Valid values: rsa, dsa, ec
Valid values: `rsa`, `dsa`, `ec`

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

Default value: rsa
Default value: `rsa`

##### `chain`
##### `provider`

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

##### `password`
##### `source_alias`

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

##### `password_file`
##### `source_password`

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

##### `password_fail_reset`
##### `storetype`

Valid values: `true`, `false`
Valid values: `jceks`, `pkcs12`, `jks`

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

Default value: `false`
##### `target`

##### `destkeypass`
namevar

The password used to protect the key in keystore.
Destination file for the keystore. This will autorequire the parent directory of the file.

##### `trustcacerts`

Valid values: `true`, `false`
Valid values: ``true``, ``false``

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

Default value: `false`

##### `path`

The search path used for command (keytool, openssl) execution.
Paths can be specified as an array or as a '

##### `keytool_timeout`

Timeout for the keytool command in seconds.

Default value: 120

##### `source_password`

The source keystore password

##### `source_alias`

The source certificate alias
Default value: ``false``

13 changes: 6 additions & 7 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -52,36 +52,35 @@ if Bundler.rubygems.find_name('github_changelog_generator').any?
config.header = "# Change log\n\nAll 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)."
config.add_pr_wo_labels = true
config.issues = false
config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM"
config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB"
config.configure_sections = {
"Changed" => {
"prefix" => "### Changed",
"labels" => ["backwards-incompatible"],
},
"Added" => {
"prefix" => "### Added",
"labels" => ["feature", "enhancement"],
"labels" => ["enhancement", "feature"],
},
"Fixed" => {
"prefix" => "### Fixed",
"labels" => ["bugfix"],
"labels" => ["bug", "documentation", "bugfix"],
},
}
end
else
desc 'Generate a Changelog from GitHub'
task :changelog do
raise <<EOM
The changelog tasks depends on unreleased features of the github_changelog_generator gem.
The changelog tasks depends on recent features of the github_changelog_generator gem.
Please manually add it to your .sync.yml for now, and run `pdk update`:
---
Gemfile:
optional:
':development':
- gem: 'github_changelog_generator'
git: 'https://github.com/skywinder/github-changelog-generator'
ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
version: '~> 1.15'
condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')"
EOM
end
end
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
version: 1.1.x.{build}
branches:
only:
- master
- main
- release
skip_commits:
message: /^\(?doc\)?.*/
Expand Down
Loading