mirror of
https://github.com/chipsec/chipsec
synced 2026-06-08 13:31:00 +00:00
Frinzell, Aaron
104 lines
3.0 KiB
ReStructuredText
104 lines
3.0 KiB
ReStructuredText
.. CHIPSEC 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 is a framework for analyzing platform level security of
|
|
hardware, devices, system firmware, low-level protection mechanisms, and
|
|
the configuration of various platform components.
|
|
|
|
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.
|
|
|
|
CHIPSEC can run on *Windows*, *Linux*, and *UEFI shell*.
|
|
|
|
.. warning::
|
|
|
|
Chipsec should only be used on test systems!
|
|
|
|
It should not be installed/deployed on production end-user systems.
|
|
|
|
There are multiple reasons for that:
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Start here
|
|
|
|
start/*
|
|
|
|
.. _Installing-Chipsec:
|
|
|
|
Installation
|
|
------------
|
|
|
|
CHIPSEC supports Windows, Linux, DAL, and UEFI shell.
|
|
Circumstances surrounding the target platform may change which of these
|
|
environments is most appropriate.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Installation
|
|
|
|
installation/*
|
|
|
|
Using CHIPSEC
|
|
-------------
|
|
|
|
CHIPSEC should be launched as Administrator/root
|
|
|
|
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.
|
|
|
|
Use ``--no-driver`` command-line option to skip loading the kernel
|
|
module. This option will only work for certain commands or modules.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Using CHIPSEC
|
|
|
|
usage/*
|
|
|
|
Module & Command Development
|
|
----------------------------
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Architecture and Modules
|
|
|
|
development/*
|
|
|
|
Contribution and Style Guides
|
|
-----------------------------
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
:caption: Contribution Guide
|
|
|
|
contribution/*
|