mirror of
https://github.com/chipsec/chipsec
synced 2026-06-08 13:31:00 +00:00
Sae86
119 lines
4.4 KiB
ReStructuredText
119 lines
4.4 KiB
ReStructuredText
.. _Running-Chipsec:
|
||
|
||
Running 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.
|
||
|
||
Use ``-m --module`` to run a specific module (e.g. security check, a tool or a PoC..):
|
||
|
||
- ``# python chipsec_main.py -m common.bios_wp``
|
||
- ``# python chipsec_main.py -m common.spi_lock``
|
||
- ``# python chipsec_main.py -m common.smrr``
|
||
|
||
- You can also use CHIPSEC to access various hardware resources:
|
||
|
||
``# python chipsec_util.py``
|
||
|
||
Running in Shell
|
||
----------------
|
||
|
||
**Basic usage**
|
||
|
||
``# python chipsec_main.py``
|
||
|
||
``# python chipsec_util.py``
|
||
|
||
**For help, run**
|
||
|
||
``# python chipsec_main.py --help``
|
||
|
||
``# python chipsec_util.py --help``
|
||
|
||
Using as a Python Package
|
||
-------------------------
|
||
|
||
Install CHIPSEC manually or from PyPI. You can then use CHIPSEC from your Python project or from the Python shell:
|
||
|
||
To install and run CHIPSEC as a package:
|
||
|
||
``# python setup.py install``
|
||
|
||
``# sudo chipsec_main``
|
||
|
||
From the Python shell:
|
||
|
||
>>> import chipsec_main
|
||
>>> chipsec_main.main()
|
||
>>> chipsec_main.main(['-m','common.bios_wp'])
|
||
|
||
>>> import chipsec_util
|
||
>>> chipsec_util.main()
|
||
>>> chipsec_util.main(['spi','info'])
|
||
|
||
To use CHIPSEC *in place* without installing it:
|
||
|
||
``# python setup.py build_ext -i``
|
||
|
||
``# sudo python chipsec_main.py``
|
||
|
||
chipsec_main options
|
||
--------------------
|
||
|
||
::
|
||
|
||
usage: chipsec_main.py [options]
|
||
|
||
Options:
|
||
-h, --help show this message and exit
|
||
-m, --module _MODULE specify module to run (example: -m common.bios_wp)
|
||
-a, --module_args _MODULE_ARGV additional module arguments
|
||
-v, --verbose verbose mode
|
||
-vv, --vverbose very verbose HAL debug mode
|
||
--hal HAL mode
|
||
-d, --debug debug mode
|
||
-l, --log LOG output to log file
|
||
|
||
Advanced Options:
|
||
-p, --platform _PLATFORM explicitly specify platform code
|
||
--pch _PCH explicitly specify PCH code
|
||
-n, --no_driver chipsec won't need kernel mode functions so don't load chipsec driver
|
||
-i, --ignore_platform run chipsec even if the platform is not recognized
|
||
-j, --json _JSON_OUT specify filename for JSON output
|
||
-x, --xml _XML_OUT specify filename for xml output (JUnit style)
|
||
-k, --markdown specify filename for markdown output
|
||
-t, --moduletype USER_MODULE_TAGS run tests of a specific type (tag)
|
||
--list_tags list all the available options for -t,--moduletype
|
||
-I, --include IMPORT_PATHS specify additional path to load modules from
|
||
--failfast fail on any exception and exit (don't mask exceptions)
|
||
--no_time don't log timestamps
|
||
--deltas _DELTAS_FILE specifies a JSON log file to compute result deltas from
|
||
--record _TO_FILE run chipsec and clone helper results into JSON file
|
||
--replay _FROM_FILE replay a chipsec run with JSON file
|
||
--helper _HELPER specify OS Helper
|
||
-nb, --no_banner chipsec won't display banner information
|
||
--skip_config skip configuration and driver loading
|
||
|
||
chipsec_util options
|
||
--------------------
|
||
|
||
::
|
||
|
||
usage: chipsec_util.py [options] <command>
|
||
|
||
Options:
|
||
-h, --help show this message and exit
|
||
-v, --verbose verbose mode
|
||
--hal HAL mode
|
||
-d, --debug debug mode
|
||
-l, --log LOG output to log file
|
||
-p, --platform _PLATFORM explicitly specify platform code
|
||
--pch _PCH explicitly specify PCH code
|
||
-n, --no_driver chipsec won't need kernel mode functions so don't load chipsec driver
|
||
-i, --ignore_platform run chipsec even if the platform is not recognized
|
||
Command _CMD Util command to run
|
||
Command _ARGS All numeric values are in hex <width> is in {1 - byte, 2 - word, 4 - dword} |