feat: inital support for .RDP files (#862)

This is paving the way for .rdp file support.

Issue: ARC-339
Issue: ARC-355

Author: CBenoit

ARCHITECTURE.md

@@ -123,6 +123,14 @@ RDCleanPath PDU structure used by IronRDP web client and Devolutions Gateway.
 Lightweight and `no_std`-compatible generic `Error` and `Report` types.
 The `Error` type wraps a custom consumer-defined type for domain-specific details (such as `PduErrorKind`).
 
+#### [`crates/ironrdp-propertyset`](./crates/ironrdp-propertyset)
+
+The main type is `PropertySet`, a key-value store for configuration options.
+
+#### [`crates/ironrdp-rdpfile`](./crates/ironrdp-rdpfile)
+
+Loader and writer for the .RDP file format.
+
 ### Extra Tier
 
 Higher level libraries and binaries built on top of the core tier.
@@ -188,6 +196,10 @@ Web-based frontend using `Svelte` and `Material` frameworks.
 
 Native CLIPRDR backend implementations.
 
+#### [`crates/ironrdp-cfg`](./crates/ironrdp-cfg)
+
+IronRDP-related utilities for ironrdp-propertyset.
+
 ### Internal Tier
 
 Crates that are only used inside the IronRDP project, not meant to be published.

Cargo.lock

@@ -0,0 +1,23 @@
+[package]
+name = "ironrdp-cfg"
+version = "0.1.0"
+readme = "README.md"
+description = "IronRDP utilities for ironrdp-cfgstore"
+publish = false # TODO: publish
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+authors.workspace = true
+keywords.workspace = true
+categories.workspace = true
+
+[lib]
+doctest = false
+test = false
+
+[dependencies]
+ironrdp-propertyset = { path = "../ironrdp-propertyset", version = "0.1" } # public
+
+[lints]
+workspace = true

crates/ironrdp-cfg/Cargo.toml

@@ -0,0 +1,7 @@
+# IronRDP Configuration
+
+IronRDP-related utilities for ironrdp-propertyset.
+
+This crate is part of the [IronRDP] project.
+
+[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-cfg/README.md

@@ -0,0 +1,63 @@
+// QUESTION: consider auto-generating this file based on a reference file?
+// https://gist.github.com/awakecoding/838c7fe2ed3a6208e3ca5d8af25363f6
+
+use ironrdp_propertyset::PropertySet;
+
+pub trait PropertySetExt {
+    fn full_address(&self) -> Option<&str>;
+
+    fn server_port(&self) -> Option<i64>;
+
+    fn alternate_full_address(&self) -> Option<&str>;
+
+    fn gateway_hostname(&self) -> Option<&str>;
+
+    fn remote_application_name(&self) -> Option<&str>;
+
+    fn remote_application_program(&self) -> Option<&str>;
+
+    fn kdc_proxy_url(&self) -> Option<&str>;
+
+    fn username(&self) -> Option<&str>;
+
+    /// Target RDP server password - use for testing only
+    fn clear_text_password(&self) -> Option<&str>;
+}
+
+impl PropertySetExt for PropertySet {
+    fn full_address(&self) -> Option<&str> {
+        self.get::<&str>("full address")
+    }
+
+    fn server_port(&self) -> Option<i64> {
+        self.get::<i64>("server port")
+    }
+
+    fn alternate_full_address(&self) -> Option<&str> {
+        self.get::<&str>("alternate full address")
+    }
+
+    fn gateway_hostname(&self) -> Option<&str> {
+        self.get::<&str>("gatewayhostname")
+    }
+
+    fn remote_application_name(&self) -> Option<&str> {
+        self.get::<&str>("remoteapplicationname")
+    }
+
+    fn remote_application_program(&self) -> Option<&str> {
+        self.get::<&str>("remoteapplicationprogram")
+    }
+
+    fn kdc_proxy_url(&self) -> Option<&str> {
+        self.get::<&str>("kdcproxyurl")
+    }
+
+    fn username(&self) -> Option<&str> {
+        self.get::<&str>("username")
+    }
+
+    fn clear_text_password(&self) -> Option<&str> {
+        self.get::<&str>("ClearTextPassword")
+    }
+}

crates/ironrdp-cfg/src/lib.rs

@@ -49,6 +49,9 @@ ironrdp-tls = { path = "../ironrdp-tls", version = "0.1" }
 ironrdp-tokio = { path = "../ironrdp-tokio", version = "0.6", features = ["reqwest"] }
 ironrdp-rdcleanpath.path = "../ironrdp-rdcleanpath"
 ironrdp-dvc-pipe-proxy.path = "../ironrdp-dvc-pipe-proxy"
+ironrdp-propertyset.path = "../ironrdp-propertyset"
+ironrdp-rdpfile.path = "../ironrdp-rdpfile"
+ironrdp-cfg.path = "../ironrdp-cfg"
 
 # Windowing and rendering
 winit = { version = "0.30", features = ["rwh_06"] }

crates/ironrdp-client/Cargo.toml

@@ -8,6 +8,7 @@ use clap::Parser;
 use ironrdp::connector::{self, Credentials};
 use ironrdp::pdu::rdp::capability_sets::{client_codecs_capabilities, MajorPlatformType};
 use ironrdp::pdu::rdp::client_info::PerformanceFlags;
+use std::path::PathBuf;
 use tap::prelude::*;
 use url::Url;
 
@@ -176,13 +177,17 @@ impl FromStr for DvcProxyInfo {
 #[clap(author = "Devolutions", about = "Devolutions-IronRDP client")]
 #[clap(version, long_about = None)]
 struct Args {
+    /// An address on which the client will connect.
+    destination: Option<Destination>,
+
+    /// Path to a .rdp file to read the configuration from.
+    #[clap(long)]
+    rdp_file: Option<PathBuf>,
+
     /// A file with IronRDP client logs
     #[clap(short, long)]
     log_file: Option<String>,
 
-    /// An address on which the client will connect.
-    destination: Option<Destination>,
-
     /// A target RDP server user name
     #[clap(short, long)]
     username: Option<String>,
@@ -273,21 +278,46 @@ struct Args {
     #[clap(long, num_args = 1.., value_delimiter = ',')]
     codecs: Vec<String>,
 
-    /// Add DVC channel named pipe proxy.
-    /// the format is <name>=<pipe>
-    /// e.g. `ChannelName=PipeName` where `ChannelName` is the name of the channel,
-    /// and `PipeName` is the name of the named pipe to connect to (without OS-specific prefix),
-    /// e.g. PipeName will automatically be prefixed with `\\.\pipe\` on Windows.
+    /// Add DVC channel named pipe proxy
+    ///
+    /// The format is `<name>=<pipe>`, e.g., `ChannelName=PipeName` where `ChannelName` is the name of the channel,
+    /// and `PipeName` is the name of the named pipe to connect to (without OS-specific prefix).
+    /// `<pipe>` will automatically be prefixed with `\\.\pipe\` on Windows.
     #[clap(long)]
     dvc_proxy: Vec<DvcProxyInfo>,
 }
 
 impl Config {
     pub fn parse_args() -> anyhow::Result<Self> {
+        use ironrdp_cfg::PropertySetExt as _;
+
         let args = Args::parse();
 
+        let mut properties = ironrdp_propertyset::PropertySet::new();
+
+        if let Some(rdp_file) = args.rdp_file {
+            let input =
+                std::fs::read_to_string(&rdp_file).with_context(|| format!("failed to read {}", rdp_file.display()))?;
+
+            if let Err(errors) = ironrdp_rdpfile::load(&mut properties, &input) {
+                for e in errors {
+                    #[expect(clippy::print_stderr)]
+                    {
+                        eprintln!("Error when reading {}: {e}", rdp_file.display())
+                    }
+                }
+            }
+        }
+
         let destination = if let Some(destination) = args.destination {
             destination
+        } else if let Some(destination) = properties.full_address() {
+            if let Some(port) = properties.server_port() {
+                format!("{destination}:{port}").parse()
+            } else {
+                destination.parse()
+            }
+            .context("invalid destination")?
         } else {
             inquire::Text::new("Server address:")
                 .prompt()
@@ -297,12 +327,16 @@ impl Config {
 
         let username = if let Some(username) = args.username {
             username
+        } else if let Some(username) = properties.username() {
+            username.to_owned()
         } else {
             inquire::Text::new("Username:").prompt().context("Username prompt")?
         };
 
         let password = if let Some(password) = args.password {
             password
+        } else if let Some(password) = properties.clear_text_password() {
+            password.to_owned()
         } else {
             inquire::Password::new("Password:")
                 .without_confirmation()

crates/ironrdp-client/src/config.rs

@@ -4,6 +4,7 @@
 
 #[cfg(feature = "alloc")]
 extern crate alloc;
+
 #[cfg(feature = "alloc")]
 use alloc::boxed::Box;
 use core::fmt;

crates/ironrdp-error/src/lib.rs

@@ -0,0 +1,23 @@
+[package]
+name = "ironrdp-propertyset"
+version = "0.1.0"
+readme = "README.md"
+description = "A key-value store for configuration options"
+publish = false # TODO: publish
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+authors.workspace = true
+keywords.workspace = true
+categories.workspace = true
+
+[lib]
+doctest = false
+test = false
+
+[dependencies]
+tracing = { version = "0.1", features = ["log"] }
+
+[lints]
+workspace = true

crates/ironrdp-propertyset/Cargo.toml

@@ -0,0 +1,7 @@
+# IronRDP PropertySet
+
+The main type is `PropertySet`, a key-value store for configuration options.
+
+This crate is part of the [IronRDP] project.
+
+[IronRDP]: https://github.com/Devolutions/IronRDP