Merge pull request #40 from chipsec/release/1.12.8

Update to release/1.12.8
chipsec · Jan 25, 2024 · eade5d5 · eade5d5
2 parents 4fea720 + cba0886
commit eade5d5
Show file tree

Hide file tree

Showing 460 changed files with 5,216 additions and 25,902 deletions.
diff --git a/_images/browse_driver.png b/_images/browse_driver.png
diff --git a/_images/check_installed_driver.png b/_images/check_installed_driver.png
diff --git a/_images/driver_architecture.png b/_images/driver_architecture.png
diff --git a/_images/driver_dev_info.png b/_images/driver_dev_info.png
diff --git a/_images/driver_files.png b/_images/driver_files.png
diff --git a/_images/install_driver_from_disk.png b/_images/install_driver_from_disk.png
diff --git a/_images/installing_driver.png b/_images/installing_driver.png
diff --git a/_images/installing_finished.png b/_images/installing_finished.png
diff --git a/_images/pci_dump_test.png b/_images/pci_dump_test.png
diff --git a/_images/pci_enum_test.png b/_images/pci_enum_test.png
diff --git a/_images/pickup_driver.png b/_images/pickup_driver.png
diff --git a/_images/restart.png b/_images/restart.png
diff --git a/_images/update_driver.png b/_images/update_driver.png
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,10 +1,10 @@
-.. CHIPSEC documentation file, created by
+.. CHIPSEC 1.12.7 documentation file, created by
    sphinx-quickstart on Wed Mar 25 13:24:44 2015.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-CHIPSEC
-=======
+CHIPSEC 1.12.7
+==============
 
 CHIPSEC is a framework for analyzing platform level security of
 hardware, devices, system firmware, low-level protection mechanisms, and

diff --git a/_sources/installation/InstallWindows.rst.txt b/_sources/installation/InstallWindows.rst.txt
@@ -140,3 +140,136 @@ When finished running CHIPSEC stop/delete service:
 
    ``sc stop chipsec``
    ``sc delete chipsec``
