point_c

README

• Handle requesting 127.0.0.1
• Proxy handler module

Documentation

Index

• func StubListener(_ context.Context, _, addr string, _ net.ListenConfig) (any, error)
• type Dialer
• type Forward
• type Forwarder
• type Forwards
  • func (*Forwards) CaddyModule() caddy.ModuleInfo
  • func (p *Forwards) Cleanup() error
  • func (p *Forwards) Provision(ctx caddy.Context) error
  • func (p *Forwards) Start() error
  • func (p *Forwards) Stop() error
  • func (p *Forwards) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
• type Listener
  • func (p *Listener) Accept() (net.Conn, error)
  • func (p *Listener) Addr() net.Addr
  • func (*Listener) CaddyModule() caddy.ModuleInfo
  • func (p *Listener) Close() error
  • func (p *Listener) Provision(ctx caddy.Context) error
  • func (p *Listener) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
• type MultiWrapper
  • func (p *MultiWrapper) CaddyModule() caddy.ModuleInfo
  • func (p *MultiWrapper) Cleanup() (err error)
  • func (p *MultiWrapper) Provision(ctx caddy.Context) error
  • func (p *MultiWrapper) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (p *MultiWrapper) WrapListener(ls net.Listener) net.Listener
• type Net
• type NetLookup
• type Network
• type Pointc
  • func (*Pointc) CaddyModule() caddy.ModuleInfo
  • func (wg *Pointc) Lookup(name string) (Net, bool)
  • func (wg *Pointc) Provision(ctx caddy.Context) error
  • func (*Pointc) Start() error
  • func (*Pointc) Stop() error
  • func (wg *Pointc) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
• type PortPair
  • func (pp *PortPair) Dst() uint16
  • func (pp *PortPair) Host() (net.IP, bool)
  • func (pp *PortPair) IsUDP() bool
  • func (pp *PortPair) Src() uint16
  • func (pp *PortPair) UnmarshalText(b []byte) error
  • func (pp *PortPair) Value() *PortPair

Functions

func StubListener

func StubListener(_ context.Context, _, addr string, _ net.ListenConfig) (any, error)

StubListener creates a stub network listener. This listener does not accept actual network connections but instead blocks on Accept calls until Close is called. It can be used as a base listener when only tunnel listeners are required.

Types

type Dialer

type Dialer interface {
	// Dial dials a remote address with the TCP protocol.
	Dial(context.Context, *net.TCPAddr) (net.Conn, error)
	// DialPacket dials a remote address with the UDP protocol.
	DialPacket(*net.UDPAddr) (net.PacketConn, error)
}

type Forward

type Forward struct {
	Name  configvalues.Hostname
	Ports []*configvalues.CaddyTextUnmarshaler[*PortPair, PortPair, *PortPair]
}

type Forwarder

type Forwarder struct {
	Net  Net
	Dst  uint16
	Addr caddy.NetworkAddress
	Ctx  caddy.Context
}

type Forwards

type Forwards struct {
	Forwards []*Forward `json:"forwards,omitempty"`
	// contains filtered or unexported fields
}

func (*Forwards) CaddyModule

func (*Forwards) CaddyModule() caddy.ModuleInfo

func (*Forwards) Cleanup

func (p *Forwards) Cleanup() error

func (*Forwards) Provision

func (p *Forwards) Provision(ctx caddy.Context) error

func (*Forwards) Start

func (p *Forwards) Start() error

func (*Forwards) Stop

func (p *Forwards) Stop() error

func (*Forwards) UnmarshalCaddyfile

func (p *Forwards) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile unmarshals a submodules from a caddyfile.

{
  forward <net name> {
    [<host>:]<src>:<dst>[/<tcp|udp>]
  }
}

type Listener

type Listener struct {
	Name configvalues.Hostname `json:"name"`
	Port configvalues.Port     `json:"port"`
	// contains filtered or unexported fields
}

Listener allows a caddy server to listen on a point-c network.

func (*Listener) Accept

func (p *Listener) Accept() (net.Conn, error)

func (*Listener) Addr

func (p *Listener) Addr() net.Addr

func (*Listener) CaddyModule

func (*Listener) CaddyModule() caddy.ModuleInfo

func (*Listener) Close

func (p *Listener) Close() error

func (*Listener) Provision

func (p *Listener) Provision(ctx caddy.Context) error

func (*Listener) UnmarshalCaddyfile

func (p *Listener) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile unmarshals the caddyfile.

