Skip to content
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

[Epic] Encryption documentation #125

Open
3 of 4 tasks
chair28980 opened this issue Oct 18, 2023 · 4 comments
Open
3 of 4 tasks

[Epic] Encryption documentation #125

chair28980 opened this issue Oct 18, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@chair28980
Copy link
Contributor

chair28980 commented Oct 18, 2023

Summary

Issue:

Users are finding it challenging to understand and implement encryption properly with Waku. While Waku's approach to encryption is unopinionated, there is a need to provide clearer guidance for new developers.

Specific Concerns Raised:

  • Users assume that messages are encrypted by default on Waku.
  • Current documentation does not sufficiently explain why messages are not encrypted by default.
  • There's a lack of specific instructions or recommendations on how to perform encryption effectively.
  • Difficulty in locating and understanding the @waku/message-encryption package due to a lack of proper documentation.

Suggested Improvements

  • Improve documentation clarity around the fact that Waku does not handle encryption at the protocol level because it doesn't have knowledge of the communication parties. Articulate that Waku is flexible and unopinionated about encryption.

  • Provide comprehensive documentation on the @waku/message-encryption package, ensuring it's easily discoverable.

  • Outline steps on how to design an app/protocol leveraging Waku's encryption:

  • Guidance on how to acquire keys and exchange them.

  • Deciding when to use symmetric vs. asymmetric encryption.

  • Explain concepts like ECIES, Noise, and possibly highlight other supported encryption methods or where to seek further options.

  • different auth/encryption protocols available #26

@fryorcraken fryorcraken added this to Waku Oct 18, 2023
@LordGhostX
Copy link
Contributor

Weekly Update

  • next: begin work on encryption docs

@chair28980 chair28980 added the documentation Improvements or additions to documentation label Nov 14, 2023
@chair28980 chair28980 moved this to To Do in Waku Nov 14, 2023
@LordGhostX
Copy link
Contributor

Weekly Update

  • next: continue work on encryption docs

@LordGhostX
Copy link
Contributor

LordGhostX commented Dec 10, 2023

Weekly Update

@fryorcraken
Copy link
Contributor

Remaining task is noise-js

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: To Do
Development

No branches or pull requests

3 participants