Skip to contentSkip to conversation

Add MAINTAINERS and SECURITY files

PATCH Superseded Daniel Kiper 2 participants 5 messages Jun 1, 2021 – Jun 3, 2021

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover Add MAINTAINERS and SECURITY files

Hey,

I want to add MAINTAINERS and SECURITY files to the GRUB source code before 2.06 release. The former says basic things about the project including who is who. The latter describes SECURITY process for the GRUB.

Daniel

 MAINTAINERS | 34 ++++++++++++++++++++++++++++++++++
 SECURITY    | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 95 insertions(+)

Daniel Kiper (2):
MAINTAINERS: Add MAINTAINERS file
SECURITY: Add SECURITY file

#1 lore raw

PATCH 1/2 MAINTAINERS: Add MAINTAINERS file

The MAINTAINERS file provides basic information about the GRUB project and its maintainers.

---
 MAINTAINERS | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 MAINTAINERS
MAINTAINERS new file +31 -0
new file mode 100644
index 000000000..41fdf5a04
@@ -0,0 +1,31 @@
+List of current GRUB maintainers and some basic information about the project
+=============================================================================
+
+Here is the list of current GRUB maintainers:
+  - Daniel Kiper <[email protected]> and <[email protected]>,
+  - Alex Burmashev <[email protected]>,
+  - Vladimir 'phcoder' Serbinenko <[email protected]>.
+
+The maintainers drive and overlook the GRUB development.
+
+The GRUB development happens on the grub-devel mailing list [1]. The latest
+GRUB source code is available at Savannah git repository [2].
+
+Users can ask for help on the help-grub mailing list [3].
+
+
+List of past GRUB maintainers and people who strongly contributed to the project
+================================================================================
+
+Here is the list, sorted alphabetically, of past GRUB maintainers and people who
+strongly contributed to the project:
+  - Andrei Borzenkov,
+  - Bryan Ford,
+  - Erich Stefan Boleyn,
+  - Gordon Matzigkeit,
+  - Yoshinori K. Okuji.
+
+
+[1] https://lists.gnu.org/mailman/listinfo/grub-devel
+[2] http://git.savannah.gnu.org/gitweb/?p=grub.git&view=view+git+repository
+[3] https://lists.gnu.org/mailman/listinfo/help-grub
Signature · 1 line
2.11.0
#2 lore raw

Re: [PATCH 1/2] MAINTAINERS: Add MAINTAINERS file

Dear Daniel,

Thank you for creating this

Am 01.06.21 um 18:13 schrieb Daniel Kiper:

Quoted 17 lines

The MAINTAINERS file provides basic information about the GRUB project and its maintainers.

---
  MAINTAINERS | 31 +++++++++++++++++++++++++++++++
  1 file changed, 31 insertions(+)

create mode 100644 MAINTAINERS

MAINTAINERS new file +0 -0
new file mode 100644
index 000000000..41fdf5a04

MAINTAINERS line 2

Quoted 2 lines
MAINTAINERS new file +2 -0
@@ -0,0 +1,31 @@
+List of current GRUB maintainers and some basic information about the project
+=============================================================================

In my opinion the basic information should go into the file README.

MAINTAINERS line 8

Quoted 6 lines
MAINTAINERS new file +6 -0
+
+Here is the list of current GRUB maintainers:
+  - Daniel Kiper <[email protected]> and <[email protected]>,
+  - Alex Burmashev <[email protected]>,
+  - Vladimir 'phcoder' Serbinenko <[email protected]>.
+

My personal preference would be to remove the , and dot/period from the items [4].

Quoted 7 lines

Capitalization and punctuation are optional when using single words or phrases in bulleted form. If each bullet or numbered point is a complete sentence, capitalize the first word and end each sentence with proper ending punctuation. The rule of thumb is to be consistent.

MAINTAINERS line 16

Quoted 8 lines
MAINTAINERS new file +8 -0
+The maintainers drive and overlook the GRUB development.
+
+The GRUB development happens on the grub-devel mailing list [1]. The latest
+GRUB source code is available at Savannah git repository [2].
+
+Users can ask for help on the help-grub mailing list [3].
+
+

As written above, I’d put the two paragraphs above in the file README.

Quoted 4 lines
MAINTAINERS new file +4 -0
+List of past GRUB maintainers and people who strongly contributed to the project
+================================================================================
+
+Here is the list, sorted alphabetically, of past GRUB maintainers and people who

MAINTAINERS line 30

Quoted 10 lines
MAINTAINERS new file +10 -0
+strongly contributed to the project:
+  - Andrei Borzenkov,
+  - Bryan Ford,
+  - Erich Stefan Boleyn,
+  - Gordon Matzigkeit,
+  - Yoshinori K. Okuji.
+
+
+[1] https://lists.gnu.org/mailman/listinfo/grub-devel
+[2] http://git.savannah.gnu.org/gitweb/?p=grub.git&view=view+git+repository

Why not the HTTPS URL?

Quoted 1 line

+[3] https://lists.gnu.org/mailman/listinfo/help-grub

Whatever you decide, you also might want to reference this file in the file README as other files are referenced there too.

Kind regards,

Paul

[4]: https://www.grammarbook.com/blog/colons/colons/

#3 lore raw

PATCH 2/2 SECURITY: Add SECURITY file

