docs: provide more guidance for customizing private keys #1724
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `KeyProvider` trait associted with the `CryptoProvider` struct is specific to private key material that can be loaded from a DER representation. For users that want to use private keys used through a handle, or PKCS11 style interface an alternative integration approach is needed. This commit adds a doc string update to the `KeyProvider` to guide such users to look at the Rustls manual's section on customizing private key usage.
This commit adds a small pointer to rustls-cng in the manual's section on customizing private key usage.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1724 +/- ##
=======================================
Coverage 96.16% 96.16%
=======================================
Files 80 80
Lines 17345 17345
=======================================
Hits 16680 16680
Misses 665 665 ☔ View full report in Codecov by Sentry. |
ctz
approved these changes
Jan 5, 2024
Benchmark resultsInstruction countsSignificant differencesClick to expand
Other differencesClick to expand
Wall-timeSignificant differencesThere are no significant wall-time differences Other differencesClick to expand
Additional informationCheckout details:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This branch adds a pointer from the
KeyProvidertrait to the manual section on customizing private key usage. It also updates that section of the manual to point to therustls-cngcrate as a complete example.Updates #1703