vnc

Documentation

Overview

Package vnc implements the VNC remote-desktop plugin. The gateway performs RFB authentication to the upstream server (keeping the password server-side) and streams the raw RFB session to the browser's noVNC client.

Index

• Constants
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Connect(_ context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)
  • func (p *Plugin) Manifest() plugin.Manifest
  • func (p *Plugin) Routes() []plugin.Route
• type Session
  • func (s *Session) Close() error
  • func (s *Session) HealthCheck(ctx context.Context) error
  • func (s *Session) OpenChannel(ctx context.Context, req plugin.ChannelRequest) (plugin.Channel, error)

Constants

const CredentialVNCPassword plugin.CredentialKind = "vnc_password"

CredentialVNCPassword is the plugin-owned reusable credential kind: a bare VNC password with no associated identity.

Types

type Plugin

type Plugin struct{}

Plugin exposes a VNC console rendered by noVNC.

func New

func New() *Plugin

func (*Plugin) Connect

func (p *Plugin) Connect(_ context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)

func (*Plugin) Manifest

func (p *Plugin) Manifest() plugin.Manifest

func (*Plugin) Routes

func (p *Plugin) Routes() []plugin.Route

type Session

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

Session holds the per-connection VNC dial parameters. VNC keeps no persistent upstream socket; each desktop channel dials fresh and authenticates.

func (*Session) Close

func (s *Session) Close() error

func (*Session) HealthCheck

func (s *Session) HealthCheck(ctx context.Context) error

func (*Session) OpenChannel

func (s *Session) OpenChannel(ctx context.Context, req plugin.ChannelRequest) (plugin.Channel, error)