control

Dec 28, 2025

Changes in this version

type ClientConnValue

+ Metadata string

type ClientID

+ func (k ClientID) String() string

type ClientPeerValue

+ Metadata string

type RelayConnValue

+ Metadata string

type RelayID

+ func (k RelayID) String() string

type Status

+ ClientIngresses []StatusIngress

+ Endpoints map[string]StatusEndpoint

+ RelayIngresses []StatusIngress

+ RelayServerID string

type StatusClient

+ Metadata string

+ type StatusEndpoint struct

+ Destinations []ClientID

+ Endpoint model.Endpoint

+ Sources []ClientID

+ type StatusIngress struct

+ Address string

+ Restrictions restr.IP

+ func StatusIngressFn(ing Ingress) StatusIngress

type StatusRelay

+ Metadata string

Dec 13, 2025

Changes in this version

+ var ClientIDNil = ClientID

+ var RelayIDNil = RelayID

+ type ClientID struct

+ func NewClientID() ClientID

+ func (k *ClientID) UnmarshalText(b []byte) error

+ func (k ClientID) MarshalText() ([]byte, error)

+ type RelayID struct

+ func NewRelayID() RelayID

+ func (k *RelayID) UnmarshalText(b []byte) error

+ func (k RelayID) MarshalText() ([]byte, error)

Jul 7, 2025

Changes in this version

type ClientPeerKey

+ Endpoint model.Endpoint

+ func (v *ClientPeerKey) UnmarshalJSON(b []byte) error

type RelayClientKey

+ Endpoint model.Endpoint

+ func (v *RelayClientKey) UnmarshalJSON(b []byte) error

+ type RelayEndpointKey struct

+ Endpoint model.Endpoint

+ func (v *RelayEndpointKey) UnmarshalJSON(b []byte) error

+ type RelayEndpointValue struct

+ Cert *x509.Certificate

+ func (v *RelayEndpointValue) UnmarshalJSON(b []byte) error

+ func (v RelayEndpointValue) MarshalJSON() ([]byte, error)

type RelayServerKey

+ Endpoint model.Endpoint

+ func (v *RelayServerKey) UnmarshalJSON(b []byte) error

type StatusPeer

+ Endpoint model.Endpoint

type Stores

+ RelayEndpoints func(id ksuid.KSUID) (logc.KV[RelayEndpointKey, RelayEndpointValue], error)

May 2, 2025

Changes in this version

type Config

+ ClientsIngress []Ingress

+ RelaysIngress []Ingress

+ type Ingress struct

+ Addr *net.UDPAddr

+ Restr restr.IP

+ TLS *tls.Config

+ type IngressBuilder struct

+ func NewIngressBuilder() *IngressBuilder

+ func (b *IngressBuilder) Error() error

+ func (b *IngressBuilder) Ingress() (Ingress, error)

+ func (b *IngressBuilder) WithAddr(addr *net.UDPAddr) *IngressBuilder

+ func (b *IngressBuilder) WithAddrFrom(addrStr string) *IngressBuilder

+ func (b *IngressBuilder) WithRestr(iprestr restr.IP) *IngressBuilder

+ func (b *IngressBuilder) WithRestrFrom(allows []string, denies []string) *IngressBuilder

+ func (b *IngressBuilder) WithTLS(cfg *tls.Config) *IngressBuilder

+ func (b *IngressBuilder) WithTLSCert(cert tls.Certificate) *IngressBuilder

+ func (b *IngressBuilder) WithTLSCertFrom(certFile, keyFile string) *IngressBuilder

type RelayConnValue

+ Hostports []model.HostPort

type RelayServerValue

+ Hostports []model.HostPort

type StatusRelay

+ Hostports []string

Apr 18, 2025

Changes in this version

type ClientAuthenticator

+ Validate func(auth ClientAuthentication, fwd model.Forward, role model.Role) (model.Forward, error)

type RelayAuthenticator

+ Allow func(reAuth RelayAuthentication, clAuth ClientAuthentication, fwd model.Forward) (bool, error)

type RelayClientValue

+ Authentication ClientAuthentication

Apr 15, 2025

Changes in this version

+ type ClientAuthenticateRequest struct

+ Addr net.Addr

+ BuildVersion string

+ Proto model.ClientToControlProto

+ Token string

+ type RelayAuthenticateRequest struct

+ Addr net.Addr

+ BuildVersion string

+ Proto model.RelayToControlProto

