security: rework guideline about issue URL / CVE references
PATCH 1/1 security: rework guideline about issue URL / CVE references
---
This incorporates the feedback that Michael provided on the just merged security process changes.
contribute/security-process.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)
contribute/security-process.md +16 -7
@@ -92,19 +92,28 @@ be scrubbed before disclosure. * The maintainer(s) will develop and/or review patch(es) for the issue privately, optionally attaching work in - progress fixes to the GitLab issues. All patches must - include the issue URL in the commit message(s). The - **"Workflow::In Progress"** label should be assigned when + progress fixes to the GitLab issues. The + **"Workflow::In Progress"** label can be assigned when a maintainer starts working on a fix. * When a CVE is allocated, it must be recorded as a comment on the GitLab issue, and the **"CVE::Required"** label replaced by the **"CVE::Assigned"** label. - * The maintainer(s) will update the commit message(s) to include - the assigned CVE and issue URL. If multiple commits are required - to fix an issue the CVE must be included in the final commit in - the series, and may optionally be included in all prior commits. + * The maintainer(s) will update the commit message(s) before + sending a pull request to include the assigned CVE and issue + URL in the following format: + + ``` + Fixes: CVE-1980-12345 + Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/75 + Reviewed-by: Not Me <[email protected]> + Signed-off-by: Some One <[email protected]> + ``` + + If multiple commits are required to fix an issue the CVE must + be included in the final commit in the series, and may optionally + be included in all prior commits. * When the maintainer(s) are satisfied that the patch(es) are suitable to propose for merge, they must be submitted to
Signature · 1 line
2.54.0
Quoted 28 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>---
This incorporates the feedback that Michael provided on the just merged security process changes.
contribute/security-process.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)contribute/security-process.md +2
-3@@ -92,19 +92,28 @@ be scrubbed before disclosure. * The maintainer(s) will develop and/or review patch(es) for the issue privately, optionally attaching work in - progress fixes to the GitLab issues. All patches must - include the issue URL in the commit message(s). The - **"Workflow::In Progress"** label should be assigned when + progress fixes to the GitLab issues. The + **"Workflow::In Progress"** label can be assigned when a maintainer starts working on a fix. * When a CVE is allocated, it must be recorded as a comment on the GitLab issue, and the **"CVE::Required"** label replaced by the **"CVE::Assigned"** label.
contribute/security-process.md be scrubbed before disclosure. · line 108
Quoted 10 lines
contribute/security-process.md +6
-4- * The maintainer(s) will update the commit message(s) to include - the assigned CVE and issue URL. If multiple commits are required - to fix an issue the CVE must be included in the final commit in - the series, and may optionally be included in all prior commits. + * The maintainer(s) will update the commit message(s) before + sending a pull request to include the assigned CVE and issue + URL in the following format: + + ``` + Fixes: CVE-1980-12345
So far we used "Fixes:" to indicate the commit ID of the patch that contained the bug. So maybe it's better to use something like "CVE:" instead?
contribute/security-process.md be scrubbed before disclosure. · line 109
Quoted 1 line
contribute/security-process.md +1
-0+ Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/75
Maybe best to use a number here that does not exist, e.g. "42".
Thomas
Quoted 10 lines
contribute/security-process.md +7
-0+ Reviewed-by: Not Me <[email protected]> + Signed-off-by: Some One <[email protected]> + ``` + + If multiple commits are required to fix an issue the CVE must + be included in the final commit in the series, and may optionally + be included in all prior commits. * When the maintainer(s) are satisfied that the patch(es) are suitable to propose for merge, they must be submitted to
Quoted 2 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>---
Thanks! something small to improve:
Quoted 33 lines
This incorporates the feedback that Michael provided on the just merged security process changes.
contribute/security-process.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)contribute/security-process.md +6
-7@@ -92,19 +92,28 @@ be scrubbed before disclosure. * The maintainer(s) will develop and/or review patch(es) for the issue privately, optionally attaching work in - progress fixes to the GitLab issues. All patches must - include the issue URL in the commit message(s). The - **"Workflow::In Progress"** label should be assigned when + progress fixes to the GitLab issues. The + **"Workflow::In Progress"** label can be assigned when a maintainer starts working on a fix. * When a CVE is allocated, it must be recorded as a comment on the GitLab issue, and the **"CVE::Required"** label replaced by the **"CVE::Assigned"** label. - * The maintainer(s) will update the commit message(s) to include - the assigned CVE and issue URL. If multiple commits are required - to fix an issue the CVE must be included in the final commit in - the series, and may optionally be included in all prior commits. + * The maintainer(s) will update the commit message(s) before + sending a pull request to include the assigned CVE and issue + URL in the following format: +
contribute/security-process.md be scrubbed before disclosure. · line 116
Quoted 10 lines
contribute/security-process.md +10
-0+ ``` + Fixes: CVE-1980-12345 + Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/75 + Reviewed-by: Not Me <[email protected]> + Signed-off-by: Some One <[email protected]> + ``` + + If multiple commits are required to fix an issue the CVE must + be included in the final commit in the series, and may optionally + be included in all prior commits.
And the Fixes tag? Same rule?
Thanks!
Quoted 4 lines
contribute/security-process.md +0
-0* When the maintainer(s) are satisfied that the patch(es) are suitable to propose for merge, they must be submitted toSignature · 1 line
2.54.0
Quoted 32 lines · Thomas Huth
Quoted 31 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>---
This incorporates the feedback that Michael provided on the just merged security process changes.
contribute/security-process.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)contribute/security-process.md +4
-7@@ -92,19 +92,28 @@ be scrubbed before disclosure. * The maintainer(s) will develop and/or review patch(es) for the issue privately, optionally attaching work in - progress fixes to the GitLab issues. All patches must - include the issue URL in the commit message(s). The - **"Workflow::In Progress"** label should be assigned when + progress fixes to the GitLab issues. The + **"Workflow::In Progress"** label can be assigned when a maintainer starts working on a fix. * When a CVE is allocated, it must be recorded as a comment on the GitLab issue, and the **"CVE::Required"** label replaced by the **"CVE::Assigned"** label. - * The maintainer(s) will update the commit message(s) to include - the assigned CVE and issue URL. If multiple commits are required - to fix an issue the CVE must be included in the final commit in - the series, and may optionally be included in all prior commits. + * The maintainer(s) will update the commit message(s) before + sending a pull request to include the assigned CVE and issue
Quoted 8 lines
contribute/security-process.md be scrubbed before disclosure. · line 108
Quoted 4 lines
contribute/security-process.md +4
-0+ URL in the following format: + + ``` + Fixes: CVE-1980-12345So far we used "Fixes:" to indicate the commit ID of the patch that contained the bug. So maybe it's better to use something like "CVE:" instead?
We've used it alot for CVEs too:
$ git log | grep 'Fixes: CVE' | wc -l 116
Quoted 3 lines
contribute/security-process.md be scrubbed before disclosure. · line 109
Quoted 1 line
contribute/security-process.md +1
-0+ Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/75Maybe best to use a number here that does not exist, e.g. "42".
Oh yes, good idea.
Quoted 14 lines
Thomas
Quoted 9 lines
contribute/security-process.md +7
-0+ Reviewed-by: Not Me <[email protected]> + Signed-off-by: Some One <[email protected]> + ``` + + If multiple commits are required to fix an issue the CVE must + be included in the final commit in the series, and may optionally + be included in all prior commits. * When the maintainer(s) are satisfied that the patch(es) are suitable to propose for merge, they must be submitted to
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com ~~ https://hachyderm.io/@berrange :| |: https://libvirt.org ~~ https://entangle-photo.org :| |: https://pixelfed.art/berrange ~~ https://fstop138.berrange.com :|
Quoted 42 lines · Daniel P. Berrangé
Quoted 32 lines · Thomas Huth
Quoted 31 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>---
This incorporates the feedback that Michael provided on the just merged security process changes.
contribute/security-process.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)contribute/security-process.md +4
-7@@ -92,19 +92,28 @@ be scrubbed before disclosure. * The maintainer(s) will develop and/or review patch(es) for the issue privately, optionally attaching work in - progress fixes to the GitLab issues. All patches must - include the issue URL in the commit message(s). The - **"Workflow::In Progress"** label should be assigned when + progress fixes to the GitLab issues. The + **"Workflow::In Progress"** label can be assigned when a maintainer starts working on a fix. * When a CVE is allocated, it must be recorded as a comment on the GitLab issue, and the **"CVE::Required"** label replaced by the **"CVE::Assigned"** label. - * The maintainer(s) will update the commit message(s) to include - the assigned CVE and issue URL. If multiple commits are required - to fix an issue the CVE must be included in the final commit in - the series, and may optionally be included in all prior commits. + * The maintainer(s) will update the commit message(s) before + sending a pull request to include the assigned CVE and issueQuoted 8 lines
contribute/security-process.md be scrubbed before disclosure. · line 108
Quoted 4 lines
contribute/security-process.md +4
-0+ URL in the following format: + + ``` + Fixes: CVE-1980-12345So far we used "Fixes:" to indicate the commit ID of the patch that contained the bug. So maybe it's better to use something like "CVE:" instead?
Quoted 4 lines
We've used it alot for CVEs too:
$ git log | grep 'Fixes: CVE' | wc -l 116
Ok, then it's fine for me, too.
Thomas
Quoted 24 lines
Quoted 4 lines
contribute/security-process.md be scrubbed before disclosure. · line 109
Quoted 2 lines
contribute/security-process.md +1
-0+ Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/75Maybe best to use a number here that does not exist, e.g. "42".
Oh yes, good idea.
Quoted 14 lines
Thomas
Quoted 9 lines
contribute/security-process.md +7
-0+ Reviewed-by: Not Me <[email protected]> + Signed-off-by: Some One <[email protected]> + ``` + + If multiple commits are required to fix an issue the CVE must + be included in the final commit in the series, and may optionally + be included in all prior commits. * When the maintainer(s) are satisfied that the patch(es) are suitable to propose for merge, they must be submitted toWith regards,
Daniel