+
+Windows PCI Filter Driver
+-------------------------
+
+**Filter driver background**
+
+Since July 31, 2020 Microsoft has released Windows 2020-KB4568831 (OS Build 19041.423) Preview. Microsoft recommends to not access the PCI configuration space using the legacy API, as it might result in the Windows BSOD (Blue Screen of Death). The BSOD trigger condition is “Windows version >= (OS Build 19041.423) && Secure Devices (SDEV) ACPI table && VBS enabled”. Therefore, CHIPSEC now includes a PCI filter driver which supplements the original CHIPSEC Windows Driver to access the PCI configuration space. A system requires the PCI Filter Driver if the conditions above are met.
+
+Windows devices that receive the 2020-KB4568831 (OS Build 19041.423) Preview or later updates restrict how processes
+can access peripheral component interconnect (PCI) device configuration space if a Secure Devices (SDEV) ACPI table is present
+and Virtualization-based Security (VBS) is running. Processes that have to access PCI device configuration space must use
+officially supported mechanisms.The SDEV table defines secure hardware devices in ACPI. VBS is enabled on a system if security
+features that use virtualization are enabled. Some examples of these features are Hypervisor Code Integrity or Windows Defender
+Credential Guard. The new restrictions are designed to prevent malicious processes from modifying the configuration space of
+secure devices. Device drivers or other system processes must not try to manipulate the configuration space of any PCI devices,
+except by using the Microsoft-provided bus interfaces or IRP. If a process tries to access PCI configuration space in an unsupported
+manner (such as by parsing MCFG table and mapping configuration space to virtual memory), Windows denies access to the process and
+generates a Stop error. For more detail please refer below link: https://learn.microsoft.com/en-us/troubleshoot/windows-client/performance/stop-error-lenovo-thinkpad-kb4568831-uefi
+
+
+**Filter Driver and Main Helper Driver Architecture**
+
+.. figure:: ../_images/driver_architecture.png
+   :alt: CHIPSEC Main & Filter Drvier Architecture
+   :width: 1100
+   :height: 1000
+
+   CHIPSEC Main & Filter Drvier Architecture
+
+Install PCI Filter Driver
+-------------------------
+**Locate the Filter Driver Files: chipsec/helper/windows/windows_amd64/**
+
+.. figure:: ../_images/driver_files.png
+   :alt: Check The Filter Drvier Files
+   :width: 920
+   :height: 340
+
+
+**Update The PCI Device Driver From Device Manager**
+
+.. figure:: ../_images/update_driver.png
+   :alt: Update The PCI Device Driver
+   :width: 920
+   :height: 630
+
+
+**Browse The PCI Filter Driver**
+
+ .. figure:: ../_images/browse_driver.png
+   :alt: Browse The PCI Filter Driver
+   :width: 920
+   :height: 630
+
+
+**Manually Select The PCI Bus Filter Driver**
+
+
+ .. figure:: ../_images/pickup_driver.png
+   :alt: Pickup The PCI Filter Driver
+   :width: 920
+   :height: 630
+
+
+**Install The Filter Driver From Disk**
+
+
+ .. figure:: ../_images/install_driver_from_disk.png
+   :alt: Install The Filter Driver From Disk
+   :width: 920
+   :height: 650
+
+
+**Installing The Filter Driver**
+
+ .. figure:: ../_images/installing_driver.png
+   :alt: Installing The Filter Driver
+   :width: 920
+   :height: 650
+
+
+**Finish The Filter Driver Installing**
+
+ .. figure:: ../_images/installing_finished.png
+   :alt: Finish The Filter Driver Installing
+   :width: 920
+   :height: 650
+
+**Restart Computer**
+
+ .. figure:: ../_images/restart.png
+   :alt: Restart Computer
+   :width: 920
+   :height: 420
+
+**Check The Installed Device Driver From Device Manager**
+
+ .. figure:: ../_images/check_installed_driver.png
+   :alt: Check The Installed Device Driver
+   :width: 920
+   :height: 650
+
+
+
+**Check The Driver Device Info**
+
+ .. figure:: ../_images/driver_dev_info.png
+   :alt: Check The Driver Device Info
+   :width: 700
+   :height: 700
+
+
+
+
+Filter Driver Access PCI Config Space Test
+------------------------------------------
+**Dump PCI Config Test**
+
+ .. figure:: ../_images/pci_dump_test.png
+   :alt: Dump PCI Config
+   :width: 950
+   :height: 900
+
+   ``py chipsec_util.py pci dump 0 0 0``
+
+**PCI Enumeration Test**
+ .. figure:: ../_images/pci_enum_test.png
+   :alt: PCI Enumeration Test
+   :width: 850
+   :height: 700
+
+   ``py chipsec_util.py pci enumerate``
+
diff --git a/_sources/modules/chipsec.cfg.parsers.core_parsers.rst.txt b/_sources/modules/chipsec.cfg.parsers.core_parsers.rst.txt
@@ -1,7 +1,7 @@
-chipsec.cfg.parsers.core\_parsers module
+core\_parsers module
 ========================================
 
 .. automodule:: chipsec.cfg.parsers.core_parsers
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.cfg.parsers.rst.txt b/_sources/modules/chipsec.cfg.parsers.rst.txt
@@ -1,18 +1,12 @@
-chipsec.cfg.parsers package
+parsers package
 ===========================
 
-Submodules
-----------
-
 .. toctree::
    :maxdepth: 10
 
    chipsec.cfg.parsers.core_parsers
 
-Module contents
----------------
-
 .. automodule:: chipsec.cfg.parsers
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.config.rst.txt b/_sources/modules/chipsec.config.rst.txt
@@ -1,7 +1,7 @@
-chipsec.config module
+config module
 =====================
 
 .. automodule:: chipsec.config
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.fuzzing.primitives.rst.txt b/_sources/modules/chipsec.fuzzing.primitives.rst.txt
@@ -1,7 +1,7 @@
-chipsec.fuzzing.primitives module
+primitives module
 =================================
 
 .. automodule:: chipsec.fuzzing.primitives
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.fuzzing.rst.txt b/_sources/modules/chipsec.fuzzing.rst.txt
@@ -1,18 +1,12 @@
-chipsec.fuzzing package
+fuzzing package
 =======================
 
-Submodules
-----------
-
 .. toctree::
    :maxdepth: 10
 
    chipsec.fuzzing.primitives
 
-Module contents
----------------
-
 .. automodule:: chipsec.fuzzing
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.acpi.rst.txt b/_sources/modules/chipsec.hal.acpi.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.acpi module
+acpi module
 =======================
 
 .. automodule:: chipsec.hal.acpi
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.acpi_tables.rst.txt b/_sources/modules/chipsec.hal.acpi_tables.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.acpi\_tables module
+acpi\_tables module
 ===============================
 
 .. automodule:: chipsec.hal.acpi_tables
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.cmos.rst.txt b/_sources/modules/chipsec.hal.cmos.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.cmos module
+cmos module
 =======================
 
 .. automodule:: chipsec.hal.cmos
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.cpu.rst.txt b/_sources/modules/chipsec.hal.cpu.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.cpu module
+cpu module
 ======================
 
 .. automodule:: chipsec.hal.cpu
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.cpuid.rst.txt b/_sources/modules/chipsec.hal.cpuid.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.cpuid module
+cpuid module
 ========================
 
 .. automodule:: chipsec.hal.cpuid
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.ec.rst.txt b/_sources/modules/chipsec.hal.ec.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.ec module
+ec module
 =====================
 
 .. automodule:: chipsec.hal.ec
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.hal_base.rst.txt b/_sources/modules/chipsec.hal.hal_base.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.hal\_base module
+hal\_base module
 ============================
 
 .. automodule:: chipsec.hal.hal_base
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.igd.rst.txt b/_sources/modules/chipsec.hal.igd.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.igd module
+igd module
 ======================
 
 .. automodule:: chipsec.hal.igd
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.interrupts.rst.txt b/_sources/modules/chipsec.hal.interrupts.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.interrupts module
+interrupts module
 =============================
 
 .. automodule:: chipsec.hal.interrupts
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.io.rst.txt b/_sources/modules/chipsec.hal.io.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.io module
+io module
 =====================
 
 .. automodule:: chipsec.hal.io
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.iobar.rst.txt b/_sources/modules/chipsec.hal.iobar.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.iobar module
+iobar module
 ========================
 
 .. automodule:: chipsec.hal.iobar
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.iommu.rst.txt b/_sources/modules/chipsec.hal.iommu.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.iommu module
+iommu module
 ========================
 
 .. automodule:: chipsec.hal.iommu
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+
diff --git a/_sources/modules/chipsec.hal.locks.rst.txt b/_sources/modules/chipsec.hal.locks.rst.txt
@@ -1,7 +1,7 @@
-chipsec.hal.locks module
+locks module
 ========================
 
 .. automodule:: chipsec.hal.locks
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
+
+