io7m.com: com.io7m.canonmill

canonmill

The canonmill package provides a Keystore implementation designed to be less painful from an operational perspective than any of the Keystore implementations currently included in the standard JDK.

Features

Exposes a simple directory-based keystore with a single XML file that maps certificate aliases to files. Keys and certificates are expected to be PEM-encoded regular files.
Implicit compatibility with ACME systems; ACME clients can simply copy certificate files into the directory and, as long as the certificates have an entry in the XML index file, the new certificates will become available as soon as the Keystore is reloaded.
A small, easily auditable codebase with use of modularity for correctness.
An extensive automated test suite with high coverage.
Platform independence. No platform-dependent code is included in any form.
OSGi-ready.
JPMS-ready.
ISC license.

Usage

See the documentation.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 2.1.0.

2.1.0 Release (2024-05-11Z)

Update junit.version:5.10.1 → 5.10.2.
Update bouncycastle.version:1.77 → 1.78.1.
Update org.slf4j:slf4j-api:2.0.10 → 2.0.13.
Update org.mockito:mockito-core:5.8.0 → 5.11.0.
Update logback.version:1.4.14 → 1.5.6.
Update com.io7m.jdeferthrow:com.io7m.jdeferthrow.core:1.2.0 → 1.3.0.
Update com.io7m.jaffirm:com.io7m.jaffirm.core:4.0.0 → 4.0.1.
Update com.io7m.jxe:com.io7m.jxe.core:1.0.2 → 1.0.3.
Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0.
Move to new organization.
Update com.io7m.anethum:com.io7m.anethum.api:1.1.0 → 1.1.1.
Update com.io7m.blackthorne:com.io7m.blackthorne.core:2.0.0 → 2.0.1.
Update com.io7m.blackthorne:com.io7m.blackthorne.jxe:2.0.0 → 2.0.1.
Update com.io7m.jxtrand:com.io7m.jxtrand.vanilla:2.0.0 → 2.1.0.
Update org.mockito:mockito-core:5.11.0 → 5.12.0.

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.canonmill</group> <artifactId>com.io7m.canonmill.core</artifactId> <version>2.1.0</version> </dependency><dependency> <group>com.io7m.canonmill</group> <artifactId>com.io7m.canonmill.documentation</artifactId> <version>2.1.0</version> </dependency><dependency> <group>com.io7m.canonmill</group> <artifactId>com.io7m.canonmill.tests</artifactId> <version>2.1.0</version> </dependency>

Previous Releases

The changelogs for the most recent previous releases are as follows:

2.0.1 Release (2024-05-11Z)

Full certificate chains were not being returned. (Tickets: 3)

2.0.0 Release (2023-12-17Z)

Fix an issue that can cause incompatible algorithm names. (Tickets: 2)
Require JDK 21 (Backwards incompatible)

1.0.0 Release (2023-08-20Z)

Initial release.

Development Snapshots

At the time of writing, the current unstable development version of the package is 2.1.1-SNAPSHOT.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

User Manual

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/canonmill

$ git clone --recursive https://www.github.com/io7m-com/canonmill

Issues

This project uses GitHub Issues to track issues.

License

Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.