Skip to content

Commit 6324ee9

Browse files
ChipSecnpmitche
authored andcommitted
Update to release/1.13.20
Signed-off-by: ChipSec <sys_chipsec@intel.com>
1 parent 2110bf6 commit 6324ee9

261 files changed

Lines changed: 1260 additions & 548 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_sources/index.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. CHIPSEC 1.13.19 documentation file, created by
1+
.. CHIPSEC 1.13.20 documentation file, created by
22
sphinx-quickstart on Wed Mar 25 13:24:44 2015.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
CHIPSEC 1.13.19
6+
CHIPSEC 1.13.20
77
===============
88

99
CHIPSEC is a framework for analyzing platform level security of
Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
.. _Windows-Exceptions:
2+
3+
Windows Exception Errors
4+
========================
5+
6+
Windows exception errors have many different causes and at least as many possible solutions.
7+
The below 'fixes' may need to be used in combination to fix any of these issues.
8+
9+
10+
STATUS_PRIVILEGED_INSTRUCTION (0xC0000096)
11+
------------------------------------------
12+
13+
This type of error often occurs on newer Windows OSes, often caused by the Windows `Device Guard` feature.
14+
THIS IS A KNOWN ISSUE WITH WINDOWS AND NOT A CHIPSEC BUG.
15+
16+
For CHIPSEC to work, the Windows `Device Guard` feature needs to be disabled.
17+
18+
Example errors:
19+
20+
::
21+
22+
ERROR: HW Access Violation: DeviceIoControl returned STATUS_PRIVILEGED_INSTRUCTION (0xC0000096)
23+
24+
chipsec.helper.oshelper.HWAccessViolationError: HW Access Violation: DeviceIoControl returned STATUS_PRIVILEGED_INSTRUCTION (0xC0000096)
25+
26+
27+
**Device Guard and Credential Guard hardware readiness tool**
28+
29+
`Device Guard and Credential Guard hardware readiness tool <https://www.microsoft.com/en-us/download/details.aspx?id=53337>`_
30+
31+
Steps to disable Device Guard:
32+
#. Download the Microsoft `Device Guard and Credential Guard hardware readiness tool`
33+
#. Extract zip contents
34+
#. Run this command (via PowerShell): ``DG_Readiness.ps1 -Disable``
35+
#. Reboot system and press **<F3>** when prompted (twice)
36+
#. May take several reboots before finishing
37+
38+
.. note::
39+
40+
Microsoft seems to no longer use “Device Guard”, instead now uses WDAC (Windows Defender Application Control).
41+
42+
43+
**If the readiness tool doesn't work...**
44+
45+
Workaround:
46+
47+
1. Launch `Local Group Policy Editor`
48+
49+
a. Run -> ``gpedit.msc``
50+
51+
2. Change `Device Guard` setting to `Disabled`
52+
53+
a. Computer Configuration > Administrative Templates > System > Device Guard
54+
b. Switch `Device Guard` from "Not Configured" to "Disabled"
55+
56+
3. Save changes and exit `Group Policy Editor`
57+
58+
4. Reboot
59+
60+
.. note::
61+
62+
Windows Home version may NOT have `Group Policy Editor` loaded by default.
63+
64+
65+
**Windows Home workaround:**
66+
67+
There is no guarantee that these steps will work. If they don't, it is recommended to use `Windows Pro` or `Windows Enterprise` versions that include the `Group Policy Editor`.
68+
69+
1. From a Windows PowerShell, `Run as Administrator`, run these commands sequentially:
70+
71+
::
72+
73+
FOR %F IN ("%SystemRoot%\servicing\Packages\Microsoft-Windows-GroupPolicy-ClientTools-Package~*.mum") DO (
74+
DISM /Online /NoRestart /Add-Package:"%F"
75+
)
76+
77+
FOR %F IN ("%SystemRoot%\servicing\Packages\Microsoft-Windows-GroupPolicy-ClientExtensions-Package~*.mum") DO (
78+
DISM /Online /NoRestart /Add-Package:"%F"
79+
)
80+
81+
2. After these commands complete, reboot the system. The `Group Policy Editor` should now be installed and ready to run the above steps to disable `Device Guard`.
82+
83+
.. note::
84+
85+
Occasionally Windows does not include the needed `Administrative template` for `Device Guard` to be visible and the template will have to be updated.
86+
In this case, download the below update and run it on the system. Reboot the system and verify that `Device Guard` is now visible.
87+
88+
Updated Windows 10 Administrative Template:
89+
https://www.microsoft.com/en-us/download/100591
90+
91+
It is possible that the template update does NOT have the needed permissions to properly update the template.
92+
A manual update may be needed. Don't forget to reboot after.
93+
94+
3. Manually copy the **.admx** and **.adml** files from the update folder
95+
**C:\\Program Files (x86)\\Microsoft Group Policy\\Windows 10 November 2019 Update (1909)\\PolicyDefinitions\\** to **C:\\Windows\\PolicyDefinitions**
96+
97+
If this last step does not work, you will have to use a different OS.
98+
99+
100+
**ERROR: Exception occurred during …**
101+
102+
This error, like the previous issue, appears to be related to a Windows Server OS and its security protections. Often happening when trying to read an MSR, MMIO, or device.
103+
Windows Server OS appears to be blocking read access to them. MSR and MMIO reads will simply fail with this error message.
104+
Device (PCI) reads appear to mask the device and return all 0xF's, causing an error parsing them.
105+
106+
One or more of the above mentioned solutions *may* fix this.
107+
108+
Example MSR/MMIO error:
109+
110+
::
111+
112+
ERROR: Exception occurred during chipsec.modules.common.smm_dma.run(): ''TSEGMB''
113+
114+
Example PCI error:
115+
116+
::
117+
118+
ERROR: Exception occurred during chipsec.modules.common.bios_smi.run(): 'integer out of range for 'H' format code'
119+
120+
121+
Windows driver: StartService error
122+
----------------------------------
123+
124+
A Windows security feature called HVCI can cause issues running CHIPSEC. HVCI should be disabled.
125+
Follow the steps described above to disable HVCI.
126+
127+
Follow these steps to disable HVCI:
128+
129+
`How to disable HVCI <https://docs.microsoft.com/en-us/windows/security/threat-protection/device-guard/enable-virtualization-based-protection-of-code-integrity#how-to-turn-off-hvci>`_
130+
131+
`Full details on HVCI <https://docs.microsoft.com/en-us/windows/security/threat-protection/device-guard/enable-virtualization-based-protection-of-code-integrity>`_
132+
133+
134+
Example error messages:
135+
136+
::
137+
138+
ERROR: service 'chipsec' didn't start: The parameter is incorrect. (87)
139+
[-] Traceback (most recent call last):
140+
File "\chipsec\helper\win\win32helper.py", line 434, in start
141+
win32serviceutil.StartService( SERVICE_NAME )
142+
File "\lib\site-packages\win32\lib\win32serviceutil.py", line 417, in StartService
143+
win32service.StartService(hs, args)
144+
pywintypes.error: (87, 'StartService', 'The parameter is incorrect.')
145+
146+
147+
And...
148+
149+
::
150+
151+
chipsec.helper.oshelper.OsHelperError: service 'chipsec' didn't start: The parameter is incorrect. (87)
152+
153+
154+
155+
Additional details
156+
------------------
157+
158+
`Windows Device Guard <https://docs.microsoft.com/en-us/windows/security/threat-protection/device-guard/introduction-to-device-guard-virtualization-based-security-and-windows-defender-application-control>`_
159+
160+
`Windows Credential Guard <https://docs.microsoft.com/en-us/windows/security/identity-protection/credential-guard/credential-guard>`_
161+
162+
`WDAC – Windows Defender Application Control <https://docs.microsoft.com/en-us/windows/security/threat-protection/windows-defender-application-control/windows-defender-application-control>`_
163+
164+
`Hypervisor-Protected Code Integrity (HVCI) <https://docs.microsoft.com/en-us/windows-hardware/drivers/bringup/device-guard-and-credential-guard>`_
165+
166+

