Windows 11 Version 23H2 - September 2024 Samples Update

* WebSocket: Use a script to generate the certificates and private keys
* LampArray: New LampArray.IsAvailable property

Author: oldnewthing

.gitignore

@@ -203,4 +203,6 @@ FakesAssemblies/
 
 # Custom ignores
 gallery.xml
-project.lock.json
+project.lock.json
+Samples/WebSocket/server/WebSocketSampleScriptSettings
+Samples/StreamSocket/**/StreamSocketSampleScriptSettings.xml

Samples/LampArray/cppwinrt/SampleConfiguration.cpp

@@ -18,7 +18,7 @@ using namespace winrt::SDKTemplate;
 using namespace winrt::Windows::Devices::Lights;
 using namespace winrt::Windows::Foundation::Collections;
 
-hstring winrt::to_hstring(LampArrayKind lampArrayKind)
+std::wstring std::to_wstring(LampArrayKind lampArrayKind)
 {
     switch (lampArrayKind)
     {
@@ -44,7 +44,8 @@ hstring winrt::to_hstring(LampArrayKind lampArrayKind)
         return L"Art";
     case LampArrayKind::Undefined:
     default:
-        return L"Unknown LampArrayKind";
+        // Additional lamp array kinds can be looked up in the USB HID specification.
+        return std::to_wstring(static_cast<uint32_t>(lampArrayKind));
     }
 }
 

Samples/LampArray/cppwinrt/SampleConfiguration.h

@@ -12,9 +12,9 @@
 #pragma once
 #include "pch.h"
 
-namespace winrt
+namespace std
 {
-    hstring to_hstring(winrt::Windows::Devices::Lights::LampArrayKind lampArrayKind);
+    std::wstring to_wstring(winrt::Windows::Devices::Lights::LampArrayKind lampArrayKind);
 }
 
 namespace winrt::SDKTemplate
@@ -29,5 +29,7 @@ namespace winrt::SDKTemplate
         winrt::hstring const id;
         winrt::hstring const displayName;
         winrt::Windows::Devices::Lights::LampArray const lampArray;
+
+        winrt::Windows::Devices::Lights::LampArray::AvailabilityChanged_revoker availabilityChangedRevoker;
     };
 }

Samples/LampArray/cppwinrt/Scenario1_Basics.cpp

@@ -70,6 +70,10 @@ namespace winrt::SDKTemplate::implementation
             co_return;
         }
 
+        // Set up the AvailabilityChanged event callback for being notified whether this process can control
+        // RGB lighting for the newly attached LampArray.
+        info->availabilityChangedRevoker = info->lampArray.AvailabilityChanged(winrt::auto_revoke, { this, &Scenario1_Basics::LampArray_AvailabilityChanged });
+
         // Remember this new LampArray and add it to the list.
         m_attachedLampArrays.push_back(std::move(info));
         UpdateLampArrayList();
@@ -91,14 +95,24 @@ namespace winrt::SDKTemplate::implementation
         UpdateLampArrayList();
     }
 
+    // The AvailabilityChanged event will fire when this calling process gains or loses control of RGB lighting
+    // for the specified LampArray.
+    winrt::fire_and_forget Scenario1_Basics::LampArray_AvailabilityChanged(const LampArray& sender, const IInspectable&)
+    {
+        co_await winrt::resume_foreground(Dispatcher());
+
+        UpdateLampArrayList();
+    }
+
     void Scenario1_Basics::UpdateLampArrayList()
     {
         std::wstring message = std::wstring(L"Attached LampArrays: ") + std::to_wstring(m_attachedLampArrays.size()) + L"\n";
 
         for (auto&& info : m_attachedLampArrays)
         {
             message += std::wstring(L"\t") + std::wstring(info->displayName) + L" ("
-                + winrt::to_hstring(info->lampArray.LampArrayKind()) + L", " + std::to_wstring(info->lampArray.LampCount()) + L" lamps)\n";
+                + std::to_wstring(info->lampArray.LampArrayKind()) + L", " + std::to_wstring(info->lampArray.LampCount()) + L" lamps, "
+                + std::wstring(info->lampArray.IsAvailable() ? L"Available" : L"Unavailable") + L")\n";
         }
 
         LampArraysSummary().Text(message);

Samples/LampArray/cppwinrt/Scenario1_Basics.h

@@ -45,6 +45,10 @@ namespace winrt::SDKTemplate::implementation
             winrt::Windows::Devices::Enumeration::DeviceWatcher const&,
             winrt::Windows::Devices::Enumeration::DeviceInformationUpdate deviceInformationUpdate);
 
