-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
238 lines (229 loc) · 14.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>CHIPSEC 1.13.9 — CHIPSEC documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=8eb72a20" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="_static/chipsec_favicon.jpg"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contact" href="start/Contact.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="start/Contact.html" title="Contact"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">CHIPSEC documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">CHIPSEC 1.13.9</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="chipsec-1-13-9">
<h1>CHIPSEC 1.13.9<a class="headerlink" href="#chipsec-1-13-9" title="Link to this heading">¶</a></h1>
<p>CHIPSEC is a framework for analyzing platform level security of
hardware, devices, system firmware, low-level protection mechanisms, and
the configuration of various platform components.</p>
<p>It contains a set of modules, including simple tests for hardware
protections and correct configuration, tests for vulnerabilities in
firmware and platform components, security assessment and fuzzing tools
for various platform devices and interfaces, and tools acquiring
critical firmware and device artifacts.</p>
<p>CHIPSEC can run on <em>Windows</em>, <em>Linux</em>, and <em>UEFI shell</em>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Chipsec should only be used on test systems!</p>
<p>It should not be installed/deployed on production end-user systems.</p>
<p>There are multiple reasons for that:</p>
<p>1. Chipsec kernel drivers provide direct access to hardware resources to
user-mode applications (for example, access to physical memory). When installed on
production systems this could allow malware to access privileged hardware resources.</p>
<p>2. The driver is distributed as source code. In order to load it on Operating System
which requires kernel drivers to be signed (for example, 64 bit versions of
Microsoft Windows 7 and higher), it is necessary to enable TestSigning (or equivalent)
mode and sign the driver executable with test signature. Enabling TestSigning
(or equivalent) mode turns off an important OS kernel protection and should not be done
on production systems.</p>
<p>3. Due to the nature of access to hardware, if any chipsec module issues incorrect access
to hardware resources, Operating System can hang or panic.</p>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Start here</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="start/Contact.html">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="start/Download.html">Download CHIPSEC</a></li>
</ul>
</div>
<section id="installation">
<span id="installing-chipsec"></span><h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>CHIPSEC supports Windows, Linux, DAL, and UEFI shell.
Circumstances surrounding the target platform may change which of these
environments is most appropriate.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/InstallLinux.html">Linux Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/InstallWinDAL.html">DAL Windows Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/InstallWindows.html">Windows Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/USBwithUEFIShell.html">Building a Bootable USB drive with UEFI Shell (x64)</a></li>
</ul>
</div>
</section>
<section id="using-chipsec">
<h2>Using CHIPSEC<a class="headerlink" href="#using-chipsec" title="Link to this heading">¶</a></h2>
<p>CHIPSEC should be launched as Administrator/root</p>
<p>CHIPSEC will automatically attempt to create and start its service,
including load its kernel-mode driver. If CHIPSEC service is already
running then it will attempt to connect to the existing service.</p>
<p>Use <code class="docutils literal notranslate"><span class="pre">--no-driver</span></code> command-line option to skip loading the kernel
module. This option will only work for certain commands or modules.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Using CHIPSEC</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/Interpreting-Results.html">Interpreting results</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/Running-Chipsec.html">Running CHIPSEC</a></li>
</ul>
</div>
</section>
<section id="module-command-development">
<h2>Module & Command Development<a class="headerlink" href="#module-command-development" title="Link to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/Architecture-Overview.html">Architecture Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Configuration-Files.html">Configuration Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Developing.html">Writing Your Own Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/OS-Helpers-and-Drivers.html">OS Helpers and Drivers</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Platform-Detection.html">Methods for Platform Detection</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Sample-Module-Code.html">Sample module code template</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Sample-Util-Command.html">Util Command</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Vulnerabilities-and-CHIPSEC-Modules.html">CHIPSEC Modules</a></li>
</ul>
</div>
</section>
<section id="contribution-and-style-guides">
<h2>Contribution and Style Guides<a class="headerlink" href="#contribution-and-style-guides" title="Link to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contribution Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html">Python Version</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#python-coding-style-guide">Python Coding Style Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#f-strings">f-Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#type-hints">Type Hints</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#underscores-in-numeric-literals">Underscores in Numeric Literals</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#walrus-operator">Walrus Operator (:=)</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#deprecate-distutils-module-support">Deprecate distutils module support</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/sphinx.html">Sphinx Version</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/sphinx.html#generating-documentation">Generating Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/sphinx.html#references">References</a></li>
</ul>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/chipsec_logo_transparent.png" alt="Logo of CHIPSEC"/>
</a></p>
<h3><a href="#">Table of Contents</a></h3>
<p class="caption" role="heading"><span class="caption-text">Start here</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="start/Contact.html">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="start/Download.html">Download CHIPSEC</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/InstallLinux.html">Linux Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/InstallWinDAL.html">DAL Windows Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/InstallWindows.html">Windows Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/USBwithUEFIShell.html">Building a Bootable USB drive with UEFI Shell (x64)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Using CHIPSEC</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/Interpreting-Results.html">Interpreting results</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/Running-Chipsec.html">Running CHIPSEC</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Architecture and Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/Architecture-Overview.html">Architecture Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Configuration-Files.html">Configuration Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Developing.html">Writing Your Own Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/OS-Helpers-and-Drivers.html">OS Helpers and Drivers</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Platform-Detection.html">Methods for Platform Detection</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Sample-Module-Code.html">Sample module code template</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Sample-Util-Command.html">Util Command</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/Vulnerabilities-and-CHIPSEC-Modules.html">CHIPSEC Modules</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contribution Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html">Python Version</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#python-coding-style-guide">Python Coding Style Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#f-strings">f-Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#type-hints">Type Hints</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#underscores-in-numeric-literals">Underscores in Numeric Literals</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#walrus-operator">Walrus Operator (:=)</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/code-style-python.html#deprecate-distutils-module-support">Deprecate distutils module support</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/sphinx.html">Sphinx Version</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/sphinx.html#generating-documentation">Generating Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribution/sphinx.html#references">References</a></li>
</ul>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="start/Contact.html"
title="next chapter">Contact</a></p>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="start/Contact.html" title="Contact"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">CHIPSEC documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">CHIPSEC 1.13.9</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jan 29, 2025.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>