auth

Documentation

Index

• func CheckAuthFile(authfile string) error
• func GetDefaultAuthFile() string
• func GetLoginFlags(flags *LoginOptions) *pflag.FlagSet
• func GetLogoutFlags(flags *LogoutOptions) *pflag.FlagSet
• func Login(ctx context.Context, systemContext *types.SystemContext, opts *LoginOptions, ...) error
• func Logout(systemContext *types.SystemContext, opts *LogoutOptions, server string) error
• type LoginOptions
• type LogoutOptions

Functions

func CheckAuthFile

func CheckAuthFile(authfile string) error

CheckAuthFile validates filepath given by --authfile used by command has --authfile flag

func GetDefaultAuthFile

func GetDefaultAuthFile() string

GetDefaultAuthFile returns env value REGISTRY_AUTH_FILE as default --authfile path used in multiple --authfile flag definitions

func GetLoginFlags

func GetLoginFlags(flags *LoginOptions) *pflag.FlagSet

GetLoginFlags defines and returns login flags for containers tools

func GetLogoutFlags

func GetLogoutFlags(flags *LogoutOptions) *pflag.FlagSet

GetLogoutFlags defines and returns logout flags for containers tools

func Login

func Login(ctx context.Context, systemContext *types.SystemContext, opts *LoginOptions, registry string) error

Login login to the server with creds from Stdin or CLI

func Logout

func Logout(systemContext *types.SystemContext, opts *LogoutOptions, server string) error

Logout removes the authentication of server from authfile removes all authtication if specifies all in the options

Types

type LoginOptions

type LoginOptions struct {
	AuthFile      string
	CertDir       string
	GetLoginSet   bool
	Password      string
	Username      string
	StdinPassword bool
	Stdin         io.Reader
	Stdout        io.Writer
}

LoginOptions represents common flags in login caller should define bool or optionalBool fields for flags --get-login and --tls-verify

type LogoutOptions

type LogoutOptions struct {
	AuthFile string
	All      bool
	Stdin    io.Reader
	Stdout   io.Writer
}

LogoutOptions represents the results for flags in logout