Add device reset command

Yubico.Core/tests/Yubico.Core.UnitTests.csproj

@@ -43,6 +43,7 @@ limitations under the License. -->
     <DefineConstants>Linux</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="Xunit.SkippableFact" Version="1.4.13" />
     <ProjectReference Include="..\src\Yubico.Core.csproj" />
     <PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive" />
     <PackageReference Include="xunit" Version="2.8.0" />

Yubico.Core/tests/Yubico/Core/Cryptography/AesGcmPrimitivesOpenSslTests.cs

@@ -55,7 +55,7 @@ public void Encrypt_Decrypt_Succeeds()
             Assert.True(isValid);
         }
 
-        [Fact]
+        [SkippableFact(typeof(System.PlatformNotSupportedException))]
         public void Encrypt_Decrypt_Succeeds_RandomValues_Succeed()
         {
             var random = RandomNumberGenerator.Create();

Yubico.YubiKey/src/Yubico/YubiKey/IYubiKeyDevice.cs

@@ -693,5 +693,15 @@ void SetLegacyDeviceConfiguration(
         /// </remarks>
         /// <param name="value">The touch threshold to apply to the YubiKey. Must be a value greater than `6`.</param>
         void SetTemporaryTouchThreshold(int value);
+
+        /// <summary>
+        /// Perform device wide reset.
+        /// </summary>
+        /// <remarks>
+        /// <para>
+        /// Only available on YubiKey Bio Multi-protocol.
+        /// </para>
+        /// </remarks>
+        void DeviceReset();
     }
 }

Yubico.YubiKey/src/Yubico/YubiKey/Management/Commands/DeviceResetCommand.cs

@@ -0,0 +1,56 @@
+// Copyright 2024 Yubico AB
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using Yubico.Core.Iso7816;
+
+namespace Yubico.YubiKey.Management.Commands
+{
+    /// <summary>
+    /// Execute device reset.
+    /// </summary>
+    /// <remarks>
+    /// This class has a corresponding partner class <see cref="DeviceResetResponse"/>
+    /// </remarks>
+    public class DeviceResetCommand : IYubiKeyCommand<DeviceResetResponse>
+    {
+        private const byte DeviceResetInstruction = 0x1F;
+
+        /// <summary>
+        /// Gets the YubiKeyApplication to which this command belongs.
+        /// </summary>
+        /// <value>
+        /// <see cref="YubiKeyApplication.Management"/>
+        /// </value>
+        public YubiKeyApplication Application => YubiKeyApplication.Management;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DeviceResetCommand"/> class.
+        /// </summary>
+        public DeviceResetCommand()
+        {
+
+        }
+
+        /// <inheritdoc />
+        public CommandApdu CreateCommandApdu() => new CommandApdu
+        {
+            Ins = DeviceResetInstruction
+        };
+
+        /// <inheritdoc />
+        public DeviceResetResponse CreateResponseForApdu(ResponseApdu responseApdu) =>
+            new DeviceResetResponse(responseApdu);
+    }
+}

Yubico.YubiKey/src/Yubico/YubiKey/Management/Commands/DeviceResetResponse.cs

@@ -0,0 +1,38 @@
+// Copyright 2024 Yubico AB
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using Yubico.Core.Iso7816;
+
+namespace Yubico.YubiKey.Management.Commands
+{
+    /// <summary>
+    /// The response to the <see cref="DeviceResetCommand"/> command, containing the YubiKey's
+    /// device configuration details.
+    /// </summary>
+    public class DeviceResetResponse : YubiKeyResponse
+    {
+        /// <summary>
+        /// Constructs a DeviceResetResponse instance based on a ResponseApdu received from the YubiKey.
+        /// </summary>
+        /// <param name="responseApdu">
+        /// The ResponseApdu returned by the YubiKey.
+        /// </param>
+        public DeviceResetResponse(ResponseApdu responseApdu) :
+            base(responseApdu)
+        {
+
+        }
+    }
+}

