derpbind

Documentation

Index

• Constants
• func FetchMap(ctx context.Context, url string) (*tailcfg.DERPMap, error)
• func WrapCustomDERPConnectError(route Route, finalServerURL string, cause error) error
• type Client
  • func NewClient(ctx context.Context, node *tailcfg.DERPNode, serverURL string) (*Client, error)
  • func NewClientWithPrivateKey(ctx context.Context, node *tailcfg.DERPNode, serverURL string, ...) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) ProxyInfo() (ProxyInfo, bool)
  • func (c *Client) PublicKey() key.NodePublic
  • func (c *Client) Receive(ctx context.Context) (Packet, error)
  • func (c *Client) Send(ctx context.Context, dst key.NodePublic, payload []byte) error
  • func (c *Client) Subscribe(filter func(Packet) bool) (<-chan Packet, func())
  • func (c *Client) SubscribeLossless(filter func(Packet) bool) (<-chan Packet, func())
• type Packet
• type ProxyInfo
  • func (i ProxyInfo) DebugString() string
• type Route
  • func NewCustomRoute(host string, derpPort, stunPort uint16) (Route, error)
  • func ParseCustomRoute(raw string) (Route, error)
  • func ParseRouteWire(src []byte) (Route, int, error)
  • func RouteFromEnvironment() (Route, error)
  • func (r Route) AppendWire(dst []byte) ([]byte, error)
  • func (r Route) DERPAuthority() string
  • func (r Route) DERPMap() *tailcfg.DERPMap
  • func (r Route) IsCustom() bool
  • func (r Route) STUNAuthority() string
  • func (r Route) ServerURL() string
  • func (r Route) Validate() error

Constants

const (
	CustomDERPServerEnv = "DERPHOLE_DERP_SERVER"
	DefaultDERPPort     = uint16(443)
	DefaultSTUNPort     = uint16(3478)
	CustomDERPRegionID  = 900
)

const PublicDERPMapURL = "https://controlplane.tailscale.com/derpmap/default"

Functions

func FetchMap

func FetchMap(ctx context.Context, url string) (*tailcfg.DERPMap, error)

func WrapCustomDERPConnectError

func WrapCustomDERPConnectError(route Route, finalServerURL string, cause error) error

WrapCustomDERPConnectError keeps connection diagnostics and the original cause while replacing final DERP URLs with the canonical embedded authority.

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, node *tailcfg.DERPNode, serverURL string) (*Client, error)

func NewClientWithPrivateKey

func NewClientWithPrivateKey(ctx context.Context, node *tailcfg.DERPNode, serverURL string, priv key.NodePrivate) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) ProxyInfo

func (c *Client) ProxyInfo() (ProxyInfo, bool)

func (*Client) PublicKey

func (c *Client) PublicKey() key.NodePublic

func (*Client) Receive

func (c *Client) Receive(ctx context.Context) (Packet, error)

func (*Client) Send

func (c *Client) Send(ctx context.Context, dst key.NodePublic, payload []byte) error

func (*Client) Subscribe

func (c *Client) Subscribe(filter func(Packet) bool) (<-chan Packet, func())

func (*Client) SubscribeLossless

func (c *Client) SubscribeLossless(filter func(Packet) bool) (<-chan Packet, func())

type Packet

type Packet struct {
	From    key.NodePublic
	Payload []byte
}

type ProxyInfo

type ProxyInfo struct {
	Scheme     string
	ProxyAddr  string
	TargetAddr string
}

func (ProxyInfo) DebugString

func (i ProxyInfo) DebugString() string

type Route

type Route struct {
	Host     string `json:"host"`
	DERPPort uint16 `json:"derp_port"`
	STUNPort uint16 `json:"stun_port"`
}

func NewCustomRoute

func NewCustomRoute(host string, derpPort, stunPort uint16) (Route, error)

func ParseCustomRoute

func ParseCustomRoute(raw string) (Route, error)

func ParseRouteWire

func ParseRouteWire(src []byte) (Route, int, error)

func RouteFromEnvironment

func RouteFromEnvironment() (Route, error)

func (Route) AppendWire

func (r Route) AppendWire(dst []byte) ([]byte, error)

func (Route) DERPAuthority

func (r Route) DERPAuthority() string

func (Route) DERPMap

func (r Route) DERPMap() *tailcfg.DERPMap

func (Route) IsCustom

func (r Route) IsCustom() bool

func (Route) STUNAuthority

func (r Route) STUNAuthority() string

func (Route) ServerURL

func (r Route) ServerURL() string

func (Route) Validate

func (r Route) Validate() error