ziti

Documentation

Overview

Package ziti provides methods for loading ziti contexts from identity JSON files Identity files specifies in `ZITI_IDENTITIES` environment variable (semicolon separates) are loaded automatically at startup

Index

• Constants
• Variables
• func ForAllContexts(f func(ctx Context) bool)
• func SetAppInfo(appId, appVersion string)
• func SetApplication(theAppId, theAppVersion string)
• type Context
  • func LoadContext(config_ string) (Context, error)
  • func NewContext() Context
  • func NewContextWithConfig(cfg *config.Config) Context
  • func NewContextWithOpts(cfg *config.Config, options *Options) Context
• type ContextDialer
• type ContextImplTest
  • func (self *ContextImplTest) GetApiSession() (*edge.ApiSession, error)
  • func (self *ContextImplTest) GetPostureCache() (*posture.Cache, error)
  • func (self *ContextImplTest) GetSessions() ([]*edge.Session, error)
• type DialOptions
  • func (d DialOptions) GetConnectTimeout() time.Duration
• type Dialer
  • func NewDialer() Dialer
  • func NewDialerWithFallback(ctx context.Context, fallback Dialer) Dialer
• type ListenOptions
  • func DefaultListenOptions() *ListenOptions
• type Options
• type Precedence
  • func GetPrecedenceForLabel(p string) Precedence
  • func (p Precedence) String() string
• type ServiceEventType

Constants

const (
	LatencyCheckInterval = 30 * time.Second
	LatencyCheckTimeout  = 10 * time.Second
)

const (
	PrecedenceDefault  Precedence = 0
	PrecedenceRequired Precedence = 1
	PrecedenceFailed   Precedence = 2

	PrecedenceDefaultLabel  = "default"
	PrecedenceRequiredLabel = "required"
	PrecedenceFailedLabel   = "failed"
)

const (
	MfaProviderZiti = "ziti"
)

Variables

var DefaultOptions = &Options{
	RefreshInterval: 5 * time.Minute,
	OnServiceUpdate: nil,
}

Functions

func ForAllContexts

func ForAllContexts(f func(ctx Context) bool)

ForAllContexts iterates over all Ziti contexts loaded from ZITI_IDENTITIES environment variable, or with LoadContext() call

func SetAppInfo

func SetAppInfo(appId, appVersion string)

SetAppInfo sets the `appId` and `appVersion` to provide in SDK Information during all Ziti context authentications

func SetApplication

func SetApplication(theAppId, theAppVersion string)

Types

type Context

type Context interface {
	Authenticate() error
	GetCurrentIdentity() (*edge.CurrentIdentity, error)
	Dial(serviceName string) (edge.Conn, error)
	DialWithOptions(serviceName string, options *DialOptions) (edge.Conn, error)
	// DialAddr finds the service for given address and creates a connection to it
	DialAddr(network string, addr string) (edge.Conn, error)
	Listen(serviceName string) (edge.Listener, error)
	ListenWithOptions(serviceName string, options *ListenOptions) (edge.Listener, error)
	GetServiceId(serviceName string) (string, bool, error)
	GetServices() ([]edge.Service, error)
	GetService(serviceName string) (*edge.Service, bool)

	// GetServiceForAddr finds the service with intercept that matches best to given address
	GetServiceForAddr(network, hostname string, port uint16) (*edge.Service, int, error)
	RefreshServices() error
	GetServiceTerminators(serviceName string, offset, limit int) ([]*edge.Terminator, int, error)
	GetSession(id string) (*edge.Session, error)

	Metrics() metrics.Registry
	// Close closes any connections open to edge routers
	Close()

	// Add a Ziti MFA handler, invoked during authentication
	AddZitiMfaHandler(handler func(query *edge.AuthQuery, resp func(code string) error) error)
	EnrollZitiMfa() (*api.MfaEnrollment, error)
	VerifyZitiMfa(code string) error
	RemoveZitiMfa(code string) error

	Reload() error
}

func LoadContext

func LoadContext(config_ string) (Context, error)

LoadContext returns Ziti context for the given identity file loading it if needed

func NewContext

func NewContext() Context

func NewContextWithConfig

func NewContextWithConfig(cfg *config.Config) Context

func NewContextWithOpts

func NewContextWithOpts(cfg *config.Config, options *Options) Context

type ContextDialer

type ContextDialer interface {
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

type ContextImplTest

type ContextImplTest struct {
	Context
}

func (*ContextImplTest) GetApiSession

func (self *ContextImplTest) GetApiSession() (*edge.ApiSession, error)

func (*ContextImplTest) GetPostureCache

func (self *ContextImplTest) GetPostureCache() (*posture.Cache, error)

func (*ContextImplTest) GetSessions

func (self *ContextImplTest) GetSessions() ([]*edge.Session, error)

type DialOptions

type DialOptions struct {
	ConnectTimeout time.Duration
	Identity       string
	AppData        []byte
}

func (DialOptions) GetConnectTimeout

func (d DialOptions) GetConnectTimeout() time.Duration

type Dialer

type Dialer interface {
	Dial(network, address string) (net.Conn, error)
}

func NewDialer

func NewDialer() Dialer

func NewDialerWithFallback

func NewDialerWithFallback(ctx context.Context, fallback Dialer) Dialer

type ListenOptions

type ListenOptions struct {
	Cost                  uint16
	Precedence            Precedence
	ConnectTimeout        time.Duration
	MaxConnections        int
	Identity              string
	BindUsingEdgeIdentity bool
	ManualStart           bool
}

func DefaultListenOptions

func DefaultListenOptions() *ListenOptions

type Options

type Options struct {
	RefreshInterval time.Duration
	OnContextReady  func(ctx Context)
	OnServiceUpdate serviceCB
}

type Precedence

type Precedence byte

func GetPrecedenceForLabel

func GetPrecedenceForLabel(p string) Precedence

func (Precedence) String

func (p Precedence) String() string

type ServiceEventType

type ServiceEventType string

const (
	ServiceAdded   ServiceEventType = "Added"
	ServiceRemoved ServiceEventType = "Removed"
	ServiceChanged ServiceEventType = "Changed"
)