Image auditing

2021-06-24

When you run BuildWSKImg, several files are generated along with the flashable Factory OS image. Two of these files contain information about the components that are included in a Factory OS image. You can use these files to audit an as-built image's contents. These files are in the your Factory OS image's output folder:

File	Description
`<imagename>.DeviceDB.xml`	Inventory of all OS components
`<imageame>.BSPDB.xml`	Inventory of all OEM-customized components
`<imageame>.WCOSCustomizationReport.xml`	Information about customization packages in an image

These filenames will have the same name as the image they are generated with, but with different file extensions. For example:

FactoryOS_Development_AMD64_UEFI_SpacesGPT_VM.DeviceDB.xml
FactoryOS_Development_AMD64_UEFI_SpacesGPT_VM.BSPDB.xml
FactoryOS_Development_AMD64_UEFI_SpacesGPT_VM.WCOSCustomizationReport.xml

DeviceDB.xml

DeviceDB.xml files contain information about all the OS packages (packages provided by Microsoft and included in the WSK) that are included in an image. The packages that get added to an image depends on what's specified in the image configuration (OEMInput) file that's used to generate a Factory OS image. Information in DeviceDB.xml includes:

The features selected in an image
The OS packages, provided by Microsoft and included in the WSK, that make up a given image. Information about OS packages includes:
- OS package IDs
- OS package versions

When using this file to audit image contents, base your audit on the listed packages. Packages offer more granularity than features, and the packages behind a feature could change from release to release.

Sample filename: FactoryOS_Development_AMD64_UEFI_SpacesGPT_VM.DeviceDB.xml

Sample DeviceDB.xml

This is a partial DeviceDB.xml file that shows OS packages that are included in the image.

<?xml version="1.0" encoding="utf-8"?>
<CompDB xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" CreatedDate="2019-04-15T17:00:53.0428689Z" Revision="1" SchemaVersion="1.2" Product="FactoryOS" BuildID="737b6f27-951a-1b5e-f0ae-0e9b8924999b" BuildInfo="rs_prerelease.18865.1000.190322-1503" OSVersion="10.0.18865.1000" BuildArch="AMD64" ReleaseType="Test" Type="Device" BSPBuildID="00000000-0000-0000-0000-000000000000" xmlns="http://schemas.microsoft.com/embedded/2004/10/ImageUpdate">
<Tags Type="Device">
  <Tag Name="UpdateType" Value="Canonical" />
</Tags>
<Features>
    <Feature Type="MobileFeature" FeatureID="BASE" FMID="WCPFM" Group="Microsoft">
      <Packages>
        <Package ID="Microsoft.FactoryOS.WindowsCoreProductionFM~31bf3856ad364e35~AMD64~~" FIP="true" PackageType="FeaturePackage" />
      </Packages>
    </Feature>
    <Feature Type="MobileFeature" FeatureID="MS_WCOS_DEVICEPORTAL" FMID="WCPFM" Group="Microsoft">
      <Packages>
        <Package ID="WindowsDevicePortal-WCOS-Package~31bf3856ad364e35~AMD64~~" PackageType="FeaturePackage" />
        <Package ID="WindowsDevicePortal-WCOS-Package_en-us~31bf3856ad364e35~AMD64~en-us~" PackageType="FeaturePackage" />
        <Package ID="Microsoft.FactoryOS.MS_WCOS_DEVICEPORTAL.WCPFM.FIP~31bf3856ad364e35~amd64~~" FIP="true" PackageType="FeaturePackage" />
      </Packages>
    </Feature>

Each OS package is listed in this file by its PackageID. In addition to the Package ID, some packages include additional information, such as installed size and version:

    <Package ID="Microsoft-OneCore-SS-Boot-Package~31bf3856ad364e35~AMD64~~" Partition="mainos" PublicKeyToken="31bf3856ad364e35" InstalledSize="278039" Version="10.0.18865.1000">
      <Payload />
    </Package>

BSPDB.xml

BSPDB.xml files contain information about OEM customizations that are included in a Factory OS image, including:

Custom drivers added by the OEM
- Listed in the <Packages> section
- Includes information about installed drivers including version and size
Store apps included in the image
- Listed in the <AppxPackages> section
- Includes information about installed Store apps
- Lists installed dependencies
Note

Even apps that ship with the WSK are considered OEM customizations and are listed in this file. This is because Factory OS Products don't include any apps by default, and any app included in an image has been chosen by an OEM for inclusion in an image.

Sample filename: FactoryOS_Development_AMD64_UEFI_SpacesGPT_VM.BSPDB.xml

Sample BSPDB.xml file

The following snippet shows how installed drivers and installed apps appear in the BSPDB.xml file. Drivers and apps are separated into two different sections, one containing <Packages>, and one containing <AppxPackages>.

