Skip to content

Draft PR to evolve the Theats & Controls profile - #1467

Draft
karsten-klein wants to merge 20 commits into
spdx:developfrom
org-metaeffekt:develop
Draft

karsten-klein wants to merge 20 commits into
spdx:developfrom
org-metaeffekt:develop

Conversation

@karsten-klein

Copy link
Copy Markdown

Drafting the PR for more visibility and early feedback.

Comment thread model/Threat/Vocabularies/Level.md Outdated
Comment on lines +19 to +24
- U: undefined; the value is not known or yet undetermined
- I: ignore; the metric is to be ignored
- N: none; the metric was evaluated to be not relevant expressed by none
- L: low; the metric was evaluated to low
- M: medium; the metric was evaluated to medium
- H: high; the metric was evaluated to high

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current SPDX 3 convention uses lowerCamelCase for vocab entries.

See https://github.com/spdx/spdx-3-model/blob/develop/docs/format.md#naming-convention

Comment thread model/Threat/Classes/Threat.md Outdated
Comment on lines +19 to +23
* Weaknesses,
* Attack Patterns,
* Attack Techniques,
* Attack Procedures,
* Attack Paths.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Weaknesses,
* Attack Patterns,
* Attack Techniques,
* Attack Procedures,
* Attack Paths.
- Weaknesses,
- Attack Patterns,
- Attack Techniques,
- Attack Procedures,
- Attack Paths.

Comment on lines +17 to +21
* Security Requirements,
* Mitigations,
* Countermeasures,
* Operational Procedures,
* Defense Techniques.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Security Requirements,
* Mitigations,
* Countermeasures,
* Operational Procedures,
* Defense Techniques.
- Security Requirements,
- Mitigations,
- Countermeasures,
- Operational Procedures,
- Defense Techniques.

By Markdown rules, in the same file, choose either * or - for bullet point.

For SPDX 3 model files, use -, that's the only option.
Since in the "Metadata", "Properties", etc sections, we have to use -,
or spec-parser will not able to recognize it
https://github.com/spdx/spec-parser/blob/270a255e86fc1bd19c37c534b493398ee87132d5/spec_parser/mdparsing.py#L67

Comment thread model/Threat/Classes/Capability.md Outdated
- genericDemand
- type: Assessment
- minCount: 0

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Only one new line at the end of file.

- context
- type: ConceptType
- minCount: 1

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Comment thread model/Threat/Classes/Control.md Outdated
- attribution
- type: ControlAttribution
- minCount: 0

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Comment thread model/Threat/ThreatsAndControls.md Outdated
`/Core/Relationship` of type `basedOn` having that element as
its `from` property and a `/Threat/TreatReference` or `/Core/Requirement` as its `to`
property.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Comment thread model/Threat/ThreatsAndControls.md Outdated

## Metadata

- id: https://spdx.org/rdf/3.1/terms/ThreatsAndControls

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- id: https://spdx.org/rdf/3.1/terms/ThreatsAndControls
- id: https://spdx.org/rdf/3/terms/ThreatsAndControls

Use only the major version in base IRI.

Signed-off-by: karsten-klein <karsten.klein@metaeffekt.com>
Signed-off-by: karsten-klein <karsten.klein@metaeffekt.com>
Signed-off-by: karsten-klein <karsten.klein@metaeffekt.com>
Comment on lines +11 to +12
Allows to provide
- impact assessments for a Threat on one or more assets or capabilities

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Allows to provide
- impact assessments for a Threat on one or more assets or capabilities
Allows to provide
- impact assessments for a Threat on one or more assets or capabilities

Add blank line before and after the list to avoid Markdown rendering issue

- type: String
- minCount: 1
- maxCount: 1
- assessments

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- assessments
- assessment

Use singular form.
Multiplicity can already be expressed by the cardinality.

See Naming convention - https://github.com/spdx/spdx-3-model/blob/develop/docs/format.md#naming-convention

@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0.

# assessments

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# assessments
# assessment

See Naming convention - https://github.com/spdx/spdx-3-model/blob/develop/docs/format.md#naming-convention

@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0.

# affectedSubject

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to extend definition of /Core/subject and reuse it?

https://github.com/spdx/spdx-3-model/blob/develop/model/Core/Properties/subject.md

  • subject: "An Element an annotator has made an assertion about."
  • affectedSubject: "Entity regarded as assessment subject in a ConcludedThreatAssessment."

Maybe combined as:

An Element that an annotator makes an assertion about or that is evaluated as the focus of a ConcludedThreatAssessment.

Comment on lines +21 to +22
- organizational: policies, rules, administrative procedures, and management frameworks that define security
expectations and govern human behavior. No newline at end of file

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- organizational: policies, rules, administrative procedures, and management frameworks that define security
expectations and govern human behavior.
- organizational: Policies, rules, administrative procedures, and management frameworks that define security expectations and govern human behavior.

An entry and its description must be in one line, or the spec-parser will failed

## Description

Assessment using metrics as defined as Parkerian Hexad.
See https://en.wikipedia.org/wiki/Parkerian_Hexad.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See https://en.wikipedia.org/wiki/Parkerian_Hexad.
See <https://en.wikipedia.org/wiki/Parkerian_Hexad>.

Need angle brackets if to be rendered as a link.

## Description

Assessment based on the MITRE Scope vocabulary.
See https://cwe.mitre.org/data/xsd/cwe_schema_v7.2.xsd or https://capec.mitre.org/data/xsd/ap_schema_v3.5.xsd.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See https://cwe.mitre.org/data/xsd/cwe_schema_v7.2.xsd or https://capec.mitre.org/data/xsd/ap_schema_v3.5.xsd.
See <https://cwe.mitre.org/data/xsd/cwe_schema_v7.2.xsd>
or <https://capec.mitre.org/data/xsd/ap_schema_v3.5.xsd>.

Need angle brackets if to be rendered as a link.

Comment on lines +17 to +21
* Security Requirements,
* Mitigations,
* Countermeasures,
* Operational Procedures,
* Defense Techniques.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Security Requirements,
* Mitigations,
* Countermeasures,
* Operational Procedures,
* Defense Techniques.
- Security Requirements,
- Mitigations,
- Countermeasures,
- Operational Procedures,
- Defense Techniques.

Use - instead of * for bullets, for consistency with the rest of the file and the repo.

## Description

Assessment using metrics as outlined in the BSI documentation.
See https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/Grundschutz/International/Basic_Security.pdf?__blob=publicationFile&v=2

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/Grundschutz/International/Basic_Security.pdf?__blob=publicationFile&v=2
See <https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/Grundschutz/International/Basic_Security.pdf>.

Need angle brackets if to be rendered as a link.


## Summary

Assessment using metrics as outlined in the BSI documentation.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Expand "BSI" abbreviation.

@@ -0,0 +1,31 @@
SPDX-License-Identifier: Community-Spec-1.0.

# genericDemand

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion for defining demand in relation to need:
genericDemandedNeed

Signed-off-by: karsten-klein <karsten.klein@metaeffekt.com>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, Operations namespace has these properties that may relevant:

@bact

bact commented Nov 16, 2026

Copy link
Copy Markdown
Collaborator

Some issues can be fixed automatically by this tool https://github.com/davidanson/markdownlint

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants