BaseTools: Add authenticated variable store support

[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenVar.py

# Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
#\r
# This file is used to collect the Variable checking information\r
#\r
\r
# #\r
# Import Modules\r
#\r
from struct import pack, unpack\r
import collections\r
import copy\r
from Common.VariableAttributes import VariableAttributes\r
from Common.Misc import *\r
import collections\r
import Common.DataType as DataType\r
import Common.GlobalData as GlobalData\r
\r
var_info = collections.namedtuple("uefi_var", "pcdindex,pcdname,defaultstoragename,skuname,var_name, var_guid, var_offset,var_attribute,pcd_default_value, default_value, data_type,PcdDscLine,StructurePcd")\r
NvStorageHeaderSize = 28\r
VariableHeaderSize = 32\r
\r
class VariableMgr(object):\r
    def __init__(self, DefaultStoreMap, SkuIdMap):\r
        self.VarInfo = []\r
        self.DefaultStoreMap = DefaultStoreMap\r
        self.SkuIdMap = SkuIdMap\r
        self.VpdRegionSize = 0\r
        self.VpdRegionOffset = 0\r
        self.NVHeaderBuff = None\r
        self.VarDefaultBuff = None\r
        self.VarDeltaBuff = None\r
\r
    def append_variable(self, uefi_var):\r
        self.VarInfo.append(uefi_var)\r
\r
    def SetVpdRegionMaxSize(self, maxsize):\r
        self.VpdRegionSize = maxsize\r
\r
    def SetVpdRegionOffset(self, vpdoffset):\r
        self.VpdRegionOffset = vpdoffset\r
\r
    def PatchNVStoreDefaultMaxSize(self, maxsize):\r
        if not self.NVHeaderBuff:\r
            return ""\r
        self.NVHeaderBuff = self.NVHeaderBuff[:8] + pack("=Q", maxsize)\r
        default_var_bin = VariableMgr.format_data(self.NVHeaderBuff + self.VarDefaultBuff + self.VarDeltaBuff)\r
        value_str = "{"\r
        default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]\r
        value_str += ",".join(default_var_bin_strip)\r
        value_str += "}"\r
        return value_str\r
\r
    def combine_variable(self):\r
        indexedvarinfo = collections.OrderedDict()\r
        for item in self.VarInfo:\r
            if (item.skuname, item.defaultstoragename, item.var_name, item.var_guid) not in indexedvarinfo:\r
                indexedvarinfo[(item.skuname, item.defaultstoragename, item.var_name, item.var_guid) ] = []\r
            indexedvarinfo[(item.skuname, item.defaultstoragename, item.var_name, item.var_guid)].append(item)\r
        for key in indexedvarinfo:\r
            sku_var_info_offset_list = indexedvarinfo[key]\r
            sku_var_info_offset_list.sort(key=lambda x:x.PcdDscLine)\r
            FirstOffset = int(sku_var_info_offset_list[0].var_offset, 16) if sku_var_info_offset_list[0].var_offset.upper().startswith("0X") else int(sku_var_info_offset_list[0].var_offset)\r
            fisrtvalue_list = sku_var_info_offset_list[0].default_value.strip("{").strip("}").split(",")\r
            firstdata_type = sku_var_info_offset_list[0].data_type\r
            if firstdata_type in DataType.TAB_PCD_NUMERIC_TYPES:\r
                fisrtdata_flag = DataType.PACK_CODE_BY_SIZE[MAX_SIZE_TYPE[firstdata_type]]\r
                fisrtdata = fisrtvalue_list[0]\r
                fisrtvalue_list = []\r
                pack_data = pack(fisrtdata_flag, int(fisrtdata, 0))\r
                for data_byte in range(len(pack_data)):\r
                    fisrtvalue_list.append(hex(unpack("B", pack_data[data_byte:data_byte + 1])[0]))\r
            newvalue_list = ["0x00"] * FirstOffset + fisrtvalue_list\r
