Improve assert_hostname and server_hostname documentation
#2169
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 default value of `assert_hostname` is `server_hostname`, so specifying `assert_hostname` isn't needed. Also, even if the IP of badssl.com probably isn't that stable, being able to actually run the example seems nicer than using a private IP.
Codecov Report
@@ Coverage Diff @@
## main #2169 +/- ##
==========================================
- Coverage 99.95% 99.45% -0.50%
==========================================
Files 25 25
Lines 2221 2208 -13
==========================================
- Hits 2220 2196 -24
- Misses 1 12 +11
Continue to review full report at Codecov.
|
sethmlarson
approved these changes
Mar 8, 2021
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.
The default value of
assert_hostnameisserver_hostname, so specifyingassert_hostnamefor SNI isn't needed. Also, even if the IP of badssl.com probably isn't that stable, being able to actually run the example seems nicer than using a private IP.Having a separate example for
assert_hostnameclarifies that it's not only about SNI. Again, I've used badssl.com since that allows to actually run the example.Fixes #2126 (the type documentation will be handled by #2162)