From 5bf1d85e05beda1c099ace74f8a2a71fabcf1da9 Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Tue, 1 Apr 2025 13:04:52 -0400 Subject: [PATCH] Add key validation (unused) --- NDecrypt.Core/DecryptArgs.cs | 268 ++++++++++++++++++++++++++++++++--- 1 file changed, 247 insertions(+), 21 deletions(-) diff --git a/NDecrypt.Core/DecryptArgs.cs b/NDecrypt.Core/DecryptArgs.cs index 160d712..a1e69e1 100644 --- a/NDecrypt.Core/DecryptArgs.cs +++ b/NDecrypt.Core/DecryptArgs.cs @@ -2,6 +2,7 @@ using System; using System.IO; using SabreTools.IO.Extensions; using SabreTools.IO.Readers; +using SabreTools.Matching; namespace NDecrypt.Core { @@ -300,47 +301,41 @@ namespace NDecrypt.Core /// public byte[] AESHardwareConstant { get; private set; } = []; - #region Retail Keys - /// /// KeyX 0x18 (New 3DS 9.3) /// public byte[] KeyX0x18 { get; private set; } = []; - /// - /// KeyX 0x1B (New 3DS 9.6) - /// - public byte[] KeyX0x1B { get; private set; } = []; - - /// - /// KeyX 0x25 (> 7.x) - /// - public byte[] KeyX0x25 { get; private set; } = []; - - /// - /// KeyX 0x2C (< 6.x) - /// - public byte[] KeyX0x2C { get; private set; } = []; - - #endregion - - #region Development Keys - /// /// Dev KeyX 0x18 (New 3DS 9.3) /// public byte[] DevKeyX0x18 { get; private set; } = []; + /// + /// KeyX 0x1B (New 3DS 9.6) + /// + public byte[] KeyX0x1B { get; private set; } = []; + /// /// Dev KeyX 0x1B New 3DS 9.6) /// public byte[] DevKeyX0x1B { get; private set; } = []; + /// + /// KeyX 0x25 (> 7.x) + /// + public byte[] KeyX0x25 { get; private set; } = []; + /// /// Dev KeyX 0x25 (> 7.x) /// public byte[] DevKeyX0x25 { get; private set; } = []; + /// + /// KeyX 0x2C (< 6.x) + /// + public byte[] KeyX0x2C { get; private set; } = []; + /// /// Dev KeyX 0x2C (< 6.x) /// @@ -348,6 +343,152 @@ namespace NDecrypt.Core #endregion + #region Internal Test Values + + /// + /// Initial value for key validation tests + /// + private static readonly byte[] TestIV = + [ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, + 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, + ]; + + /// + /// Pattern to use for key validation tests + /// + private static readonly byte[] TestPattern = + [ + 0x0F, 0x0E, 0x0D, 0x0C, 0x0B, 0x0A, 0x09, 0x08, + 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00, + 0x0F, 0x0E, 0x0D, 0x0C, 0x0B, 0x0A, 0x09, 0x08, + 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00, + 0x0F, 0x0E, 0x0D, 0x0C, 0x0B, 0x0A, 0x09, 0x08, + 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00, + 0x0F, 0x0E, 0x0D, 0x0C, 0x0B, 0x0A, 0x09, 0x08, + 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00, + ]; + + /// + /// Expected output value for KeyX0x18 + /// + private static readonly byte[] ExpectedKeyX0x18 = + [ + 0x06, 0xF1, 0xB2, 0x3B, 0x12, 0xAD, 0x80, 0xC1, + 0x13, 0xC6, 0x18, 0x3D, 0x27, 0xB8, 0xB9, 0x95, + 0x49, 0x73, 0x59, 0x82, 0xEF, 0xFE, 0x16, 0x48, + 0x91, 0x2A, 0x89, 0x55, 0x9A, 0xDC, 0x3C, 0xA0, + 0x84, 0x46, 0x14, 0xE0, 0x16, 0x59, 0x8E, 0x4F, + 0xC2, 0x6C, 0x52, 0xA4, 0x7D, 0xAD, 0x4F, 0x23, + 0xF1, 0xC6, 0x99, 0x44, 0x39, 0xB7, 0x42, 0xF0, + 0x1F, 0xBB, 0x02, 0xF6, 0x0A, 0x8A, 0xC2, 0x9A, + ]; + + /// + /// Expected output value for DevKeyX0x18 + /// + private static readonly byte[] ExpectedDevKeyX0x18 = + [ + 0x99, 0x6E, 0x3C, 0x54, 0x97, 0x3C, 0xEA, 0xE8, + 0xBA, 0xAE, 0x18, 0x5C, 0x93, 0x27, 0x65, 0x50, + 0xF6, 0x6D, 0x67, 0xD7, 0xEF, 0xBD, 0x7C, 0xCB, + 0x8A, 0xC1, 0x1A, 0x54, 0xFC, 0x3B, 0x8B, 0x3A, + 0x0E, 0xE5, 0xEF, 0x27, 0x4A, 0x73, 0x7E, 0x0A, + 0x2E, 0x2E, 0x9D, 0xAF, 0x6C, 0x03, 0xF2, 0x91, + 0xC4, 0xFA, 0x73, 0xFD, 0x6B, 0xA0, 0x07, 0xD4, + 0x75, 0x5B, 0x6F, 0x2E, 0x8B, 0x68, 0x4C, 0xD1, + ]; + + /// + /// Expected output value for KeyX0x1B + /// + private static readonly byte[] ExpectedKeyX0x1B = + [ + 0x0A, 0xE4, 0x79, 0x02, 0x1B, 0xFA, 0x25, 0x4B, + 0x2D, 0x92, 0x4F, 0xA8, 0x41, 0x59, 0xCE, 0x10, + 0x09, 0xE6, 0x08, 0x61, 0x23, 0xC7, 0xD2, 0x30, + 0x84, 0x37, 0xD5, 0x49, 0x42, 0x94, 0xB2, 0x70, + 0x6A, 0xF3, 0x75, 0xB0, 0x1F, 0x4F, 0xA1, 0xCE, + 0x03, 0xA2, 0x6A, 0x19, 0x5D, 0x32, 0x0D, 0xB5, + 0x79, 0xCD, 0xFD, 0xF0, 0xDE, 0x49, 0x26, 0x2D, + 0x29, 0x36, 0x30, 0x69, 0x8B, 0x45, 0xE1, 0xFC, + ]; + + /// + /// Expected output value for DevKeyX0x1B + /// + private static readonly byte[] ExpectedDevKeyX0x1B = + [ + 0x16, 0x4F, 0xD9, 0x58, 0xC9, 0x20, 0xB3, 0xED, + 0xC4, 0xEB, 0x57, 0x39, 0x10, 0xEF, 0xA8, 0xCC, + 0xE5, 0x49, 0xBF, 0x52, 0x10, 0xA9, 0xCC, 0xE1, + 0x65, 0x3B, 0x2D, 0x51, 0x45, 0xFB, 0x60, 0x52, + 0x3E, 0x29, 0xEB, 0xEB, 0x3F, 0xF2, 0x76, 0x08, + 0x00, 0x05, 0x7F, 0x64, 0x29, 0x4A, 0x17, 0x22, + 0x56, 0x7F, 0x49, 0x94, 0x1A, 0x8C, 0x56, 0x35, + 0x38, 0xBE, 0xA4, 0x2E, 0x58, 0xD3, 0x81, 0x8C, + ]; + + /// + /// Expected output value for KeyX0x25 + /// + private static readonly byte[] ExpectedKeyX0x25 = + [ + 0x37, 0xBC, 0x73, 0xD6, 0xEE, 0x73, 0xE0, 0x94, + 0x42, 0x84, 0x74, 0xE5, 0xD8, 0xFB, 0x5F, 0x65, + 0xF4, 0xCF, 0x2E, 0xC1, 0x43, 0x48, 0x6C, 0xAA, + 0xC8, 0xF9, 0x96, 0xE6, 0x33, 0xDD, 0xE7, 0xBF, + 0xD2, 0x21, 0x89, 0x39, 0x13, 0xD1, 0xEC, 0xCA, + 0x1D, 0x5D, 0x1F, 0x77, 0x95, 0xD2, 0x8B, 0x27, + 0x92, 0x79, 0xC5, 0x1D, 0x72, 0xA7, 0x28, 0x57, + 0x41, 0x0E, 0x46, 0xB8, 0x80, 0x7B, 0x7C, 0x0D, + ]; + + /// + /// Expected output value for DevKeyX0x25 + /// + private static readonly byte[] ExpectedDevKeyX0x25 = + [ + 0x71, 0x65, 0x30, 0xF2, 0x68, 0xEC, 0x65, 0x0A, + 0x8C, 0x9E, 0xC5, 0x5A, 0xFA, 0x37, 0x8E, 0xDA, + 0x7B, 0x58, 0x3B, 0x66, 0x7C, 0x9D, 0x16, 0xD9, + 0x2D, 0x8F, 0xCF, 0x04, 0x66, 0x7F, 0x27, 0x41, + 0xBF, 0x5F, 0x1E, 0x11, 0x4C, 0xD6, 0xB9, 0x0A, + 0xC5, 0x42, 0xCF, 0x2B, 0x87, 0x6B, 0xD4, 0x72, + 0x4D, 0x9C, 0x29, 0x2E, 0xF8, 0xB0, 0x6F, 0x22, + 0x35, 0x5B, 0x96, 0x83, 0xD1, 0xE4, 0x5E, 0xDB, + ]; + + /// + /// Expected output value for KeyX0x2C + /// + private static readonly byte[] ExpectedKeyX0x2C = + [ + 0xAE, 0x44, 0x20, 0xDB, 0xA5, 0x96, 0xDC, 0xF3, + 0xD8, 0x23, 0x9E, 0x3C, 0x44, 0x73, 0x3D, 0xCD, + 0x07, 0xD5, 0xF8, 0xD0, 0xC6, 0xB3, 0x5A, 0x80, + 0xB5, 0x5A, 0x55, 0x30, 0x5D, 0x4A, 0xBE, 0x61, + 0xBF, 0xEF, 0x64, 0x17, 0x28, 0xD6, 0x26, 0x52, + 0x42, 0x4D, 0x8F, 0x1C, 0xBC, 0x63, 0xD3, 0x91, + 0x7D, 0xA6, 0x4F, 0xAF, 0x26, 0x38, 0x60, 0xEE, + 0x79, 0x92, 0x2F, 0xD8, 0xCA, 0x4E, 0xE7, 0xEC, + ]; + + /// + /// Expected output value for DevKeyX0x2C + /// + private static readonly byte[] ExpectedDevKeyX0x2C = + [ + 0x5F, 0x73, 0xD5, 0x9A, 0x67, 0xFF, 0x8C, 0x12, + 0x31, 0x58, 0x0B, 0x58, 0x46, 0xFE, 0x05, 0x16, + 0x92, 0xE4, 0x84, 0x06, 0x18, 0x9B, 0x58, 0x91, + 0xE7, 0xF8, 0xCD, 0xA9, 0x95, 0xAC, 0x07, 0xCD, + 0x43, 0x20, 0x7A, 0x8C, 0xCC, 0xAB, 0x48, 0x50, + 0x29, 0x2F, 0x96, 0x73, 0xB0, 0xD9, 0xE5, 0xCB, + 0xE6, 0x9A, 0x0D, 0xF7, 0xD0, 0x1E, 0xC2, 0xEC, + 0xC1, 0xE2, 0x8E, 0xEE, 0x89, 0xB9, 0xB1, 0x97, + ]; + #endregion /// @@ -371,6 +512,9 @@ namespace NDecrypt.Core InitAesKeysTxt(keyfile); else InitKeysBin(keyfile); + + // Perform validation tests + ValidateKeys(); } /// @@ -571,6 +715,88 @@ namespace NDecrypt.Core IsReady = true; } + /// + /// Validate that all keys provided are going to be valid + /// + /// Does not know what the keys are, just the result + /// TODO: Do something with these results? + private void ValidateKeys() + { + Console.WriteLine("DEBUG: Validating provided keys"); + + // KeyX0x18 + if (KeyX0x18.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(KeyX0x18, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedKeyX0x18, actual); + Console.WriteLine($"KeyX0x18 match: {match}"); + } + + // DevKeyX0x18 + if (DevKeyX0x18.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(DevKeyX0x18, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedDevKeyX0x18, actual); + Console.WriteLine($"DevKeyX0x18 match: {match}"); + } + + // KeyX0x1B + if (KeyX0x1B.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(KeyX0x1B, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedKeyX0x1B, actual); + Console.WriteLine($"KeyX0x1B match: {match}"); + } + + // DevKeyX0x1B + if (DevKeyX0x1B.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(DevKeyX0x1B, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedDevKeyX0x1B, actual); + Console.WriteLine($"DevKeyX0x1B match: {match}"); + } + + // KeyX0x25 + if (KeyX0x25.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(KeyX0x25, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedKeyX0x25, actual); + Console.WriteLine($"KeyX0x25 match: {match}"); + } + + // DevKeyX0x25 + if (DevKeyX0x25.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(DevKeyX0x25, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedDevKeyX0x25, actual); + Console.WriteLine($"DevKeyX0x25 match: {match}"); + } + + // KeyX0x2C + if (KeyX0x2C.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(KeyX0x2C, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedKeyX0x2C, actual); + Console.WriteLine($"KeyX0x2C match: {match}"); + } + + // DevKeyX0x2C + if (DevKeyX0x2C.Length > 0) + { + var cipher = CommonOperations.CreateAESEncryptionCipher(DevKeyX0x2C, TestIV); + byte[] actual = cipher.ProcessBytes(TestPattern); + bool match = Extensions.EqualsExactly(ExpectedDevKeyX0x2C, actual); + Console.WriteLine($"DevKeyX0x2C match: {match}"); + } + } + // https://stackoverflow.com/questions/311165/how-do-you-convert-a-byte-array-to-a-hexadecimal-string-and-vice-versa private static byte[] StringToByteArray(string? hex) {