{
  servers :443 {
    listener_wrappers {
      merge {
        point-c <network name> <port to expose>
      }
      tls
    }
  }
}

type MultiWrapper

type MultiWrapper struct {
	// ListenerRaw is a slice of JSON-encoded data representing listener configurations.
	// These configurations are used to create the actual net.Listener instances.
	// Listeners should implement [net.Listener] and be in the 'caddy.listeners.multi.listeners' namespace.
	ListenerRaw []json.RawMessage `json:"listeners" caddy:"namespace=caddy.listeners.multi.listeners inline_key=listener"`
	// contains filtered or unexported fields
}

MultiWrapper loads multiple [net.Listener]s and aggregates their [net.Conn]s into a single net.Listener. It allows caddy to accept connections from multiple sources.

func (*MultiWrapper) CaddyModule

func (p *MultiWrapper) CaddyModule() caddy.ModuleInfo

CaddyModule implements caddy.Module.

func (*MultiWrapper) Cleanup

func (p *MultiWrapper) Cleanup() (err error)

Cleanup implements caddy.CleanerUpper. All wrapped listeners are closed and the struct is cleared.

func (*MultiWrapper) Provision

func (p *MultiWrapper) Provision(ctx caddy.Context) error

Provision implements caddy.Provisioner. It loads the listeners from their configs and asserts them to net.Listener. Any failed assertions will cause a panic.

func (*MultiWrapper) UnmarshalCaddyfile

func (p *MultiWrapper) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler. Must have at least one listener to aggregate with the wrapped listener. `tls` should come specifically after any `multi` directives.

 http caddyfile:
	{
	  servers :443 {
	    listener_wrappers {
	      multi {
	        <submodule name> <submodule config>
	      }
	      tls
	    }
	  }
	}

func (*MultiWrapper) WrapListener

func (p *MultiWrapper) WrapListener(ls net.Listener) net.Listener

WrapListener implements caddy.ListenerWrapper. The listener passed in is closed by MultiWrapper during cleanup.

type Net

type Net interface {
	// Listen listens on the given address with the TCP protocol.
	Listen(addr *net.TCPAddr) (net.Listener, error)
	// ListenPacket listens on the given address with the UDP protocol.
	ListenPacket(addr *net.UDPAddr) (net.PacketConn, error)
	// Dialer returns a [Dialer] with a given local address. If the network does not support arbitrary remote addresses this value can be ignored.
	Dialer(laddr net.IP, port uint16) Dialer
	// LocalAddr is the local address of the net interface. If it does not have one, return nil.
	LocalAddr() net.IP
}

Net is a peer in the networking stack. If it has a local address [Net.LocalAddress] should return a non-nil value.

type NetLookup

type NetLookup interface {
	Lookup(string) (Net, bool)
}

type Network

type Network interface {
	Networks() map[string]Net
}

Network is a map of a unique name to a Net tunnel. Since ip addresses may be arbitrary depending on what the application is doing in the tunnel, names are used as lookup. This allows helps with configuration, so that users don't need to remember ip addresses.

type Pointc

type Pointc struct {
	NetworksRaw []json.RawMessage `json:"networks,omitempty" caddy:"namespace=point-c.net inline_key=type"`
	// contains filtered or unexported fields
}

Pointc allows usage of networks through a net-ish interface.

func (*Pointc) CaddyModule

func (*Pointc) CaddyModule() caddy.ModuleInfo

func (*Pointc) Lookup

func (wg *Pointc) Lookup(name string) (Net, bool)

Lookup gets a Net by its declared name.

func (*Pointc) Provision

func (wg *Pointc) Provision(ctx caddy.Context) error

func (*Pointc) Start

func (*Pointc) Start() error

func (*Pointc) Stop

func (*Pointc) Stop() error

func (*Pointc) UnmarshalCaddyfile

func (wg *Pointc) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile unmarshals a submodules from a caddyfile.

{
  point-c {
    <submodule name> <submodule config>
  }
}

type PortPair

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

PortPair is a [<host>:]<src>:<dst>[/<tcp|udp>] port pair.

func (*PortPair) Dst

func (pp *PortPair) Dst() uint16

func (*PortPair) Host

func (pp *PortPair) Host() (net.IP, bool)

func (*PortPair) IsUDP

func (pp *PortPair) IsUDP() bool

func (*PortPair) Src

func (pp *PortPair) Src() uint16

func (*PortPair) UnmarshalText

func (pp *PortPair) UnmarshalText(b []byte) error

func (*PortPair) Value

func (pp *PortPair) Value() *PortPair