credentials

package
v2.2.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2015 License: BSD-3-Clause, Apache-2.0 Imports: 11 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 NewApplicationDefault

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

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

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. TODO(dsymonds): Deprecate and remove this.

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 ProtocolInfo

type ProtocolInfo struct {
	// ProtocolVersion is the gRPC wire protocol version.
	ProtocolVersion string
	// SecurityProtocol is the security protocol in use.
	SecurityProtocol string
	// SecurityVersion is the security protocol version.
	SecurityVersion string
}

ProtocolInfo provides information regarding the gRPC wire protocol version, security protocol, security protocol version in use, etc.

type TokenSource

type TokenSource struct {
	oauth2.TokenSource
}

TokenSource supplies credentials from an oauth2.TokenSource.

func (TokenSource) GetRequestMetadata

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

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

type TransportAuthenticator

type TransportAuthenticator interface {
	// ClientHandshake does the authentication handshake specified by the corresponding
	// authentication protocol on rawConn for clients.
	ClientHandshake(addr string, rawConn net.Conn, timeout time.Duration) (net.Conn, error)
	// ServerHandshake does the authentication handshake for servers.
	ServerHandshake(rawConn net.Conn) (net.Conn, error)
	// Info provides the ProtocolInfo of this TransportAuthenticator.
	Info() ProtocolInfo
	Credentials
}

TransportAuthenticator defines the common interface for all the live gRPC wire protocols and supported transport security protocols (e.g., TLS, SSL).

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.

func NewTLS

NewTLS uses c to construct a TransportAuthenticator based on TLS.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL