Merge burn

1 files changed, 399 insertions, 0 deletions

diff --git a/src/burn/engine/section.cpp b/src/burn/engine/section.cpp
new file mode 100644
index 00000000..3720155c
--- /dev/null
+++ b/src/burn/engine/section.cpp
@@ -0,0 +1,399 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+#include "precomp.h"
+
+
+// constants
+
+// If these defaults ever change, be sure to update constants in burn\stub\StubSection.cpp as well.
+#define BURN_SECTION_NAME ".wixburn"
+#define BURN_SECTION_MAGIC 0x00f14300
+#define BURN_SECTION_VERSION 0x00000002
+#define MANIFEST_CABINET_TOKEN L"0"
+
+// structs
+typedef struct _BURN_SECTION_HEADER
+{
+    DWORD dwMagic;
+    DWORD dwVersion;
+
+    GUID guidBundleId;
+
+    DWORD dwStubSize;
+    DWORD dwOriginalChecksum;
+    DWORD dwOriginalSignatureOffset;
+    DWORD dwOriginalSignatureSize;
+
+    DWORD dwFormat;
+    DWORD cContainers;
+    DWORD rgcbContainers[1];
+} BURN_SECTION_HEADER;
+
+static HRESULT VerifySectionMatchesMemoryPEHeader(
+    __in REFGUID pSection
+    );
+
+
+extern "C" HRESULT SectionInitialize(
+    __in BURN_SECTION* pSection,
+    __in HANDLE hEngineFile,
+    __in HANDLE hSourceEngineFile
+    )
+{
+    HRESULT hr = S_OK;
+    DWORD cbRead = 0;
+    LARGE_INTEGER li = { };
+    LONGLONG llSize = 0;
+    IMAGE_DOS_HEADER dosHeader = { };
+    IMAGE_NT_HEADERS ntHeader = { };
+    DWORD dwChecksumOffset = 0;
+    DWORD dwCertificateTableOffset = 0;
+    DWORD dwSignatureOffset = 0;
+    DWORD cbSignature = 0;
+    IMAGE_SECTION_HEADER sectionHeader = { };
+    DWORD_PTR dwOriginalChecksumAndSignatureOffset = 0;
+    BURN_SECTION_HEADER* pBurnSectionHeader = NULL;
+
+    pSection->hEngineFile = hEngineFile;
+    ExitOnInvalidHandleWithLastError(pSection->hEngineFile, hr, "Failed to open handle to engine process path.");
+
+    pSection->hSourceEngineFile = INVALID_HANDLE_VALUE == hSourceEngineFile ? hEngineFile : hSourceEngineFile;
+
+    //
+    // First, make sure we have a valid DOS signature.
+    //
+    if (!::SetFilePointerEx(pSection->hEngineFile, li, NULL, FILE_BEGIN))
+    {
+        ExitWithLastError(hr, "Failed to seek to start of file.");
+    }
+
+    // read DOS header
+    if (!::ReadFile(pSection->hEngineFile, &dosHeader, sizeof(IMAGE_DOS_HEADER), &cbRead, NULL))
+    {
+        ExitWithLastError(hr, "Failed to read DOS header.");
+    }
+    else if (sizeof(IMAGE_DOS_HEADER) > cbRead || IMAGE_DOS_SIGNATURE != dosHeader.e_magic)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to find valid DOS image header in buffer.");
+    }
+
+    //
+    // Now, make sure we have a valid NT signature.
+    //
+
+    // seek to new header
+    li.QuadPart = dosHeader.e_lfanew;
+    if (!::SetFilePointerEx(pSection->hEngineFile, li, NULL, FILE_BEGIN))
+    {
+        ExitWithLastError(hr, "Failed to seek to NT header.");
+    }
+
+    // read NT header
+    if (!::ReadFile(pSection->hEngineFile, &ntHeader, sizeof(IMAGE_NT_HEADERS) - sizeof(IMAGE_OPTIONAL_HEADER), &cbRead, NULL))
+    {
+        ExitWithLastError(hr, "Failed to read NT header.");
+    }
+    else if ((sizeof(IMAGE_NT_HEADERS) - sizeof(IMAGE_OPTIONAL_HEADER)) > cbRead || IMAGE_NT_SIGNATURE != ntHeader.Signature)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to find valid NT image header in buffer.");
+    }
+
+    // Get the table offsets.
+    dwChecksumOffset = dosHeader.e_lfanew + sizeof(IMAGE_NT_HEADERS) - sizeof(IMAGE_OPTIONAL_HEADER) + (sizeof(DWORD) * 16);
+    dwCertificateTableOffset = dosHeader.e_lfanew + sizeof(IMAGE_NT_HEADERS) - (sizeof(IMAGE_DATA_DIRECTORY) * (IMAGE_NUMBEROF_DIRECTORY_ENTRIES - IMAGE_DIRECTORY_ENTRY_SECURITY));
+
+    // Seek into the certificate table to get the signature size.
+    li.QuadPart = dwCertificateTableOffset;
+    if (!::SetFilePointerEx(pSection->hEngineFile, li, NULL, FILE_BEGIN))
+    {
+        ExitWithLastError(hr, "Failed to seek to section info.");
+    }
+
+    if (!::ReadFile(pSection->hEngineFile, &dwSignatureOffset, sizeof(dwSignatureOffset), &cbRead, NULL))
+    {
+        ExitWithLastError(hr, "Failed to read signature offset.");
+    }
+
+    if (!::ReadFile(pSection->hEngineFile, &cbSignature, sizeof(cbSignature), &cbRead, NULL))
+    {
+        ExitWithLastError(hr, "Failed to read signature size.");
+    }
+
+    //
+    // Finally, get into the section table and look for the Burn section info.
+    //
+
+    // seek past optional headers
+    li.QuadPart = dosHeader.e_lfanew + sizeof(IMAGE_NT_HEADERS) - sizeof(IMAGE_OPTIONAL_HEADER) + ntHeader.FileHeader.SizeOfOptionalHeader;
+    if (!::SetFilePointerEx(pSection->hEngineFile, li, NULL, FILE_BEGIN))
+    {
+        ExitWithLastError(hr, "Failed to seek past optional headers.");
+    }
+
+    // read sections one by one until we find our section
+    for (DWORD i = 0; ; ++i)
+    {
+        // read section
+        if (!::ReadFile(pSection->hEngineFile, &sectionHeader, sizeof(IMAGE_SECTION_HEADER), &cbRead, NULL))
+        {
+            ExitWithLastError(hr, "Failed to read image section header, index: %u", i);
+        }
+        if (sizeof(IMAGE_SECTION_HEADER) > cbRead)
+        {
+            hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+            ExitOnRootFailure(hr, "Failed to read complete image section header, index: %u", i);
+        }
+
+        // compare header name
+        C_ASSERT(sizeof(sectionHeader.Name) == sizeof(BURN_SECTION_NAME) - 1);
+        if (0 == memcmp(sectionHeader.Name, BURN_SECTION_NAME, sizeof(sectionHeader.Name)))
+        {
+            break;
+        }
+
+        // fail if we hit the end
+        if (i + 1 >= ntHeader.FileHeader.NumberOfSections)
+        {
+            hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+            ExitOnRootFailure(hr, "Failed to find Burn section.");
+        }
+    }
+
+    //
+    // We've arrived at the section info.
+    //
+
+    // check size of section
+    if (sizeof(BURN_SECTION_HEADER) > sectionHeader.SizeOfRawData)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to read section info, data to short: %u", sectionHeader.SizeOfRawData);
+    }
+
+    // allocate buffer for section info
+    pBurnSectionHeader = (BURN_SECTION_HEADER*)MemAlloc(sectionHeader.SizeOfRawData, TRUE);
+    ExitOnNull(pBurnSectionHeader, hr, E_OUTOFMEMORY, "Failed to allocate buffer for section info.");
+
+    // seek to section info
+    li.QuadPart = sectionHeader.PointerToRawData;
+    if (!::SetFilePointerEx(pSection->hEngineFile, li, NULL, FILE_BEGIN))
+    {
+        ExitWithLastError(hr, "Failed to seek to section info.");
+    }
+
+    // Note the location of original checksum and signature information in the burn section header.
+    dwOriginalChecksumAndSignatureOffset = sectionHeader.PointerToRawData + (reinterpret_cast<LPBYTE>(&pBurnSectionHeader->dwOriginalChecksum) - reinterpret_cast<LPBYTE>(pBurnSectionHeader));
+
+    // read section info
+    if (!::ReadFile(pSection->hEngineFile, pBurnSectionHeader, sectionHeader.SizeOfRawData, &cbRead, NULL))
+    {
+        ExitWithLastError(hr, "Failed to read section info.");
+    }
+    else if (sectionHeader.SizeOfRawData > cbRead)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to read complete section info.");
+    }
+
+    // validate version of section info
+    if (BURN_SECTION_VERSION != pBurnSectionHeader->dwVersion)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to read section info, unsupported version: %08x", pBurnSectionHeader->dwVersion);
+    }
+
+    hr = FileSizeByHandle(pSection->hSourceEngineFile, &llSize);
+    ExitOnFailure(hr, "Failed to get total size of bundle.");
+
+    pSection->cbStub = pBurnSectionHeader->dwStubSize;
+
+    // If there is an original signature use that to determine the engine size.
+    if (pBurnSectionHeader->dwOriginalSignatureOffset)
+    {
+        pSection->cbEngineSize = pBurnSectionHeader->dwOriginalSignatureOffset + pBurnSectionHeader->dwOriginalSignatureSize;
+    }
+    else if (dwSignatureOffset) // if there is a signature, use it.
+    {
+        pSection->cbEngineSize = dwSignatureOffset + cbSignature;
+    }
+    else // just use the stub and UX container as the size of the engine.
+    {
+        pSection->cbEngineSize = pSection->cbStub + pBurnSectionHeader->rgcbContainers[0];
+    }
+
+    pSection->qwBundleSize = static_cast<DWORD64>(llSize);
+
+    pSection->dwChecksumOffset = dwChecksumOffset;
+    pSection->dwCertificateTableOffset = dwCertificateTableOffset;
+    pSection->dwOriginalChecksumAndSignatureOffset = dwOriginalChecksumAndSignatureOffset;
+
+    pSection->dwOriginalChecksum = pBurnSectionHeader->dwOriginalChecksum;
+    pSection->dwOriginalSignatureOffset = pBurnSectionHeader->dwOriginalSignatureOffset;
+    pSection->dwOriginalSignatureSize = pBurnSectionHeader->dwOriginalSignatureSize;
+
+    pSection->dwFormat = pBurnSectionHeader->dwFormat;
+    pSection->cContainers = pBurnSectionHeader->cContainers;
+    pSection->rgcbContainers = (DWORD*)MemAlloc(sizeof(DWORD) * pSection->cContainers, TRUE);
+    ExitOnNull(pSection->rgcbContainers, hr, E_OUTOFMEMORY, "Failed to allocate memory for container sizes.");
+
+    memcpy(pSection->rgcbContainers, pBurnSectionHeader->rgcbContainers, sizeof(DWORD) * pSection->cContainers);
+
+    // TODO: verify more than just the GUID.
+    hr = VerifySectionMatchesMemoryPEHeader(pBurnSectionHeader->guidBundleId);
+    ExitOnRootFailure(hr, "PE Header from file didn't match PE Header in memory.");
+
+LExit:
+    ReleaseMem(pBurnSectionHeader);
+
+    return hr;
+}
+
+extern "C" void SectionUninitialize(
+    __out BURN_SECTION* pSection
+    )
+{
+    ReleaseMem(pSection->rgcbContainers);
+    memset(pSection, 0, sizeof(BURN_SECTION));
+}
+
+extern "C" HRESULT SectionGetAttachedContainerInfo(
+    __in BURN_SECTION* pSection,
+    __in DWORD iContainerIndex,
+    __in DWORD dwExpectedType,
+    __out DWORD64* pqwOffset,
+    __out DWORD64* pqwSize,
+    __out BOOL* pfPresent
+    )
+{
+    HRESULT hr = S_OK;
+
+    // validate container info
+    if (iContainerIndex >= pSection->cContainers)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to find container info, too few elements: %u", pSection->cContainers);
+    }
+    else if (dwExpectedType != pSection->dwFormat)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Unexpected container format.");
+    }
+
+    // If we are asking for the UX container, find it right after the stub.
+    if (0 == iContainerIndex)
+    {
+        *pqwOffset = pSection->cbStub;
+    }
+    else // attached containers start after the whole engine.
+    {
+        *pqwOffset = pSection->cbEngineSize;
+        for (DWORD i = 1; i < iContainerIndex; ++i)
+        {
+            *pqwOffset += pSection->rgcbContainers[i];
+        }
+    }
+
+    *pqwSize = pSection->rgcbContainers[iContainerIndex];
+    *pfPresent = (*pqwOffset + *pqwSize) <= pSection->qwBundleSize;
+
+    AssertSz(*pfPresent || pSection->qwBundleSize <= *pqwOffset, "An attached container should either be present or completely absent from the bundle. Found a case where the attached container is partially present which is wrong.");
+
+LExit:
+    return hr;
+}
+
+HRESULT VerifySectionMatchesMemoryPEHeader(
+    __in REFGUID pBundleId
+    )
+{
+    HRESULT hr = S_OK;
+    BYTE* pbPEHeader = NULL;
+    PIMAGE_DOS_HEADER pDosHeader = NULL;
+    PIMAGE_NT_HEADERS pNtHeader = NULL;
+    PIMAGE_SECTION_HEADER pSections = NULL;
+    PIMAGE_SECTION_HEADER pSectionHeader = NULL;
+    BURN_SECTION_HEADER* pBurnSectionHeader = NULL;
+
+    pbPEHeader = reinterpret_cast<BYTE*>(::GetModuleHandleW(NULL));
+    ExitOnNullWithLastError(pbPEHeader, hr, "Failed to get module handle to process.");
+
+    //
+    // First, make sure we have a valid DOS signature.
+    //
+
+    pDosHeader = reinterpret_cast<PIMAGE_DOS_HEADER>(pbPEHeader);
+    if (IMAGE_DOS_SIGNATURE != pDosHeader->e_magic)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to find valid DOS image header in buffer.");
+    }
+
+    //
+    // Now, make sure we have a valid NT signature.
+    //
+
+    pNtHeader = reinterpret_cast<PIMAGE_NT_HEADERS>(pbPEHeader + pDosHeader->e_lfanew);
+    if (IMAGE_NT_SIGNATURE != pNtHeader->Signature)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to find valid NT image header in buffer.");
+    }
+
+    //
+    // Finally, get into the section table and look for the Burn section info.
+    //
+
+    pSections = reinterpret_cast<PIMAGE_SECTION_HEADER>(pbPEHeader + pDosHeader->e_lfanew + sizeof(IMAGE_NT_HEADERS) - sizeof(IMAGE_OPTIONAL_HEADER) + pNtHeader->FileHeader.SizeOfOptionalHeader);
+
+    // Read sections one by one until we find our section.
+    for (DWORD i = 0; ; ++i)
+    {
+        pSectionHeader = pSections + i;
+
+        // Compare header name.
+        C_ASSERT(sizeof(pSectionHeader->Name) == sizeof(BURN_SECTION_NAME) - 1);
+        if (0 == memcmp(pSectionHeader->Name, BURN_SECTION_NAME, sizeof(pSectionHeader->Name)))
+        {
+            break;
+        }
+
+        // Fail if we hit the end.
+        if (i + 1 >= pNtHeader->FileHeader.NumberOfSections)
+        {
+            hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+            ExitOnRootFailure(hr, "Failed to find Burn section.");
+        }
+    }
+
+    //
+    // We've arrived at the section info.
+    //
+
+    // Check size of section.
+    if (sizeof(BURN_SECTION_HEADER) > pSectionHeader->SizeOfRawData)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to read section info, data to short: %u", pSectionHeader->SizeOfRawData);
+    }
+
+    // Get Burn section info.
+    pBurnSectionHeader = reinterpret_cast<BURN_SECTION_HEADER*>(pbPEHeader + pSectionHeader->VirtualAddress);
+
+    // Validate version of section info.
+    if (BURN_SECTION_VERSION != pBurnSectionHeader->dwVersion)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
+        ExitOnRootFailure(hr, "Failed to read section info, unsupported version: %08x", pBurnSectionHeader->dwVersion);
+    }
+
+    if (!::IsEqualGUID(pBundleId, pBurnSectionHeader->guidBundleId))
+    {
+        hr = E_INVALIDDATA;
+        ExitOnRootFailure(hr, "Bundle guid didn't match the guid in the PE Header in memory.");
+    }
+
+LExit:
+    return hr;
+}