summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/index.rst1
-rw-r--r--documentation/dev-manual/security-subjects.rst194
-rw-r--r--documentation/index.rst7
-rw-r--r--documentation/migration-guides/release-notes-4.3.rst2
-rw-r--r--documentation/security-reference/index.rst14
-rw-r--r--documentation/security-reference/reporting-vulnerabilities.rst85
-rw-r--r--documentation/security-reference/security-team.rst110
7 files changed, 216 insertions, 197 deletions
diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst
index 8243c0f4cb..612fba55e4 100644
--- a/documentation/dev-manual/index.rst
+++ b/documentation/dev-manual/index.rst
@@ -41,7 +41,6 @@ Yocto Project Development Tasks Manual
41 build-quality 41 build-quality
42 debugging 42 debugging
43 licenses 43 licenses
44 security-subjects
45 vulnerabilities 44 vulnerabilities
46 sbom 45 sbom
47 error-reporting-tool 46 error-reporting-tool
diff --git a/documentation/dev-manual/security-subjects.rst b/documentation/dev-manual/security-subjects.rst
deleted file mode 100644
index 1ec7c8b385..0000000000
--- a/documentation/dev-manual/security-subjects.rst
+++ /dev/null
@@ -1,194 +0,0 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Dealing with Vulnerability Reports
4**********************************
5
6The Yocto Project and OpenEmbedded are open-source, community-based projects
7used in numerous products. They assemble multiple other open-source projects,
8and need to handle security issues and practices both internal (in the code
9maintained by both projects), and external (maintained by other projects and
10organizations).
11
12This manual assembles security-related information concerning the whole
13ecosystem. It includes information on reporting a potential security issue,
14the operation of the YP Security team and how to contribute in the
15related code. It is written to be useful for both security researchers and
16YP developers.
17
18How to report a potential security vulnerability?
19=================================================
20
21If you would like to report a public issue (for example, one with a released
22CVE number), please report it using the
23:yocto_bugs:`Security Bugzilla </enter_bug.cgi?product=Security>`.
24
25If you are dealing with a not-yet-released issue, or an urgent one, please send
26a message to security AT yoctoproject DOT org, including as many details as
27possible: the layer or software module affected, the recipe and its version,
28and any example code, if available. This mailing list is monitored by the
29Yocto Project Security team.
30
31For each layer, you might also look for specific instructions (if any) for
32reporting potential security issues in the specific ``SECURITY.md`` file at the
33root of the repository. Instructions on how and where submit a patch are
34usually available in ``README.md``. If this is your first patch to the
35Yocto Project/OpenEmbedded, you might want to have a look into the
36Contributor's Manual section
37":ref:`contributor-guide/submit-changes:preparing changes for submission`".
38
39Branches maintained with security fixes
40---------------------------------------
41
42See the
43:ref:`Release process <ref-manual/release-process:Stable Release Process>`
44documentation for details regarding the policies and maintenance of stable
45branches.
46
47The :yocto_home:`Releases </development/releases/>` page contains a list of all
48releases of the Yocto Project, grouped into current and previous releases.
49Previous releases are no longer actively maintained with security patches, but
50well-tested patches may still be accepted for them for significant issues.
51
52Security-related discussions at the Yocto Project
53-------------------------------------------------
54
55We have set up two security-related emails/mailing lists:
56
57 - Public Mailing List: yocto [dash] security [at] yoctoproject[dot] org
58
59 This is a public mailing list for anyone to subscribe to. This list is an
60 open list to discuss public security issues/patches and security-related
61 initiatives. For more information, including subscription information,
62 please see the :yocto_lists:`yocto-security mailing list info page
63 </g/yocto-security>`.
64
65 This list requires moderator approval for new topics to be posted, to avoid
66 private security reports to be posted by mistake.
67
68 - Yocto Project Security Team: security [at] yoctoproject [dot] org
69
70 This is an email for reporting non-published potential vulnerabilities.
71 Emails sent to this address are forwarded to the Yocto Project Security
72 Team members.
73
74
75What you should do if you find a security vulnerability
76-------------------------------------------------------
77
78If you find a security flaw: a crash, an information leakage, or anything that
79can have a security impact if exploited in any Open Source software built or
80used by the Yocto Project, please report this to the Yocto Project Security
81Team. If you prefer to contact the upstream project directly, please send a
82copy to the security team at the Yocto Project as well. If you believe this is
83highly sensitive information, please report the vulnerability in a secure way,
84i.e. encrypt the email and send it to the private list. This ensures that
85the exploit is not leaked and exploited before a response/fix has been generated.
86
87Security team
88=============
89
90The Yocto Project/OpenEmbedded security team coordinates the work on security
91subjects in the project. All general discussion takes place publicly. The
92Security Team only uses confidential communication tools to deal with private
93vulnerability reports before they are released.
94
95Security team appointment
96-------------------------
97
98The Yocto Project Security Team consists of at least three members. When new
99members are needed, the Yocto Project Technical Steering Committee (YP TSC)
100asks for nominations by public channels including a nomination deadline.
101Self-nominations are possible. When the limit time is
102reached, the YP TSC posts the list of candidates for the comments of project
103participants and developers. Comments may be sent publicly or privately to the
104YP and OE TSCs. The candidates are approved by both YP TSC and OpenEmbedded
105Technical Steering Committee (OE TSC) and the final list of the team members
106is announced publicly. The aim is to have people representing technical
107leadership, security knowledge and infrastructure present with enough people
108to provide backup/coverage but keep the notification list small enough to
109minimize information risk and maintain trust.
110
111YP Security Team members may resign at any time.
112
113Security Team Operations
114------------------------
115
116The work of the Security Team might require high confidentiality. Team members
117are individuals selected by merit and do not represent the companies they work
118for. They do not share information about confidential issues outside of the team
119and do not hint about ongoing embargoes.
120
121Team members can bring in domain experts as needed. Those people should be
122added to individual issues only and adhere to the same standards as the YP
123Security Team.
124
125The YP security team organizes its meetings and communication as needed.
126
127When the YP Security team receives a report about a potential security
128vulnerability, they quickly analyze and notify the reporter of the result.
129They might also request more information.
130
131If the issue is confirmed and affects the code maintained by the YP, they
132confidentially notify maintainers of that code and work with them to prepare
133a fix.
134
135If the issue is confirmed and affects an upstream project, the YP security team
136notifies the project. Usually, the upstream project analyzes the problem again.
137If they deem it a real security problem in their software, they develop and
138release a fix following their security policy. They may want to include the
139original reporter in the loop. There is also sometimes some coordination for
140handling patches, backporting patches etc, or just understanding the problem
141or what caused it.
142
143When the fix is publicly available, the YP security team member or the
144package maintainer sends patches against the YP code base, following usual
145procedures, including public code review.
146
147What Yocto Security Team does when it receives a security vulnerability
148-----------------------------------------------------------------------
149
150The YP Security Team team performs a quick analysis and would usually report
151the flaw to the upstream project. Normally the upstream project analyzes the
152problem. If they deem it a real security problem in their software, they
153develop and release a fix following their own security policy. They may want
154to include the original reporter in the loop. There is also sometimes some
155coordination for handling patches, backporting patches etc, or just
156understanding the problem or what caused it.
157
158The security policy of the upstream project might include a notification to
159Linux distributions or other important downstream projects in advance to
160discuss coordinated disclosure. These mailing lists are normally non-public.
161
162When the upstream project releases a version with the fix, they are responsible
163for contacting `Mitre <https://www.cve.org/>`__ to get a CVE number assigned and
164the CVE record published.
165
166If an upstream project does not respond quickly
167-----------------------------------------------
168
169If an upstream project does not fix the problem in a reasonable time,
170the Yocto's Security Team will contact other interested parties (usually
171other distributions) in the community and together try to solve the
172vulnerability as quickly as possible.
173
174The Yocto Project Security team adheres to the 90 days disclosure policy
175by default. An increase of the embargo time is possible when necessary.
176
177Current Security Team members
178-----------------------------
179
180For secure communications, please send your messages encrypted using the GPG
181keys. Remember, message headers are not encrypted so do not include sensitive
182information in the subject line.
183
184 - Ross Burton: <ross@burtonini.com> `Public key <https://keys.openpgp.org/search?q=ross%40burtonini.com>`__
185
186 - Michael Halstead: <mhalstead [at] linuxfoundation [dot] org>
187 `Public key <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x3373170601861969>`__
188 or `Public key <https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xd1f2407285e571ed12a407a73373170601861969>`__
189
190 - Richard Purdie: <richard.purdie@linuxfoundation.org> `Public key <https://keys.openpgp.org/search?q=richard.purdie%40linuxfoundation.org>`__
191
192 - Marta Rybczynska: <marta DOT rybczynska [at] syslinbit [dot] com> `Public key <https://keys.openpgp.org/search?q=marta.rybczynska@syslinbit.com>`__
193
194 - Steve Sakoman: <steve [at] sakoman [dot] com> `Public key <https://keys.openpgp.org/search?q=steve%40sakoman.com>`__
diff --git a/documentation/index.rst b/documentation/index.rst
index 6c6be38a7e..037edcee61 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -20,7 +20,6 @@ Welcome to the Yocto Project Documentation
20 Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/> 20 Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/>
21 Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks> 21 Tips and Tricks Wiki <https://wiki.yoctoproject.org/wiki/TipsAndTricks>
22 22
23
24.. toctree:: 23.. toctree::
25 :maxdepth: 1 24 :maxdepth: 1
26 :caption: Manuals 25 :caption: Manuals
@@ -39,6 +38,12 @@ Welcome to the Yocto Project Documentation
39 38
40.. toctree:: 39.. toctree::
41 :maxdepth: 1 40 :maxdepth: 1
41 :caption: Security
42
43 Yocto Project Security Reference <security-reference/index>
44
45.. toctree::
46 :maxdepth: 1
42 :caption: Release Manuals 47 :caption: Release Manuals
43 :hidden: 48 :hidden:
44 49
diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst
index 0103ac985e..797e1cf74b 100644
--- a/documentation/migration-guides/release-notes-4.3.rst
+++ b/documentation/migration-guides/release-notes-4.3.rst
@@ -274,7 +274,7 @@ New Features / Enhancements in 4.3
274 274
275 - New :doc:`../contributor-guide/index` document. 275 - New :doc:`../contributor-guide/index` document.
276 276
277 - New :doc:`../dev-manual/security-subjects` chapter in the Development 277 - New "Dealing with Vulnerability Reports" chapter in the Development
278 Tasks Manual. 278 Tasks Manual.
279 279
280 - Long overdue documentation for the :ref:`ref-classes-devicetree` class. 280 - Long overdue documentation for the :ref:`ref-classes-devicetree` class.
diff --git a/documentation/security-reference/index.rst b/documentation/security-reference/index.rst
new file mode 100644
index 0000000000..c20a54d1a9
--- /dev/null
+++ b/documentation/security-reference/index.rst
@@ -0,0 +1,14 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3================================
4Yocto Project Security Reference
5================================
6
7.. toctree::
8 :caption: Table of Contents
9 :numbered:
10
11 security-team
12 reporting-vulnerabilities
13
14.. include:: /boilerplate.rst
diff --git a/documentation/security-reference/reporting-vulnerabilities.rst b/documentation/security-reference/reporting-vulnerabilities.rst
new file mode 100644
index 0000000000..0c457278d5
--- /dev/null
+++ b/documentation/security-reference/reporting-vulnerabilities.rst
@@ -0,0 +1,85 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Reporting Vulnerabilities
4*************************
5
6The Yocto Project and OpenEmbedded are open-source, community-based projects
7used in numerous products. They assemble multiple other open-source projects,
8and need to handle security issues and practices both internal (in the code
9maintained by both projects), and external (maintained by other projects and
10organizations).
11
12This manual assembles security-related information concerning the whole
13ecosystem. It includes information on reporting a potential security issue,
14the operation of the YP Security team and how to contribute in the
15related code. It is written to be useful for both security researchers and
16YP developers.
17
18How to report a potential security vulnerability?
19=================================================
20
21If you would like to report a public issue (for example, one with a released
22CVE number), please report it using the
23:yocto_bugs:`Security Bugzilla </enter_bug.cgi?product=Security>`.
24
25If you are dealing with a not-yet-released issue, or an urgent one, please send
26a message to security AT yoctoproject DOT org, including as many details as
27possible: the layer or software module affected, the recipe and its version,
28and any example code, if available. This mailing list is monitored by the
29Yocto Project Security team.
30
31For each layer, you might also look for specific instructions (if any) for
32reporting potential security issues in the specific ``SECURITY.md`` file at the
33root of the repository. Instructions on how and where submit a patch are
34usually available in ``README.md``. If this is your first patch to the
35Yocto Project/OpenEmbedded, you might want to have a look into the
36Contributor's Manual section
37":ref:`contributor-guide/submit-changes:preparing changes for submission`".
38
39Branches maintained with security fixes
40---------------------------------------
41
42See the
43:ref:`Release process <ref-manual/release-process:Stable Release Process>`
44documentation for details regarding the policies and maintenance of stable
45branches.
46
47The :yocto_home:`Releases </development/releases/>` page contains a list of all
48releases of the Yocto Project, grouped into current and previous releases.
49Previous releases are no longer actively maintained with security patches, but
50well-tested patches may still be accepted for them for significant issues.
51
52Security-related discussions at the Yocto Project
53-------------------------------------------------
54
55We have set up two security-related emails/mailing lists:
56
57 - Public Mailing List: yocto [dash] security [at] yoctoproject[dot] org
58
59 This is a public mailing list for anyone to subscribe to. This list is an
60 open list to discuss public security issues/patches and security-related
61 initiatives. For more information, including subscription information,
62 please see the :yocto_lists:`yocto-security mailing list info page
63 </g/yocto-security>`.
64
65 This list requires moderator approval for new topics to be posted, to avoid
66 private security reports to be posted by mistake.
67
68 - Yocto Project Security Team: security [at] yoctoproject [dot] org
69
70 This is an email for reporting non-published potential vulnerabilities.
71 Emails sent to this address are forwarded to the Yocto Project Security
72 Team members.
73
74
75What you should do if you find a security vulnerability
76-------------------------------------------------------
77
78If you find a security flaw: a crash, an information leakage, or anything that
79can have a security impact if exploited in any Open Source software built or
80used by the Yocto Project, please report this to the Yocto Project Security
81Team. If you prefer to contact the upstream project directly, please send a
82copy to the security team at the Yocto Project as well. If you believe this is
83highly sensitive information, please report the vulnerability in a secure way,
84i.e. encrypt the email and send it to the private list. This ensures that
85the exploit is not leaked and exploited before a response/fix has been generated.
diff --git a/documentation/security-reference/security-team.rst b/documentation/security-reference/security-team.rst
new file mode 100644
index 0000000000..b773653822
--- /dev/null
+++ b/documentation/security-reference/security-team.rst
@@ -0,0 +1,110 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Security team
4*************
5
6The Yocto Project/OpenEmbedded security team coordinates the work on security
7subjects in the project. All general discussion takes place publicly. The
8Security Team only uses confidential communication tools to deal with private
9vulnerability reports before they are released.
10
11Security team appointment
12=========================
13
14The Yocto Project Security Team consists of at least three members. When new
15members are needed, the Yocto Project Technical Steering Committee (YP TSC)
16asks for nominations by public channels including a nomination deadline.
17Self-nominations are possible. When the limit time is
18reached, the YP TSC posts the list of candidates for the comments of project
19participants and developers. Comments may be sent publicly or privately to the
20YP and OE TSCs. The candidates are approved by both YP TSC and OpenEmbedded
21Technical Steering Committee (OE TSC) and the final list of the team members
22is announced publicly. The aim is to have people representing technical
23leadership, security knowledge and infrastructure present with enough people
24to provide backup/coverage but keep the notification list small enough to
25minimize information risk and maintain trust.
26
27YP Security Team members may resign at any time.
28
29Security Team Operations
30========================
31
32The work of the Security Team might require high confidentiality. Team members
33are individuals selected by merit and do not represent the companies they work
34for. They do not share information about confidential issues outside of the team
35and do not hint about ongoing embargoes.
36
37Team members can bring in domain experts as needed. Those people should be
38added to individual issues only and adhere to the same standards as the YP
39Security Team.
40
41The YP security team organizes its meetings and communication as needed.
42
43When the YP Security team receives a report about a potential security
44vulnerability, they quickly analyze and notify the reporter of the result.
45They might also request more information.
46
47If the issue is confirmed and affects the code maintained by the YP, they
48confidentially notify maintainers of that code and work with them to prepare
49a fix.
50
51If the issue is confirmed and affects an upstream project, the YP security team
52notifies the project. Usually, the upstream project analyzes the problem again.
53If they deem it a real security problem in their software, they develop and
54release a fix following their security policy. They may want to include the
55original reporter in the loop. There is also sometimes some coordination for
56handling patches, backporting patches etc, or just understanding the problem
57or what caused it.
58
59When the fix is publicly available, the YP security team member or the
60package maintainer sends patches against the YP code base, following usual
61procedures, including public code review.
62
63What Yocto Security Team does when it receives a security vulnerability
64=======================================================================
65
66The YP Security Team team performs a quick analysis and would usually report
67the flaw to the upstream project. Normally the upstream project analyzes the
68problem. If they deem it a real security problem in their software, they
69develop and release a fix following their own security policy. They may want
70to include the original reporter in the loop. There is also sometimes some
71coordination for handling patches, backporting patches etc, or just
72understanding the problem or what caused it.
73
74The security policy of the upstream project might include a notification to
75Linux distributions or other important downstream projects in advance to
76discuss coordinated disclosure. These mailing lists are normally non-public.
77
78When the upstream project releases a version with the fix, they are responsible
79for contacting `Mitre <https://www.cve.org/>`__ to get a CVE number assigned and
80the CVE record published.
81
82If an upstream project does not respond quickly
83===============================================
84
85If an upstream project does not fix the problem in a reasonable time,
86the Yocto's Security Team will contact other interested parties (usually
87other distributions) in the community and together try to solve the
88vulnerability as quickly as possible.
89
90The Yocto Project Security team adheres to the 90 days disclosure policy
91by default. An increase of the embargo time is possible when necessary.
92
93Security Team Members
94=====================
95
96For secure communications, please send your messages encrypted using the GPG
97keys. Remember, message headers are not encrypted so do not include sensitive
98information in the subject line.
99
100- Ross Burton: <ross [at] burtonini [dot] com> `Public key <https://keys.openpgp.org/search?q=ross%40burtonini.com>`__
101
102- Michael Halstead: <mhalstead [at] linuxfoundation [dot] org>
103 `Public key <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x3373170601861969>`__
104 or `Public key <https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xd1f2407285e571ed12a407a73373170601861969>`__
105
106- Richard Purdie: <richard.purdie [at] linuxfoundation [dot] org> `Public key <https://keys.openpgp.org/search?q=richard.purdie%40linuxfoundation.org>`__
107
108- Marta Rybczynska: <marta DOT rybczynska [at] syslinbit [dot] com> `Public key <https://keys.openpgp.org/search?q=marta.rybczynska@syslinbit.com>`__
109
110- Steve Sakoman: <steve [at] sakoman [dot] com> `Public key <https://keys.openpgp.org/search?q=steve%40sakoman.com>`__