secret

Documentation

Overview

Package secret provides a way to read user credentials.

Index

• Variables
• func ReadCredentialFile(path string) (api.SavedCredentials, error)
• type Reader
  • func NewReader(filePath string) *Reader
  • func (s *Reader) Read() (api.SavedCredentials, error)
• type Static
  • func (u Static) Read() (api.SavedCredentials, error)
• type UserPasswordFromEnv
  • func (UserPasswordFromEnv) Read() (api.SavedCredentials, error)

Variables

var (
	// ErrInvalidSecret is returned when the secret is invalid.
	ErrInvalidSecret = errors.New("invalid secret")
)

Functions

func ReadCredentialFile

func ReadCredentialFile(path string) (api.SavedCredentials, error)

ReadCredentialFile reads the credentials from a file.

Types

type Reader

type Reader struct {
	FilePath string
}

Reader is a secret reader from a file.

func NewReader

func NewReader(filePath string) *Reader

NewReader creates a new secret reader.

func (*Reader) Read

func (s *Reader) Read() (api.SavedCredentials, error)

Read reads the username and password from the file.

type Static

type Static struct {
	api.SavedCredentials
}

Static is a static user password reader.

func (Static) Read

func (u Static) Read() (api.SavedCredentials, error)

Read returns the email and password.

type UserPasswordFromEnv

type UserPasswordFromEnv struct{}

UserPasswordFromEnv is a user password reader from the environment.

func (UserPasswordFromEnv) Read

func (UserPasswordFromEnv) Read() (api.SavedCredentials, error)

Read returns the email and password from the environment.