Skip to content

Commit 67032df

Browse files
ci: Apply prettier lint suggestions
This is blocking [new proposals][1] from passing CI. [1]: https://gerrit.openbmc.org/c/openbmc/docs/+/76147 Change-Id: I3df57bd4e1abec93cb1775aa291295de9fa083f2 Signed-off-by: Peter Delevoryas <peter@pjd.dev>
1 parent dfd4abd commit 67032df

14 files changed

+70
-59
lines changed

SECURITY.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,16 @@ the problem. Activities may include:
2929
- Privately engage community members to understand and address the problem.
3030
Anyone brought onboard should be given a link to the OpenBMC [security
3131
response team guidelines][].
32-
- Work to determine the scope and severity of the problem, such as [CVSS metrics][].
32+
- Work to determine the scope and severity of the problem, such as [CVSS
33+
metrics][].
3334
- Work to create or identify an existing [CVE][].
3435
- Coordinate workarounds and fixes with you and the community.
3536
- Coordinate announcement details with you, such as timing or how you want to be
3637
credited.
3738
- Create an OpenBMC security advisory.
3839

39-
Please refer to the [CERT Guide to Coordinated Vulnerability Disclosure][], (SPECIAL
40-
REPORT CMU/SEI-2017-SR-022) for additional considerations.
40+
Please refer to the [CERT Guide to Coordinated Vulnerability Disclosure][],
41+
(SPECIAL REPORT CMU/SEI-2017-SR-022) for additional considerations.
4142

4243
Alternatives to this process:
4344

architecture/code-update/emmc-storage-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ based on AST2400 and AST2500, but there is no design for managed NAND.
135135

136136
- No initramfs: It may be possible to boot the rootfs by passing the UUID of the
137137
logical volume to the kernel, although a [pre-init script][] will likely still
138-
be needed. Therefore, having an initramfs would offer a more standard implementation
139-
for initialization.
138+
be needed. Therefore, having an initramfs would offer a more standard
139+
implementation for initialization.
140140

141141
- FAT MBR partitioning: FAT is a simple and well understood partition table
142142
format. There is space for 4 independent partitions. Alternatively one slot

architecture/code-update/flash-layout.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ and how code update updates the flash modules and boots the new image. See
1010

1111
### Boot loading and init
1212

13-
For system initialization and bootstrap, [Das U-Boot][] was selected as the bootloader.
13+
For system initialization and bootstrap, [Das U-Boot][] was selected as the
14+
bootloader.
1415

1516
After basic initialization of the system, the bootloader may present a prompt
1617
and/or start automatic boot. The commands and/or data to select the boot image

architecture/interface-overview.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ and service shown.
2323

2424
OpenBMC's services and the interfaces they provide are controlled by `systemd`.
2525
This document references OpenBMC `systemd` unit names to help link concepts to
26-
the source code. The reader is assumed to be familiar with [systemd
27-
concepts][]. The templated units ("unit@.service") may be omitted for clarity. Relevant
28-
details from the unit file may be shown, such as the program which implements a service.
26+
the source code. The reader is assumed to be familiar with [systemd concepts][].
27+
The templated units ("unit@.service") may be omitted for clarity. Relevant
28+
details from the unit file may be shown, such as the program which implements a
29+
service.
2930

3031
The OpenBMC [Service Management][] interface can control `systemd` services. For
31-
example, disabling a BMC service will disable the corresponding external interface.
32+
example, disabling a BMC service will disable the corresponding external
33+
interface.
3234

