keyring

Jun 3, 2026

Changes in this version

+ func TestExpandTilde(t *testing.T) — linux/amd64

+ func TestExpandTildeWithoutLeadingTilde(t *testing.T) — linux/amd64

+ func TestExpandTildeWithoutSlash(t *testing.T) — linux/amd64

type BackendType

+ const WinHelloBackend

Jan 20, 2026

Changes in this version

type BackendType

+ const PassageBackend

Jan 8, 2026

Changes in this version

+ const OPDesktopEnvAccountID

+ const OPSrvAccountEnvToken

+ var OPDesktopErrAccountID = fmt.Errorf("%w: %w: %#v", OPDesktopErrKeyring, ErrEnvUnsetOrEmpty, OPDesktopEnvAccountID)

+ var OPDesktopErrClient = errors.New("Unable to create a 1Password Desktop client")

+ var OPDesktopErrKeyring = errors.New("Unable to create a 1Password Desktop keyring")

+ var OPDesktopErrNewClient = fmt.Errorf("%w: onepassword.NewClient returned an error", OPDesktopErrClient)

+ var OPDesktopErrTimeout = fmt.Errorf("%w: Timeout must be a non-zero duration", OPDesktopErrKeyring)

+ var OPSrvAccountErrClient = errors.New("Unable to create a 1Password Service Accounts client")

+ var OPSrvAccountErrKeyring = errors.New("Unable to create a 1Password Service Accounts keyring")

+ var OPSrvAccountErrNewClient = fmt.Errorf("%w: onepassword.NewClient returned an error", OPSrvAccountErrClient)

+ var OPSrvAccountErrTimeout = fmt.Errorf("%w: Timeout must be a non-zero duration", OPSrvAccountErrKeyring)

type BackendType

+ const OPDesktopBackend

type Config

+ OPDesktopAccountID string

+ type OPDesktopKeyring struct

+ DesktopAccountID string

+ func NewOPDesktopKeyring(cfg *Config) (*OPDesktopKeyring, error)

+ func (k *OPDesktopKeyring) Get(key string) (Item, error)

+ func (k *OPDesktopKeyring) GetMetadata(key string) (Metadata, error)

+ func (k *OPDesktopKeyring) InitializeClient() error

+ func (k *OPDesktopKeyring) Keys() ([]string, error)

+ func (k *OPDesktopKeyring) Remove(key string) error

+ func (k *OPDesktopKeyring) Set(item Item) error

+ type OPSrvAccountKeyring struct

+ func NewOPSrvAccountKeyring(cfg *Config) (*OPSrvAccountKeyring, error)

+ func (k *OPSrvAccountKeyring) Get(key string) (Item, error)

+ func (k *OPSrvAccountKeyring) GetMetadata(key string) (Metadata, error)

+ func (k *OPSrvAccountKeyring) InitializeClient() error

+ func (k *OPSrvAccountKeyring) Keys() ([]string, error)

+ func (k *OPSrvAccountKeyring) Remove(key string) error

+ func (k *OPSrvAccountKeyring) Set(item Item) error

Sep 29, 2025

Changes in this version

type Config

+ OPConnectTokenEnv string

+ OPTokenEnv string

type OPBaseKeyring

+ TokenEnvs []string

Sep 28, 2025

Changes in this version

+ const OPConnectEnvHost

+ const OPConnectEnvToken

+ const OPConnectItemCategory

+ const OPConnectItemFieldType

+ const OPEnvVaultID

+ const OPItemFieldTitle

+ const OPItemTag

+ const OPItemTitlePrefix

+ const OPItemTitlePrefixKeySep

+ const OPStandardEnvToken

+ const OPStandardIntegrationName

+ const OPStandardIntegrationVersion

+ const OPStandardItemCategory

+ const OPStandardItemFieldType

+ var ErrEnvUnsetOrEmpty = errors.New("Environment variable unset or empty")

+ var OPConnectErrHost = fmt.Errorf("%w: %w: %#v", OPConnectErrKeyring, ErrEnvUnsetOrEmpty, OPConnectEnvHost)

+ var OPConnectErrKeyring = errors.New("Unable to create a 1Password Connect keyring")

+ var OPErrClient = errors.New("Unable to create a 1Password Connect / Service Accounts client")

+ var OPErrItemMultiple = errors.New("Found multiple matching 1Password items")

+ var OPErrItemTitleDuplicate = errors.New("Found duplicate 1Password item title")

