client

package

Go to main page

Versions in this module

v0

v0.3.7

Apr 10, 2026

v0.3.6

Apr 10, 2026

v0.3.5

Apr 10, 2026

v0.3.4

Apr 4, 2026

Changes in this version

+ type Session struct

+ func (s *Session) Close()

+ func (s *Session) Done() <-chan struct{}

+ func (s *Session) IsConnected() bool

v0.3.3

Apr 4, 2026

v0.3.2

Apr 3, 2026

v0.3.1

Apr 2, 2026

Changes in this version

type AttestationConfig

+ AllowedOutboundPorts []int

+ OutboundAllowed bool

type AttestationOptions

+ AllowedOutboundPorts []int

+ OutboundAllowed bool

type BackendConfig

+ Socks5ListenAddr string

type ClientBackendConfig

+ Socks5ListenAddr string

type TokenRequest

+ AllowedOutboundPorts []int

+ OutboundAllowed bool

v0.3.0

Apr 1, 2026

Changes in this version

+ const DefaultHighWaterMark

+ const DefaultLowWaterMark

+ const DefaultMaxBuffer

+ const DisconnectBufferFull

+ const DisconnectDialFailed

+ const DisconnectLocalError

+ const DisconnectNormal

+ const DisconnectPauseViolated

+ const DisconnectSessionEnded

+ const DisconnectShutdown

+ const DisconnectTimeout

+ const DisconnectUnknown

+ const TransportTCP

+ const TransportUDP

+ var ErrNoRoute = errors.New("client: no route configured")

+ type AttestationConfig struct

+ Args []string

+ AuthorizerStatusURI string

+ CacheHandshakeSeconds int

+ Command string

+ Env map[string]string

+ HMACSecret string

+ HMACSecretFile string

+ HandshakeMaxAgeSeconds int

+ MaintenanceGraceCapSeconds int

+ PolicyVersion string

+ ReauthGraceSeconds int

+ ReauthIntervalSeconds int

+ TimeoutSeconds int

+ TokenTTLSeconds int

+ type AttestationOptions struct

+ Args []string

+ AuthorizerStatusURI string

+ CacheHandshake time.Duration

+ Command string

+ Env map[string]string

+ HMACSecret string

+ HMACSecretFile string

+ HandshakeMaxAgeSeconds int

+ MaintenanceGraceCapSeconds int

+ PolicyVersion string

+ ReauthGraceSeconds int

+ ReauthIntervalSeconds int

+ Timeout time.Duration

+ TokenTTL time.Duration

+ type BackendConfig struct

+ Attestation AttestationConfig

+ FlowControl FlowControlConfig

+ HealthChecks HealthCheckConfig

+ Hostname string

+ Hostnames []string

+ Name string

+ NexusAddresses []string

+ PortMappings map[int]PortMapping

+ TCPPorts []int

+ UDPRoutes []UDPRouteConfig

+ Weight int

+ func (b BackendConfig) ToClientConfig(nexusAddr string) ClientBackendConfig

+ type CategorizedError struct

+ Category ErrorCategory

+ Err error

+ Reason string

+ type Client struct

+ func New(cfg ClientBackendConfig, opts ...Option) (*Client, error)

+ func (c *Client) Start(ctx context.Context)

+ func (c *Client) Stats() Stats

+ func (c *Client) StatsDetailed() Stats

+ func (c *Client) Stop()

+ type ClientBackendConfig struct

+ Attestation AttestationOptions

+ FlowControl FlowControlConfig

+ HealthChecks HealthCheckConfig

+ Hostnames []string

+ Name string

+ NexusAddress string

+ PortMappings map[int]PortMapping

+ TCPPorts []int

+ UDPRoutes []UDPRouteConfig

+ Weight int

+ type CommandTokenProvider struct

+ func NewCommandTokenProvider(cfg AttestationOptions) (*CommandTokenProvider, error)

+ func (c *CommandTokenProvider) IssueToken(ctx context.Context, req TokenRequest) (Token, error)

