-
Notifications
You must be signed in to change notification settings - Fork 93
feat: tls #261
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
feat: tls #261
Conversation
@thomaseizinger can you help review this? (Took liberty of unassigning Marten to help spread the load.) |
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.
Who is the audience of this document?
It starts out very high-level ("What is TLS") but gets detailed fairly quickly, explaining the messages in the handshake. Hence, for someone who's got no idea what TLS is, most of this document is probably overwhelming.
Given that libp2p is just using libp2p in a particular configuration, (i.e. we didn't build it from scratch) I'd recommend the following:
- Retain the super high-level description (i.e. "What is TLS"). This provides some context on what we are talking about.
- From there, link to useful material for people that want to understand TLS in detail (RFC, perhaps Wikipedia for the historical bit)
- Describe that libp2p uses a particular subset, most notably TLS 1.3+
- For any details, we can link to our spec: https://github.com/libp2p/specs/blob/master/tls/tls.md
Hope this helps :)
Co-authored-by: Marten Seemann <martenseemann@gmail.com>
Co-authored-by: Marten Seemann <martenseemann@gmail.com>
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! Thanks for incorporating the review :)
thanks @thomaseizinger and @marten-seemann! available to re-review @marten-seemann |
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.
It would be nice to have an introduction sentence saying that TLS is one of the security handshakes used to secure transports that don't have built-in security (TCP, WebSocket), and also mention that Noise is an alternative option. That would motivate the rest of this document.
Other than that, this looks good to me.
Added an introductory statement. Based on the feedback here, I'll also simplify and update the Noise document I worked. |
additional statement added in the introduction and checked off by reviewers
Context
Latest preview
Please view the latest Fleek preview here.