tdp

type ButtonState ¶

type ButtonState byte

ButtonState is the press state of a keyboard or mouse button.

type ClientScreenSpec ¶

type ClientScreenSpec struct {
	Width  uint32
	Height uint32
}

ClientScreenSpec is the client screen specification. | message type (1) | width uint32 | height uint32 |

func (s ClientScreenSpec) Encode() ([]byte, error)

type ClientUsername ¶

type ClientUsername struct {
	Username string
}

ClientUsername is the client username. | message type (7) | username_length uint32 | username []byte |

func (r ClientUsername) Encode() ([]byte, error)

type ClipboardData ¶

type ClipboardData []byte

ClipboardData represents shared clipboard data. | message type (6) | length uint32 | data []byte |

func (c ClipboardData) Encode() ([]byte, error)

type Conn ¶

type Conn struct {

	// OnSend is an optional callback that is invoked when a TDP message
	// is sent on the wire. It is passed both the raw bytes and the encoded
	// message.
	OnSend func(m Message, b []byte)

	// OnRecv is an optional callback that is invoked when a TDP message
	// is received on the wire.
	OnRecv func(m Message)
	// contains filtered or unexported fields
}

Conn is a desktop protocol connection. It converts between a stream of bytes (io.ReadWriter) and a stream of Teleport Desktop Protocol (TDP) messages.

func NewConn(rwc io.ReadWriteCloser) *Conn

func (c *Conn) Close() error

func (c *Conn) LocalAddr() net.Addr

func (c *Conn) ReadClientScreenSpec() (*ClientScreenSpec, error)

func (c *Conn) ReadMessage() (Message, error)

func (c *Conn) RemoteAddr() net.Addr

func (c *Conn) SendNotification(message string, severity Severity) error

func (c *Conn) WriteMessage(m Message) error

type ConnectionInitialized ¶

type ConnectionInitialized struct {
	IOChannelID   uint16
	UserChannelID uint16
	ScreenWidth   uint16
	ScreenHeight  uint16
}

ConnectionInitialized is sent to the browser when an RDP session is fully initialized. It contains data that the browser needs in order to correctly handle the session.

See "3. Channel Connection" at https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpbcgr/023f1e69-cfe8-4ee6-9ee0-7e759fb4e4ee

| message type (31) | io_channel_id uint16 | user_channel_id uint16 |

func (c ConnectionInitialized) Encode() ([]byte, error)

type Error ¶

type Error struct {
	Message string
}

Error is used to send a fatal error message to the browser. In Teleport 12 and up, Error is deprecated and Notification should be preferred. | message type (9) | message_length uint32 | message []byte |

func (m Error) Encode() ([]byte, error)

type FileSystemObject ¶

type FileSystemObject struct {
	LastModified uint64
	Size         uint64
	FileType     uint32
	IsEmpty      uint8
	Path         string
}

FileSystemObject represents a file or directory. | last_modified uint64 | size uint64 | file_type uint32 | is_empty bool | path_length uint32 | path byte[] |

func (f FileSystemObject) Encode() ([]byte, error)

type KeyboardButton ¶

type KeyboardButton struct {
	KeyCode uint32
	State   ButtonState
}

KeyboardButton is the keyboard button press message. | message type (5) | key_code uint32 | state byte |

func (k KeyboardButton) Encode() ([]byte, error)

type MFA ¶

type MFA struct {
	// Type should be defaults.WebsocketWebauthnChallenge
	Type byte
	// MFAAuthenticateChallenge is the challenge we send to the client.
	// Used for messages from Teleport to the user's browser.
	*client.MFAAuthenticateChallenge
	// MFAAuthenticateResponse is the response to the MFA challenge,
	// sent from the browser to Teleport.
	*authproto.MFAAuthenticateResponse
}

MFA represents a MFA challenge or response. | message type (10) | mfa_type byte | length uint32 | JSON []byte |

