Skip to content

Commit 6d0aee7

Browse files
committed
Describe Cargo features in README
1 parent 7de5a0e commit 6d0aee7

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,19 @@ specification.
2020
* Support for external account binding
2121
* Support for certificate revocation
2222
* Uses hyper with rustls and Tokio for HTTP requests
23-
* Uses *ring* for ECDSA signing
23+
* Uses *ring* or aws-lc-rs for ECDSA signing
2424
* Minimum supported Rust version: 1.63
2525

26+
## Cargo features
27+
28+
* `hyper-rustls` (default): use a hyper client with rustls
29+
* `ring` (default): use the *ring* crate as the crypto backend
30+
* `aws-lc-rs`: use the aws-lc-rs crate as the crypto backend
31+
* `fips`: enable the aws-lc-rs crate's FIPS-compliant mode
32+
33+
If both `ring` and `aws-lc-rs` are enabled, which backend is used depends on the `fips` feature.
34+
If `fips` is enabled, `aws-lc-rs` is used; otherwise, `ring` is used.
35+
2636
## Limitations
2737

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

0 commit comments

Comments
 (0)