3335
[systemd concepts]:
3436
https://www.freedesktop.org/software/systemd/man/systemd.html#Concepts
@@ -250,8 +252,8 @@ for example Unix domain sockets.
250252
+--------------------------------------------------+
251253
```
252254

253-
To learn more, read the [Phosphor D-Bus interface docs][] and search for README files
254-
in various subdirectories under the xyz/openbmc_project path.
255+
To learn more, read the [Phosphor D-Bus interface docs][] and search for README
256+
files in various subdirectories under the xyz/openbmc_project path.
255257

256258
[phosphor d-bus interface docs]:
257259
https://github.com/openbmc/phosphor-dbus-interfaces

community-membership.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ roles are scoped to these subrepos.
1515

1616
## New contributors
1717

18-
[New contributors] should be welcomed to the community by existing members, helped
19-
with review workflow, and directed to relevant documentation and communication channels.
18+
[New contributors] should be welcomed to the community by existing members,
19+
helped with review workflow, and directed to relevant documentation and
20+
communication channels.
2021

2122
## Established community members
2223

designs/dump-manager.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,8 @@ which collects the dumps from BMC.
165165
come from a parallel class with this specific Enum name. All of the Enum
166166
strings should be in the format
167167
'domain.Dump.Create.CreateParameters.ParamName'. e.g.: { "key1": "value1",
168-
"key2": "value2" } ends up in AdditionaData like: ["KEY1=value1", "KEY2=value2"]
168+
"key2": "value2" } ends up in AdditionaData like: ["KEY1=value1",
169+
"KEY2=value2"]
169170

170171
- **Notify**: Notify the dump manager that a new dump is created.
171172
- ID: ID of the dump, if not 0 this will be the external id of the dump

designs/entity-manager-hw-id-vpd-discover-via-device-tree.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -307,9 +307,9 @@ https://github.com/openbmc/technical-oversight-forum/issues/38
307307

308308
8. Proposal: xyz.openbmc_project.MachineContext
309309

310-
Rejection: "We have all this stuff [.Model, .SerialNumber, ect. properties] defined
311-
already. I'm not going to accept a new "bunch of random properties HPe thinks
312-
are important [today] globbed into a new interface" interface"
310+
Rejection: "We have all this stuff [.Model, .SerialNumber, ect. properties]
311+
defined already. I'm not going to accept a new "bunch of random properties
312+
HPe thinks are important [today] globbed into a new interface" interface"
313313

314314
- Patrick Williams, Phosphor-dbus-interfaces maintainer.
315315

designs/expired-password.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ PasswordChangeRequired the same as an account that is invalid for any other
3737
reason. Some servers (such as the OpenSSH server) handle the
3838
PasswordChangeRequired by implementing a "password change dialog".
3939

40-
The [Redfish Specification version 1.7.0][] section 13.2.6.1 ("Password change required
41-
handling") provides the ManagerAccount resource v1.3 with a PasswordChangeRequired
42-
property which supports a password change dialog.
40+
The [Redfish Specification version 1.7.0][] section 13.2.6.1 ("Password change
41+
required handling") provides the ManagerAccount resource v1.3 with a
42+
PasswordChangeRequired property which supports a password change dialog.
4343

4444
[redfish specification version 1.7.0]:
4545
https://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.7.0.pdf

designs/vpd-collection.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ Created: 2019-06-11
88

99
On OpenBMC, Vital Product Data (VPD) collection is limited to only one or two
1010
Field Replaceable Units (FRUs) today - one example is the BMC FRU. On OpenPower
11-
systems, the BMC also supports just one VPD format, the [OpenPower VPD] [1] format.
12-
As a part of its enterprise class servers, IBM will use the IPZ format VPD, which
13-
the BMC currently does not support. Certain FRUs also have keyword format VPD.
11+
systems, the BMC also supports just one VPD format, the [OpenPower VPD] [1]
12+
format. As a part of its enterprise class servers, IBM will use the IPZ format
13+
VPD, which the BMC currently does not support. Certain FRUs also have keyword
14+
format VPD.
1415

1516
The BMC requires to read VPD for all FRUs for several reasons:
1617

features.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Follow links to learn more about OpenBMC features:
55
- [BMCWeb][] HTTP/Web server
66
- [WebUI Vue][] web application
77
- REST Management: [BMCWeb Redfish][], [Phosphor REST APIs][] includes [Host
8-
management
9-
REST APIs][]
8+
management REST APIs][]
109
- [D-Bus interfaces][] describes internal interfaces
1110
- [D-Bus Object Mapper][]
1211
- [Remote KVM][]

security/how-to-report-a-security-vulnerability.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,16 @@ The collaborators work to resolve the problem. Activities may include:
4444
- Privately engage community members to understand and address the problem.
4545
Anyone brought onboard should be given a link to the OpenBMC [security
4646
response team guidelines][].
47-
- Work to determine the scope and severity of the problem, such as [CVSS metrics][].
47+
- Work to determine the scope and severity of the problem, such as [CVSS
48+
metrics][].
4849
- Coordinate workarounds and fixes with you and the community.
4950
- Coordinate announcement details with you, such as timing or how you want to be
5051
credited.
5152
- At the agreed time, publish the OpenBMC security advisory, reveal the fix, and
5253
publish the CVE.
5354

54-
Please refer to the [CERT Guide to Coordinated Vulnerability Disclosure][], (SPECIAL
55-
REPORT CMU/SEI-2017-SR-022) for additional considerations.
55+
Please refer to the [CERT Guide to Coordinated Vulnerability Disclosure][],
56+
(SPECIAL REPORT CMU/SEI-2017-SR-022) for additional considerations.
5657

5758
Alternatives to this process:
5859

security/network-security-considerations.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ these threats.
66

77
This is only intended to be a guide; security is ultimately the responsibility
88
of projects which choose to incorporate OpenBMC into their project. If you find
9-
a security vulnerability, please consider [how to report a security vulnerability][].
9+
a security vulnerability, please consider [how to report a security
10+
vulnerability][].
1011

1112
[how to report a security vulnerability]:
1213
https://github.com/openbmc/docs/blob/master/security/how-to-report-a-security-vulnerability.md
1314

14-
Threats to the BMC are classified using the [CIA triad][]. All threat types are significant;
15-
here is an example of each:
15+
Threats to the BMC are classified using the [CIA triad][]. All threat types are
16+
significant; here is an example of each:
1617

1718
- Confidentiality: If an attacker can get data from the BMC, they may be able to
1819
chain other vulnerabilities to establish a covert information channel to get
@@ -51,9 +52,9 @@ packages for the BMC referenced by your machine's configuration. For example, in
5152
the `https://github.com/openbmc/meta-aspeed` repository under
5253
`recipes-kernel/linux/linux-aspeed_git.bb`.
5354

