securestore

Documentation

Index

• Constants
• Variables
• func AvailableBackends() []string
• func GetConfigFromKeyring() ([]byte, error)
• func RemoveConfigFromKeyring() error
• func UpsertConfigToKeyring(creds []byte) error

Constants

const (
	SecureStoreConfigKey = "securestore"       // OCM_CONFIG key to enable secure OS store
	KindInternetPassword = "Internet password" // MacOS Keychain item kind
	ItemKey              = "RedHatSSO"
	CollectionName       = "login" // Common OS default collection name
	MaxWindowsByteSize   = 2500    // Windows Credential Manager has a 2500 byte limit
)

Variables

var (
	ErrNoBackendsAvailable = fmt.Errorf("no backends available, expected one of %v", allowedBackends)
)

Functions

func AvailableBackends

func AvailableBackends() []string

AvailableBackends provides a slice of all available backend keys on the current OS.

Note: CGO_ENABLED=1 is required for OSX Keychain and darwin builds

The first backend in the slice is the first one that will be used.

func GetConfigFromKeyring

func GetConfigFromKeyring() ([]byte, error)

GetConfigFromKeyring will retrieve the credentials from the first priority OS secure store.

Note: CGO_ENABLED=1 is required for OSX Keychain and darwin builds

func RemoveConfigFromKeyring

func RemoveConfigFromKeyring() error

RemoveConfigFromKeyring will remove the credentials from the first priority OS secure store.

Note: CGO_ENABLED=1 is required for OSX Keychain and darwin builds

func UpsertConfigToKeyring

func UpsertConfigToKeyring(creds []byte) error

UpsertConfigToKeyring will upsert the provided credentials to first priority OS secure store.

Note: CGO_ENABLED=1 is required for OSX Keychain and darwin builds