Project icon

com.io7m.canonmill

Build status Maven Central Codecov

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

Contents

Features

  • Exposes a simple directory-based keystore with a single JSON 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 JSON 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

Releases

The most recently published version of the software is 0.0.5.

Source code and binaries are available from the repository.

Documentation

Documentation for the 0.0.5 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User Documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.canonmill</groupId>
  <artifactId>com.io7m.canonmill</artifactId>
  <version>0.0.5</version>
</dependency>

<dependency>
  <groupId>com.io7m.canonmill</groupId>
  <artifactId>com.io7m.canonmill.core</artifactId>
  <version>0.0.5</version>
</dependency>

<dependency>
  <groupId>com.io7m.canonmill</groupId>
  <artifactId>com.io7m.canonmill.documentation</artifactId>
  <version>0.0.5</version>
</dependency>

<dependency>
  <groupId>com.io7m.canonmill</groupId>
  <artifactId>com.io7m.canonmill.tests</artifactId>
  <version>0.0.5</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

No formal releases have been made.

Sources

This project uses Git to manage source code.

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

$ git clone https://github.com/io7m/canonmill

License

Copyright © 2022 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.

Bug Tracker

The project uses GitHub Issues to track issues.