contribution/code-style-python.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -546,6 +546,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
546546
<ul>
547547
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
548548
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
549+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
549550
</ul>
550551
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
551552
<ul>
@@ -616,8 +617,8 @@ <h3>Navigation</h3>
616617
</ul>
617618
</div>
618619
<div class="footer" role="contentinfo">
619-
Last updated on Dec 09, 2025.
620-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
620+
Last updated on Jan 30, 2026.
621+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
621622
</div>
622623
</body>
623624
</html>

contribution/sphinx.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
9494
<ul>
9595
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
9696
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
97+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
9798
</ul>
9899
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
99100
<ul>
@@ -156,8 +157,8 @@ <h3>Navigation</h3>
156157
</ul>
157158
</div>
158159
<div class="footer" role="contentinfo">
159-
Last updated on Dec 09, 2025.
160-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
160+
Last updated on Jan 30, 2026.
161+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
161162
</div>
162163
</body>
163164
</html>

development/Architecture-Overview.html

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<link rel="index" title="Index" href="../genindex.html" />
1818
<link rel="search" title="Search" href="../search.html" />
1919
<link rel="next" title="chipsec.utilcmd package" href="../modules/chipsec.utilcmd.html" />
20-
<link rel="prev" title="Running CHIPSEC" href="../usage/Running-Chipsec.html" />
20+
<link rel="prev" title="Windows Exception Errors" href="../usage/Windows-Exceptions.html" />
2121
</head><body>
2222
<div class="related" role="navigation" aria-label="Related">
2323
<h3>Navigation</h3>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<a href="../modules/chipsec.utilcmd.html" title="chipsec.utilcmd package"
3333
accesskey="N">next</a> |</li>
3434
<li class="right" >
35-
<a href="../usage/Running-Chipsec.html" title="Running CHIPSEC"
35+
<a href="../usage/Windows-Exceptions.html" title="Windows Exception Errors"
3636
accesskey="P">previous</a> |</li>
3737
<li class="nav-item nav-item-0"><a href="../index.html">CHIPSEC documentation</a> &#187;</li>
3838
<li class="nav-item nav-item-this"><a href="">Architecture Overview</a></li>
@@ -47,7 +47,7 @@ <h3>Navigation</h3>
4747
<section id="architecture-overview">
4848
<h1>Architecture Overview<a class="headerlink" href="#architecture-overview" title="Link to this heading"></a></h1>
4949
<figure class="align-default" id="id1">
50-
<a class="reference internal image-reference" href="../_images/architecture.png"><img alt="CHIPSEC Architecture" src="../_images/architecture.png" style="width: 1100px; height: 600px;" />
50+
<a class="reference internal image-reference" href="../_images/architecture.png"><img alt="CHIPSEC Architecture" height="600" src="../_images/architecture.png" width="1100" />
5151
</a>
5252
<figcaption>
5353
<p><span class="caption-text">CHIPSEC Architecture</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
@@ -293,6 +293,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
293293
<ul>
294294
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
295295
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
296+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
296297
</ul>
297298
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
298299
<ul class="current">
@@ -321,8 +322,8 @@ <h3><a href="../index.html">Table of Contents</a></h3>
321322

