Skip to contentSkip to conversation

docs: Add a basic security document

PATCH In review Tom Rini 3 participants 4 messages Nov 3, 2022

lore
Share & tools
lore

Tom Rini

author
#0 lore raw

PATCH 1/1 docs: Add a basic security document

Based loosely on the Linux kernel Documentation/admin-guide/security-bugs.rst file, create a basic security document for U-Boot. In sum, security issues should be disclosed in public on the mailing list if at all possible as an initial position.

---
 doc/develop/index.rst    |  1 +
 doc/develop/security.rst | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 doc/develop/security.rst
doc/develop/index.rst +1 -0
index 5934d9ffb115..04322efe59fd 100644
@@ -15,6 +15,7 @@ General
    process
    release_cycle
    system_configuration
+   security
    sending_patches
 
 Implementation
doc/develop/security.rst new file +32 -0
new file mode 100644
index 000000000000..84b130646f31
@@ -0,0 +1,32 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+Handling of security vulnerabilities
+====================================
+
+The U-Boot project takes security very seriously.  As such, we'd like to know
+when a security bug is found so that it can be fixed and disclosed as quickly
+as possible.
+
+Contact
+-------
+
+The preferred initial point of contact is to send email to
+`[email protected]` and use `scripts/get_maintainers.pl` to also include any
+relevant custodians. In addition, Tom Rini should be contacted at
+`[email protected]`.
+
+CVE assignment
+--------------
+
+The U-Boot project cannot directly assign CVEs, nor do we require them for
+reports or fixes, as this can needlessly complicate the process and may delay
+the bug handling. If a reporter wishes to have a CVE identifier assigned ahead
+of public disclosure, they will need to coordinate this on their own.  When
+such a CVE identifier is known before a patch is provided, it is desirable to
+mention it in the commit message if the reporter agrees.
+
+Non-disclosure agreements
+-------------------------
+
+The U-Boot project is not a formal body and therefore unable to enter any
+non-disclosure agreements.
Signature · 1 line
2.25.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 18 lines · Tom Rini

Based loosely on the Linux kernel Documentation/admin-guide/security-bugs.rst file, create a basic security document for U-Boot. In sum, security issues should be disclosed in public on the mailing list if at all possible as an initial position.

---
  doc/develop/index.rst    |  1 +
  doc/develop/security.rst | 32 ++++++++++++++++++++++++++++++++
  2 files changed, 33 insertions(+)

create mode 100644 doc/develop/security.rst

doc/develop/index.rst +0 -0
index 5934d9ffb115..04322efe59fd 100644

doc/develop/index.rst General · line 18

Quoted 4 lines
doc/develop/index.rst +1 -0
@@ -15,6 +15,7 @@ General
     process
     release_cycle
     system_configuration
+   security

Should we get this into alphabetic order?

Quoted 31 lines
doc/develop/index.rst +0 -0
     sending_patches
 
  Implementation
doc/develop/security.rst new file +22 -0
new file mode 100644
index 000000000000..84b130646f31
@@ -0,0 +1,32 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+Handling of security vulnerabilities
+====================================
+
+The U-Boot project takes security very seriously.  As such, we'd like to know
+when a security bug is found so that it can be fixed and disclosed as quickly
+as possible.
+
+Contact
+-------
+
+The preferred initial point of contact is to send email to
+`[email protected]` and use `scripts/get_maintainers.pl` to also include any
+relevant custodians. In addition, Tom Rini should be contacted at
+`[email protected]`.
+
+CVE assignment
+--------------
+
+The U-Boot project cannot directly assign CVEs, nor do we require them for
+reports or fixes, as this can needlessly complicate the process and may delay

doc/develop/security.rst line 32

Quoted 10 lines
doc/develop/security.rst new file +10 -0
+the bug handling. If a reporter wishes to have a CVE identifier assigned ahead
+of public disclosure, they will need to coordinate this on their own.  When
+such a CVE identifier is known before a patch is provided, it is desirable to
+mention it in the commit message if the reporter agrees.
+
+Non-disclosure agreements
+-------------------------
+
+The U-Boot project is not a formal body and therefore unable to enter any
+non-disclosure agreements.

Otherwise

author
#2 lore raw
Quoted 14 lines · Heinrich Schuchardt
Quoted 13 lines · Tom Rini

