control

package

Go to main page

Versions in this module

v0

v0.13.2

Jan 14, 2026

v0.13.1

Jan 13, 2026

Changes in this version

type RelayDirectValue

+ AuthenticationSealKey *[32]byte

type Status

+ BuildVersion string

v0.13.0

Jan 12, 2026

Changes in this version

type ClientRelays

+ Directs func(ctx context.Context, endpoint model.Endpoint, role model.Role, ...) error

+ type RelayDirectValue struct

+ Authentication RelayAuthentication

+ AuthenticationSignKey ed25519.PrivateKey

+ Certificate *x509.Certificate

+ Hostports []model.HostPort

+ Metadata string

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

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

type Stores

+ RelayDirects func() (logc.KV[RelayConnKey, RelayDirectValue], error)

v0.12.0

Jan 11, 2026

Changes in this version

+ var ClientIDNil = ClientID

+ var RelayIDNil = RelayID

+ type ClientAuthenticateRequest struct

+ Addr net.Addr

+ BuildVersion string

+ Proto model.ClientControlNextProto

+ Token string

+ type ClientAuthentication []byte

+ type ClientAuthenticator interface

+ Authenticate func(req ClientAuthenticateRequest) (ClientAuthentication, error)

+ Validate func(auth ClientAuthentication, endpoint model.Endpoint, role model.Role) (model.Endpoint, error)

+ type ClientConnKey struct

+ ID ClientID

+ type ClientConnValue struct

+ Addr string

+ Authentication ClientAuthentication

+ Metadata string

+ type ClientID struct

+ func NewClientID() ClientID

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

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

+ func (k ClientID) String() string

+ type ClientPeerKey struct

+ Endpoint model.Endpoint

+ ID ClientID

+ Role model.Role

+ type ClientPeerValue struct

+ Metadata string

+ Peer *pbclient.Peer

+ type ClientRelays interface

+ Client func(ctx context.Context, endpoint model.Endpoint, role model.Role, ...) error

+ type Config struct

+ ClientsAuth ClientAuthenticator

+ ClientsIngress []Ingress

+ Logger *slog.Logger

+ RelaysAuth RelayAuthenticator

+ RelaysIngress []Ingress

+ Stores Stores

+ type ConfigKey string

+ type ConfigValue struct

+ Bytes []byte

+ Int64 int64

+ String string

+ 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 RelayAuthenticateRequest struct

+ Addr net.Addr

+ BuildVersion string

+ Proto model.RelayControlNextProto

+ Token string

+ type RelayAuthentication []byte

+ type RelayAuthenticator interface

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

+ Authenticate func(req RelayAuthenticateRequest) (RelayAuthentication, error)

+ type RelayClientKey struct

+ Endpoint model.Endpoint

+ Key model.Key

+ Role model.Role

+ type RelayClientValue struct

+ Authentication ClientAuthentication

+ Cert *x509.Certificate

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

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

+ type RelayConnKey struct

+ ID RelayID

+ type RelayConnValue struct

+ Authentication RelayAuthentication

+ Hostports []model.HostPort

+ Metadata string

+ type RelayEndpointKey struct

+ Endpoint model.Endpoint

+ type RelayEndpointValue struct

+ Cert *x509.Certificate

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

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

+ type RelayID struct

+ func NewRelayID() RelayID

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

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

+ func (k RelayID) String() string

+ type RelayServerKey struct

+ Endpoint model.Endpoint

+ RelayID RelayID

+ type RelayServerValue struct

+ Cert *x509.Certificate

+ Hostports []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

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

+ type Status struct

+ ClientIngresses []StatusIngress

+ Clients map[string]StatusClient

+ Endpoints map[string]StatusEndpoint

+ RelayIngresses []StatusIngress

+ RelayServerID string

+ Relays map[string]StatusRelay

+ type StatusClient struct

+ Address string

+ ID ClientID

+ 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 struct

+ Hostports []string

+ ID RelayID

+ Metadata string

+ 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)

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

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

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

+ func NewFileStores(dir string) Stores

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