\r
            for var_item in sku_var_info_offset_list[1:]:\r
                CurOffset = int(var_item.var_offset, 16) if var_item.var_offset.upper().startswith("0X") else int(var_item.var_offset)\r
                CurvalueList = var_item.default_value.strip("{").strip("}").split(",")\r
                Curdata_type = var_item.data_type\r
                if Curdata_type in DataType.TAB_PCD_NUMERIC_TYPES:\r
                    data_flag = DataType.PACK_CODE_BY_SIZE[MAX_SIZE_TYPE[Curdata_type]]\r
                    data = CurvalueList[0]\r
                    CurvalueList = []\r
                    pack_data = pack(data_flag, int(data, 0))\r
                    for data_byte in range(len(pack_data)):\r
                        CurvalueList.append(hex(unpack("B", pack_data[data_byte:data_byte + 1])[0]))\r
                if CurOffset > len(newvalue_list):\r
                    newvalue_list = newvalue_list + ["0x00"] * (CurOffset - len(newvalue_list)) + CurvalueList\r
                else:\r
                    newvalue_list[CurOffset : CurOffset + len(CurvalueList)] = CurvalueList\r
\r
            newvaluestr =  "{" + ",".join(newvalue_list) +"}"\r
            n = sku_var_info_offset_list[0]\r
            indexedvarinfo[key] =  [var_info(n.pcdindex, n.pcdname, n.defaultstoragename, n.skuname, n.var_name, n.var_guid, "0x00", n.var_attribute, newvaluestr, newvaluestr, DataType.TAB_VOID,n.PcdDscLine,n.StructurePcd)]\r
        self.VarInfo = [item[0] for item in list(indexedvarinfo.values())]\r
\r
    def process_variable_data(self):\r
\r
        var_data = collections.defaultdict(collections.OrderedDict)\r
\r
        indexedvarinfo = collections.OrderedDict()\r
        for item in self.VarInfo:\r
            if item.pcdindex not in indexedvarinfo:\r
                indexedvarinfo[item.pcdindex] = dict()\r
            indexedvarinfo[item.pcdindex][(item.skuname, item.defaultstoragename)] = item\r
\r
        for index in indexedvarinfo:\r
            sku_var_info = indexedvarinfo[index]\r
\r
            default_data_buffer = ""\r
            others_data_buffer = ""\r
            tail = None\r
            default_sku_default = indexedvarinfo[index].get((DataType.TAB_DEFAULT, DataType.TAB_DEFAULT_STORES_DEFAULT))\r
\r
            if default_sku_default.data_type not in DataType.TAB_PCD_NUMERIC_TYPES:\r
                var_max_len = max(len(var_item.default_value.split(",")) for var_item in sku_var_info.values())\r
                if len(default_sku_default.default_value.split(",")) < var_max_len:\r
                    tail = ",".join("0x00" for i in range(var_max_len-len(default_sku_default.default_value.split(","))))\r
\r
            default_data_buffer = VariableMgr.PACK_VARIABLES_DATA(default_sku_default.default_value, default_sku_default.data_type, tail)\r
\r
            default_data_array = ()\r
            for item in range(len(default_data_buffer)):\r
                default_data_array += unpack("B", default_data_buffer[item:item + 1])\r
\r
            var_data[(DataType.TAB_DEFAULT, DataType.TAB_DEFAULT_STORES_DEFAULT)][index] = (default_data_buffer, sku_var_info[(DataType.TAB_DEFAULT, DataType.TAB_DEFAULT_STORES_DEFAULT)])\r
\r
            for (skuid, defaultstoragename) in indexedvarinfo[index]:\r
                tail = None\r
                if (skuid, defaultstoragename) == (DataType.TAB_DEFAULT, DataType.TAB_DEFAULT_STORES_DEFAULT):\r
                    continue\r
                other_sku_other = indexedvarinfo[index][(skuid, defaultstoragename)]\r
\r
                if default_sku_default.data_type not in DataType.TAB_PCD_NUMERIC_TYPES:\r
                    if len(other_sku_other.default_value.split(",")) < var_max_len:\r
                        tail = ",".join("0x00" for i in range(var_max_len-len(other_sku_other.default_value.split(","))))\r
\r
                others_data_buffer = VariableMgr.PACK_VARIABLES_DATA(other_sku_other.default_value, other_sku_other.data_type, tail)\r
\r
                others_data_array = ()\r
                for item in range(len(others_data_buffer)):\r
                    others_data_array += unpack("B", others_data_buffer[item:item + 1])\r
\r
                data_delta = VariableMgr.calculate_delta(default_data_array, others_data_array)\r
