auth

Documentation

Overview

Package auth contains authentication methods to talk to the registry

Index

• func NewIaasKeychain(ctx context.Context, environFunc func() []string) (authn.Keychain, error)
• type CustomRegistryKeychain
  • func (k CustomRegistryKeychain) Resolve(res regauthn.Resource) (regauthn.Authenticator, error)
• type EnvKeychain
  • func NewEnvKeychain(environFunc func() []string) *EnvKeychain
  • func (k *EnvKeychain) Resolve(target regauthn.Resource) (regauthn.Authenticator, error)
• type KeychainOpts
• type SingleAuthKeychain
  • func NewSingleAuthKeychain(auth regauthn.Authenticator) SingleAuthKeychain
  • func (s SingleAuthKeychain) Resolve(_ regauthn.Resource) (regauthn.Authenticator, error)

Functions

func NewIaasKeychain

func NewIaasKeychain(ctx context.Context, environFunc func() []string) (authn.Keychain, error)

NewIaasKeychain implements an authn.Keychain interface by using credentials provided by the iaas metadata services

Types

type CustomRegistryKeychain

type CustomRegistryKeychain struct {
	Opts KeychainOpts
}

CustomRegistryKeychain implements an authn.Keychain interface by using credentials provided by imgpkg's auth options

func (CustomRegistryKeychain) Resolve

func (k CustomRegistryKeychain) Resolve(res regauthn.Resource) (regauthn.Authenticator, error)

Resolve looks up the most appropriate credential for the specified target.

type EnvKeychain

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

EnvKeychain implements an authn.Keychain interface by using credentials provided by imgpkg's auth environment vars

func NewEnvKeychain

func NewEnvKeychain(environFunc func() []string) *EnvKeychain

NewEnvKeychain builder for Environment Keychain

func (*EnvKeychain) Resolve

func (k *EnvKeychain) Resolve(target regauthn.Resource) (regauthn.Authenticator, error)

Resolve looks up the most appropriate credential for the specified target.

type KeychainOpts

type KeychainOpts struct {
	Username string
	Password string
	Token    string
	Anon     bool
}

KeychainOpts Contains credentials (passed down via flags) used by custom keychain to auth with a registry

type SingleAuthKeychain

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

SingleAuthKeychain This Keychain will always provide the same authentication for all images

func NewSingleAuthKeychain

func NewSingleAuthKeychain(auth regauthn.Authenticator) SingleAuthKeychain

NewSingleAuthKeychain Builds a SingleAuthKeychain struct

func (SingleAuthKeychain) Resolve

func (s SingleAuthKeychain) Resolve(_ regauthn.Resource) (regauthn.Authenticator, error)

Resolve returns the same authentication for all images