Skip to content

[Epic] Encryption documentation #125

@chair28980

Description

@chair28980

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

To Do

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions