GovOPlaN/govoplan-encryption
2
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

[Feature] Provide a governed key-vault and key-lifecycle capability #2

New Issue
Closed
opened 2026-07-30 17:34:18 +02:00 by zemion · 2 comments
zemion commented 2026-07-30 17:34:18 +02:00
Owner
Copy Link
Copy Source

Implement the module-neutral key custody layer after the threat model is accepted.

Acceptance criteria

  • Stable capability contracts cover key creation/import, wrapping, rotation, revocation, destruction scheduling, recovery, and status/provenance.
  • Key material never crosses module capability boundaries as plaintext.
  • Tenant/scope isolation, policy provenance, recent-auth requirements, quorum recovery, and audit-safe events are enforced.
  • Providers can be local development, deployment KMS/HSM, or client-held without callers importing provider modules.
  • Secret values are redacted from logs, APIs, events, exceptions, and diagnostics.
  • Test vectors, failure injection, migration, backup/restore, and key-loss behavior are covered.
Implement the module-neutral key custody layer after the threat model is accepted. ## Acceptance criteria - Stable capability contracts cover key creation/import, wrapping, rotation, revocation, destruction scheduling, recovery, and status/provenance. - Key material never crosses module capability boundaries as plaintext. - Tenant/scope isolation, policy provenance, recent-auth requirements, quorum recovery, and audit-safe events are enforced. - Providers can be local development, deployment KMS/HSM, or client-held without callers importing provider modules. - Secret values are redacted from logs, APIs, events, exceptions, and diagnostics. - Test vectors, failure injection, migration, backup/restore, and key-loss behavior are covered.
zemion commented 2026-08-01 21:03:30 +02:00
Author
Owner
Copy Link
Copy Source

Codex State: progress

Summary

  • Implemented provider-neutral opaque key-operation contracts and SQL lifecycle state for provision/import references, rotation, revocation, destruction scheduling, status, recovery quorum, current high-assurance checks, audit-safe events, idempotency, outcome-unknown handling, and reconciliation.
  • This remains open because no concrete local/KMS/HSM/client-held cryptographic provider, provider conformance suite/test vectors, or target backup/restore and key-loss drill has been selected and proven.

Changed Files

  • src/govoplan_encryption/backend/service.py
  • src/govoplan_encryption/backend/db/models.py
  • src/govoplan_core/core/encryption.py

Verification

  • Encryption lifecycle/failure/recovery suite passed in GovOPlaN/govoplan-encryption@858c41d.

Suggested status label: status/in-progress

## Codex State: progress ### Summary - Implemented provider-neutral opaque key-operation contracts and SQL lifecycle state for provision/import references, rotation, revocation, destruction scheduling, status, recovery quorum, current high-assurance checks, audit-safe events, idempotency, outcome-unknown handling, and reconciliation. - This remains open because no concrete local/KMS/HSM/client-held cryptographic provider, provider conformance suite/test vectors, or target backup/restore and key-loss drill has been selected and proven. ### Changed Files - `src/govoplan_encryption/backend/service.py` - `src/govoplan_encryption/backend/db/models.py` - `src/govoplan_core/core/encryption.py` ### Verification - `Encryption lifecycle/failure/recovery suite passed in GovOPlaN/govoplan-encryption@858c41d.` Suggested status label: `status/in-progress`
zemion added
status
in-progress
 and removed
status
ready
 labels 2026-08-01 21:06:08 +02:00
zemion commented 2026-08-02 03:44:27 +02:00
Author
Owner
Copy Link
Copy Source

Codex State: done

Summary

  • Completed the provider-neutral key-material, key-vault, content-cipher, recovery, lifecycle, provenance, and disable-preflight contracts.
  • Added the bundled local_aesgcm server-envelope provider with AES-256-GCM, opaque SQL-wrapped vault/content keys, idempotent operations, rotation, revocation, scheduled cryptographic destruction, tenant binding, and failure injection.
  • Added real SQLite backup/restore and wrong-key/key-loss coverage. This closes the governed server-side reference implementation; it does not claim E2EE, HSM/KMS custody, or external certification.

Changed Files

  • src/govoplan_encryption/backend/local_provider.py
  • src/govoplan_encryption/backend/service.py
  • src/govoplan_encryption/backend/migrations/versions/e5b7c9d1f3a4_v0114_local_crypto_provider.py
  • tests/test_local_provider.py
  • docs/ENCRYPTION_BOUNDARY.md

Verification

  • 14 Encryption tests passed.
  • GovOPlaN consolidated focused module, migration, composition, and optional-permutation checks passed.
  • Pushed as 42f35f8; Core contracts are in 972c681.
## Codex State: done ### Summary - Completed the provider-neutral key-material, key-vault, content-cipher, recovery, lifecycle, provenance, and disable-preflight contracts. - Added the bundled local_aesgcm server-envelope provider with AES-256-GCM, opaque SQL-wrapped vault/content keys, idempotent operations, rotation, revocation, scheduled cryptographic destruction, tenant binding, and failure injection. - Added real SQLite backup/restore and wrong-key/key-loss coverage. This closes the governed server-side reference implementation; it does not claim E2EE, HSM/KMS custody, or external certification. ### Changed Files - `src/govoplan_encryption/backend/local_provider.py` - `src/govoplan_encryption/backend/service.py` - `src/govoplan_encryption/backend/migrations/versions/e5b7c9d1f3a4_v0114_local_crypto_provider.py` - `tests/test_local_provider.py` - `docs/ENCRYPTION_BOUNDARY.md` ### Verification - `14 Encryption tests passed.` - `GovOPlaN consolidated focused module, migration, composition, and optional-permutation checks passed.` - `Pushed as 42f35f8; Core contracts are in 972c681.`
zemion removed the codex/ready
status
in-progress
 labels 2026-08-02 03:46:53 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
HTTP API contracts, routers, schemas, or API smoke behavior.
 area/auth
Authentication, sessions, access bootstrap, or login behavior.
 area/db
Database sessions, models, transactions, or persistence primitives.
 area/devex
Local developer workflow, scripts, tests, tooling, or release helpers.
 area/docs
Durable documentation and project guidance.
 area/governance
Governance policy, audit, privacy, retention, or compliance behavior.
 area/marketing
Public website, product messaging, publication copy, or legal page content.
 area/migrations
Alembic migrations, schema bootstrap, or persistence evolution.
 area/module-system
Module discovery, manifests, capabilities, routing, or optional integrations.
 area/rbac
Permissions, roles, delegation, or authorization policy.
 area/release
Versioning, release locks, tags, packaging, or dependency pins.
 area/security
Security posture, static analysis, supply-chain hardening, or vulnerability remediation.
 area/tenancy
Tenant boundaries, provisioning, or tenant-scoped data behavior.
 area/webui
Shared WebUI shell, frontend components, routing, or frontend tests.
 audit/complexity
Complexity finding from Radon, Xenon, or equivalent maintainability scans.
 audit/duplication
Duplicated-code finding from jscpd or equivalent similarity scans.
 audit/false-positive
Audit finding reviewed as a narrow false positive or acceptable risk.
 audit/needs-design
Audit finding that needs an architectural or product decision before implementation.
 audit/quick-fix
Audit finding that appears narrow and directly fixable.
 audit/structural
Audit finding that needs design, refactoring, or behavior review.
 codex/needs-human
Needs an explicit human decision before Codex should implement.
 codex/ready
Suitable for Codex to pick up with the existing issue context.
 module/access
GovOPlaN access, identity, authentication, RBAC, and administration behavior.
 module/addresses
GovOPlaN Addresses module behavior or integration.
 module/admin
GovOPlaN Admin module behavior or integration.
 module/appointments
GovOPlaN Appointments module behavior or integration.
 module/approvals
GovOPlaN Approvals module behavior or integration.
 module/audit
GovOPlaN Audit module behavior or integration.
 module/calendar
GovOPlaN Calendar module behavior or integration.
 module/campaign
GovOPlaN campaign module behavior or integration.
 module/cases
GovOPlaN Cases module behavior or integration.
 module/committee
GovOPlaN Committee module behavior or integration.
 module/connectors
GovOPlaN Connectors module behavior or integration.
 module/core
GovOPlaN core runner, shared primitives, shell, or extension points.
 module/dashboard
GovOPlaN Dashboard module behavior or integration.
 module/dataflow
GovOPlaN Dataflow module behavior or integration.
 module/datasources
GovOPlaN governed datasource contracts, catalogs, and integrations.
 module/decisions
GovOPlaN formal Decisions module behavior or integration.
 module/dist-lists
GovOPlaN Distribution Lists module behavior or integration.
 module/dms
GovOPlaN Dms module behavior or integration.
 module/docs
GovOPlaN Docs module behavior or integration.
 module/encryption
