public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
* [PATCH 1/4] contributor-guide: recipe-style-guide: add section about CVE patches
@ 2023-09-20 10:06 Roland Hieber
  2023-09-20 10:06 ` [PATCH 2/4] contributor-guide: recipe-style-guide: add some more patch tagging examples Roland Hieber
                   ` (3 more replies)
  0 siblings, 4 replies; 11+ messages in thread
From: Roland Hieber @ 2023-09-20 10:06 UTC (permalink / raw)
  To: docs; +Cc: yocto, Roland Hieber

This was previously included in the OpenEmbedded wiki page [1], but was
not ported along with the rest in commit 95c9a1e1e78bbfb82ade
(2023-09-12, Michael Opdenacker: "contributor-guide: recipe-style-guide:
add Upstream-Status").

  [1]: https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935

Group the examples in their own sections.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
This is basically v2 of "[PATCH] contributor-guide: add docs for
Upstream-Status patch headers", Message-Id:
<20230919111549.997443-2-rhi@pengutronix.de>
<https://lists.yoctoproject.org/g/docs/topic/resend_patch/101455254>
rebased onto master-next, but since it looks so different now I made a
new v1 patch out of it.

 .../contributor-guide/recipe-style-guide.rst  | 27 ++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst
index 99105179a6b9..52ab4523c49f 100644
--- a/documentation/contributor-guide/recipe-style-guide.rst
+++ b/documentation/contributor-guide/recipe-style-guide.rst
@@ -321,7 +321,17 @@ the status should be changed to ``Submitted [where]``, and an additional
 ``Signed-off-by:`` line should be added to the patch by the person claiming
 responsibility for upstreaming.
 
-For example, if the patch has been submitted upstream::
+CVE patches
+-----------
+
+In order to have a better control of vulnerabilities, patches that fix CVEs must
+contain a *"CVE:"* tag. This tag list all CVEs fixed by the patch. If more than
+one CVE is fixed, separate them using spaces.
+
+Examples
+--------
+
+Here's an example of a patch that has been submitted upstream::
 
    rpm: Adjusted the foo setting in bar
 
@@ -336,3 +346,18 @@ For example, if the patch has been submitted upstream::
 
 A future update can change the value to ``Accepted`` or ``Denied`` as
 appropriate.
+
+This should be the header of patch that fixes CVE-2015-8370 in GRUB2::
+
+   grub2: Fix CVE-2015-8370
+
+   [No upstream tracking] -- https://bugzilla.redhat.com/show_bug.cgi?id=1286966
+
+   Back to 28; Grub2 Authentication
+
+   Two functions suffer from integer underflow fault; the grub_username_get() and grub_password_get()located in
+   grub-core/normal/auth.c and lib/crypto.c respectively. This can be exploited to obtain a Grub rescue shell.
+
+   Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2]
+   CVE: CVE-2015-8370
+   Signed-off-by: Joe Developer <joe.developer@example.com>
-- 
2.39.2



^ permalink raw reply related	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2023-09-22  9:25 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-20 10:06 [PATCH 1/4] contributor-guide: recipe-style-guide: add section about CVE patches Roland Hieber
2023-09-20 10:06 ` [PATCH 2/4] contributor-guide: recipe-style-guide: add some more patch tagging examples Roland Hieber
2023-09-20 14:16   ` [docs] " Michael Opdenacker
2023-09-21  8:52     ` Roland Hieber
2023-09-22  9:25       ` Michael Opdenacker
2023-09-20 10:06 ` [PATCH 3/4] contributor-guide: discourage marking patches as Inappropriate Roland Hieber
2023-09-20 14:19   ` [docs] " Michael Opdenacker
2023-09-21  8:53     ` Roland Hieber
2023-09-20 10:06 ` [PATCH 4/4] contributor-guide: deprecate "Accepted" patch status Roland Hieber
2023-09-20 14:25   ` [docs] " Michael Opdenacker
2023-09-20 14:11 ` [docs] [PATCH 1/4] contributor-guide: recipe-style-guide: add section about CVE patches Michael Opdenacker

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox