Stian/Shade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
3243647aa1d7f4b8c90d3162bf1bdca3821507d1
Shade/docs/archive/V3.5.md
Sterister e6fdf31b49
Some checks failed
Test / test (push) Has been cancelled
Details
Cross-platform vectors / TypeScript vectors (bun) (push) Has been cancelled
Details
Cross-platform vectors / Kotlin vectors (gradle) (push) Has been cancelled
Details
Docker build and publish / docker (push) Has been cancelled
Details
Publish / publish (push) Has been cancelled
Details
release(v4.0.0): Shade GA — V3.x consolidation + audit prep 
V3.1 → V3.12 consolidated and tagged for the first GA release. Wire
format unchanged from 0.4.x — 4.0 peers interoperate with 0.4.x peers
byte-for-byte. The version bump is semantic: audit-cycle complete,
opt-in surface fully exposed, threat model refreshed for every new
surface.

Highlights:
- All 24 @shade/* packages bumped to 4.0.0 in lockstep.
- CHANGELOG 4.0.0 section is the canonical manifest of what landed.
- THREAT-MODEL extended (§10 fingerprint gates, §11 WebRTC P2P, §12
  Web-Worker boundary) + residual-risks table refreshed.
- OpenAPI now covers all 27 routes: prekey, transfer, KT, inbox,
  bridge, observer, /metrics, /healthz, /ready.
- MIGRATION 0.3.x → 4.0 documented + smoke-tested against
  shade migrate-storage on a real SQLite DB.
- docs/audit/REVIEW-BUNDLE.md + SCOPE.md ready for external reviewer.
- scripts/soak.ts harness for the GA-stable 2-week soak window.
- All V*.md plans archived under docs/archive/ with Status: Done.
- Voice/Video carved out into V5.0; 4.0 audit focuses on the frozen
  non-realtime stack.

Tests: TS 1000/1000 + Kotlin 11/11 cross-platform vectors green.
Docker: gt.zyon.no/stian/shade-prekey:4.0.0 builds and reports
  version 4.0.0 on /health.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 18:35:35 +02:00

4.0 KiB
Raw Blame History

Shade V3.5 — Android Parity & Cross-Platform CI

Status: Done (kryptografisk lag + CI-gate). Android-KeystoreStorage og scrypt/argon2id-paritet er post-GA-arbeid sporet i android/shade-android/ROADMAP-ANDROID.md — ikke en 4.0 GA-blocker. Effort: XL (2–4 måneder, parallelliserbar) Forrige: V3.1 Adresserer: V2.1 §3

Mål

Gjør Kotlin-implementasjonen byte-kompatibel med TS-implementasjonen, og forsegle paritet via CI-gate som kjører delte test-vectors i begge språk. Ingen "production"-label på Android før ratchet + proto + streams 0x11 er grønne.

Scope

Inn — paritet-sjekkpunkter (eksplisitt)

  1. KDF-chain — root key + chain key derivasjoner. Vector: test-vectors/kdf-chain.json.
  2. HKDF — labels for info-felt. Vector: test-vectors/hkdf.json.
  3. X3DH — full agreement med samme bundles. Vector: test-vectors/x3dh.json.
  4. Ratchet message — encrypt/decrypt roundtrip (legg til vector).
  5. Fingerprint — 60-digit safety number. Vector: test-vectors/fingerprint.json.
  6. Wire format 0x02 — encode/decode. Vector: test-vectors/wire-format.json.
  7. Streams 0x11 — multi-lane chunk encryption (M-Cross 3, ikke i M-Cross 1).
  8. Backup-format — passphrase-basert KDF + AES-GCM payload.

Inn — milestoner

  • M-Cross 1 ✅ — keys + HKDF + X3DH + fingerprint.
  • M-Cross 2 ✅ — ratchet step (encrypt + decrypt roundtrip) + wire 0x02 (RatchetMessage + PreKeyMessage med/uten OTPK). Vector-versjon 2.
  • M-Cross 3 ✅ — streams 0x11 (KDF, deterministic chunk nonce/AAD, wire 0x11 encode/decode). End-to-end socket interop pending; ikke gating-blokker.
  • M-Cross 4 ✅ — backup-format HKDF + AEAD, gruppe sender-keys (kdfChainKey + Ed25519 sign(aad ‖ ct)), storage-HKDF (storageKey, fieldKey, rowNonce). Gjenstående: scrypt master-key (Bouncy Castle), argon2id-bytte, Android-KeystoreStorage som søsken-modul.

Inn — CI

  • Gitea Actions matrix-job:
    • Bun-runner kjører bun test:vectors mot test-vectors/*.json.
    • Gradle-runner kjører ./gradlew vectorTests mot samme filer.
    • PR-gate: begge må passere.
  • Vector-genereringsskript (scripts/generate-vectors.ts) finnes — utvid til 7 + 8.

Ut

  • iOS — egen Swift-port er framtidig roadmap, ikke V3.5.
  • Native bindings i shade-android (vi bruker Tink i JVM-kode).

Leveranser

Kotlin

  • Full ratchet-implementasjon (M-Cross 2).
  • Wire 0x02 encode/decode.
  • Streams 0x11 (M-Cross 3).
  • Tink-storage-adapter med Keystore.

Test-vectors

  • Utvid scripts/generate-vectors.ts med ratchet-step + streams + backup.
  • Versjons-tag på vector-filer ({ "version": 2, ... }).

CI

  • .gitea/workflows/cross-vectors.yml — Bun + Gradle matrise.
  • Fail-policy: hvis vector-fil endres, begge runners må publisere passing før merge.

Dokumentasjon

  • android/shade-android/ROADMAP-ANDROID.md — eksplisitte milestoner + status per sjekkpunkt.
  • docs/cross-platform.md — hvordan legge til en ny vector + hvordan kjøre lokalt.

Akseptansekriterier

  • M-Cross 2: TS-encrypted melding kan dekrypteres av Kotlin-klient og omvendt, end-to-end-test.
  • CI-jobben feiler innen 60 s ved bevisst byte-divergens.
  • M-Cross 3: 1 MiB streams-fil over 4 lanes mellom TS-server og Kotlin-klient verifisert.
  • Ingen public release med "production"-label før M-Cross 2 er grønn.

Avhengigheter

  • V3.1 — cross-platform.md lever der.

Risiko

  • Tink-mismatch. Tink HKDF-info-encoding kan avvike fra @noble/hashes. Mitiger med tidlig vector-test (M-Cross 1 dekker dette).
  • Endian / encoding. Wire 0x02 bruker big-endian — Kotlin ByteBuffer default er big-endian, men streams-nonce-konstruksjon må gjennomgås.
  • Maintainer-kapasitet. Kotlin-port + TS-port må holdes i sync. Vector-CI er primær mitigasjon.

Migrasjon

Eksisterende M-Cross 1 scaffold beholdes; alt nytt bygges på den.

Reference in New Issue View Git Blame Copy Permalink