Documentation
¶
Overview ¶
Package secrets provides secure storage for sensitive data using OS-native keyrings with automatic fallback to filesystem storage.
Index ¶
- Variables
- type Manager
- func (m *Manager) Delete(appName string, secretType SecretType) error
- func (m *Manager) Get(appName string, secretType SecretType) (string, StorageBackend, error)
- func (m *Manager) IsAvailable() bool
- func (m *Manager) Store(appName string, secretType SecretType, value string) (StorageBackend, error)
- type SecretType
- type StorageBackend
Constants ¶
This section is empty.
Variables ¶
var ( ErrNotFound = errors.New("secret not found") ErrTimeout = errors.New("keyring operation timeout") )
Common errors returned by the secrets manager
Functions ¶
This section is empty.
Types ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager handles secure storage and retrieval of secrets
func NewManager ¶
NewManager creates a new secrets manager with the specified fallback directory
func (*Manager) Delete ¶
func (m *Manager) Delete(appName string, secretType SecretType) error
Delete removes a secret from both keyring and filesystem
func (*Manager) Get ¶
func (m *Manager) Get(appName string, secretType SecretType) (string, StorageBackend, error)
Get retrieves a secret, trying keyring first then filesystem
func (*Manager) IsAvailable ¶
IsAvailable checks if encrypted keyring storage is available
func (*Manager) Store ¶
func (m *Manager) Store(appName string, secretType SecretType, value string) (StorageBackend, error)
Store attempts to store a secret in the OS keyring first, falling back to filesystem if keyring is unavailable. Returns the storage backend used.
type SecretType ¶
type SecretType string
SecretType identifies the type of secret being stored
const ( // SecretTypePrivateKey represents a GitHub App RSA private key SecretTypePrivateKey SecretType = "private_key" // SecretTypeAccessToken represents a GitHub App access token SecretTypeAccessToken SecretType = "access_token" // SecretTypeInstallToken represents a GitHub App installation token SecretTypeInstallToken SecretType = "installation_token" // SecretTypePAT represents a Personal Access Token SecretTypePAT SecretType = "pat" )
type StorageBackend ¶
type StorageBackend string
StorageBackend identifies where a secret is stored
const ( // StorageBackendKeyring indicates the secret is in the OS keyring StorageBackendKeyring StorageBackend = "keyring" // StorageBackendFilesystem indicates the secret is on the filesystem StorageBackendFilesystem StorageBackend = "filesystem" )
Source Files