Files
alknet/tasks/architecture/spec-secret-service.md
glm-5.1 19b3d3a078 docs: write Phase 0 architecture foundation — ADRs 026-034, spec docs, and task updates
Phase 0a — ADRs (9 new):
- ADR-026: Transport/interface separation (three-layer model)
- ADR-027: Crate decomposition (core, secret, storage, flowgraph, napi, CLI)
- ADR-028: Auth as irpc service (AuthProtocol behind feature flag)
- ADR-029: Identity as core type (Identity + IdentityProvider in alknet-core)
- ADR-030: Static/dynamic config split (ArcSwap, ConfigReloadHandle)
- ADR-031: Forwarding policy (rule-based allow/deny, TransportKind-aware)
- ADR-032: Event boundary discipline (domain, irpc, call protocol boundaries)
- ADR-033: OperationEnv universal composition (three dispatch paths)
- ADR-034: Head/worker terminology (replace hub/spoke)

Phase 0b — New spec documents (7):
- identity.md, services.md, interface.md, configuration.md,
  storage.md, flowgraph.md, secret-service.md

Updated existing docs:
- auth.md: reference identity.md for canonical definitions, add AuthProtocol
- open-questions.md: resolve OQ-12, OQ-16, OQ-18, OQ-22, OQ-23-25
- README.md: add all new docs, ADRs 026-034

Marked 19 architecture tasks as completed.
2026-06-07 09:32:58 +00:00

2.9 KiB

id, name, status, depends_on, scope, risk, impact, level
id name status depends_on scope risk impact level
architecture/spec-secret-service Create secret-service.md architecture spec completed
architecture/adr-027-crate-decomposition
architecture/adr-032-event-boundary-discipline
narrow low component implementation

Description

Create docs/architecture/secret-service.md — a new architecture spec for the alknet-secret crate and its SecretProtocol irpc service.

This slides from the research in docs/research/services.md (SecretProtocol definition) and docs/research/storage.md (secrets section, key derivation paths). The secret service is well-bounded: BIP39 mnemonics, SLIP-0010 Ed25519 HD key derivation, AES-256-GCM encryption for external credentials, and a lock/unlock lifecycle.

Scope: alknet-secret crate definition, not alknet-core changes.

Key content from research:

  • SecretProtocol enum: Unlock, Lock, DeriveEd25519, DeriveEncryptionKey, DeriveEthereumKey, DerivePassword, Encrypt, Decrypt
  • DerivedKey, KeyType, EncryptedData types
  • Security model: locked/unlocked states, seed in RAM only, never on disk
  • Derivation path constants (SLIP-0044 coin type 74')
  • Event boundary: SecretService domain events (honker streams for key derivation notifications) stay internal. External consumers use irpc calls or call protocol operations that project to integration events.

Acceptance Criteria

  • docs/architecture/secret-service.md exists with YAML frontmatter (status: draft)
  • Follows spec format: What, Why, Architecture, Constraints, Open Questions, Design Decisions
  • Documents BIP39 mnemonic generation and seed derivation
  • Documents SLIP-0010 Ed25519 HD key derivation (SLIP-0044 coin type 74')
  • Documents AES-256-GCM encryption/decryption for external credentials
  • Documents SecretProtocol irpc service: Unlock, Lock, DeriveEd25519, DeriveEncryptionKey, Encrypt, Decrypt variants
  • Documents EncryptedData type (key_version, salt, iv, ciphertext)
  • Documents derivation path constants
  • Documents security model: locked/unlocked states, seed lifecycle, never persisted
  • States crate dependencies: bip39, ed25519-bip32, aes-gcm, sha2, irpc
  • States crate does NOT depend on alknet-core or alknet-storage
  • States interface back to core: EncryptedData format referenced by alknet-storage (wire format compatibility, not crate dependency)
  • Event boundary per ADR-032: honker streams internal, irpc calls internal, no direct EventEnvelope emission
  • References ADR-027, ADR-032
  • docs/architecture/README.md updated to include secret-service.md

References

  • docs/research/services.md — SecretProtocol definition, DerivedKey, KeyType, EncryptedData
  • docs/research/storage.md — secrets section, key derivation paths
  • docs/research/integration-plan.md — Phase 2.1 (alknet-secret)

Notes

To be filled by implementation agent

Summary

To be filled on completion