dehub

Documentation

Index

• Constants
• func CheckPublicKeys(trustedPubKeys ...[]byte) (func(ssh.PublicKey) bool, error)
• func WebsocketDial(ctx context.Context, addr string) (net.Conn, error)
• func WebsocketUpgrade(conn io.ReadWriter) error
• type ClientType
• type Command
  • func (c Command) String() string
• type DB
• type ExecMeta
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Handle(conn io.ReadWriteCloser)
  • func (h *Hub) MustStartRelay() func()
  • func (h *Hub) StartRelay(addr string) (func(), error)
• type HubHeader
• type Logger
• type Master
  • func NewMaster(id ServantID, prvKey ssh.Signer, check func(ssh.PublicKey) bool) *Master
  • func (m *Master) Connect(conn io.ReadWriteCloser) error
  • func (m *Master) Exec(in io.Reader, out io.Writer, cmd string, args ...string) error
  • func (m *Master) ForwardHTTP(listenTo net.Listener) error
  • func (m *Master) ForwardSocks5(listenTo net.Listener) error
  • func (m *Master) ServeNFS(remoteDir string, fsSrv net.Listener, cacheLimit int) error
• type MountDirMeta
• type Servant
  • func NewServant(id ServantID, prvKey ssh.Signer, check func(ssh.PublicKey) bool) *Servant
  • func (s *Servant) Serve(conn io.ReadWriteCloser) func()
• type ServantID
  • func (n ServantID) String() string
• type TunnelHeader

Constants

const (
	UnmarshalMetaFailed ssh.RejectionReason = iota + ssh.ResourceShortage + 1000
	FailedStartPTY
)

const DefaultSignTimeout = 10 * time.Second

const ExecResizeRequest = "resize"

Functions

func CheckPublicKeys

func CheckPublicKeys(trustedPubKeys ...[]byte) (func(ssh.PublicKey) bool, error)

func WebsocketDial

func WebsocketDial(ctx context.Context, addr string) (net.Conn, error)

func WebsocketUpgrade

func WebsocketUpgrade(conn io.ReadWriter) error

Types

type ClientType

type ClientType int

const (
	ClientTypeServant ClientType = iota
	ClientTypeMaster
)

type Command

type Command string

const (
	CommandExec          Command = "exec"
	CommandForwardSocks5 Command = "forward-socks5"
	CommandShareDir      Command = "share-dir"
)

func (Command) String

func (c Command) String() string

type DB

type DB interface {
	StoreLocation(id string, netAddr string) error
	LoadLocation(idPrefix string) (netAddr string, id string, err error)
	DeleteLocation(id string) error
}

DB store the location of which hub node the servant is connected to.

type ExecMeta

type ExecMeta struct {
	Size *pty.Winsize
	Cmd  string
	Args []string
}

type Hub

type Hub struct {
	Logger *slog.Logger

	DB DB

	GetIP func() (string, error)
	// contains filtered or unexported fields
}

func NewHub

func NewHub() *Hub

func (*Hub) Handle

func (h *Hub) Handle(conn io.ReadWriteCloser)

func (*Hub) MustStartRelay

func (h *Hub) MustStartRelay() func()

MustStartRelay is similar to Hub.StartRelay.

func (*Hub) StartRelay

func (h *Hub) StartRelay(addr string) (func(), error)

type HubHeader

type HubHeader struct {
	Type ClientType
	ID   ServantID
}

type Logger

type Logger interface {
	Info(string, ...slog.Attr)
	Warn(string, ...slog.Attr)
	Error(string, ...slog.Attr)
}

type Master

type Master struct {
	Logger *slog.Logger
	// contains filtered or unexported fields
}

func NewMaster

func NewMaster(id ServantID, prvKey ssh.Signer, check func(ssh.PublicKey) bool) *Master

NewMaster creates a new master instance. If the prvKey is nil, it will try ssh agent to use the private key.

func (*Master) Connect

func (m *Master) Connect(conn io.ReadWriteCloser) error

Connect to hub server.

func (*Master) Exec

func (m *Master) Exec(in io.Reader, out io.Writer, cmd string, args ...string) error

func (*Master) ForwardHTTP

func (m *Master) ForwardHTTP(listenTo net.Listener) error

func (*Master) ForwardSocks5

func (m *Master) ForwardSocks5(listenTo net.Listener) error

func (*Master) ServeNFS

func (m *Master) ServeNFS(remoteDir string, fsSrv net.Listener, cacheLimit int) error

type MountDirMeta

type MountDirMeta struct {
	Path       string
	CacheLimit int
}

type Servant

type Servant struct {
	Logger *slog.Logger
	// contains filtered or unexported fields
}

func NewServant

func NewServant(id ServantID, prvKey ssh.Signer, check func(ssh.PublicKey) bool) *Servant

func (*Servant) Serve

func (s *Servant) Serve(conn io.ReadWriteCloser) func()

type ServantID

type ServantID string

func (ServantID) String

func (n ServantID) String() string

type TunnelHeader

type TunnelHeader struct {
	Timestamp    []byte
	PubKeyHash   [md5.Size]byte
	Sign         *ssh.Signature
	Command      Command
	ExecMeta     *ExecMeta
	ShareDirMeta *MountDirMeta
}