vault

package
v0.3.0-beta.32 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2026 License: MIT Imports: 20 Imported by: 0

Documentation

Overview

Package vault owns encrypted daemon-managed secret material.

Index

Constants

View Source
const (
	// MCPUserScope identifies user-owned MCP credentials.
	MCPUserScope = "user"
	// MCPProfileScope identifies profile-owned MCP credentials.
	MCPProfileScope = "profile"
	// MCPWorkspaceScope identifies workspace-owned MCP credentials.
	MCPWorkspaceScope = "workspace"
	// MCPWorkspaceProfileScope identifies a workspace and profile credential cell.
	MCPWorkspaceProfileScope = "workspace_profile"
	// MCPSharedRefPrefix identifies MCP secrets explicitly shared across owners.
	MCPSharedRefPrefix = "vault:mcp/shared/"
)
View Source
const MCPManualOwner = "manual"
View Source
const (
	// ProfileSecretRefPrefix is the root of profile-owned credential refs.
	ProfileSecretRefPrefix = "vault:profiles/"
)

Variables

View Source
var (
	// ErrSecretNotFound reports that a secret reference has no stored value.
	ErrSecretNotFound = errors.New("vault: secret not found")
	// ErrUnsupportedSecretRef reports that a launch binding uses an unsupported reference scheme.
	ErrUnsupportedSecretRef = errors.New("vault: unsupported secret ref")
	// ErrMissingSecret reports that a required env or secret reference resolved to no value.
	ErrMissingSecret = errors.New("vault: secret value missing")
)
View Source
var EnvNamePattern = regexp.MustCompile(`^[A-Za-z_][A-Za-z0-9_]*$`)

EnvNamePattern is the daemon-wide grammar for environment variable names.

View Source
var (

	// ErrProfileSecretEnvForbidden marks process-environment refs rejected for profile-owned credentials.
	ErrProfileSecretEnvForbidden = errors.New("vault: profile secret env ref forbidden")
)

Functions

func EnvNameFromRef

func EnvNameFromRef(ref string) (string, error)

EnvNameFromRef returns the validated environment variable name in an env: ref.

func ExtensionProfileSecretOwnerPrefix

func ExtensionProfileSecretOwnerPrefix(extension, profileID, workspaceID string) string

ExtensionProfileSecretOwnerPrefix returns the profile-aware binding owner prefix. An empty profile keeps the shared user-layer namespace.

func ExtensionProfileSecretRef

func ExtensionProfileSecretRef(extension, profileID, workspaceID, envName string) string

ExtensionProfileSecretRef returns the conventional ref for one profile-aware binding.

func ExtensionSecretOwnerPrefix

func ExtensionSecretOwnerPrefix(extension, workspaceID string) string

ExtensionSecretOwnerPrefix returns the instance-qualified extension Vault prefix ending in a slash.

func ExtensionSecretRef

func ExtensionSecretRef(extension, workspaceID, envName string) string

ExtensionSecretRef returns the conventional Vault ref for one extension env binding.

func IsEnvRef

func IsEnvRef(ref string) bool

IsEnvRef reports whether a ref points at an operator-managed environment variable.

func IsSecretRef

func IsSecretRef(ref string) bool

IsSecretRef reports whether a ref points at Compozy-managed encrypted storage.

func ListProfileSecretPrefixes

func ListProfileSecretPrefixes(ctx context.Context, q profileRefSQLQueryer, name string) ([]string, error)

ListProfileSecretPrefixes includes standalone credentials as well as refs used by live MCP authorization rows.

func MCPOwnerSegment

func MCPOwnerSegment(ownerID string) (string, error)

MCPOwnerSegment returns a collision-safe Vault path segment for an MCP credential owner identifier. Grammar-safe identifiers remain readable; reserved or unsafe values use a deterministic hex encoding.

func MCPSecretOwnerPrefix

func MCPSecretOwnerPrefix(target MCPSecretTarget) (string, error)

MCPSecretOwnerPrefix returns the canonical scope-qualified Vault prefix for one MCP server. The returned value always ends with a slash.

func MCPServerSegment

func MCPServerSegment(serverName string) (string, error)

MCPServerSegment returns a collision-safe Vault path segment for an MCP server name while preserving the exact server name as the runtime identity.

func NormalizeMCPClientSecretRef

func NormalizeMCPClientSecretRef(ref string, target MCPSecretTarget) (string, error)

NormalizeMCPClientSecretRef enforces configured client-secret ownership before resolution.

func NormalizeMCPOwner

