Documentation
¶
Index ¶
- Constants
- func IP() netip.Addr
- func NewDERPMap(ctx context.Context, region *tailcfg.DERPRegion, stunAddrs []string, ...) (*tailcfg.DERPMap, error)
- type AgentConnMsg
- type AgentConnMsgType
- type Conn
- func (c *Conn) AwaitReachable(ctx context.Context, ip netip.Addr) bool
- func (c *Conn) Close() error
- func (c *Conn) Closed() <-chan struct{}
- func (c *Conn) ConnectToCoordinator(conn net.Conn) <-chan error
- func (c *Conn) DERPMap() *tailcfg.DERPMap
- func (c *Conn) DialContextTCP(ctx context.Context, ipp netip.AddrPort) (*gonet.TCPConn, error)
- func (c *Conn) DialContextUDP(ctx context.Context, ipp netip.AddrPort) (*gonet.UDPConn, error)
- func (c *Conn) Listen(network, addr string) (net.Listener, error)
- func (c *Conn) Node() *Node
- func (c *Conn) Ping(ctx context.Context, ip netip.Addr) (time.Duration, bool, *ipnstate.PingResult, error)
- func (c *Conn) RemoveAllPeers() error
- func (c *Conn) SetConnStatsCallback(maxPeriod time.Duration, maxConns int, dump func(start, end time.Time, ...))
- func (c *Conn) SetDERPMap(derpMap *tailcfg.DERPMap)
- func (c *Conn) SetForwardTCPCallback(callback func(conn net.Conn, listenerExists bool) net.Conn)
- func (c *Conn) SetNodeCallback(callback func(node *Node))
- func (c *Conn) Status() *ipnstate.Status
- func (c *Conn) UpdateNodes(nodes []*Node) error
- func (c *Conn) UpdateNodesClear(nodes []*Node) error
- type ConnType
- type ConnectionMetadata
- type Coordinator
- type Node
- type Options
Constants ¶
const ( // AgentPrefix is the prefix key that is used to save an agent's tailnet node information to the cluster state AgentPrefix = "ts/coord/agent" // ServerPrefix is the prefix key that is used to save a server's tailnet node information to the cluster state ServerPrefix = "ts/coord/server" // ConnectionPrefix is the prefix key that is used to save a connection's tailnet information to the cluster state ConnectionPrefix = "ts/coord/connection" )
Variables ¶
This section is empty.
Functions ¶
func NewDERPMap ¶
func NewDERPMap(ctx context.Context, region *tailcfg.DERPRegion, stunAddrs []string, remoteURL, localPath string) (*tailcfg.DERPMap, error)
NewDERPMap constructs a DERPMap from a set of STUN addresses and optionally a remote URL to fetch a mapping from e.g. https://controlplane.tailscale.com/derpmap/default.
Types ¶
type AgentConnMsg ¶
type AgentConnMsg struct {
Type AgentConnMsgType `json:"type"`
AgentID int64 `json:"agent_id"`
Node Node `json:"node"`
}
AgentConnMsg is the metadata of an agent
type AgentConnMsgType ¶
type AgentConnMsgType int
const ( AgentConnMsgTypeAdd AgentConnMsgType = iota AgentConnMsgTypeRemove )
type Conn ¶
type Conn struct {
// contains filtered or unexported fields
}
Conn is an actively listening Wireguard connection.
func NewConn ¶
NewConn constructs a new Wireguard server that will accept connections from the addresses provided.
func (*Conn) AwaitReachable ¶
AwaitReachable pings the provided IP continually until the address is reachable. It's the callers responsibility to provide a timeout, otherwise this function will block forever.
func (*Conn) Closed ¶
func (c *Conn) Closed() <-chan struct{}
Closed is a channel that ends when the connection has been closed.
func (*Conn) ConnectToCoordinator ¶
ConnectToCoordinator Connects the connection to the provided coordinator connection and processes network updates automatically.
func (*Conn) DialContextTCP ¶
func (*Conn) DialContextUDP ¶
func (*Conn) Listen ¶
Listen announces only on the Tailscale network. It will start the server if it has not been started yet.
func (*Conn) Ping ¶
func (c *Conn) Ping(ctx context.Context, ip netip.Addr) (time.Duration, bool, *ipnstate.PingResult, error)
Ping sends a Disco ping to the Wireguard engine. The bool returned is true if the ping was performed P2P.
func (*Conn) SetConnStatsCallback ¶
func (c *Conn) SetConnStatsCallback(maxPeriod time.Duration, maxConns int, dump func(start, end time.Time, virtual, physical map[netlogtype.Connection]netlogtype.Counts))
SetConnStatsCallback sets a callback to be called after maxPeriod or maxConns, whichever comes first. Multiple calls overwrites the callback.
func (*Conn) SetDERPMap ¶
SetDERPMap updates the DERPMap of a connection.
func (*Conn) SetForwardTCPCallback ¶
SetForwardTCPCallback is called every time a TCP connection is initiated inbound. listenerExists is true if a listener is registered for the target port. If there isn't one, traffic is forwarded to the local listening port.
This allows wrapping a Conn to track reads and writes.
func (*Conn) SetNodeCallback ¶
func (*Conn) UpdateNodes ¶
UpdateNodes connects with a set of peers. This can be constantly updated, and peers will continually be reconnected as necessary.
func (*Conn) UpdateNodesClear ¶
UpdateNodesClear removes all peers and then adds the provided peers.
type ConnectionMetadata ¶
type ConnectionMetadata struct {
// ID is the unique ID of the connection
ID int64 `json:"_id"`
// AgentID is the unique ID of the agent
AgentID int64 `json:"agent_id"`
// ServerID is the unique ID of the server
ServerID int64 `json:"server_id"`
// CreatedAt is the time the connection was created
CreatedAt time.Time `json:"created_at"`
}
ConnectionMetadata is the metadata associated with a connection
type Coordinator ¶
type Coordinator struct {
// contains filtered or unexported fields
}
Coordinator exchanges nodes with agents to establish connections. ┌──────────────────┐ ┌────────────────────┐ ┌───────────────────┐ ┌──────────────────┐ │tailnet.Coordinate├──►│tailnet.AcceptClient│◄─►│tailnet.AcceptAgent│◄──┤tailnet.Coordinate│ └──────────────────┘ └────────────────────┘ └───────────────────┘ └──────────────────┘
func NewCoordinator ¶
func NewCoordinator(clusterNode cluster.Node, jsClient *mq.JetstreamClient, logger logging.Logger) (*Coordinator, error)
NewCoordinator constructs a new in-memory connection Coordinator. This Coordinator is incompatible with multiple Coder replicas as all node data is in-memory.
func (*Coordinator) Agent ¶
func (c *Coordinator) Agent(id int64) (*Node, error)
Agent
Returns the tailscale node for the passed agent ID. If the agent does not exist, nil is returned.
func (*Coordinator) Close ¶
func (c *Coordinator) Close() error
Close closes all of the open connections in the Coordinator and stops the Coordinator from accepting new connections.
func (*Coordinator) ServeAgent ¶
func (c *Coordinator) ServeAgent(conn net.Conn, agent int64) error
ServeAgent accepts a WebSocket connection to an agent that listens to incoming connections and publishes node updates.
func (*Coordinator) ServeClient ¶
ServeClient accepts a WebSocket connection that wants to connect to an agent with the specified ID.
type Node ¶
type Node struct {
// ID is used to identify the connection.
ID tailcfg.NodeID `json:"id"`
// AsOf is the time the node was created.
AsOf time.Time `json:"as_of"`
// Key is the Wireguard public key of the node.
Key key.NodePublic `json:"key"`
// DiscoKey is used for discovery messages over DERP to establish peer-to-peer connections.
DiscoKey key.DiscoPublic `json:"disco"`
// PreferredDERP is the DERP server that peered connections
// should meet at to establish.
PreferredDERP int `json:"preferred_derp"`
// DERPLatency is the latency in seconds to each DERP server.
DERPLatency map[string]float64 `json:"derp_latency"`
// Addresses are the IP address ranges this connection exposes.
Addresses []netip.Prefix `json:"addresses"`
// AllowedIPs specify what addresses can dial the connection.
// We allow all by default.
AllowedIPs []netip.Prefix `json:"allowed_ips"`
// Endpoints are ip:port combinations that can be used to establish
// peer-to-peer connections.
Endpoints []string `json:"endpoints"`
}
Node represents a node in the network.
Source Files
Directories