54-
Per [CVE 1999-0524][], responding to certain ICMP packets can give an attacker more
55-
information about the BMC's clock or subnet, which can help with subsequent attacks.
56-
OpenBMC responds to all ICMP requests.
55+
Per [CVE 1999-0524][], responding to certain ICMP packets can give an attacker
56+
more information about the BMC's clock or subnet, which can help with subsequent
57+
attacks. OpenBMC responds to all ICMP requests.
5758

5859
[cve 1999-0524]: https://nvd.nist.gov/vuln/detail/CVE-1999-0524
5960

@@ -108,9 +109,9 @@ Services can be disabled in several ways:
108109
1. Configure OpenBMC recipes to build the unwanted feature out of the BMC's
109110
firmware image. This gives the BMC the advantage of a smaller attack
110111
surface.
111-
2. Implement something like the [Redfish ManagerNetworkProtocol][] properties for
112-
IPMI, SSH, and other BMC services, possibly by using shell commands like 'systemctl
113-
disable ipmid' and 'systemctl stop ipmid'.
112+
2. Implement something like the [Redfish ManagerNetworkProtocol][] properties
113+
for IPMI, SSH, and other BMC services, possibly by using shell commands like
114+
'systemctl disable ipmid' and 'systemctl stop ipmid'.
114115

115116
[redfish managernetworkprotocol]:
116117
https://redfish.dmtf.org/schemas/ManagerNetworkProtocol.v1_4_0.json
@@ -208,9 +209,9 @@ https://www.dmtf.org/standards/redfish.
208209

209210
#### The webui-vue Web application
210211

211-
General considerations for Web applications such as given by [OWASP
212-
Web Application Security Guidance][] apply to OpenBMC. The webui-vue uses
213-
username and password-based authentication, and REST APIs for subsequent access.
212+
General considerations for Web applications such as given by [OWASP Web
213+
Application Security Guidance][] apply to OpenBMC. The webui-vue uses username
214+
and password-based authentication, and REST APIs for subsequent access.
214215

215216
[owasp web application security guidance]:
216217
https://www.owasp.org/index.php/Web_Application_Security_Guidance