func DecodeMFA(in byteReader) (*MFA, error)

func DecodeMFAChallenge(in byteReader) (*MFA, error)

func (m MFA) Encode() ([]byte, error)

type Message ¶

type Message interface {
	Encode() ([]byte, error)
}

Message is a Go representation of a desktop protocol message.

func Decode(buf []byte) (Message, error)

type MessageType ¶

type MessageType byte

MessageType identifies the type of the message.

type MouseButton ¶

type MouseButton struct {
	Button MouseButtonType
	State  ButtonState
}

MouseButton is the mouse button press message. | message type (4) | button byte | state byte |

func (m MouseButton) Encode() ([]byte, error)

type MouseButtonType ¶

type MouseButtonType byte

MouseButtonType identifies a specific button on the mouse.

type MouseMove ¶

type MouseMove struct {
	X, Y uint32
}

MouseMove is the mouse movement message. | message type (3) | x uint32 | y uint32 |

func (m MouseMove) Encode() ([]byte, error)

type MouseWheel ¶

type MouseWheel struct {
	Axis  MouseWheelAxis
	Delta int16
}

MouseWheel is the mouse wheel scroll message. | message type (8) | axis byte | delta int16 |

func (w MouseWheel) Encode() ([]byte, error)

type MouseWheelAxis ¶

type MouseWheelAxis byte

MouseWheelAxis identifies a scroll axis on the mouse wheel.

type Notification ¶

type Notification struct {
	Message  string
	Severity Severity
}

Notification is an informational message sent from Teleport to the Web UI. It can be used for fatal errors or non-fatal warnings. | message type (28) | message_length uint32 | message []byte | severity byte |

func (m Notification) Encode() ([]byte, error)

type PNG2Frame ¶

type PNG2Frame []byte

PNG2Frame is a newer version of PNGFrame that includes the length of the PNG data. It's represented as a fully encoded byte slice to optimize for speed and simplicity of encoding/decoding. | message type (27) | png_length uint32 | left uint32 | top uint32 | right uint32 | bottom uint32 | data []byte |

func (f PNG2Frame) Bottom() uint32

func (f PNG2Frame) Data() []byte

func (f PNG2Frame) Encode() ([]byte, error)

func (f PNG2Frame) Left() uint32

func (f PNG2Frame) Right() uint32

func (f PNG2Frame) Top() uint32

type PNGFrame ¶

type PNGFrame struct {
	Img image.Image
	// contains filtered or unexported fields
}

PNGFrame is the PNG frame message | message type (2) | left uint32 | top uint32 | right uint32 | bottom uint32 | data []byte |

func (f PNGFrame) Encode() ([]byte, error)

type RDPFastPathPDU ¶

type RDPFastPathPDU []byte

