expand documentation for Certificate and PrivateKey #1301
Merged
Conversation
This file contains hidden or 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
djc
approved these changes
May 22, 2023
cpu
approved these changes
May 22, 2023
Codecov Report
@@ Coverage Diff @@
## main #1301 +/- ##
=======================================
Coverage 95.55% 95.55%
=======================================
Files 60 60
Lines 14351 14351
=======================================
Hits 13713 13713
Misses 638 638
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
(Going to work around the MSRV failure with #1302, feel free to ignore.) |
this is only relevant for implementers of ClientCertVerifier or ServerCertVerifier traits, and what validation should happen should be documented on those trait's methods.
416ae2a to
8a50c44
Compare
djc
approved these changes
May 22, 2023
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.
Some of the rustls documentation is... not that helpful to those unfamiliar with TLS and certificates. The
CertificateandPrivateKeytypes had particularly little documentation. This is my attempt to improve the situation.I've included code samples using
rustls_pemfile. tried to give some info to quickly check "does this file I have match roughly what rustls would expect" and provide some links to more info and thercgencrate, if a user wants to generate a new certificate or private key.