modules.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945
  1. //////////////////////////////////////////////////////////////////////////////
  2. //
  3. // Module Enumeration Functions (modules.cpp of detours.lib)
  4. //
  5. // Microsoft Research Detours Package, Version 4.0.1
  6. //
  7. // Copyright (c) Microsoft Corporation. All rights reserved.
  8. //
  9. // Module enumeration functions.
  10. //
  11. // #define DETOUR_DEBUG 1
  12. #define DETOURS_INTERNAL
  13. #include "detours.h"
  14. #if DETOURS_VERSION != 0x4c0c1 // 0xMAJORcMINORcPATCH
  15. #error detours.h version mismatch
  16. #endif
  17. #define CLR_DIRECTORY OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR]
  18. #define IAT_DIRECTORY OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_IAT]
  19. //////////////////////////////////////////////////////////////////////////////
  20. //
  21. const GUID DETOUR_EXE_RESTORE_GUID = {
  22. 0xbda26f34, 0xbc82, 0x4829,
  23. { 0x9e, 0x64, 0x74, 0x2c, 0x4, 0xc8, 0x4f, 0xa0 } };
  24. //////////////////////////////////////////////////////////////////////////////
  25. //
  26. PDETOUR_SYM_INFO DetourLoadImageHlp(VOID)
  27. {
  28. static DETOUR_SYM_INFO symInfo;
  29. static PDETOUR_SYM_INFO pSymInfo = NULL;
  30. static BOOL failed = false;
  31. if (failed) {
  32. return NULL;
  33. }
  34. if (pSymInfo != NULL) {
  35. return pSymInfo;
  36. }
  37. ZeroMemory(&symInfo, sizeof(symInfo));
  38. // Create a real handle to the process.
  39. #if 0
  40. DuplicateHandle(GetCurrentProcess(),
  41. GetCurrentProcess(),
  42. GetCurrentProcess(),
  43. &symInfo.hProcess,
  44. 0,
  45. FALSE,
  46. DUPLICATE_SAME_ACCESS);
  47. #else
  48. symInfo.hProcess = GetCurrentProcess();
  49. #endif
  50. symInfo.hDbgHelp = LoadLibraryExW(L"dbghelp.dll", NULL, 0);
  51. if (symInfo.hDbgHelp == NULL) {
  52. abort:
  53. failed = true;
  54. if (symInfo.hDbgHelp != NULL) {
  55. FreeLibrary(symInfo.hDbgHelp);
  56. }
  57. symInfo.pfImagehlpApiVersionEx = NULL;
  58. symInfo.pfSymInitialize = NULL;
  59. symInfo.pfSymSetOptions = NULL;
  60. symInfo.pfSymGetOptions = NULL;
  61. symInfo.pfSymLoadModule64 = NULL;
  62. symInfo.pfSymGetModuleInfo64 = NULL;
  63. symInfo.pfSymFromName = NULL;
  64. return NULL;
  65. }
  66. symInfo.pfImagehlpApiVersionEx
  67. = (PF_ImagehlpApiVersionEx)GetProcAddress(symInfo.hDbgHelp,
  68. "ImagehlpApiVersionEx");
  69. symInfo.pfSymInitialize
  70. = (PF_SymInitialize)GetProcAddress(symInfo.hDbgHelp, "SymInitialize");
  71. symInfo.pfSymSetOptions
  72. = (PF_SymSetOptions)GetProcAddress(symInfo.hDbgHelp, "SymSetOptions");
  73. symInfo.pfSymGetOptions
  74. = (PF_SymGetOptions)GetProcAddress(symInfo.hDbgHelp, "SymGetOptions");
  75. symInfo.pfSymLoadModule64
  76. = (PF_SymLoadModule64)GetProcAddress(symInfo.hDbgHelp, "SymLoadModule64");
  77. symInfo.pfSymGetModuleInfo64
  78. = (PF_SymGetModuleInfo64)GetProcAddress(symInfo.hDbgHelp, "SymGetModuleInfo64");
  79. symInfo.pfSymFromName
  80. = (PF_SymFromName)GetProcAddress(symInfo.hDbgHelp, "SymFromName");
  81. API_VERSION av;
  82. ZeroMemory(&av, sizeof(av));
  83. av.MajorVersion = API_VERSION_NUMBER;
  84. if (symInfo.pfImagehlpApiVersionEx == NULL ||
  85. symInfo.pfSymInitialize == NULL ||
  86. symInfo.pfSymLoadModule64 == NULL ||
  87. symInfo.pfSymGetModuleInfo64 == NULL ||
  88. symInfo.pfSymFromName == NULL) {
  89. goto abort;
  90. }
  91. symInfo.pfImagehlpApiVersionEx(&av);
  92. if (av.MajorVersion < API_VERSION_NUMBER) {
  93. goto abort;
  94. }
  95. if (!symInfo.pfSymInitialize(symInfo.hProcess, NULL, FALSE)) {
  96. // We won't retry the initialize if it fails.
  97. goto abort;
  98. }
  99. if (symInfo.pfSymGetOptions != NULL && symInfo.pfSymSetOptions != NULL) {
  100. DWORD dw = symInfo.pfSymGetOptions();
  101. dw &= ~(SYMOPT_CASE_INSENSITIVE |
  102. SYMOPT_UNDNAME |
  103. SYMOPT_DEFERRED_LOADS |
  104. 0);
  105. dw |= (
  106. #if defined(SYMOPT_EXACT_SYMBOLS)
  107. SYMOPT_EXACT_SYMBOLS |
  108. #endif
  109. #if defined(SYMOPT_NO_UNQUALIFIED_LOADS)
  110. SYMOPT_NO_UNQUALIFIED_LOADS |
  111. #endif
  112. SYMOPT_DEFERRED_LOADS |
  113. #if defined(SYMOPT_FAIL_CRITICAL_ERRORS)
  114. SYMOPT_FAIL_CRITICAL_ERRORS |
  115. #endif
  116. #if defined(SYMOPT_INCLUDE_32BIT_MODULES)
  117. SYMOPT_INCLUDE_32BIT_MODULES |
  118. #endif
  119. 0);
  120. symInfo.pfSymSetOptions(dw);
  121. }
  122. pSymInfo = &symInfo;
  123. return pSymInfo;
  124. }
  125. PVOID WINAPI DetourFindFunction(_In_ LPCSTR pszModule,
  126. _In_ LPCSTR pszFunction)
  127. {
  128. if (pszFunction == NULL) {
  129. SetLastError(ERROR_INVALID_PARAMETER);
  130. return NULL;
  131. }
  132. /////////////////////////////////////////////// First, try GetProcAddress.
  133. //
  134. #pragma prefast(suppress:28752, "We don't do the unicode conversion for LoadLibraryExA.")
  135. HMODULE hModule = LoadLibraryExA(pszModule, NULL, 0);
  136. if (hModule == NULL) {
  137. return NULL;
  138. }
  139. PBYTE pbCode = (PBYTE)GetProcAddress(hModule, pszFunction);
  140. if (pbCode) {
  141. return pbCode;
  142. }
  143. ////////////////////////////////////////////////////// Then try ImageHelp.
  144. //
  145. DETOUR_TRACE(("DetourFindFunction(%hs, %hs)\n", pszModule, pszFunction));
  146. PDETOUR_SYM_INFO pSymInfo = DetourLoadImageHlp();
  147. if (pSymInfo == NULL) {
  148. DETOUR_TRACE(("DetourLoadImageHlp failed: %lu\n",
  149. GetLastError()));
  150. return NULL;
  151. }
  152. if (pSymInfo->pfSymLoadModule64(pSymInfo->hProcess, NULL,
  153. (PCHAR)pszModule, NULL,
  154. (DWORD64)hModule, 0) == 0) {
  155. if (ERROR_SUCCESS != GetLastError()) {
  156. DETOUR_TRACE(("SymLoadModule64(%p) failed: %lu\n",
  157. pSymInfo->hProcess, GetLastError()));
  158. return NULL;
  159. }
  160. }
  161. HRESULT hrRet;
  162. CHAR szFullName[512];
  163. IMAGEHLP_MODULE64 modinfo;
  164. ZeroMemory(&modinfo, sizeof(modinfo));
  165. modinfo.SizeOfStruct = sizeof(modinfo);
  166. if (!pSymInfo->pfSymGetModuleInfo64(pSymInfo->hProcess, (DWORD64)hModule, &modinfo)) {
  167. DETOUR_TRACE(("SymGetModuleInfo64(%p, %p) failed: %lu\n",
  168. pSymInfo->hProcess, hModule, GetLastError()));
  169. return NULL;
  170. }
  171. hrRet = StringCchCopyA(szFullName, sizeof(szFullName)/sizeof(CHAR), modinfo.ModuleName);
  172. if (FAILED(hrRet)) {
  173. DETOUR_TRACE(("StringCchCopyA failed: %08lx\n", hrRet));
  174. return NULL;
  175. }
  176. hrRet = StringCchCatA(szFullName, sizeof(szFullName)/sizeof(CHAR), "!");
  177. if (FAILED(hrRet)) {
  178. DETOUR_TRACE(("StringCchCatA failed: %08lx\n", hrRet));
  179. return NULL;
  180. }
  181. hrRet = StringCchCatA(szFullName, sizeof(szFullName)/sizeof(CHAR), pszFunction);
  182. if (FAILED(hrRet)) {
  183. DETOUR_TRACE(("StringCchCatA failed: %08lx\n", hrRet));
  184. return NULL;
  185. }
  186. struct CFullSymbol : SYMBOL_INFO {
  187. CHAR szRestOfName[512];
  188. } symbol;
  189. ZeroMemory(&symbol, sizeof(symbol));
  190. //symbol.ModBase = (ULONG64)hModule;
  191. symbol.SizeOfStruct = sizeof(SYMBOL_INFO);
  192. #ifdef DBHLPAPI
  193. symbol.MaxNameLen = sizeof(symbol.szRestOfName)/sizeof(symbol.szRestOfName[0]);
  194. #else
  195. symbol.MaxNameLength = sizeof(symbol.szRestOfName)/sizeof(symbol.szRestOfName[0]);
  196. #endif
  197. if (!pSymInfo->pfSymFromName(pSymInfo->hProcess, szFullName, &symbol)) {
  198. DETOUR_TRACE(("SymFromName(%hs) failed: %lu\n", szFullName, GetLastError()));
  199. return NULL;
  200. }
  201. #if defined(DETOURS_IA64)
  202. // On the IA64, we get a raw code pointer from the symbol engine
  203. // and have to convert it to a wrapped [code pointer, global pointer].
  204. //
  205. PPLABEL_DESCRIPTOR pldEntry = (PPLABEL_DESCRIPTOR)DetourGetEntryPoint(hModule);
  206. PPLABEL_DESCRIPTOR pldSymbol = new PLABEL_DESCRIPTOR;
  207. pldSymbol->EntryPoint = symbol.Address;
  208. pldSymbol->GlobalPointer = pldEntry->GlobalPointer;
  209. return (PBYTE)pldSymbol;
  210. #elif defined(DETOURS_ARM)
  211. // On the ARM, we get a raw code pointer, which we must convert into a
  212. // valied Thumb2 function pointer.
  213. return DETOURS_PBYTE_TO_PFUNC(symbol.Address);
  214. #else
  215. return (PBYTE)symbol.Address;
  216. #endif
  217. }
  218. //////////////////////////////////////////////////// Module Image Functions.
  219. //
  220. HMODULE WINAPI DetourEnumerateModules(_In_opt_ HMODULE hModuleLast)
  221. {
  222. PBYTE pbLast = (PBYTE)hModuleLast + MM_ALLOCATION_GRANULARITY;
  223. MEMORY_BASIC_INFORMATION mbi;
  224. ZeroMemory(&mbi, sizeof(mbi));
  225. // Find the next memory region that contains a mapped PE image.
  226. //
  227. for (;; pbLast = (PBYTE)mbi.BaseAddress + mbi.RegionSize) {
  228. if (VirtualQuery(pbLast, &mbi, sizeof(mbi)) <= 0) {
  229. break;
  230. }
  231. // Skip uncommitted regions and guard pages.
  232. //
  233. if ((mbi.State != MEM_COMMIT) ||
  234. ((mbi.Protect & 0xff) == PAGE_NOACCESS) ||
  235. (mbi.Protect & PAGE_GUARD)) {
  236. continue;
  237. }
  238. __try {
  239. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)pbLast;
  240. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE ||
  241. (DWORD)pDosHeader->e_lfanew > mbi.RegionSize ||
  242. (DWORD)pDosHeader->e_lfanew < sizeof(*pDosHeader)) {
  243. continue;
  244. }
  245. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  246. pDosHeader->e_lfanew);
  247. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  248. continue;
  249. }
  250. SetLastError(NO_ERROR);
  251. return (HMODULE)pDosHeader;
  252. }
  253. #pragma prefast(suppress:28940, "A bad pointer means this probably isn't a PE header.")
  254. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  255. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  256. continue;
  257. }
  258. }
  259. return NULL;
  260. }
  261. PVOID WINAPI DetourGetEntryPoint(_In_opt_ HMODULE hModule)
  262. {
  263. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)hModule;
  264. if (hModule == NULL) {
  265. pDosHeader = (PIMAGE_DOS_HEADER)GetModuleHandleW(NULL);
  266. }
  267. __try {
  268. #pragma warning(suppress:6011) // GetModuleHandleW(NULL) never returns NULL.
  269. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
  270. SetLastError(ERROR_BAD_EXE_FORMAT);
  271. return NULL;
  272. }
  273. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  274. pDosHeader->e_lfanew);
  275. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  276. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  277. return NULL;
  278. }
  279. if (pNtHeader->FileHeader.SizeOfOptionalHeader == 0) {
  280. SetLastError(ERROR_EXE_MARKED_INVALID);
  281. return NULL;
  282. }
  283. PDETOUR_CLR_HEADER pClrHeader = NULL;
  284. if (pNtHeader->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
  285. if (((PIMAGE_NT_HEADERS32)pNtHeader)->CLR_DIRECTORY.VirtualAddress != 0 &&
  286. ((PIMAGE_NT_HEADERS32)pNtHeader)->CLR_DIRECTORY.Size != 0) {
  287. pClrHeader = (PDETOUR_CLR_HEADER)
  288. (((PBYTE)pDosHeader)
  289. + ((PIMAGE_NT_HEADERS32)pNtHeader)->CLR_DIRECTORY.VirtualAddress);
  290. }
  291. }
  292. else if (pNtHeader->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
  293. if (((PIMAGE_NT_HEADERS64)pNtHeader)->CLR_DIRECTORY.VirtualAddress != 0 &&
  294. ((PIMAGE_NT_HEADERS64)pNtHeader)->CLR_DIRECTORY.Size != 0) {
  295. pClrHeader = (PDETOUR_CLR_HEADER)
  296. (((PBYTE)pDosHeader)
  297. + ((PIMAGE_NT_HEADERS64)pNtHeader)->CLR_DIRECTORY.VirtualAddress);
  298. }
  299. }
  300. if (pClrHeader != NULL) {
  301. // For MSIL assemblies, we want to use the _Cor entry points.
  302. HMODULE hClr = GetModuleHandleW(L"MSCOREE.DLL");
  303. if (hClr == NULL) {
  304. return NULL;
  305. }
  306. SetLastError(NO_ERROR);
  307. return (PVOID)GetProcAddress(hClr, "_CorExeMain");
  308. }
  309. SetLastError(NO_ERROR);
  310. // Pure resource DLLs have neither an entry point nor CLR information
  311. // so handle them by returning NULL (LastError is NO_ERROR)
  312. if (pNtHeader->OptionalHeader.AddressOfEntryPoint == 0) {
  313. return NULL;
  314. }
  315. return ((PBYTE)pDosHeader) +
  316. pNtHeader->OptionalHeader.AddressOfEntryPoint;
  317. }
  318. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  319. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  320. SetLastError(ERROR_EXE_MARKED_INVALID);
  321. return NULL;
  322. }
  323. }
  324. ULONG WINAPI DetourGetModuleSize(_In_opt_ HMODULE hModule)
  325. {
  326. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)hModule;
  327. if (hModule == NULL) {
  328. pDosHeader = (PIMAGE_DOS_HEADER)GetModuleHandleW(NULL);
  329. }
  330. __try {
  331. #pragma warning(suppress:6011) // GetModuleHandleW(NULL) never returns NULL.
  332. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
  333. SetLastError(ERROR_BAD_EXE_FORMAT);
  334. return NULL;
  335. }
  336. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  337. pDosHeader->e_lfanew);
  338. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  339. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  340. return NULL;
  341. }
  342. if (pNtHeader->FileHeader.SizeOfOptionalHeader == 0) {
  343. SetLastError(ERROR_EXE_MARKED_INVALID);
  344. return NULL;
  345. }
  346. SetLastError(NO_ERROR);
  347. return (pNtHeader->OptionalHeader.SizeOfImage);
  348. }
  349. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  350. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  351. SetLastError(ERROR_EXE_MARKED_INVALID);
  352. return NULL;
  353. }
  354. }
  355. HMODULE WINAPI DetourGetContainingModule(_In_ PVOID pvAddr)
  356. {
  357. MEMORY_BASIC_INFORMATION mbi;
  358. ZeroMemory(&mbi, sizeof(mbi));
  359. __try {
  360. if (VirtualQuery(pvAddr, &mbi, sizeof(mbi)) <= 0) {
  361. SetLastError(ERROR_BAD_EXE_FORMAT);
  362. return NULL;
  363. }
  364. // Skip uncommitted regions and guard pages.
  365. //
  366. if ((mbi.State != MEM_COMMIT) ||
  367. ((mbi.Protect & 0xff) == PAGE_NOACCESS) ||
  368. (mbi.Protect & PAGE_GUARD)) {
  369. SetLastError(ERROR_BAD_EXE_FORMAT);
  370. return NULL;
  371. }
  372. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)mbi.AllocationBase;
  373. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
  374. SetLastError(ERROR_BAD_EXE_FORMAT);
  375. return NULL;
  376. }
  377. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  378. pDosHeader->e_lfanew);
  379. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  380. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  381. return NULL;
  382. }
  383. if (pNtHeader->FileHeader.SizeOfOptionalHeader == 0) {
  384. SetLastError(ERROR_EXE_MARKED_INVALID);
  385. return NULL;
  386. }
  387. SetLastError(NO_ERROR);
  388. return (HMODULE)pDosHeader;
  389. }
  390. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  391. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  392. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  393. return NULL;
  394. }
  395. }
  396. static inline PBYTE RvaAdjust(_Pre_notnull_ PIMAGE_DOS_HEADER pDosHeader, _In_ DWORD raddr)
  397. {
  398. if (raddr != NULL) {
  399. return ((PBYTE)pDosHeader) + raddr;
  400. }
  401. return NULL;
  402. }
  403. BOOL WINAPI DetourEnumerateExports(_In_ HMODULE hModule,
  404. _In_opt_ PVOID pContext,
  405. _In_ PF_DETOUR_ENUMERATE_EXPORT_CALLBACK pfExport)
  406. {
  407. if (pfExport == NULL) {
  408. SetLastError(ERROR_INVALID_PARAMETER);
  409. return FALSE;
  410. }
  411. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)hModule;
  412. if (hModule == NULL) {
  413. pDosHeader = (PIMAGE_DOS_HEADER)GetModuleHandleW(NULL);
  414. }
  415. __try {
  416. #pragma warning(suppress:6011) // GetModuleHandleW(NULL) never returns NULL.
  417. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
  418. SetLastError(ERROR_BAD_EXE_FORMAT);
  419. return NULL;
  420. }
  421. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  422. pDosHeader->e_lfanew);
  423. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  424. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  425. return FALSE;
  426. }
  427. if (pNtHeader->FileHeader.SizeOfOptionalHeader == 0) {
  428. SetLastError(ERROR_EXE_MARKED_INVALID);
  429. return FALSE;
  430. }
  431. PIMAGE_EXPORT_DIRECTORY pExportDir
  432. = (PIMAGE_EXPORT_DIRECTORY)
  433. RvaAdjust(pDosHeader,
  434. pNtHeader->OptionalHeader
  435. .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].VirtualAddress);
  436. if (pExportDir == NULL) {
  437. SetLastError(ERROR_EXE_MARKED_INVALID);
  438. return FALSE;
  439. }
  440. PBYTE pExportDirEnd = (PBYTE)pExportDir + pNtHeader->OptionalHeader
  441. .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].Size;
  442. PDWORD pdwFunctions = (PDWORD)RvaAdjust(pDosHeader, pExportDir->AddressOfFunctions);
  443. PDWORD pdwNames = (PDWORD)RvaAdjust(pDosHeader, pExportDir->AddressOfNames);
  444. PWORD pwOrdinals = (PWORD)RvaAdjust(pDosHeader, pExportDir->AddressOfNameOrdinals);
  445. for (DWORD nFunc = 0; nFunc < pExportDir->NumberOfFunctions; nFunc++) {
  446. PBYTE pbCode = (pdwFunctions != NULL)
  447. ? (PBYTE)RvaAdjust(pDosHeader, pdwFunctions[nFunc]) : NULL;
  448. PCHAR pszName = NULL;
  449. // if the pointer is in the export region, then it is a forwarder.
  450. if (pbCode > (PBYTE)pExportDir && pbCode < pExportDirEnd) {
  451. pbCode = NULL;
  452. }
  453. for (DWORD n = 0; n < pExportDir->NumberOfNames; n++) {
  454. if (pwOrdinals[n] == nFunc) {
  455. pszName = (pdwNames != NULL)
  456. ? (PCHAR)RvaAdjust(pDosHeader, pdwNames[n]) : NULL;
  457. break;
  458. }
  459. }
  460. ULONG nOrdinal = pExportDir->Base + nFunc;
  461. if (!pfExport(pContext, nOrdinal, pszName, pbCode)) {
  462. break;
  463. }
  464. }
  465. SetLastError(NO_ERROR);
  466. return TRUE;
  467. }
  468. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  469. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  470. SetLastError(ERROR_EXE_MARKED_INVALID);
  471. return NULL;
  472. }
  473. }
  474. BOOL WINAPI DetourEnumerateImportsEx(_In_opt_ HMODULE hModule,
  475. _In_opt_ PVOID pContext,
  476. _In_opt_ PF_DETOUR_IMPORT_FILE_CALLBACK pfImportFile,
  477. _In_opt_ PF_DETOUR_IMPORT_FUNC_CALLBACK_EX pfImportFunc)
  478. {
  479. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)hModule;
  480. if (hModule == NULL) {
  481. pDosHeader = (PIMAGE_DOS_HEADER)GetModuleHandleW(NULL);
  482. }
  483. __try {
  484. #pragma warning(suppress:6011) // GetModuleHandleW(NULL) never returns NULL.
  485. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
  486. SetLastError(ERROR_BAD_EXE_FORMAT);
  487. return FALSE;
  488. }
  489. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  490. pDosHeader->e_lfanew);
  491. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  492. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  493. return FALSE;
  494. }
  495. if (pNtHeader->FileHeader.SizeOfOptionalHeader == 0) {
  496. SetLastError(ERROR_EXE_MARKED_INVALID);
  497. return FALSE;
  498. }
  499. PIMAGE_IMPORT_DESCRIPTOR iidp
  500. = (PIMAGE_IMPORT_DESCRIPTOR)
  501. RvaAdjust(pDosHeader,
  502. pNtHeader->OptionalHeader
  503. .DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT].VirtualAddress);
  504. if (iidp == NULL) {
  505. SetLastError(ERROR_EXE_MARKED_INVALID);
  506. return FALSE;
  507. }
  508. for (; iidp->OriginalFirstThunk != 0; iidp++) {
  509. PCSTR pszName = (PCHAR)RvaAdjust(pDosHeader, iidp->Name);
  510. if (pszName == NULL) {
  511. SetLastError(ERROR_EXE_MARKED_INVALID);
  512. return FALSE;
  513. }
  514. PIMAGE_THUNK_DATA pThunks = (PIMAGE_THUNK_DATA)
  515. RvaAdjust(pDosHeader, iidp->OriginalFirstThunk);
  516. PVOID * pAddrs = (PVOID *)
  517. RvaAdjust(pDosHeader, iidp->FirstThunk);
  518. HMODULE hFile = DetourGetContainingModule(pAddrs[0]);
  519. if (pfImportFile != NULL) {
  520. if (!pfImportFile(pContext, hFile, pszName)) {
  521. break;
  522. }
  523. }
  524. DWORD nNames = 0;
  525. if (pThunks) {
  526. for (; pThunks[nNames].u1.Ordinal; nNames++) {
  527. DWORD nOrdinal = 0;
  528. PCSTR pszFunc = NULL;
  529. if (IMAGE_SNAP_BY_ORDINAL(pThunks[nNames].u1.Ordinal)) {
  530. nOrdinal = (DWORD)IMAGE_ORDINAL(pThunks[nNames].u1.Ordinal);
  531. }
  532. else {
  533. pszFunc = (PCSTR)RvaAdjust(pDosHeader,
  534. (DWORD)pThunks[nNames].u1.AddressOfData + 2);
  535. }
  536. if (pfImportFunc != NULL) {
  537. if (!pfImportFunc(pContext,
  538. nOrdinal,
  539. pszFunc,
  540. &pAddrs[nNames])) {
  541. break;
  542. }
  543. }
  544. }
  545. if (pfImportFunc != NULL) {
  546. pfImportFunc(pContext, 0, NULL, NULL);
  547. }
  548. }
  549. }
  550. if (pfImportFile != NULL) {
  551. pfImportFile(pContext, NULL, NULL);
  552. }
  553. SetLastError(NO_ERROR);
  554. return TRUE;
  555. }
  556. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  557. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  558. SetLastError(ERROR_EXE_MARKED_INVALID);
  559. return FALSE;
  560. }
  561. }
  562. // Context for DetourEnumerateImportsThunk, which adapts "regular" callbacks for use with "Ex".
  563. struct _DETOUR_ENUMERATE_IMPORTS_THUNK_CONTEXT
  564. {
  565. PVOID pContext;
  566. PF_DETOUR_IMPORT_FILE_CALLBACK pfImportFile;
  567. PF_DETOUR_IMPORT_FUNC_CALLBACK pfImportFunc;
  568. };
  569. // Callback for DetourEnumerateImportsEx that adapts DetourEnumerateImportsEx
  570. // for use with a DetourEnumerateImports callback -- derefence the IAT and pass the value on.
  571. static
  572. BOOL
  573. CALLBACK
  574. DetourEnumerateImportsThunk(_In_ PVOID VoidContext,
  575. _In_ DWORD nOrdinal,
  576. _In_opt_ PCSTR pszFunc,
  577. _In_opt_ PVOID* ppvFunc)
  578. {
  579. _DETOUR_ENUMERATE_IMPORTS_THUNK_CONTEXT const * const
  580. pContext = (_DETOUR_ENUMERATE_IMPORTS_THUNK_CONTEXT*)VoidContext;
  581. return pContext->pfImportFunc(pContext->pContext, nOrdinal, pszFunc, ppvFunc ? *ppvFunc : NULL);
  582. }
  583. static
  584. BOOL
  585. CALLBACK
  586. DetourEnumerateImportsFile(_In_ PVOID VoidContext,
  587. _In_opt_ HMODULE hModule,
  588. _In_opt_ LPCSTR pszFile)
  589. {
  590. _DETOUR_ENUMERATE_IMPORTS_THUNK_CONTEXT const * const
  591. pContext = (_DETOUR_ENUMERATE_IMPORTS_THUNK_CONTEXT*)VoidContext;
  592. return pContext->pfImportFile(pContext->pContext, hModule, pszFile);
  593. }
  594. BOOL WINAPI DetourEnumerateImports(_In_opt_ HMODULE hModule,
  595. _In_opt_ PVOID pContext,
  596. _In_opt_ PF_DETOUR_IMPORT_FILE_CALLBACK pfImportFile,
  597. _In_opt_ PF_DETOUR_IMPORT_FUNC_CALLBACK pfImportFunc)
  598. {
  599. if (pfImportFile == NULL || pfImportFunc == NULL) {
  600. SetLastError(ERROR_INVALID_PARAMETER);
  601. return FALSE;
  602. }
  603. _DETOUR_ENUMERATE_IMPORTS_THUNK_CONTEXT const context = { pContext, pfImportFile, pfImportFunc };
  604. return DetourEnumerateImportsEx(hModule,
  605. (PVOID)&context,
  606. &DetourEnumerateImportsFile,
  607. &DetourEnumerateImportsThunk);
  608. }
  609. static PDETOUR_LOADED_BINARY WINAPI GetPayloadSectionFromModule(HMODULE hModule)
  610. {
  611. PIMAGE_DOS_HEADER pDosHeader = (PIMAGE_DOS_HEADER)hModule;
  612. if (hModule == NULL) {
  613. pDosHeader = (PIMAGE_DOS_HEADER)GetModuleHandleW(NULL);
  614. }
  615. __try {
  616. #pragma warning(suppress:6011) // GetModuleHandleW(NULL) never returns NULL.
  617. if (pDosHeader->e_magic != IMAGE_DOS_SIGNATURE) {
  618. SetLastError(ERROR_BAD_EXE_FORMAT);
  619. return NULL;
  620. }
  621. PIMAGE_NT_HEADERS pNtHeader = (PIMAGE_NT_HEADERS)((PBYTE)pDosHeader +
  622. pDosHeader->e_lfanew);
  623. if (pNtHeader->Signature != IMAGE_NT_SIGNATURE) {
  624. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  625. return NULL;
  626. }
  627. if (pNtHeader->FileHeader.SizeOfOptionalHeader == 0) {
  628. SetLastError(ERROR_EXE_MARKED_INVALID);
  629. return NULL;
  630. }
  631. PIMAGE_SECTION_HEADER pSectionHeaders
  632. = (PIMAGE_SECTION_HEADER)((PBYTE)pNtHeader
  633. + sizeof(pNtHeader->Signature)
  634. + sizeof(pNtHeader->FileHeader)
  635. + pNtHeader->FileHeader.SizeOfOptionalHeader);
  636. for (DWORD n = 0; n < pNtHeader->FileHeader.NumberOfSections; n++) {
  637. if (strcmp((PCHAR)pSectionHeaders[n].Name, ".detour") == 0) {
  638. if (pSectionHeaders[n].VirtualAddress == 0 ||
  639. pSectionHeaders[n].SizeOfRawData == 0) {
  640. break;
  641. }
  642. PBYTE pbData = (PBYTE)pDosHeader + pSectionHeaders[n].VirtualAddress;
  643. DETOUR_SECTION_HEADER *pHeader = (DETOUR_SECTION_HEADER *)pbData;
  644. if (pHeader->cbHeaderSize < sizeof(DETOUR_SECTION_HEADER) ||
  645. pHeader->nSignature != DETOUR_SECTION_HEADER_SIGNATURE) {
  646. break;
  647. }
  648. if (pHeader->nDataOffset == 0) {
  649. pHeader->nDataOffset = pHeader->cbHeaderSize;
  650. }
  651. SetLastError(NO_ERROR);
  652. return (PBYTE)pHeader;
  653. }
  654. }
  655. SetLastError(ERROR_EXE_MARKED_INVALID);
  656. return NULL;
  657. }
  658. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  659. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  660. SetLastError(ERROR_EXE_MARKED_INVALID);
  661. return NULL;
  662. }
  663. }
  664. DWORD WINAPI DetourGetSizeOfPayloads(_In_opt_ HMODULE hModule)
  665. {
  666. PDETOUR_LOADED_BINARY pBinary = GetPayloadSectionFromModule(hModule);
  667. if (pBinary == NULL) {
  668. // Error set by GetPayloadSectionFromModule.
  669. return 0;
  670. }
  671. __try {
  672. DETOUR_SECTION_HEADER *pHeader = (DETOUR_SECTION_HEADER *)pBinary;
  673. if (pHeader->cbHeaderSize < sizeof(DETOUR_SECTION_HEADER) ||
  674. pHeader->nSignature != DETOUR_SECTION_HEADER_SIGNATURE) {
  675. SetLastError(ERROR_INVALID_HANDLE);
  676. return 0;
  677. }
  678. SetLastError(NO_ERROR);
  679. return pHeader->cbDataSize;
  680. }
  681. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  682. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  683. SetLastError(ERROR_INVALID_HANDLE);
  684. return 0;
  685. }
  686. }
  687. _Writable_bytes_(*pcbData)
  688. _Readable_bytes_(*pcbData)
  689. _Success_(return != NULL)
  690. PVOID WINAPI DetourFindPayload(_In_opt_ HMODULE hModule,
  691. _In_ REFGUID rguid,
  692. _Out_opt_ DWORD *pcbData)
  693. {
  694. PBYTE pbData = NULL;
  695. if (pcbData) {
  696. *pcbData = 0;
  697. }
  698. PDETOUR_LOADED_BINARY pBinary = GetPayloadSectionFromModule(hModule);
  699. if (pBinary == NULL) {
  700. // Error set by GetPayloadSectionFromModule.
  701. return NULL;
  702. }
  703. __try {
  704. DETOUR_SECTION_HEADER *pHeader = (DETOUR_SECTION_HEADER *)pBinary;
  705. if (pHeader->cbHeaderSize < sizeof(DETOUR_SECTION_HEADER) ||
  706. pHeader->nSignature != DETOUR_SECTION_HEADER_SIGNATURE) {
  707. SetLastError(ERROR_INVALID_EXE_SIGNATURE);
  708. return NULL;
  709. }
  710. PBYTE pbBeg = ((PBYTE)pHeader) + pHeader->nDataOffset;
  711. PBYTE pbEnd = ((PBYTE)pHeader) + pHeader->cbDataSize;
  712. for (pbData = pbBeg; pbData < pbEnd;) {
  713. DETOUR_SECTION_RECORD *pSection = (DETOUR_SECTION_RECORD *)pbData;
  714. if (DetourAreSameGuid(pSection->guid, rguid)) {
  715. if (pcbData) {
  716. *pcbData = pSection->cbBytes - sizeof(*pSection);
  717. }
  718. SetLastError(NO_ERROR);
  719. return (PBYTE)(pSection + 1);
  720. }
  721. pbData = (PBYTE)pSection + pSection->cbBytes;
  722. }
  723. SetLastError(ERROR_INVALID_HANDLE);
  724. return NULL;
  725. }
  726. __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ?
  727. EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH) {
  728. SetLastError(ERROR_INVALID_HANDLE);
  729. return NULL;
  730. }
  731. }
  732. _Writable_bytes_(*pcbData)
  733. _Readable_bytes_(*pcbData)
  734. _Success_(return != NULL)
  735. PVOID WINAPI DetourFindPayloadEx(_In_ REFGUID rguid,
  736. _Out_opt_ DWORD *pcbData)
  737. {
  738. for (HMODULE hMod = NULL; (hMod = DetourEnumerateModules(hMod)) != NULL;) {
  739. PVOID pvData;
  740. pvData = DetourFindPayload(hMod, rguid, pcbData);
  741. if (pvData != NULL) {
  742. return pvData;
  743. }
  744. }
  745. SetLastError(ERROR_MOD_NOT_FOUND);
  746. return NULL;
  747. }
  748. BOOL WINAPI DetourFreePayload(_In_ PVOID pvData)
  749. {
  750. BOOL fSucceeded = FALSE;
  751. // If you have any doubts about the following code, please refer to the comments in DetourCopyPayloadToProcess.
  752. HMODULE hModule = DetourGetContainingModule(pvData);
  753. DETOUR_ASSERT(hModule != NULL);
  754. if (hModule != NULL) {
  755. fSucceeded = VirtualFree(hModule, 0, MEM_RELEASE);
  756. DETOUR_ASSERT(fSucceeded);
  757. if (fSucceeded) {
  758. hModule = NULL;
  759. }
  760. }
  761. return fSucceeded;
  762. }
  763. BOOL WINAPI DetourRestoreAfterWithEx(_In_reads_bytes_(cbData) PVOID pvData,
  764. _In_ DWORD cbData)
  765. {
  766. PDETOUR_EXE_RESTORE pder = (PDETOUR_EXE_RESTORE)pvData;
  767. if (pder->cb != sizeof(*pder) || pder->cb > cbData) {
  768. SetLastError(ERROR_BAD_EXE_FORMAT);
  769. return FALSE;
  770. }
  771. DWORD dwPermIdh = ~0u;
  772. DWORD dwPermInh = ~0u;
  773. DWORD dwPermClr = ~0u;
  774. DWORD dwIgnore;
  775. BOOL fSucceeded = FALSE;
  776. BOOL fUpdated32To64 = FALSE;
  777. if (pder->pclr != NULL && pder->clr.Flags != ((PDETOUR_CLR_HEADER)pder->pclr)->Flags) {
  778. // If we had to promote the 32/64-bit agnostic IL to 64-bit, we can't restore
  779. // that.
  780. fUpdated32To64 = TRUE;
  781. }
  782. if (DetourVirtualProtectSameExecute(pder->pidh, pder->cbidh,
  783. PAGE_EXECUTE_READWRITE, &dwPermIdh)) {
  784. if (DetourVirtualProtectSameExecute(pder->pinh, pder->cbinh,
  785. PAGE_EXECUTE_READWRITE, &dwPermInh)) {
  786. CopyMemory(pder->pidh, &pder->idh, pder->cbidh);
  787. CopyMemory(pder->pinh, &pder->inh, pder->cbinh);
  788. if (pder->pclr != NULL && !fUpdated32To64) {
  789. if (DetourVirtualProtectSameExecute(pder->pclr, pder->cbclr,
  790. PAGE_EXECUTE_READWRITE, &dwPermClr)) {
  791. CopyMemory(pder->pclr, &pder->clr, pder->cbclr);
  792. VirtualProtect(pder->pclr, pder->cbclr, dwPermClr, &dwIgnore);
  793. fSucceeded = TRUE;
  794. }
  795. }
  796. else {
  797. fSucceeded = TRUE;
  798. }
  799. VirtualProtect(pder->pinh, pder->cbinh, dwPermInh, &dwIgnore);
  800. }
  801. VirtualProtect(pder->pidh, pder->cbidh, dwPermIdh, &dwIgnore);
  802. }
  803. // Delete the payload after successful recovery to prevent repeated restore
  804. if (fSucceeded) {
  805. DetourFreePayload(pder);
  806. pder = NULL;
  807. }
  808. return fSucceeded;
  809. }
  810. BOOL WINAPI DetourRestoreAfterWith()
  811. {
  812. PVOID pvData;
  813. DWORD cbData;
  814. pvData = DetourFindPayloadEx(DETOUR_EXE_RESTORE_GUID, &cbData);
  815. if (pvData != NULL && cbData != 0) {
  816. return DetourRestoreAfterWithEx(pvData, cbData);
  817. }
  818. SetLastError(ERROR_MOD_NOT_FOUND);
  819. return FALSE;
  820. }
  821. // End of File