Add documentation for missing ssl bits#7136
Conversation
|
Docs Build status updates of commit 4378c4a: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
xml/System.Net.Security/SslStreamCertificateContext.xml
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
| <Docs> | ||
| <param name="trustList">To be added.</param> | ||
| <param name="trustList">The store containig the trusted certificates.</param> | ||
| <param name="sendTrustInHandshake">To be added.</param> |
There was a problem hiding this comment.
@wfurt can you please provide description for this param?
There was a problem hiding this comment.
If the is set to true server will send list of trusted CAs during TLS Handshake. This is used to guide client to select appropriate client certificate.
Now, this has many caveats and we should put some big warnings about it: 1. In 6,0 it works only on Windows - we cut out macOS and Linux. 2) on Windows it depends on registry setting.
Since this increases size of the handshake message and can be viewed as info leak about system configuration, this should be off unless there is specific reason. e.g. it would be nice to have some warning like "don't use it unless you know what you are doing".
There was a problem hiding this comment.
@wfurt would you mind providing these comments as suggestions? Both for the empty <param> and for the <remarks> section below with all those caveats you mentioned.
There was a problem hiding this comment.
I already did that in my review.
| <summary>To be added.</summary> | ||
| <returns>To be added.</returns> | ||
| <summary>Creates new SslCertificateTrust.</summary> | ||
| <returns>A collection of certificates replacing the default certificate trust.</returns> |
There was a problem hiding this comment.
It doesn't return a collection of certificates, it returns the trust policy thing.
There was a problem hiding this comment.
Yep, it returns an object of this file's Type. So in that case, the <returns> value should start similarl to the suggestion you provided here, right?:
https://github.com/dotnet/dotnet-api-docs/pull/7136/files#r706271785
|
Docs Build status updates of commit 0a968a0: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Co-authored-by: Jeremy Barton <jbarton@microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
Docs Build status updates of commit c097ec7: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 0c636e3: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 0c636e3: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit b805c07: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Summary
part of dotnet/runtime#54857