Based loosely on the Linux kernel Documentation/admin-guide/security-bugs.rst file, create a basic security document for U-Boot. In sum, security issues should be disclosed in public on the mailing list if at all possible as an initial position.

---
  doc/develop/index.rst    |  1 +
  doc/develop/security.rst | 32 ++++++++++++++++++++++++++++++++
  2 files changed, 33 insertions(+)

create mode 100644 doc/develop/security.rst

Quoted 12 lines

doc/develop/index.rst General · line 18

Quoted 9 lines
doc/develop/index.rst +1 -0
index 5934d9ffb115..04322efe59fd 100644
@@ -15,6 +15,7 @@ General
     process
     release_cycle
     system_configuration
+   security

Should we get this into alphabetic order?

Whoops, can you fix when applying please?

Quoted 44 lines
Quoted 31 lines
doc/develop/index.rst +0 -0
     sending_patches
 
  Implementation
doc/develop/security.rst new file +22 -0
new file mode 100644
index 000000000000..84b130646f31
@@ -0,0 +1,32 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+Handling of security vulnerabilities
+====================================
+
+The U-Boot project takes security very seriously.  As such, we'd like to know
+when a security bug is found so that it can be fixed and disclosed as quickly
+as possible.
+
+Contact
+-------
+
+The preferred initial point of contact is to send email to
+`[email protected]` and use `scripts/get_maintainers.pl` to also include any
+relevant custodians. In addition, Tom Rini should be contacted at
+`[email protected]`.
+
+CVE assignment
+--------------
+
+The U-Boot project cannot directly assign CVEs, nor do we require them for
+reports or fixes, as this can needlessly complicate the process and may delay

doc/develop/security.rst line 32

Quoted 10 lines
doc/develop/security.rst new file +10 -0
+the bug handling. If a reporter wishes to have a CVE identifier assigned ahead
+of public disclosure, they will need to coordinate this on their own.  When
+such a CVE identifier is known before a patch is provided, it is desirable to
+mention it in the commit message if the reporter agrees.
+
+Non-disclosure agreements
+-------------------------
+
+The U-Boot project is not a formal body and therefore unable to enter any
+non-disclosure agreements.

Otherwise

Signature · 1 line
Tom
Reviewed-by on v1 1/1
#3 lore raw
In reply to Tom Rini

Hi Tom,

Quoted 7 lines · Tom Rini

Based loosely on the Linux kernel Documentation/admin-guide/security-bugs.rst file, create a basic security document for U-Boot. In sum, security issues should be disclosed in public on the mailing list if at all possible as an initial position.

Quoted 6 lines
---
 doc/develop/index.rst    |  1 +
 doc/develop/security.rst | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 doc/develop/security.rst
Quoted 23 lines
doc/develop/index.rst +1 -0
index 5934d9ffb115..04322efe59fd 100644
@@ -15,6 +15,7 @@ General
    process
    release_cycle
    system_configuration
+   security
    sending_patches
 
 Implementation
doc/develop/security.rst new file +4 -0
new file mode 100644
index 000000000000..84b130646f31
@@ -0,0 +1,32 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+Handling of security vulnerabilities
+====================================

doc/develop/security.rst line 14

Quoted 10 lines
doc/develop/security.rst new file +10 -0
+
+The U-Boot project takes security very seriously.  As such, we'd like to know
+when a security bug is found so that it can be fixed and disclosed as quickly
+as possible.
+
+Contact
+-------
+
+The preferred initial point of contact is to send email to
+`[email protected]` and use `scripts/get_maintainers.pl` to also include any

link to patman docs?

:doc:doc/develop/sending_patches

Quoted 19 lines
doc/develop/security.rst new file +18 -1
+relevant custodians. In addition, Tom Rini should be contacted at
+`[email protected]`.
+
+CVE assignment
+--------------
+
+The U-Boot project cannot directly assign CVEs, nor do we require them for
+reports or fixes, as this can needlessly complicate the process and may delay
+the bug handling. If a reporter wishes to have a CVE identifier assigned ahead
+of public disclosure, they will need to coordinate this on their own.  When
+such a CVE identifier is known before a patch is provided, it is desirable to
+mention it in the commit message if the reporter agrees.
+
+Non-disclosure agreements
+-------------------------
+
+The U-Boot project is not a formal body and therefore unable to enter any
+non-disclosure agreements.
--
Quoted 2 lines

2.25.1

Regards,
Simon