Skip to content

Commit

Permalink
Implement gzip unpacking, fixes #149
Browse files Browse the repository at this point in the history
  • Loading branch information
@vit9696
vit9696 committed Nov 11, 2018
1 parent aa0ab13 commit 4dcd6b2
Show file tree
Hide file tree
Showing 34 changed files with 13,602 additions and 61 deletions.
26 changes: 26 additions & 0 deletions UEFIExtract/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,21 @@ SET(PROJECT_SOURCES
../common/sha256.c
../common/bstrlib/bstrlib.c
../common/bstrlib/bstrwrap.cpp
../common/zlib/adler32.c
../common/zlib/compress.c
../common/zlib/crc32.c
../common/zlib/deflate.c
../common/zlib/gzclose.c
../common/zlib/gzlib.c
../common/zlib/gzread.c
../common/zlib/gzwrite.c
../common/zlib/inflate.c
../common/zlib/infback.c
../common/zlib/inftrees.c
../common/zlib/inffast.c
../common/zlib/trees.c
../common/zlib/uncompr.c
../common/zlib/zutil.c
)

SET(PROJECT_HEADERS
Expand Down Expand Up @@ -54,6 +69,17 @@ SET(PROJECT_HEADERS
../common/filesystem.h
../common/bstrlib/bstrlib.h
../common/bstrlib/bstrwrap.h
../common/zlib/zconf.h
../common/zlib/zlib.h
../common/zlib/crc32.h
../common/zlib/deflate.h
../common/zlib/gzguts.h
../common/zlib/inffast.h
../common/zlib/inffixed.h
../common/zlib/inflate.h
../common/zlib/inftrees.h
../common/zlib/trees.h
../common/zlib/zutil.h
../version.h
)

Expand Down
26 changes: 26 additions & 0 deletions UEFIFind/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ SET(PROJECT_SOURCES
../common/sha256.c
../common/bstrlib/bstrlib.c
../common/bstrlib/bstrwrap.cpp
../common/zlib/adler32.c
../common/zlib/compress.c
../common/zlib/crc32.c
../common/zlib/deflate.c
../common/zlib/gzclose.c
../common/zlib/gzlib.c
../common/zlib/gzread.c
../common/zlib/gzwrite.c
../common/zlib/inflate.c
../common/zlib/infback.c
../common/zlib/inftrees.c
../common/zlib/inffast.c
../common/zlib/trees.c
../common/zlib/uncompr.c
../common/zlib/zutil.c
)

SET(PROJECT_HEADERS
Expand Down Expand Up @@ -52,6 +67,17 @@ SET(PROJECT_HEADERS
../common/filesystem.h
../common/bstrlib/bstrlib.h
../common/bstrlib/bstrwrap.h
../common/zlib/zconf.h
../common/zlib/zlib.h
../common/zlib/crc32.h
../common/zlib/deflate.h
../common/zlib/gzguts.h
../common/zlib/inffast.h
../common/zlib/inffixed.h
../common/zlib/inflate.h
../common/zlib/inftrees.h
../common/zlib/trees.h
../common/zlib/zutil.h
../version.h
)

Expand Down
26 changes: 26 additions & 0 deletions UEFITool/uefitool.pro
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ HEADERS += uefitool.h \
../common/ubytearray.h \
../common/bootguard.h \
../common/sha256.h \
../common/zlib/zconf.h \
../common/zlib/zlib.h \
../common/zlib/crc32.h \
../common/zlib/deflate.h \
../common/zlib/gzguts.h \
../common/zlib/inffast.h \
../common/zlib/inffixed.h \
../common/zlib/inflate.h \
../common/zlib/inftrees.h \
../common/zlib/trees.h \
../common/zlib/zutil.h \
../version.h \
qhexedit2/qhexedit.h \
qhexedit2/chunks.h \
Expand Down Expand Up @@ -79,6 +90,21 @@ SOURCES += uefitool_main.cpp \
../common/Tiano/EfiTianoCompressLegacy.c \
../common/ustring.cpp \
../common/sha256.c \
../common/zlib/adler32.c \
../common/zlib/compress.c \
../common/zlib/crc32.c \
../common/zlib/deflate.c \
../common/zlib/gzclose.c \
../common/zlib/gzlib.c \
../common/zlib/gzread.c \
../common/zlib/gzwrite.c \
../common/zlib/inflate.c \
../common/zlib/infback.c \
../common/zlib/inftrees.c \
../common/zlib/inffast.c \
../common/zlib/trees.c \
../common/zlib/uncompr.c \
../common/zlib/zutil.c \
qhexedit2/qhexedit.cpp \
qhexedit2/chunks.cpp \
qhexedit2/commands.cpp
Expand Down
1 change: 1 addition & 0 deletions common/basetypes.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ typedef ptrdiff_t INTN;
#define COMPRESSION_ALGORITHM_UNDECIDED 4
#define COMPRESSION_ALGORITHM_LZMA 5
#define COMPRESSION_ALGORITHM_IMLZMA 6
#define COMPRESSION_ALGORITHM_GZIP 7

// Item create modes
#define CREATE_MODE_APPEND 0
Expand Down
3 changes: 3 additions & 0 deletions common/ffs.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,9 @@ const UByteArray EFI_GUIDED_SECTION_LZMA // EE4E5898-3914-4259-9D6E-DC7BD79403CF
const UByteArray EFI_GUIDED_SECTION_LZMAF86 // D42AE6BD-1352-4BFB-909A-CA72A6EAE889
("\xBD\xE6\x2A\xD4\x52\x13\xFB\x4B\x90\x9A\xCA\x72\xA6\xEA\xE8\x89", 16);

const UByteArray EFI_GUIDED_SECTION_GZIP // 1D301FE9-BE79-4353-91C2-D23BC959AE0C
("\xE9\x1F\x30\x1D\x79\xBE\x53\x43\x91\xC2\xD2\x3B\xC9\x59\xAE\x0C", 16);

const UByteArray EFI_FIRMWARE_CONTENTS_SIGNED_GUID // 0F9D89E8-9259-4F76-A5AF-0C89E34023DF
("\xE8\x89\x9D\x0F\x59\x92\x76\x4F\xA5\xAF\x0C\x89\xE3\x40\x23\xDF", 16);

Expand Down
20 changes: 19 additions & 1 deletion common/ffsparser.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2062,6 +2062,7 @@ USTATUS FfsParser::parseGuidedSectionHeader(const UByteArray & section, const UI
bool msgInvalidCrc = false;
bool msgUnknownCertType = false;
bool msgUnknownCertSubtype = false;
bool msgProcessingRequiredAttributeOnUnknownGuidedSection = false;
if (baGuid == EFI_GUIDED_SECTION_CRC32) {
if ((attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID) == 0) { // Check that AuthStatusValid attribute is set on compressed GUIDed sections
msgNoAuthStatusAttribute = true;
Expand All @@ -2083,7 +2084,7 @@ USTATUS FfsParser::parseGuidedSectionHeader(const UByteArray & section, const UI
}
// No need to change dataOffset here
}
else if (baGuid == EFI_GUIDED_SECTION_LZMA || baGuid == EFI_GUIDED_SECTION_LZMAF86 || baGuid == EFI_GUIDED_SECTION_TIANO) {
else if (baGuid == EFI_GUIDED_SECTION_LZMA || baGuid == EFI_GUIDED_SECTION_LZMAF86 || baGuid == EFI_GUIDED_SECTION_TIANO || baGuid == EFI_GUIDED_SECTION_GZIP) {
if ((attributes & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) == 0) { // Check that ProcessingRequired attribute is set on compressed GUIDed sections
msgNoProcessingRequiredAttributeCompressed = true;
}
Expand Down Expand Up @@ -2145,6 +2146,10 @@ USTATUS FfsParser::parseGuidedSectionHeader(const UByteArray & section, const UI
}
msgSignedSectionFound = true;
}
// Check that ProcessingRequired attribute is not set on GUIDed sections with unknown GUID
else if ((attributes & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) == EFI_GUIDED_SECTION_PROCESSING_REQUIRED) {
msgProcessingRequiredAttributeOnUnknownGuidedSection = true;
}

UByteArray header = section.left(dataOffset);
UByteArray body = section.mid(dataOffset);
Expand Down Expand Up @@ -2187,6 +2192,8 @@ USTATUS FfsParser::parseGuidedSectionHeader(const UByteArray & section, const UI
msg(usprintf("%s: signed GUIDed section with unknown type", __FUNCTION__), index);
if (msgUnknownCertSubtype)
msg(usprintf("%s: signed GUIDed section with unknown subtype", __FUNCTION__), index);
if (msgProcessingRequiredAttributeOnUnknownGuidedSection)
msg(usprintf("%s: processing required bit set for GUIDed section with unknown GUID", __FUNCTION__), index);
}

return U_SUCCESS;
Expand Down Expand Up @@ -2571,6 +2578,17 @@ USTATUS FfsParser::parseGuidedSectionBody(const UModelIndex & index)
parseCurrentSection = false;
}
}
// GZip compressed section
else if (baGuid == EFI_GUIDED_SECTION_GZIP) {
USTATUS result = gzipDecompress(model->body(index), processed);
if (result) {
msg(usprintf("%s: decompression failed with error ", __FUNCTION__) + errorCodeToUString(result), index);
return U_SUCCESS;
}

info += UString("\nCompression algorithm: GZip");
info += usprintf("\nDecompressed size: %Xh (%u)", processed.size(), processed.size());
}

// Add info
model->addInfo(index, info);
Expand Down
93 changes: 39 additions & 54 deletions common/utility.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,57 +135,6 @@ UString errorCodeToUString(USTATUS errorCode)
}
}

// CRC32 implementation
UINT32 crc32(UINT32 initial, const UINT8* buffer, const UINT32 length)
{
static const UINT32 crcTable[256] = {
0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535,
0x9E6495A3, 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD,
0xE7B82D07, 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D,
0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC,
0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4,
0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, 0x35B5A8FA, 0x42B2986C,
0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC,
0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F,
0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB,
0xB6662D3D, 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F,
0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB,
0x086D3D2D, 0x91646C97, 0xE6635C01, 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E,
0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA,
0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, 0x4DB26158, 0x3AB551CE,
0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A,
0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9,
0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409,
0xCE61E49F, 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81,
0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739,
0x9DD277AF, 0x04DB2615, 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344, 0x8708A3D2, 0x1E01F268,
0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0,
0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, 0xD6D6A3E8,
0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B,
0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF,
0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703,
0x220216B9, 0x5505262F, 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7,
0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A,
0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE,
0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242,
0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, 0x88085AE6,
0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45,
0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D,
0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5,
0x47B2CF7F, 0x30B5FFE9, 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605,
0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94,
0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D };

// Accumulate crc32 for buffer
UINT32 crc32 = initial ^ 0xFFFFFFFF;
for (UINT32 i = 0; i < length; i++) {
crc32 = (crc32 >> 8) ^ crcTable[(crc32 ^ buffer[i]) & 0xFF];
}

return(crc32 ^ 0xFFFFFFFF);
}

// Compression routines
USTATUS decompress(const UByteArray & compressedData, const UINT8 compressionType, UINT8 & algorithm, UByteArray & decompressedData, UByteArray & efiDecompressedData)
{
Expand Down Expand Up @@ -380,7 +329,8 @@ UINT8 getPaddingType(const UByteArray & padding)
return Subtypes::DataPadding;
}

static inline int char2hex(char c) {
static inline int char2hex(char c)
{
if (c >= '0' && c <= '9')
return c - '0';
if (c >= 'A' && c <= 'F')
Expand All @@ -391,7 +341,8 @@ static inline int char2hex(char c) {
}

INTN findPattern(const UINT8 *pattern, const UINT8 *patternMask, UINTN patternSize,
const UINT8 *data, UINTN dataSize, UINTN dataOff) {
const UINT8 *data, UINTN dataSize, UINTN dataOff)
{
if (patternSize == 0 || dataSize == 0 || dataOff >= dataSize || dataSize - dataOff < patternSize)
return -1;

Expand All @@ -413,7 +364,8 @@ INTN findPattern(const UINT8 *pattern, const UINT8 *patternMask, UINTN patternSi
return -1;
}

BOOLEAN makePattern(const CHAR8 *textPattern, std::vector<UINT8> &pattern, std::vector<UINT8> &patternMask) {
BOOLEAN makePattern(const CHAR8 *textPattern, std::vector<UINT8> &pattern, std::vector<UINT8> &patternMask)
{
UINTN len = std::strlen(textPattern);

if (len == 0 || len % 2 != 0)
Expand Down Expand Up @@ -444,3 +396,36 @@ BOOLEAN makePattern(const CHAR8 *textPattern, std::vector<UINT8> &pattern, std::

return TRUE;
}

USTATUS gzipDecompress(const UByteArray & input, UByteArray & output)
{
output.clear();

if (input.size() == 0)
return U_SUCCESS;

z_stream stream;
stream.next_in = (z_const Bytef *)input.data();
stream.avail_in = input.size();
stream.zalloc = Z_NULL;
stream.zfree = Z_NULL;
stream.opaque = Z_NULL;

// 15 for the maximum history buffer, 16 for gzip only input.
int ret = inflateInit2(&stream, 15U | 16U);
if (ret != Z_OK)
return U_CUSTOMIZED_DECOMPRESSION_FAILED;

while (ret == Z_OK) {
Bytef out[4096];
stream.next_out = out;
stream.avail_out = sizeof(out);

ret = inflate(&stream, Z_NO_FLUSH);
if ((ret == Z_OK || ret == Z_STREAM_END) && stream.avail_out != sizeof(out))
output += UByteArray((char *)out, sizeof(out) - stream.avail_out);
}

inflateEnd(&stream);
return ret == Z_STREAM_END ? U_SUCCESS : U_CUSTOMIZED_DECOMPRESSION_FAILED;
}
11 changes: 5 additions & 6 deletions common/utility.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

#include <vector>

#include "../common/zlib/zlib.h"

#include "basetypes.h"
#include "ustring.h"
#include "treemodel.h"
Expand All @@ -27,14 +29,11 @@ UString uniqueItemName(const UModelIndex & index);
// Converts error code to UString
UString errorCodeToUString(USTATUS errorCode);

// Decompression routine
// EFI/Tiano decompression routine
USTATUS decompress(const UByteArray & compressed, const UINT8 compressionType, UINT8 & algorithm, UByteArray & decompressed, UByteArray & efiDecompressed);

// Compression routine
//USTATUS compress(const UByteArray & decompressed, UByteArray & compressed, const UINT8 & algorithm);

// CRC32 calculation routine
UINT32 crc32(UINT32 initial, const UINT8* buffer, const UINT32 length);
// GZIP decompression routine
USTATUS gzipDecompress(const UByteArray & compressed, UByteArray & decompressed);

// 8bit sum calculation routine
UINT8 calculateSum8(const UINT8* buffer, UINT32 bufferSize);
Expand Down
Loading

0 comments on commit 4dcd6b2

Please sign in to comment.