mirror of
https://github.com/chipsec/chipsec
synced 2026-06-08 13:31:00 +00:00
Aaron Frinzell
91 lines
4.0 KiB
ReStructuredText
91 lines
4.0 KiB
ReStructuredText
.. toctree::
|
|
|
|
UEFI Shell Installation
|
|
=======================
|
|
|
|
Installing CHIPSEC for UEFI Shell
|
|
---------------------------------
|
|
|
|
#. Extract contents of ``__install__/UEFI/chipsec_uefi_<arch>.zip`` to the EFI drive which can be either USB flash drive (e.g. DUET USB drive) or HDD/SSD hard drive (e.g. EFI System Partition). ``<arch>`` should correspond to your UEFI shell and can be ``x64``, ``ia32`` or ``i586``. This will create ``/efi/Tools`` directory with ``Python.efi`` and ``/efi/StdLib`` with subdirectories
|
|
|
|
#. Copy contents of CHIPSEC anywhere on the EFI drive (for example, to ``chipsec`` directory in root). The contents of your drive should look like follows:
|
|
|
|
::
|
|
|
|
\
|
|
efi\
|
|
boot\
|
|
bootx64.efi
|
|
StdLib\
|
|
lib\
|
|
python.27\
|
|
[lots of python files and directories]
|
|
Tools\
|
|
Python.efi
|
|
chipsec\
|
|
chipsec\
|
|
chipsec_main.py
|
|
chipsec_util.py
|
|
...
|
|
|
|
.. note:: The EFI drive should already include a UEFI Shell binary in ``/efi/boot``. On 64-bit platforms the shell will likely be named ``bootx64.efi``
|
|
|
|
#. Run your UEFI shell
|
|
|
|
- If UEFI shell is on the USB removable drive, you'll need to boot off of the USB drive (rebooting will load UEFI shell).
|
|
- If your UEFI firmware allows booting from any file, choose to boot from your UEFI shell binary from the UEFI firmware setup options
|
|
- Some systems have embedded UEFI shell which can be booted from setup options
|
|
|
|
#. Run CHIPSEC in UEFI shell
|
|
|
|
1. ``fs0:``
|
|
2. ``python chipsec_main.py`` or ``python chipsec_util.py``
|
|
|
|
|
|
(OPTIONAL) Extending CHIPSEC functionality for UEFI
|
|
---------------------------------------------------
|
|
|
|
Skip this section if you don't plan on extending native UEFI functionality for CHIPSEC.
|
|
|
|
Native functions accessing HW resources are built directly into Python UEFI port in built-in edk2 module. If you want to add more native functionality to Python UEFI port for chipsec, you'll need to re-build Python for UEFI:
|
|
|
|
#. Check out `AppPkg with Python 2.7.2 <https://github.com/tianocore/edk2-libc/tree/master/AppPkg/Applications/Python>`_ port for UEFI from SVN
|
|
|
|
- You'll also need to check out ``StdLib`` and ``StdLibPrivateInternalFiles`` packages from SVN
|
|
- Alternatively download latest EADK (`EDK II Application Development Kit <https://sourceforge.net/projects/edk2/files/EDK%20II%20Releases/EADK/EADK_1.02/>`_). EADK includes ``AppPkg/StdLib/StdLibPrivateInternalFiles``. Unfortunately, EADK Alpha 2 doesn't have Python 2.7.2 port so you'll need to check it out SVN.
|
|
|
|
#. Add functionality to Python port for UEFI
|
|
|
|
- Python 2.7.2 port for UEFI is in ``<UDK>\AppPkg\Applications\Python``
|
|
- All chipsec related functions are in ``<UDK>\AppPkg\Applications\Python\Efi\edk2module.c`` (``#ifdef CHIPSEC``)
|
|
- Asm functions are in ``<UDK>\AppPkg\Applications\Python\Efi\cpu.asm`` e.g. ``<UDK>`` is ``C:\UDK2010.SR1``
|
|
- Add cpu.asm under the Efi section in ``PythonCore.inf``
|
|
|
|
#. Build ``<UDK>/AppPkg`` with Python
|
|
|
|
- Read instructions in ``<UDK>\AppPkg\ReadMe.txt`` and ``<UDK>\AppPkg\Applications\Python\PythonReadMe.txt``
|
|
- Binaries of AppPkg and Python will be in ``<UDK>\Build\AppPkg\DEBUG_MYTOOLS\X64\``
|
|
|
|
#. Create directories and copy Python files on DUET USB drive
|
|
|
|
- Read instructions in ``<UDK>\AppPkg\Applications\Python\PythonReadMe.txt``
|
|
|
|
(OPTIONAL) Building bootable USB thumb drive with UEFI Shell
|
|
------------------------------------------------------------
|
|
|
|
You can build bootable USB drive with UEFI shell (X64):
|
|
|
|
#. Format your media as FAT32
|
|
|
|
#. Create the following directory structure in the root of the new media
|
|
|
|
``/efi/boot``
|
|
|
|
#. Download the UEFI Shell (``Shell.efi``) from the following link
|
|
|
|
`UEFI Shell <https://github.com/tianocore/edk2/blob/UDK2018/ShellBinPkg/UefiShell/X64/Shell.efi>`
|
|
|
|
#. Rename the UEFI shell file to ``Bootx64.efi``
|
|
|
|
#. Copy the UEFI shell (now ``Bootx64.efi``) to the ``/efi/boot`` directory
|