auth

Documentation

Index

• Variables
• func GetRootCmd() *cobra.Command
• func NewGoogleComputeTokenSourceWrapper(ctx context.Context) (*tokenSourceWrapper, error)
• func NewGoogleImpersonateTokenSourceWrapper(ctx context.Context, email string, parentTs oauth2.TokenSource) (*tokenSourceWrapper, error)
• func Token() (*oauth2.Token, error)
• func TokenCtx(ctx context.Context) (*oauth2.Token, error)
• type ApplicationCredentialManager
  • func DefaultApplicationCredentialManager() *ApplicationCredentialManager
  • func EnvApplicationCredentialManager() *ApplicationCredentialManager
  • func (m *ApplicationCredentialManager) AutoDetectLogin(ctx context.Context, quotaProject string) error
  • func (m *ApplicationCredentialManager) BrowserFlowLogin(ctx context.Context, quotaProject string) error
  • func (m *ApplicationCredentialManager) CodeFlowLogin(ctx context.Context, quotaProject string) error
  • func (m *ApplicationCredentialManager) ReadApplicationCredentials() (*ApplicationCredentials, error)
  • func (m *ApplicationCredentialManager) WriteApplicationCredentials(ac *ApplicationCredentials) error
• type ApplicationCredentials
  • func (a *ApplicationCredentials) CacheKey() string
  • func (a *ApplicationCredentials) SetContext(ctx context.Context)
  • func (a *ApplicationCredentials) Token() (*oauth2.Token, error)
• type CachingTokenSource
  • func IdentityTokenSource(aud string) (*CachingTokenSource, error)
  • func NewCachingTokenSource(ts TokenSourceWithCacheKey) (*CachingTokenSource, error)
  • func TokenSource() (*CachingTokenSource, error)
  • func TokenSourceCtx(ctx context.Context) (*CachingTokenSource, error)
  • func (c *CachingTokenSource) GetAccessTokenPath() string
  • func (c *CachingTokenSource) IdentityTokenSource() *CachingTokenSource
  • func (c *CachingTokenSource) Token() (*oauth2.Token, error)
• type DockerHelperRes
• type TokenSourceWithCacheKey

Variables

var ImpersonateServiceAccount = ""

easily impersonate a service account and maintain the TokenSource interface

Functions

func GetRootCmd

func GetRootCmd() *cobra.Command

func NewGoogleComputeTokenSourceWrapper

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

func NewGoogleImpersonateTokenSourceWrapper

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

func Token

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

func TokenCtx

func TokenCtx(ctx context.Context) (*oauth2.Token, error)

Types

type ApplicationCredentialManager

type ApplicationCredentialManager struct {
	ClientID     string
	ClientSecret string
}

func DefaultApplicationCredentialManager

func DefaultApplicationCredentialManager() *ApplicationCredentialManager

func EnvApplicationCredentialManager

func EnvApplicationCredentialManager() *ApplicationCredentialManager

func (*ApplicationCredentialManager) AutoDetectLogin

func (m *ApplicationCredentialManager) AutoDetectLogin(ctx context.Context, quotaProject string) error

func (*ApplicationCredentialManager) BrowserFlowLogin

func (m *ApplicationCredentialManager) BrowserFlowLogin(ctx context.Context, quotaProject string) error

func (*ApplicationCredentialManager) CodeFlowLogin

func (m *ApplicationCredentialManager) CodeFlowLogin(ctx context.Context, quotaProject string) error

func (*ApplicationCredentialManager) ReadApplicationCredentials

func (m *ApplicationCredentialManager) ReadApplicationCredentials() (*ApplicationCredentials, error)

func (*ApplicationCredentialManager) WriteApplicationCredentials

func (m *ApplicationCredentialManager) WriteApplicationCredentials(ac *ApplicationCredentials) error

WriteApplicationCredentials idempotently writes out the application credentials to disk

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 (*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 IdentityTokenSource

func IdentityTokenSource(aud string) (*CachingTokenSource, error)

IdentityTokenSource gets a cached idtoken source. This can only be used with service accounts

func NewCachingTokenSource

func NewCachingTokenSource(ts TokenSourceWithCacheKey) (*CachingTokenSource, error)

func TokenSource

func TokenSource() (*CachingTokenSource, error)

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

func TokenSourceCtx

func TokenSourceCtx(ctx context.Context) (*CachingTokenSource, error)

func (*CachingTokenSource) GetAccessTokenPath

func (c *CachingTokenSource) GetAccessTokenPath() string

func (*CachingTokenSource) IdentityTokenSource

func (c *CachingTokenSource) IdentityTokenSource() *CachingTokenSource

IdentityTokenSource clones the current token source and configured the clone to return the identity token in the AccessToken field. this only works with user accounts.

func (*CachingTokenSource) Token

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

type DockerHelperRes

type DockerHelperRes struct {
	Secret   string
	Username string
}

type TokenSourceWithCacheKey

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