security/obmc-github-security-advisory-template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# OpenBMC Security Advisory Template
22

33
This has guidelines for OpenBMC repository maintainers to follow when creating
4-
new draft GitHub security advisories as part of the [Security response team guidelines][].
4+
new draft GitHub security advisories as part of the [Security response team
5+
guidelines][].
56

67
Note that the sections under the "Description" section are intended for the
78
security advisory "Description" field

security/obmc-security-response-team-guidelines.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ Workflow highlights:
4747
response team. For example, link to these guidelines.
4848
- Coordinate with all collaborators and keep them informed.
4949

50-
Considerations in the [CERT Guide to Coordinated Vulnerability Disclosure][] (SPECIAL
51-
REPORT CMU/SEI-2017-SR-022) may guide the process.
50+
Considerations in the [CERT Guide to Coordinated Vulnerability Disclosure][]
51+
(SPECIAL REPORT CMU/SEI-2017-SR-022) may guide the process.
5252

5353
Example collaborations:
5454

@@ -64,9 +64,10 @@ Workflow highlights:
6464
problems. When fixing the problem, use the contribution process but limit
6565
the details in the issue or use a private channel to discuss.
6666
3. Negotiate how the code review will proceed.
67-
- Consider [contributing][] using a Gerrit [private change][] if everyone has
68-
access to Gerrit.
69-
- Consider using [Patch set][] emails to make reviews accessible to all stakeholders.
67+
- Consider [contributing][] using a Gerrit [private change][] if everyone
68+
has access to Gerrit.
69+
- Consider using [Patch set][] emails to make reviews accessible to all
70+
stakeholders.
7071
4. When agreed:
7172
- Publish a security advisory to the affected OpenBMC repository.
7273
- Make the Gerrit review publicly viewable.
@@ -76,18 +77,19 @@ Workflow highlights:
7677
Repository maintainer process steps: 1. Create a private gerrit code review and
7778
oversee development of the fix. 2. Create a draft advisory under
7879
github.com/openbmc/<REPO>/security/advisories. Please follow guidance in the
79-
[OpenBMC Security Advisory Template][]. Add the openbmc security-response group and
80-
other stakeholders to the advisory. 3. Review the security bulletin with stakeholders
81-
to get it ready to publish. 4. Work with the SRT to identify CVEs. If you are unsure
82-
what counts as a vulnerability, please consult with the SRT. For example, independent
83-
bugs should have separate CVEs. A security advisory can reference multiple CVEs.
84-
When the CVE is known, add it to the security advisory, and reference it in the commit
85-
message, stating how the fix relates to the CVE. For example: This fixes CVE-yyyy-nnnnn.
86-
Doing so helps downstream security responders. If the commit is a partial fix, please
87-
explain that and provide references to the other parts of the fix. 5. If stakeholders
88-
negotiate for coordinated disclosure, plan to release the fix and the security advisory
89-
on the negotiated day. 6. When the code fix and the advisory are both ready (subject
90-
to coordinated disclosure), please merge the fixes (and make any private review be
80+
[OpenBMC Security Advisory Template][]. Add the openbmc security-response group
81+
and other stakeholders to the advisory. 3. Review the security bulletin with
82+
stakeholders to get it ready to publish. 4. Work with the SRT to identify CVEs.
83+
If you are unsure what counts as a vulnerability, please consult with the SRT.
84+
For example, independent bugs should have separate CVEs. A security advisory can
85+
reference multiple CVEs. When the CVE is known, add it to the security advisory,
86+
and reference it in the commit message, stating how the fix relates to the CVE.
87+
For example: This fixes CVE-yyyy-nnnnn. Doing so helps downstream security
88+
responders. If the commit is a partial fix, please explain that and provide
89+
references to the other parts of the fix. 5. If stakeholders negotiate for
90+
coordinated disclosure, plan to release the fix and the security advisory on the
91+
negotiated day. 6. When the code fix and the advisory are both ready (subject to
92+
coordinated disclosure), please merge the fixes (and make any private review be
9193
public) publish the security advisory, and email the security-response team.
9294

9395
[security vulnerability reporting process]: ./obmc-security-response-team.md

0 commit comments

Comments
 (0)