\r
                var_data[(skuid, defaultstoragename)][index] = (data_delta, sku_var_info[(skuid, defaultstoragename)])\r
        return var_data\r
\r
    def new_process_varinfo(self):\r
        self.combine_variable()\r
\r
        var_data = self.process_variable_data()\r
\r
        if not var_data:\r
            return []\r
\r
        pcds_default_data = var_data.get((DataType.TAB_DEFAULT, DataType.TAB_DEFAULT_STORES_DEFAULT), {})\r
        NvStoreDataBuffer = bytearray()\r
        var_data_offset = collections.OrderedDict()\r
        offset = NvStorageHeaderSize\r
        for default_data, default_info in pcds_default_data.values():\r
            var_name_buffer = VariableMgr.PACK_VARIABLE_NAME(default_info.var_name)\r
\r
            vendorguid = default_info.var_guid.split('-')\r
\r
            if default_info.var_attribute:\r
                var_attr_value, _ = VariableAttributes.GetVarAttributes(default_info.var_attribute)\r
            else:\r
                var_attr_value = 0x07\r
\r
            DataBuffer = VariableMgr.AlignData(var_name_buffer + default_data)\r
\r
            data_size = len(DataBuffer)\r
            offset += VariableHeaderSize + len(default_info.var_name.split(","))\r
            var_data_offset[default_info.pcdindex] = offset\r
            offset += data_size - len(default_info.var_name.split(","))\r
            if GlobalData.gCommandLineDefines.get(TAB_DSC_DEFINES_VPD_AUTHENTICATED_VARIABLE_STORE,"FALSE").upper() == "TRUE":\r
                var_header_buffer = VariableMgr.PACK_AUTHENTICATED_VARIABLE_HEADER(var_attr_value, len(default_info.var_name.split(",")), len (default_data), vendorguid)\r
            else:\r
                var_header_buffer = VariableMgr.PACK_VARIABLE_HEADER(var_attr_value, len(default_info.var_name.split(",")), len (default_data), vendorguid)\r
            NvStoreDataBuffer += (var_header_buffer + DataBuffer)\r
\r
        if GlobalData.gCommandLineDefines.get(TAB_DSC_DEFINES_VPD_AUTHENTICATED_VARIABLE_STORE,"FALSE").upper() == "TRUE":\r
            variable_storage_header_buffer = VariableMgr.PACK_AUTHENTICATED_VARIABLE_STORE_HEADER(len(NvStoreDataBuffer) + 28)\r
        else:\r
            variable_storage_header_buffer = VariableMgr.PACK_VARIABLE_STORE_HEADER(len(NvStoreDataBuffer) + 28)\r
\r
        nv_default_part = VariableMgr.AlignData(VariableMgr.PACK_DEFAULT_DATA(0, 0, VariableMgr.unpack_data(variable_storage_header_buffer+NvStoreDataBuffer)), 8)\r
\r
        data_delta_structure_buffer = bytearray()\r
        for skuname, defaultstore in var_data:\r
            if (skuname, defaultstore) == (DataType.TAB_DEFAULT, DataType.TAB_DEFAULT_STORES_DEFAULT):\r
                continue\r
            pcds_sku_data = var_data[(skuname, defaultstore)]\r
            delta_data_set = []\r
            for pcdindex in pcds_sku_data:\r
                offset = var_data_offset[pcdindex]\r
                delta_data, _ = pcds_sku_data[pcdindex]\r
                delta_data = [(item[0] + offset, item[1]) for item in delta_data]\r
                delta_data_set.extend(delta_data)\r
\r
            data_delta_structure_buffer += VariableMgr.AlignData(self.PACK_DELTA_DATA(skuname, defaultstore, delta_data_set), 8)\r
\r
        size = len(nv_default_part + data_delta_structure_buffer) + 16\r
        maxsize = self.VpdRegionSize if self.VpdRegionSize else size\r
        NV_Store_Default_Header = VariableMgr.PACK_NV_STORE_DEFAULT_HEADER(size, maxsize)\r
\r
        self.NVHeaderBuff =  NV_Store_Default_Header\r
        self.VarDefaultBuff =nv_default_part\r
        self.VarDeltaBuff =  data_delta_structure_buffer\r
        return VariableMgr.format_data(NV_Store_Default_Header + nv_default_part + data_delta_structure_buffer)\r
