Skip to content

Commit

Permalink
Improve grammar/consistency in README and ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history 
This is almost entirely changes to capitalization, spacing, etc. There
are a few places where I've added words where I felt they'd be
uncontroversial.
  • Loading branch information
@tedbrandston
tedbrandston committed Feb 10, 2022
1 parent a82f9fe commit 28f9f9f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
16 changes: 9 additions & 7 deletions ISSUE_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Make sure you have provided the following information:
- [ ] a Dockerfile to reproduce the build of the provided shim EFI binaries

-------------------------------------------------------------------------------
### What organization or people are asking to have this signed:
### What organization or people are asking to have this signed?
-------------------------------------------------------------------------------
`[your text here]`

-------------------------------------------------------------------------------
### What product or service is this for:
### What product or service is this for?
-------------------------------------------------------------------------------
`[your text here]`

Expand All @@ -28,7 +28,7 @@ Make sure you have provided the following information:
`[your text here]`

-------------------------------------------------------------------------------
### What's the justification that this really does need to be signed for the whole world to be able to boot it:
### What's the justification that this really does need to be signed for the whole world to be able to boot it?
-------------------------------------------------------------------------------
`[your text here]`

Expand All @@ -43,7 +43,8 @@ Make sure you have provided the following information:
`[your text here]`

-------------------------------------------------------------------------------
### If you use new vendor_db functionality, are any hashes allow-listed, and if yes: for what binaries ?
### If you use new vendor_db functionality, are any hashes allow-listed?
### If yes: for what binaries?
-------------------------------------------------------------------------------
`[your text here]`

Expand Down Expand Up @@ -91,17 +92,18 @@ Make sure you have provided the following information:
`[your text here]`

-------------------------------------------------------------------------------
### If your SHIM launches any other components, please provide further details on what is launched
### If your SHIM launches any other components, please provide further details on what is launched.
-------------------------------------------------------------------------------
`[your text here]`

-------------------------------------------------------------------------------
### If your GRUB2 launches any other binaries that are not Linux kernel in SecureBoot mode, please provide further details on what is launched and how it enforces Secureboot lockdown
### If your GRUB2 launches any other binaries that are not the Linux kernel in SecureBoot mode, please provide further details on what is launched and how it enforces Secureboot lockdown.
-------------------------------------------------------------------------------
`[your text here]`

-------------------------------------------------------------------------------
### If you are re-using a previously used (CA) certificate, you will need to add the hashes of the previous GRUB2 binaries exposed to the CVEs to vendor_dbx in shim in order to prevent GRUB2 from being able to chainload those older GRUB2 binaries. If you are changing to a new (CA) certificate, this does not apply. Please describe your strategy.
### If you are re-using a previously used (CA) certificate, you will need to add the hashes of the previous GRUB2 binaries exposed to the CVEs to vendor_dbx in shim in order to prevent GRUB2 from being able to chainload those older GRUB2 binaries. If you are changing to a new (CA) certificate, this does not apply.
### Please describe your strategy.
-------------------------------------------------------------------------------
`[your text here]`

Expand Down
29 changes: 16 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@ your part.
Here's the template:

-------------------------------------------------------------------------------
### What organization or people are asking to have this signed:
### What organization or people are asking to have this signed?
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### What product or service is this for:
### What product or service is this for?
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### What's the justification that this really does need to be signed for the whole world to be able to boot it:
### What's the justification that this really does need to be signed for the whole world to be able to boot it?
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### Who is the primary contact for security updates, etc.
### Who is the primary contact for security updates, etc.?
-------------------------------------------------------------------------------
- Name:
- Position:
Expand All @@ -45,7 +45,7 @@ like keyserver.ubuntu.com, and preferably have signatures that are reasonably
well known in the Linux community.)

-------------------------------------------------------------------------------
### Who is the secondary contact for security updates, etc.
### Who is the secondary contact for security updates, etc.?
-------------------------------------------------------------------------------
- Name:
- Position:
Expand Down Expand Up @@ -99,35 +99,38 @@ well known in the Linux community.)
[your text here]

-------------------------------------------------------------------------------
### If your boot chain of trust includes linux kernel, is "efi: Restrict efivar_ssdt_load when the kernel is locked down" upstream commit 1957a85b0032a81e6482ca4aab883643b8dae06e applied ?
### Is "ACPI: configfs: Disallow loading ACPI tables when locked down" upstream commit 75b0cea7bf307f362057cc778efe89af4c615354 applied ?
### If your boot chain of trust includes a linux kernel:
### Is upstream commit [1957a85b0032a81e6482ca4aab883643b8dae06e "efi: Restrict efivar_ssdt_load when the kernel is locked down"](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1957a85b0032a81e6482ca4aab883643b8dae06e) applied?
### Is upstream commit [75b0cea7bf307f362057cc778efe89af4c615354 "ACPI: configfs: Disallow loading ACPI tables when locked down"](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=75b0cea7bf307f362057cc778efe89af4c615354) applied?
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### If you use vendor_db functionality of providing multiple certificates and/or hashes please briefly describe your certificate setup.
### If there are allow-listed hashes please provide exact binaries for which hashes are created via file sharing service, available in public with anonymous access for verification
### If you use vendor_db functionality of providing multiple certificates and/or hashes please briefly describe your certificate setup.
### If there are allow-listed hashes please provide exact binaries for which hashes are created via file sharing service, available in public with anonymous access for verification.
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### If you are re-using a previously used (CA) certificate, you will need to add the hashes of the previous GRUB2 binaries to vendor_dbx in shim in order to prevent GRUB2 from being able to chainload those older GRUB2 binaries. If you are changing to a new (CA) certificate, this does not apply.
### If you are re-using a previously used (CA) certificate, you will need to add the hashes of the previous GRUB2 binaries exposed to the CVEs to vendor_dbx in shim in order to prevent GRUB2 from being able to chainload those older GRUB2 binaries. If you are changing to a new (CA) certificate, this does not apply.
### Please describe your strategy.
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### 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.
### 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 closely 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.
### If the shim binaries can't be reproduced using the provided Dockerfile, please explain why that's the case and what the differences would be.
-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### 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.
### 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.

-------------------------------------------------------------------------------
[your text here]

-------------------------------------------------------------------------------
### Add any additional information you think we may need to validate this shim
### Add any additional information you think we may need to validate this shim.
-------------------------------------------------------------------------------
[your text here]

0 comments on commit 28f9f9f

Please sign in to comment.