+        winrt::fire_and_forget LampArray_AvailabilityChanged(
+            winrt::Windows::Devices::Lights::LampArray const& sender,
+            winrt::Windows::Foundation::IInspectable const&);
+
         void UpdateLampArrayList();
 
         void ApplySettingsToLampArray(winrt::Windows::Devices::Lights::LampArray const& lampArray);

Samples/LampArray/cppwinrt/Scenario2_Effects.cpp

@@ -91,6 +91,10 @@ namespace winrt::SDKTemplate::implementation
         // Initial condition for the new LampArray is all lights off.
         info->lampArray.SetColor(Colors::Black());
 
+        // Set up the AvailabilityChanged event callback for being notified whether this process can control
+        // RGB lighting for the newly attached LampArray.
+        info->availabilityChangedRevoker = info->lampArray.AvailabilityChanged(winrt::auto_revoke, { this, &Scenario2_Effects::LampArray_AvailabilityChanged });
+
         m_attachedLampArrays.push_back(std::move(info));
 
         UpdateLampArrayList();
@@ -112,14 +116,24 @@ namespace winrt::SDKTemplate::implementation
         UpdateLampArrayList();
     }
 
+    // The AvailabilityChanged event will fire when this calling process gains or loses control of RGB lighting
+    // for the specified LampArray.
+    winrt::fire_and_forget Scenario2_Effects::LampArray_AvailabilityChanged(const LampArray& sender, const IInspectable&)
+    {
+        co_await winrt::resume_foreground(Dispatcher());
+
+        UpdateLampArrayList();
+    }
+
     void Scenario2_Effects::UpdateLampArrayList()
     {
         std::wstring message = std::wstring(L"Attached LampArrays: ") + std::to_wstring(m_attachedLampArrays.size()) + L"\n";
 
         for (auto&& info : m_attachedLampArrays)
         {
             message += L"\t" + info->displayName + L" ("
-                + winrt::to_hstring(info->lampArray.LampArrayKind()) + L", " + std::to_wstring(info->lampArray.LampCount()) + L" lamps)\n";
+                + std::to_wstring(info->lampArray.LampArrayKind()) + L", " + std::to_wstring(info->lampArray.LampCount()) + L" lamps, "
+                + std::wstring(info->lampArray.IsAvailable() ? L"Available" : L"Unavailable") + L")\n";
         }
 
         LampArraysSummary().Text(message);

Samples/LampArray/cppwinrt/Scenario2_Effects.h

@@ -125,6 +125,10 @@ namespace winrt::SDKTemplate::implementation
             winrt::Windows::Devices::Enumeration::DeviceWatcher const&,
             winrt::Windows::Devices::Enumeration::DeviceInformationUpdate deviceInformationUpdate);
 
+        winrt::fire_and_forget LampArray_AvailabilityChanged(
+            winrt::Windows::Devices::Lights::LampArray const& sender,
+            winrt::Windows::Foundation::IInspectable const&);
+
         void UpdateLampArrayList();
         void CleanupPreviousEffect();
 

Samples/LampArray/cs/Scenario1_Basics.xaml.cs

@@ -72,6 +72,10 @@ await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
                     return;
                 }
 
+                // Set up the AvailabilityChanged event callback for being notified whether this process can control
+                // RGB lighting for the newly attached LampArray.
+                info.lampArray.AvailabilityChanged += LampArray_AvailabilityChanged;
+
                 // Remember this new LampArray and add it to the list.
                 m_attachedLampArrays.Add(info);
                 UpdateLampArrayList();
@@ -90,12 +94,23 @@ await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
             });
         }
 
+        // The AvailabilityChanged event will fire when this calling process gains or loses control of RGB lighting
+        // for the specified LampArray.
+        private async void LampArray_AvailabilityChanged(LampArray sender, object args)
+        {
+            await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
+            {
+                UpdateLampArrayList();
+            });
+        }
+
         private void UpdateLampArrayList()
         {
             string message = $"Attached LampArrays: {m_attachedLampArrays.Count}\n";
             foreach (LampArrayInfo info in m_attachedLampArrays)
             {
-                message += $"\t{info.displayName} ({info.lampArray.LampArrayKind}, {info.lampArray.LampCount} lamps)\n";
+                message += $"\t{info.displayName} ({info.lampArray.LampArrayKind.ToString()}, {info.lampArray.LampCount} lamps, " +
+                           $"{(info.lampArray.IsAvailable ? "Available" : "Unavailable")})\n";
             }
             LampArraysSummary.Text = message;
         }

