portforward

Documentation

Index

• type Cmder
• type Logger
• type Loop
  • func NewLoop(settings settings.PortForwarding, routing Routing, client *http.Client, ...) *Loop
  • func (l *Loop) GetPortsForwarded() (ports []uint16)
  • func (l *Loop) Start(_ context.Context) (runError <-chan error, _ error)
  • func (l *Loop) Stop() (err error)
  • func (l *Loop) String() string
  • func (l *Loop) UpdateWith(partialUpdate Settings) (err error)
• type PortAllower
• type Routing
• type Service
• type Settings

Types

type Cmder

type Cmder interface {
	Start(cmd *exec.Cmd) (stdoutLines, stderrLines <-chan string,
		waitError <-chan error, startErr error)
}

type Logger

type Logger interface {
	Debug(s string)
	Info(s string)
	Warn(s string)
	Error(s string)
}

type Loop

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

func NewLoop

func NewLoop(settings settings.PortForwarding, routing Routing,
	client *http.Client, portAllower PortAllower,
	logger Logger, cmder Cmder, uid, gid int,
) *Loop

func (*Loop) GetPortsForwarded

func (l *Loop) GetPortsForwarded() (ports []uint16)

func (*Loop) Start

func (l *Loop) Start(_ context.Context) (runError <-chan error, _ error)

func (*Loop) Stop

func (l *Loop) Stop() (err error)

func (*Loop) String

func (l *Loop) String() string

func (*Loop) UpdateWith

func (l *Loop) UpdateWith(partialUpdate Settings) (err error)

type PortAllower

type PortAllower interface {
	SetAllowedPort(ctx context.Context, port uint16, intf string) (err error)
	RemoveAllowedPort(ctx context.Context, port uint16) (err error)
	RedirectPort(ctx context.Context, intf string, sourcePort,
		destinationPort uint16) (err error)
}

type Routing

type Routing interface {
	VPNLocalGatewayIP(vpnInterface string) (gateway netip.Addr, err error)
	AssignedIP(interfaceName string, family int) (ip netip.Addr, err error)
}

type Service

type Service interface {
	Start(ctx context.Context) (runError <-chan error, err error)
	Stop() (err error)
	GetPortsForwarded() (ports []uint16)
}

type Settings

type Settings struct {
	// VPNIsUp can be optionally set to signal the loop
	// the VPN is up (true) or down (false). If left to nil,
	// it is assumed the VPN is in the same previous state.
	VPNIsUp *bool
	Service service.Settings
}