credentials

Documentation

Overview

Package credentials resolves credential references against environment variables and the OS keyring.

Lookup order for a reference named "github_pat":

1. Environment variable OMP_SYNC_GITHUB_PAT
2. Keyring entry "github_pat" (via zalando/go-keyring)

The CLI never stores raw secrets in the config file; it stores references.

Index

• Variables
• func Delete(name string) error
• func EnvName(name string) string
• func Lookup(name string) (string, error)
• func Store(name, value string) error

Variables

var ErrNotFound = errors.New("credential not found")

ErrNotFound is returned when no credential could be located.

Functions

func Delete

func Delete(name string) error

Delete removes a credential from the keyring.

func EnvName

func EnvName(name string) string

EnvName returns the environment-variable name a credential would be looked up under. Useful for actionable error messages (SC-007).

func Lookup

func Lookup(name string) (string, error)

Lookup resolves a credential by name. Returns ErrNotFound if absent. If the lookup fails because of a missing keyring entry AND no env var was provided, the wrapped error includes the expected env var name so the user can act on it.

func Store

func Store(name, value string) error

Store sets a credential in the keyring. Used by `omp-sync config set` for interactive flows.