+ var OPErrKeyring = errors.New("Unable to create a 1Password Connect / Service Accounts keyring")

+ var OPErrTokenFuncNil = fmt.Errorf("%w: Token function is nil", OPErrClient)

+ var OPErrVaultID = fmt.Errorf("%w: %w: %#v", OPErrKeyring, ErrEnvUnsetOrEmpty, OPEnvVaultID)

+ var OPStandardErrClient = errors.New("Unable to create a 1Password Service Accounts client")

+ var OPStandardErrKeyring = errors.New("Unable to create a 1Password Service Accounts keyring")

+ var OPStandardErrNewClient = fmt.Errorf("%w: onepassword.NewClient returned an error", OPStandardErrClient)

+ var OPStandardErrTimeout = fmt.Errorf("%w: Timeout must be a non-zero duration", OPStandardErrKeyring)

type BackendType

+ const OPBackend

+ const OPConnectBackend

type Config

+ OPConnectHost string

+ OPConnectTokenFunc PromptFunc

+ OPItemFieldTitle string

+ OPItemTag string

+ OPItemTitlePrefix string

+ OPTimeout time.Duration

+ OPTokenFunc PromptFunc

+ OPVaultID string

+ type OPBaseKeyring struct

+ ItemFieldTitle string

+ ItemTag string

+ ItemTitlePrefix string

+ TokenFunc PromptFunc

+ VaultID string

+ func (k *OPBaseKeyring) GetItemFromOPItemFieldValue(opItemFieldValue string) (*Item, error)

+ func (k *OPBaseKeyring) GetKeyFromOPItemTitle(opItemTitle string) string

+ func (k *OPBaseKeyring) GetOPItemFieldValueFromItem(item *Item) (string, error)

+ func (k *OPBaseKeyring) GetOPItemTitleFromKey(key string) string

+ func (k *OPBaseKeyring) GetOPToken(prompt string) (string, error)

+ type OPConnectClientAPI interface

+ CreateItem func(item *connectop.Item, vaultQuery string) (*connectop.Item, error)

+ DeleteItemByID func(itemUUID string, vaultQuery string) error

+ GetItemByUUID func(uuid string, vaultQuery string) (*connectop.Item, error)

+ GetItems func(vaultQuery string) ([]connectop.Item, error)

+ GetItemsByTitle func(title string, vaultQuery string) ([]connectop.Item, error)

+ UpdateItem func(item *connectop.Item, vaultQuery string) (*connectop.Item, error)

+ type OPConnectKeyring struct

+ Client OPConnectClientAPI

+ Host string

+ func NewOPConnectKeyring(cfg *Config) (*OPConnectKeyring, error)

+ func (k *OPConnectKeyring) GetOPItem(key string) (*onepassword.Item, error)

+ func (k *OPConnectKeyring) GetOPItems() ([]onepassword.Item, error)

+ func (k *OPConnectKeyring) InitializeOPConnectClient() error

+ func (k *OPConnectKeyring) PruneAndHydrateOPItemOverviews(opConnectItemOverviews []connectop.Item) ([]onepassword.Item, error)

+ func (k OPConnectKeyring) Get(key string) (Item, error)

+ func (k OPConnectKeyring) GetMetadata(key string) (Metadata, error)

+ func (k OPConnectKeyring) Keys() ([]string, error)

+ func (k OPConnectKeyring) Remove(key string) error

+ func (k OPConnectKeyring) Set(item Item) error

+ type OPKeyringAPI interface

+ GetItemFromOPItemFieldValue func(opItemFieldValue string) (*Item, error)

+ GetKeyFromOPItemTitle func(opItemTitle string) string

+ GetOPItem func(key string) (*onepassword.Item, error)

+ GetOPItemFieldValueFromItem func(item *Item) (string, error)

+ GetOPItemTitleFromKey func(key string) string

+ GetOPItems func() ([]onepassword.Item, error)

+ GetOPToken func(prompt string) (string, error)

+ type OPStandardClientAPI interface

+ Create func(ctx context.Context, params onepassword.ItemCreateParams) (onepassword.Item, error)

+ Delete func(ctx context.Context, vaultID string, itemID string) error

+ Get func(ctx context.Context, vaultID string, itemID string) (onepassword.Item, error)

+ List func(ctx context.Context, vaultID string, filters ...onepassword.ItemListFilter) ([]onepassword.ItemOverview, error)

