auth

Documentation

Index

• Variables
• func APIKeyIsInKeyring() bool
• func DeleteAPIKeyFromKeyring() bool
• func RetrieveAPIKeyFromKeyring() string
• func StoreAPIKeyInKeyring(key string) error
• func ValidateAPIKey(url string, key string) bool

Variables

var KeyringService = "PiCLI"

Keyring Service: Required for use in authentication and API key management

var KeyringUsr = "api-key"

Keyring User: Required for use in authentication and API key management

Functions

func APIKeyIsInKeyring

func APIKeyIsInKeyring() bool

Is there an entry for the API key in the system keyring?

func DeleteAPIKeyFromKeyring

func DeleteAPIKeyFromKeyring() bool

Delete the stored API key if it exists

func RetrieveAPIKeyFromKeyring

func RetrieveAPIKeyFromKeyring() string

Retrieve the API key from the system keyring

func StoreAPIKeyInKeyring

func StoreAPIKeyInKeyring(key string) error

Store the API key in the system keyring. Returns an error if this action failed.

func ValidateAPIKey

func ValidateAPIKey(url string, key string) bool

Does an key allow authentication? I.e., is is valid?