Skip to content

Commit d85b35d

Browse files
Updates to Documentation criteria missing rationale and implementation details (#159)
* Updates to Documentation criteria missing rationale and implementation details Signed-off-by: CRob <69357996+SecurityCRob@users.noreply.github.com> * Update OSPS-DO.yaml adjusted text to attempt to meet Evan's ask Signed-off-by: CRob <69357996+SecurityCRob@users.noreply.github.com> * Added OpenEoX lexicon entry and updated criteria Signed-off-by: Eddie Knight <knight@linux.com> * simplified DO-15 text Signed-off-by: Eddie Knight <knight@linux.com> --------- Signed-off-by: CRob <69357996+SecurityCRob@users.noreply.github.com> Signed-off-by: Eddie Knight <knight@linux.com> Co-authored-by: Eddie Knight <knight@linux.com>
1 parent 1b9d264 commit d85b35d

File tree

3 files changed

+2621
-15
lines changed

3 files changed

+2621
-15
lines changed

baseline/OSPS-DO.yaml

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,17 @@ criteria:
100100
The project documentation MUST include a
101101
descriptive statement about the scope and
102102
duration of support.
103-
rationale: # TODO
104-
# TODO: Integrate with advice from https://endoflife.date/recommendations
103+
rationale: |
104+
Provide users with clear expecations regarding
105+
the project's support lifecycle. This allows
106+
downstream consumers to take relevant actions
107+
to ensure the continued functionality and
108+
security of their systems.
105109
implementation: |
106-
The project should have either a "Support"
107-
header in the README, a SUPPORT.md file
108-
present in the repo root, or a SUPPORT.eox
109-
file in the [OpenEOX format](https://github.com/OpenEoX/openeox/blob/main/schema/schema.json)
110-
describing the scope and duration of support
111-
for the project's released software assets.
110+
In order to communicate the scope and duration of
111+
support for the project's released software assets,
112+
the project should have a SUPPORT.md or an OpenEoX
113+
file in a well known location.
112114
control_mappings:
113115
BPB: R-B-3
114116
SSDF: PO4.2, PS3.1, RV1.3
@@ -121,10 +123,18 @@ criteria:
121123
criterion: |
122124
The project documentation MUST provide a
123125
descriptive statement when releases or
124-
versions are no longer supported and that
125-
will no longer receive security updates.
126-
rationale: # TODO
127-
implementation: # TODO
126+
versions will no longer receive security
127+
updates.
128+
rationale: |
129+
Communicating when the project maintainers
130+
will no longer fix defects or security
131+
vulnerabilities is crucial for downstream
132+
consumers to find alternative solutions or
133+
alternative means of support for the project.
134+
implementation: |
135+
While a machine-readable OpenEoX file is recommended,
136+
this may also be communicated in a SUPPORT.md or
137+
beneath a Support header in the primary README.md.
128138
control_mappings:
129139
CRA: 1.2c, 2.6
130140
OC: 4.1.1, 4.3.1
@@ -133,13 +143,24 @@ criteria:
133143

134144
- id: OSPS-DO-15
135145
maturity_level: 2
136-
category: Vulnerability Management
146+
category: Documentation
137147
criterion: |
138148
The project documentation MUST include a
139149
description of how the project selects,
140150
obtains, and tracks its dependencies.
141-
rationale: # TODO
142-
implementation: # TODO
151+
rationale: |
152+
Provide information about how the project
153+
selects, obtains, and tracks dependencies,
154+
libraries, frameworks, etc. to help downstream
155+
consumers understand how the project operates
156+
in regards to third-party components that are
157+
required neccessary for the software to function.
158+
implementation: |
159+
It is recommended to publish this information
160+
alongside the projects technical & design
161+
documentation on a publicy viewable resource
162+
such as the source code repository, project website,
163+
or other channel.
143164
control_mappings:
144165
BPB: A-S-1
145166
CRA: 2.1

baseline/lexicon.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,16 @@
138138
originally been intentional, but a change in
139139
environment or understanding has made them
140140
undesirable.
141+
- term: OpenEoX
142+
definition: |
143+
An initiative aimed at standardizing the way
144+
End-of-Life and End-of-Support information is
145+
exchanged within the software and hardware industries.
146+
Covering both vendors and open-source maintainers,
147+
OpenEoX strives to provide a transparent, efficient,
148+
and unified approach to managing product lifecycles.
149+
references:
150+
- https://openeox.org/
141151
- term: Exploitable Vulnerabilities
142152
definition: |
143153
Defects in the software that can be leveraged

0 commit comments

Comments
 (0)