grpc

Documentation

Overview

Copyright (c) Ultraviolet SPDX-License-Identifier: Apache-2.0

Package grpc contains the domain concept definitions needed to support Agent Client grpc functionality.

Index

• Constants
• Variables
• func CustomDialer(ctx context.Context, addr string) (net.Conn, error)
• func ReadAttestationPolicy(manifestPath string, attestationConfiguration *check.Config) error
• type AgentClientConfig
  • func (a AgentClientConfig) GetBaseConfig() BaseConfig
• type BaseConfig
  • func (a BaseConfig) GetBaseConfig() BaseConfig
• type Client
  • func NewClient(cfg ClientConfiguration) (Client, error)
• type ClientConfiguration
• type ManagerClientConfig
  • func (a ManagerClientConfig) GetBaseConfig() BaseConfig

Constants

const (
	AttestationReportSize = 0x4A0
	WithATLS              = "with aTLS"
	WithTLS               = "with TLS"
)

Variables

var (
	ErrAttestationPolicyMissing = errors.New("failed due to missing Attestation Policy file")
	ErrAttestationPolicyDecode  = errors.New("failed to decode Attestation Policy file")
)

Functions

func CustomDialer

func CustomDialer(ctx context.Context, addr string) (net.Conn, error)

func ReadAttestationPolicy

func ReadAttestationPolicy(manifestPath string, attestationConfiguration *check.Config) error

Types

type AgentClientConfig

type AgentClientConfig struct {
	BaseConfig
	AttestationPolicy string `env:"ATTESTATION_POLICY" envDefault:""`
	AttestedTLS       bool   `env:"ATTESTED_TLS"       envDefault:"false"`
}

func (AgentClientConfig) GetBaseConfig

func (a AgentClientConfig) GetBaseConfig() BaseConfig

type BaseConfig

type BaseConfig struct {
	URL          string        `env:"URL"             envDefault:"localhost:7001"`
	Timeout      time.Duration `env:"TIMEOUT"         envDefault:"60s"`
	ClientCert   string        `env:"CLIENT_CERT"     envDefault:""`
	ClientKey    string        `env:"CLIENT_KEY"      envDefault:""`
	ServerCAFile string        `env:"SERVER_CA_CERTS"    envDefault:""`
}

func (BaseConfig) GetBaseConfig

func (a BaseConfig) GetBaseConfig() BaseConfig

type Client

type Client interface {
	// Close closes gRPC connection.
	Close() error

	// Secure is used for pretty printing TLS info.
	Secure() string

	// Connection returns the gRPC connection.
	Connection() *grpc.ClientConn
}

func NewClient

func NewClient(cfg ClientConfiguration) (Client, error)

type ClientConfiguration

type ClientConfiguration interface {
	GetBaseConfig() BaseConfig
}

type ManagerClientConfig

type ManagerClientConfig struct {
	BaseConfig
}

func (ManagerClientConfig) GetBaseConfig

func (a ManagerClientConfig) GetBaseConfig() BaseConfig