secrets

package

v0.1.66 Latest Latest Go to latest Published: Sep 8, 2026 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Geogboe/boxy

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package secrets provides explicit server-owned secret backends.

Index ¶

Variables
func PoolBootstrapKey(poolName string) string
func ResourceCredentialKey(resourceID string) string
type Backend
type Config
type Store
- func Open(cfg Config) (Store, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotFound        = errors.New("secret not found")
	ErrBackendRequired = errors.New("secret backend is required")
	ErrUnsupported     = errors.New("secret backend is unsupported on this platform")
)

Functions ¶

func PoolBootstrapKey ¶

func PoolBootstrapKey(poolName string) string

func ResourceCredentialKey ¶

func ResourceCredentialKey(resourceID string) string

Types ¶

type Backend ¶

type Backend string

const (
	BackendFile    Backend = "file"
	BackendKeyring Backend = "keyring"
	BackendDPAPI   Backend = "dpapi"
)

type Config ¶

type Config struct {
	Backend Backend
	Path    string
	Service string
}

Config selects exactly one secret backend. There is intentionally no automatic fallback: the deployment must make its storage posture explicit.

type Store ¶

type Store interface {
	Get(context.Context, string) ([]byte, error)
	Put(context.Context, string, []byte) error
	Delete(context.Context, string) error
	Check() error
}

Store is the runtime secret contract. Keys are logical Boxy keys, never provider paths or user-visible credential values.

func Open ¶

func Open(cfg Config) (Store, error)

Open constructs the selected backend.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL