mirror of
https://github.com/LongSoft/UEFITool.git
synced 2024-11-22 07:58:22 +08:00
206 lines
9.3 KiB
C++
206 lines
9.3 KiB
C++
/* ffsparser.h
|
|
|
|
Copyright (c) 2017, LongSoft. All rights reserved.
|
|
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.
|
|
*/
|
|
|
|
#ifndef FFSPARSER_H
|
|
#define FFSPARSER_H
|
|
|
|
#include <vector>
|
|
|
|
#include "basetypes.h"
|
|
#include "ustring.h"
|
|
#include "ubytearray.h"
|
|
#include "treemodel.h"
|
|
#include "intel_microcode.h"
|
|
#include "ffs.h"
|
|
#include "fitparser.h"
|
|
|
|
// Region info
|
|
typedef struct REGION_INFO_ {
|
|
UINT32 offset = 0;
|
|
UINT32 length = 0;
|
|
UINT8 type = 0;
|
|
UByteArray data;
|
|
friend bool operator< (const struct REGION_INFO_ & lhs, const struct REGION_INFO_ & rhs) { return lhs.offset < rhs.offset; }
|
|
} REGION_INFO;
|
|
|
|
// BPDT partition info
|
|
typedef struct BPDT_PARTITION_INFO_ {
|
|
BPDT_ENTRY ptEntry = {};
|
|
UINT8 type = 0;
|
|
UModelIndex index;
|
|
friend bool operator< (const struct BPDT_PARTITION_INFO_ & lhs, const struct BPDT_PARTITION_INFO_ & rhs) { return lhs.ptEntry.Offset < rhs.ptEntry.Offset; }
|
|
} BPDT_PARTITION_INFO;
|
|
|
|
// CPD partition info
|
|
typedef struct CPD_PARTITION_INFO_ {
|
|
CPD_ENTRY ptEntry = {};
|
|
UINT8 type = 0;
|
|
bool hasMetaData = false;
|
|
UModelIndex index;
|
|
friend bool operator< (const struct CPD_PARTITION_INFO_ & lhs, const struct CPD_PARTITION_INFO_ & rhs) { return lhs.ptEntry.Offset.Offset < rhs.ptEntry.Offset.Offset; }
|
|
} CPD_PARTITION_INFO;
|
|
|
|
// Protected range
|
|
typedef struct PROTECTED_RANGE_ {
|
|
UINT32 Offset;
|
|
UINT32 Size;
|
|
UINT16 AlgorithmId;
|
|
UINT8 Type;
|
|
UINT8 : 8;
|
|
UByteArray Hash;
|
|
} PROTECTED_RANGE;
|
|
|
|
#define PROTECTED_RANGE_INTEL_BOOT_GUARD_IBB 0x01
|
|
#define PROTECTED_RANGE_INTEL_BOOT_GUARD_POST_IBB 0x02
|
|
#define PROTECTED_RANGE_INTEL_BOOT_GUARD_OBB 0x03
|
|
#define PROTECTED_RANGE_VENDOR_HASH_PHOENIX 0x04
|
|
#define PROTECTED_RANGE_VENDOR_HASH_AMI_V1 0x05
|
|
#define PROTECTED_RANGE_VENDOR_HASH_AMI_V2 0x06
|
|
#define PROTECTED_RANGE_VENDOR_HASH_AMI_V3 0x07
|
|
#define PROTECTED_RANGE_VENDOR_HASH_MICROSOFT_PMDA 0x08
|
|
|
|
class FitParser;
|
|
class NvramParser;
|
|
class MeParser;
|
|
|
|
class FfsParser
|
|
{
|
|
public:
|
|
// Constructor and destructor
|
|
FfsParser(TreeModel* treeModel);
|
|
~FfsParser();
|
|
|
|
// Obtain parser messages
|
|
std::vector<std::pair<UString, UModelIndex> > getMessages() const;
|
|
// Clear messages
|
|
void clearMessages() { messagesVector.clear(); }
|
|
|
|
// Parse firmware image
|
|
USTATUS parse(const UByteArray &buffer);
|
|
|
|
// Obtain parsed FIT table
|
|
std::vector<std::pair<std::vector<UString>, UModelIndex> > getFitTable() const;
|
|
|
|
// Obtain Security Info
|
|
UString getSecurityInfo() const;
|
|
|
|
// Obtain offset/address difference
|
|
UINT64 getAddressDiff() { return addressDiff; }
|
|
|
|
// Output some info to stdout
|
|
void outputInfo(void);
|
|
|
|
private:
|
|
TreeModel *model;
|
|
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));
|
|
};
|
|
|
|
FitParser* fitParser;
|
|
NvramParser* nvramParser;
|
|
MeParser* meParser;
|
|
|
|
UByteArray openedImage;
|
|
UModelIndex lastVtf;
|
|
UINT32 imageBase;
|
|
UINT64 addressDiff;
|
|
|
|
UString securityInfo;
|
|
|
|
std::vector<PROTECTED_RANGE> protectedRanges;
|
|
UINT64 protectedRegionsBase;
|
|
UModelIndex dxeCore;
|
|
|
|
// First pass
|
|
USTATUS performFirstPass(const UByteArray & imageFile, UModelIndex & index);
|
|
|
|
USTATUS parseCapsule(const UByteArray & capsule, const UINT32 localOffset, const UModelIndex & parent, 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);
|
|
|
|
USTATUS parseBpdtRegion(const UByteArray & region, const UINT32 localOffset, const UINT32 sbpdtOffsetFixup, const UModelIndex & parent, UModelIndex & index);
|
|
USTATUS parseCpdRegion(const UByteArray & region, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
|
|
USTATUS parseCpdExtensionsArea(const UModelIndex & index, const UINT32 localOffset);
|
|
USTATUS parseSignedPackageInfoData(const UModelIndex & index);
|
|
|
|
USTATUS parseRawArea(const UModelIndex & index);
|
|
USTATUS parseVolumeHeader(const UByteArray & volume, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
|
|
USTATUS parseVolumeBody(const UModelIndex & index);
|
|
USTATUS parseMicrocodeVolumeBody(const UModelIndex & index);
|
|
USTATUS parseFileHeader(const UByteArray & file, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
|
|
USTATUS parseFileBody(const UModelIndex & index);
|
|
USTATUS parseSectionHeader(const UByteArray & section, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index, const bool insertIntoTree);
|
|
USTATUS parseSectionBody(const UModelIndex & index);
|
|
|
|
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);
|
|
USTATUS parseDevExp1Region(const UByteArray & devExp1, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
|
|
USTATUS parseGenericRegion(const UINT8 subtype, const UByteArray & region, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
|
|
|
|
USTATUS parsePadFileBody(const UModelIndex & index);
|
|
USTATUS parseVolumeNonUefiData(const UByteArray & data, const UINT32 localOffset, const UModelIndex & index);
|
|
|
|
USTATUS parseSections(const UByteArray & sections, const UModelIndex & index, const bool insertIntoTree);
|
|
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);
|
|
|
|
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);
|
|
USTATUS findNextRawAreaItem(const UModelIndex & index, const UINT32 localOffset, UINT8 & nextItemType, UINT32 & nextItemOffset, UINT32 & nextItemSize, UINT32 & nextItemAlternativeSize);
|
|
UINT32 getFileSize(const UByteArray & volume, const UINT32 fileOffset, const UINT8 ffsVersion, const UINT8 revision);
|
|
UINT32 getSectionSize(const UByteArray & file, const UINT32 sectionOffset, const UINT8 ffsVersion);
|
|
|
|
USTATUS parseIntelMicrocodeHeader(const UByteArray & store, const UINT32 localOffset, const UModelIndex & parent, UModelIndex & index);
|
|
bool microcodeHeaderValid(const INTEL_MICROCODE_HEADER* ucodeHeader);
|
|
|
|
USTATUS parseVendorHashFile(const UByteArray & fileGuid, const UModelIndex & index);
|
|
|
|
// Second pass
|
|
USTATUS performSecondPass(const UModelIndex & index);
|
|
USTATUS addInfoRecursive(const UModelIndex & index);
|
|
USTATUS checkTeImageBase(const UModelIndex & index);
|
|
|
|
USTATUS checkProtectedRanges(const UModelIndex & index);
|
|
USTATUS markProtectedRangeRecursive(const UModelIndex & index, const PROTECTED_RANGE & range);
|
|
|
|
USTATUS parseResetVectorData();
|
|
|
|
#ifdef U_ENABLE_FIT_PARSING_SUPPORT
|
|
friend class FitParser; // Make FFS parsing routines accessible to FitParser
|
|
#endif
|
|
|
|
#ifdef U_ENABLE_NVRAM_PARSING_SUPPORT
|
|
friend class NvramParser; // Make FFS parsing routines accessible to NvramParser
|
|
#endif
|
|
|
|
#ifdef U_ENABLE_ME_PARSING_SUPPORT
|
|
friend class MeParser; // Make FFS parsing routines accessible to MeParser
|
|
#endif
|
|
};
|
|
|
|
#endif // FFSPARSER_H
|