Update get_client_cert_chain API documentation #4260
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
goatgoose
force-pushed
the
client-cert-getter-docs
branch
from
da298e8 to
798f97a
Compare
goatgoose
force-pushed
the
client-cert-getter-docs
branch
from
798f97a to
d1eb3e4
Compare
lrstewart
approved these changes
Oct 25, 2023
maddeleine
approved these changes
Oct 25, 2023
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:
Currently the
s2n_connection_get_client_cert_chain()API documentation is a bit unclear as to what's being retrieved. The output argument is called "der_cert_chain_out", which implies that the output is just a list of DER-encoded certificates. Without reading the client_cert code, it's not clear that this function actually returns the certificate chain as received from the client, which includes length values prepending each DER-encoding.This PR updates the API documentation to make this more clear.
Testing:
Documentation change - no new tests.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.