diff options
| author | Jacob Hoffman-Andrews <github@hoffman-andrews.com> | 2024-07-29 18:03:03 -0700 |
|---|---|---|
| committer | Daniel McCarney <daniel@binaryparadox.net> | 2024-07-30 10:59:14 -0400 |
| commit | 311fba170462f8279ef4e4169309e891d212f048 (patch) | |
| tree | 39fae807a8ec43f12dfae90332336326bba613d3 | |
| parent | 493ee05164166df98e631c78f29de8f9c7e8e829 (diff) | |
doc: fix comment on WebPKI and platform verifier
Since the webpki crate is a specific implementation (which is chosen by the
platform verifier crate on some platforms), it was confusing to call it out by
name. Instead, simplify the comment to say it uses "the default behavior for the
current platform."
| -rw-r--r-- | src/cipher.rs | 5 | ||||
| -rw-r--r-- | src/rustls.h | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/src/cipher.rs b/src/cipher.rs index 6f5d4bd..6d903cd 100644 --- a/src/cipher.rs +++ b/src/cipher.rs @@ -1055,8 +1055,9 @@ box_castable! { } impl rustls_server_cert_verifier { - /// Create a new server certificate verifier that uses the system's root store and WebPKI via - /// [`rustls-platform-verifier`][]. + /// Create a verifier that uses the default behavior for the current platform. + /// + /// This uses [`rustls-platform-verifier`][]. /// /// The verifier can be used in several `rustls_client_config` instances and must be freed by /// the application using `rustls_server_cert_verifier_free` when no longer needed. diff --git a/src/rustls.h b/src/rustls.h index a318417..1b0c9d0 100644 --- a/src/rustls.h +++ b/src/rustls.h @@ -1257,8 +1257,9 @@ rustls_result rustls_web_pki_server_cert_verifier_builder_build(struct rustls_we void rustls_web_pki_server_cert_verifier_builder_free(struct rustls_web_pki_server_cert_verifier_builder *builder); /** - * Create a new server certificate verifier that uses the system's root store and WebPKI via - * [`rustls-platform-verifier`][]. + * Create a verifier that uses the default behavior for the current platform. + * + * This uses [`rustls-platform-verifier`][]. * * The verifier can be used in several `rustls_client_config` instances and must be freed by * the application using `rustls_server_cert_verifier_free` when no longer needed. |