Documentation: embargoed-hardware-issues.rst: minor cleanups and fixes

The embargoed-hardware-issues.rst file needed a bunch of minor grammar,
punctuation, and syntax cleanups based on feedback we have gotten over
the past few years. The main change here is the term "silicon" being
used over "hardware" to differentiate between companies that make a chip
(i.e. a CPU) and those that take the chip and put it into their system.

No process changes are made here at all, only clarification for the way
the current process works.

All of these changes have been approved by a review from a large number
of different open source legal members, representing the companies
involved in this process.

Acked-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/2024073032-outsource-sniff-e8ea@gregkh
Co-developed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Co-developed-by: Michael Dolan <mdolan@linuxfoundation.org>
Signed-off-by: Michael Dolan <mdolan@linuxfoundation.org>
Co-developed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

+65 -57
+65 -57
Documentation/process/embargoed-hardware-issues.rst
··· 13 13 Hardware issues like Meltdown, Spectre, L1TF etc. must be treated 14 14 differently because they usually affect all Operating Systems ("OS") and 15 15 therefore need coordination across different OS vendors, distributions, 16 - hardware vendors and other parties. For some of the issues, software 17 - mitigations can depend on microcode or firmware updates, which need further 18 - coordination. 16 + silicon vendors, hardware integrators, and other parties. For some of the 17 + issues, software mitigations can depend on microcode or firmware updates, 18 + which need further coordination. 19 19 20 20 .. _Contact: 21 21 ··· 32 32 <securitybugs>`) instead. 33 33 34 34 The team can be contacted by email at <hardware-security@kernel.org>. This 35 - is a private list of security officers who will help you to coordinate a 36 - fix according to our documented process. 35 + is a private list of security officers who will help you coordinate a fix 36 + according to our documented process. 37 37 38 38 The list is encrypted and email to the list can be sent by either PGP or 39 39 S/MIME encrypted and must be signed with the reporter's PGP key or S/MIME ··· 43 43 - PGP: https://www.kernel.org/static/files/hardware-security.asc 44 44 - S/MIME: https://www.kernel.org/static/files/hardware-security.crt 45 45 46 - While hardware security issues are often handled by the affected hardware 46 + While hardware security issues are often handled by the affected silicon 47 47 vendor, we welcome contact from researchers or individuals who have 48 48 identified a potential hardware flaw. 49 49 ··· 65 65 ability to access the embargoed information, but are obliged to 66 66 confidentiality by their employment contract. Linux Foundation IT 67 67 personnel are also responsible for operating and managing the rest of 68 - kernel.org infrastructure. 68 + kernel.org's infrastructure. 69 69 70 70 The Linux Foundation's current director of IT Project infrastructure is 71 71 Konstantin Ryabitsev. ··· 85 85 86 86 The Linux kernel community has a deep understanding of the requirement to 87 87 keep hardware security issues under embargo for coordination between 88 - different OS vendors, distributors, hardware vendors and other parties. 88 + different OS vendors, distributors, silicon vendors, and other parties. 89 89 90 90 The Linux kernel community has successfully handled hardware security 91 91 issues in the past and has the necessary mechanisms in place to allow ··· 103 103 All involved developers pledge to adhere to the embargo rules and to keep 104 104 the received information confidential. Violation of the pledge will lead to 105 105 immediate exclusion from the current issue and removal from all related 106 - mailing-lists. In addition, the hardware security team will also exclude 106 + mailing lists. In addition, the hardware security team will also exclude 107 107 the offender from future issues. The impact of this consequence is a highly 108 108 effective deterrent in our community. In case a violation happens the 109 109 hardware security team will inform the involved parties immediately. If you 110 - or anyone becomes aware of a potential violation, please report it 110 + or anyone else becomes aware of a potential violation, please report it 111 111 immediately to the Hardware security officers. 112 112 113 113 ··· 124 124 Start of Disclosure 125 125 """"""""""""""""""" 126 126 127 - Disclosure starts by contacting the Linux kernel hardware security team by 128 - email. This initial contact should contain a description of the problem and 129 - a list of any known affected hardware. If your organization builds or 130 - distributes the affected hardware, we encourage you to also consider what 131 - other hardware could be affected. 127 + Disclosure starts by emailing the Linux kernel hardware security team per 128 + the Contact section above. This initial contact should contain a 129 + description of the problem and a list of any known affected silicon. If 130 + your organization builds or distributes the affected hardware, we encourage 131 + you to also consider what other hardware could be affected. The disclosing 132 + party is responsible for contacting the affected silicon vendors in a 133 + timely manner. 132 134 133 135 The hardware security team will provide an incident-specific encrypted 134 - mailing-list which will be used for initial discussion with the reporter, 136 + mailing list which will be used for initial discussion with the reporter, 135 137 further disclosure, and coordination of fixes. 136 138 137 139 The hardware security team will provide the disclosing party a list of ··· 160 158 - The disclosed entities can be contacted to name experts who should 161 159 participate in the mitigation development. 162 160 163 - - If an expert which is required to handle an issue is employed by an 164 - listed entity or member of an listed entity, then the response teams can 161 + - If an expert who is required to handle an issue is employed by a listed 162 + entity or member of an listed entity, then the response teams can 165 163 request the disclosure of that expert from that entity. This ensures 166 164 that the expert is also part of the entity's response team. 167 165 ··· 171 169 The disclosing party provides detailed information to the initial response 172 170 team via the specific encrypted mailing-list. 173 171 174 - From our experience the technical documentation of these issues is usually 175 - a sufficient starting point and further technical clarification is best 172 + From our experience, the technical documentation of these issues is usually 173 + a sufficient starting point, and further technical clarification is best 176 174 done via email. 177 175 178 176 Mitigation development ··· 181 179 The initial response team sets up an encrypted mailing-list or repurposes 182 180 an existing one if appropriate. 183 181 184 - Using a mailing-list is close to the normal Linux development process and 185 - has been successfully used in developing mitigations for various hardware 182 + Using a mailing list is close to the normal Linux development process and 183 + has been successfully used to develop mitigations for various hardware 186 184 security issues in the past. 187 185 188 - The mailing-list operates in the same way as normal Linux development. 189 - Patches are posted, discussed and reviewed and if agreed on applied to a 190 - non-public git repository which is only accessible to the participating 186 + The mailing list operates in the same way as normal Linux development. 187 + Patches are posted, discussed, and reviewed and if agreed upon, applied to 188 + a non-public git repository which is only accessible to the participating 191 189 developers via a secure connection. The repository contains the main 192 190 development branch against the mainline kernel and backport branches for 193 191 stable kernel versions as necessary. 194 192 195 193 The initial response team will identify further experts from the Linux 196 - kernel developer community as needed. Bringing in experts can happen at any 197 - time of the development process and needs to be handled in a timely manner. 194 + kernel developer community as needed. Any involved party can suggest 195 + further experts to be included, each of which will be subject to the same 196 + requirements outlined above. 198 197 199 - If an expert is employed by or member of an entity on the disclosure list 198 + Bringing in experts can happen at any time in the development process and 199 + needs to be handled in a timely manner. 200 + 201 + If an expert is employed by or a member of an entity on the disclosure list 200 202 provided by the disclosing party, then participation will be requested from 201 203 the relevant entity. 202 204 203 - If not, then the disclosing party will be informed about the experts 205 + If not, then the disclosing party will be informed about the experts' 204 206 participation. The experts are covered by the Memorandum of Understanding 205 - and the disclosing party is requested to acknowledge the participation. In 206 - case that the disclosing party has a compelling reason to object, then this 207 - objection has to be raised within five work days and resolved with the 208 - incident team immediately. If the disclosing party does not react within 209 - five work days this is taken as silent acknowledgement. 207 + and the disclosing party is requested to acknowledge their participation. 208 + In the case where the disclosing party has a compelling reason to object, 209 + any objection must to be raised within five working days and resolved with 210 + the incident team immediately. If the disclosing party does not react 211 + within five working days this is taken as silent acknowledgment. 210 212 211 - After acknowledgement or resolution of an objection the expert is disclosed 212 - by the incident team and brought into the development process. 213 + After the incident team acknowledges or resolves an objection, the expert 214 + is disclosed and brought into the development process. 213 215 214 216 List participants may not communicate about the issue outside of the 215 217 private mailing list. List participants may not use any shared resources ··· 223 217 Coordinated release 224 218 """"""""""""""""""" 225 219 226 - The involved parties will negotiate the date and time where the embargo 227 - ends. At that point the prepared mitigations are integrated into the 228 - relevant kernel trees and published. There is no pre-notification process: 229 - fixes are published in public and available to everyone at the same time. 220 + The involved parties will negotiate the date and time when the embargo 221 + ends. At that point, the prepared mitigations are published into the 222 + relevant kernel trees. There is no pre-notification process: the 223 + mitigations are published in public and available to everyone at the same 224 + time. 230 225 231 226 While we understand that hardware security issues need coordinated embargo 232 - time, the embargo time should be constrained to the minimum time which is 233 - required for all involved parties to develop, test and prepare the 227 + time, the embargo time should be constrained to the minimum time that is 228 + required for all involved parties to develop, test, and prepare their 234 229 mitigations. Extending embargo time artificially to meet conference talk 235 - dates or other non-technical reasons is creating more work and burden for 236 - the involved developers and response teams as the patches need to be kept 237 - up to date in order to follow the ongoing upstream kernel development, 238 - which might create conflicting changes. 230 + dates or other non-technical reasons creates more work and burden for the 231 + involved developers and response teams as the patches need to be kept up to 232 + date in order to follow the ongoing upstream kernel development, which 233 + might create conflicting changes. 239 234 240 235 CVE assignment 241 236 """""""""""""" ··· 282 275 283 276 If you want your organization to be added to the ambassadors list, please 284 277 contact the hardware security team. The nominated ambassador has to 285 - understand and support our process fully and is ideally well connected in 278 + understand and support our process fully and is ideally well-connected in 286 279 the Linux kernel community. 287 280 288 281 Encrypted mailing-lists 289 282 ----------------------- 290 283 291 - We use encrypted mailing-lists for communication. The operating principle 284 + We use encrypted mailing lists for communication. The operating principle 292 285 of these lists is that email sent to the list is encrypted either with the 293 - list's PGP key or with the list's S/MIME certificate. The mailing-list 286 + list's PGP key or with the list's S/MIME certificate. The mailing list 294 287 software decrypts the email and re-encrypts it individually for each 295 288 subscriber with the subscriber's PGP key or S/MIME certificate. Details 296 - about the mailing-list software and the setup which is used to ensure the 289 + about the mailing list software and the setup that is used to ensure the 297 290 security of the lists and protection of the data can be found here: 298 291 https://korg.wiki.kernel.org/userdoc/remail. 299 292 300 293 List keys 301 294 ^^^^^^^^^ 302 295 303 - For initial contact see :ref:`Contact`. For incident specific mailing-lists 304 - the key and S/MIME certificate are conveyed to the subscribers by email 305 - sent from the specific list. 296 + For initial contact see the :ref:`Contact` section above. For incident 297 + specific mailing lists, the key and S/MIME certificate are conveyed to the 298 + subscribers by email sent from the specific list. 306 299 307 - Subscription to incident specific lists 300 + Subscription to incident-specific lists 308 301 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 309 302 310 - Subscription is handled by the response teams. Disclosed parties who want 311 - to participate in the communication send a list of potential subscribers to 312 - the response team so the response team can validate subscription requests. 303 + Subscription to incident-specific lists is handled by the response teams. 304 + Disclosed parties who want to participate in the communication send a list 305 + of potential experts to the response team so the response team can validate 306 + subscription requests. 313 307 314 308 Each subscriber needs to send a subscription request to the response team 315 309 by email. The email must be signed with the subscriber's PGP key or S/MIME