+ type Config struct

+ Backends []BackendConfig

+ func LoadConfig(path string) (*Config, error)

+ type ConnState uint32

+ const ConnStateActive

+ const ConnStateClosed

+ const ConnStateDraining

+ const ConnStatePending

+ type ConnectHandler func(ctx context.Context, req ConnectRequest) (net.Conn, error)

+ type ConnectRequest struct

+ BackendName string

+ ClientID uuid.UUID

+ ClientIP string

+ Hostname string

+ IsTLS bool

+ OriginalHostname string

+ Port int

+ Transport Transport

+ type ConnectionStats struct

+ BufferLevel int

+ BytesIn int64

+ BytesOut int64

+ ClientID string

+ ConnectedAt time.Time

+ Hostname string

+ IsUDP bool

+ LastActivity time.Time

+ Paused bool

+ State ConnState

+ type DisconnectReason = protocol.DisconnectReason

+ type ErrorCategory int

+ const ErrorPermanent

+ const ErrorRateLimit

+ const ErrorTransient

+ type Event struct

+ ClientID string

+ Error error

+ Hostname string

+ Reason string

+ Timestamp time.Time

+ Type EventType

+ type EventHandler func(Event)

+ type EventType int

+ const EventConnected

+ const EventConnectionClosed

+ const EventConnectionOpened

+ const EventDisconnected

+ const EventError

+ const EventPaused

+ const EventReauthCompleted

+ const EventReauthStarted

+ const EventResumed

+ func (e EventType) String() string

+ type FlowControlConfig struct

+ HighWaterMark int

+ LowWaterMark int

+ MaxBuffer int

+ type HMACTokenProvider struct

+ func NewHMACTokenProvider(opts AttestationOptions, backendName string, hostnames []string, ...) (*HMACTokenProvider, error)

+ func (h *HMACTokenProvider) IssueToken(ctx context.Context, req TokenRequest) (Token, error)

+ type HealthCheckConfig struct

+ Enabled bool

+ InactivityTimeout int

+ PongTimeout int

+ type Option func(*Client)

+ func WithConnectHandler(handler ConnectHandler) Option

+ func WithEventHandler(handler EventHandler) Option

+ func WithTokenProvider(provider TokenProvider) Option

+ type PortMapping struct

+ Default string

+ Hosts map[string]string

+ func (pm PortMapping) Resolve(hostname string) (string, bool)

+ type Stats struct

+ ActiveConnections int64

+ BytesReceivedTotal int64

+ BytesSentTotal int64

+ ConnectionStats map[string]ConnectionStats

+ ControlQueueDepth int

+ DataQueueDepth int

+ DroppedConnections int64

+ DroppedEvents int64

+ EnqueueTimeouts int64

+ LastConnectedAt time.Time

+ LastUpdated time.Time

+ MessagesReceivedTotal int64

+ MessagesSentTotal int64

+ PauseViolations int64

+ PausedConnections int64

+ PendingConnections int64

+ PermanentErrors int64

+ RateLimitHits int64

+ ReconnectCount int64

+ SessionUptime time.Duration

+ TotalConnections int64

+ TransientErrors int64

+ UDPDroppedPackets int64

+ type Token struct

+ Expiry time.Time

+ Value string

+ type TokenProvider interface

+ IssueToken func(ctx context.Context, req TokenRequest) (Token, error)

+ type TokenRequest struct

+ BackendName string

+ Hostnames []string

+ SessionNonce string

+ Stage TokenStage

+ TCPPorts []int

+ UDPRoutes []UDPRouteConfig

+ Weight int

+ type TokenStage string

+ const StageAttest

+ const StageHandshake

+ const StageReauth

+ type Transport = protocol.Transport

+ type UDPRouteConfig struct

+ FlowIdleTimeoutSeconds *int

+ Port int

+ func CopyUDPRoutes(in []UDPRouteConfig) []UDPRouteConfig

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL