Modern .NET Support

.editorconfig

@@ -0,0 +1,10 @@
+[*.{cs,vb}]
+
+# IDE0046: Convert to conditional expression
+dotnet_style_prefer_conditional_expression_over_return = false
+
+# CA1510: Use ArgumentNullException throw helper
+dotnet_diagnostic.CA1510.severity = none
+
+# CA1513: Use ObjectDisposedException throw helper
+dotnet_diagnostic.CA1513.severity = none

.github/workflows/dotnet.yml

@@ -31,6 +31,7 @@ jobs:
         name: msbuild_log_${{matrix.configuration}}
         path: msbuild.binlog
         if-no-files-found: error
+      if: always()
 
   # Build the only in Release to generate all the NuGet packages.
   # This workflow also uploads the resulting packages as artifacts.

Directory.Build.props

@@ -1,10 +1,11 @@
 <Project>
   <PropertyGroup>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
-    <LangVersion>10.0</LangVersion>
+    <LangVersion>12</LangVersion>
     <Nullable>enable</Nullable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <NoWarn>$(NoWarn);MSB3270</NoWarn>
+    <CsWinRTIIDOptimizerOptOut>true</CsWinRTIIDOptimizerOptOut>
   </PropertyGroup>
 
   <!-- Centralized location for all generated artifacts -->
@@ -18,7 +19,7 @@
     As such, this needs to be changed before a new release as well.
   -->
   <PropertyGroup>
-    <ShmuelieWinRTServerPackageVersion>1.1.1</ShmuelieWinRTServerPackageVersion>
+    <ShmuelieWinRTServerPackageVersion>1.2.0</ShmuelieWinRTServerPackageVersion>
     <IsCommitOnReleaseBranch>false</IsCommitOnReleaseBranch>
   </PropertyGroup>
 
@@ -60,10 +61,12 @@
     <Copyright>Copyright (c) 2022 Shmueli Englard</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
-    <PackageIcon>icon.png</PackageIcon>
+    <PackageIcon>$(MSBuildProjectName)-128.png</PackageIcon>
     <PackageIconUrl>https://github.com/shmuelie/Shmuelie.WinRTServer/blob/main/Shmuelie.WinRTServer-64.png?raw=true</PackageIconUrl>
     <PackageTags>dotnet net netcore netstandard csharp library windows com winrt oop outofprocess rpc</PackageTags>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <Description>Out-of-Process WinRT/COM Server</Description>
   </PropertyGroup>
 
   <ItemGroup>

README.md

@@ -37,6 +37,11 @@ Many of the types you are used to using are supported out of the box like
 collection types, map types, streams, etc. This allows you to not have to worry
 about how the IPC works.
 
+## Security
+
+COM provides various ways to secure usage and creation of objects. For more
+details, see [Security in COM][7].
+
 # Usage
 
 Currently to create an Out-of-Process server requires the C++/WinRT tooling
@@ -111,16 +116,35 @@ similar).
 
 # Sample
 
-To help understand usage, a sample using a UWP client app, and WPF app, and a C++ console app is included under the
-test directory. Simply run the `Shmuelie.WinRTServer.Sample.Package` project to
-see it in action.
+To help understand usage and show what can be done samples can be found under
+the tests folder. The sample has:
+
+- .NET Framework Server
+- .NET 7 Server
+- UWP .NET Client App
+- C++/WinRT Console Client App
+- WPF .NET Framework Client App
+- WPF .NET 7 Client App
 
 > **Note**: If Visual Studio fails to build the Metadata project restarting
 > Visual Studio should fix the problem.
 
+# Troubleshooting
+
+If you are having issues, check on these things:
+
+- Make sure the client app includes the WinMDs (Interface and Metadata)
+- Make sure that the interface project uses the
+   `Windows.Foundation.Metadata.GuidAttribute` attribute, not the
+   `System.Runtime.InteropServices.GuidAttribute` attribute.
+- Make sure that the server project uses the
+  `System.Runtime.InteropServices.GuidAttribute` attribute, not the
+  `Windows.Foundation.Metadata.GuidAttribute` attribute.
+
 [1]: https://github.com/Shmuelie/Shmuelie.WinRTServer/actions
 [2]: https://www.nuget.org/stats/packages/Shmuelie.WinRTServer?groupby=Version
 [3]: https://www.nuget.org/packages/Shmuelie.WinRTServer/
 [4]: https://learn.microsoft.com/en-us/windows/apps/develop/platform/csharp-winrt/net-mappings-of-winrt-types
 [5]: https://learn.microsoft.com/en-us/uwp/midl-3/
 [6]: https://devblogs.microsoft.com/ifdef-windows/the-journey-of-moving-from-cpp-winrt-to-csharp-in-the-microsoft-store/
