Skip to content

chore(docs): 📝 Clarify crypto documentation - #15

Merged
haskou merged 2 commits into
masterfrom
chore/clarify-crypto-docs
Jun 8, 2026
Merged

chore(docs): 📝 Clarify crypto documentation#15
haskou merged 2 commits into
masterfrom
chore/clarify-crypto-docs

Conversation

@haskou

@haskou haskou commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Clarify Ed25519, X25519, SHA-256, and AES-256-GCM roles in README crypto docs.
  • Update technical documentation for payload encryption, encrypted private key formats, legacy decryption, and security caveats.
  • Remove ambiguous ECIES wording and document that the payload format is library-specific, not HPKE, and not post-quantum.
  • Correct the documented payload encryption cap to 1 MiB.

Validation

  • Ran crypto test suite: yarn test tests/value-objects/crypto --runInBand.
  • Ran git diff --check.
  • Checked documentation for stale crypto wording such as ECIES and 2048.

@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fbef0a85e8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
@haskou
haskou merged commit 525f28b into master Jun 8, 2026
3 checks passed
@haskou
haskou deleted the chore/clarify-crypto-docs branch June 8, 2026 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant