chore: restructure now libraries layout

.github/workflows/nuget-publish.yml

@@ -57,7 +57,7 @@ jobs:
         library: [ NowAgent ]
         include:
           - library: NowAgent
-            libpath: ./dotnet/Devolutions.NowClient
+            libpath: ./protocols/dotnet/Devolutions.NowClient
 
     steps:
       - name: Check out ${{ github.repository }}
@@ -67,8 +67,8 @@ jobs:
         shell: pwsh
         run: |
           $PackageVersion = '${{ needs.preflight.outputs.package-version }}'
-          @("dotnet\Devolutions.NowClient\Devolutions.NowClient.csproj",
-            "dotnet\Devolutions.NowProto\Devolutions.NowProto.csproj") | ForEach-Object {
+          @("protocols\dotnet\Devolutions.NowClient\Devolutions.NowClient.csproj",
+            "protocols\dotnet\Devolutions.NowProto\Devolutions.NowProto.csproj") | ForEach-Object {
             $csprojPath = $_
             $csprojContent = Get-Content $csprojPath -Raw
             $csprojContent = $csprojContent -Replace '(<Version>).*?(</Version>)', "<Version>$PackageVersion</Version>"

Cargo.toml

@@ -1,22 +1,22 @@
 [workspace]
 resolver = "2"
 members = [
-  "rust/*",
+  "protocols/rust/*",
   "xtask",
 ]
 
 [workspace.package]
 edition = "2021"
 license = "MIT/Apache-2.0"
-homepage = "https://github.com/Devolutions/now-proto"
-repository = "https://github.com/Devolutions/now-proto"
+homepage = "https://github.com/Devolutions/now-libraries"
+repository = "https://github.com/Devolutions/now-libraries"
 authors = ["Devolutions Inc. <infos@devolutions.net>"]
 keywords = ["rdp", "remote-desktop", "network", "client", "protocol"]
 categories = ["network-programming"]
 
 [workspace.dependencies]
-now-proto-pdu = { version = "0.1", path = "crates/now-proto-pdu" }
-now-proto-fuzzing = { version = "0.1", path = "crates/now-proto-fuzzing" }
+now-proto-pdu = { version = "0.1", path = "protocols/rust/now-proto-pdu" }
+now-proto-fuzzing = { version = "0.1", path = "protocols/rust/now-proto-fuzzing" }
 
 [profile.test.package.proptest]
 opt-level = 3

README.md

@@ -1,19 +1,15 @@
-NOW-proto
-=========
+now-libraries
+=============
 
-Devolutions::Now::Agent RDP virtual channel protocol libraries and clients.
+Shared libraries for Devolutions NOW components.
 
-### Specification
+## Libraries
 
-Current protocol specification: [read](./docs/NOW-spec.md)
+- [protocols](./protocols/) contains the NOW protocol specifications, Rust crates, .NET libraries, and protocol test tools.
+- [policies](./policies/) is reserved for the UniGetUI/PEDM policy engine libraries.
 
-### Updating protocol
+## Repository Layout
 
-In order to update the protocol, the following steps should be followed:
-
-1. Update the protocol specification in `./docs/NOW-spec.md`.
-    - Bump the protocol version number.
-1. Update the Rust implementation of the protocol in `./rust/now-proto-pdu`.
-    - Bump current protocol version defined in `now_proto_pdu::channel::capset::NowProtoVersion::CURRENT`
-1. Update the C# implementation of the protocol in `./dotnet/Devolutions.NowProto`
-    - Bump current protocol version in `Devolutions.NowProto.NowProtoVersion.Current`
+- Root-level tooling and CI are shared across library families.
+- Protocol-specific documentation and source code live under `protocols/`.
+- Policy-specific documentation and source code will live under `policies/`.

cliff.toml

@@ -36,7 +36,7 @@ body = """
 {%- endif %}
 
 {%- set short_sha = commit.id | truncate(length=10, end="") %}
-{%- set commit_url = "https://github.com/Devolutions/now-proto/commit/" ~ commit.id %}
+{%- set commit_url = "https://github.com/Devolutions/now-libraries/commit/" ~ commit.id %}
 {%- set commit_link = "[" ~ short_sha ~ "](" ~ commit_url ~ ")" %}
 
 - {{ breaking }}{{ message }} ({{ commit_link }}) \
@@ -58,9 +58,9 @@ sort_commits = "oldest"
 
 commit_preprocessors = [
   # Replace issue number with the link
-  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/Devolutions/now-proto/issues/${2}))"},
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/Devolutions/now-libraries/issues/${2}))"},
   # Replace commit sha1 with the link
-  { pattern = '([a-f0-9]{10})([a-f0-9]{30})', replace = "[${0}](https://github.com/Devolutions/now-proto/commit/${1}${2})" }
+  { pattern = '([a-f0-9]{10})([a-f0-9]{30})', replace = "[${0}](https://github.com/Devolutions/now-libraries/commit/${1}${2})" }
 ]
 
 # regex for parsing and grouping commits

policies/README.md

@@ -0,0 +1,6 @@
+Policies
+========
+
+This directory is reserved for the UniGetUI/PEDM policy engine libraries.
+
+The future policy engine NuGet package and Rust crate will live here.

protocols/README.md

@@ -0,0 +1,19 @@
+NOW-proto
+=========
+
+Devolutions::Now::Agent RDP virtual channel protocol libraries and clients.
+
+### Specification
+
+Current protocol specification: [read](./docs/NOW-spec.md)
+
+### Updating protocol
+
+In order to update the protocol, the following steps should be followed:
+
+1. Update the protocol specification in `./docs/NOW-spec.md`.
+    - Bump the protocol version number.
+1. Update the Rust implementation of the protocol in `./rust/now-proto-pdu`.
+    - Bump current protocol version defined in `now_proto_pdu::channel::capset::NowProtoVersion::CURRENT`
+1. Update the C# implementation of the protocol in `./dotnet/Devolutions.NowProto`
+    - Bump current protocol version in `Devolutions.NowProto.NowProtoVersion.Current`

protocols/docs/make.ps1

@@ -0,0 +1,6 @@
+# NOTE: Markdown Monster CLI may be broken at the moment (WinGet version 3.5.4 definitely is),
+# the PDF could be generated manually via GUI instead.
+$SpecPath = Join-Path $PSScriptRoot 'NOW-spec.md'
+$OutputPath = Join-Path $PSScriptRoot 'NOW-spec.pdf'
+
+mmcli markdowntopdf -i $SpecPath -o $OutputPath --theme Github --orientation Portrait --page-size A4

dotnet/Devolutions.NowClient/Devolutions.NowClient.csproj → protocols/dotnet/Devolutions.NowClient/Devolutions.NowClient.csproj

@@ -10,7 +10,7 @@
     <Copyright>© Devolutions Inc. All rights reserved.</Copyright>
     <RootNamespace>Devolutions.NowClient</RootNamespace>
     <PackageLicenseExpression>MIT OR Apache-2.0</PackageLicenseExpression>
-    <RepositoryUrl>https://github.com/Devolutions/now-proto.git</RepositoryUrl>
+    <RepositoryUrl>https://github.com/Devolutions/now-libraries.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
 
     <OutputType>Library</OutputType>

dotnet/Devolutions.NowDvcApp/ConnectionDlg.resx → protocols/dotnet/Devolutions.NowDvcApp/ConnectionDlg.resx

@@ -1,120 +1,120 @@
-<?xml version="1.0" encoding="utf-8"?>
-<root>
-  <!--
-    Microsoft ResX Schema
-
-    Version 2.0
-
-    The primary goals of this format is to allow a simple XML format
-    that is mostly human readable. The generation and parsing of the
-    various data types are done through the TypeConverter classes
-    associated with the data types.
-
-    Example:
-
-    ... ado.net/XML headers & schema ...
-    <resheader name="resmimetype">text/microsoft-resx</resheader>
-    <resheader name="version">2.0</resheader>
-    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
-    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
-    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
-    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
-    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
-        <value>[base64 mime encoded serialized .NET Framework object]</value>
-    </data>
-    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
-        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
-        <comment>This is a comment</comment>
-    </data>
-
-    There are any number of "resheader" rows that contain simple
-    name/value pairs.
-
-    Each data row contains a name, and value. The row also contains a
-    type or mimetype. Type corresponds to a .NET class that support
-    text/value conversion through the TypeConverter architecture.
-    Classes that don't support this are serialized and stored with the
-    mimetype set.
-
-    The mimetype is used for serialized objects, and tells the
-    ResXResourceReader how to depersist the object. This is currently not
-    extensible. For a given mimetype the value must be set accordingly:
-
-    Note - application/x-microsoft.net.object.binary.base64 is the format
-    that the ResXResourceWriter will generate, however the reader can
-    read any of the formats listed below.
-
-    mimetype: application/x-microsoft.net.object.binary.base64
-    value   : The object must be serialized with
-            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
-            : and then encoded with base64 encoding.
-
-    mimetype: application/x-microsoft.net.object.soap.base64
-    value   : The object must be serialized with
-            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
-            : and then encoded with base64 encoding.
-
-    mimetype: application/x-microsoft.net.object.bytearray.base64
-    value   : The object must be serialized into a byte array
-            : using a System.ComponentModel.TypeConverter
-            : and then encoded with base64 encoding.
-    -->
-  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
-    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
-    <xsd:element name="root" msdata:IsDataSet="true">
-      <xsd:complexType>
-        <xsd:choice maxOccurs="unbounded">
-          <xsd:element name="metadata">
-            <xsd:complexType>
-              <xsd:sequence>
-                <xsd:element name="value" type="xsd:string" minOccurs="0" />
-              </xsd:sequence>
-              <xsd:attribute name="name" use="required" type="xsd:string" />
-              <xsd:attribute name="type" type="xsd:string" />
-              <xsd:attribute name="mimetype" type="xsd:string" />
-              <xsd:attribute ref="xml:space" />
-            </xsd:complexType>
-          </xsd:element>
-          <xsd:element name="assembly">
-            <xsd:complexType>
-              <xsd:attribute name="alias" type="xsd:string" />
-              <xsd:attribute name="name" type="xsd:string" />
-            </xsd:complexType>
-          </xsd:element>
-          <xsd:element name="data">
-            <xsd:complexType>
-              <xsd:sequence>
-                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
-                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
-              </xsd:sequence>
-              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
-              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
-              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
-              <xsd:attribute ref="xml:space" />
-            </xsd:complexType>
-          </xsd:element>
-          <xsd:element name="resheader">
-            <xsd:complexType>
-              <xsd:sequence>
-                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
-              </xsd:sequence>
-              <xsd:attribute name="name" type="xsd:string" use="required" />
-            </xsd:complexType>
-          </xsd:element>
-        </xsd:choice>
-      </xsd:complexType>
-    </xsd:element>
-  </xsd:schema>
-  <resheader name="resmimetype">
-    <value>text/microsoft-resx</value>
-  </resheader>
-  <resheader name="version">
-    <value>2.0</value>
-  </resheader>
-  <resheader name="reader">
-    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
-  </resheader>
-  <resheader name="writer">
-    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
-  </resheader>
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!--
+    Microsoft ResX Schema
+
+    Version 2.0
+
+    The primary goals of this format is to allow a simple XML format
+    that is mostly human readable. The generation and parsing of the
+    various data types are done through the TypeConverter classes
+    associated with the data types.
+
+    Example:
+
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+
+    There are any number of "resheader" rows that contain simple
+    name/value pairs.
+
+    Each data row contains a name, and value. The row also contains a
+    type or mimetype. Type corresponds to a .NET class that support
+    text/value conversion through the TypeConverter architecture.
+    Classes that don't support this are serialized and stored with the
+    mimetype set.
+
+    The mimetype is used for serialized objects, and tells the
+    ResXResourceReader how to depersist the object. This is currently not
+    extensible. For a given mimetype the value must be set accordingly:
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format
+    that the ResXResourceWriter will generate, however the reader can
+    read any of the formats listed below.
+
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
 </root>