Skip to content

docs: update benchmarks and docs for encryption at rest#82

Merged
kacy merged 3 commits intomainfrom
docs/encryption-benchmarks
Feb 10, 2026
Merged

docs: update benchmarks and docs for encryption at rest#82
kacy merged 3 commits intomainfrom
docs/encryption-benchmarks

Conversation

@kacy
Copy link
Owner

@kacy kacy commented Feb 10, 2026

summary

  • adds bench/bench-encryption.sh — a focused benchmark script that compares persistence throughput with and without AES-256-GCM encryption, following existing script patterns
  • updates all relevant docs (root README, bench README, persistence README, server README, SECURITY.md) to reflect the encryption at rest feature from feat: encryption at rest (AES-256-GCM) #81
  • bumps test count from 886 → 906

what was tested

  • bash -n bench/bench-encryption.sh passes syntax check
  • all doc changes reviewed for consistency with each other and with the actual --encryption-key-file flag in the server

design considerations

the benchmark script runs two ember instances side-by-side (plaintext vs encrypted) on different ports with temp data dirs and a random key file, cleaned up on exit. results tables in bench/README.md are left as placeholders to be filled after running on a dedicated VM — didn't want to include local laptop numbers that won't be reproducible.

kacy added 3 commits February 10, 2026 10:31
compares persistence throughput with and without AES-256-GCM
encryption. runs two ember instances (plaintext vs encrypted)
and reports side-by-side results with overhead percentages.
- bench/README.md: encryption overhead section, script entry, build note
- README.md: encryption feature, config flag, quickstart example,
  test count 886 → 906, security note
- ember-persistence/README.md: encryption module, v3 format docs
- ember-server/README.md: encryption example with feature flag
- SECURITY.md: encryption at rest section with key management guidance
- benchmark.rs: use `is_ascii_lowercase()` instead of manual range check
- cluster.rs: use `(0..16384).contains()` instead of manual comparison
@kacy kacy merged commit a7456ac into main Feb 10, 2026
7 checks passed
@kacy kacy deleted the docs/encryption-benchmarks branch February 10, 2026 15:37
kacy added a commit that referenced this pull request Feb 11, 2026
* bench: add encryption overhead benchmark script

compares persistence throughput with and without AES-256-GCM
encryption. runs two ember instances (plaintext vs encrypted)
and reports side-by-side results with overhead percentages.

* docs: update benchmarks and docs for encryption at rest

- bench/README.md: encryption overhead section, script entry, build note
- README.md: encryption feature, config flag, quickstart example,
  test count 886 → 906, security note
- ember-persistence/README.md: encryption module, v3 format docs
- ember-server/README.md: encryption example with feature flag
- SECURITY.md: encryption at rest section with key management guidance

* fix: resolve clippy warnings for range contains patterns

- benchmark.rs: use `is_ascii_lowercase()` instead of manual range check
- cluster.rs: use `(0..16384).contains()` instead of manual comparison
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