Describe Cargo features in README

This commit is contained in:
Dirkjan Ochtman 2024-07-16 20:35:30 +02:00
parent 7de5a0e796
commit 6d0aee7f22
1 changed files with 11 additions and 1 deletions

View File

@ -20,9 +20,19 @@ specification.
* Support for external account binding * Support for external account binding
* Support for certificate revocation * Support for certificate revocation
* Uses hyper with rustls and Tokio for HTTP requests * 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 * 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 ## Limitations
* Only tested with DNS challenges against Let's Encrypt (staging and production) and ZeroSSL (production) so far * Only tested with DNS challenges against Let's Encrypt (staging and production) and ZeroSSL (production) so far