auth

Documentation

Index

• func GetRootCmd() *cobra.Command
• func NewCachingTokenSource(ts TokenSourceWithCacheKey) (oauth2.TokenSource, error)
• func Token() (*oauth2.Token, error)
• func TokenSource() (oauth2.TokenSource, error)
• func WriteApplicationCredentials(ac *ApplicationCredentials) error
• type ApplicationCredentials
  • func ReadApplicationCredentials() (*ApplicationCredentials, error)
  • func (a *ApplicationCredentials) CacheKey() string
  • func (a *ApplicationCredentials) SetContext(ctx context.Context)
  • func (a *ApplicationCredentials) Token() (*oauth2.Token, error)
• type CachingTokenSource
  • func (c *CachingTokenSource) Token() (*oauth2.Token, error)
• type DockerHelperRes
• type GoogleComputeTokenSourceWrapper
  • func NewGoogleComputeTokenSourceWrapper(ctx context.Context) (*GoogleComputeTokenSourceWrapper, error)
  • func (m *GoogleComputeTokenSourceWrapper) CacheKey() string
  • func (m *GoogleComputeTokenSourceWrapper) Token() (*oauth2.Token, error)
• type GoogleImpersonateTokenSourceWrapper
  • func NewGoogleImpersonateTokenSourceWrapper(ctx context.Context, email string, parentTs oauth2.TokenSource) (*GoogleImpersonateTokenSourceWrapper, error)
  • func (m *GoogleImpersonateTokenSourceWrapper) CacheKey() string
  • func (m *GoogleImpersonateTokenSourceWrapper) Token() (*oauth2.Token, error)
• type TokenSourceWithCacheKey

Functions

func GetRootCmd

func GetRootCmd() *cobra.Command

func NewCachingTokenSource

func NewCachingTokenSource(ts TokenSourceWithCacheKey) (oauth2.TokenSource, error)

func Token

func Token() (*oauth2.Token, error)

func TokenSource

func TokenSource() (oauth2.TokenSource, error)

TokenSource returns a cached application default credentials or falls back to the compute token source

func WriteApplicationCredentials

func WriteApplicationCredentials(ac *ApplicationCredentials) error

WriteApplicationCredentials idempotently writes out the application credentials to disk

Types

type ApplicationCredentials

type ApplicationCredentials struct {
	ClientID       string `json:"client_id,omitempty"`
	ClientSecret   string `json:"client_secret,omitempty"`
	QuotaProjectId string `json:"quota_project_id,omitempty"`
	RefreshToken   string `json:"refresh_token,omitempty"`
	Type           string `json:"type,omitempty"`
	AuthUri        string `json:"auth_uri,omitempty"`
	TokenUri       string `json:"token_uri,omitempty"`

	// service account fields
	ProjectID               string `json:"project_id,omitempty"`
	PrivateKeyID            string `json:"private_key_id,omitempty"`
	PrivateKey              string `json:"private_key,omitempty"`
	ClientEmail             string `json:"client_email,omitempty"`
	AuthProviderX509CertUrl string `json:"auth_provider_x509_cert_url,omitempty"`
	ClientX509CertUrl       string `json:"client_x509_cert_url,omitempty"`
	// contains filtered or unexported fields
}

ApplicationCredentials is the a struct representing the application_default_credentials.json format. We add access_token and access_token_expiry for easy token caching and refresh.

func ReadApplicationCredentials

func ReadApplicationCredentials() (*ApplicationCredentials, error)

func (*ApplicationCredentials) CacheKey

func (a *ApplicationCredentials) CacheKey() string

func (*ApplicationCredentials) SetContext

func (a *ApplicationCredentials) SetContext(ctx context.Context)

SetContext allows you to set the context on token refresh operations

func (*ApplicationCredentials) Token

func (a *ApplicationCredentials) Token() (*oauth2.Token, error)

Token ensures that we cache the access token. You should probably be using auth.Token() which conditionally calls this. This is slightly better than google.DefaultTokenSource because it has caching.

type CachingTokenSource

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

func (*CachingTokenSource) Token

func (c *CachingTokenSource) Token() (*oauth2.Token, error)

type DockerHelperRes

type DockerHelperRes struct {
	Secret   string
	Username string
}

type GoogleComputeTokenSourceWrapper

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

func NewGoogleComputeTokenSourceWrapper

func NewGoogleComputeTokenSourceWrapper(ctx context.Context) (*GoogleComputeTokenSourceWrapper, error)

func (*GoogleComputeTokenSourceWrapper) CacheKey

func (m *GoogleComputeTokenSourceWrapper) CacheKey() string

func (*GoogleComputeTokenSourceWrapper) Token

func (m *GoogleComputeTokenSourceWrapper) Token() (*oauth2.Token, error)

type GoogleImpersonateTokenSourceWrapper

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

func NewGoogleImpersonateTokenSourceWrapper

func NewGoogleImpersonateTokenSourceWrapper(ctx context.Context, email string, parentTs oauth2.TokenSource) (*GoogleImpersonateTokenSourceWrapper, error)

func (*GoogleImpersonateTokenSourceWrapper) CacheKey

func (m *GoogleImpersonateTokenSourceWrapper) CacheKey() string

func (*GoogleImpersonateTokenSourceWrapper) Token

func (m *GoogleImpersonateTokenSourceWrapper) Token() (*oauth2.Token, error)

type TokenSourceWithCacheKey

type TokenSourceWithCacheKey interface {
	Token() (*oauth2.Token, error)
	CacheKey() string
}