basic

Documentation

Overview

Package basic is adopted from Talos.

Index

• func NewConnection(dialer func(ctx context.Context, addr string) (net.Conn, error), ...) (conn *grpc.ClientConn, err error)
• type Credentials
  • func NewTokenCredentials(token string) (creds Credentials)
  • func NewTokenCredentialsDynamic(f TokenGetterFunc) (creds Credentials)
• type TokenCredentials
  • func (b *TokenCredentials) GetRequestMetadata(ctx context.Context, _ ...string) (map[string]string, error)
  • func (b *TokenCredentials) RequireTransportSecurity() bool
  • func (b *TokenCredentials) UnaryInterceptor() grpc.UnaryServerInterceptor
• type TokenGetterFunc

Functions

func NewConnection

func NewConnection(dialer func(ctx context.Context, addr string) (net.Conn, error),
	address string, creds credentials.PerRPCCredentials, acceptedCAs []*x509.PEMEncodedCertificate) (conn *grpc.ClientConn, err error,
)

NewConnection initializes a grpc.ClientConn configured for basic authentication.

Types

type Credentials

type Credentials interface {
	credentials.PerRPCCredentials

	UnaryInterceptor() grpc.UnaryServerInterceptor
}

Credentials describes an authorization method.

func NewTokenCredentials

func NewTokenCredentials(token string) (creds Credentials)

NewTokenCredentials initializes ClientCredentials with the token.

func NewTokenCredentialsDynamic

func NewTokenCredentialsDynamic(f TokenGetterFunc) (creds Credentials)

NewTokenCredentialsDynamic initializes ClientCredentials with the dynamic token token.

type TokenCredentials

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

TokenCredentials implements credentials.PerRPCCredentials. It uses a basic token lookup to authenticate users.

func (*TokenCredentials) GetRequestMetadata

func (b *TokenCredentials) GetRequestMetadata(ctx context.Context, _ ...string) (map[string]string, error)

GetRequestMetadata sets the value for the "token" key.

func (*TokenCredentials) RequireTransportSecurity

func (b *TokenCredentials) RequireTransportSecurity() bool

RequireTransportSecurity is set to true in order to encrypt the communication.

func (*TokenCredentials) UnaryInterceptor

func (b *TokenCredentials) UnaryInterceptor() grpc.UnaryServerInterceptor

UnaryInterceptor sets the UnaryServerInterceptor for the server and enforces basic authentication.

type TokenGetterFunc

type TokenGetterFunc func(context.Context) (string, error)

TokenGetterFunc is the function to dynamically retrieve the token.