GovOPlaN Encryption key custody, cryptographic policy, and E2EE integration.
 module/erp
GovOPlaN Erp module behavior or integration.
 module/evaluation
GovOPlaN Evaluation module behavior or integration.
 module/files
GovOPlaN files module behavior or integration.
 module/fit-connect
GovOPlaN Fit Connect module behavior or integration.
 module/forms
GovOPlaN Forms module behavior or integration.
 module/forms-runtime
GovOPlaN Forms Runtime module behavior or integration.
 module/helpdesk
GovOPlaN Helpdesk module behavior or integration.
 module/identity
GovOPlaN Identity module behavior or integration.
 module/identity-trust
GovOPlaN Identity Trust module behavior or integration.
 module/idm
GovOPlaN Idm module behavior or integration.
 module/ledger
GovOPlaN Ledger module behavior or integration.
 module/mail
GovOPlaN mail module behavior or integration.
 module/mandates
GovOPlaN Mandates, jurisdiction, responsibility, and authority behavior or integration.
 module/notifications
GovOPlaN Notifications module behavior or integration.
 module/ops
GovOPlaN Ops module behavior or integration.
 module/organizations
GovOPlaN Organizations module behavior or integration.
 module/parties
GovOPlaN procedure Parties, representation, and delivery-authority behavior or integration.
 module/payments
GovOPlaN Payments module behavior or integration.
 module/permits
GovOPlaN Permits module behavior or integration.
 module/policy
GovOPlaN Policy module behavior or integration.
 module/poll
GovOPlaN Poll module behavior or integration.
 module/portal
GovOPlaN Portal module behavior or integration.
 module/postbox
GovOPlaN Postbox module behavior or integration.
 module/projects
GovOPlaN Projects module behavior or integration.
 module/quick-access
GovOPlaN configurable task-local Quick Access behavior and integrations.
 module/records
GovOPlaN Records and eAkte lifecycle behavior or integration.
 module/reporting
GovOPlaN Reporting module behavior or integration.
 module/risk-compliance
GovOPlaN Risk Compliance module behavior or integration.
 module/scheduling
GovOPlaN Scheduling module behavior or integration.
 module/search
GovOPlaN Search module behavior or integration.
 module/services
GovOPlaN versioned institutional Services behavior or integration.
 module/tasks
GovOPlaN Tasks module behavior or integration.
 module/templates
GovOPlaN Templates module behavior or integration.
 module/tenancy
GovOPlaN Tenancy module behavior or integration.
 module/tickets
GovOPlaN Tickets module behavior or integration.
 module/views
GovOPlaN governed task views, interface projections, and workflow view integration.
 module/voting
GovOPlaN Voting module behavior or integration.
 module/wiki
GovOPlaN Wiki module behavior or integration.
 module/workflow
GovOPlaN Workflow module behavior or integration.
 module/workflow-engine
GovOPlaN Workflow Engine runtime, persistence, or integration.
 module/xoev
GovOPlaN Xoev module behavior or integration.
 module/xrechnung
GovOPlaN Xrechnung module behavior or integration.
 module/xta-osci
GovOPlaN Xta Osci module behavior or integration.
priority
p0
Immediate stop-the-line priority.
priority
p1
High priority for the next focused work window.
priority
p2
Normal planned priority.
priority
p3
Low priority or opportunistic cleanup.
source/backlog-import
Imported from markdown backlog, roadmap, plan, or TODO files.
 source/security-audit
Created from a structured security or code-quality audit report.
 source/todo-scan
Imported from inline TODO/FIXME/HACK markers by the Gitea TODO importer.
status
blocked
Cannot progress without a decision, dependency, credential, or external change.
status
in-progress
Currently being worked.
status
needs-info
Needs clarifying input before implementation can proceed safely.
status
ready
Ready for implementation.
status
triage
Needs review, ownership, priority, or acceptance criteria.
type
bug
A reproducible defect, regression, or incorrect behavior.
type
debt
Cleanup, refactoring, risk reduction, or deferred engineering work.
type
docs
Documentation, process, or developer workflow work.
type
feature
New user-visible behavior or platform capability.
type
task
Implementation, maintenance, migration, or operational work.
type
user-story
End-to-end user journey or real-world process story used to steer product slices.
No labels area/api area/security module/encryption
priority
p1
type
feature
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
govoplan-package-publisher zemion (Albrecht Degering)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: GovOPlaN/govoplan-encryption#2