Merge pull request #348 from Yubico/dennisdyallo/fix-device-props

fix: certain YubiKeyDevice properties were not being updated in the YubiKeyDevice

Author: DennisDyallo

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

@@ -400,9 +400,10 @@ bool TryConnect(
         /// </para>
         ///
         /// <para>
-        /// Modifies the value of <see cref="IYubiKeyDeviceInfo.ChallengeResponseTimeout"/>. This
-        /// requires the YubiKey's configuration to be unlocked (see
-        /// <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> and
+        /// Modifies the value of <see cref="IYubiKeyDeviceInfo.ChallengeResponseTimeout"/>.
+        /// After successful execution, the <see cref="IYubiKeyDeviceInfo.ChallengeResponseTimeout"/> property
+        /// will immediately reflect the new value. This requires the YubiKey's configuration
+        /// to be unlocked (see <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> and
         /// <see cref="UnlockConfiguration(ReadOnlySpan{byte})"/>.
         /// </para>
         /// </remarks>
@@ -432,9 +433,10 @@ bool TryConnect(
         /// </para>
         ///
         /// <para>
-        /// Modifies the value of <see cref="IYubiKeyDeviceInfo.AutoEjectTimeout"/>. This
-        /// requires the YubiKey's configuration to be unlocked (see
-        /// <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> and
+        /// Modifies the value of <see cref="IYubiKeyDeviceInfo.AutoEjectTimeout"/>.
+        /// After successful execution, the <see cref="IYubiKeyDeviceInfo.AutoEjectTimeout"/> property
+        /// will immediately reflect the new value. This requires the YubiKey's configuration
+        /// to be unlocked (see <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> and
         /// <see cref="UnlockConfiguration(ReadOnlySpan{byte})"/>.
         /// </para>
         /// <para>
@@ -465,6 +467,11 @@ bool TryConnect(
         /// </summary>
         /// <remarks>
         /// <para>
+        /// After successful execution, the <see cref="DeviceFlags"/> property
+        /// will immediately reflect the new value.
+        /// </para>
+        ///
+        /// <para>
         /// YubiKeys prior to firmware version 5 can use
         /// <see cref="SetLegacyDeviceConfiguration(YubiKeyCapabilities, byte, bool, int)"/> to enable
         /// <see cref="DeviceFlags.TouchEject"/>.
@@ -499,7 +506,8 @@ bool TryConnect(
         /// </para>
         ///
         /// <para>
-        /// See <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/>.
+        /// See <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/>. After successful execution,
+        /// the <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> property will immediately be set to <c>true</c>.
         /// </para>
         /// <para>
         /// Once the lock code is set, no changes can be made to the YubiKey's user-settable
@@ -537,7 +545,8 @@ bool TryConnect(
         ///
         /// <remarks>
         /// <para>
-        /// See <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/>.
+        /// See <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/>. After successful execution,
+        /// the <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> property will immediately be set to <c>false</c>.
         /// </para>
         /// <para>
         /// By removing the lock code, changes can be made to the YubiKey's user-settable
@@ -648,12 +657,26 @@ void SetLegacyDeviceConfiguration(
             int autoEjectTimeout = 0);
 
         /// <summary>
-        /// Sets the <see cref="IYubiKeyDeviceInfo.IsNfcRestricted"/> on the <see cref="YubiKeyDeviceInfo"/>
+        /// Sets the <see cref="IYubiKeyDeviceInfo.IsNfcRestricted"/> value.
         /// </summary>
-        /// <param name="enabled">Set this value to true to enable, otherwise false</param>
+        /// <remarks>
+        /// <para>
+        /// After successful execution, the <see cref="IYubiKeyDeviceInfo.IsNfcRestricted"/> property
+        /// will immediately reflect the new value.
+        /// </para>
+        /// <para>
+        /// This operation requires the YubiKey's configuration to be unlocked (see
+        /// <see cref="IYubiKeyDeviceInfo.ConfigurationLocked"/> and
+        /// <see cref="UnlockConfiguration(ReadOnlySpan{byte})"/>.
+        /// </para>
+        /// </remarks>
+        /// <param name="enabled">Set this value to true to restrict NFC, false to allow NFC.</param>
         /// <exception cref="InvalidOperationException">
         /// The command failed to complete.
         /// </exception>
+        /// <exception cref="NotSupportedException">
+        /// This feature is not supported on this YubiKey version.
+        /// </exception>
         void SetIsNfcRestricted(bool enabled);
 
         /// <summary>

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

@@ -373,6 +373,12 @@ public void SetChallengeResponseTimeout(int seconds)
             {
                 throw new InvalidOperationException(response.StatusMessage);
             }
+
+            // Update cached property to reflect the new configuration
+            if (_yubiKeyDeviceInfo is YubiKeyDeviceInfo deviceInfo)
+            {
+                deviceInfo.ChallengeResponseTimeout = (byte)seconds;
+            }
         }
 
         /// <inheritdoc/>
@@ -394,6 +400,12 @@ public void SetAutoEjectTimeout(int seconds)
             {
                 throw new InvalidOperationException(response.StatusMessage);
             }
+
+            // Update cached property to reflect the new configuration
+            if (_yubiKeyDeviceInfo is YubiKeyDeviceInfo deviceInfo)
+            {
+                deviceInfo.AutoEjectTimeout = seconds;
+            }
         }
 
         /// <inheritdoc/>
@@ -411,6 +423,12 @@ public void SetIsNfcRestricted(bool enabled)
             {
                 throw new InvalidOperationException(response.StatusMessage);
             }
+
+            // Update cached property to reflect the new configuration
+            if (_yubiKeyDeviceInfo is YubiKeyDeviceInfo deviceInfo)
+            {
+                deviceInfo.IsNfcRestricted = enabled;
+            }
         }
 
         /// <inheritdoc/>
@@ -426,6 +444,12 @@ public void SetDeviceFlags(DeviceFlags deviceFlags)
             {
                 throw new InvalidOperationException(response.StatusMessage);
             }
+
+            // Update cached property to reflect the new configuration
+            if (_yubiKeyDeviceInfo is YubiKeyDeviceInfo deviceInfo)
+            {
+                deviceInfo.DeviceFlags = deviceFlags;
+            }
         }
 
         /// <inheritdoc/>
@@ -457,6 +481,12 @@ public void LockConfiguration(ReadOnlySpan<byte> lockCode)
             {
                 throw new InvalidOperationException(response.StatusMessage);
             }
+
+            // Update cached property to reflect the new configuration
+            if (_yubiKeyDeviceInfo is YubiKeyDeviceInfo deviceInfo)
+            {
+                deviceInfo.ConfigurationLocked = true;
+            }
         }
 
         /// <inheritdoc/>
@@ -483,6 +513,12 @@ public void UnlockConfiguration(ReadOnlySpan<byte> lockCode)
             {
                 throw new InvalidOperationException(response.StatusMessage);
             }
+
+            // Update cached property to reflect the new configuration
+            if (_yubiKeyDeviceInfo is YubiKeyDeviceInfo deviceInfo)
+            {
+                deviceInfo.ConfigurationLocked = false;
+            }
         }
 
         /// <inheritdoc/>