rfb

package
v0.0.0-...-67eda22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 8, 2021 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package rfb defines representations and serialization for messages in the RFB (Remote Framebuffer) protocol, which is used for VNC.

Types that do not not have a protocol version suffix such as "RFB33" are appropriate for use with all known versions of the RFB protocol.

See the RFCs for details, but the initial handshake goes like this: 

server sends ProtocolVersionMessage
client sends ProtocolVersionMessage
server sends AuthenticationSchemeMessageRFB33
	If AuthenticationSchemeNone:
		continue
	If AuthenticationSchemeVNC:
		server sends VNCAuthenticationChallengeMessage
		client sends VNCAuthenticationResponseMessage
		server sends VNCAuthenticationResultMessage
client sends ClientInitialisationMessage
server sends ServerInitialisationMessage

Thereafter, client and server enter message processing loops. The first byte identifies the message type, which dictates the length of the payload, so all clients and servers must process all event types. Each message's Read function verifies the presence of the message type byte.

Clients may send: 

Type 0	SetPixelFormatMessage
Type 1	FixColourMapEntries — uncommon, not implemented by this library
Type 2	SetEncodingsMessage
Type 3	FramebufferUpdateRequestMessage
Type 4	KeyEventMessage
Type 5	PointerEventMessage
Type 6	ClientCutTextMessage

Servers may send: 

Type 0	FramebufferUpdateMessage — only in response to FramebufferUpdateRequestMessage
Type 1	SetColourMapEntries — uncommon, not implemented by this library
Type 2	BellMessage
Type 3	ServerCutTextMessage

Index

Constants

