client

Documentation

Index

• func Erase(program ProgramFunc, serverURL string) error
• func Get(program ProgramFunc, serverURL string) (*credentials.Credentials, error)
• func List(program ProgramFunc) (map[string]string, error)
• func Store(program ProgramFunc, creds *credentials.Credentials) error
• type Program
• type ProgramFunc
  • func NewShellProgramFunc(name string) ProgramFunc
  • func NewShellProgramFuncWithEnv(name string, env *map[string]string) ProgramFunc
• type Shell
  • func (s *Shell) Input(in io.Reader)
  • func (s *Shell) Output() ([]byte, error)

Examples

• Erase
• Get
• Store

Functions

func Erase

func Erase(program ProgramFunc, serverURL string) error

Erase executes a program to remove the server credentials from the native store.

Example

p := NewShellProgramFunc("docker-credential-secretservice")

if err := Erase(p, "https://example.com"); err != nil {
	fmt.Println(err)
}

func Get

func Get(program ProgramFunc, serverURL string) (*credentials.Credentials, error)

Get executes an external program to get the credentials from a native store.

Example

p := NewShellProgramFunc("docker-credential-secretservice")

creds, err := Get(p, "https://example.com")
if err != nil {
	fmt.Println(err)
}

fmt.Printf("Got credentials for user `%s` in `%s`\n", creds.Username, creds.ServerURL)

func List

func List(program ProgramFunc) (map[string]string, error)

List executes a program to list server credentials in the native store.

func Store

func Store(program ProgramFunc, creds *credentials.Credentials) error

Store uses an external program to save credentials.

Example

p := NewShellProgramFunc("docker-credential-secretservice")

c := &credentials.Credentials{
	ServerURL: "https://example.com",
	Username:  "calavera",
	Secret:    "my super secret token",
}

if err := Store(p, c); err != nil {
	fmt.Println(err)
}

Types

type Program

type Program interface {
	Output() ([]byte, error)
	Input(in io.Reader)
}

Program is an interface to execute external programs.

type ProgramFunc

type ProgramFunc func(args ...string) Program

ProgramFunc is a type of function that initializes programs based on arguments.

func NewShellProgramFunc

func NewShellProgramFunc(name string) ProgramFunc

NewShellProgramFunc creates programs that are executed in a Shell.

func NewShellProgramFuncWithEnv

func NewShellProgramFuncWithEnv(name string, env *map[string]string) ProgramFunc

NewShellProgramFuncWithEnv creates programs that are executed in a Shell with environment variables

type Shell

type Shell struct {
	// contains filtered or unexported fields
}

Shell invokes shell commands to talk with a remote credentials helper.

func (*Shell) Input

func (s *Shell) Input(in io.Reader)

Input sets the input to send to a remote credentials helper.

func (*Shell) Output

func (s *Shell) Output() ([]byte, error)

Output returns responses from the remote credentials helper.