Yubico.YubiKey/src/Yubico/YubiKey/YubiKeyDevice.Instance.cs

@@ -741,6 +741,45 @@ public void SetTemporaryTouchThreshold(int value)
             }
         }
 
+        /// <inheritdoc />
+        /// <exception cref="NotSupportedException">
+        /// The YubiKey does not support this feature.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// The YubiKey encountered an error and could not set the setting.
+        /// </exception>
+        public void DeviceReset()
+        {
+            if (!this.HasFeature(YubiKeyFeature.DeviceReset))
+            {
+                throw new NotSupportedException(
+                    string.Format(
+                        CultureInfo.CurrentCulture,
+                        ExceptionMessages.NotSupportedByYubiKeyVersion));
+            }
+            IYubiKeyConnection? connection = null;
+            try
+            {
+                if (TryConnect(YubiKeyApplication.Management, out connection))
+                {
+                    var command = new MgmtCmd.DeviceResetCommand();
+                    IYubiKeyResponse response = connection.SendCommand(command);
+                    if (response.Status != ResponseStatus.Success)
+                    {
+                        throw new InvalidOperationException(response.StatusMessage);
+                    }
+                }
+                else
+                {
+                    throw new NotSupportedException(ExceptionMessages.NoInterfaceAvailable);
+                }
+            }
+            finally
+            {
+                connection?.Dispose();
+            }
+        }
+
         private IYubiKeyResponse SendConfiguration(MgmtCmd.SetDeviceInfoBaseCommand baseCommand)
         {
             IYubiKeyConnection? connection = null;
@@ -1049,7 +1088,7 @@ private void WaitForReclaimTimeout(Transport newTransport)
             // Newer YubiKeys are able to switch interfaces much, much faster. Maybe this is being paranoid, but we
             // should still probably wait a few milliseconds for things to stabilize. But definitely not the full
             // three seconds! For older keys, we use a value of 3.01 seconds to give us a little wiggle room as the
-            // YubiKey's measurement for the reclaim timout is likely not as accurate as our system clock.
+            // YubiKey's measurement for the reclaim timeout is likely not as accurate as our system clock.
             TimeSpan reclaimTimeout = CanFastReclaim() ? TimeSpan.FromMilliseconds(100) : TimeSpan.FromSeconds(3.01);
 
             // We're only affected by the reclaim timeout if we're switching USB transports.

Yubico.YubiKey/src/Yubico/YubiKey/YubiKeyFeature.cs

@@ -74,6 +74,11 @@ public enum YubiKeyFeature
         /// </summary>
         TemporaryTouchThreshold,
 
+        /// <summary>
+        ///     The YubiKey supports proprietary reset.
+        /// </summary>
+        DeviceReset,
+
         // OTP application features
 
         /// <summary>

Yubico.YubiKey/src/Yubico/YubiKey/YubiKeyFeatureExtensions.cs

@@ -97,6 +97,9 @@ public static bool HasFeature(this IYubiKeyDevice yubiKeyDevice, YubiKeyFeature
                 YubiKeyFeature.FastUsbReclaim =>
                     yubiKeyDevice.FirmwareVersion >= FirmwareVersion.V5_6_0,
 
+                YubiKeyFeature.DeviceReset =>
+                    yubiKeyDevice.FirmwareVersion >= FirmwareVersion.V5_6_0,
+
                 YubiKeyFeature.TemporaryTouchThreshold =>
                     yubiKeyDevice.FirmwareVersion >= FirmwareVersion.V5_3_1,
 

Yubico.YubiKey/tests/utilities/Yubico/YubiKey/TestUtilities/HollowYubiKeyDevice.cs

@@ -262,5 +262,10 @@ public void SetTemporaryTouchThreshold(int value)
         {
             throw new NotImplementedException();
         }
+
+        public void DeviceReset()
+        {
+            throw new NotImplementedException();
+        }
     }
 }