credentials

Documentation

Overview

Package credentials implements various credentials supported by gRPC library, which encapsulate all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client's identity, role, or whether it is authorized to make a particular call.

Index

• type Credentials
  • func NewComputeEngine() Credentials
  • func NewServiceAccountFromFile(keyFile string, scope ...string) (Credentials, error)
  • func NewServiceAccountFromKey(jsonKey []byte, scope ...string) (Credentials, error)
• type TransportAuthenticator
  • func NewClientTLSFromCert(cp *x509.CertPool, serverName string) TransportAuthenticator
  • func NewClientTLSFromFile(certFile, serverName string) (TransportAuthenticator, error)
  • func NewServerTLSFromCert(cert *tls.Certificate) TransportAuthenticator
  • func NewServerTLSFromFile(certFile, keyFile string) (TransportAuthenticator, error)

Types

type Credentials

type Credentials interface {
	// GetRequestMetadata gets the current request metadata, refreshing
	// tokens if required. This should be called by the transport layer on
	// each request, and the data should be populated in headers or other
	// context. When supported by the underlying implementation, ctx can
	// be used for timeout and cancellation.
	// TODO(zhaoq): Define the set of the qualified keys instead of leaving
	// it as an arbitrary string.
	GetRequestMetadata(ctx context.Context) (map[string]string, error)
}

Credentials defines the common interface all supported credentials must implement.

func NewComputeEngine

func NewComputeEngine() Credentials

NewComputeEngine constructs the credentials 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.

func NewServiceAccountFromFile

func NewServiceAccountFromFile(keyFile string, scope ...string) (Credentials, error)

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

func NewServiceAccountFromKey

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

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

type TransportAuthenticator

type TransportAuthenticator interface {
	// Dial connects to the given network address and does the authentication
	// handshake specified by the corresponding authentication protocol.
	Dial(addr string) (net.Conn, error)
	// NewListener creates a listener which accepts connections with requested
	// authentication handshake.
	NewListener(lis net.Listener) net.Listener
	Credentials
}

TransportAuthenticator defines the common interface all supported transport authentication protocols (e.g., TLS, SSL) must implement.

func NewClientTLSFromCert

func NewClientTLSFromCert(cp *x509.CertPool, serverName string) TransportAuthenticator

NewClientTLSFromCert constructs a TLS from the input certificate for client.

func NewClientTLSFromFile

func NewClientTLSFromFile(certFile, serverName string) (TransportAuthenticator, error)

NewClientTLSFromFile constructs a TLS from the input certificate file for client.

func NewServerTLSFromCert

func NewServerTLSFromCert(cert *tls.Certificate) TransportAuthenticator

NewServerTLSFromCert constructs a TLS from the input certificate for server.

func NewServerTLSFromFile

func NewServerTLSFromFile(certFile, keyFile string) (TransportAuthenticator, error)

NewServerTLSFromFile constructs a TLS from the input certificate file and key file for server.