View Source 
const (
	AuthenticationSchemeInvalid = AuthenticationScheme(0)
	AuthenticationSchemeNone    = AuthenticationScheme(1)
	AuthenticationSchemeVNC     = AuthenticationScheme(2)
)
View Source 
const (
	VNCAuthenticationResultOK      = VNCAuthenticationResult(0)
	VNCAuthenticationResultFailed  = VNCAuthenticationResult(1)
	VNCAuthenticationResultTooMany = VNCAuthenticationResult(2)
)
View Source 
const (
	EncodingTypeRaw           = uint32(0)
	EncodingTypeCopyRectangle = uint32(1)
	EncodingTypeRRE           = uint32(2)
	EncodingTypeCoRRE         = uint32(4)
	EncodingTypeHextile       = uint32(5)
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationScheme 

type AuthenticationScheme uint32

type AuthenticationSchemeMessageRFB33 

type AuthenticationSchemeMessageRFB33 struct {
	Scheme AuthenticationScheme
}

func (*AuthenticationSchemeMessageRFB33) Read 

func (m *AuthenticationSchemeMessageRFB33) Read(r io.Reader, bo binary.ByteOrder) error

func (*AuthenticationSchemeMessageRFB33) Write 

func (m *AuthenticationSchemeMessageRFB33) Write(w io.Writer, bo binary.ByteOrder) error

type BellMessage 

type BellMessage struct{}

func (*BellMessage) Read 

func (m *BellMessage) Read(r io.Reader) error

func (*BellMessage) Write 

func (m *BellMessage) Write(w io.Writer) error

type ClientCutTextMessage 

type ClientCutTextMessage struct {
	Text string
}

func (*ClientCutTextMessage) Read 

func (m *ClientCutTextMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*ClientCutTextMessage) Write 

func (m *ClientCutTextMessage) Write(w io.Writer, bo binary.ByteOrder) error

type ClientInitialisationMessage 

type ClientInitialisationMessage struct {
	// If true, share the desktop with other clients.
	// If false, disconnect all other clients.
	Shared bool
}

func (*ClientInitialisationMessage) Read 

func (m *ClientInitialisationMessage) Read(r io.Reader) error

func (*ClientInitialisationMessage) Write 

func (m *ClientInitialisationMessage) Write(w io.Writer) error

type FramebufferUpdateMessage 

type FramebufferUpdateMessage struct {
	Rectangles []*FramebufferUpdateRect
}

func (*FramebufferUpdateMessage) Read 

func (m *FramebufferUpdateMessage) Read(r io.Reader, bo binary.ByteOrder, pixelFormat PixelFormat) error

func (*FramebufferUpdateMessage) Write 

func (m *FramebufferUpdateMessage) Write(w io.Writer, bo binary.ByteOrder) error

type FramebufferUpdateRect 

type FramebufferUpdateRect struct {
	X            uint16
	Y            uint16
	Width        uint16
	Height       uint16
	EncodingType uint32 // Unsigned per spec, but often interpreted signed
	PixelData    []byte
}

func (*FramebufferUpdateRect) Read 

func (rect *FramebufferUpdateRect) Read(r io.Reader, bo binary.ByteOrder, pixelFormat PixelFormat) error

func (*FramebufferUpdateRect) Write 

func (rect *FramebufferUpdateRect) Write(w io.Writer, bo binary.ByteOrder) error

type FramebufferUpdateRequestMessage 

type FramebufferUpdateRequestMessage struct {
	// If true, only updates to changed portions of the framebuffer are requested.
	// If false, the entire region should be returned and EncodingTypeCopyRectangle is not supported.
	Incremental bool

	X      uint16
	Y      uint16
	Width  uint16
	Height uint16
}

func (*FramebufferUpdateRequestMessage) Read 

func (m *FramebufferUpdateRequestMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*FramebufferUpdateRequestMessage) Write 

func (m *FramebufferUpdateRequestMessage) Write(w io.Writer, bo binary.ByteOrder) error

type KeyEventMessage 

type KeyEventMessage struct {
	Pressed bool
	KeySym  uint32 // Defined in Xlib Reference Manual and <X11/keysymdef.h>
}

func (*KeyEventMessage) Read 

func (m *KeyEventMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*KeyEventMessage) Write 

func (m *KeyEventMessage) Write(w io.Writer, bo binary.ByteOrder) error

type PixelFormat 

type PixelFormat struct {
	BitsPerPixel uint8
	BitDepth     uint8
	BigEndian    bool

	// RGB definitions below are used if true.
	// If false, palette mode is used, which is unsupported by this library.
	TrueColor bool

	RedMax     uint16
	GreenMax   uint16
	BlueMax    uint16
	RedShift   uint8
	GreenShift uint8
	BlueShift  uint8
}

func (*PixelFormat) Read 

func (pf *PixelFormat) Read(buf []byte, bo binary.ByteOrder)

buf must contain at least 16 bytes.

func (*PixelFormat) Write 

func (pf *PixelFormat) Write(buf []byte, bo binary.ByteOrder)

buf must contain at least 16 bytes.

type PixelFormatColor 

type PixelFormatColor struct {
	Pixel       uint32
	PixelFormat PixelFormat
}

PixelFormatColor represents a color using the wire format specified by PixelFormat.

func (PixelFormatColor) RGBA 

func (c PixelFormatColor) RGBA() (r, g, b, a uint32)

type PixelFormatImage 

type PixelFormatImage struct {
	Pix         []uint8
	Rect        image.Rectangle
	PixelFormat PixelFormat
	// contains filtered or unexported fields
}

PixelFormatImage represents an image using the wire format specified by PixelFormat. Supports arbitrary drawing with At and Set, but for speed, use CopyToRGBA and CopyFromRGBA.

func NewPixelFormatImage 

func NewPixelFormatImage(pixelFormat PixelFormat, bounds image.Rectangle) (*PixelFormatImage, error)

func (*PixelFormatImage) At 

func (img *PixelFormatImage) At(x, y int) color.Color

func (*PixelFormatImage) Bounds 

func (img *PixelFormatImage) Bounds() image.Rectangle

func (*PixelFormatImage) ColorModel 

func (img *PixelFormatImage) ColorModel() color.Model

func (*PixelFormatImage) CopyFromRGBA 

func (dst *PixelFormatImage) CopyFromRGBA(src *image.RGBA) error

CopyFromRGBA copies src into dst, returning an error if their bounds are not exactly equal. The alpha channel is ignored.

func (*PixelFormatImage) CopyToRGBA 

func (src *PixelFormatImage) CopyToRGBA(dst *image.RGBA) error

func (*PixelFormatImage) Set 

func (img *PixelFormatImage) Set(x, y int, c color.Color)

type PointerEventMessage 

type PointerEventMessage struct {
	ButtonMask uint8
	X          uint16
	Y          uint16
}

func (*PointerEventMessage) Read 

func (m *PointerEventMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*PointerEventMessage) Write 

func (m *PointerEventMessage) Write(w io.Writer, bo binary.ByteOrder) error

type ProtocolVersionMessage 

type ProtocolVersionMessage struct {
	Major, Minor int
}

func (*ProtocolVersionMessage) Read 

func (m *ProtocolVersionMessage) Read(r io.Reader) error

func (*ProtocolVersionMessage) Write 

func (m *ProtocolVersionMessage) Write(w io.Writer) error

type ServerCutTextMessage 

type ServerCutTextMessage struct {
	Text string
}

func (*ServerCutTextMessage) Read 

func (m *ServerCutTextMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*ServerCutTextMessage) Write 

func (m *ServerCutTextMessage) Write(w io.Writer, bo binary.ByteOrder) error

type ServerInitialisationMessage 

type ServerInitialisationMessage struct {
	FramebufferWidth  uint16
	FramebufferHeight uint16
	PixelFormat       PixelFormat
	Name              string
}

func (*ServerInitialisationMessage) Read 

func (m *ServerInitialisationMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*ServerInitialisationMessage) Write 

func (m *ServerInitialisationMessage) Write(w io.Writer, bo binary.ByteOrder) error

type SetEncodingsMessage 

type SetEncodingsMessage struct {
	EncodingTypes []uint32
}

func (*SetEncodingsMessage) Read 

func (m *SetEncodingsMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*SetEncodingsMessage) Write 

func (m *SetEncodingsMessage) Write(w io.Writer, bo binary.ByteOrder) error

type SetPixelFormatMessage 

type SetPixelFormatMessage struct {
	PixelFormat PixelFormat
}

func (*SetPixelFormatMessage) Read 

func (m *SetPixelFormatMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*SetPixelFormatMessage) Write 

func (m *SetPixelFormatMessage) Write(w io.Writer, bo binary.ByteOrder) error

type VNCAuthenticationChallengeMessage 

type VNCAuthenticationChallengeMessage [16]byte

func (*VNCAuthenticationChallengeMessage) Read 

func (m *VNCAuthenticationChallengeMessage) Read(r io.Reader) error

func (*VNCAuthenticationChallengeMessage) Write 

func (m *VNCAuthenticationChallengeMessage) Write(w io.Writer) error

type VNCAuthenticationResponseMessage 

type VNCAuthenticationResponseMessage [16]byte

func (*VNCAuthenticationResponseMessage) Read 

func (m *VNCAuthenticationResponseMessage) Read(r io.Reader) error

func (*VNCAuthenticationResponseMessage) Write 

func (m *VNCAuthenticationResponseMessage) Write(w io.Writer) error

type VNCAuthenticationResult 

type VNCAuthenticationResult uint32

type VNCAuthenticationResultMessage 

type VNCAuthenticationResultMessage struct {
	Result VNCAuthenticationResult
}

func (*VNCAuthenticationResultMessage) Read 

func (m *VNCAuthenticationResultMessage) Read(r io.Reader, bo binary.ByteOrder) error

func (*VNCAuthenticationResultMessage) Write 

func (m *VNCAuthenticationResultMessage) Write(w io.Writer, bo binary.ByteOrder) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.