Add NFC ID (decimal and hex) to Get-YubiKey output to support PACS integration

Author: JMarkstrom

Module/Cmdlets/Yubikey/GetYubikey.cs

@@ -6,6 +6,10 @@
 /// .EXAMPLE
 /// Get-YubiKey
 /// Returns information about the currently connected YubiKey
+/// 
+/// .EXAMPLE
+/// Get-YubiKey | Select-Object SerialNumber, NfcIdDec, NfcIdHex
+/// Returns information about select attributes of the YubiKey: serial number, NFC ID (decimal) and NFC ID (hex)
 /// </summary>
 
 using System.Management.Automation;           // Windows PowerShell namespace.

Module/support/Converter.cs

@@ -9,6 +9,17 @@
 /// .EXAMPLE
 /// $bytes = [byte[]]@(0x1A, 0x2B, 0x3C, 0x4D)
 /// $hexString = [powershellYK.support.Converter]::ByteArrayToString($bytes)
+/// 
+/// .EXAMPLE
+/// $uid = [powershellYK.support.Converter]::SerialToNfcUid(12345678)
+/// $hex = [powershellYK.support.Converter]::ByteArrayToString($uid)
+/// Returns NFC ID in hex: "274E61BC00614E"
+/// 
+/// .EXAMPLE
+/// $uid = [powershellYK.support.Converter]::SerialToNfcUid(12345678)
+/// $dec = [powershellYK.support.Converter]::NfcUidToDecimal($uid)
+/// Returns NFC ID in decimal: 11161651036004942
+/// 
 /// </summary>
 
 // Imports
@@ -96,6 +107,33 @@ internal static string AddMissingPadding(string base64)
             return base64;
         }
 
+        // Derive the 7-byte NFC UID from a YubiKey serial number
+        public static byte[] SerialToNfcUid(uint serial)
+        {
+            byte b0 = (byte)(serial >> 24);
+            byte b1 = (byte)(serial >> 16);
+            byte b2 = (byte)(serial >> 8);
+            byte b3 = (byte)serial;
+
+            return new byte[] { 0x27, b3, b2, b1, b0, b2, b3 };
+        }
+
+        // Derive the decimal representation of a 7-byte NFC UID
+        public static ulong NfcUidToDecimal(byte[] uid)
+        {
+            if (uid.Length != 7)
+            {
+                throw new ArgumentException("NFC UID must be 7 bytes long", nameof(uid));
+            }
+
+            ulong value = 0;
+            for (int i = 0; i < uid.Length; i++)
+            {
+                value = (value << 8) | uid[i];
+            }
+            return value;
+        }
+
         // Convert YubiKey public key to .NET asymmetric algorithm
         public static AsymmetricAlgorithm YubiKeyPublicKeyToDotNet(IPublicKey publicKey)
         {

Module/types/YubiKeyInformation.cs

@@ -72,6 +72,28 @@ public class YubikeyInformation
         // YubiKey serial number
         public int? SerialNumber { get { return YubiKeyDevice.SerialNumber; } }
 
+        // NFC UID as decimal
+        public string? NfcIdDec
+        {
+            get
+            {
+                if (SerialNumber is null) return null;
+                byte[] uid = Converter.SerialToNfcUid((uint)SerialNumber.Value);
+                return Converter.NfcUidToDecimal(uid).ToString();
+            }
+        }
+
+        // NFC UID as hex
+        public string? NfcIdHex
+        {
+            get
+            {
+                if (SerialNumber is null) return null;
+                byte[] uid = Converter.SerialToNfcUid((uint)SerialNumber.Value);
+                return Converter.ByteArrayToString(uid);
+            }
+        }
+
         // FIPS series status
         public bool IsFipsSeries { get { return YubiKeyDevice.IsFipsSeries; } }