322323
<div>
323324
<h4>Previous topic</h4>
324-
<p class="topless"><a href="../usage/Running-Chipsec.html"
325-
title="previous chapter">Running CHIPSEC</a></p>
325+
<p class="topless"><a href="../usage/Windows-Exceptions.html"
326+
title="previous chapter">Windows Exception Errors</a></p>
326327
</div>
327328
<div>
328329
<h4>Next topic</h4>
@@ -356,15 +357,15 @@ <h3>Navigation</h3>
356357
<a href="../modules/chipsec.utilcmd.html" title="chipsec.utilcmd package"
357358
>next</a> |</li>
358359
<li class="right" >
359-
<a href="../usage/Running-Chipsec.html" title="Running CHIPSEC"
360+
<a href="../usage/Windows-Exceptions.html" title="Windows Exception Errors"
360361
>previous</a> |</li>
361362
<li class="nav-item nav-item-0"><a href="../index.html">CHIPSEC documentation</a> &#187;</li>
362363
<li class="nav-item nav-item-this"><a href="">Architecture Overview</a></li>
363364
</ul>
364365
</div>
365366
<div class="footer" role="contentinfo">
366-
Last updated on Dec 09, 2025.
367-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
367+
Last updated on Jan 30, 2026.
368+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
368369
</div>
369370
</body>
370371
</html>

development/Configuration-Files.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
174174
<ul>
175175
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
176176
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
177+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
177178
</ul>
178179
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
179180
<ul class="current">
@@ -244,8 +245,8 @@ <h3>Navigation</h3>
244245
</ul>
245246
</div>
246247
<div class="footer" role="contentinfo">
247-
Last updated on Dec 09, 2025.
248-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
248+
Last updated on Jan 30, 2026.
249+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
249250
</div>
250251
</body>
251252
</html>

development/Developing.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
122122
<ul>
123123
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
124124
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
125+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
125126
</ul>
126127
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
127128
<ul class="current">
@@ -192,8 +193,8 @@ <h3>Navigation</h3>
192193
</ul>
193194
</div>
194195
<div class="footer" role="contentinfo">
195-
Last updated on Dec 09, 2025.
196-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
196+
Last updated on Jan 30, 2026.
197+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
197198
</div>
198199
</body>
199200
</html>

development/OS-Helpers-and-Drivers.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
119119
<ul>
120120
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
121121
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
122+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
122123
</ul>
123124
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
124125
<ul class="current">
@@ -189,8 +190,8 @@ <h3>Navigation</h3>
189190
</ul>
190191
</div>
191192
<div class="footer" role="contentinfo">
192-
Last updated on Dec 09, 2025.
193-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
193+
Last updated on Jan 30, 2026.
194+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
194195
</div>
195196
</body>
196197
</html>

development/Platform-Detection.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
9393
<ul>
9494
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
9595
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
96+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
9697
</ul>
9798
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
9899
<ul class="current">
@@ -163,8 +164,8 @@ <h3>Navigation</h3>
163164
</ul>
164165
</div>
165166
<div class="footer" role="contentinfo">
166-
Last updated on Dec 09, 2025.
167-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
167+
Last updated on Jan 30, 2026.
168+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
168169
</div>
169170
</body>
170171
</html>

development/Sample-Module-Code.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
102102
<ul>
103103
<li class="toctree-l1"><a class="reference internal" href="../usage/Interpreting-Results.html">Interpreting results</a></li>
104104
<li class="toctree-l1"><a class="reference internal" href="../usage/Running-Chipsec.html">Running CHIPSEC</a></li>
105+
<li class="toctree-l1"><a class="reference internal" href="../usage/Windows-Exceptions.html">Windows Exception Errors</a></li>
105106
</ul>
106107
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
107108
<ul class="current">
@@ -172,8 +173,8 @@ <h3>Navigation</h3>
172173
</ul>
173174
</div>
174175
<div class="footer" role="contentinfo">
175-
Last updated on Dec 09, 2025.
176-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.4.
176+
Last updated on Jan 30, 2026.
177+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
177178
</div>
178179
</body>
179180
</html>

0 commit comments

Comments
 (0)