\r
\r
    @staticmethod\r
    def format_data(data):\r
        return  [hex(item) for item in VariableMgr.unpack_data(data)]\r
\r
    @staticmethod\r
    def unpack_data(data):\r
        final_data = ()\r
        for item in range(len(data)):\r
            final_data += unpack("B", data[item:item + 1])\r
        return final_data\r
\r
    @staticmethod\r
    def calculate_delta(default, theother):\r
        if len(default) - len(theother) != 0:\r
            EdkLogger.error("build", FORMAT_INVALID, 'The variable data length is not the same for the same PCD.')\r
        data_delta = []\r
        for i in range(len(default)):\r
            if default[i] != theother[i]:\r
                data_delta.append((i, theother[i]))\r
        return data_delta\r
\r
    def dump(self):\r
\r
        default_var_bin = self.new_process_varinfo()\r
        if default_var_bin:\r
            value_str = "{"\r
            default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]\r
            value_str += ",".join(default_var_bin_strip)\r
            value_str += "}"\r
            return value_str\r
        return ""\r
\r
    @staticmethod\r
    def PACK_VARIABLE_STORE_HEADER(size):\r
        #Signature: gEfiVariableGuid\r
        Guid = "{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}"\r
        Guid = GuidStructureStringToGuidString(Guid)\r
        GuidBuffer = PackGUID(Guid.split('-'))\r
\r
        SizeBuffer = pack('=L', size)\r
        FormatBuffer = pack('=B', 0x5A)\r
        StateBuffer = pack('=B', 0xFE)\r
        reservedBuffer = pack('=H', 0)\r
        reservedBuffer += pack('=L', 0)\r
\r
        return GuidBuffer + SizeBuffer + FormatBuffer + StateBuffer + reservedBuffer\r
\r
    def PACK_AUTHENTICATED_VARIABLE_STORE_HEADER(size):\r
        #Signature: gEfiAuthenticatedVariableGuid\r
        Guid = "{ 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 }}"\r
        Guid = GuidStructureStringToGuidString(Guid)\r
        GuidBuffer = PackGUID(Guid.split('-'))\r
\r
        SizeBuffer = pack('=L', size)\r
        FormatBuffer = pack('=B', 0x5A)\r
        StateBuffer = pack('=B', 0xFE)\r
        reservedBuffer = pack('=H', 0)\r
        reservedBuffer += pack('=L', 0)\r
\r
        return GuidBuffer + SizeBuffer + FormatBuffer + StateBuffer + reservedBuffer\r
\r
    @staticmethod\r
    def PACK_NV_STORE_DEFAULT_HEADER(size, maxsize):\r
        Signature = pack('=B', ord('N'))\r
        Signature += pack("=B", ord('S'))\r
        Signature += pack("=B", ord('D'))\r
        Signature += pack("=B", ord('B'))\r
\r
        SizeBuffer = pack("=L", size)\r
        MaxSizeBuffer = pack("=Q", maxsize)\r
\r
        return Signature + SizeBuffer + MaxSizeBuffer\r
\r
    @staticmethod\r
    def PACK_VARIABLE_HEADER(attribute, namesize, datasize, vendorguid):\r
\r
        Buffer = pack('=H', 0x55AA) # pack StartID\r
        Buffer += pack('=B', 0x3F)  # pack State\r
        Buffer += pack('=B', 0)     # pack reserved\r
\r
        Buffer += pack('=L', attribute)\r
        Buffer += pack('=L', namesize)\r
        Buffer += pack('=L', datasize)\r
\r
        Buffer += PackGUID(vendorguid)\r
\r
        return Buffer\r
\r
    @staticmethod\r
    def PACK_AUTHENTICATED_VARIABLE_HEADER(attribute, namesize, datasize, vendorguid):\r
\r
        Buffer = pack('=H', 0x55AA)    # pack StartID\r
        Buffer += pack('=B', 0x3F)     # pack State\r
        Buffer += pack('=B', 0)        # pack reserved\r
\r
        Buffer += pack('=L', attribute)\r
