better Aes handling

Author: LongerWarrior

Private/ZenTools.cpp

@@ -34,7 +34,7 @@ INT32_MAIN_INT32_ARGC_TCHAR_ARGV()
 	return Result;
 }
 
-bool FIOStoreTools::ExtractPackagesFromContainers( const FString& ContainerDirPath, const FString& OutputDirPath, const FString& EncryptionKeysFile,
+bool FIOStoreTools::ExtractPackagesFromContainers( const FString& ContainerDirPath, const FString& OutputDirPath, const FString& MainAesKey, const FString& EncryptionKeysFile,
 	EZenPackageVersion DefaultZenPackageVersion, const FString& PackageFilter, const FString& Filter, bool SkipBulkData )
 {
 	TMap<FGuid, FAES::FAESKey> EncryptionKeys;
@@ -65,7 +65,11 @@ bool FIOStoreTools::ExtractPackagesFromContainers( const FString& ContainerDirPa
 			FGuid KeyGuid;
 			if ( FGuid::Parse( EntryPair.Key, KeyGuid ) )
 			{
-				const FString EncryptionKeyHex = EntryPair.Value->AsString();
+				FString EncryptionKeyHex = EntryPair.Value->AsString();
+				if (EncryptionKeyHex.StartsWith("0x"))
+				{
+					EncryptionKeyHex = EncryptionKeyHex.RightChop(2);
+				}
 
 				TArray<uint8> HexToBytesBuffer;
 				HexToBytesBuffer.AddZeroed( EncryptionKeyHex.Len() + 1 );
@@ -84,7 +88,22 @@ bool FIOStoreTools::ExtractPackagesFromContainers( const FString& ContainerDirPa
 			}
 		}
 	}
-	
+
+	if (!MainAesKey.IsEmpty())
+	{
+		TArray<uint8> HexToBytesBuffer;
+		HexToBytesBuffer.AddZeroed(MainAesKey.Len() + 1);
+		HexToBytesBuffer.SetNumZeroed(HexToBytes(MainAesKey, HexToBytesBuffer.GetData()));
+		if (HexToBytesBuffer.Num() != FAES::FAESKey::KeySize)
+		{
+			UE_LOG(LogIoStoreTools, Warning, TEXT("Ignoring Main AES Key because it has invalid size (%d bytes vs %d expected)"), HexToBytesBuffer.Num(), FAES::FAESKey::KeySize);
+		}
+		else
+		{
+			FMemory::Memcpy(EncryptionKeys.FindOrAdd(FGuid()).Key, HexToBytesBuffer.GetData(), HexToBytesBuffer.Num());
+		}
+	}
+
 	TArray<FString> FilterStrings;
 	if (!Filter.IsEmpty())
 	{
@@ -193,12 +212,14 @@ bool FIOStoreTools::ExecuteIOStoreTools(const TCHAR* Cmd)
 		{
 			EncryptionKeysFile = FPaths::ConvertRelativePathToFull( EncryptionKeysFile );
 		}
-		// Legacy argument support, it should not have a forward slash
-		else if ( FParse::Value( Cmd, TEXT("-EncryptionKeys="), EncryptionKeysFile ) )
+
+		FString MainAesKey;
+		
+		if (FParse::Value(Cmd, TEXT("AES="), MainAesKey) && MainAesKey.StartsWith("0x"))
 		{
-			EncryptionKeysFile = FPaths::ConvertRelativePathToFull( EncryptionKeysFile );
+			MainAesKey = MainAesKey.RightChop(2);
 		}
-		
+
 		ContainerFolderPath = FPaths::ConvertRelativePathToFull( ContainerFolderPath );
 		ExtractFolderRootPath = FPaths::ConvertRelativePathToFull( ExtractFolderRootPath );
 
@@ -250,7 +271,7 @@ bool FIOStoreTools::ExecuteIOStoreTools(const TCHAR* Cmd)
 		FString PotentialPackageFilter;
 		FParse::Value( Cmd, TEXT("PackageFilter="), PotentialPackageFilter );
 
-		return ExtractPackagesFromContainers( ContainerFolderPath, ExtractFolderRootPath, EncryptionKeysFile, DefaultZenPackageVersion, PotentialPackageFilter, FilterFilePath, SkipBulkData);
+		return ExtractPackagesFromContainers( ContainerFolderPath, ExtractFolderRootPath, MainAesKey,EncryptionKeysFile, DefaultZenPackageVersion, PotentialPackageFilter, FilterFilePath, SkipBulkData);
 	}
 
 	UE_LOG( LogIoStoreTools, Display, TEXT("Unknown command. Available commands: ") );

Private/ZenTools.h

@@ -12,6 +12,6 @@ class ZENTOOLS_API FIOStoreTools
 {
 public:
 	static bool ExecuteIOStoreTools( const TCHAR* Cmd );
-	static bool ExtractPackagesFromContainers( const FString& ContainerDirPath, const FString& OutputDirPath, const FString& EncryptionKeysFile, 
+	static bool ExtractPackagesFromContainers( const FString& ContainerDirPath, const FString& OutputDirPath, const FString& MainAesKey, const FString& EncryptionKeysFile,
 		EZenPackageVersion DefaultZenPackageVersion, const FString& PackageFiler, const FString& Filter, bool SkipBulkData );
 };

README.md

@@ -30,10 +30,11 @@ And `FFileHelper::SaveArrayToFile` signature to supports TArrayView64
 
 ## Usage:
 
-`ZenTools ExtractPackages <ContainerFolderPath> <ExtractionDir> [-EncryptionKeys=<KeyFile>] [-ZenPackageVersion=<Initial/DataResourceTable/Latest>] [-SkipBulkData] [-PackageFilter=<Package/Path/Filter>] [-Filter=<FilterFile>]`
+`ZenTools ExtractPackages <ContainerFolderPath> <ExtractionDir> [-Aes=<MainAesKey>] [-EncryptionKeys=<KeyFile>] [-ZenPackageVersion=<Initial/DataResourceTable/Latest>] [-SkipBulkData] [-PackageFilter=<Package/Path/Filter>] [-Filter=<FilterFile>]`
 
 - `ContainerFolderPath` - Path to the folder containing the container files (.ucas/.utoc + .pak).
 - `ExtractionDir` - Path to the folder where the extracted packages will be saved.
+- `MainAesKey` - Main AES key for the game.
 - `KeyFile` - Path to the file containing encryption keys.
 - `ZenPackageVersion` - Version of the ZenPackage format to use. Default is `Latest`. `Initial` for UE5.1
 - `SkipBulkData` - Skip extracting bulk data.
@@ -63,3 +64,4 @@ Since the game in the above example needs an AES key, this is the following `key
   "00000000-0000-0000-0000-000000000000": "DEADBEEFCAFEDEADBEEFCAFEDEADBEEFCAFEDEADBEEFCAFEDEADBEEFCAFEDEAD"
 }
 ```
+or use `-AES=DEADBEEFCAFEDEADBEEFCAFEDEADBEEFCAFEDEADBEEFCAFEDEADBEEFCAFEDEAD` instead.