Add initial README writeup
[shim-review.git] / README.md
1 This repo is for review of requests for signing shim.  To create a request for review:
2
3 - clone this repo
4 - edit the template below
5 - add the shim.efi to be signed
6 - add build logs
7 - commit all of that
8 - tag it with a tag of the form "myorg-shim-arch-YYYYMMDD"
9 - push that to github
10 - file an issue at https://github.com/rhboot/shim-review/issues with a link to your branch
11
12 Note that we really only have experience with using grub2 on Linux, so asking
13 us to endorse anything else for signing is going to require some convincing on
14 your part.
15
16 Here's the template:
17
18 -------------------------------------------------------------------------------
19 What organization or people are asking to have this signed:
20 -------------------------------------------------------------------------------
21 Debian
22
23 -------------------------------------------------------------------------------
24 What product or service is this for:
25 -------------------------------------------------------------------------------
26 Debian GNU/Linux
27
28 -------------------------------------------------------------------------------
29 What's the justification that this really does need to be signed for the whole world to be able to boot it:
30 -------------------------------------------------------------------------------
31 Debian is a well-known GNU/Linux distribution.
32
33 -------------------------------------------------------------------------------
34 Who is the primary contact for security updates, etc.
35 -------------------------------------------------------------------------------
36 - Name: Debian Security Team
37 - Position: Security team
38 - Email address: security@debian.org
39 - PGP key, signed by the other security contacts, and preferably also with signatures that are reasonably well known in the linux community: The file keys/security-team.pub in this git repo
40
41
42 -------------------------------------------------------------------------------
43 Who is the secondary contact for security updates, etc.
44 -------------------------------------------------------------------------------
45 - Name: Steve Langasek
46 - Position: shim maintainer
47 - Email address: vorlon@debian.org
48 - PGP key, signed by the other security contacts, and preferably also with signatures that are reasonably well known in the linux community: The file keys/vorlon.pub in this git repo
49
50 -------------------------------------------------------------------------------
51 What upstream shim tag is this starting from:
52 -------------------------------------------------------------------------------
53 https://github.com/rhboot/shim/tree/15 + commits up to
54 https://github.com/rhboot/shim/commit/3beb971b10659cf78144ddc5eeea83501384440c
55
56 -------------------------------------------------------------------------------
57 URL for a repo that contains the exact code which was built to get this binary:
58 -------------------------------------------------------------------------------
59 https://salsa.debian.org/vorlon/shim/tree/debian/15+1533136590.3beb971-2
60
61 -------------------------------------------------------------------------------
62 What patches are being applied and why:
63 -------------------------------------------------------------------------------
64 No extra patches.
65
66 -------------------------------------------------------------------------------
67 What OS and toolchain must we use to reproduce this build?  Include where to find it, etc.  We're going to try to reproduce your build as close as possible to verify that it's really a build of the source tree you tell us it is, so these need to be fairly thorough. At the very least include the specific versions of gcc, binutils, and gnu-efi which were used, and where to find those binaries.
68 -------------------------------------------------------------------------------
69 We recommend reproducing the binary by way of using the supplied Dockerfile:
70
71 `docker build .`
72
73 The binary is built on Debian unstable as of 2019-02-11.
74
75 Versions used can be found in the build log.
76
77 -------------------------------------------------------------------------------
78 Which files in this repo are the logs for your build?   This should include logs for creating the buildroots, applying patches, doing the build, creating the archives, etc.
79 -------------------------------------------------------------------------------
80 shim_15+1533136590.3beb971-2_amd64.log
81
82 -------------------------------------------------------------------------------
83 Add any additional information you think we may need to validate this shim
84 -------------------------------------------------------------------------------
85 [your text here]