tunnel

Documentation

Index

• func NewApoxy4To6Prefix(projectID uuid.UUID, endpoint string) netip.Prefix
• type IPAM
  • func NewRandomULA() IPAM
• type TunnelClient
  • func NewTunnelClient(opts ...TunnelClientOption) (*TunnelClient, error)
  • func (c *TunnelClient) LocalAddresses() ([]netip.Prefix, error)
  • func (c *TunnelClient) Start(ctx context.Context) error
  • func (t *TunnelClient) Stop() error
• type TunnelClientOption
  • func WithAuthToken(token string) TunnelClientOption
  • func WithPcapPath(path string) TunnelClientOption
  • func WithRootCAs(caCerts *x509.CertPool) TunnelClientOption
  • func WithServerAddr(addr string) TunnelClientOption
  • func WithSocksListenAddr(addr string) TunnelClientOption
  • func WithUUID(uuid string) TunnelClientOption
• type TunnelServer
  • func NewTunnelServer(opts ...TunnelServerOption) *TunnelServer
  • func (t *TunnelServer) AddTunnelNode(node *corev1alpha.TunnelNode)
  • func (t *TunnelServer) RemoveTunnelNode(node *corev1alpha.TunnelNode)
  • func (t *TunnelServer) SetupWithManager(mgr ctrl.Manager) error
  • func (t *TunnelServer) Start(ctx context.Context) error
  • func (t *TunnelServer) Stop() error
• type TunnelServerOption
  • func WithCertPath(path string) TunnelServerOption
  • func WithClient(client client.Client) TunnelServerOption
  • func WithIPAM(ipam IPAM) TunnelServerOption
  • func WithKeyPath(path string) TunnelServerOption
  • func WithLocalAddr(prefix netip.Prefix) TunnelServerOption
  • func WithProxyAddr(addr string) TunnelServerOption
  • func WithTUNName(name string) TunnelServerOption
  • func WithULAPrefix(prefix netip.Prefix) TunnelServerOption

Functions

func NewApoxy4To6Prefix

func NewApoxy4To6Prefix(projectID uuid.UUID, endpoint string) netip.Prefix

NewApoxy4To6Prefix generates a new IPv6 address from the Apoxy4To6Range prefix.

Types

type IPAM

type IPAM interface {
	// Allocate allocates an IP address for a peer.
	Allocate(r *http.Request) netip.Prefix

	// Release releases an IP address for a peer. No-op if the address is not allocated
	// (returns nil).
	Release(peerPrefix netip.Prefix) error
}

func NewRandomULA

func NewRandomULA() IPAM

type TunnelClient

type TunnelClient struct {
	// contains filtered or unexported fields
}

func NewTunnelClient

func NewTunnelClient(opts ...TunnelClientOption) (*TunnelClient, error)

NewTunnelClient creates a new SOCKS5 proxy and loopback reverse proxy, that forwards and receives traffic via QUIC tunnels.

func (*TunnelClient) LocalAddresses

func (c *TunnelClient) LocalAddresses() ([]netip.Prefix, error)

Get the local addresses assigned to the tunnel client.

func (*TunnelClient) Start

func (c *TunnelClient) Start(ctx context.Context) error

Start establishes a connection to the server and begins forwarding traffic.

func (*TunnelClient) Stop

func (t *TunnelClient) Stop() error

Stop closes the tunnel client and stops forwarding traffic.

type TunnelClientOption

type TunnelClientOption func(*tunnelClientOptions)

func WithAuthToken

func WithAuthToken(token string) TunnelClientOption

WithAuthToken sets the authentication token for the tunnel client.

func WithPcapPath

func WithPcapPath(path string) TunnelClientOption

WithPcapPath sets the optional path to a packet capture file for the tunnel client.

func WithRootCAs

func WithRootCAs(caCerts *x509.CertPool) TunnelClientOption

WithRootCAs sets the optional root CA certificates for TLS verification.

func WithServerAddr

func WithServerAddr(addr string) TunnelClientOption

WithServerAddr sets the server address that the tunnel client will connect to. The address should be in the format "host:port".

func WithSocksListenAddr

func WithSocksListenAddr(addr string) TunnelClientOption

WithSocksListenAddr sets the listen address for the local SOCKS5 proxy server.

func WithUUID

func WithUUID(uuid string) TunnelClientOption

WithUUID sets the UUID for the tunnel client.

type TunnelServer

type TunnelServer struct {
	http3.Server
	client.Client
	// contains filtered or unexported fields
}

func NewTunnelServer

func NewTunnelServer(opts ...TunnelServerOption) *TunnelServer

NewTunnelServer creates a new server proxy that routes traffic via QUIC tunnels.

func (*TunnelServer) AddTunnelNode

func (t *TunnelServer) AddTunnelNode(node *corev1alpha.TunnelNode)

AddTunnelNode adds a TunnelNode to the server. This is visible for testing purposes, it is usually called as part of the reconcile loop.

func (*TunnelServer) RemoveTunnelNode

func (t *TunnelServer) RemoveTunnelNode(node *corev1alpha.TunnelNode)

RemoveTunnelNode removes a TunnelNode from the server. This is visible for testing purposes, it is usually called as part of the reconcile loop.

func (*TunnelServer) SetupWithManager

func (t *TunnelServer) SetupWithManager(mgr ctrl.Manager) error

func (*TunnelServer) Start

func (t *TunnelServer) Start(ctx context.Context) error

func (*TunnelServer) Stop

func (t *TunnelServer) Stop() error

type TunnelServerOption

type TunnelServerOption func(*tunnelServerOptions)

func WithCertPath

func WithCertPath(path string) TunnelServerOption

WithCertPath sets the path to the TLS certificate.

func WithClient

func WithClient(client client.Client) TunnelServerOption

WithClient sets the kubernetes client to use.

func WithIPAM

func WithIPAM(ipam IPAM) TunnelServerOption

WithIPAM sets the IPAM to use.

func WithKeyPath

func WithKeyPath(path string) TunnelServerOption

WithKeyPath sets the path to the TLS key.

func WithLocalAddr

func WithLocalAddr(prefix netip.Prefix) TunnelServerOption

WithLocalAddr sets the local address prefix.

func WithProxyAddr

func WithProxyAddr(addr string) TunnelServerOption

WithProxyAddr sets the address to bind the proxy to.

func WithTUNName

func WithTUNName(name string) TunnelServerOption

WithTUNName sets the name of the TUN interface.

func WithULAPrefix

func WithULAPrefix(prefix netip.Prefix) TunnelServerOption

WithULAPrefix sets the Unique Local Address prefix.