Samples/LampArray/cs/Scenario2_Effects.xaml.cs

@@ -125,6 +125,10 @@ await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
                 // Initial condition for the new LampArray is all lights off.
                 info.lampArray.SetColor(Colors.Black);
 
+                // Set up the AvailabilityChanged event callback for being notified whether this process can control
+                // RGB lighting for the newly attached LampArray.
+                info.lampArray.AvailabilityChanged += LampArray_AvailabilityChanged;
+
                 m_attachedLampArrays.Add(info);
 
                 UpdateLampArrayList();
@@ -143,12 +147,23 @@ await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
             });
         }
 
+        // The AvailabilityChanged event will fire when this calling process gains or loses control of RGB lighting
+        // for the specified LampArray.
+        private async void LampArray_AvailabilityChanged(LampArray sender, object args)
+        {
+            await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
+            {
+                UpdateLampArrayList();
+            });
+        }
+
         private void UpdateLampArrayList()
         {
             string message = $"Attached LampArrays: {m_attachedLampArrays.Count}\n";
             foreach (LampArrayInfo info in m_attachedLampArrays)
             {
-                message += $"\t{info.displayName} ({info.lampArray.LampArrayKind.ToString()}, {info.lampArray.LampCount} lamps)\n";
+                message += $"\t{info.displayName} ({info.lampArray.LampArrayKind.ToString()}, {info.lampArray.LampCount} lamps, " +
+                           $"{(info.lampArray.IsAvailable ? "Available" : "Unavailable")})\n";
             }
             LampArraysSummary.Text = message;
         }

Samples/WebSocket/README.md

@@ -95,9 +95,10 @@ This sample requires that network capabilities be set in the *Package.appxmanife
 ## Build the sample
 
 1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build. 
-2. Start Microsoft Visual Studio and select **File** \> **Open** \> **Project/Solution**.
-3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
-4. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**.
+2. **Important**: From an elevated Powershell command prompt, navigate to the `WebSocket/shared` folder and execute the Powershell script `.\\clientCertGenerator.ps1`, This script will generate a custom RootCert.cer and clientCert.pfx, which are required for the application and server.
+3. Start Microsoft Visual Studio and select **File** \> **Open** \> **Project/Solution**.
+4. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C++/WinRT, C#). Double-click the Visual Studio Solution (.sln) file.
+5. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**.
 
 ## Run the sample
 

Samples/WebSocket/cpp/WebSocket.vcxproj

@@ -236,4 +236,7 @@
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>
+  <Target Name="CheckCertificates" BeforeTargets="PrepareForBuild">
+    <Error Condition="!Exists('$(MSBuildThisFileDirectory)\..\shared\clientCert.pfx')" Text="Before building this project, run the clientCertGenerator.ps1 script elevated as described in the README.md."/>
+  </Target>
 </Project>

Samples/WebSocket/cppwinrt/WebSocket.vcxproj

@@ -196,6 +196,9 @@
   <ImportGroup Label="ExtensionTargets">
     <Import Project="packages\Microsoft.Windows.CppWinRT.2.0.200703.9\build\native\Microsoft.Windows.CppWinRT.targets" Condition="Exists('packages\Microsoft.Windows.CppWinRT.2.0.200703.9\build\native\Microsoft.Windows.CppWinRT.targets')" />
   </ImportGroup>
+  <Target Name="CheckCertificates" BeforeTargets="PrepareForBuild">
+    <Error Condition="!Exists('$(MSBuildThisFileDirectory)\..\shared\clientCert.pfx')" Text="Before building this project, run the clientCertGenerator.ps1 script elevated as described in the README.md."/>
+  </Target>
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
       <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>

Samples/WebSocket/cs/WebSocket.csproj

@@ -205,10 +205,11 @@
     <VisualStudioVersion>14.0</VisualStudioVersion>
   </PropertyGroup>
   <Import Project="$(MSBuildExtensionsPath)\Microsoft\WindowsXaml\v$(VisualStudioVersion)\Microsoft.Windows.UI.Xaml.CSharp.targets" />
-  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
-       Other similar extension points exist, see Microsoft.Common.targets.
   <Target Name="BeforeBuild">
+    <Error Condition="!Exists('$(MSBuildThisFileDirectory)\..\shared\clientCert.pfx')" Text="Before building this project, run the clientCertGenerator.ps1 script as described in the README.md."/>
   </Target>
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
   <Target Name="AfterBuild">
   </Target>
   -->