\r
        Buffer += pack('=Q', 0)        # pack MonotonicCount\r
        Buffer += pack('=HBBBBBBLhBB', # pack TimeStamp\r
                         0,            # UINT16 Year\r
                         0,            # UINT8  Month\r
                         0,            # UINT8  Day\r
                         0,            # UINT8  Hour\r
                         0,            # UINT8  Minute\r
                         0,            # UINT8  Second\r
                         0,            # UINT8  Pad1\r
                         0,            # UINT32 Nanosecond\r
                         0,            # INT16  TimeZone\r
                         0,            # UINT8  Daylight\r
                         0)            # UINT8  Pad2\r
        Buffer += pack('=L', 0)        # pack PubKeyIndex\r
\r
        Buffer += pack('=L', namesize)\r
        Buffer += pack('=L', datasize)\r
\r
        Buffer += PackGUID(vendorguid)\r
\r
        return Buffer\r
\r
    @staticmethod\r
    def PACK_VARIABLES_DATA(var_value,data_type, tail = None):\r
        Buffer = bytearray()\r
        data_len = 0\r
        if data_type == DataType.TAB_VOID:\r
            for value_char in var_value.strip("{").strip("}").split(","):\r
                Buffer += pack("=B", int(value_char, 16))\r
            data_len += len(var_value.split(","))\r
            if tail:\r
                for value_char in tail.split(","):\r
                    Buffer += pack("=B", int(value_char, 16))\r
                data_len += len(tail.split(","))\r
        elif data_type == "BOOLEAN":\r
            Buffer += pack("=B", True) if var_value.upper() in ["TRUE","1"] else pack("=B", False)\r
            data_len += 1\r
        elif data_type  == DataType.TAB_UINT8:\r
            Buffer += pack("=B", GetIntegerValue(var_value))\r
            data_len += 1\r
        elif data_type == DataType.TAB_UINT16:\r
            Buffer += pack("=H", GetIntegerValue(var_value))\r
            data_len += 2\r
        elif data_type == DataType.TAB_UINT32:\r
            Buffer += pack("=L", GetIntegerValue(var_value))\r
            data_len += 4\r
        elif data_type == DataType.TAB_UINT64:\r
            Buffer += pack("=Q", GetIntegerValue(var_value))\r
            data_len += 8\r
\r
        return Buffer\r
\r
    @staticmethod\r
    def PACK_DEFAULT_DATA(defaultstoragename, skuid, var_value):\r
        Buffer = bytearray()\r
        Buffer += pack("=L", 4+8+8)\r
        Buffer += pack("=Q", int(skuid))\r
        Buffer += pack("=Q", int(defaultstoragename))\r
\r
        for item in var_value:\r
            Buffer += pack("=B", item)\r
\r
        Buffer = pack("=L", len(Buffer)+4) + Buffer\r
\r
        return Buffer\r
\r
    def GetSkuId(self, skuname):\r
        if skuname not in self.SkuIdMap:\r
            return None\r
        return self.SkuIdMap.get(skuname)[0]\r
\r
    def GetDefaultStoreId(self, dname):\r
        if dname not in self.DefaultStoreMap:\r
            return None\r
        return self.DefaultStoreMap.get(dname)[0]\r
\r
    def PACK_DELTA_DATA(self, skuname, defaultstoragename, delta_list):\r
        skuid = self.GetSkuId(skuname)\r
        defaultstorageid = self.GetDefaultStoreId(defaultstoragename)\r
        Buffer = bytearray()\r
        Buffer += pack("=L", 4+8+8)\r
        Buffer += pack("=Q", int(skuid))\r
        Buffer += pack("=Q", int(defaultstorageid))\r
        for (delta_offset, value) in delta_list:\r
            Buffer += pack("=L", delta_offset)\r
            Buffer = Buffer[:-1] + pack("=B", value)\r
\r
        Buffer = pack("=L", len(Buffer) + 4) + Buffer\r
\r
        return Buffer\r
\r
    @staticmethod\r
    def AlignData(data, align = 4):\r
        mybuffer = data\r
        if (len(data) % align) > 0:\r
            for i in range(align - (len(data) % align)):\r
                mybuffer += pack("=B", 0)\r
\r
        return mybuffer\r
\r
    @staticmethod\r
    def PACK_VARIABLE_NAME(var_name):\r
        Buffer = bytearray()\r
        for name_char in var_name.strip("{").strip("}").split(","):\r
            Buffer += pack("=B", int(name_char, 16))\r
\r
        return Buffer\r