RDPFastPathPDU is an RDP Fast-Path PDU message. It carries a raw RDP Server Fast-Path Update PDU (https://tinyurl.com/3t2t6er8) which is used to transport image data to the frontend.

| message type (29) | data_length uint32 | data []byte |

Whenever you see this type itself, you can assume that it's just the | data []byte | part of the message. Calling Encode() on this type will return the full encoded message, including the | message type (29) | data_length uint32 | parts.

func (f RDPFastPathPDU) Encode() ([]byte, error)

type RDPResponsePDU ¶

type RDPResponsePDU []byte

RDPResponsePDU is an RDP Response PDU message. It carries a raw encoded RDP response PDU created by the ironrdp client on the frontend and sends it directly to the RDP server.

| message type (30) | data_length uint32 | data []byte |

Whenever you see this type itself, you can assume that it's just the | data []byte | section of the message. Calling Encode() on this type will return the full encoded message, including the | message type (30) | data_length uint32 | parts.

func (r RDPResponsePDU) Encode() ([]byte, error)

type Severity ¶

type Severity byte

const (
	SeverityInfo    Severity = 0
	SeverityWarning Severity = 1
	SeverityError   Severity = 2
)

type SharedDirectoryAcknowledge ¶

type SharedDirectoryAcknowledge struct {
	ErrCode     uint32
	DirectoryID uint32
}

SharedDirectoryAcknowledge acknowledges a SharedDirectoryAnnounce was received. | message type (12) | err_code uint32 | directory_id uint32 |

func (s SharedDirectoryAcknowledge) Encode() ([]byte, error)

type SharedDirectoryAnnounce ¶

type SharedDirectoryAnnounce struct {
	DirectoryID uint32
	Name        string
}

SharedDirectoryAnnounce announces a new directory to be shared. | message type (11) | directory_id uint32 | name_length uint32 | name []byte |

func (s SharedDirectoryAnnounce) Encode() ([]byte, error)

type SharedDirectoryCreateRequest ¶

type SharedDirectoryCreateRequest struct {
	CompletionID uint32
	DirectoryID  uint32
	FileType     uint32
	Path         string
}

SharedDirectoryCreateRequest is sent by the TDP server to the client to request the creation of a new file or directory. | message type (15) | completion_id uint32 | directory_id uint32 | file_type uint32 | path_length uint32 | path []byte |

func (s SharedDirectoryCreateRequest) Encode() ([]byte, error)

type SharedDirectoryCreateResponse ¶

type SharedDirectoryCreateResponse struct {
	CompletionID uint32
	ErrCode      uint32
	Fso          FileSystemObject
}

SharedDirectoryCreateResponseis sent by the TDP client to the server with information from an executed SharedDirectoryCreateRequest. | message type (16) | completion_id uint32 | err_code uint32 | file_system_object fso |

func (s SharedDirectoryCreateResponse) Encode() ([]byte, error)

type SharedDirectoryDeleteRequest ¶

type SharedDirectoryDeleteRequest struct {
	CompletionID uint32
	DirectoryID  uint32
	Path         string
}

SharedDirectoryDeleteRequest is sent by the TDP server to the client to request the deletion of a file or directory. | message type (17) | completion_id uint32 | directory_id uint32 | path_length uint32 | path []byte |

func (s SharedDirectoryDeleteRequest) Encode() ([]byte, error)

type SharedDirectoryDeleteResponse ¶

type SharedDirectoryDeleteResponse struct {
	CompletionID uint32
	ErrCode      uint32
}

SharedDirectoryDeleteResponse is sent by the TDP client to the server with information from an executed SharedDirectoryDeleteRequest. | message type (18) | completion_id uint32 | err_code uint32 |

func (s SharedDirectoryDeleteResponse) Encode() ([]byte, error)

type SharedDirectoryInfoRequest ¶

type SharedDirectoryInfoRequest struct {
	CompletionID uint32
	DirectoryID  uint32
	Path         string
}

SharedDirectoryInfoRequest requests information about a file or directory. | message type (13) | completion_id uint32 | directory_id uint32 | path_length uint32 | path []byte |

func (s SharedDirectoryInfoRequest) Encode() ([]byte, error)

type SharedDirectoryInfoResponse ¶

type SharedDirectoryInfoResponse struct {
	CompletionID uint32
	ErrCode      uint32
	Fso          FileSystemObject
}

SharedDirectoryInfoResponse returns information about a file or directory. | message type (14) | completion_id uint32 | err_code uint32 | file_system_object fso |

func (s SharedDirectoryInfoResponse) Encode() ([]byte, error)

type SharedDirectoryListRequest ¶

type SharedDirectoryListRequest struct {
	CompletionID uint32
	DirectoryID  uint32
	Path         string
}

SharedDirectoryListRequest is sent by the TDP server to the client to request a directory listing. | message type (25) | completion_id uint32 | directory_id uint32 | path_length uint32 | path []byte |

func (s SharedDirectoryListRequest) Encode() ([]byte, error)

type SharedDirectoryListResponse ¶

type SharedDirectoryListResponse struct {
	CompletionID uint32
	ErrCode      uint32
	FsoList      []FileSystemObject
}

SharedDirectoryListResponse is sent by the TDP client to the server with the information from an executed SharedDirectoryListRequest. | message type (26) | completion_id uint32 | err_code uint32 | fso_list_length uint32 | fso_list fso[] |

func (s SharedDirectoryListResponse) Encode() ([]byte, error)

type SharedDirectoryMoveRequest ¶

type SharedDirectoryMoveRequest struct {
	CompletionID uint32
	DirectoryID  uint32
	OriginalPath string
	NewPath      string
}

SharedDirectoryMoveRequest is sent from the TDP server to the client to request a file at original_path be moved to new_path. | message type (23) | completion_id uint32 | directory_id uint32 | original_path_length uint32 | original_path []byte | new_path_length uint32 | new_path []byte |

func (s SharedDirectoryMoveRequest) Encode() ([]byte, error)

type SharedDirectoryMoveResponse ¶

type SharedDirectoryMoveResponse struct {
	CompletionID uint32
	ErrCode      uint32
}

SharedDirectoryMoveResponse is sent from the TDP client to the server to acknowledge a SharedDirectoryMoveRequest was executed. | message type (24) | completion_id uint32 | err_code uint32 |

func (s SharedDirectoryMoveResponse) Encode() ([]byte, error)

type SharedDirectoryReadRequest ¶

type SharedDirectoryReadRequest struct {
	CompletionID uint32
	DirectoryID  uint32
	Path         string
	Offset       uint64
	Length       uint32
}

SharedDirectoryReadRequest is a message sent by the TDP server to the client to request bytes to be read from the file at the path and starting at byte offset. | message type (19) | completion_id uint32 | directory_id uint32 | path_length uint32 | path []byte | offset uint64 | length uint32 |

func (s SharedDirectoryReadRequest) Encode() ([]byte, error)

type SharedDirectoryReadResponse ¶

type SharedDirectoryReadResponse struct {
	CompletionID   uint32
	ErrCode        uint32
	ReadDataLength uint32
	ReadData       []byte
}

SharedDirectoryReadResponse is a message sent by the TDP client to the server in response to the SharedDirectoryReadRequest. | message type (20) | completion_id uint32 | err_code uint32 | read_data_length uint32 | read_data []byte |

func (s SharedDirectoryReadResponse) Encode() ([]byte, error)

type SharedDirectoryWriteRequest ¶

type SharedDirectoryWriteRequest struct {
	CompletionID    uint32
	DirectoryID     uint32
	Offset          uint64
	Path            string
	WriteDataLength uint32
	WriteData       []byte
}

SharedDirectoryWriteRequest is a message sent by the TDP server to the client to request bytes to be written the file at the path and starting at byte offset. | message type (21) | completion_id uint32 | directory_id uint32 | path_length uint32 | path []byte | offset uint64 | write_data_length uint32 | write_data []byte |

func (s SharedDirectoryWriteRequest) Encode() ([]byte, error)

type SharedDirectoryWriteResponse ¶

type SharedDirectoryWriteResponse struct {
	CompletionID uint32
	ErrCode      uint32
	BytesWritten uint32
}

SharedDirectoryWriteResponse is a message sent by the TDP client to the server in response to the SharedDirectoryWriteRequest. | message type (22) | completion_id uint32 | err_code uint32 | bytes_written uint32 |

func (s SharedDirectoryWriteResponse) Encode() ([]byte, error)

type SyncKeys ¶

type SyncKeys struct {
	ScrollLockState ButtonState
	NumLockState    ButtonState
	CapsLockState   ButtonState
	KanaLockState   ButtonState
}

| message type (32) | scroll_lock_state byte | num_lock_state byte | caps_lock_state byte | kana_lock_state byte |

func (k SyncKeys) Encode() ([]byte, error)