+[7]: https://learn.microsoft.com/en-us/windows/win32/com/security-in-com

Shmuelie.WinRTServer.sln

@@ -5,6 +5,7 @@ VisualStudioVersion = 17.3.32929.385
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_SolutionItems", "_SolutionItems", "{50DD472E-AD00-45C5-A2F7-4CB77CB8CD67}"
 	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
 		.gitignore = .gitignore
 		Directory.Build.props = Directory.Build.props
 		Directory.Build.targets = Directory.Build.targets
@@ -21,9 +22,6 @@ EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Shmuelie.WinRTServer", "src\Shmuelie.WinRTServer\Shmuelie.WinRTServer.csproj", "{F09FEFE0-ED5E-4A17-9C54-DB6C1CD559E9}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Src", "Src", "{E1670C4F-46C0-45BE-A351-E504DCB17A45}"
-	ProjectSection(SolutionItems) = preProject
-		src\Directory.Build.props = src\Directory.Build.props
-	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Shmuelie.WinRTServer.Sample.Interfaces", "tests\Shmuelie.WinRTServer.Sample.Interfaces\Shmuelie.WinRTServer.Sample.Interfaces.csproj", "{7E420EEB-3D6C-49FB-9E60-AE448BAC8B1F}"
 EndProject
@@ -47,6 +45,8 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Shmuelie.WinRTServer.Sample
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Shmuelie.WinRTServer.Sample.WpfNet6Client", "tests\Shmuelie.WinRTServer.Sample.WpfNet6Client\Shmuelie.WinRTServer.Sample.WpfNet6Client.csproj", "{8FFAA094-2D9C-49B5-BB36-4B2BB7512444}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Shmuelie.WinRTServer.Sample.ServerNet6", "tests\Shmuelie.WinRTServer.Sample.ServerNet6\Shmuelie.WinRTServer.Sample.ServerNet6.csproj", "{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|x64 = Debug|x64
@@ -135,6 +135,14 @@ Global
 		{8FFAA094-2D9C-49B5-BB36-4B2BB7512444}.Release|x64.Build.0 = Release|x64
 		{8FFAA094-2D9C-49B5-BB36-4B2BB7512444}.Release|x86.ActiveCfg = Release|x86
 		{8FFAA094-2D9C-49B5-BB36-4B2BB7512444}.Release|x86.Build.0 = Release|x86
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Debug|x64.ActiveCfg = Debug|x64
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Debug|x64.Build.0 = Debug|x64
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Debug|x86.ActiveCfg = Debug|x86
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Debug|x86.Build.0 = Debug|x86
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Release|x64.ActiveCfg = Release|x64
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Release|x64.Build.0 = Release|x64
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Release|x86.ActiveCfg = Release|x86
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3}.Release|x86.Build.0 = Release|x86
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -149,6 +157,7 @@ Global
 		{6B799403-7548-4FD8-9AF8-76BD13473029} = {CB701FA8-9663-444D-9610-1A8CDFF30E61}
 		{A78E8601-3191-4987-B61A-E48256869A39} = {CB701FA8-9663-444D-9610-1A8CDFF30E61}
 		{8FFAA094-2D9C-49B5-BB36-4B2BB7512444} = {CB701FA8-9663-444D-9610-1A8CDFF30E61}
+		{F37FE3DF-B23B-44C7-A3C1-1E4F20885DB3} = {CB701FA8-9663-444D-9610-1A8CDFF30E61}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {97F14D53-B029-4E3E-B7DE-51A510B2D428}

global.json

@@ -1,6 +1,10 @@
 {
-    "msbuild-sdks":
-    {
-      "MSBuild.Sdk.Extras": "3.0.38"
-    }
-  }
+  "msbuild-sdks": {
+    "MSBuild.Sdk.Extras": "3.0.38"
+  },
+  "sdk": {
+    "version": "8.0.100",
+    "rollForward": "latestFeature",
+    "allowPrerelease": false
+  }
+}

src/Shmuelie.WinRTServer/BaseActivationFactory.cs

@@ -1,13 +1,13 @@
 using System;
