-
Notifications
You must be signed in to change notification settings - Fork 1.7k
SslClientAuthenticationOptions - update documentation #4366
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SslClientAuthenticationOptions - update documentation #4366
Conversation
wfurt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
generally looks good to me. I added few comments.
…tAuthenticationOptions
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…aik-jahoda/dotnet-api-docs into jajahoda/SslClientAuthenticationOptions
wfurt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with few more comments.
| </ReturnValue> | ||
| <Docs> | ||
| <summary>To be added.</summary> | ||
| <summary>List of the client certificates offered to the server.</summary> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should make sure to be clear we will pick just one from the collection and it must have private key.
There are some weird rules hard to describe and there were cases when we did not pick anything from the collection - sometimes even if there is exactly one certificate.
| <Docs> | ||
| <summary>To be added.</summary> | ||
| <value>To be added.</value> | ||
| <summary>Gets or sets the <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents protocols used for authentication.</summary> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should make sure IMHO that this is set of protocols client wants to use. One of them may be used or negotiation may fail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is same for SslServerAuthemticationOptions hence I put it there: https://github.com/aik-jahoda/dotnet-api-docs/blob/27ea1dbfb6dd106749d7d4c9fda77ebf0ed4429b/xml/System.Security.Authentication/SslProtocols.xml#L45
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You will get that only if you follow the link but not oof you joust read the property decryption, right?
how about
Gets or sets the value that represents protocol versions offered by client to the server during authentication.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated this summary also in SslServerAuthenticationOptions.xml
…tAuthenticationOptions
gewarren
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a few grammatical suggestions, otherwise looks good.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Summary
Collect all changes from #3916 related to SslClientAuthenticationOptions