Go to file
Colin Walters 2616b13645 Convert README -> README.md
One of the really great things about Github IMO is how
"front and center" the README file in a repository is (just
compare with Sourceforge).

Github renders it more nicely if the file is declared to be Markdown,
so let's do that.  Add a bit of formatting: using code fences
for code, hyperlinks for other files etc.

I also added a title block from the Fedora package `Summary`
since while I know in theory shim is independent of bootloaders,
let's say what the 95% case is here.
2021-02-15 17:20:05 -05:00
.github/workflows github workflows: add the sbat branch to one PR builds run for 2021-02-05 16:30:57 -05:00
Cryptlib Make openssl accept the right set of KU/EKUs 2020-07-23 22:22:04 -04:00
data Add a .sbat section to EFI binaries 2021-02-12 12:51:32 -05:00
include sbat: make the includes work like everything else. 2021-02-15 18:40:07 +01:00
lib get_variable: always allocate a NUL character at the end. 2021-02-13 13:15:12 -05:00
.clang-format Add some linked list primitives. 2021-02-13 12:58:23 -05:00
.gitignore .gitignore: ignore .gdbinit 2021-02-15 17:20:05 -05:00
buildid.c Fix the license on our buildid extractor. 2020-07-23 20:53:24 -04:00
BUILDING BUILDING: Fix a typo 2021-02-15 17:20:05 -05:00
cert.S Add support for vendor_db built-in shim authorized list. 2020-07-23 22:22:04 -04:00
COPYRIGHT Add copyright file 2012-07-09 11:03:12 -04:00
crypt_blowfish.c Move includes around to clean the source tree up a bit. 2018-03-12 16:21:43 -04:00
elf_aarch64_efi.lds efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
elf_arm_efi.lds efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
elf_ia32_efi.lds efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
elf_ia64_efi.lds efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
elf_x86_64_efi.lds efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
errlog.c Improve debug output some 2020-07-25 22:14:08 -04:00
fallback.c Work around some clang-format oddnesses 2021-01-29 18:24:57 -05:00
httpboot.c translate_slashes(): don't write to string literals 2020-07-23 20:53:24 -04:00
make-certs Use portable shebangs: /bin/bash -> /usr/bin/env bash 2020-07-23 20:53:24 -04:00
Make.coverity Try to make coverity.mk work without cov-build installed. 2021-02-15 17:20:05 -05:00
Make.defaults efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
Make.rules efi bins: add an easy way for vendors to add .sbat data 2021-02-12 19:27:21 +01:00
Make.scan-build Try to make scan-build.mk work without scan-build installed. 2021-02-15 17:20:05 -05:00
Makefile Add the beginning of .sbat parsing stuff 2021-02-13 11:02:59 -05:00
model.c Add a model file for coverity. 2018-03-12 16:21:43 -04:00
mok.c Work around some clang-format oddnesses 2021-01-29 18:24:57 -05:00
MokManager.c Fix some mokmanager deletion paths 2020-10-15 19:17:35 -04:00
MokVars.txt Add MokListX to MokVars.txt 2017-08-03 11:00:58 -04:00
netboot.c Check PxeReplyReceived as fallback in netboot 2020-07-23 20:53:24 -04:00
PasswordCrypt.c shim: Use EFI_ERROR() instead of comparing to EFI_SUCCESS everywhere. 2018-03-12 16:21:43 -04:00
pe.c SBAT: parse a copy of the table that's got a NUL at the end 2021-02-13 11:02:59 -05:00
README.fallback README.fallback: correct the path of BOOT.CSV in layout example 2017-07-24 14:12:31 -04:00
README.md Convert README -> README.md 2021-02-15 17:20:05 -05:00
README.tpm Add support for vendor_db built-in shim authorized list. 2020-07-23 22:22:04 -04:00
replacements.c shim: compile time option to bypass the ExitBootServices() check 2021-01-29 15:53:34 -05:00
sbat.c sbat: make the includes work like everything else. 2021-02-15 18:40:07 +01:00
SBAT.example.md Add an example SBAT workflow document 2021-02-13 11:29:18 -05:00
SBAT.md Add Secure Boot Advanced Targeting (SBAT) specification document 2021-02-13 11:29:18 -05:00
shim.c Add the beginning of .sbat parsing stuff 2021-02-13 11:02:59 -05:00
shim.h sbat: make the includes work like everything else. 2021-02-15 18:40:07 +01:00
testplan.txt Another testplan error. 2014-10-02 01:01:46 -04:00
TODO Add mm/fb hashing to TODO, put that and related things under 'Reproducible builds' 2021-02-15 17:20:05 -05:00
tpm.c Fix a broken tpm type 2020-07-23 20:53:24 -04:00
version.c.in Make shim_version live in a special aligned section. 2017-02-23 16:08:42 -05:00
version.h Add ident-like blobs to shim.efi for version checking. 2013-10-03 11:11:09 -04:00

shim, a first-stage UEFI bootloader

shim is a trivial EFI application that, when run, attempts to open and execute another application. It will initially attempt to do this via the standard EFI LoadImage() and StartImage() calls. If these fail (because Secure Boot is enabled and the binary is not signed with an appropriate key, for instance) it will then validate the binary against a built-in certificate. If this succeeds and if the binary or signing key are not blacklisted then shim will relocate and execute the binary.

shim will also install a protocol which permits the second-stage bootloader to perform similar binary validation. This protocol has a GUID as described in the shim.h header file and provides a single entry point. On 64-bit systems this entry point expects to be called with SysV ABI rather than MSABI, so calls to it should not be wrapped.

On systems with a TPM chip enabled and supported by the system firmware, shim will extend various PCRs with the digests of the targets it is loading. A full list is in the file README.tpm .

To use shim, simply place a DER-encoded public certificate in a file such as pub.cer and build with make VENDOR_CERT_FILE=pub.cer.

There are a couple of build options, and a couple of ways to customize the build, described in BUILDING.