docs: document s2n_cert_auth_type behavior #4454
Merged
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
|
offline comments:
|
maddeleine
reviewed
May 1, 2024
maddeleine
reviewed
May 28, 2024
maddeleine
reviewed
May 28, 2024
toidiu
commented
May 29, 2024
api/s2n.h
Outdated
Comment on lines
2302
to
2303
| * - Optional: request the client's certificate and validate if it's non-empty. Abort the | ||
| * handshake if the client doesn't send its certificate (can be empty). |
There was a problem hiding this comment.
Dont love the "(can be empty)" and technically its redundant since i mention non-empty. Thoughts on if we should keep it or re-word it?
maddeleine
approved these changes
May 29, 2024
goatgoose
reviewed
May 30, 2024
goatgoose
approved these changes
May 31, 2024
api/s2n.h
Outdated
| * - Optional: Request the client's certificate and validate it. If no certificate is received then | ||
| * no validation is performed. | ||
| * - Required: Request the client's certificate and validate it. Abort the handshake if a client | ||
| * certificate is not received. |
There was a problem hiding this comment.
nit: the spacing here is still inconsistent. I would either remove all of the newline indenting or fix this one.
Suggested change
| * certificate is not received. | |
| * certificate is not received. |
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.
Description of changes:
s2n-tls has a concept of
s2n_cert_auth_typewhich controls handshake behavior depending on the type of connection (server vs client). This behavior is complex and undocumented. This PR attempts to document the behavior.Callout:
The default behavior was recently changed in #4390
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.