#rustls #native #certificate #certs

rustls-native-certs

rustls-native-certs allows rustls to use the platform native certificate store

6 releases (breaking)

0.5.0 Nov 22, 2020
0.4.0 Jul 5, 2020
0.3.0 Feb 24, 2020
0.2.1 Jan 26, 2020
0.1.0 Nov 4, 2019

#43 in Network programming

Download history 34596/week @ 2021-01-21 36824/week @ 2021-01-28 35789/week @ 2021-02-04 35982/week @ 2021-02-11 37549/week @ 2021-02-18 37379/week @ 2021-02-25 39665/week @ 2021-03-04 43284/week @ 2021-03-11 41584/week @ 2021-03-18 49852/week @ 2021-03-25 38748/week @ 2021-04-01 41166/week @ 2021-04-08 40103/week @ 2021-04-15 45261/week @ 2021-04-22 48384/week @ 2021-04-29 48316/week @ 2021-05-06

186,540 downloads per month
Used in 89 crates (26 directly)

MIT/Apache/ISC

19KB
194 lines

Logo

rustls-native-certs allows rustls to use the platform's native certificate store when operating as a TLS client.

This is supported on Windows, macOS and Linux:

  • On Windows, certificates are loaded from the system certificate store. The schannel crate is used to access the Windows certificate store APIs.
  • On macOS, certificates are loaded from the keychain. The user, admin and system trust settings are merged together as documented by Apple. The security-framework crate is used to access the keystore APIs.
  • On Linux and other UNIX-like operating systems, the openssl-probe crate is used to discover the filename of the system CA bundle.

Status

rustls-native-certs is currently in development.

If you'd like to help out, please see CONTRIBUTING.md.

Build Status Documentation

Release history:

  • 0.5.0 (2020-11-22):
    • Update dependencies.
    • Make rustls dependency optional, for use with reqwest's certificate types. Thanks to @est31.
  • 0.4.0 (2020-07-05):
    • Update dependencies.
  • 0.3.0 (2020-02-24):
    • Support wider range of UNIX platforms.
    • Update dependencies.
  • 0.2.0 (2020-01-26):
    • Return valid certificates even in the presence of invalid ones. This allows callers to opt-in to "best effort" behaviour.
  • 0.1.0 (2019-11-04):
    • Initial release.

API

This library exposes a single function with this signature:

pub fn load_native_certs() -> Result<rustls::RootCertStore, (Option<rustls::RootCertStore>, std::io::Error)>

On success, this returns a rustls::RootCertStore loaded with a snapshop of the root certificates found on this platform. This function fails in a platform-specific way, expressed in a std::io::Error.

When an error is returned, optionally a rustls::RootCertStore is also returned containing the certificates which could be loaded. This means callers can opt-in to "best-effort" behaviour even in the presence of invalid certificates.

This function can be expensive: on some platforms it involves loading and parsing a ~300KB disk file. It's therefore prudent to call this sparingly.

Worked example

See examples/google.rs.

Should I use this or webpki-roots?

(Background: webpki-roots is a crate that compiles-in Mozilla's set of root certificates.)

This crate is preferable in many ways to webpki-roots. To sum up the pros and cons:

Pros:

  • This crate respects local configuration of root certificates: both removal of roots that the user finds untrustworthy, and addition of locally-trusted roots. The latter case is exceedingly important if your application is required to work in enterprise environments with "transparent" TLS-terminating middleboxes.
  • This crate instantaneously reflects underlying system configuration. Since webpki-roots compiles in root certificates, getting an update to these requires taking regular updates to this crate, plus recompilation and redeployment of the application. This is a long-winded process that may become a liability in the event of a severe misissuance.
  • This crate is compatible with developer aids such as mkcert.

Cons:

  • The OS certificate store is occasionally "attacked" by malware or just bad software.
  • The OS update system may, in fact, be quite poor at keeping the root certificates up-to-date if it is disabled or out-of-support.
  • The quality of the ca-certificates package on debian-based Linux distributions is poor. At the time of writing, this ships many certificates not included in the Mozilla set, either because they failed an audit and were withdrawn or were removed for mississuance.
  • You may prefer to insulate yourself against local configuration for support or (perhaps inadvisable) security reasons.

License

rustls-native-certs is distributed under the following three licenses:

  • Apache License version 2.0.
  • MIT license.
  • ISC license.

These are included as LICENSE-APACHE, LICENSE-MIT and LICENSE-ISC respectively. You may use this software under the terms of any of these licenses, at your option.

Dependencies

~7.5MB
~206K SLoC