Documentation
¶
Index ¶
- Variables
- func DialerWithContext(ctx context.Context, dialer Dialer) context.Context
- func PathToSocket() string
- func SetSysProcAttributes(cmd *exec.Cmd)
- type Client
- func (c *Client) ConnectToTunnel(ctx context.Context, slug, network string, silent bool) (d Dialer, err error)
- func (c *Client) Dialer(ctx context.Context, slug, network string) (d Dialer, err error)
- func (c *Client) Establish(ctx context.Context, slug, network string) (res *EstablishResponse, err error)
- func (c *Client) Instances(ctx context.Context, org, app string) (instances Instances, err error)
- func (c *Client) Kill(ctx context.Context) error
- func (c *Client) LookupTxt(ctx context.Context, slug, host string) (records []string, err error)
- func (c *Client) Ping(ctx context.Context) (res PingResponse, err error)
- func (c *Client) Pinger(ctx context.Context, slug, network string) (p *Pinger, err error)
- func (c *Client) Probe(ctx context.Context, slug, network string) error
- func (c *Client) Reestablish(ctx context.Context, slug, network string) (res *EstablishResponse, err error)
- func (c *Client) Resolve(ctx context.Context, slug, host, network string) (addr string, err error)
- func (c *Client) WaitForDNS(parent context.Context, dialer Dialer, slug, host, network string) (err error)
- func (c *Client) WaitForTunnel(parent context.Context, slug, network string) (err error)
- type Dialer
- type EstablishResponse
- type Instances
- type PingResponse
- type Pinger
Constants ¶
This section is empty.
Variables ¶
var ( ErrNoSuchHost = errors.New("host was not found in DNS") )
var ErrAgentNotRunning = errors.New("agent not running")
Functions ¶
func DialerWithContext ¶ added in v0.0.367
func SetSysProcAttributes ¶ added in v0.1.117
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) ConnectToTunnel ¶
func (c *Client) ConnectToTunnel(ctx context.Context, slug, network string, silent bool) (d Dialer, err error)
ConnectToTunnel is a convenience method for connect to a wireguard tunnel and returning a Dialer. Only suitable for use in the new CLI commands.
func (*Client) Dialer ¶
Dialer establishes a connection to the wireguard agent and return a dialier for use in subsequent actions, such as running ssh commands or opening proxies
func (*Client) Pinger ¶
Pinger creates a Pinger struct. It does this by first ensuring a WireGuard session exists for the specified org, and then opening an additional connection to the agent, which is upgraded to a Pinger connection by sending the "ping6" command. Call "Close" on a Pinger when you're done pinging things.
func (*Client) Reestablish ¶
type Dialer ¶
type Dialer interface {
State() *wg.WireGuardState
Config() *wg.Config
DialContext(ctx context.Context, network, addr string) (net.Conn, error)
}
TODO: refactor to struct
func DialerFromContext ¶ added in v0.0.367
type EstablishResponse ¶
type EstablishResponse struct {
WireGuardState *wg.WireGuardState
TunnelConfig *wg.Config
}
type PingResponse ¶
type Pinger ¶
type Pinger struct {
// contains filtered or unexported fields
}
Pinger wraps a connection to the flyctl agent over which ICMP requests and replies are written. There's a simple protocol for encapsulating requests and responses; drive it with the Pinger member functions. Pinger implements most of net.PacketConn but is not really intended as such.
func (*Pinger) Err ¶
Err returns any non-recoverable error seen on this Pinger connection; WriteTo and ReadFrom on a Pinger will not function if Err returns non-nil.
func (*Pinger) ReadFrom ¶
ReadFrom reads an ICMP message from a Pinger, using the same protocol as WriteTo. Call `SetReadDeadline` to poll this interface while watching channels or whatever.
func (*Pinger) WriteTo ¶
WriteTo writes an ICMP message, including headers, to the specified address. `addr` should always be an IPv6 net.IPAddr beginning with `fdaa` --- you cannot ping random hosts on the Internet with this interface. See golang/x/net/icmp for message construction details; this interface uses gVisor netstack, which is fussy about ICMP, and will only allow icmp.Echo messages with a code of 0.
Pinger runs a trivial protocol to encapsulate ICMP messages over agent connections: each message is a 16-byte IPv6 address, followed by an NBO u16 length, followed by the ICMP message bytes, which again must begin with an ICMP header. Checksums are performed by netstack; don't bother with them.
Source Files
Directories