github
/
acme4j
mirror of https://github.com/shred/acme4j
1
0
Fork 0
Code Issues Releases Wiki Activity

Review README

pull/61/head
Richard Körber 2018-03-13 23:13:47 +01:00
parent fb0abde265
commit eeedf0faad
No known key found for this signature in database
GPG Key ID: AAB9FD19C78AA3E0
1 changed files with 4 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,13 +1,5 @@
# ACME Java Client ![build status](https://shredzone.org/badge/acme4j.svg) ![maven central](https://maven-badges.herokuapp.com/maven-central/org.shredzone.acme4j/acme4j/badge.svg)
> **NOTE:** There is currently no _acme4j_ 2.0 release available at Maven Central. To use _acme4j_ with the ACMEv2 protocol, you need to build it yourself and use version `2.0-SNAPSHOT` in your project. Version 2.0 will be available as soon as _Let's Encrypt_ starts its production ACMEv2 server.
>
> **For production** you should use the latest version available at Maven Central (see the badge above). You can find the corresponding source code in the [acmev1 branch](https://github.com/shred/acme4j/tree/acmev1).
> **NOTE:** Due to a change in the ACME draft 10 that is not downward compatible, **please use the [staging](https://github.com/shred/acme4j/tree/staging) branch of _acme4j_ if you want to connect to the _Let's Encrypt_ staging server.** This is only a temporary workaround, until the staging server incorporates these changes.
>
> This master branch implements the latest ACME draft. It can be used with a local Pebble or Boulder server.
This is a Java client for the [Automatic Certificate Management Environment (ACME)](https://tools.ietf.org/html/draft-ietf-acme-acme-10) protocol.
ACME is a protocol that a certificate authority (CA) and an applicant can use to automate the process of verification and certificate issuance.
@ -25,26 +17,17 @@ It is an independent open source implementation that is not affiliated with or e
* Small, only requires [jose4j](https://bitbucket.org/b_c/jose4j/wiki/Home) and [slf4j](http://www.slf4j.org/) as dependencies
* Extensive unit and integration tests
## ACME Versions
## Usage
There are two versions of the ACME protocol 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!**
_Let's Encrypt_ plans to launch an ACME v2 production server in the near future. A staging server is already available. _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.
* See the [online documentation](https://shredzone.org/maven/acme4j/) about how to use _acme4j_.
* For a quick start, have a look at [the source code of an example](https://github.com/shred/acme4j/blob/master/acme4j-example/src/main/java/org/shredzone/acme4j/ClientTest.java).
* The previous ACME v1 protocol is still supported by [_acme4j_ version 1](https://shredzone.org/maven/acme4j-acmev1/index.html).
## Known Issues
* 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
* See the [online documentation](https://shredzone.org/maven/acme4j/) about how to use _acme4j_.
* For a quick start, have a look at [the source code of an example](https://github.com/shred/acme4j/blob/master/acme4j-example/src/main/java/org/shredzone/acme4j/ClientTest.java).
## Contribute
* Fork the [Source code at GitHub](https://github.com/shred/acme4j). Feel free to send pull requests.