authn

Documentation

Overview

Package authn implements the logic for authentication with OCI registries.

Index

• func Login(hostname, user, token string) error
• func Logout(hostname string) error
• func NewClient(cred auth.Credential) *auth.Client
• type Store
  • func NewStore(configPaths ...string) (*Store, error)
  • func (s *Store) Credential(ctx context.Context, registry string) (auth.Credential, error)
  • func (s *Store) Erase(registry string) error
  • func (s *Store) Store(registry string, cred auth.Credential) error

Functions

func Login

func Login(hostname, user, token string) error

Login to remote registry. For now, only support login with token.

func Logout

func Logout(hostname string) error

Logout from remote registry.

func NewClient

func NewClient(cred auth.Credential) *auth.Client

NewClient creates a new authenticated client to interact with a remote registry.

Types

type Store

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

Store provides credential CRUD operations.

func NewStore

func NewStore(configPaths ...string) (*Store, error)

NewStore generates a store based on the passed in config file path.

func (*Store) Credential

func (s *Store) Credential(ctx context.Context, registry string) (auth.Credential, error)

Credential iterates all the config files, returns the first non-empty credential in a best-effort way.

func (*Store) Erase

func (s *Store) Erase(registry string) error

Erase erases a credential for a given registry.

func (*Store) Store

func (s *Store) Store(registry string, cred auth.Credential) error

Store stores a credential for a given registry.