mirror of https://github.com/shred/acme4j
44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
# ACME Java Client 
|
|
|
|
This is a Java client for the [Automatic Certificate Management Environment (ACME)](https://tools.ietf.org/html/draft-ietf-acme-acme-01) 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
|
|
|
|
* Easy to use Java API
|
|
* Requires JRE 7 or higher
|
|
* Built with maven, packages available at Maven Central
|
|
* Small, only requires [jose4j](https://bitbucket.org/b_c/jose4j/wiki/Home) and [slf4j](http://www.slf4j.org/) as dependencies
|
|
* Extensive unit tests
|
|
|
|
## Usage
|
|
|
|
* See the [online documentation](http://www.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).
|
|
|
|
## Beta Release
|
|
|
|
Please note that _acme4j_ is currently in beta state. The API may still change without prior notice, but I try to keep the changes minimal.
|
|
|
|
As _Let's Encrypt_ is currently in public beta, some of the ACME services may be restricted or [not implemented](https://github.com/letsencrypt/boulder/wiki/TODO). Also see the [_acme4j_ bug tracker](https://github.com/shred/acme4j/issues) for missing or untested features.
|
|
|
|
The [ACME specifications](https://github.com/ietf-wg-acme/acme) are not finalized yet. The _acme4j_ API may change as features are added to, and other features removed from the specifications.
|
|
|
|
## Contribute
|
|
|
|
* Fork the [Source code at GitHub](https://github.com/shred/acme4j). Feel free to send pull requests.
|
|
* Found a bug? [File a bug report!](https://github.com/shred/acme4j/issues)
|
|
|
|
## License
|
|
|
|
_acme4j_ is open source software. The source code is distributed under the terms of [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
|
|
|
## Acknowledgements
|
|
|
|
* I would like to thank Brian Campbell and all the other [jose4j](https://bitbucket.org/b_c/jose4j/wiki/Home) developers. _acme4j_ would not exist without your excellent work.
|