In reply to Daniel Kiper

The SECURITY file describes the GRUB project security policy.

It is based on https://github.com/wireapp/wire/blob/master/SECURITY.md

---
 MAINTAINERS |  3 +++
 SECURITY    | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+)
 create mode 100644 SECURITY
MAINTAINERS +3 -0
index 41fdf5a04..3d5d1ae97 100644
@@ -8,6 +8,9 @@ Here is the list of current GRUB maintainers:
 
 The maintainers drive and overlook the GRUB development.
 
+If you found a security vulnerability in the GRUB please check the SECURITY file to
+get more information how to properly report this kind of bugs to the maintainers.
+
 The GRUB development happens on the grub-devel mailing list [1]. The latest
 GRUB source code is available at Savannah git repository [2].
 
SECURITY new file +61 -0

61 lines not on this page · raw message

Signature · 1 line
2.11.0
#4 lore raw

Re: [PATCH 2/2] SECURITY: Add SECURITY file

Dear Daniel,

Am 01.06.21 um 18:13 schrieb Daniel Kiper:

Quoted 18 lines

The SECURITY file describes the GRUB project security policy.

It is based on https://github.com/wireapp/wire/blob/master/SECURITY.md

---
  MAINTAINERS |  3 +++
  SECURITY    | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  2 files changed, 64 insertions(+)

create mode 100644 SECURITY

MAINTAINERS +0 -0
index 41fdf5a04..3d5d1ae97 100644

MAINTAINERS Here is the list of current GRUB maintainers: · line 13

Quoted 6 lines
MAINTAINERS +3 -0
@@ -8,6 +8,9 @@ Here is the list of current GRUB maintainers:
 
  The maintainers drive and overlook the GRUB development.
 
+If you found a security vulnerability in the GRUB please check the SECURITY file to
+get more information how to properly report this kind of bugs to the maintainers.
+

I’d put this into the file README.

Quoted 12 lines
MAINTAINERS +0 -0
  The GRUB development happens on the grub-devel mailing list [1]. The latest
  GRUB source code is available at Savannah git repository [2].
 
SECURITY new file +3 -0
new file mode 100644
index 000000000..abe1a2fe4
@@ -0,0 +1,61 @@
+Security Policy
+===============
+

SECURITY line 13

Quoted 10 lines
SECURITY new file +10 -0
+To report a vulnerability see "Reporting a Vulnerability" below.
+
+
+Security Incident Policy
+========================
+
+Security bug reports are treated with special attention and are handled
+differently from normal bugs. In particular, security sensitive bugs are not
+handled in public but in private. Information about the bug and access to it
+is restricted to people in the security bug group, the individual engineers

Who is the “security bug group”?

Quoted 4 lines
SECURITY new file +4 -0
+that work on fixing it, and any other person who needs to be involved for
+organisational reasons. The process is handled by the security team, which
+decides on the people involved in order to fix the issue. It is also
+guaranteed that the person reporting the issue has visibility into the process

SECURITY line 27

Quoted 10 lines
SECURITY new file +10 -0
+of fixing it. Any security issue gets prioritized according to its security
+rating. The issue is opened up to the public in coordination with the release
+schedule and the reporter.
+
+
+Disclosure Policy
+=================
+
+Everyone involved in the handling of a security issue - including the reporter -
+is required to adhere to the following policy. Any information related to

Are you sure you can put these restrictions on the reporter?

Quoted 9 lines
SECURITY new file +9 -0
+a security issue must be treated as confidential and only shared with trusted
+partners if necessary, for example to coordinate a release or manage exposure
+of clients to the issue. No information must be disclosed to the public before
+the embargo ends. The embargo time is agreed upon by all involved parties. It
+should be as short as possible without putting any users at risk.
+
+
+Supported Versions
+==================

SECURITY line 46

Quoted 10 lines
SECURITY new file +10 -0
+
+Only the most recent version of the GRUB is supported.
+
+While there's currently no bug bounty program we appreciate every report.
+
+
+Reporting a Vulnerability
+=========================
+
+The security report has to be encrypted with the PGP keys and send to ALL email

s/has to be/should be/

I guess you will look at these reports even if they are not encrypted?

Quoted 5 lines
SECURITY new file +5 -0
+addresses listed below. Every vulnerability report will be assessed within
+72 hours of receiving it. If the outcome of the assessment is that the report
+describes a security issue, the report will be transferred into an issue on the
+internal vulnerability project for further processing. The reporter is updated
+on each step of the process.

SECURITY line 61

Quoted 10 lines
SECURITY new file +10 -0
+
+* Contact: Daniel Kiper <[email protected]> and
+           Daniel Kiper <[email protected]>
+* PGP Key Fingerprint: BE5C 2320 9ACD DACE B20D  B0A2 8C81 89F1 988C 2166
+
+* Contact: Alex Burmashev <[email protected]>
+* PGP Key Fingerprint: 50A4 EC06 EF7E B84D 67E0  3BB6 2AE2 C87E 28EF 2E6E
+
+* Contact: Vladimir 'phcoder' Serbinenko <[email protected]>
+* PGP Key Fingerprint: E53D 497F 3FA4 2AD8 C9B4  D1E8 35A9 3B74 E82E 4209

Kind regards,

Paul