+ Token string

Jan 24, 2025

Changes in this version

type Config

+ ClientsAddr *net.UDPAddr

+ ClientsAuth ClientAuthenticator

+ ClientsRestr restr.IP

+ RelaysAddr *net.UDPAddr

+ RelaysAuth RelayAuthenticator

+ RelaysRestr restr.IP

Jan 11, 2025

Changes in this version

type Config

+ ClientRestr netc.IPRestriction

+ RelayRestr netc.IPRestriction

+ StatusAddr *net.TCPAddr

type Server

+ func (s *Server) Status(ctx context.Context) (Status, error)

+ type Status struct

+ Clients []StatusClient

+ Peers []StatusPeer

+ Relays []StatusRelay

+ ServerID string

+ type StatusClient struct

+ Addr string

+ ID ksuid.KSUID

+ type StatusPeer struct

+ Forward model.Forward

+ ID ksuid.KSUID

+ Role model.Role

+ type StatusRelay struct

+ Hostport string

+ ID ksuid.KSUID

Dec 29, 2024

Changes in this version

+ type ClientAuthentication interface

+ Validate func(fwd model.Forward, role model.Role) (model.Forward, error)

+ type ClientAuthenticator interface

+ Authenticate func(token string) (ClientAuthentication, error)

+ type ClientConnKey struct

+ ID ksuid.KSUID

+ type ClientConnValue struct

+ Addr string

+ Authentication []byte

+ type ClientPeerKey struct

+ Forward model.Forward

+ ID ksuid.KSUID

+ Role model.Role

+ type ClientPeerValue struct

+ Peer *pbs.ClientPeer

+ type ClientRelays interface

+ Client func(ctx context.Context, fwd model.Forward, role model.Role, ...) error

+ type Config struct

+ Addr *net.UDPAddr

+ Cert tls.Certificate

+ ClientAuth ClientAuthenticator

+ Logger *slog.Logger

+ RelayAuth RelayAuthenticator

+ Stores Stores

+ type ConfigKey string

+ type ConfigValue struct

+ Bytes []byte

+ Int64 int64

+ String string

+ type RelayAuthentication interface

+ Allow func(fwd model.Forward) bool

+ type RelayAuthenticator interface

+ Authenticate func(token string) (RelayAuthentication, error)

+ type RelayClientKey struct

+ Forward model.Forward

+ Key certc.Key

+ Role model.Role

+ type RelayClientValue struct

+ Cert *x509.Certificate

+ func (v *RelayClientValue) UnmarshalJSON(b []byte) error

+ func (v RelayClientValue) MarshalJSON() ([]byte, error)

+ type RelayConnKey struct

+ ID ksuid.KSUID

+ type RelayConnValue struct

+ Authentication []byte

+ Hostport model.HostPort

+ type RelayForwardKey struct

+ Forward model.Forward

+ type RelayForwardValue struct

+ Cert *x509.Certificate

+ func (v *RelayForwardValue) UnmarshalJSON(b []byte) error

+ func (v RelayForwardValue) MarshalJSON() ([]byte, error)

+ type RelayServerKey struct

+ Forward model.Forward

+ RelayID ksuid.KSUID

+ type RelayServerValue struct

+ Cert *x509.Certificate

+ Hostport model.HostPort

+ func (v *RelayServerValue) UnmarshalJSON(b []byte) error

+ func (v RelayServerValue) MarshalJSON() ([]byte, error)

+ type Server struct

+ func NewServer(cfg Config) (*Server, error)

+ func (s *Server) Run(ctx context.Context) error

+ type Stores interface

+ ClientConns func() (logc.KV[ClientConnKey, ClientConnValue], error)

+ ClientPeers func() (logc.KV[ClientPeerKey, ClientPeerValue], error)

+ Config func() (logc.KV[ConfigKey, ConfigValue], error)

+ RelayClients func() (logc.KV[RelayClientKey, RelayClientValue], error)

+ RelayConns func() (logc.KV[RelayConnKey, RelayConnValue], error)

+ RelayForwards func(id ksuid.KSUID) (logc.KV[RelayForwardKey, RelayForwardValue], error)

+ RelayServerOffsets func() (logc.KV[RelayConnKey, int64], error)

+ RelayServers func() (logc.KV[RelayServerKey, RelayServerValue], error)

+ func NewFileStores(dir string) Stores

+ func NewTmpFileStores() (Stores, error)