Skip to content

Commit

Permalink
Describe Cargo features in README
Browse files Browse the repository at this point in the history
  • Loading branch information
djc committed Jul 16, 2024
1 parent 7de5a0e commit 6d0aee7
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,19 @@ specification.
* Support for external account binding
* Support for certificate revocation
* Uses hyper with rustls and Tokio for HTTP requests
* Uses *ring* for ECDSA signing
* Uses *ring* or aws-lc-rs for ECDSA signing
* Minimum supported Rust version: 1.63

## Cargo features

* `hyper-rustls` (default): use a hyper client with rustls
* `ring` (default): use the *ring* crate as the crypto backend
* `aws-lc-rs`: use the aws-lc-rs crate as the crypto backend
* `fips`: enable the aws-lc-rs crate's FIPS-compliant mode

If both `ring` and `aws-lc-rs` are enabled, which backend is used depends on the `fips` feature.
If `fips` is enabled, `aws-lc-rs` is used; otherwise, `ring` is used.

## Limitations

* Only tested with DNS challenges against Let's Encrypt (staging and production) and ZeroSSL (production) so far
Expand Down

0 comments on commit 6d0aee7

Please sign in to comment.