├── .gitignore ├── .gitmodules ├── Breakpoint.cpp ├── Breakpoint.h ├── CHANGES.txt ├── COPYING.txt ├── DebugLoop.cpp ├── DebugLoop.h ├── README.md ├── UnrealKey.sln ├── UnrealKey.vcxproj ├── UnrealKey.vcxproj.filters ├── UnrealKeyDLL.vcxproj ├── UnrealKeyDLL.vcxproj.filters ├── aes.c ├── aes.h ├── common.h ├── dllmain.cpp └── main.cpp /.gitignore: -------------------------------------------------------------------------------- 1 | .vs 2 | lib 3 | x64 4 | *.vcxproj.user 5 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "minhook"] 2 | path = minhook 3 | url = https://github.com/TsudaKageyu/minhook 4 | -------------------------------------------------------------------------------- /Breakpoint.cpp: -------------------------------------------------------------------------------- 1 | #include "Breakpoint.h" 2 | 3 | // ---------------------------------------------------------------------------- 4 | Breakpoint::Breakpoint(DWORD tid, void* addr, UCHAR type) 5 | { 6 | m_hThread = OpenThread(THREAD_SUSPEND_RESUME | THREAD_GET_CONTEXT | THREAD_SET_CONTEXT, FALSE, tid); 7 | m_nIndex = -1; 8 | this->set(addr, type); 9 | this->enable(); 10 | } 11 | 12 | // ---------------------------------------------------------------------------- 13 | Breakpoint::~Breakpoint() 14 | { 15 | this->disable(); 16 | CloseHandle(m_hThread); 17 | } 18 | 19 | // ---------------------------------------------------------------------------- 20 | bool Breakpoint::set(void* addr, UCHAR type) 21 | { 22 | m_pAddr = addr; 23 | m_nType = type; 24 | 25 | if (this->enabled()) 26 | { 27 | // update existing breakpoint 28 | return this->enable(); 29 | } 30 | 31 | return true; 32 | } 33 | 34 | // ---------------------------------------------------------------------------- 35 | bool Breakpoint::enable() 36 | { 37 | BOOL ok = false; 38 | 39 | SuspendThread(m_hThread); 40 | 41 | CONTEXT ctx = { 0 }; 42 | ctx.ContextFlags = CONTEXT_DEBUG_REGISTERS; 43 | if (GetThreadContext(m_hThread, &ctx)) 44 | { 45 | ok = true; 46 | auto index = -1; 47 | 48 | if (this->enabled()) index = m_nIndex; 49 | else if (!(ctx.Dr7 & 0x01)) index = 0; 50 | else if (!(ctx.Dr7 & 0x04)) index = 1; 51 | else if (!(ctx.Dr7 & 0x10)) index = 2; 52 | else if (!(ctx.Dr7 & 0x40)) index = 3; 53 | 54 | switch (index) 55 | { 56 | default: 57 | ok = false; 58 | break; 59 | 60 | case 0: 61 | ctx.Dr0 = (DWORD64)m_pAddr; 62 | ctx.Dr7 &= 0xFFF0FFFC; 63 | ctx.Dr7 |= (m_nType << 16) | 0x01; 64 | break; 65 | 66 | case 1: 67 | ctx.Dr1 = (DWORD64)m_pAddr; 68 | ctx.Dr7 &= 0xFF0FFFF3; 69 | ctx.Dr7 |= (m_nType << 20) | 0x04; 70 | break; 71 | 72 | case 2: 73 | ctx.Dr2 = (DWORD64)m_pAddr; 74 | ctx.Dr7 &= 0xF0FFFFCF; 75 | ctx.Dr7 |= (m_nType << 24) | 0x10; 76 | break; 77 | 78 | case 3: 79 | ctx.Dr3 = (DWORD64)m_pAddr; 80 | ctx.Dr7 &= 0x0FFFFF3F; 81 | ctx.Dr7 |= (m_nType << 28) | 0x40; 82 | break; 83 | } 84 | 85 | ctx.Dr6 = 0; 86 | if (ok &= SetThreadContext(m_hThread, &ctx)) 87 | { 88 | m_nIndex = index; 89 | } 90 | } 91 | 92 | ResumeThread(m_hThread); 93 | 94 | return ok; 95 | } 96 | 97 | // ---------------------------------------------------------------------------- 98 | bool Breakpoint::disable() 99 | { 100 | BOOL ok = false; 101 | 102 | SuspendThread(m_hThread); 103 | 104 | CONTEXT ctx = { 0 }; 105 | ctx.ContextFlags = CONTEXT_DEBUG_REGISTERS; 106 | if (GetThreadContext(m_hThread, &ctx)) 107 | { 108 | ok = true; 109 | 110 | switch (m_nIndex) 111 | { 112 | default: 113 | ok = false; 114 | break; 115 | 116 | case 0: 117 | ctx.Dr7 &= 0xFFF0FFFC; 118 | break; 119 | 120 | case 1: 121 | ctx.Dr7 &= 0xFF0FFFF3; 122 | break; 123 | 124 | case 2: 125 | ctx.Dr7 &= 0xF0FFFFCF; 126 | break; 127 | 128 | case 3: 129 | ctx.Dr7 &= 0x0FFFFF3F; 130 | break; 131 | } 132 | 133 | ctx.Dr6 = 0; 134 | if (ok &= SetThreadContext(m_hThread, &ctx)) 135 | { 136 | m_nIndex = -1; 137 | } 138 | } 139 | 140 | ResumeThread(m_hThread); 141 | 142 | return ok; 143 | } 144 | -------------------------------------------------------------------------------- /Breakpoint.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | 5 | class Breakpoint 6 | { 7 | public: 8 | enum Type 9 | { 10 | Exec = 0x0, 11 | Write = 0x1, 12 | ReadWrite = 0x3, 13 | 14 | Size1 = 0x0, 15 | Size2 = 0x4, 16 | Size4 = 0xC, 17 | Size8 = 0x8, 18 | 19 | AccessMask = 0x3, 20 | SizeMask = 0xC 21 | }; 22 | 23 | Breakpoint(DWORD tid, void* addr, UCHAR type); 24 | ~Breakpoint(); 25 | 26 | bool set(void* addr, UCHAR type); 27 | bool enable(); 28 | bool disable(); 29 | 30 | bool enabled() const { return m_nIndex >= 0 && m_nIndex < 4; } 31 | void* addr() const { return m_pAddr; } 32 | UCHAR type() const { return m_nType; } 33 | UCHAR access() const { return m_nType & AccessMask; } 34 | UCHAR size() const { return m_nType & SizeMask; } 35 | HANDLE thread() const { return m_hThread; } 36 | 37 | private: 38 | HANDLE m_hThread; 39 | void* m_pAddr; 40 | UCHAR m_nType; 41 | CHAR m_nIndex; 42 | }; 43 | -------------------------------------------------------------------------------- /CHANGES.txt: -------------------------------------------------------------------------------- 1 | v0.2.0 [2021-05-07] 2 | - Improved support for Steam games attempting to re-launch themselves through the Steam client 3 | (must actually have Steam open and logged in) 4 | - Added detection of older unencrypted pak format 5 | - Slightly cleaner error handling in the event that DLL injection on the target process fails 6 | 7 | v0.1.0 [2021-05-03] 8 | - Initial release 9 | -------------------------------------------------------------------------------- /COPYING.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2021 Devin Acker 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in 11 | all copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 | THE SOFTWARE. -------------------------------------------------------------------------------- /DebugLoop.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #include "Breakpoint.h" 6 | #include "DebugLoop.h" 7 | #include "common.h" 8 | 9 | extern "C" 10 | { 11 | #include "aes.h" 12 | } 13 | 14 | #define PID_DEBUG(fmt, pid, ...) printf("[%5d] " fmt, pid, __VA_ARGS__) 15 | 16 | static union 17 | { 18 | WCHAR g_pathw[1024]; 19 | CHAR g_path[1024]; 20 | }; 21 | 22 | struct FoundKey 23 | { 24 | std::wstring fileName; 25 | UCHAR key[AES_KEYLEN]; 26 | }; 27 | 28 | static std::vector g_foundKeys; 29 | static std::vector g_namedPipes; 30 | 31 | static PipeMessage g_indexData; 32 | static bool g_running; 33 | 34 | // ---------------------------------------------------------------------------- 35 | static void HandleNewProcess(DWORD pid, LPCWSTR filePath) 36 | { 37 | bool ok = false; 38 | HANDLE hFile = INVALID_HANDLE_VALUE; 39 | HANDLE hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid); 40 | 41 | snprintf(g_path, sizeof(g_path), PIPE_NAME, pid); 42 | HANDLE hPipe = CreateNamedPipeA(g_path, PIPE_ACCESS_INBOUND | FILE_FLAG_FIRST_PIPE_INSTANCE, 43 | PIPE_TYPE_MESSAGE | PIPE_READMODE_MESSAGE | PIPE_NOWAIT, 1, 44 | 0, sizeof(PipeMessage), 0, NULL); 45 | if (hPipe == INVALID_HANDLE_VALUE) 46 | { 47 | PID_DEBUG("couldn't open named pipe (error 0x%x)\n", pid, GetLastError()); 48 | } 49 | else 50 | { 51 | g_namedPipes.push_back(hPipe); 52 | 53 | PID_DEBUG("Starting %ws\n", pid, filePath); 54 | 55 | GetCurrentDirectoryW(MAX_PATH, g_pathw); 56 | std::wstring currentDir(g_pathw); 57 | 58 | GetModuleFileNameW(NULL, g_pathw, MAX_PATH); 59 | wcsrchr(g_pathw, L'\\')[1] = 0; 60 | SetCurrentDirectoryW(g_pathw); 61 | 62 | WIN32_FIND_DATAW findData = { 0 }; 63 | hFile = FindFirstFileW(L".\\UnrealKey64.dll", &findData); 64 | wcscat_s(g_pathw, findData.cFileName); 65 | 66 | SetCurrentDirectoryW(currentDir.c_str()); 67 | } 68 | 69 | if (hFile != INVALID_HANDLE_VALUE) 70 | { 71 | // got DLL path, load it in the remote process 72 | 73 | LPVOID procMem = VirtualAllocEx(hProcess, NULL, sizeof(g_pathw), MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE); 74 | if (WriteProcessMemory(hProcess, procMem, g_pathw, sizeof(g_pathw), NULL)) 75 | { 76 | HANDLE hThread = CreateRemoteThread(hProcess, NULL, 0, 77 | (LPTHREAD_START_ROUTINE)GetProcAddress(GetModuleHandleA("kernel32"), "LoadLibraryW"), 78 | procMem, 0, NULL); 79 | 80 | if (hThread) 81 | { 82 | WaitForSingleObject(hThread, INFINITE); 83 | 84 | DWORD exitCode; 85 | if (GetExitCodeThread(hThread, &exitCode) && exitCode) 86 | { 87 | ok = true; 88 | } 89 | else 90 | { 91 | PID_DEBUG("Remote thread init error\n", pid); 92 | } 93 | 94 | CloseHandle(hThread); 95 | } 96 | else 97 | { 98 | PID_DEBUG("Couldn't start remote thread (error 0x%x)\n", pid, GetLastError()); 99 | } 100 | } 101 | else 102 | { 103 | PID_DEBUG("Couldn't write to process memory (error 0x%x)\n", pid, GetLastError()); 104 | } 105 | 106 | FindClose(hFile); 107 | } 108 | else 109 | { 110 | PID_DEBUG("Couldn't find UnrealKey64.dll\n", pid); 111 | } 112 | 113 | if (!ok) 114 | { 115 | // can't do anything useful here, just leave 116 | TerminateProcess(hProcess, 1); 117 | } 118 | 119 | CloseHandle(hProcess); 120 | } 121 | 122 | // ---------------------------------------------------------------------------- 123 | static void DebugOutputEvent(const DEBUG_EVENT& event) 124 | { 125 | WORD len = min(sizeof(g_pathw), event.u.DebugString.nDebugStringLength); 126 | HANDLE hProcess = OpenProcess(PROCESS_VM_READ, FALSE, event.dwProcessId); 127 | 128 | memset(g_pathw, 0, sizeof(g_pathw)); 129 | if (ReadProcessMemory(hProcess, event.u.DebugString.lpDebugStringData, g_pathw, event.u.DebugString.nDebugStringLength, NULL)) 130 | { 131 | if (event.u.DebugString.fUnicode) 132 | { 133 | PID_DEBUG("%ws", event.dwProcessId, g_pathw); 134 | } 135 | else 136 | { 137 | PID_DEBUG("%s", event.dwProcessId, g_path); 138 | } 139 | } 140 | 141 | CloseHandle(hProcess); 142 | } 143 | 144 | // ---------------------------------------------------------------------------- 145 | static void HandleIndexDataMessage(const PipeMessage& message) 146 | { 147 | g_indexData = message; 148 | 149 | // Start debugging the remote process now 150 | if (DebugActiveProcess(message.pid)) 151 | { 152 | // Set a hardware breakpoint on the first byte of index data that we're watching, 153 | // so that when it's copied out of the buffer into the actual index, we can 154 | // find out where the index is, and then put another breakpoint on that later. 155 | g_indexData.msgIndex.breakpoint = new Breakpoint(message.tid, message.msgIndex.indexAddr, Breakpoint::ReadWrite); 156 | } 157 | else 158 | { 159 | PID_DEBUG("Couldn't attach to process (error 0x%x)\n", message.pid, GetLastError()); 160 | } 161 | } 162 | 163 | // ---------------------------------------------------------------------------- 164 | static bool HandleSteamAppIDMessage(const PipeMessage& message) 165 | { 166 | if (GetEnvironmentVariableA("SteamAppID", g_path, sizeof(g_path)) > 0) 167 | { 168 | PID_DEBUG("Already tried to restart with SteamAppID once, aborting...\n", message.pid); 169 | PID_DEBUG("Make sure Steam is actually running.\n", message.pid); 170 | return false; 171 | } 172 | 173 | snprintf(g_path, sizeof(g_path), "%u", message.msgUInt); 174 | 175 | if (SetEnvironmentVariableA("SteamAppID", g_path)) 176 | { 177 | PID_DEBUG("Set SteamAppID successfully, app will restart...\n", message.pid); 178 | return true; 179 | } 180 | 181 | PID_DEBUG("Couldn't set SteamAppID (error 0x%x)\n", message.pid, GetLastError()); 182 | return false; 183 | } 184 | 185 | // ---------------------------------------------------------------------------- 186 | static bool BreakpointEvent(const DEBUG_EVENT& event, bool &detach) 187 | { 188 | if (event.dwProcessId != g_indexData.pid 189 | || event.dwThreadId != g_indexData.tid) 190 | { 191 | return false; 192 | } 193 | 194 | HANDLE hThread = g_indexData.msgIndex.breakpoint->thread(); 195 | CONTEXT ctx = { 0 }; 196 | ctx.ContextFlags = CONTEXT_INTEGER | CONTEXT_CONTROL; // get RIP, RSP, RSI and RDI 197 | 198 | GetThreadContext(hThread, &ctx); 199 | 200 | if (g_indexData.msgIndex.breakpoint->access() == Breakpoint::ReadWrite) 201 | { 202 | // Data should be getting memmove'd out of the buffer into the real index now. 203 | // Check the source/dest registers and make sure we can determine where it's going, 204 | // then put a new breakpoint in the destination somewhere 205 | auto indexAddr = (DWORD64)g_indexData.msgIndex.indexAddr; 206 | 207 | if (ctx.Rsi >= indexAddr 208 | && ctx.Rsi < indexAddr + g_indexData.msgIndex.readBufSize) 209 | { 210 | g_indexData.msgIndex.indexAddr = (void*)(ctx.Rdi - (ctx.Rsi - indexAddr)); 211 | 212 | g_indexData.msgIndex.breakpoint->set((CHAR*)g_indexData.msgIndex.indexAddr + AES_BLOCKLEN - 1, Breakpoint::Write); 213 | 214 | PID_DEBUG("Detected buffer->index copy successfully\n", event.dwProcessId); 215 | } 216 | else 217 | { 218 | PID_DEBUG("Unexpected read out of buffer!\n", event.dwProcessId); 219 | PID_DEBUG("\tRIP=0x%p, RSI=0x%p, RDI=0x%p, buf=%p\n", event.dwProcessId, 220 | (void*)ctx.Rip, (void*)ctx.Rsi, (void*)ctx.Rdi, g_indexData.msgIndex.indexAddr); 221 | } 222 | } 223 | else if (g_indexData.msgIndex.breakpoint->access() == Breakpoint::Write) 224 | { 225 | // One full block of data in the index buffer has been decrypted now. 226 | // We have both the encrypted and decrypted data, and the key should be on the stack 227 | PID_DEBUG("Detected index decryption successfully, finding key now...\n", event.dwProcessId); 228 | 229 | UCHAR decrypted[AES_BLOCKLEN]; 230 | HANDLE hProcess = OpenProcess(PROCESS_VM_READ, FALSE, event.dwProcessId); 231 | if (ReadProcessMemory(hProcess, g_indexData.msgIndex.indexAddr, decrypted, sizeof(decrypted), NULL)) 232 | { 233 | UCHAR encrypted[AES_BLOCKLEN]; 234 | UCHAR possibleKey[AES_KEYLEN]; 235 | AES_ctx aes; 236 | 237 | // start crawling the stack and see if we find anything good 238 | bool foundKey = false; 239 | for (auto sp = ctx.Rsp; !foundKey && sp < ctx.Rsp + 0x200; sp += sizeof(void*)) 240 | { 241 | memcpy(encrypted, g_indexData.msgIndex.indexData, AES_BLOCKLEN); 242 | ReadProcessMemory(hProcess, (void*)sp, possibleKey, AES_KEYLEN, NULL); 243 | 244 | AES_init_ctx(&aes, possibleKey); 245 | AES_ECB_decrypt(&aes, encrypted); 246 | if (!memcmp(encrypted, decrypted, AES_BLOCKLEN)) 247 | { 248 | PID_DEBUG("Key: 0x", event.dwProcessId); 249 | for (int i = 0; i < AES_KEYLEN; i++) 250 | { 251 | printf("%02X", possibleKey[i]); 252 | } 253 | printf("\n"); 254 | 255 | foundKey = true; 256 | 257 | auto &key = *g_foundKeys.insert(g_foundKeys.end(), FoundKey()); 258 | key.fileName = g_indexData.msgIndex.filePath; 259 | memcpy(key.key, possibleKey, AES_KEYLEN); 260 | } 261 | } 262 | if (!foundKey) 263 | { 264 | PID_DEBUG("Couldn't find a valid key.\n", event.dwProcessId); 265 | } 266 | } 267 | else 268 | { 269 | PID_DEBUG("Reading process memory at %p failed!\n", event.dwProcessId, g_indexData.msgIndex.indexAddr); 270 | } 271 | CloseHandle(hProcess); 272 | 273 | // we're done, no more breakpoints 274 | delete g_indexData.msgIndex.breakpoint; 275 | g_indexData.msgIndex.breakpoint = NULL; 276 | g_indexData.pid = g_indexData.tid = 0; 277 | 278 | detach = true; 279 | } 280 | else 281 | { 282 | // ??? 283 | return false; 284 | } 285 | 286 | return true; 287 | } 288 | 289 | // ---------------------------------------------------------------------------- 290 | static BOOL WINAPI CtrlHandler(DWORD type) 291 | { 292 | if (type == CTRL_C_EVENT) 293 | { 294 | printf("Ctrl-C received, stopping...\n"); 295 | g_running = false; 296 | return TRUE; 297 | } 298 | 299 | return FALSE; 300 | } 301 | 302 | // ---------------------------------------------------------------------------- 303 | static bool StartProcess(LPCWSTR appPath, HANDLE hJob, PROCESS_INFORMATION& pi) 304 | { 305 | STARTUPINFO si = { 0 }; 306 | si.cb = sizeof(si); 307 | 308 | if (!CreateProcessW(appPath, NULL, NULL, NULL, FALSE, 309 | CREATE_SUSPENDED | CREATE_BREAKAWAY_FROM_JOB, NULL, NULL, &si, &pi)) 310 | { 311 | printf("couldn't launch %ws (error 0x%x)\n", appPath, GetLastError()); 312 | return false; 313 | } 314 | 315 | HandleNewProcess(pi.dwProcessId, appPath); 316 | AssignProcessToJobObject(hJob, pi.hProcess); 317 | ResumeThread(pi.hThread); 318 | CloseHandle(pi.hThread); 319 | 320 | return true; 321 | } 322 | 323 | // ---------------------------------------------------------------------------- 324 | int DebugLoop(LPCWSTR appPath) 325 | { 326 | JOBOBJECT_EXTENDED_LIMIT_INFORMATION jobInfo = { 0 }; 327 | HANDLE hJob = CreateJobObjectW(NULL, NULL); 328 | jobInfo.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE; 329 | SetInformationJobObject(hJob, JobObjectExtendedLimitInformation, &jobInfo, sizeof(jobInfo)); 330 | 331 | PROCESS_INFORMATION pi = { 0 }; 332 | 333 | printf("Starting the game now.\nClose the game or press Ctrl-C to stop.\n\n"); 334 | 335 | if (!StartProcess(appPath, hJob, pi)) 336 | return 1; 337 | 338 | g_running = true; 339 | int rc = 0; 340 | bool restart = false; 341 | DEBUG_EVENT event; 342 | PipeMessage message; 343 | DWORD dwTemp; 344 | 345 | SetConsoleCtrlHandler(CtrlHandler, TRUE); 346 | 347 | while (g_running) 348 | { 349 | if (GetExitCodeProcess(pi.hProcess, &dwTemp) 350 | && dwTemp != STILL_ACTIVE) 351 | { 352 | PID_DEBUG("process exited with code 0x%x\n", pi.dwProcessId, dwTemp); 353 | 354 | // if we want to try to restart with a Steam App ID set (or something), do that now 355 | if (restart) 356 | { 357 | restart = false; 358 | 359 | if (StartProcess(appPath, hJob, pi)) 360 | continue; 361 | else 362 | rc = 1; 363 | } 364 | 365 | g_running = false; 366 | break; 367 | } 368 | 369 | for (int i = 0; i < g_namedPipes.size(); i++) 370 | { 371 | if (ReadFile(g_namedPipes[i], &message, sizeof(message), &dwTemp, NULL)) 372 | { 373 | switch (message.msgType) 374 | { 375 | case StringMessage: 376 | PID_DEBUG("%ws\n", message.pid, message.msgString); 377 | break; 378 | 379 | case NewProcessMessage: 380 | HandleNewProcess(message.msgProcess.pid, message.msgProcess.filePath); 381 | break; 382 | 383 | case IndexDataMessage: 384 | HandleIndexDataMessage(message); 385 | break; 386 | 387 | case SteamAppIDMessage: 388 | restart = HandleSteamAppIDMessage(message); 389 | break; 390 | } 391 | 392 | HANDLE hThread = OpenThread(THREAD_SUSPEND_RESUME, FALSE, message.tid); 393 | ResumeThread(hThread); 394 | CloseHandle(hThread); 395 | } 396 | else if (GetLastError() == ERROR_BROKEN_PIPE) 397 | { 398 | CloseHandle(g_namedPipes[i]); 399 | g_namedPipes[i] = g_namedPipes.back(); 400 | g_namedPipes.pop_back(); 401 | i--; 402 | } 403 | } 404 | while (WaitForDebugEvent(&event, 50)) 405 | { 406 | bool handled = false; 407 | bool detach = false; 408 | 409 | switch (event.dwDebugEventCode) 410 | { 411 | case CREATE_PROCESS_DEBUG_EVENT: 412 | handled = true; 413 | CloseHandle(event.u.CreateProcessInfo.hFile); 414 | break; 415 | 416 | case LOAD_DLL_DEBUG_EVENT: 417 | handled = true; 418 | CloseHandle(event.u.LoadDll.hFile); 419 | break; 420 | 421 | #ifdef HANDLE_DEBUG_OUT 422 | case OUTPUT_DEBUG_STRING_EVENT: 423 | handled = true; 424 | DebugOutputEvent(event); 425 | break; 426 | #endif 427 | 428 | case EXCEPTION_DEBUG_EVENT: 429 | switch (event.u.Exception.ExceptionRecord.ExceptionCode) 430 | { 431 | case EXCEPTION_BREAKPOINT: 432 | case 0x406d1388: // thread rename notification 433 | handled = true; 434 | break; 435 | 436 | case EXCEPTION_SINGLE_STEP: 437 | handled = BreakpointEvent(event, detach); 438 | default: 439 | break; 440 | } 441 | break; 442 | 443 | case EXIT_PROCESS_DEBUG_EVENT: 444 | handled = true; 445 | PID_DEBUG("process exited with code 0x%x\n", event.dwProcessId, event.u.ExitProcess.dwExitCode); 446 | break; 447 | 448 | default: 449 | break; 450 | } 451 | 452 | ContinueDebugEvent(event.dwProcessId, event.dwThreadId, handled ? DBG_CONTINUE : DBG_EXCEPTION_NOT_HANDLED); 453 | 454 | if (detach) 455 | DebugActiveProcessStop(event.dwProcessId); 456 | } 457 | } 458 | 459 | // Clean up and show any keys that were found 460 | CloseHandle(pi.hProcess); 461 | CloseHandle(hJob); 462 | 463 | printf("\nSummary:\n--------\n\n"); 464 | 465 | if (g_foundKeys.empty()) 466 | { 467 | printf("No valid keys were found.\n"); 468 | } 469 | else for (auto &key : g_foundKeys) 470 | { 471 | printf("File: %ws\n", key.fileName.c_str()); 472 | printf("Key: 0x"); 473 | for (int i = 0; i < AES_KEYLEN; i++) 474 | { 475 | printf("%02X", key.key[i]); 476 | } 477 | printf("\n\n"); 478 | } 479 | 480 | return rc; 481 | } 482 | -------------------------------------------------------------------------------- /DebugLoop.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | 5 | int DebugLoop(LPCWSTR appPath); 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # UnrealKey 2 | 3 | UnrealKey is a tool for automatically finding the AES-256 decryption keys for Unreal Engine 4 encrypted pak files. 4 | 5 | Pass the path to a game's executable as an argument to UnrealKey.exe, and it will launch the game and attempt to detect the loading and decryption of encrypted pak files. If successful, the decryption key(s) will appear in the output, usually within a few seconds of launching the game. 6 | 7 | __This project is a proof of concept and is not being actively developed or maintained.__ 8 | 9 | ### Example output 10 | 11 | ``` 12 | [11976] starting TetrisEffect.exe 13 | [ 9604] starting "C:\Program Files\Epic Games\TetrisEffect\TetrisEffect/Binaries/Win64/TetrisEffect-Win64-Shipping.exe" TetrisEffect 14 | [ 9604] Reading pak info for \\?\C:\Program Files\Epic Games\TetrisEffect\TetrisEffect\Content\Paks\TetrisEffect-WindowsNoEditor.pak (encrypted) 15 | [ 9604] Reading encrypted pak index for TetrisEffect-WindowsNoEditor.pak 16 | [ 9604] Detected buffer->index copy successfully 17 | [ 9604] Detected index decryption successfully, finding key now... 18 | [ 9604] Key: 0x0635D5F4B20E2CF1708524223DB7F1C77E7C49C556C5B875A90132E88E91F734 19 | [11976] process exited with code 0x0 20 | 21 | Summary: 22 | -------- 23 | 24 | File: \\?\C:\Program Files\Epic Games\TetrisEffect\TetrisEffect\Content\Paks\TetrisEffect-WindowsNoEditor.pak 25 | Key: 0x0635D5F4B20E2CF1708524223DB7F1C77E7C49C556C5B875A90132E88E91F734 26 | ``` 27 | 28 | ### Limitations 29 | 30 | Currently, only 64-bit Windows games are supported. 31 | 32 | Games using Steam DRM should work (_without_ needing to manually create a `steam_appid.txt` file), as long as the Steam client is open and logged in (and the game is actually in your library). If you're having trouble with a particular game, try running it through Steamless first. 33 | 34 | Games using anti-cheat software will most likely _not_ work, since this tool doesn't make any attempt to circumvent it. 35 | 36 | ### License 37 | 38 | UnrealKey uses code from [minhook](https://github.com/TsudaKageyu/minhook) (2-clause BSD license) and [tiny-AES-c](https://github.com/kokke/tiny-AES-c) (public domain). 39 | 40 | All other code is released under the MIT license. See COPYING.txt for details. 41 | -------------------------------------------------------------------------------- /UnrealKey.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.28307.960 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "UnrealKey", "UnrealKey.vcxproj", "{B132E444-012E-4486-BAAE-47696B7A269A}" 7 | ProjectSection(ProjectDependencies) = postProject 8 | {FB36F250-1187-43EC-925D-6C39C4309E13} = {FB36F250-1187-43EC-925D-6C39C4309E13} 9 | EndProjectSection 10 | EndProject 11 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "UnrealKeyDLL", "UnrealKeyDLL.vcxproj", "{FB36F250-1187-43EC-925D-6C39C4309E13}" 12 | ProjectSection(ProjectDependencies) = postProject 13 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE} = {F142A341-5EE0-442D-A15F-98AE9B48DBAE} 14 | EndProjectSection 15 | EndProject 16 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libMinHook", "minhook\build\VC15\libMinHook.vcxproj", "{F142A341-5EE0-442D-A15F-98AE9B48DBAE}" 17 | EndProject 18 | Global 19 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 20 | Debug|x64 = Debug|x64 21 | Debug|x86 = Debug|x86 22 | Release|x64 = Release|x64 23 | Release|x86 = Release|x86 24 | EndGlobalSection 25 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 26 | {B132E444-012E-4486-BAAE-47696B7A269A}.Debug|x64.ActiveCfg = Debug|x64 27 | {B132E444-012E-4486-BAAE-47696B7A269A}.Debug|x64.Build.0 = Debug|x64 28 | {B132E444-012E-4486-BAAE-47696B7A269A}.Debug|x86.ActiveCfg = Debug|Win32 29 | {B132E444-012E-4486-BAAE-47696B7A269A}.Debug|x86.Build.0 = Debug|Win32 30 | {B132E444-012E-4486-BAAE-47696B7A269A}.Release|x64.ActiveCfg = Release|x64 31 | {B132E444-012E-4486-BAAE-47696B7A269A}.Release|x64.Build.0 = Release|x64 32 | {B132E444-012E-4486-BAAE-47696B7A269A}.Release|x86.ActiveCfg = Release|Win32 33 | {B132E444-012E-4486-BAAE-47696B7A269A}.Release|x86.Build.0 = Release|Win32 34 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Debug|x64.ActiveCfg = Debug|x64 35 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Debug|x64.Build.0 = Debug|x64 36 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Debug|x86.ActiveCfg = Debug|Win32 37 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Debug|x86.Build.0 = Debug|Win32 38 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Release|x64.ActiveCfg = Release|x64 39 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Release|x64.Build.0 = Release|x64 40 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Release|x86.ActiveCfg = Release|Win32 41 | {FB36F250-1187-43EC-925D-6C39C4309E13}.Release|x86.Build.0 = Release|Win32 42 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Debug|x64.ActiveCfg = Debug|x64 43 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Debug|x64.Build.0 = Debug|x64 44 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Debug|x86.ActiveCfg = Debug|Win32 45 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Debug|x86.Build.0 = Debug|Win32 46 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Release|x64.ActiveCfg = Release|x64 47 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Release|x64.Build.0 = Release|x64 48 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Release|x86.ActiveCfg = Release|Win32 49 | {F142A341-5EE0-442D-A15F-98AE9B48DBAE}.Release|x86.Build.0 = Release|Win32 50 | EndGlobalSection 51 | GlobalSection(SolutionProperties) = preSolution 52 | HideSolutionNode = FALSE 53 | EndGlobalSection 54 | GlobalSection(ExtensibilityGlobals) = postSolution 55 | SolutionGuid = {D27210AE-CB35-4A05-AA01-3670B79E9521} 56 | EndGlobalSection 57 | EndGlobal 58 | -------------------------------------------------------------------------------- /UnrealKey.vcxproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | Win32 7 | 8 | 9 | Release 10 | Win32 11 | 12 | 13 | Debug 14 | x64 15 | 16 | 17 | Release 18 | x64 19 | 20 | 21 | 22 | 15.0 23 | {B132E444-012E-4486-BAAE-47696B7A269A} 24 | Win32Proj 25 | UnrealKey 26 | 10.0.17763.0 27 | UnrealKey 28 | 29 | 30 | 31 | Application 32 | true 33 | v141 34 | Unicode 35 | 36 | 37 | Application 38 | false 39 | v141 40 | true 41 | Unicode 42 | 43 | 44 | Application 45 | true 46 | v141 47 | Unicode 48 | 49 | 50 | Application 51 | false 52 | v141 53 | true 54 | Unicode 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | true 76 | 77 | 78 | true 79 | 80 | 81 | false 82 | 83 | 84 | false 85 | 86 | 87 | 88 | 89 | 90 | Level3 91 | Disabled 92 | true 93 | WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions) 94 | true 95 | 96 | 97 | Console 98 | true 99 | 100 | 101 | 102 | 103 | 104 | 105 | Level3 106 | Disabled 107 | true 108 | _DEBUG;_CONSOLE;%(PreprocessorDefinitions) 109 | true 110 | 111 | 112 | Console 113 | true 114 | 115 | 116 | 117 | 118 | 119 | 120 | Level3 121 | MaxSpeed 122 | true 123 | true 124 | true 125 | WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions) 126 | true 127 | 128 | 129 | Console 130 | true 131 | true 132 | true 133 | 134 | 135 | 136 | 137 | 138 | 139 | Level3 140 | MaxSpeed 141 | true 142 | true 143 | true 144 | NDEBUG;_CONSOLE;%(PreprocessorDefinitions) 145 | true 146 | MultiThreadedDLL 147 | Sync 148 | 149 | 150 | Console 151 | true 152 | true 153 | true 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | -------------------------------------------------------------------------------- /UnrealKey.vcxproj.filters: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | {4FC737F1-C7A5-4376-A066-2A32D752A2FF} 6 | cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx 7 | 8 | 9 | {93995380-89BD-4b04-88EB-625FBE52EBFB} 10 | h;hh;hpp;hxx;hm;inl;inc;ipp;xsd 11 | 12 | 13 | {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} 14 | rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms 15 | 16 | 17 | 18 | 19 | Source Files 20 | 21 | 22 | Source Files 23 | 24 | 25 | Source Files 26 | 27 | 28 | Source Files 29 | 30 | 31 | 32 | 33 | Header Files 34 | 35 | 36 | Header Files 37 | 38 | 39 | Header Files 40 | 41 | 42 | Header Files 43 | 44 | 45 | -------------------------------------------------------------------------------- /UnrealKeyDLL.vcxproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | Win32 7 | 8 | 9 | Release 10 | Win32 11 | 12 | 13 | Debug 14 | x64 15 | 16 | 17 | Release 18 | x64 19 | 20 | 21 | 22 | 15.0 23 | {FB36F250-1187-43EC-925D-6C39C4309E13} 24 | Win32Proj 25 | UnrealKeyDLL 26 | 10.0.17763.0 27 | UnrealKeyDLL 28 | 29 | 30 | 31 | DynamicLibrary 32 | true 33 | v141 34 | Unicode 35 | 36 | 37 | DynamicLibrary 38 | false 39 | v141 40 | true 41 | Unicode 42 | 43 | 44 | DynamicLibrary 45 | true 46 | v141 47 | Unicode 48 | 49 | 50 | DynamicLibrary 51 | false 52 | v141 53 | true 54 | Unicode 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | true 76 | $(SolutionName)64 77 | 78 | 79 | true 80 | $(SolutionName)32 81 | 82 | 83 | false 84 | $(SolutionName)32 85 | 86 | 87 | false 88 | $(SolutionName)64 89 | 90 | 91 | 92 | NotUsing 93 | Level3 94 | Disabled 95 | true 96 | _DEBUG;_WINDOWS;_USRDLL;%(PreprocessorDefinitions) 97 | true 98 | pch.h 99 | minhook\include\; 100 | 101 | 102 | Windows 103 | true 104 | false 105 | libMinHook.x64.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies) 106 | $(SolutionDir)lib\$(Configuration)\; 107 | 108 | 109 | 110 | 111 | NotUsing 112 | Level3 113 | Disabled 114 | true 115 | WIN32;_DEBUG;_WINDOWS;_USRDLL;%(PreprocessorDefinitions) 116 | true 117 | pch.h 118 | minhook\include\; 119 | 120 | 121 | Windows 122 | true 123 | false 124 | libMinHook.x86.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies) 125 | $(SolutionDir)lib\$(Configuration)\; 126 | 127 | 128 | 129 | 130 | NotUsing 131 | Level3 132 | MaxSpeed 133 | true 134 | true 135 | true 136 | WIN32;NDEBUG;_WINDOWS;_USRDLL;%(PreprocessorDefinitions) 137 | true 138 | pch.h 139 | minhook\include\; 140 | 141 | 142 | Windows 143 | true 144 | true 145 | true 146 | false 147 | libMinHook.x86.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies) 148 | $(SolutionDir)lib\$(Configuration)\; 149 | 150 | 151 | 152 | 153 | NotUsing 154 | Level3 155 | MaxSpeed 156 | true 157 | true 158 | true 159 | NDEBUG;_WINDOWS;_USRDLL;%(PreprocessorDefinitions) 160 | true 161 | pch.h 162 | minhook\include\; 163 | MultiThreadedDLL 164 | Sync 165 | 166 | 167 | Windows 168 | true 169 | true 170 | true 171 | false 172 | libMinHook.x64.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies) 173 | $(SolutionDir)lib\$(Configuration)\; 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | -------------------------------------------------------------------------------- /UnrealKeyDLL.vcxproj.filters: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | {4FC737F1-C7A5-4376-A066-2A32D752A2FF} 6 | cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx 7 | 8 | 9 | {93995380-89BD-4b04-88EB-625FBE52EBFB} 10 | h;hh;hpp;hxx;hm;inl;inc;ipp;xsd 11 | 12 | 13 | {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} 14 | rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms 15 | 16 | 17 | 18 | 19 | Source Files 20 | 21 | 22 | 23 | 24 | Header Files 25 | 26 | 27 | -------------------------------------------------------------------------------- /aes.c: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | This is an implementation of the AES algorithm, specifically ECB, CTR and CBC mode. 4 | Block size can be chosen in aes.h - available choices are AES128, AES192, AES256. 5 | 6 | The implementation is verified against the test vectors in: 7 | National Institute of Standards and Technology Special Publication 800-38A 2001 ED 8 | 9 | ECB-AES128 10 | ---------- 11 | 12 | plain-text: 13 | 6bc1bee22e409f96e93d7e117393172a 14 | ae2d8a571e03ac9c9eb76fac45af8e51 15 | 30c81c46a35ce411e5fbc1191a0a52ef 16 | f69f2445df4f9b17ad2b417be66c3710 17 | 18 | key: 19 | 2b7e151628aed2a6abf7158809cf4f3c 20 | 21 | resulting cipher 22 | 3ad77bb40d7a3660a89ecaf32466ef97 23 | f5d3d58503b9699de785895a96fdbaaf 24 | 43b1cd7f598ece23881b00e3ed030688 25 | 7b0c785e27e8ad3f8223207104725dd4 26 | 27 | 28 | NOTE: String length must be evenly divisible by 16byte (str_len % 16 == 0) 29 | You should pad the end of the string with zeros if this is not the case. 30 | For AES192/256 the key size is proportionally larger. 31 | 32 | */ 33 | 34 | 35 | /*****************************************************************************/ 36 | /* Includes: */ 37 | /*****************************************************************************/ 38 | #include // CBC mode, for memset 39 | #include "aes.h" 40 | 41 | /*****************************************************************************/ 42 | /* Defines: */ 43 | /*****************************************************************************/ 44 | // The number of columns comprising a state in AES. This is a constant in AES. Value=4 45 | #define Nb 4 46 | 47 | #if defined(AES256) && (AES256 == 1) 48 | #define Nk 8 49 | #define Nr 14 50 | #elif defined(AES192) && (AES192 == 1) 51 | #define Nk 6 52 | #define Nr 12 53 | #else 54 | #define Nk 4 // The number of 32 bit words in a key. 55 | #define Nr 10 // The number of rounds in AES Cipher. 56 | #endif 57 | 58 | // jcallan@github points out that declaring Multiply as a function 59 | // reduces code size considerably with the Keil ARM compiler. 60 | // See this link for more information: https://github.com/kokke/tiny-AES-C/pull/3 61 | #ifndef MULTIPLY_AS_A_FUNCTION 62 | #define MULTIPLY_AS_A_FUNCTION 0 63 | #endif 64 | 65 | 66 | 67 | 68 | /*****************************************************************************/ 69 | /* Private variables: */ 70 | /*****************************************************************************/ 71 | // state - array holding the intermediate results during decryption. 72 | typedef uint8_t state_t[4][4]; 73 | 74 | 75 | 76 | // The lookup-tables are marked const so they can be placed in read-only storage instead of RAM 77 | // The numbers below can be computed dynamically trading ROM for RAM - 78 | // This can be useful in (embedded) bootloader applications, where ROM is often limited. 79 | static const uint8_t sbox[256] = { 80 | //0 1 2 3 4 5 6 7 8 9 A B C D E F 81 | 0x63, 0x7c, 0x77, 0x7b, 0xf2, 0x6b, 0x6f, 0xc5, 0x30, 0x01, 0x67, 0x2b, 0xfe, 0xd7, 0xab, 0x76, 82 | 0xca, 0x82, 0xc9, 0x7d, 0xfa, 0x59, 0x47, 0xf0, 0xad, 0xd4, 0xa2, 0xaf, 0x9c, 0xa4, 0x72, 0xc0, 83 | 0xb7, 0xfd, 0x93, 0x26, 0x36, 0x3f, 0xf7, 0xcc, 0x34, 0xa5, 0xe5, 0xf1, 0x71, 0xd8, 0x31, 0x15, 84 | 0x04, 0xc7, 0x23, 0xc3, 0x18, 0x96, 0x05, 0x9a, 0x07, 0x12, 0x80, 0xe2, 0xeb, 0x27, 0xb2, 0x75, 85 | 0x09, 0x83, 0x2c, 0x1a, 0x1b, 0x6e, 0x5a, 0xa0, 0x52, 0x3b, 0xd6, 0xb3, 0x29, 0xe3, 0x2f, 0x84, 86 | 0x53, 0xd1, 0x00, 0xed, 0x20, 0xfc, 0xb1, 0x5b, 0x6a, 0xcb, 0xbe, 0x39, 0x4a, 0x4c, 0x58, 0xcf, 87 | 0xd0, 0xef, 0xaa, 0xfb, 0x43, 0x4d, 0x33, 0x85, 0x45, 0xf9, 0x02, 0x7f, 0x50, 0x3c, 0x9f, 0xa8, 88 | 0x51, 0xa3, 0x40, 0x8f, 0x92, 0x9d, 0x38, 0xf5, 0xbc, 0xb6, 0xda, 0x21, 0x10, 0xff, 0xf3, 0xd2, 89 | 0xcd, 0x0c, 0x13, 0xec, 0x5f, 0x97, 0x44, 0x17, 0xc4, 0xa7, 0x7e, 0x3d, 0x64, 0x5d, 0x19, 0x73, 90 | 0x60, 0x81, 0x4f, 0xdc, 0x22, 0x2a, 0x90, 0x88, 0x46, 0xee, 0xb8, 0x14, 0xde, 0x5e, 0x0b, 0xdb, 91 | 0xe0, 0x32, 0x3a, 0x0a, 0x49, 0x06, 0x24, 0x5c, 0xc2, 0xd3, 0xac, 0x62, 0x91, 0x95, 0xe4, 0x79, 92 | 0xe7, 0xc8, 0x37, 0x6d, 0x8d, 0xd5, 0x4e, 0xa9, 0x6c, 0x56, 0xf4, 0xea, 0x65, 0x7a, 0xae, 0x08, 93 | 0xba, 0x78, 0x25, 0x2e, 0x1c, 0xa6, 0xb4, 0xc6, 0xe8, 0xdd, 0x74, 0x1f, 0x4b, 0xbd, 0x8b, 0x8a, 94 | 0x70, 0x3e, 0xb5, 0x66, 0x48, 0x03, 0xf6, 0x0e, 0x61, 0x35, 0x57, 0xb9, 0x86, 0xc1, 0x1d, 0x9e, 95 | 0xe1, 0xf8, 0x98, 0x11, 0x69, 0xd9, 0x8e, 0x94, 0x9b, 0x1e, 0x87, 0xe9, 0xce, 0x55, 0x28, 0xdf, 96 | 0x8c, 0xa1, 0x89, 0x0d, 0xbf, 0xe6, 0x42, 0x68, 0x41, 0x99, 0x2d, 0x0f, 0xb0, 0x54, 0xbb, 0x16 }; 97 | 98 | #if (defined(CBC) && CBC == 1) || (defined(ECB) && ECB == 1) 99 | static const uint8_t rsbox[256] = { 100 | 0x52, 0x09, 0x6a, 0xd5, 0x30, 0x36, 0xa5, 0x38, 0xbf, 0x40, 0xa3, 0x9e, 0x81, 0xf3, 0xd7, 0xfb, 101 | 0x7c, 0xe3, 0x39, 0x82, 0x9b, 0x2f, 0xff, 0x87, 0x34, 0x8e, 0x43, 0x44, 0xc4, 0xde, 0xe9, 0xcb, 102 | 0x54, 0x7b, 0x94, 0x32, 0xa6, 0xc2, 0x23, 0x3d, 0xee, 0x4c, 0x95, 0x0b, 0x42, 0xfa, 0xc3, 0x4e, 103 | 0x08, 0x2e, 0xa1, 0x66, 0x28, 0xd9, 0x24, 0xb2, 0x76, 0x5b, 0xa2, 0x49, 0x6d, 0x8b, 0xd1, 0x25, 104 | 0x72, 0xf8, 0xf6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xd4, 0xa4, 0x5c, 0xcc, 0x5d, 0x65, 0xb6, 0x92, 105 | 0x6c, 0x70, 0x48, 0x50, 0xfd, 0xed, 0xb9, 0xda, 0x5e, 0x15, 0x46, 0x57, 0xa7, 0x8d, 0x9d, 0x84, 106 | 0x90, 0xd8, 0xab, 0x00, 0x8c, 0xbc, 0xd3, 0x0a, 0xf7, 0xe4, 0x58, 0x05, 0xb8, 0xb3, 0x45, 0x06, 107 | 0xd0, 0x2c, 0x1e, 0x8f, 0xca, 0x3f, 0x0f, 0x02, 0xc1, 0xaf, 0xbd, 0x03, 0x01, 0x13, 0x8a, 0x6b, 108 | 0x3a, 0x91, 0x11, 0x41, 0x4f, 0x67, 0xdc, 0xea, 0x97, 0xf2, 0xcf, 0xce, 0xf0, 0xb4, 0xe6, 0x73, 109 | 0x96, 0xac, 0x74, 0x22, 0xe7, 0xad, 0x35, 0x85, 0xe2, 0xf9, 0x37, 0xe8, 0x1c, 0x75, 0xdf, 0x6e, 110 | 0x47, 0xf1, 0x1a, 0x71, 0x1d, 0x29, 0xc5, 0x89, 0x6f, 0xb7, 0x62, 0x0e, 0xaa, 0x18, 0xbe, 0x1b, 111 | 0xfc, 0x56, 0x3e, 0x4b, 0xc6, 0xd2, 0x79, 0x20, 0x9a, 0xdb, 0xc0, 0xfe, 0x78, 0xcd, 0x5a, 0xf4, 112 | 0x1f, 0xdd, 0xa8, 0x33, 0x88, 0x07, 0xc7, 0x31, 0xb1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xec, 0x5f, 113 | 0x60, 0x51, 0x7f, 0xa9, 0x19, 0xb5, 0x4a, 0x0d, 0x2d, 0xe5, 0x7a, 0x9f, 0x93, 0xc9, 0x9c, 0xef, 114 | 0xa0, 0xe0, 0x3b, 0x4d, 0xae, 0x2a, 0xf5, 0xb0, 0xc8, 0xeb, 0xbb, 0x3c, 0x83, 0x53, 0x99, 0x61, 115 | 0x17, 0x2b, 0x04, 0x7e, 0xba, 0x77, 0xd6, 0x26, 0xe1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0c, 0x7d }; 116 | #endif 117 | 118 | // The round constant word array, Rcon[i], contains the values given by 119 | // x to the power (i-1) being powers of x (x is denoted as {02}) in the field GF(2^8) 120 | static const uint8_t Rcon[11] = { 121 | 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36 }; 122 | 123 | /* 124 | * Jordan Goulder points out in PR #12 (https://github.com/kokke/tiny-AES-C/pull/12), 125 | * that you can remove most of the elements in the Rcon array, because they are unused. 126 | * 127 | * From Wikipedia's article on the Rijndael key schedule @ https://en.wikipedia.org/wiki/Rijndael_key_schedule#Rcon 128 | * 129 | * "Only the first some of these constants are actually used – up to rcon[10] for AES-128 (as 11 round keys are needed), 130 | * up to rcon[8] for AES-192, up to rcon[7] for AES-256. rcon[0] is not used in AES algorithm." 131 | */ 132 | 133 | 134 | /*****************************************************************************/ 135 | /* Private functions: */ 136 | /*****************************************************************************/ 137 | /* 138 | static uint8_t getSBoxValue(uint8_t num) 139 | { 140 | return sbox[num]; 141 | } 142 | */ 143 | #define getSBoxValue(num) (sbox[(num)]) 144 | 145 | // This function produces Nb(Nr+1) round keys. The round keys are used in each round to decrypt the states. 146 | static void KeyExpansion(uint8_t* RoundKey, const uint8_t* Key) 147 | { 148 | unsigned i, j, k; 149 | uint8_t tempa[4]; // Used for the column/row operations 150 | 151 | // The first round key is the key itself. 152 | for (i = 0; i < Nk; ++i) 153 | { 154 | RoundKey[(i * 4) + 0] = Key[(i * 4) + 0]; 155 | RoundKey[(i * 4) + 1] = Key[(i * 4) + 1]; 156 | RoundKey[(i * 4) + 2] = Key[(i * 4) + 2]; 157 | RoundKey[(i * 4) + 3] = Key[(i * 4) + 3]; 158 | } 159 | 160 | // All other round keys are found from the previous round keys. 161 | for (i = Nk; i < Nb * (Nr + 1); ++i) 162 | { 163 | { 164 | k = (i - 1) * 4; 165 | tempa[0]=RoundKey[k + 0]; 166 | tempa[1]=RoundKey[k + 1]; 167 | tempa[2]=RoundKey[k + 2]; 168 | tempa[3]=RoundKey[k + 3]; 169 | 170 | } 171 | 172 | if (i % Nk == 0) 173 | { 174 | // This function shifts the 4 bytes in a word to the left once. 175 | // [a0,a1,a2,a3] becomes [a1,a2,a3,a0] 176 | 177 | // Function RotWord() 178 | { 179 | const uint8_t u8tmp = tempa[0]; 180 | tempa[0] = tempa[1]; 181 | tempa[1] = tempa[2]; 182 | tempa[2] = tempa[3]; 183 | tempa[3] = u8tmp; 184 | } 185 | 186 | // SubWord() is a function that takes a four-byte input word and 187 | // applies the S-box to each of the four bytes to produce an output word. 188 | 189 | // Function Subword() 190 | { 191 | tempa[0] = getSBoxValue(tempa[0]); 192 | tempa[1] = getSBoxValue(tempa[1]); 193 | tempa[2] = getSBoxValue(tempa[2]); 194 | tempa[3] = getSBoxValue(tempa[3]); 195 | } 196 | 197 | tempa[0] = tempa[0] ^ Rcon[i/Nk]; 198 | } 199 | #if defined(AES256) && (AES256 == 1) 200 | if (i % Nk == 4) 201 | { 202 | // Function Subword() 203 | { 204 | tempa[0] = getSBoxValue(tempa[0]); 205 | tempa[1] = getSBoxValue(tempa[1]); 206 | tempa[2] = getSBoxValue(tempa[2]); 207 | tempa[3] = getSBoxValue(tempa[3]); 208 | } 209 | } 210 | #endif 211 | j = i * 4; k=(i - Nk) * 4; 212 | RoundKey[j + 0] = RoundKey[k + 0] ^ tempa[0]; 213 | RoundKey[j + 1] = RoundKey[k + 1] ^ tempa[1]; 214 | RoundKey[j + 2] = RoundKey[k + 2] ^ tempa[2]; 215 | RoundKey[j + 3] = RoundKey[k + 3] ^ tempa[3]; 216 | } 217 | } 218 | 219 | void AES_init_ctx(struct AES_ctx* ctx, const uint8_t* key) 220 | { 221 | KeyExpansion(ctx->RoundKey, key); 222 | } 223 | #if (defined(CBC) && (CBC == 1)) || (defined(CTR) && (CTR == 1)) 224 | void AES_init_ctx_iv(struct AES_ctx* ctx, const uint8_t* key, const uint8_t* iv) 225 | { 226 | KeyExpansion(ctx->RoundKey, key); 227 | memcpy (ctx->Iv, iv, AES_BLOCKLEN); 228 | } 229 | void AES_ctx_set_iv(struct AES_ctx* ctx, const uint8_t* iv) 230 | { 231 | memcpy (ctx->Iv, iv, AES_BLOCKLEN); 232 | } 233 | #endif 234 | 235 | // This function adds the round key to state. 236 | // The round key is added to the state by an XOR function. 237 | static void AddRoundKey(uint8_t round, state_t* state, const uint8_t* RoundKey) 238 | { 239 | uint8_t i,j; 240 | for (i = 0; i < 4; ++i) 241 | { 242 | for (j = 0; j < 4; ++j) 243 | { 244 | (*state)[i][j] ^= RoundKey[(round * Nb * 4) + (i * Nb) + j]; 245 | } 246 | } 247 | } 248 | 249 | // The SubBytes Function Substitutes the values in the 250 | // state matrix with values in an S-box. 251 | static void SubBytes(state_t* state) 252 | { 253 | uint8_t i, j; 254 | for (i = 0; i < 4; ++i) 255 | { 256 | for (j = 0; j < 4; ++j) 257 | { 258 | (*state)[j][i] = getSBoxValue((*state)[j][i]); 259 | } 260 | } 261 | } 262 | 263 | // The ShiftRows() function shifts the rows in the state to the left. 264 | // Each row is shifted with different offset. 265 | // Offset = Row number. So the first row is not shifted. 266 | static void ShiftRows(state_t* state) 267 | { 268 | uint8_t temp; 269 | 270 | // Rotate first row 1 columns to left 271 | temp = (*state)[0][1]; 272 | (*state)[0][1] = (*state)[1][1]; 273 | (*state)[1][1] = (*state)[2][1]; 274 | (*state)[2][1] = (*state)[3][1]; 275 | (*state)[3][1] = temp; 276 | 277 | // Rotate second row 2 columns to left 278 | temp = (*state)[0][2]; 279 | (*state)[0][2] = (*state)[2][2]; 280 | (*state)[2][2] = temp; 281 | 282 | temp = (*state)[1][2]; 283 | (*state)[1][2] = (*state)[3][2]; 284 | (*state)[3][2] = temp; 285 | 286 | // Rotate third row 3 columns to left 287 | temp = (*state)[0][3]; 288 | (*state)[0][3] = (*state)[3][3]; 289 | (*state)[3][3] = (*state)[2][3]; 290 | (*state)[2][3] = (*state)[1][3]; 291 | (*state)[1][3] = temp; 292 | } 293 | 294 | static uint8_t xtime(uint8_t x) 295 | { 296 | return ((x<<1) ^ (((x>>7) & 1) * 0x1b)); 297 | } 298 | 299 | // MixColumns function mixes the columns of the state matrix 300 | static void MixColumns(state_t* state) 301 | { 302 | uint8_t i; 303 | uint8_t Tmp, Tm, t; 304 | for (i = 0; i < 4; ++i) 305 | { 306 | t = (*state)[i][0]; 307 | Tmp = (*state)[i][0] ^ (*state)[i][1] ^ (*state)[i][2] ^ (*state)[i][3] ; 308 | Tm = (*state)[i][0] ^ (*state)[i][1] ; Tm = xtime(Tm); (*state)[i][0] ^= Tm ^ Tmp ; 309 | Tm = (*state)[i][1] ^ (*state)[i][2] ; Tm = xtime(Tm); (*state)[i][1] ^= Tm ^ Tmp ; 310 | Tm = (*state)[i][2] ^ (*state)[i][3] ; Tm = xtime(Tm); (*state)[i][2] ^= Tm ^ Tmp ; 311 | Tm = (*state)[i][3] ^ t ; Tm = xtime(Tm); (*state)[i][3] ^= Tm ^ Tmp ; 312 | } 313 | } 314 | 315 | // Multiply is used to multiply numbers in the field GF(2^8) 316 | // Note: The last call to xtime() is unneeded, but often ends up generating a smaller binary 317 | // The compiler seems to be able to vectorize the operation better this way. 318 | // See https://github.com/kokke/tiny-AES-c/pull/34 319 | #if MULTIPLY_AS_A_FUNCTION 320 | static uint8_t Multiply(uint8_t x, uint8_t y) 321 | { 322 | return (((y & 1) * x) ^ 323 | ((y>>1 & 1) * xtime(x)) ^ 324 | ((y>>2 & 1) * xtime(xtime(x))) ^ 325 | ((y>>3 & 1) * xtime(xtime(xtime(x)))) ^ 326 | ((y>>4 & 1) * xtime(xtime(xtime(xtime(x)))))); /* this last call to xtime() can be omitted */ 327 | } 328 | #else 329 | #define Multiply(x, y) \ 330 | ( ((y & 1) * x) ^ \ 331 | ((y>>1 & 1) * xtime(x)) ^ \ 332 | ((y>>2 & 1) * xtime(xtime(x))) ^ \ 333 | ((y>>3 & 1) * xtime(xtime(xtime(x)))) ^ \ 334 | ((y>>4 & 1) * xtime(xtime(xtime(xtime(x)))))) \ 335 | 336 | #endif 337 | 338 | #if (defined(CBC) && CBC == 1) || (defined(ECB) && ECB == 1) 339 | /* 340 | static uint8_t getSBoxInvert(uint8_t num) 341 | { 342 | return rsbox[num]; 343 | } 344 | */ 345 | #define getSBoxInvert(num) (rsbox[(num)]) 346 | 347 | // MixColumns function mixes the columns of the state matrix. 348 | // The method used to multiply may be difficult to understand for the inexperienced. 349 | // Please use the references to gain more information. 350 | static void InvMixColumns(state_t* state) 351 | { 352 | int i; 353 | uint8_t a, b, c, d; 354 | for (i = 0; i < 4; ++i) 355 | { 356 | a = (*state)[i][0]; 357 | b = (*state)[i][1]; 358 | c = (*state)[i][2]; 359 | d = (*state)[i][3]; 360 | 361 | (*state)[i][0] = Multiply(a, 0x0e) ^ Multiply(b, 0x0b) ^ Multiply(c, 0x0d) ^ Multiply(d, 0x09); 362 | (*state)[i][1] = Multiply(a, 0x09) ^ Multiply(b, 0x0e) ^ Multiply(c, 0x0b) ^ Multiply(d, 0x0d); 363 | (*state)[i][2] = Multiply(a, 0x0d) ^ Multiply(b, 0x09) ^ Multiply(c, 0x0e) ^ Multiply(d, 0x0b); 364 | (*state)[i][3] = Multiply(a, 0x0b) ^ Multiply(b, 0x0d) ^ Multiply(c, 0x09) ^ Multiply(d, 0x0e); 365 | } 366 | } 367 | 368 | 369 | // The SubBytes Function Substitutes the values in the 370 | // state matrix with values in an S-box. 371 | static void InvSubBytes(state_t* state) 372 | { 373 | uint8_t i, j; 374 | for (i = 0; i < 4; ++i) 375 | { 376 | for (j = 0; j < 4; ++j) 377 | { 378 | (*state)[j][i] = getSBoxInvert((*state)[j][i]); 379 | } 380 | } 381 | } 382 | 383 | static void InvShiftRows(state_t* state) 384 | { 385 | uint8_t temp; 386 | 387 | // Rotate first row 1 columns to right 388 | temp = (*state)[3][1]; 389 | (*state)[3][1] = (*state)[2][1]; 390 | (*state)[2][1] = (*state)[1][1]; 391 | (*state)[1][1] = (*state)[0][1]; 392 | (*state)[0][1] = temp; 393 | 394 | // Rotate second row 2 columns to right 395 | temp = (*state)[0][2]; 396 | (*state)[0][2] = (*state)[2][2]; 397 | (*state)[2][2] = temp; 398 | 399 | temp = (*state)[1][2]; 400 | (*state)[1][2] = (*state)[3][2]; 401 | (*state)[3][2] = temp; 402 | 403 | // Rotate third row 3 columns to right 404 | temp = (*state)[0][3]; 405 | (*state)[0][3] = (*state)[1][3]; 406 | (*state)[1][3] = (*state)[2][3]; 407 | (*state)[2][3] = (*state)[3][3]; 408 | (*state)[3][3] = temp; 409 | } 410 | #endif // #if (defined(CBC) && CBC == 1) || (defined(ECB) && ECB == 1) 411 | 412 | // Cipher is the main function that encrypts the PlainText. 413 | static void Cipher(state_t* state, const uint8_t* RoundKey) 414 | { 415 | uint8_t round = 0; 416 | 417 | // Add the First round key to the state before starting the rounds. 418 | AddRoundKey(0, state, RoundKey); 419 | 420 | // There will be Nr rounds. 421 | // The first Nr-1 rounds are identical. 422 | // These Nr rounds are executed in the loop below. 423 | // Last one without MixColumns() 424 | for (round = 1; ; ++round) 425 | { 426 | SubBytes(state); 427 | ShiftRows(state); 428 | if (round == Nr) { 429 | break; 430 | } 431 | MixColumns(state); 432 | AddRoundKey(round, state, RoundKey); 433 | } 434 | // Add round key to last round 435 | AddRoundKey(Nr, state, RoundKey); 436 | } 437 | 438 | #if (defined(CBC) && CBC == 1) || (defined(ECB) && ECB == 1) 439 | static void InvCipher(state_t* state, const uint8_t* RoundKey) 440 | { 441 | uint8_t round = 0; 442 | 443 | // Add the First round key to the state before starting the rounds. 444 | AddRoundKey(Nr, state, RoundKey); 445 | 446 | // There will be Nr rounds. 447 | // The first Nr-1 rounds are identical. 448 | // These Nr rounds are executed in the loop below. 449 | // Last one without InvMixColumn() 450 | for (round = (Nr - 1); ; --round) 451 | { 452 | InvShiftRows(state); 453 | InvSubBytes(state); 454 | AddRoundKey(round, state, RoundKey); 455 | if (round == 0) { 456 | break; 457 | } 458 | InvMixColumns(state); 459 | } 460 | 461 | } 462 | #endif // #if (defined(CBC) && CBC == 1) || (defined(ECB) && ECB == 1) 463 | 464 | /*****************************************************************************/ 465 | /* Public functions: */ 466 | /*****************************************************************************/ 467 | #if defined(ECB) && (ECB == 1) 468 | 469 | 470 | void AES_ECB_encrypt(const struct AES_ctx* ctx, uint8_t* buf) 471 | { 472 | // The next function call encrypts the PlainText with the Key using AES algorithm. 473 | Cipher((state_t*)buf, ctx->RoundKey); 474 | } 475 | 476 | void AES_ECB_decrypt(const struct AES_ctx* ctx, uint8_t* buf) 477 | { 478 | // The next function call decrypts the PlainText with the Key using AES algorithm. 479 | InvCipher((state_t*)buf, ctx->RoundKey); 480 | } 481 | 482 | 483 | #endif // #if defined(ECB) && (ECB == 1) 484 | 485 | 486 | 487 | 488 | 489 | #if defined(CBC) && (CBC == 1) 490 | 491 | 492 | static void XorWithIv(uint8_t* buf, const uint8_t* Iv) 493 | { 494 | uint8_t i; 495 | for (i = 0; i < AES_BLOCKLEN; ++i) // The block in AES is always 128bit no matter the key size 496 | { 497 | buf[i] ^= Iv[i]; 498 | } 499 | } 500 | 501 | void AES_CBC_encrypt_buffer(struct AES_ctx *ctx, uint8_t* buf, size_t length) 502 | { 503 | size_t i; 504 | uint8_t *Iv = ctx->Iv; 505 | for (i = 0; i < length; i += AES_BLOCKLEN) 506 | { 507 | XorWithIv(buf, Iv); 508 | Cipher((state_t*)buf, ctx->RoundKey); 509 | Iv = buf; 510 | buf += AES_BLOCKLEN; 511 | } 512 | /* store Iv in ctx for next call */ 513 | memcpy(ctx->Iv, Iv, AES_BLOCKLEN); 514 | } 515 | 516 | void AES_CBC_decrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length) 517 | { 518 | size_t i; 519 | uint8_t storeNextIv[AES_BLOCKLEN]; 520 | for (i = 0; i < length; i += AES_BLOCKLEN) 521 | { 522 | memcpy(storeNextIv, buf, AES_BLOCKLEN); 523 | InvCipher((state_t*)buf, ctx->RoundKey); 524 | XorWithIv(buf, ctx->Iv); 525 | memcpy(ctx->Iv, storeNextIv, AES_BLOCKLEN); 526 | buf += AES_BLOCKLEN; 527 | } 528 | 529 | } 530 | 531 | #endif // #if defined(CBC) && (CBC == 1) 532 | 533 | 534 | 535 | #if defined(CTR) && (CTR == 1) 536 | 537 | /* Symmetrical operation: same function for encrypting as for decrypting. Note any IV/nonce should never be reused with the same key */ 538 | void AES_CTR_xcrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length) 539 | { 540 | uint8_t buffer[AES_BLOCKLEN]; 541 | 542 | size_t i; 543 | int bi; 544 | for (i = 0, bi = AES_BLOCKLEN; i < length; ++i, ++bi) 545 | { 546 | if (bi == AES_BLOCKLEN) /* we need to regen xor compliment in buffer */ 547 | { 548 | 549 | memcpy(buffer, ctx->Iv, AES_BLOCKLEN); 550 | Cipher((state_t*)buffer,ctx->RoundKey); 551 | 552 | /* Increment Iv and handle overflow */ 553 | for (bi = (AES_BLOCKLEN - 1); bi >= 0; --bi) 554 | { 555 | /* inc will overflow */ 556 | if (ctx->Iv[bi] == 255) 557 | { 558 | ctx->Iv[bi] = 0; 559 | continue; 560 | } 561 | ctx->Iv[bi] += 1; 562 | break; 563 | } 564 | bi = 0; 565 | } 566 | 567 | buf[i] = (buf[i] ^ buffer[bi]); 568 | } 569 | } 570 | 571 | #endif // #if defined(CTR) && (CTR == 1) 572 | 573 | -------------------------------------------------------------------------------- /aes.h: -------------------------------------------------------------------------------- 1 | #ifndef _AES_H_ 2 | #define _AES_H_ 3 | 4 | #include 5 | #include 6 | 7 | // #define the macros below to 1/0 to enable/disable the mode of operation. 8 | // 9 | // CBC enables AES encryption in CBC-mode of operation. 10 | // CTR enables encryption in counter-mode. 11 | // ECB enables the basic ECB 16-byte block algorithm. All can be enabled simultaneously. 12 | 13 | // The #ifndef-guard allows it to be configured before #include'ing or at compile time. 14 | #ifndef CBC 15 | #define CBC 0 16 | #endif 17 | 18 | #ifndef ECB 19 | #define ECB 1 20 | #endif 21 | 22 | #ifndef CTR 23 | #define CTR 0 24 | #endif 25 | 26 | 27 | //#define AES128 1 28 | //#define AES192 1 29 | #define AES256 1 30 | 31 | #define AES_BLOCKLEN 16 // Block length in bytes - AES is 128b block only 32 | 33 | #if defined(AES256) && (AES256 == 1) 34 | #define AES_KEYLEN 32 35 | #define AES_keyExpSize 240 36 | #elif defined(AES192) && (AES192 == 1) 37 | #define AES_KEYLEN 24 38 | #define AES_keyExpSize 208 39 | #else 40 | #define AES_KEYLEN 16 // Key length in bytes 41 | #define AES_keyExpSize 176 42 | #endif 43 | 44 | struct AES_ctx 45 | { 46 | uint8_t RoundKey[AES_keyExpSize]; 47 | #if (defined(CBC) && (CBC == 1)) || (defined(CTR) && (CTR == 1)) 48 | uint8_t Iv[AES_BLOCKLEN]; 49 | #endif 50 | }; 51 | 52 | void AES_init_ctx(struct AES_ctx* ctx, const uint8_t* key); 53 | #if (defined(CBC) && (CBC == 1)) || (defined(CTR) && (CTR == 1)) 54 | void AES_init_ctx_iv(struct AES_ctx* ctx, const uint8_t* key, const uint8_t* iv); 55 | void AES_ctx_set_iv(struct AES_ctx* ctx, const uint8_t* iv); 56 | #endif 57 | 58 | #if defined(ECB) && (ECB == 1) 59 | // buffer size is exactly AES_BLOCKLEN bytes; 60 | // you need only AES_init_ctx as IV is not used in ECB 61 | // NB: ECB is considered insecure for most uses 62 | void AES_ECB_encrypt(const struct AES_ctx* ctx, uint8_t* buf); 63 | void AES_ECB_decrypt(const struct AES_ctx* ctx, uint8_t* buf); 64 | 65 | #endif // #if defined(ECB) && (ECB == !) 66 | 67 | 68 | #if defined(CBC) && (CBC == 1) 69 | // buffer size MUST be mutile of AES_BLOCKLEN; 70 | // Suggest https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS7 for padding scheme 71 | // NOTES: you need to set IV in ctx via AES_init_ctx_iv() or AES_ctx_set_iv() 72 | // no IV should ever be reused with the same key 73 | void AES_CBC_encrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length); 74 | void AES_CBC_decrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length); 75 | 76 | #endif // #if defined(CBC) && (CBC == 1) 77 | 78 | 79 | #if defined(CTR) && (CTR == 1) 80 | 81 | // Same function for encrypting as for decrypting. 82 | // IV is incremented for every block, and used after encryption as XOR-compliment for output 83 | // Suggesting https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS7 for padding scheme 84 | // NOTES: you need to set IV in ctx with AES_init_ctx_iv() or AES_ctx_set_iv() 85 | // no IV should ever be reused with the same key 86 | void AES_CTR_xcrypt_buffer(struct AES_ctx* ctx, uint8_t* buf, size_t length); 87 | 88 | #endif // #if defined(CTR) && (CTR == 1) 89 | 90 | 91 | #endif // _AES_H_ 92 | -------------------------------------------------------------------------------- /common.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #include 3 | #include "Breakpoint.h" 4 | 5 | #define PIPE_NAME "\\\\.\\pipe\\UnrealKey\\%d" 6 | 7 | enum PipeMessageType 8 | { 9 | StringMessage, 10 | NewProcessMessage, 11 | IndexDataMessage, 12 | SteamAppIDMessage, 13 | }; 14 | 15 | struct PipeProcessData 16 | { 17 | WCHAR filePath[MAX_PATH]; 18 | DWORD pid, flags; 19 | }; 20 | 21 | struct PipeIndexData 22 | { 23 | WCHAR filePath[MAX_PATH]; 24 | void *indexAddr; 25 | DWORD readBufSize; 26 | UCHAR indexData[16]; 27 | // only used by exception handler 28 | Breakpoint *breakpoint; 29 | }; 30 | 31 | struct PipeMessage 32 | { 33 | DWORD pid, tid; 34 | WORD msgType; 35 | union 36 | { 37 | WCHAR msgString[1024]; 38 | PipeProcessData msgProcess; 39 | PipeIndexData msgIndex; 40 | UINT msgUInt; 41 | }; 42 | }; 43 | -------------------------------------------------------------------------------- /dllmain.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | #include 7 | 8 | #include "common.h" 9 | 10 | #pragma pack(1) 11 | struct PakHeaderOld // not all of it, just the stuff we need 12 | { 13 | CHAR bEncrypted; 14 | DWORD magic; 15 | DWORD version; 16 | UINT64 indexOffset, indexSize; 17 | }; 18 | 19 | struct PakHeader 20 | { 21 | GUID guid; 22 | PakHeaderOld data; 23 | }; 24 | #pragma pack() 25 | 26 | static const DWORD PakMagic = 0x5a6f12e1; 27 | 28 | // track encrypted index locations that we've found 29 | struct PakIndex 30 | { 31 | HANDLE hFile; 32 | UINT64 indexOffset; 33 | GUID guid; 34 | }; 35 | 36 | std::vector g_pakIndexes; 37 | 38 | static HANDLE g_hPipe; 39 | 40 | // WinAPI function hooks 41 | auto orig_CreateProcessW = CreateProcessW; 42 | auto orig_ShellExecuteA = ShellExecuteA; 43 | auto orig_ShellExecuteW = ShellExecuteW; 44 | auto orig_ReadFile = ReadFile; 45 | NTSTATUS (*orig_ZwSetInformationThread)(HANDLE, ULONG, PVOID, ULONG); 46 | 47 | // ---------------------------------------------------------------------------- 48 | static void SendPipeMessage(PipeMessage& msg) 49 | { 50 | msg.pid = GetCurrentProcessId(); 51 | msg.tid = GetCurrentThreadId(); 52 | 53 | DWORD dummy; 54 | if (WriteFile(g_hPipe, &msg, sizeof(msg), &dummy, NULL)) 55 | { 56 | // wait for launcher to handle message 57 | SuspendThread(GetCurrentThread()); 58 | } 59 | } 60 | 61 | // ---------------------------------------------------------------------------- 62 | static void SendStringMessage(const WCHAR *str, ...) 63 | { 64 | PipeMessage msg; 65 | msg.msgType = StringMessage; 66 | 67 | va_list va; 68 | va_start(va, str); 69 | _vsnwprintf_s(msg.msgString, sizeof(msg.msgString) / sizeof(WCHAR), str, va); 70 | va_end(va); 71 | 72 | SendPipeMessage(msg); 73 | } 74 | 75 | // ---------------------------------------------------------------------------- 76 | static void CheckPakHeader(HANDLE hFile, const PakHeaderOld *header, const GUID *guid = NULL) 77 | { 78 | // found a potential pak header 79 | WCHAR path[MAX_PATH]; 80 | GetFinalPathNameByHandleW(hFile, path, MAX_PATH, 0); 81 | 82 | if (header != NULL && header->bEncrypted) 83 | { 84 | SendStringMessage(L"Reading pak info for %ws (encrypted)", path); 85 | 86 | PakIndex index = { 0 }; 87 | index.hFile = hFile; 88 | index.indexOffset = header->indexOffset; 89 | 90 | if (guid) 91 | { 92 | index.guid = *guid; 93 | StringFromGUID2(*guid, path, MAX_PATH); 94 | SendStringMessage(L"key GUID is %ws", path); 95 | } 96 | 97 | g_pakIndexes.push_back(index); 98 | } 99 | else 100 | { 101 | SendStringMessage(L"Reading pak info for %ws (not encrypted, ignoring)", path); 102 | } 103 | } 104 | 105 | // ---------------------------------------------------------------------------- 106 | static BOOL WINAPI hook_CreateProcessW(LPCWSTR name, LPWSTR cmdLine, LPSECURITY_ATTRIBUTES procAttr, LPSECURITY_ATTRIBUTES threadAttr, 107 | BOOL inherit, DWORD flags, LPVOID env, LPCWSTR dir, LPSTARTUPINFOW si, LPPROCESS_INFORMATION pi) 108 | { 109 | // create suspended version of process, signal it to the launcher 110 | if (orig_CreateProcessW(name, cmdLine, procAttr, threadAttr, inherit, 111 | flags | CREATE_SUSPENDED, env, dir, si, pi)) 112 | { 113 | PipeMessage msg; 114 | msg.msgType = NewProcessMessage; 115 | 116 | if (name) 117 | wcsncpy_s(msg.msgProcess.filePath, name, MAX_PATH); 118 | else 119 | wcsncpy_s(msg.msgProcess.filePath, cmdLine, MAX_PATH); 120 | 121 | msg.msgProcess.pid = pi->dwProcessId; 122 | msg.msgProcess.flags = flags; 123 | SendPipeMessage(msg); 124 | 125 | // if the process wasn't already supposed to be suspended, unsuspend it now 126 | if (!(flags & CREATE_SUSPENDED)) 127 | { 128 | ResumeThread(pi->hThread); 129 | } 130 | 131 | return TRUE; 132 | } 133 | 134 | return FALSE; 135 | } 136 | 137 | // ---------------------------------------------------------------------------- 138 | static void RunWithSteamAppID(UINT appID) 139 | { 140 | SendStringMessage(L"Tried to launch Steam w/ app ID %u", appID); 141 | 142 | PipeMessage msg; 143 | msg.msgType = SteamAppIDMessage; 144 | msg.msgUInt = appID; 145 | SendPipeMessage(msg); 146 | } 147 | 148 | // ---------------------------------------------------------------------------- 149 | static HINSTANCE WINAPI hook_ShellExecuteA(HWND hwnd, LPCSTR lpOperation, LPCSTR lpFile, LPCSTR lpParams, LPCSTR lpDir, INT nShowCmd) 150 | { 151 | UINT appID; 152 | 153 | if (lpOperation && lpFile 154 | && !strcmp(lpOperation, "open") 155 | && sscanf_s(lpFile, "steam://run/%u", &appID) == 1) 156 | { 157 | RunWithSteamAppID(appID); 158 | return 0; 159 | } 160 | 161 | return orig_ShellExecuteA(hwnd, lpOperation, lpFile, lpParams, lpDir, nShowCmd); 162 | } 163 | 164 | // ---------------------------------------------------------------------------- 165 | static HINSTANCE WINAPI hook_ShellExecuteW(HWND hwnd, LPCWSTR lpOperation, LPCWSTR lpFile, LPCWSTR lpParams, LPCWSTR lpDir, INT nShowCmd) 166 | { 167 | UINT appID; 168 | 169 | if (lpFile && lpParams 170 | && wcsstr(lpFile, L"steam.exe") 171 | && swscanf_s(lpParams, L"steam://run/%u", &appID) == 1) 172 | { 173 | RunWithSteamAppID(appID); 174 | return 0; 175 | } 176 | 177 | return orig_ShellExecuteW(hwnd, lpOperation, lpFile, lpParams, lpDir, nShowCmd); 178 | } 179 | 180 | // ---------------------------------------------------------------------------- 181 | static BOOL WINAPI hook_ReadFile(HANDLE hFile, LPVOID lpBuffer, DWORD nSize, LPDWORD lpSize, LPOVERLAPPED lpOverlapped) 182 | { 183 | PakHeader* header = (PakHeader*)lpBuffer; 184 | PakHeaderOld* headerOld = (PakHeaderOld*)lpBuffer; 185 | 186 | BOOL ok = orig_ReadFile(hFile, lpBuffer, nSize, lpSize, lpOverlapped); 187 | 188 | if (!ok && lpOverlapped && GetLastError() == ERROR_IO_PENDING) 189 | { 190 | // wait for read to finish 191 | ok = GetOverlappedResult(hFile, lpOverlapped, lpSize, true); 192 | } 193 | 194 | if (ok) 195 | { 196 | if (*lpSize >= sizeof(PakHeader) && header->data.magic == PakMagic) 197 | { 198 | CheckPakHeader(hFile, &header->data, &header->guid); 199 | } 200 | else if (*lpSize >= sizeof(PakHeaderOld) && headerOld->magic == PakMagic) 201 | { 202 | CheckPakHeader(hFile, headerOld); 203 | } 204 | else if (*lpSize >= sizeof(DWORD) && *(DWORD*)lpBuffer == PakMagic) 205 | { 206 | CheckPakHeader(hFile, NULL); 207 | } 208 | else for (auto &index : g_pakIndexes) 209 | { 210 | // see if we're reading the encrypted index for one of the pak files we found earlier 211 | if (hFile == index.hFile 212 | && lpOverlapped 213 | && (UINT32)lpOverlapped->Offset == (UINT32)index.indexOffset 214 | && (UINT32)lpOverlapped->OffsetHigh == (index.indexOffset >> 32)) 215 | { 216 | PipeMessage msg; 217 | msg.msgType = IndexDataMessage; 218 | 219 | GetFinalPathNameByHandleW(hFile, msg.msgIndex.filePath, MAX_PATH, 0); 220 | msg.msgIndex.indexAddr = lpBuffer; 221 | msg.msgIndex.readBufSize = nSize; 222 | // msg.msgIndex.guid = index.guid; 223 | memcpy(msg.msgIndex.indexData, lpBuffer, sizeof(msg.msgIndex.indexData)); 224 | 225 | // SendStringMessage(L"Reading encrypted pak index to 0x%p for %ws", lpBuffer, msg.msgIndex.filePath); 226 | SendStringMessage(L"Reading encrypted pak index for %ws", wcsrchr(msg.msgIndex.filePath, L'\\') + 1); 227 | // SendStringMessage(L"Buffer size is 0x%x", nSize); 228 | SendPipeMessage(msg); 229 | } 230 | } 231 | } 232 | 233 | return ok; 234 | } 235 | 236 | // ---------------------------------------------------------------------------- 237 | static NTSTATUS hook_ZwSetInformationThread(HANDLE hThread, ULONG infoClass, PVOID info, ULONG infoLength) 238 | { 239 | // ignore ThreadHideFromDebugger 240 | if (infoClass == 0x11) 241 | return TRUE; 242 | 243 | return orig_ZwSetInformationThread(hThread, infoClass, info, infoLength); 244 | } 245 | 246 | // ---------------------------------------------------------------------------- 247 | static BOOL Init() 248 | { 249 | CHAR pipeName[MAX_PATH]; 250 | 251 | snprintf(pipeName, sizeof(pipeName), PIPE_NAME, GetCurrentProcessId()); 252 | g_hPipe = CreateFileA(pipeName, GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, 0); 253 | if (g_hPipe != INVALID_HANDLE_VALUE) 254 | { 255 | DWORD mode = PIPE_READMODE_MESSAGE; 256 | SetNamedPipeHandleState(g_hPipe, &mode, NULL, NULL); 257 | } 258 | else 259 | { 260 | return FALSE; 261 | } 262 | 263 | MH_STATUS hookStatus = MH_Initialize(); 264 | if (!hookStatus) 265 | { 266 | MH_CreateHook(CreateProcessW, hook_CreateProcessW, (LPVOID*)&orig_CreateProcessW); 267 | MH_CreateHook(ShellExecuteA, hook_ShellExecuteA, (LPVOID*)&orig_ShellExecuteA); 268 | MH_CreateHook(ShellExecuteW, hook_ShellExecuteW, (LPVOID*)&orig_ShellExecuteW); 269 | MH_CreateHook(ReadFile, hook_ReadFile, (LPVOID*)&orig_ReadFile); 270 | MH_CreateHook(GetProcAddress(GetModuleHandleA("ntdll"), "ZwSetInformationThread"), 271 | hook_ZwSetInformationThread, (LPVOID*)&orig_ZwSetInformationThread); 272 | 273 | hookStatus = MH_EnableHook(MH_ALL_HOOKS); 274 | if (!hookStatus) 275 | { 276 | // SendStringMessage(L"Initialized hooks"); 277 | } 278 | else 279 | { 280 | SendStringMessage(L"MinHook enable failed: %hs", MH_StatusToString(hookStatus)); 281 | return FALSE; 282 | } 283 | } 284 | else 285 | { 286 | SendStringMessage(L"MinHook init failed: %hs", MH_StatusToString(hookStatus)); 287 | return FALSE; 288 | } 289 | 290 | return TRUE; 291 | } 292 | 293 | // ---------------------------------------------------------------------------- 294 | static void DeInit() 295 | { 296 | CloseHandle(g_hPipe); 297 | MH_Uninitialize(); 298 | } 299 | 300 | // ---------------------------------------------------------------------------- 301 | BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserved) 302 | { 303 | switch (ul_reason_for_call) 304 | { 305 | case DLL_PROCESS_ATTACH: 306 | return Init(); 307 | break; 308 | 309 | case DLL_PROCESS_DETACH: 310 | DeInit(); 311 | break; 312 | 313 | case DLL_THREAD_ATTACH: 314 | case DLL_THREAD_DETACH: 315 | break; 316 | } 317 | 318 | return TRUE; 319 | } 320 | 321 | -------------------------------------------------------------------------------- /main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #include "DebugLoop.h" 5 | 6 | int main() 7 | { 8 | printf("UnrealKey v0.2.0 - " __DATE__ "\n"); 9 | printf("https://github.com/devinacker/UnrealKey\n\n"); 10 | 11 | int rc = 0; 12 | int argc = 0; 13 | LPWSTR *argv = CommandLineToArgvW(GetCommandLineW(), &argc); 14 | 15 | if (argc < 2) 16 | { 17 | if (argv) 18 | printf("usage: %ws path_to_game_exe\n", argv[0]); 19 | rc = 1; 20 | } 21 | else 22 | { 23 | rc = DebugLoop(argv[1]); 24 | } 25 | 26 | LocalFree(argv); 27 | return rc; 28 | } 29 | --------------------------------------------------------------------------------