doc: gRPC SSL certificate documentation improvements#7731
Merged
ShahanaFarooqui merged 2 commits intoElementsProject:masterfrom Oct 21, 2024
Merged
Conversation
3d6322e to
6e0ace9
Compare
ShahanaFarooqui
requested changes
Oct 11, 2024
6e0ace9 to
6525778
Compare
Contributor
Author
|
Changed the |
6525778 to
85e5b95
Compare
Changelog-Added: Example documentation on generating custom gRPC certificates with SANs.
85e5b95 to
dad0676
Compare
Collaborator
|
Combined the last two commits into one as the second commit only added links to the content of the first. ACK 85e5b95. |
ShahanaFarooqui
approved these changes
Oct 13, 2024
This file contains hidden or 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
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.
Checklist
Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked:
Adds some additional documentation around generating custom gRPC SSL certificates.
gprcpage instead of redirecting toapp-development.Context
After struggling with properly generating custom certificates for a long time while trying to run the API under both Tor and SSL, as well as allow another local service to communicate with the gRPC APIs, I'm submitting the process that worked for me as candidate for documentation improvements. From memory, the problematic issues were:
SANfrom the original default certificate, includinglocalhost,127.0.0.1andclnetc.CNfor the "production" domain, but browsers and other common SSL client libraries complain that verification viaSANis required and throw an error (as of circa 2017?).Caveat
Not exactly an SSL expert here, so a review on best practices would be appreciated. I used the following resources to assemble this solution:
Also, this page suggests it could be possible to do this with a one-liner due to this
opensslcommit. Just saying, there may be a better way to do this.