func NormalizeMCPOwner(owner string) string

NormalizeMCPOwner treats an omitted owner as manual.

func NormalizeRef

func NormalizeRef(ref string) string

NormalizeRef returns the trimmed secret ref used by stores and resolvers.

func ProfileSecretOwnerPrefix

func ProfileSecretOwnerPrefix(profileName, ownerKind, owner string) (string, error)

ProfileSecretOwnerPrefix returns the canonical owner-qualified prefix ending in a slash.

func RefMatchesPrefix

func RefMatchesPrefix(ref string, prefix string) bool

RefMatchesPrefix reports whether ref is exactly prefix or is nested below it.

func RenameProfileSecretRef

func RenameProfileSecretRef(ref, oldName, newName string) string

RenameProfileSecretRef translates only references owned by the renamed profile.

func SecretLikeEnvName

func SecretLikeEnvName(name string) bool

SecretLikeEnvName reports whether an environment variable name conventionally carries durable credential material and should be declared through secret_env.

func SecretRefNamespace

func SecretRefNamespace(ref string) (string, error)

SecretRefNamespace returns the first path segment for a validated vault ref.

func SecretRefPrefixNamespace

func SecretRefPrefixNamespace(prefix string) (string, error)

SecretRefPrefixNamespace returns the first path segment for a validated vault ref prefix.

func ValidateExtensionSecretRefOwner

func ValidateExtensionSecretRefOwner(ref, extension string) error

ValidateExtensionSecretRefOwner checks the extension segment, without validating the workspace or profile instance.

func ValidateMCPOwner

func ValidateMCPOwner(owner string) error

func ValidateMCPSecretRefAccess

func ValidateMCPSecretRefAccess(ref string, target MCPSecretTarget) error

ValidateMCPSecretRefAccess permits only the target server's owned refs or the explicit shared namespace.

func ValidateNamespace

func ValidateNamespace(namespace string) error

ValidateNamespace reports whether namespace is one of Compozy's durable vault namespaces.

func ValidateNonSecretEnvMap

func ValidateNonSecretEnvMap(path string, env map[string]string) error

ValidateNonSecretEnvMap rejects literal env maps that appear to carry secrets.

func ValidateProfileScopedRef

func ValidateProfileScopedRef(ref, profileName string) error

ValidateProfileScopedRef rejects machine-wide env refs and enforces profile ownership for vault refs.

func ValidateProfileSecretRefAccess

func ValidateProfileSecretRefAccess(ref, profileName string) error

ValidateProfileSecretRefAccess permits only refs owned by the acting profile.

func ValidateRef

func ValidateRef(ref string) error

ValidateRef reports whether ref uses Compozy's supported env: or vault: grammar.

func ValidateRefNamespace

func ValidateRefNamespace(ref string, namespace string) error

ValidateRefNamespace reports whether ref uses env: or the requested vault namespace.

func ValidateSecretEnvMap

func ValidateSecretEnvMap(path string, namespace string, secretEnv map[string]string) error

ValidateSecretEnvMap validates env-name to secret-ref bindings for one vault namespace.

func ValidateSecretRef

func ValidateSecretRef(ref string) error

ValidateSecretRef reports whether ref belongs to one of Compozy's durable vault namespaces.

func ValidateSecretRefNamespace

func ValidateSecretRefNamespace(ref string, namespace string) error

ValidateSecretRefNamespace reports whether ref is a vault ref in the requested namespace.

func ValidateSecretRefPrefix

func ValidateSecretRefPrefix(prefix string) error

ValidateSecretRefPrefix reports whether prefix can safely filter Compozy vault refs.

Types

type KeyProvider

type KeyProvider interface {
	Key() ([]byte, error)
}

KeyProvider loads the daemon-local vault encryption key.

func NewFileKeyProvider

func NewFileKeyProvider(homeDir string, lookupEnv func(string) (string, bool)) KeyProvider

NewFileKeyProvider returns a non-interactive key provider backed by COMPOZY_VAULT_KEY or a 0600 key file.

type MCPDCRSecretRefs

type MCPDCRSecretRefs struct {
	ClientSecretRef            string
	RegistrationAccessTokenRef string
}

MCPDCRSecretRefs identifies the Vault locations for one MCP OAuth client registration.

func MCPDCRSecretRefsForTarget

func MCPDCRSecretRefsForTarget(target MCPSecretTarget) (MCPDCRSecretRefs, error)

MCPDCRSecretRefsForTarget returns the canonical Vault refs for one MCP OAuth registration.

type MCPSecretTarget

