authclient

Documentation

Overview

Package authclient contains common code for creating an auth server client which may use SSH tunneling through a proxy.

Index

• func Connect(ctx context.Context, cfg *Config) (auth.ClientI, error)
• type Config

Functions

func Connect

func Connect(ctx context.Context, cfg *Config) (auth.ClientI, error)

Connect creates a valid client connection to the auth service. It may connect directly to the auth server, or tunnel through the proxy.

Types

type Config

type Config struct {
	// TLS holds credentials for mTLS.
	TLS *tls.Config
	// SSH is client SSH config.
	SSH *ssh.ClientConfig
	// AuthServers is a list of possible auth or proxy server addresses.
	AuthServers []utils.NetAddr
	// Log sets the logger for the client to use.
	Log logrus.FieldLogger
	// CircuitBreakerConfig is the configuration for the auth client circuit breaker.
	CircuitBreakerConfig breaker.Config
}

Config holds configuration parameters for connecting to the auth service.