keyring

package module

v0.0.0-...-0c8bdba Latest Latest Go to latest Published: Apr 18, 2023 License: ISC Imports: 4 Imported by: 35

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tmc/keyring

Links

Open Source Insights

README ¶

keyring provides cross-platform keychain access

http://godoc.org/github.com/tmc/keyring

Keyring provides a common interface to keyring/keychain tools.

License: ISC

Currently implemented:

OSX
SecretService
gnome-keychain (via "gnome_keyring" build flag)
Windows

Contributions welcome!

Usage example:

  err := keyring.Set("libraryFoo", "jack", "sacrifice")
  password, err := keyring.Get("libraryFoo", "jack")
  fmt.Println(password) //Output: sacrifice

Linux

Linux requirements:

SecretService provider

dbus

gnome-keychain provider

gnome-keychain headers
Ubuntu/Debian: libsecret-dev
Fedora: libsecret-devel
Archlinux: libsecret

Tests on Linux:

 $ go test github.com/tmc/keyring
 $ # for gnome-keyring provider
 $ go test -tags gnome_keyring github.com/tmc/keyring

Documentation ¶

Rendered for

Overview ¶

Package keyring provides a cross-platform interface to keychains for password management

Currently implemented:

OSX
SecretService
gnome-keychain (via "gnome_keyring" build flag)

Usage ¶

Example usage:

err := keyring.Set("libraryFoo", "jack", "sacrifice")
password, err := keyring.Get("libraryFoo", "jack")
fmt.Println(password)
Output: sacrifice

TODO

Write Windows provider

Index ¶

Variables
func Get(service, username string) (string, error)
func Set(service, username, password string) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrNotFound means the requested password was not found
	ErrNotFound = errors.New("keyring: Password not found")
	// ErrNoDefault means that no default keyring provider has been found
	ErrNoDefault = errors.New("keyring: No suitable keyring provider found (check your build flags)")
)

Functions ¶

func Get ¶

func Get(service, username string) (string, error)

Get gets the password for a paricular Service and Username using the default keyring provider.

func Set ¶

func Set(service, username, password string) error

Set sets the password for a particular Service and Username using the default keyring provider.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
keyring-example Shows example use of the keyring package	Shows example use of the keyring package

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