type MCPSecretTarget struct {
	Scope       string
	WorkspaceID string
	ServerName  string
	Owner       string
}

MCPSecretTarget carries only the identity needed to address MCP credentials. It keeps the Vault boundary independent of the OAuth/config packages.

type Metadata

type Metadata struct {
	Ref       string
	Kind      string
	Present   bool
	CreatedAt time.Time
	UpdatedAt time.Time
}

Metadata is a redacted vault row safe for operator-facing status surfaces.

type Option

type Option func(*Service)

Option customizes the vault service.

func WithLookupEnv

func WithLookupEnv(lookup func(string) (string, bool)) Option

WithLookupEnv injects env lookup for tests and daemon composition.

func WithNow

func WithNow(now func() time.Time) Option

WithNow injects the service clock.

type ProfileRefRewrite

type ProfileRefRewrite struct {
	Location string
	OldRef   string
	NewRef   string
}

ProfileRefRewrite identifies one persisted ref mutation included in a profile rename.

func ListProfileRefRewrites

func ListProfileRefRewrites(
	ctx context.Context,
	q profileRefSQLQueryer,
	oldName string,
	newName string,
) ([]ProfileRefRewrite, error)

ListProfileRefRewrites enumerates every persisted ref occurrence touched by a rename.

type ProfileRefRewriter

type ProfileRefRewriter struct {
	// contains filtered or unexported fields
}

ProfileRefRewriter rebinds profile-owned ciphertext and every daemon-owned ref atomically in a caller transaction.

func NewProfileRefRewriter

func NewProfileRefRewriter(keys KeyProvider) (*ProfileRefRewriter, error)

NewProfileRefRewriter constructs the profile lifecycle ref rewriter.

func (*ProfileRefRewriter) RewriteProfileRefs

func (r *ProfileRefRewriter) RewriteProfileRefs(
	ctx context.Context,
	exec profileRefSQLExecutor,
	oldName string,
	newName string,
	updatedAt string,
) error

RewriteProfileRefs re-encrypts vault rows under their new AAD identity and updates every stored ref occurrence.

type ProfileSecretError

type ProfileSecretError struct {
	Code    string
	Message string
	Action  string
	Cause   error
}

ProfileSecretError is a stable operator-facing validation error.

func (*ProfileSecretError) Error

func (e *ProfileSecretError) Error() string

func (*ProfileSecretError) Unwrap

func (e *ProfileSecretError) Unwrap() error

type ProfileSecretRef

type ProfileSecretRef struct {
	ProfileName string
	OwnerKind   string
	Owner       string
	Key         string
}

ProfileSecretRef is one parsed profile-owned credential reference.

func ParseProfileSecretRef

func ParseProfileSecretRef(ref string) (ProfileSecretRef, error)

ParseProfileSecretRef parses the exact profile credential grammar.

type Record

type Record struct {
	Ref            string
	Kind           string
	EncryptedValue string
	CreatedAt      time.Time
	UpdatedAt      time.Time
}

Record is one encrypted vault row. EncryptedValue must never contain plaintext.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service resolves env-backed and vault-backed secret references.

func NewService

func NewService(store Store, keys KeyProvider, opts ...Option) (*Service, error)

NewService constructs a vault service.

func (*Service) DeleteSecret

func (s *Service) DeleteSecret(ctx context.Context, ref string) error

DeleteSecret removes one vault-backed ref.

func (*Service) GetMetadata

func (s *Service) GetMetadata(ctx context.Context, ref string) (Metadata, error)

GetMetadata returns redacted metadata for one vault-backed ref.

func (*Service) ListMetadata

func (s *Service) ListMetadata(ctx context.Context, prefix string) ([]Metadata, error)

ListMetadata returns redacted metadata for a ref prefix.

func (*Service) PutSecret

func (s *Service) PutSecret(ctx context.Context, ref string, kind string, plaintext string) (Metadata, error)

PutSecret encrypts and stores one vault-backed secret ref.

func (*Service) ResolveRef

func (s *Service) ResolveRef(ctx context.Context, ref string) (string, error)

ResolveRef resolves env: and vault: refs to plaintext for launch-time injection.

type Store

type Store interface {
	PutVaultSecret(ctx context.Context, record Record) error
	GetVaultSecret(ctx context.Context, ref string) (Record, error)
	ListVaultSecrets(ctx context.Context, prefix string) ([]Record, error)
	DeleteVaultSecret(ctx context.Context, ref string) error
}

Store persists encrypted vault records.

Jump to

Keyboard shortcuts

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