jh163888/UEFITool
1
0
Fork 0
mirror of https://github.com/LongSoft/UEFITool.git synced 2024-11-21 23:48:22 +08:00
Code Issues Projects Releases Wiki Activity
bbdfe28449
UEFITool/common/ffsparser.h

168 lines
8.3 KiB
C
Raw Normal View History

First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
/* ffsparser.h
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
Copyright (c) 2017, LongSoft. All rights reserved.
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHWARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
*/
Removed '_' symbols in include guards which are violating DCL51-CPP rule, closing #46
2016-04-09 18:47:19 +08:00
#ifndef FFSPARSER_H
#define FFSPARSER_H
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
NE A21: deQtization begins - added FfsBuilder code and UI, but reconstruction routines for volumes, files and sections are still not ready - FfsOps moved to common - QVector and QPair aren't used anymore, replaces with std::vector and std::pair - common classes are now independent from QObject - next step is to replace QString with CBString from bstrlib
2016-03-01 15:20:44 +08:00
#include <vector>
NE Alpha 33 - human readable JEDEC ID - NVRAM parser separated from FFS parser - added support for LZMAF86 sections - solved a bug with parsing of VSS variables with invalid sizes
2016-10-10 14:05:04 +08:00
#include "basetypes.h"
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
#include "ustring.h"
#include "ubytearray.h"
UT NE A19 Thanks to lordkag for #41: - improved parsing of Intel flash descriptor - improved detection of Tiano/EFI 1.1 compression type - added 2 UEFI capsule GUIDs used by Lenovo - solved potential crash on very low memory available - UEFIExtract and UEFIFind update to include the latest parser changes
2016-02-02 09:08:08 +08:00
#include "treemodel.h"
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
#include "bootguard.h"
typedef struct BG_PROTECTED_RANGE_
{
UINT32 Offset;
UINT32 Size;
UINT8 Type;
UByteArray Hash;
} BG_PROTECTED_RANGE;
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
#define BG_PROTECTED_RANGE_INTEL_BOOT_GUARD_IBB 0x01
#define BG_PROTECTED_RANGE_INTEL_BOOT_GUARD_POST_IBB 0x02
#define BG_PROTECTED_RANGE_VENDOR_HASH_PHOENIX 0x03
#define BG_PROTECTED_RANGE_VENDOR_HASH_AMI_OLD 0x04
#define BG_PROTECTED_RANGE_VENDOR_HASH_AMI_NEW 0x05
#define BG_PROTECTED_RANGE_VENDOR_HASH_MICROSOFT 0x06
class NvramParser;
class MeParser;
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
NE A21: deQtization begins - added FfsBuilder code and UI, but reconstruction routines for volumes, files and sections are still not ready - FfsOps moved to common - QVector and QPair aren't used anymore, replaces with std::vector and std::pair - common classes are now independent from QObject - next step is to replace QString with CBString from bstrlib
2016-03-01 15:20:44 +08:00
class FfsParser
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
{
public:
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
// Constructor and destructor
FfsParser(TreeModel* treeModel);
~FfsParser();
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
NE Alpha 41
2017-07-09 03:31:57 +08:00
// Obtain parser messages
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
std::vector<std::pair<UString, UModelIndex> > getMessages() const;
NE Alpha 41
2017-07-09 03:31:57 +08:00
// Clear messages
UT NE A25.1 - added support for all Phoenix SCT stuff from NVRAM volume: Intel microcodes, CMDB block, SLIC pubkey/marker. - added support for EVSA extended variables (bigger than 0xFFFF) - better EVSA parsing (invalid data vars are shown now) - FlashMap entries now have human-readable types - various small fixes and refactorings
2016-04-15 02:36:59 +08:00
void clearMessages() { messagesVector.clear(); }
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
NE Alpha 41
2017-07-09 03:31:57 +08:00
// Parse firmware image
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parse(const UByteArray &buffer);
NE A21: deQtization begins - added FfsBuilder code and UI, but reconstruction routines for volumes, files and sections are still not ready - FfsOps moved to common - QVector and QPair aren't used anymore, replaces with std::vector and std::pair - common classes are now independent from QObject - next step is to replace QString with CBString from bstrlib
2016-03-01 15:20:44 +08:00
Move fitParser to ffsParser - required to set fixed properly
2016-07-15 03:22:51 +08:00
// Obtain parsed FIT table
NE Alpha 35
2016-11-03 03:40:38 +08:00
std::vector<std::pair<std::vector<UString>, UModelIndex> > getFitTable() const { return fitTable; }
NE_aplha5 Added FIT detection, parsing and UI, finally
2015-07-07 21:57:41 +08:00
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
// Obtain BootGuardInfo
UString getBootGuardInfo() const { return bootGuardInfo; }
NE Alpha 41
2017-07-09 03:31:57 +08:00
// Obtain offset/address difference
UINT64 getAddressDiff() { return addressDiff; }
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
private:
TreeModel *model;
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
std::vector<std::pair<UString, UModelIndex> > messagesVector;
void msg(const UString message, const UModelIndex index = UModelIndex()) {
messagesVector.push_back(std::pair<UString, UModelIndex>(message, index));
UT NE A26 - NVRAM parsing code refactored - Missing entries added to NVRAM-related infos - Various small bugfixes here and there
2016-04-18 21:10:07 +08:00
};
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
NvramParser* nvramParser;
MeParser* meParser;
NE Alpha 35
2016-11-03 03:40:38 +08:00
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
UByteArray openedImage;
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
UModelIndex lastVtf;
bugfix
2018-04-30 13:33:19 +08:00
UINT32 imageBase;
NE Alpha 41
2017-07-09 03:31:57 +08:00
UINT64 addressDiff;
NE Alpha 35
2016-11-03 03:40:38 +08:00
std::vector<std::pair<std::vector<UString>, UModelIndex> > fitTable;
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
UString bootGuardInfo;
bool bgAcmFound;
bool bgKeyManifestFound;
bool bgBootPolicyFound;
UByteArray bgKmHash;
UByteArray bgBpHash;
UByteArray bgBpDigest;
std::vector<BG_PROTECTED_RANGE> bgProtectedRanges;
UINT64 bgFirstVolumeOffset;
UModelIndex bgDxeCoreIndex;
NE Alpha 33 - human readable JEDEC ID - NVRAM parser separated from FFS parser - added support for LZMAF86 sections - solved a bug with parsing of VSS variables with invalid sizes
2016-10-10 14:05:04 +08:00
Move fitParser to ffsParser - required to set fixed properly
2016-07-15 03:22:51 +08:00
// First pass
USTATUS performFirstPass(const UByteArray & imageFile, UModelIndex & index);
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
bugfix
2018-04-30 13:33:19 +08:00
USTATUS parseCapsule(const UByteArray & capsule, UModelIndex & index);
USTATUS parseIntelImage(const UByteArray & intelImage, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
USTATUS parseGenericImage(const UByteArray & intelImage, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parseRawArea(const UModelIndex & index);
NE Alpha 34
2016-10-28 00:31:15 +08:00
USTATUS parseVolumeHeader(const UByteArray & volume, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parseVolumeBody(const UModelIndex & index);
NE Alpha 34
2016-10-28 00:31:15 +08:00
USTATUS parseFileHeader(const UByteArray & file, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parseFileBody(const UModelIndex & index);
NE Alpha 34
2016-10-28 00:31:15 +08:00
USTATUS parseSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parseSectionBody(const UModelIndex & index);
NE Alpha 34
2016-10-28 00:31:15 +08:00
USTATUS parseGbeRegion(const UByteArray & gbe, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
USTATUS parseMeRegion(const UByteArray & me, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
USTATUS parseBiosRegion(const UByteArray & bios, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
USTATUS parsePdrRegion(const UByteArray & pdr, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
USTATUS parseGenericRegion(const UINT8 subtype, const UByteArray & region, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parsePadFileBody(const UModelIndex & index);
NE Alpha 34
2016-10-28 00:31:15 +08:00
USTATUS parseVolumeNonUefiData(const UByteArray & data, const UINT32 localOffset, const UModelIndex & index);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
UT NE A32 - improved parsing of volume's non-UEFI data - improved detection of top-swap for TE images - other minor fixes
2016-07-16 13:02:33 +08:00
USTATUS parseSections(const UByteArray & sections, const UModelIndex & index, const bool insertIntoTree);
NE Alpha 34
2016-10-28 00:31:15 +08:00
USTATUS parseCommonSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
USTATUS parseCompressedSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
USTATUS parseGuidedSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
USTATUS parseFreeformGuidedSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
USTATUS parseVersionSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
USTATUS parsePostcodeSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS parseCompressedSectionBody(const UModelIndex & index);
USTATUS parseGuidedSectionBody(const UModelIndex & index);
USTATUS parseVersionSectionBody(const UModelIndex & index);
USTATUS parseDepexSectionBody(const UModelIndex & index);
USTATUS parseUiSectionBody(const UModelIndex & index);
USTATUS parseRawSectionBody(const UModelIndex & index);
USTATUS parsePeImageSectionBody(const UModelIndex & index);
USTATUS parseTeImageSectionBody(const UModelIndex & index);
USTATUS parseAprioriRawSection(const UByteArray & body, UString & parsed);
bugfix
2018-04-30 13:33:19 +08:00
USTATUS findNextVolume(const UModelIndex & index, const UByteArray & bios, const UINT32 globalOffset, const UINT32 volumeOffset, UINT32 & nextVolumeOffset);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
USTATUS getVolumeSize(const UByteArray & bios, const UINT32 volumeOffset, UINT32 & volumeSize, UINT32 & bmVolumeSize);
UT NE A32 - improved parsing of volume's non-UEFI data - improved detection of top-swap for TE images - other minor fixes
2016-07-16 13:02:33 +08:00
UINT32 getFileSize(const UByteArray & volume, const UINT32 fileOffset, const UINT8 ffsVersion);
UINT32 getSectionSize(const UByteArray & file, const UINT32 sectionOffset, const UINT8 ffsVersion);
LessQt, part 1 - added wrappers over Qt classes for seamless replacement if Qt is not available - added bstrlib as submodule - only UEFIExtract works with this changes for now, others will followa bit later
2016-06-26 11:54:21 +08:00
Move fitParser to ffsParser - required to set fixed properly
2016-07-15 03:22:51 +08:00
// Second pass
USTATUS performSecondPass(const UModelIndex & index);
USTATUS addOffsetsRecursive(const UModelIndex & index);
NE Alpha 41
2017-07-09 03:31:57 +08:00
USTATUS addMemoryAddressesRecursive(const UModelIndex & index);
Move fitParser to ffsParser - required to set fixed properly
2016-07-15 03:22:51 +08:00
USTATUS addFixedAndCompressedRecursive(const UModelIndex & index);
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
USTATUS checkProtectedRanges(const UModelIndex & index);
USTATUS markProtectedRangeRecursive(const UModelIndex & index, const BG_PROTECTED_RANGE & range);
NE Alpha 41
2017-07-09 03:31:57 +08:00
USTATUS parseFit(const UModelIndex & index);
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
USTATUS parseVendorHashFile(const UByteArray & fileGuid, const UModelIndex & index);
#ifdef U_ENABLE_FIT_PARSING_SUPPORT
NE Alpha 41
2017-07-09 03:31:57 +08:00
USTATUS findFitRecursive(const UModelIndex & index, UModelIndex & found, UINT32 & fitOffset);
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
// FIT entries
USTATUS parseIntelMicrocode(const UByteArray & microcode, const UINT32 localOffset, const UModelIndex & parent, UString & info, UINT32 &realSize);
USTATUS parseIntelAcm(const UByteArray & acm, const UINT32 localOffset, const UModelIndex & parent, UString & info, UINT32 &realSize);
USTATUS parseIntelBootGuardKeyManifest(const UByteArray & keyManifest, const UINT32 localOffset, const UModelIndex & parent, UString & info, UINT32 &realSize);
USTATUS parseIntelBootGuardBootPolicy(const UByteArray & bootPolicy, const UINT32 localOffset, const UModelIndex & parent, UString & info, UINT32 &realSize);
NE Alpha 44 + support of MS Surface implementation of Intel Boot Guard + optional disabling Intel Boot Guard marking
2017-11-06 15:10:06 +08:00
USTATUS findNextElement(const UByteArray & bootPolicy, const UINT32 elementOffset, UINT32 & nextElementOffset, UINT32 & nextElementSize);
NE Alpha 43 add visual validation of Intel Boot Guard coverage
2017-10-12 13:59:23 +08:00
#endif
A45 + FFSv3 support with large files and large sections + proper names for Flash Descriptor v2 regions (#89) + better alignment calculations (#96) + improved NVRAM parser + post IBB hash support for Boot Guard + bugfixes + companion tool updated
2017-12-11 09:56:00 +08:00
#ifdef U_ENABLE_NVRAM_PARSING_SUPPORT
friend class NvramParser; // Make FFS parsing routines accessible to NvramParser
#endif
First commit of the new_engine branch - new ffsParser is done, supports FFSv3, non-UEFI data everywhere, fixed files, offsets for uncompressed data and many other things - command-line utilities are removed until the end of new engine's development
2015-03-13 14:48:53 +08:00
};
Removed '_' symbols in include guards which are violating DCL51-CPP rule, closing #46
2016-04-09 18:47:19 +08:00
#endif // FFSPARSER_H
Reference in New Issue Copy Permalink