<?xml version="1.0" encoding="utf-8"?>
<CompDB xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" CreatedDate="2019-04-15T17:00:53.0428689Z" Revision="1" SchemaVersion="1.3" Product="FactoryOS" BuildID="737b6f27-951a-1b5e-f0ae-0e9b8924999b" BuildInfo="rs_prerelease.18865.1000.190322-1503" OSVersion="10.0.18865.1000" BuildArch="AMD64" ReleaseType="Test" Type="BSP" BSPVersion="" BSPProductName="Factory OS.BSP." xmlns="http://schemas.microsoft.com/embedded/2004/10/ImageUpdate">
  <Tags Type="BSP">
    <Tag Name="UpdateType" Value="Canonical" />
  </Tags>
  <Features>
    <Feature Type="DriverSet" FeatureID="BASE-DRIVERSET "Group="OEM" />
  </Features>
  <Packages>
      <Package ID="Microsoft-universalblender.inf" Partition="BSP" OwnerType="OEM" InstalledSize="42703" CompressedSize="26212" Type="DriverPackage" Version="19.7.8.216">
        <Payload />
      </Package>
  </Package>
...
  <AppX>
    <AppXPackages>
      <Package OwnerType="OEM" AppXPackageType="AppXFramework" FullName="Microsoft.VCLibs.140.00_14.0.26706.0_x64__8wekyb3d8bbwe" FamilyName="Microsoft.VCLibs.140.00_8wekyb3d8bbwe">
        <Payload>
          <PayloadItem PayloadSize="848261" Path="Appx\Frameworks\Microsoft.VCLibs.x64.14.00.appx" PayloadType="Canonical" />
        </Payload>
      </Package>
...
    </AppXPackages>
  </AppX>

WCOSCustomizationReport.xml

The WCOSCustomizationReport contains relevant information about the OEM customization packages included in an image, relative to the Microsoft OS packages that are included in the image.

The report has elements for:

Applicable customizations, customizations where the OS package exposing the customization is present.
Inapplicable customizations, customizations where the OS package exposing the customization is not present.
All Available customizations, all available customizations in the image. If any inapplicable customizations are found to be included in the image, the report will log a warning for each one.

For OEM-authored customizations, the value of each customization appears in the log for all registry settings (strings, numeric, etc.), but not file type settings.

You can disable the creation of this report to reduce image creation time. To disable the report creation, from the Windows system kit environment set the DISABLE_CUSTOMIZATION_REPORT variable to 1 prior to running BuildWSKImage:

DISABLE_CUSTOMIZATION_REPORT=1

Advanced customization settings

For settings customization files that were specified using the -advanced parameter, the settings won't appear in the "All Available Customizations" section of the log. They will, however, appear in the "Applicable Customizations" section.

Sample WCOSCustomizationReport.xml

<?xml version="1.0" encoding="utf-8"?>
<WCOSCustomizationReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/embedded/2004/10/ImageUpdate">
  <ApplicableCustomizationsAuthored>
    <Customization FeatureArea="Cellular" Name="OEM COSA Provisioning package" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableCommandPromptPage" Value="1" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableFileTransferPage" Value="1" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableManageTasklistsPage" Value="1" />
    <Customization FeatureArea="FactoryProduct" Name="HideMouseCursor" Value="1" />
    <Customization FeatureArea="OOBE" Name="OOBE_Assets" />
    <Customization FeatureArea="TextInput" Name="InputPanelImageCustomization" />
  </ApplicableCustomizationsAuthored>
  <InapplicableCustomizationsAuthored>
    <Customization FeatureArea="DisplayEnhancement" Name="DefaultAdaptiveColorAdaptationStrength" Value="66" />
    <Customization FeatureArea="DisplayEnhancement" Name="DefaultBatterySaverBrightnessMultiplier" Value="99" />
    <Customization FeatureArea="DisplayEnhancement" Name="IsAdaptiveColorOnByDefault" Value="1" />
  </InapplicableCustomizationsAuthored>
  <AllAvailableCustomizationsInThisImage>
    <Customization FeatureArea="Cellular" Name="OEM COSA Provisioning package" />
    <Customization FeatureArea="DeviceLayout" Name="SplitLayoutFile" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableCommandPromptPage" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableFileTransferPage" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableManageTasklistsPage" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableNetworkAccess" />
    <Customization FeatureArea="FactoryOrchestrator" Name="DisableUWPAppsPage" />
    <Customization FeatureArea="FactoryProduct" Name="BackgroundImagePath" />
    <Customization FeatureArea="FactoryProduct" Name="DisableSSHUser" />
    <Customization FeatureArea="FactoryProduct" Name="HideMouseCursor" />
    <Customization FeatureArea="FactoryProduct" Name="OEMVersion" />
    <Customization FeatureArea="FactoryProduct" Name="SSHPassword" />
    <Customization FeatureArea="FactoryProduct" Name="SSHUsername" />
    <Customization FeatureArea="FactoryProduct" Name="UWPLaunchOnBoot" />
    <Customization FeatureArea="OOBE" Name="OOBE_Assets" />
    <Customization FeatureArea="Start" Name="PrimaryOEMApps" />
    <Customization FeatureArea="Start" Name="SecondaryOEMApps" />
    <Customization FeatureArea="TextInput" Name="InputPanelImageCustomization" />
    <Customization FeatureArea="Theme" Name="DefaultBackgroundImage" />
    <Customization FeatureArea="Theme" Name="OEMBackgrounds" />
    <Customization FeatureArea="Theme" Name="SystemUsesLightTheme" />
  </AllAvailableCustomizationsInThisImage>
</WCOSCustomizationReport>

Share via