helper

Documentation

Index

• type AuthEntry
  • func (authEntry *AuthEntry) IsValid(testTime time.Time) bool
• type CredentialsCache
  • func BuildCredentialsCache(region string) CredentialsCache
  • func NewFileCredentialsCache(path string, filename string, cachePrefixKey string) CredentialsCache
• type PorterHelper
  • func (p *PorterHelper) Add(cr *credentials.Credentials) error
  • func (p *PorterHelper) Delete(serverURL string) error
  • func (p *PorterHelper) Get(serverURL string) (user string, secret string, err error)
  • func (p *PorterHelper) List() (map[string]string, error)
• type RegistryCache

Types

type AuthEntry

type AuthEntry struct {
	AuthorizationToken string
	RequestedAt        time.Time
	ExpiresAt          time.Time
	ProxyEndpoint      string
}

func (*AuthEntry) IsValid

func (authEntry *AuthEntry) IsValid(testTime time.Time) bool

IsValid checks if AuthEntry is still valid at testTime. AuthEntries expire at 1/2 of their original requested window.

type CredentialsCache

type CredentialsCache interface {
	Get(registry string) *AuthEntry
	Set(registry string, entry *AuthEntry)
	List() []*AuthEntry
	Clear()
}

func BuildCredentialsCache

func BuildCredentialsCache(region string) CredentialsCache

func NewFileCredentialsCache

func NewFileCredentialsCache(path string, filename string, cachePrefixKey string) CredentialsCache

NewFileCredentialsCache returns a new file credentials cache.

path is used for temporary files during save, and filename should be a relative filename in the same directory where the cache is serialized and deserialized.

cachePrefixKey is used for scoping credentials for a given credential cache (i.e. region and accessKey).

type PorterHelper

type PorterHelper struct {
	Debug bool
	// contains filtered or unexported fields
}

PorterHelper implements credentials.Helper: it acts as a credentials helper for Docker that allows authentication with different registries.

func (*PorterHelper) Add

func (p *PorterHelper) Add(cr *credentials.Credentials) error

Add appends credentials to the store.

func (*PorterHelper) Delete

func (p *PorterHelper) Delete(serverURL string) error

Delete removes credentials from the store.

func (*PorterHelper) Get

func (p *PorterHelper) Get(serverURL string) (user string, secret string, err error)

Get retrieves credentials from the store. It returns username and secret as strings.

func (*PorterHelper) List

func (p *PorterHelper) List() (map[string]string, error)

List returns the stored serverURLs and their associated usernames.

type RegistryCache

type RegistryCache struct {
	Registries map[string]*AuthEntry
	Version    string
}