crew

Documentation

Index

• Constants
• func ConnectErrors() <-chan *terminal.Error
• func EnableConnecting(my *hub.Hub)
• func HandleSluiceRequest(connInfo *network.Connection, conn net.Conn)
• type ConnectOp
  • func NewConnectOp(tunnel *Tunnel) (*ConnectOp, *terminal.Error)
  • func (op *ConnectOp) Abandon(err *terminal.Error)
  • func (op *ConnectOp) Ctx() context.Context
  • func (op *ConnectOp) Deliver(c *container.Container) *terminal.Error
  • func (op *ConnectOp) End(err *terminal.Error) (errorToSend *terminal.Error)
  • func (op *ConnectOp) FmtID() string
  • func (op *ConnectOp) Type() string
• type ConnectRequest
  • func (r *ConnectRequest) Address() string
  • func (r *ConnectRequest) String() string
• type Tunnel
• type TunnelContext
  • func (tc *TunnelContext) GetExitNodeID() string
  • func (tc *TunnelContext) StopTunnel() error
• type TunnelContextHop
• type TunnelContextHopIPInfo

Constants

const ConnectOpType string = "connect"

ConnectOpType is the type ID for the connection operation.

Functions

func ConnectErrors

func ConnectErrors() <-chan *terminal.Error

ConnectErrors returns errors of connect operations. It only has a small and shared buffer and may only be used for indications, not for full monitoring.

func EnableConnecting

func EnableConnecting(my *hub.Hub)

EnableConnecting enables connecting from this Hub.

func HandleSluiceRequest

func HandleSluiceRequest(connInfo *network.Connection, conn net.Conn)

HandleSluiceRequest handles a sluice request to build a tunnel.

Types

type ConnectOp

type ConnectOp struct {
	terminal.OpBase
	*terminal.DuplexFlowQueue
	// contains filtered or unexported fields
}

ConnectOp is used to connect data tunnels to servers on the Internet.

func NewConnectOp

func NewConnectOp(tunnel *Tunnel) (*ConnectOp, *terminal.Error)

NewConnectOp starts a new connect operation.

func (*ConnectOp) Abandon

func (op *ConnectOp) Abandon(err *terminal.Error)

Abandon ends the operation.

func (*ConnectOp) Ctx

func (op *ConnectOp) Ctx() context.Context

Ctx returns the operation context.

func (*ConnectOp) Deliver

func (op *ConnectOp) Deliver(c *container.Container) *terminal.Error

Deliver delivers a messages to the operation.

func (*ConnectOp) End

func (op *ConnectOp) End(err *terminal.Error) (errorToSend *terminal.Error)

End ends the operation.

func (*ConnectOp) FmtID

func (op *ConnectOp) FmtID() string

FmtID formats the operation ID.

func (*ConnectOp) Type

func (op *ConnectOp) Type() string

Type returns the type ID.

type ConnectRequest

type ConnectRequest struct {
	// TODO: Switch to json tags when everyone has the update.
	Domain              string            `cbor:"d,omitempty"`
	IP                  net.IP            `cbor:"ip,omitempty"`
	UsePriorityDataMsgs bool              `cbor:"pr,omitempty"`
	Protocol            packet.IPProtocol `cbor:"p,omitempty"`
	Port                uint16            `cbor:"po,omitempty"`
	QueueSize           uint32            `cbor:"qs,omitempty"`
}

ConnectRequest holds all the information necessary for a connect operation.

func (*ConnectRequest) Address

func (r *ConnectRequest) Address() string

Address returns the address of the connext request.

func (*ConnectRequest) String

func (r *ConnectRequest) String() string

type Tunnel

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

Tunnel represents the local information and endpoint of a data tunnel.

type TunnelContext

type TunnelContext struct {
	Path       []*TunnelContextHop
	PathCost   float32
	RoutingAlg string
	// contains filtered or unexported fields
}

TunnelContext holds additional information about the tunnel to be added to a connection.

func (*TunnelContext) GetExitNodeID

func (tc *TunnelContext) GetExitNodeID() string

GetExitNodeID returns the ID of the exit node. It returns an empty string in case no path exists.

func (*TunnelContext) StopTunnel

func (tc *TunnelContext) StopTunnel() error

StopTunnel stops the tunnel.

type TunnelContextHop

type TunnelContextHop struct {
	ID   string
	Name string
	IPv4 *TunnelContextHopIPInfo `json:",omitempty"`
	IPv6 *TunnelContextHopIPInfo `json:",omitempty"`
}

TunnelContextHop holds hop data for TunnelContext.

type TunnelContextHopIPInfo

type TunnelContextHopIPInfo struct {
	IP      net.IP
	Country string
	ASN     uint
	ASOwner string
}

TunnelContextHopIPInfo holds hop IP data for TunnelContextHop.