Rust implementation of the Microsoft Remote Desktop Protocol (RDP)
Find a file
2025-03-29 06:03:17 +09:00
.cargo refactor: re-organize workspace (#101) 2023-03-29 19:09:15 -04:00
.github ci(ffi): verify FFI code and examples 2025-03-25 12:26:28 +01:00
crates DO NOT MERGE: Quick and Dirty iron-remote-gui-vnc package 2025-03-29 06:03:17 +09:00
ffi fix(ffi): use patched diplomat (#723) 2025-03-26 00:55:30 +00:00
fuzz chore(release): prepare for publishing (#699) 2025-03-13 09:06:30 +00:00
web-client DO NOT MERGE: Quick and Dirty iron-remote-gui-vnc package 2025-03-29 06:03:17 +09:00
xtask DO NOT MERGE: Quick and Dirty iron-remote-gui-vnc package 2025-03-29 06:03:17 +09:00
.gitattribute feat(ffi): initial C# bindings (connector only) (#423) 2024-04-05 15:11:32 +00:00
.gitignore docs(now-proto): add missing NOW-PROTO docs (#575) 2024-11-07 19:29:08 -05:00
ARCHITECTURE.md chore(xtask): update binary dependencies (#663) 2025-02-05 18:12:10 -05:00
Cargo.lock fix(ffi): use patched diplomat (#723) 2025-03-26 00:55:30 +00:00
Cargo.toml fix(ffi): use patched diplomat (#723) 2025-03-26 00:55:30 +00:00
cliff.toml chore(release): prepare for publishing (#656) 2025-01-31 04:22:55 +00:00
clippy.toml chore: use workspace lints 2024-07-24 04:35:32 -04:00
LICENSE-APACHE ironrdp: initial commit 2019-07-10 17:31:26 -04:00
LICENSE-MIT ironrdp: initial commit 2019-07-10 17:31:26 -04:00
README.md docs: add ironrdp docs.rs & crates.io badges 2024-10-29 19:14:20 +09:00
release-plz.toml chore: only publish GitHub releases for ironrdp-client (#704) 2025-03-14 11:00:44 +02:00
rust-toolchain.toml chore: update Rust toolchain to 1.85.0 2025-03-13 11:03:10 +01:00
rustfmt.toml style: run cargo fmt 2022-04-15 13:39:34 -04:00
STYLE.md style(cliprdr): clarify invariants 2023-11-20 09:39:36 -05:00
typos.toml style: fix typos (#546) 2024-09-03 10:36:47 +00:00

IronRDP

A collection of Rust crates providing an implementation of the Microsoft Remote Desktop Protocol, with a focus on security.

Demonstration

https://user-images.githubusercontent.com/3809077/202049929-76f42471-aeb0-41da-9118-0dc6ea491bd2.mp4

Video Codec Support

Supported codecs:

  • Uncompressed raw bitmap
  • Interleaved Run-Length Encoding (RLE) Bitmap Codec
  • RDP 6.0 Bitmap Compression
  • Microsoft RemoteFX (RFX)

Examples

ironrdp-client

A full-fledged RDP client based on IronRDP crates suite, and implemented using non-blocking, asynchronous I/O.

cargo run --bin ironrdp-client -- <HOSTNAME> --username <USERNAME> --password <PASSWORD>

screenshot

Example of utilizing IronRDP in a blocking, synchronous fashion.

This example showcases the use of IronRDP in a blocking manner. It demonstrates how to create a basic RDP client with just a few hundred lines of code by leveraging the IronRDP crates suite.

In this basic client implementation, the client establishes a connection with the destination server, decodes incoming graphics updates, and saves the resulting output as a BMP image file on the disk.

cargo run --example=screenshot -- --host <HOSTNAME> --username <USERNAME> --password <PASSWORD> --output out.bmp

How to enable RemoteFX on server

Run the following PowerShell commands, and reboot.

Set-ItemProperty -Path 'HKLM:\Software\Policies\Microsoft\Windows NT\Terminal Services' -Name 'ColorDepth' -Type DWORD -Value 5
Set-ItemProperty -Path 'HKLM:\Software\Policies\Microsoft\Windows NT\Terminal Services' -Name 'fEnableVirtualizedGraphics' -Type DWORD -Value 1

Alternatively, you may change a few group policies using gpedit.msc:

  1. Run gpedit.msc.

  2. Enable Computer Configuration/Administrative Templates/Windows Components/Remote Desktop Services/Remote Desktop Session Host/Remote Session Environment/RemoteFX for Windows Server 2008 R2/Configure RemoteFX

  3. Enable Computer Configuration/Administrative Templates/Windows Components/Remote Desktop Services/Remote Desktop Session Host/Remote Session Environment/Enable RemoteFX encoding for RemoteFX clients designed for Windows Server 2008 R2 SP1

  4. Enable Computer Configuration/Administrative Templates/Windows Components/Remote Desktop Services/Remote Desktop Session Host/Remote Session Environment/Limit maximum color depth

  5. Reboot.

Architecture

See the ARCHITECTURE.md document.

Getting help