v2

README

This directory has the implementation of the S2Av2's gRPC-Go client libraries

Documentation

Overview

Package v2 provides the S2Av2 transport credentials used by a gRPC application.

Index

• func GetS2ATimeout() time.Duration
• func NewClientCreds(s2av2Address string, transportCreds credentials.TransportCredentials, ...) (credentials.TransportCredentials, error)
• func NewClientTLSConfig(ctx context.Context, s2av2Address string, ...) (*tls.Config, error)
• func NewServerCreds(s2av2Address string, transportCreds credentials.TransportCredentials, ...) (credentials.TransportCredentials, error)

Functions

func GetS2ATimeout

func GetS2ATimeout() time.Duration

GetS2ATimeout returns the timeout enforced on the connection to the S2A service for handshake.

func NewClientCreds

func NewClientCreds(s2av2Address string, transportCreds credentials.TransportCredentials, localIdentity *commonpb.Identity, verificationMode s2av2pb.ValidatePeerCertificateChainReq_VerificationMode, fallbackClientHandshakeFunc fallback.ClientHandshake, getS2AStream stream.GetS2AStream, serverAuthorizationPolicy []byte) (credentials.TransportCredentials, error)

NewClientCreds returns a client-side transport credentials object that uses the S2Av2 to establish a secure connection with a server.

func NewClientTLSConfig

func NewClientTLSConfig(
	ctx context.Context,
	s2av2Address string,
	transportCreds credentials.TransportCredentials,
	tokenManager tokenmanager.AccessTokenManager,
	verificationMode s2av2pb.ValidatePeerCertificateChainReq_VerificationMode,
	serverName string,
	serverAuthorizationPolicy []byte,
	getStream stream.GetS2AStream) (*tls.Config, error)

NewClientTLSConfig returns a tls.Config instance that uses S2Av2 to establish a TLS connection as a client. The tls.Config MUST only be used to establish a single TLS connection.

func NewServerCreds

func NewServerCreds(s2av2Address string, transportCreds credentials.TransportCredentials, localIdentities []*commonpb.Identity, verificationMode s2av2pb.ValidatePeerCertificateChainReq_VerificationMode, getS2AStream stream.GetS2AStream) (credentials.TransportCredentials, error)

NewServerCreds returns a server-side transport credentials object that uses the S2Av2 to establish a secure connection with a client.