+ Put func(ctx context.Context, item onepassword.Item) (onepassword.Item, error)

+ type OPStandardKeyring struct

+ Client OPStandardClientAPI

+ Timeout time.Duration

+ func NewOPStandardKeyring(cfg *Config) (*OPStandardKeyring, error)

+ func (k *OPStandardKeyring) GetOPItem(key string) (*onepassword.Item, error)

+ func (k *OPStandardKeyring) GetOPItems() ([]onepassword.Item, error)

+ func (k *OPStandardKeyring) InitializeOPStandardClient() error

+ func (k OPStandardKeyring) Get(key string) (Item, error)

+ func (k OPStandardKeyring) GetMetadata(key string) (Metadata, error)

+ func (k OPStandardKeyring) Keys() ([]string, error)

+ func (k OPStandardKeyring) Remove(key string) error

+ func (k OPStandardKeyring) Set(item Item) error

Sep 23, 2025

Changes in this version

type Config

+ TouchIDAccount string

+ TouchIDService string

+ UseBiometrics bool

Jun 21, 2025

Changes in this version

+ const KEYCTL_PERM_ALL — linux/amd64

+ const KEYCTL_PERM_GROUP — linux/amd64

+ const KEYCTL_PERM_LINK — linux/amd64

+ const KEYCTL_PERM_OTHERS — linux/amd64

+ const KEYCTL_PERM_PROCESS — linux/amd64

+ const KEYCTL_PERM_READ — linux/amd64

+ const KEYCTL_PERM_SEARCH — linux/amd64

+ const KEYCTL_PERM_SETATTR — linux/amd64

+ const KEYCTL_PERM_USER — linux/amd64

+ const KEYCTL_PERM_VIEW — linux/amd64

+ const KEYCTL_PERM_WRITE — linux/amd64

+ var Debug bool

+ var ErrKeyNotFound = errors.New("The specified item could not be found in the keyring")

+ var ErrMetadataNeedsCredentials = errors.New("The keyring backend requires credentials for metadata access")

+ var ErrMetadataNotSupported = errors.New("The keyring backend does not support metadata access")

+ var ErrNoAvailImpl = errors.New("Specified keyring backend not available")

+ func ExpandTilde(dir string) (string, error)

+ func GetKeyringIDForScope(scope string) (int32, error) — linux/amd64

+ func GetPermissions(process, user, group, others uint32) uint32 — linux/amd64

+ func TerminalPrompt(prompt string) (string, error)

+ type ArrayKeyring struct

+ func NewArrayKeyring(initial []Item) *ArrayKeyring

+ func (k *ArrayKeyring) Get(key string) (Item, error)

+ func (k *ArrayKeyring) GetMetadata(_ string) (Metadata, error)

+ func (k *ArrayKeyring) Keys() ([]string, error)

+ func (k *ArrayKeyring) Remove(key string) error

+ func (k *ArrayKeyring) Set(i Item) error

+ type BackendType string

+ const FileBackend

+ const InvalidBackend

+ const KWalletBackend

+ const KeyCtlBackend

+ const KeychainBackend

+ const PassBackend

+ const SecretServiceBackend

+ const WinCredBackend

+ func AvailableBackends() []BackendType

+ type Config struct

+ AllowedBackends []BackendType

+ FileDir string

+ FilePasswordFunc PromptFunc

+ KWalletAppID string

+ KWalletFolder string

+ KeyCtlPerm uint32

+ KeyCtlScope string

+ KeychainAccessibleWhenUnlocked bool

+ KeychainName string

+ KeychainPasswordFunc PromptFunc

+ KeychainSynchronizable bool

+ KeychainTrustApplication bool

+ LibSecretCollectionName string

+ PassCmd string

+ PassDir string

+ PassPrefix string

+ ServiceName string

+ WinCredPrefix string

+ type Item struct

+ Data []byte

+ Description string

+ Key string

+ KeychainNotSynchronizable bool

+ KeychainNotTrustApplication bool

+ Label string

+ type Keyring interface

+ Get func(key string) (Item, error)

+ GetMetadata func(key string) (Metadata, error)

+ Keys func() ([]string, error)

+ Remove func(key string) error

+ Set func(item Item) error

+ func Open(cfg Config) (Keyring, error)

+ type Metadata struct

+ ModificationTime time.Time

+ type PromptFunc func(string) (string, error)

+ func FixedStringPrompt(value string) PromptFunc