credentials

Documentation

Overview

Package credentials implements gRPC credential interface with etcd specific logic. e.g., client handshake with custom authority parameter

Index

• Variables
• func NewOauthAccess(token string) credentials.PerRPCCredentials
• type Bundle
  • func NewBundle(cfg Config) Bundle
• type CallerIdentity
• type Config
• type Token

Variables

var (
	// TokenFieldNameGRPC specifies name for token
	TokenFieldNameGRPC = "authorization"
)

Functions

func NewOauthAccess

func NewOauthAccess(token string) credentials.PerRPCCredentials

NewOauthAccess constructs the PerRPCCredentials using a given token.

Types

type Bundle

type Bundle interface {
	grpccredentials.Bundle
	UpdateAuthToken(token Token)
	WithDPoP(signer dpop.Signer)
	WithCallerIdentity(provider CallerIdentity)
}

Bundle defines gRPC credential interface. see https://pkg.go.dev/google.golang.org/grpc/credentials

func NewBundle

func NewBundle(cfg Config) Bundle

NewBundle constructs a new gRPC credential bundle.

type CallerIdentity

type CallerIdentity interface {
	// GetCallerIdentity returns token
	GetCallerIdentity(ctx context.Context) (*Token, error)
}

CallerIdentity interface

type Config

type Config struct {
	TLSConfig *tls.Config
}

Config defines gRPC credential configuration.

type Token

type Token struct {
	TokenType   string
	AccessToken string
	// Expires is expiration time of the token
	Expires *time.Time
}

Token provides access token