oauth

Documentation

Overview

Package oauth implements gRPC credentials using OAuth.

Index

• func NewApplicationDefault(ctx context.Context, scope ...string) (credentials.PerRPCCredentials, error)
• func NewComputeEngine() credentials.PerRPCCredentials
• func NewJWTAccessFromFile(keyFile string) (credentials.PerRPCCredentials, error)
• func NewJWTAccessFromKey(jsonKey []byte) (credentials.PerRPCCredentials, error)
• func NewOauthAccess(token *oauth2.Token) credentials.PerRPCCredentials
• func NewServiceAccountFromFile(keyFile string, scope ...string) (credentials.PerRPCCredentials, error)
• func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (credentials.PerRPCCredentials, error)
• type TokenSource
  • func (ts TokenSource) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
  • func (ts TokenSource) RequireTransportSecurity() bool

Functions

func NewApplicationDefault

func NewApplicationDefault(ctx context.Context, scope ...string) (credentials.PerRPCCredentials, error)

NewApplicationDefault returns "Application Default Credentials". For more detail, see https://developers.google.com/accounts/docs/application-default-credentials.

func NewComputeEngine

func NewComputeEngine() credentials.PerRPCCredentials

NewComputeEngine constructs the PerRPCCredentials that fetches access tokens from Google Compute Engine (GCE)'s metadata server. It is only valid to use this if your program is running on a GCE instance. TODO(dsymonds): Deprecate and remove this.

func NewJWTAccessFromFile

func NewJWTAccessFromFile(keyFile string) (credentials.PerRPCCredentials, error)

NewJWTAccessFromFile creates PerRPCCredentials from the given keyFile.

func NewJWTAccessFromKey

func NewJWTAccessFromKey(jsonKey []byte) (credentials.PerRPCCredentials, error)

NewJWTAccessFromKey creates PerRPCCredentials from the given jsonKey.

func NewOauthAccess

func NewOauthAccess(token *oauth2.Token) credentials.PerRPCCredentials

NewOauthAccess constructs the PerRPCCredentials using a given token.

Deprecated: use oauth.TokenSource instead.

func NewServiceAccountFromFile

func NewServiceAccountFromFile(keyFile string, scope ...string) (credentials.PerRPCCredentials, error)

NewServiceAccountFromFile constructs the PerRPCCredentials using the JSON key file of a Google Developers service account.

func NewServiceAccountFromKey

func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (credentials.PerRPCCredentials, error)

NewServiceAccountFromKey constructs the PerRPCCredentials using the JSON key slice from a Google Developers service account.

Types

type TokenSource

type TokenSource struct {
	oauth2.TokenSource
}

TokenSource supplies PerRPCCredentials from an oauth2.TokenSource.

func (TokenSource) GetRequestMetadata

func (ts TokenSource) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)

GetRequestMetadata gets the request metadata as a map from a TokenSource.

func (TokenSource) RequireTransportSecurity

func (ts TokenSource) RequireTransportSecurity() bool

RequireTransportSecurity indicates whether the credentials requires transport security.