Skip to content

Commit 2763d39

Browse files
mnadareskimnadareski
committed
Add MPQ hashing methods
1 parent 16b2385 commit 2763d39

File tree

1 file changed

+176
-0
lines changed

1 file changed

+176
-0
lines changed

‎SabreTools.IO/Encryption/MoPaQDecrypter.cs‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using System;
22
using System.IO;
3+
using System.Text;
34
using SabreTools.Hashing;
45
using SabreTools.IO.Extensions;
56

@@ -12,6 +13,78 @@ public class MoPaQDecrypter
1213
{
1314
#region Constants
1415

16+
/// <summary>
17+
/// Converts ASCII characters to lowercase
18+
/// </summary>
19+
/// <remarks>Converts slash (0x2F) to backslash (0x5C)</remarks>
20+
private static readonly byte[] AsciiToLowerTable = new byte[256]
21+
{
22+
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
23+
0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F,
24+
0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x5C,
25+
0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F,
26+
0x40, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F,
27+
0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F,
28+
0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F,
29+
0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F,
30+
0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F,
31+
0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F,
32+
0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF,
33+
0xB0, 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8, 0xB9, 0xBA, 0xBB, 0xBC, 0xBD, 0xBE, 0xBF,
34+
0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF,
35+
0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA, 0xDB, 0xDC, 0xDD, 0xDE, 0xDF,
36+
0xE0, 0xE1, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0xE9, 0xEA, 0xEB, 0xEC, 0xED, 0xEE, 0xEF,
37+
0xF0, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, 0xF8, 0xF9, 0xFA, 0xFB, 0xFC, 0xFD, 0xFE, 0xFF
38+
};
39+
40+
/// <summary>
41+
/// Converts ASCII characters to uppercase
42+
/// </summary>
43+
/// <remarks>Converts slash (0x2F) to backslash (0x5C)</remarks>
44+
private static readonly byte[] AsciiToUpperTable = new byte[256]
45+
{
46+
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
47+
0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F,
48+
0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x5C,
49+
0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F,
50+
0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F,
51+
0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F,
52+
0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F,
53+
0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F,
54+
0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F,
55+
0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F,
56+
0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF,
57+
0xB0, 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8, 0xB9, 0xBA, 0xBB, 0xBC, 0xBD, 0xBE, 0xBF,
58+
0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF,
59+
0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA, 0xDB, 0xDC, 0xDD, 0xDE, 0xDF,
60+
0xE0, 0xE1, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0xE9, 0xEA, 0xEB, 0xEC, 0xED, 0xEE, 0xEF,
61+
0xF0, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, 0xF8, 0xF9, 0xFA, 0xFB, 0xFC, 0xFD, 0xFE, 0xFF
62+
};
63+
64+
/// <summary>
65+
/// Converts ASCII characters to uppercase
66+
/// </summary>
67+
/// <remarks>Does NOT convert slash (0x2F) to backslash (0x5C)</remarks>
68+
private static readonly byte[] AsciiToUpperTable_Slash = new byte[256]
69+
{
70+
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
71+
0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F,
72+
0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F,
73+
0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F,
74+
0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F,
75+
0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F,
76+
0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F,
77+
0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F,
78+
0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F,
79+
0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F,
80+
0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF,
81+
0xB0, 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8, 0xB9, 0xBA, 0xBB, 0xBC, 0xBD, 0xBE, 0xBF,
82+
0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF,
83+
0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA, 0xDB, 0xDC, 0xDD, 0xDE, 0xDF,
84+
0xE0, 0xE1, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0xE9, 0xEA, 0xEB, 0xEC, 0xED, 0xEE, 0xEF,
85+
0xF0, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, 0xF8, 0xF9, 0xFA, 0xFB, 0xFC, 0xFD, 0xFE, 0xFF
86+
};
87+
1588
private const uint MPQ_HASH_KEY2_MIX = 0x400;
1689

1790
private const uint STORM_BUFFER_SIZE = 0x500;
@@ -175,5 +248,108 @@ public unsafe byte[] DecryptBlock(byte[] block, long length, uint key)
175248
Buffer.BlockCopy(castBlock, 0, block, 0, block.Length >> 2);
176249
return block;
177250
}
251+
252+
#region Hashing
253+
254+
//
255+
// Note: Implementation of this function in WorldEdit.exe and storm.dll
256+
// incorrectly treats the character as signed, which leads to the
257+
// a buffer underflow if the character in the file name >= 0x80:
258+
// The following steps happen when *pbKey == 0xBF and hashType == 0x0000
259+
// (calculating hash index)
260+
//
261+
// 1) Result of AsciiToUpperTable_Slash[*pbKey++] is sign-extended to 0xffffffbf
262+
// 2) The "ch" is added to hashType (0xffffffbf + 0x0000 => 0xffffffbf)
263+
// 3) The result is used as index to the StormBuffer table,
264+
// thus dereferences a random value BEFORE the begin of StormBuffer.
265+
//
266+
// As result, MPQs containing files with non-ANSI characters will not work between
267+
// various game versions and localizations. Even WorldEdit, after importing a file
268+
// with Korean characters in the name, cannot open the file back.
269+
//
270+
271+
/// <summary>
272+
/// Hash a string representing a filename based on the hash type
273+
/// using upper-case normalization
274+
/// </summary>
275+
/// <param name="filename">Filename to hash</param>
276+
/// <param name="hashType">Hash type to perform</param>
277+
/// <returns>Value representing the hashed filename</returns>
278+
public uint HashString(string filename, uint hashType)
279+
{
280+
uint seed1 = 0x7FED7FED;
281+
uint seed2 = 0xEEEEEEEE;
282+
283+
byte[] key = Encoding.ASCII.GetBytes(filename);
284+
int keyPtr = 0;
285+
while (key[keyPtr] != 0)
286+
{
287+
// Convert the input character to uppercase
288+
// Convert slash (0x2F) to backslash (0x5C)
289+
byte ch = AsciiToUpperTable[key[keyPtr++]];
290+
291+
seed1 = _stormBuffer[hashType + ch] ^ (seed1 + seed2);
292+
seed2 = ch + seed1 + seed2 + (seed2 << 5) + 3;
293+
}
294+
295+
return seed1;
296+
}
297+
298+
/// <summary>
299+
/// Hash a string representing a filename based on the hash type
300+
/// using upper-case normalization
301+
/// </summary>
302+
/// <param name="filename">Filename to hash</param>
303+
/// <param name="hashType">Hash type to perform</param>
304+
/// <returns>Value representing the hashed filename</returns>
305+
/// <remarks>This preserves slashes when hashing</remarks>
306+
public uint HashStringSlash(string filename, uint hashType)
307+
{
308+
uint seed1 = 0x7FED7FED;
309+
uint seed2 = 0xEEEEEEEE;
310+
311+
byte[] key = Encoding.ASCII.GetBytes(filename);
312+
int keyPtr = 0;
313+
while (key[keyPtr] != 0)
314+
{
315+
// Convert the input character to uppercase
316+
// DON'T convert slash (0x2F) to backslash (0x5C)
317+
byte ch = AsciiToUpperTable_Slash[key[keyPtr++]];
318+
319+
seed1 = _stormBuffer[hashType + ch] ^ (seed1 + seed2);
320+
seed2 = ch + seed1 + seed2 + (seed2 << 5) + 3;
321+
}
322+
323+
return seed1;
324+
}
325+
326+
/// <summary>
327+
/// Hash a string representing a filename based on the hash type
328+
/// using lower-case normalization
329+
/// </summary>
330+
/// <param name="filename">Filename to hash</param>
331+
/// <param name="hashType">Hash type to perform</param>
332+
/// <returns>Value representing the hashed filename</returns>
333+
public uint HashStringLower(string filename, uint hashType)
334+
{
335+
uint seed1 = 0x7FED7FED;
336+
uint seed2 = 0xEEEEEEEE;
337+
338+
byte[] key = Encoding.ASCII.GetBytes(filename);
339+
int keyPtr = 0;
340+
while (key[keyPtr] != 0)
341+
{
342+
// Convert the input character to lower
343+
// DON'T convert slash (0x2F) to backslash (0x5C)
344+
byte ch = AsciiToLowerTable[key[keyPtr++]];
345+
346+
seed1 = _stormBuffer[hashType + ch] ^ (seed1 + seed2);
347+
seed2 = ch + seed1 + seed2 + (seed2 << 5) + 3;
348+
}
349+
350+
return seed1;
351+
}
352+
353+
#endregion
178354
}
179355
}

0 commit comments

Comments
 (0)