github
/
acme4j
mirror of https://github.com/shred/acme4j
1
0
Fork 0
Code Issues Releases Wiki Activity
424 Commits
4 Branches
43 Tags
4 MiB
Java 99.3%
Python 0.5%
Shell 0.2%
 
 
 
Go to file
Richard Körber 622d5795ec
Fix documentation path 		2018-01-08 01:07:48 +01:00
.github Add issue template and contribution rules 2018-01-07 16:34:12 +01:00
acme4j-client Bump to version 2.0, to emphasize the relation to ACMEv2 2018-01-07 22:49:52 +01:00
acme4j-example Bump to version 2.0, to emphasize the relation to ACMEv2 2018-01-07 22:49:52 +01:00
acme4j-it Add integration tests for Boulder 2018-01-08 00:51:24 +01:00
acme4j-utils Bump to version 2.0, to emphasize the relation to ACMEv2 2018-01-07 22:49:52 +01:00
src/site Fix documentation path 2018-01-08 01:07:48 +01:00
.gitignore Initial commit 2015-12-04 21:28:12 +01:00
.gitlab-ci.yml Always rebuild docker image on CI. Fail if IT fails. 2017-11-10 00:14:59 +01:00
.project Project start 2015-12-09 01:24:03 +01:00
CONTRIBUTING.md Add issue template and contribution rules 2018-01-07 16:34:12 +01:00
LICENSE-APL.txt Initial commit 2015-12-04 21:28:12 +01:00
README.md Say thank you to cpu 2018-01-08 00:57:13 +01:00
pom.xml Add integration tests for Boulder 2018-01-08 00:51:24 +01:00

README.md

ACME Java Client build status maven central

This is a Java client for the Automatic Certificate Management Environment (ACME) protocol.

ACME is a protocol that a certificate authority (CA) and an applicant can use to automate the process of verification and certificate issuance.

This Java client helps connecting to an ACME server, and performing all necessary steps to manage certificates.

It is an independent open source implementation that is not affiliated with or endorsed by Let's Encrypt.

Features

  • Fully supports the ACME v2 protocol up to draft 09
  • Easy to use Java API
  • Requires JRE 8 (update 101) or higher
  • Built with maven, packages available at Maven Central
  • Small, only requires jose4j and slf4j as dependencies
  • Extensive unit and integration tests

Work in Progress!

There are two versions of the ACME specification, ACME v1 and ACME v2.

ACME v1 is currently in production. It is supported by acme4j < 2.0, so use acme4j < 2.0 for production purposes!

At the moment, Let's Encrypt only provides an ACME v2 staging server for testing purposes. An ACME v2 production server is planned to be launched on Feburary 27th, 2018. acme4j >= 2.0 supports the ACME v2 protocol.

Let's Encrypt has not announced a sunset date for ACME v1 yet, so there is plenty of time for migration. acme4j < 2.0 will be maintained in the acmev1 branch until sunset of the ACME v1 protocol.

Known Issues

  • Let's Encrypt does not support the tls-sni-02 challenge yet, while acme4j does not provide tls-sni-01 support any more. If you use tls-sni, do not upgrade to acme4j v2 yet!
  • The acme4j v2 API is still subject to change.
  • Integration tests do not fully cover all functions. The standard methods for creating an account, ordering, and downloading a certificate are tested. Other methods are not tested yet, and may not work as expected.

Usage

Contribute

License

acme4j is open source software. The source code is distributed under the terms of Apache License 2.0.

Acknowledgements

  • I would like to thank Brian Campbell and all the other jose4j developers. acme4j would not exist without your excellent work.
  • Thanks to Daniel McCarney for his help with the ACME protocol, Pebble, and Boulder.
  • I also like to thank everyone who contributed to acme4j.