Samples/WebSocket/server/RootCert.cer

@@ -19,6 +19,7 @@ $wssFirewallRuleName = "WebSocketSample - HTTPS 443"
 $requiredFeatures = "IIS-WebServer", "IIS-WebServerRole", "NetFx4Extended-ASPNET45", "IIS-ApplicationDevelopment", "IIS-ASPNET45", "IIS-ISAPIExtensions", "IIS-ISAPIFilter", "IIS-NetFxExtensibility45", "IIS-WebSockets"
 $settings = @{"featuresToEnable"=@(); "serverCertificateThumbprint"=""; "clientRootCertThumbprint" = ""; "webBindingAdded"=$false; "oldDefaultCert"=""}
 $settingsFile = "$scriptPath\WebSocketSampleScriptSettings"
+$rootCertFile = "$scriptPath\Rootcert.cer"
 
 # Check if running as Administrator.
 $windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
@@ -37,6 +38,13 @@ if (Test-Path $settingsFile)
     return;
 }
 
+# Check if the necessary certificates have been created. If not, then user should run the certificate scripts first.
+if (Test-Path $rootCertFile)
+{
+    "You need to run the ..\shared\clientCertGenerator.ps1 script to create the certificates before running this script."
+    return;
+}
+
 # Get features that should be enabled.
 $featuresToEnable = @()
 Get-WindowsOptionalFeature -Online | ?{ $_.State -eq [Microsoft.Dism.Commands.FeatureState]::Disabled -and $requiredFeatures -contains $_.FeatureName } | %{ $featuresToEnable += $_.FeatureName }

Samples/WebSocket/server/WebSocketSampleScriptSettings

@@ -0,0 +1,63 @@
+#*********************************************************
+#
+# Copyright (c) Microsoft. All rights reserved.
+# This code is licensed under the MIT License (MIT).
+# THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
+# ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
+# IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
+# PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
+#
+#*********************************************************
+
+$sampleRootPath = Split-Path $(Split-Path -Resolve $MyInvocation.MyCommand.Path)
+$rootCertPath = "$sampleRootPath\server\RootCert.cer"
+$pfxFilePath = "$sampleRootPath\shared\clientCert.pfx"
+
+if ((Test-Path $rootCertPath) -And (Test-Path $pfxFilePath)) {
+    "The necessary certificates for this sample have already been created."
+    "If you want to regenerate them, delete the files below and rerun this script."
+    $rootCertPath
+    $pfxFilePath
+    return
+}
+
+# Check if running as Administrator.
+$windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
+$principal = New-Object System.Security.Principal.WindowsPrincipal($windowsIdentity)
+$administratorRole = [System.Security.Principal.WindowsBuiltInRole]::Administrator
+if ($principal.IsInRole($administratorRole) -eq $false)
+{
+    "This script must be run from an elevated PowerShell."
+    return
+}
+
+# Create a Root Certificate with a Private Key
+$rootCert = New-SelfSignedCertificate -DnsName "www.contoso.com" -KeySpec Signature -Subject "CN=www.contoso.com" -KeyExportPolicy Exportable -KeyUsage CertSign,CRLSign,DigitalSignature -CertStoreLocation "cert:\LocalMachine\My" -TextExtension @("2.5.29.19={text}CA=true&pathlength=0")
+
+# Export the root certificate to a file
+Export-Certificate -Cert $rootCert -FilePath $rootCertPath
+
+# Verify if the root certificate was created successfully
+if ($rootCert -eq $null) {
+    Write-Error "Failed to create the root certificate."
+    return
+}
+
+# Create the Client Certificate
+$clientCert = New-SelfSignedCertificate -KeySpec Signature -Subject "CN=WebSocketSample" -KeyExportPolicy Exportable -KeyUsage DigitalSignature,KeyEncipherment -CertStoreLocation "cert:\LocalMachine\My" -FriendlyName "WebSocketSampleClientCert" -Signer $rootCert -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.2")
+
+# Verify if the client certificate was created successfully
+if ($clientCert -eq $null) {
+    Write-Error "Failed to create the client certificate."
+    return
+} 
+
+# Export the Client Certificate to a PFX File
+$pfxPassword = ConvertTo-SecureString -String "1234" -Force -AsPlainText
+Export-PfxCertificate -Cert $clientCert -FilePath $pfxFilePath -Password $pfxPassword
+
+# Verify if the client certificate was exported successfully
+if (-Not (Test-Path $pfxFilePath)) {
+    Write-Error "Failed to export the client certificate to a PFX file."
+    return
+}