docs: document s2n_cert_auth_type behavior #4454
Open
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
| @@ -2291,7 +2291,31 @@ S2N_API extern int s2n_shutdown_send(struct s2n_connection *conn, s2n_blocked_st | |||
| /** | |||
| * Used to declare what type of client certificate authentication to use. | |||
| * | |||
| * Currently the default for s2n-tls is for neither the server side or the client side to use Client (aka Mutual) authentication. | |||
| * A s2n_connection will enforce client certificate authentication (mTLS) differently based on | |||
There was a problem hiding this comment.
Okay a couple of thoughts:
- The API guide isn't really a good fit for in-depth discussions about behavior. Maybe the discussion about the default behavior is better suited to the Usage Guide, in the Client / Mutual Auth section? I dunno, you could play around with it and see if some of this information works better there.
- You should probably take a step back if you're starting to discuss specific messages sent in the TLS handshake. Users don't care about this level of detail, they are at minimum skimming these docs and probably aren't going to read it if it goes too in-depth. The important bits are: what errors could occur with these different options, and what validation they will get with these different options. So for example:
S2N_CERT_AUTH_OPTIONAL: Server requests a client certificate but does not error if the client doesn't send one. The certificate is validated if the client sends one.
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.