Skip to content

Commit 09be880

Browse files
cpucomplexspaces
authored andcommitted
docs: clarify Linux certificate store
Previously webpki-roots was used unconditionally on Linux. This changed so that webpki-roots can be used on an opt-in basis with the `Verifier::new_with_extra_roots`. This commit clarifies this point in the README table describing platform support.
1 parent 0da4cd6 commit 09be880

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This library supports the following platforms and flows:
2323
| macOS (10.14+) | macOS platform roots and keychain certificate | macOS `Security.framework` | Yes |
2424
| iOS | iOS platform roots and keychain certificates | iOS `Security.framework` | Yes |
2525
| Android | Android System Trust Store | Android Trust Manager | Sometimes[^1] |
26-
| Linux | webpki roots and platform certificate bundles | webpki | No[^2] |
26+
| Linux | System CA bundle, or user-provided certs[^3] | webpki | No[^2] |
2727
| WASM | webpki roots | webpki | No[^2] |
2828

2929
[^1]: On Android, revocation checking requires API version >= 24 (e.g. at least Android 7.0, August 2016).
@@ -36,7 +36,14 @@ checking. If you require revocation checking on these platforms, prefer construc
3636
`WebPkiServerVerifier`, providing necessary CRLs. See the Rustls [`ServerCertVerifierBuilder`] docs for more
3737
information.
3838

39+
[^3]: On Linux the [rustls-native-certs] and [openssl-probe] crates are used to try and discover the system CA bundle.
40+
Users may wish to augment these certificates with [webpki-roots] using [`Verifier::new_with_extra_roots`] in case
41+
a system CA bundle is unavailable.
42+
3943
[`ServerCertVerifierBuilder`]: https://docs.rs/rustls/latest/rustls/client/struct.ServerCertVerifierBuilder.html
44+
[rustls-native-certs]: https://github.com/rustls/rustls-native-certs
45+
[openssl-probe]: https://github.com/alexcrichton/openssl-probe
46+
[webpki-roots]: https://github.com/rustls/webpki-roots
4047

4148
## Installation and setup
4249
On most platforms, no setup should be required beyond adding the dependency via `cargo`:

0 commit comments

Comments
 (0)