README
¶
OpenKCM: Krypton
About this project
OpenKCM Krypton is a manging key materials.
Getting Started
Since this project requires GOEXPERIMENT=runtimesecret, add the following line to your environment variables:
echo 'export GOEXPERIMENT=runtimesecret' >> ~/.zshrc
make test # run tests
make lint # run linter
make dev # start postgres + Krypton server locally
make cli # build and install the Krypton CLI
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright (20xx-)20xx SAP SE or an SAP affiliate company and OpenKCM contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
Directories
¶
| Path | Synopsis |
|---|---|
|
state
Package state provides local CLI state management.
|
Package state provides local CLI state management. |
|
cmd
|
|
|
agent
command
|
|
|
root
command
|
|
|
internal
|
|
|
cryptor
Package cryptor defines cryptographic interfaces for multi-tenant encrypt/decrypt operations.
|
Package cryptor defines cryptographic interfaces for multi-tenant encrypt/decrypt operations. |
|
cryptor/aes256gcm
Package aes256gcm provides an AES-256-GCM cryptor.Cryptor implementation.
|
Package aes256gcm provides an AES-256-GCM cryptor.Cryptor implementation. |
|
cryptor/staticsecret
Package staticsecret provides a cryptor.Sealer that embeds a fixed AES-256-GCM key, removing the need for callers to supply secrets per-request.
|
Package staticsecret provides a cryptor.Sealer that embeds a fixed AES-256-GCM key, removing the need for callers to supply secrets per-request. |
|
handler/announcekey
Package announcekey contains the manager-side (root) job handler and the operator-side (agent) task handler for the "announce-key" reconciliation flow.
|
Package announcekey contains the manager-side (root) job handler and the operator-side (agent) task handler for the "announce-key" reconciliation flow. |
|
keylifecycle
Package keylifecycle manages cryptographic key lifecycle states and transition validation per NIST SP 800-57 Part 1 Rev 5.
|
Package keylifecycle manages cryptographic key lifecycle states and transition validation per NIST SP 800-57 Part 1 Rev 5. |
|
secret
Package secret defines interfaces for loading cryptographic key material from external sources (environment variables, files, vaults, etc.).
|
Package secret defines interfaces for loading cryptographic key material from external sources (environment variables, files, vaults, etc.). |
|
secret/envvar
Package envvar provides a secret source that loads key material from a base64-encoded environment variable.
|
Package envvar provides a secret source that loads key material from a base64-encoded environment variable. |
|
securemem
Package securemem provides utilities for secure memory management.
|
Package securemem provides utilities for secure memory management. |
|
securemem/test/cleanup
command
Test helper binary for cleanup_test.go.
|
Test helper binary for cleanup_test.go. |
|
securemem/test/dump
command
|
|
|
securemem/test/readonlydata
command
|
|
|
securemem/test/readonlyrun
command
|
|
|
worker
Package worker provides a simple periodic task scheduler.
|
Package worker provides a simple periodic task scheduler. |
|
pkg
|
|
|
authn
Package authn provides low-level authentication primitives and interfaces for verifying credentials, validating tokens, and managing authentication state.
|
Package authn provides low-level authentication primitives and interfaces for verifying credentials, validating tokens, and managing authentication state. |