mirrors/IronRDP
1
0
Fork 0
mirror of https://github.com/Devolutions/IronRDP.git synced 2025-12-23 12:26:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
Rust implementation of the Microsoft Remote Desktop Protocol (RDP)
1331 commits 36 branches 231 tags 42 MiB
Find a file
Yuval Marcus a70e01d9c5
Some checks are pending
CI / Check formatting (push) Waiting to run
Details
CI / FFI (push) Blocked by required conditions
Details
CI / Success (push) Blocked by required conditions
Details
CI / Check typos (push) Waiting to run
Details
CI / Checks [linux] (push) Blocked by required conditions
Details
CI / Checks [macos] (push) Blocked by required conditions
Details
CI / Checks [windows] (push) Blocked by required conditions
Details
CI / Fuzzing (push) Blocked by required conditions
Details
CI / Web Client (push) Blocked by required conditions
Details
Coverage / Coverage Report (push) Waiting to run
Details
Release crates / Open release PR (push) Waiting to run
Details
Release crates / Release crates (push) Waiting to run
Details
fix(server): send TLS close_notify during graceful RDP disconnect (#1032) 
Add support for sending a proper TLS close_notify message when the RDP
client initiates a graceful disconnect PDU.
2025-11-17 07:36:31 -05:00
.cargo build(deps): bump getrandom to 0.3 2025-07-24 06:34:50 -04:00
.github ci(npm): migrate publishing to OIDC authentication (#1026) 2025-10-30 08:40:10 -04:00
benches refactor: add as_conversions clippy correctness lint (#1021) 2025-11-05 22:23:22 +00:00
crates fix(server): send TLS close_notify during graceful RDP disconnect (#1032) 2025-11-17 07:36:31 -05:00
ffi feat(ffi): expose RDCleanPath (#1014) 2025-10-30 16:38:41 +00:00
fuzz build(deps): bump clap from 4.5.49 to 4.5.50 in the patch group across 1 directory (#1023) 2025-10-21 05:04:36 -04:00
web-client chore(web): bump iron-remote-desktop to 0.10.1 (#1011) 2025-10-07 06:47:11 -04:00
xtask refactor: add as_conversions clippy correctness lint (#1021) 2025-11-05 22:23:22 +00: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 refactor(mstsgu): follow up to PR 913 (#920) 2025-08-19 10:01:49 -04:00
Cargo.lock build(deps): bump windows from 0.61.3 to 0.62.1 (#1010) 2025-11-10 14:12:28 -05:00
Cargo.toml refactor: add as_conversions clippy correctness lint (#1021) 2025-11-05 22:23:22 +00:00
cliff.toml chore(release): prepare for publishing (#656) 2025-01-31 04:22:55 +00:00
clippy.toml refactor: add as_conversions clippy correctness lint (#1021) 2025-11-05 22:23:22 +00: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.88.0 (#852) 2025-07-03 07:38:28 +03:00
rustfmt.toml style: run cargo fmt 2022-04-15 13:39:34 -04:00
STYLE.md docs: clarify STYLE.md (#910) 2025-08-05 09:12:59 +00:00
typos.toml chore(release): prepare for publishing (#748) 2025-05-27 15:21:56 +00:00

README.md

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