-using System.Runtime.InteropServices.WindowsRuntime;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
 /// <summary>
 /// Base for a WinRT Activation Factory for a .NET type.
 /// </summary>
-/// <seealso cref="IActivationFactory"/>
-public abstract class BaseActivationFactory : IActivationFactory
+[SupportedOSPlatform("windows8.0")]
+public abstract class BaseActivationFactory
 {
     /// <inheritdoc/>
     public abstract object ActivateInstance();

src/Shmuelie.WinRTServer/BaseClassFactory.cs

@@ -1,12 +1,13 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
 /// <summary>
 /// Base for a COM class factory for a .NET type.
 /// </summary>
-/// <seealso cref="Interop.Windows.IClassFactory"/>
 /// <remarks>Does not support aggregation. Will always return <c>CLASS_E_NOAGGREGATION</c> if requested.</remarks>
+[SupportedOSPlatform("windows6.0.6000")]
 public abstract class BaseClassFactory
 {
     /// <summary>

src/Shmuelie.WinRTServer/ComServer.cs

@@ -1,11 +1,12 @@
 using System;
 using System.Collections.Generic;
-using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using System.Threading.Tasks;
 using System.Timers;
 using Shmuelie.Interop.Windows;
-using static Shmuelie.Interop.Windows.ComBaseAPI;
-using static Shmuelie.Interop.Windows.Windows;
+using Windows.Win32.Foundation;
+using Windows.Win32.System.Com;
+using static Windows.Win32.PInvoke;
 
 namespace Shmuelie.WinRTServer;
 
@@ -14,12 +15,13 @@ namespace Shmuelie.WinRTServer;
 /// </summary>
 /// <see cref="IAsyncDisposable"/>
 /// <threadsafety static="true" instance="false"/>
+[SupportedOSPlatform("windows6.0.6000")]
 public sealed class ComServer : IAsyncDisposable
 {
     /// <summary>
     /// Map of class factories and the registration cookie from the CLSID that the factory creates.
     /// </summary>
-    private readonly Dictionary<Guid, (BaseClassFactory factory, uint cookie)> factories = new();
+    private readonly Dictionary<Guid, (BaseClassFactory factory, uint cookie)> factories = [];
 
     /// <summary>
     /// Collection of created instances.
@@ -42,8 +44,9 @@ public sealed class ComServer : IAsyncDisposable
     public unsafe ComServer()
     {
         using ComPtr<IGlobalOptions> options = default;
-        Guid clsid = IGlobalOptions.CLSID;
-        if (CoCreateInstance(&clsid, null, (uint)CLSCTX.CLSCTX_INPROC_SERVER, __uuidof<IGlobalOptions>(), (void**)options.GetAddressOf()) == S.S_OK)
+        Guid clsid = CLSID_GlobalOptions;
+        Guid iid = IGlobalOptions.IID_Guid;
+        if (CoCreateInstance(&clsid, null, CLSCTX.CLSCTX_INPROC_SERVER, &iid, (void**)options.GetAddressOf()) == HRESULT.S_OK)
         {
             options.Get()->Set(GLOBALOPT_PROPERTIES.COMGLB_RO_SETTINGS, (nuint)GLOBALOPT_RO_FLAGS.COMGLB_FAST_RUNDOWN);
         }
@@ -128,7 +131,7 @@ public unsafe bool RegisterClassFactory(BaseClassFactory factory)
         proxy.Attach(BaseClassFactoryProxy.Create(factory));
 
         uint cookie;
-        Marshal.ThrowExceptionForHR(CoRegisterClassObject(&clsid, (IUnknown*)proxy.Get(), (uint)CLSCTX.CLSCTX_LOCAL_SERVER, (uint)(REGCLS.REGCLS_MULTIPLEUSE | REGCLS.REGCLS_SUSPENDED), &cookie));
+        CoRegisterClassObject(&clsid, (IUnknown*)proxy.Get(), CLSCTX.CLSCTX_LOCAL_SERVER, (REGCLS.REGCLS_MULTIPLEUSE | REGCLS.REGCLS_SUSPENDED), &cookie).ThrowOnFailure();
 
         factories.Add(clsid, (factory, cookie));
         return true;
@@ -161,7 +164,7 @@ public unsafe bool UnregisterClassFactory(Guid clsid)
 
         data.factory.InstanceCreated -= Factory_InstanceCreated;
 
-        Marshal.ThrowExceptionForHR(CoRevokeClassObject(data.cookie));
+        CoRevokeClassObject(data.cookie).ThrowOnFailure();
         return true;
     }
 
@@ -199,7 +202,7 @@ public void Start()
 
         firstInstanceCreated = new();
         lifetimeCheckTimer.Start();
-        Marshal.ThrowExceptionForHR(CoResumeClassObjects());
+        CoResumeClassObjects().ThrowOnFailure();
     }
 
     /// <summary>
@@ -219,7 +222,7 @@ public void Stop()
 
         firstInstanceCreated = null;
         lifetimeCheckTimer.Stop();
-        Marshal.ThrowExceptionForHR(CoSuspendClassObjects());
+        CoSuspendClassObjects().ThrowOnFailure();
     }
 
     /// <summary>

src/Shmuelie.WinRTServer/ComServerExtensions.cs

@@ -1,10 +1,12 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
 /// <summary>
 /// Extensions for <see cref="ComServer"/>.
 /// </summary>
+[SupportedOSPlatform("windows6.0.6000")]
 public static class ComServerExtensions
 {
     /// <summary>

src/Shmuelie.WinRTServer/DelegateActivationFactory.cs

@@ -1,24 +1,18 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
 /// <summary>
 /// Delegate based activation factory for .NET types.
 /// </summary>
 /// <typeparam name="T">The type the factory creates.</typeparam>
+/// <param name="factory">Delegate to create instances.</param>
 /// <seealso cref="BaseActivationFactory"/>
-public sealed class DelegateActivationFactory<T> : BaseActivationFactory where T : class
+[SupportedOSPlatform("windows8.0")]
+public sealed class DelegateActivationFactory<T>(Func<T> factory) : BaseActivationFactory where T : class
 {
-    private readonly Func<T> factory;
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="DelegateActivationFactory{T}"/> class.
-    /// </summary>
-    /// <param name="factory">Delegate to create instances.</param>
-    public DelegateActivationFactory(Func<T> factory)
-    {
-        this.factory = factory;
-    }
+    private readonly Func<T> factory = factory;
 
     /// <inheritdoc/>
     public override string ActivatableClassId => typeof(T).FullName ?? throw new InvalidOperationException($"Unable to get activation class ID for type {typeof(T)}");

src/Shmuelie.WinRTServer/DelegateClassFactory.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
@@ -7,19 +8,12 @@ namespace Shmuelie.WinRTServer;
 /// </summary>
 /// <typeparam name="T">Type the factory creates.</typeparam>
 /// <typeparam name="TInterface">Interface that <typeparamref name="T"/> implements.</typeparam>
+/// <param name="factory">Delegate to create instances.</param>
 /// <seealso cref="BaseClassFactory"/>
-public sealed class DelegateClassFactory<T, TInterface> : BaseClassFactory where T : class, TInterface
+[SupportedOSPlatform("windows6.0.6000")]
+public sealed class DelegateClassFactory<T, TInterface>(Func<T> factory) : BaseClassFactory where T : class, TInterface
 {
-    private readonly Func<T> factory;
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="DelegateClassFactory{T, TInterface}"/> class.
-    /// </summary>
-    /// <param name="factory">Delegate to create instances.</param>
-    public DelegateClassFactory(Func<T> factory)
-    {
-        this.factory = factory;
-    }
+    private readonly Func<T> factory = factory;
 
     /// <inheritdoc/>
     protected internal override Guid Clsid => typeof(T).GUID;

src/Shmuelie.WinRTServer/GeneralActivationFactory.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
@@ -7,6 +8,7 @@ namespace Shmuelie.WinRTServer;
 /// </summary>
 /// <typeparam name="T">The type the factory creates.</typeparam>
 /// <seealso cref="BaseActivationFactory"/>
+[SupportedOSPlatform("windows8.0")]
 public sealed class GeneralActivationFactory<T> : BaseActivationFactory where T : class, new()
 {
     /// <inheritdoc/>

src/Shmuelie.WinRTServer/GeneralClassFactory.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
 
@@ -8,6 +9,7 @@ namespace Shmuelie.WinRTServer;
 /// <typeparam name="T">Type the factory creates.</typeparam>
 /// <typeparam name="TInterface">Interface that <typeparamref name="T"/> implements.</typeparam>
 /// <seealso cref="BaseClassFactory"/>
+[SupportedOSPlatform("windows6.0.6000")]
 public sealed class GeneralClassFactory<T, TInterface> : BaseClassFactory where T : class, TInterface, new()
 {
     /// <inheritdoc/>