Weakness Object

Weakness A mistake or condition that, if left unaddressed, could under the proper conditions contribute to a cyber-enabled capability being vulnerable to attack, allowing an adversary to make items function in unintended ways.

Property	Type	Description	Required?
description	MarkdownString	Should be short and limited to the key points that define this weakness.	✓
id	String	Globally unique URI identifying this object.	✓
schema_version	String	CTIM schema version for this entity.	✓
type	WeaknessTypeIdentifierString	The fixed value weakness	✓
abstraction_level	WeaknessAbstractionLevelString	Refers to the level of abstraction or granularity used to describe the weakness. It helps to categorize the vulnerability based on the level of detail provided.
affected_resources	SystemResourceString List	Identifies system resources that can be affected by an exploit of this weakness.
alternate_terms	AlternateTerm Object List	Indicates one or more other names used to describe this weakness.
architectures	Architecture Object List	Applicable architectures.
background_details	MarkdownString	Information that is relevant but not related to the nature of the weakness itself.
common_consequences	Consequence Object List	Refers to the typical or expected negative effects that can result from exploiting the weakness. This could include anything from unauthorized access to data, denial of service, system crashes or other things.
detection_methods	DetectionMethod Object List	Identifies methods that may be employed to detect this weakness, including their strengths and limitations.
external_ids	String List	It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.
external_references	ExternalReference Object List	Specifies a list of external references which refers to non-CTIM information. Similar to external_ids field with major differences: - external_ids field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The external_ids field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. - external_references field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The external_references field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.
functional_areas	FunctionalAreaString List	Identifies the functional area of the software in which the weakness is most likely to occur.
language	ShortStringString	The language field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages. For example, if an incident involves an attack on a system in a country where a specific language is predominant, the language field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The language field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.
languages	Language Object List	Applicable Languages.
likelihood	HighMedLowString	Likelihood of exploit.
modes_of_introduction	ModeOfIntroduction Object List	Information about how and when a given weakness may be introduced.
notes	Note Object List	Provides any additional comments about the weakness.
operating_systems	OperatingSystem Object List	Applicable operating systems.
paradigms	Paradigm Object List	Applicable paradigms.
potential_mitigations	Mitigation Object List	Describes potential mitigations associated with a weakness.
revision	Integer	A monotonically increasing revision, incremented each time the object is changed.
short_description	MedStringString	A single line, short summary of the object.
source	MedStringString	Represents the source of the intelligence that led to the creation of the entity.
source_uri	String	URI of the source of the intelligence that led to the creation of the entity.
structure	WeaknessStructureString	Defines the structural nature of the weakness.
technologies	Technology Object List	Applicable technologies.
timestamp	Inst (Date)	The time this object was created at, or last modified.
title	ShortStringString	A short title for this object, used as primary display and reference value.
tlp	TLPString	TLP stands for Traffic Light Protocol, which indicates precisely how a resource is intended to be shared, replicated, copied, etc. It is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know. For example, an entity containing information about a critical vulnerability in a widely-used software might be marked as red, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as amber or green, indicating that it can be shared more broadly within an organization.

• Reference: WeaknessType

Property abstraction_level ∷ WeaknessAbstractionLevelString

Refers to the level of abstraction or granularity used to describe the weakness. It helps to categorize the vulnerability based on the level of detail provided.

• This entry is optional

  • WeaknessAbstractionLevel Refers to the level of abstraction or granularity used to describe the weakness. It helps to categorize the vulnerability based on the level of detail provided. CTIM provides four different levels of abstraction for weaknesses: Class, Base, Variant, and Compound.

• Class: is the highest level of abstraction and describes a general category of weaknesses. Examples of Classes include :"Buffer Errors", "Input Validation", or "Authentication Issues".

• Base: More specific category than Class. A Base weakness is a concrete form of a Class weakness. An example of a Base weakness could be "SQL Injection".

• Variant: Describes one specific type of Base weakness that is defined by alterations or extensions to the Base description. For example, "Blind SQL Injection" can be considered a Variant of the Base weakness "SQL Injection".

• Compound: A Compound Weakness describes a weakness that combines two or more Base weaknesses to exploit a system. For example, a "Buffer-Overflow with Format-String Exploit" combines the Base weaknesses of "Buffer-Overflow" and "Format-String Vulnerability".

By specifying the abstraction level, cybersec professionals can more easily identify weaknesses that are related and prioritize their response efforts based on the potential impact of the vulnerability.

• Allowed Values:
  • Base
  • Class
  • Compound
  • Variant
• Reference: AbstractionEnumeration

Property affected_resources ∷ SystemResourceString List

Identifies system resources that can be affected by an exploit of this weakness.

• This entry is optional

• This entry's type is sequential (allows zero or more values)

  • SystemResource Defines a resource of a system.
  • Allowed Values:
    • CPU
    • File or Directory
    • Memory
    • System Process
  • Reference: ResourceEnumeration

Property alternate_terms ∷ AlternateTerm Object List

Indicates one or more other names used to describe this weakness.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• AlternateTerm Object Value
  • Details: AlternateTerm Object

Property architectures ∷ Architecture Object List

Applicable architectures.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Architecture Object Value
  • Details: Architecture Object

Property background_details ∷ MarkdownString

Information that is relevant but not related to the nature of the weakness itself.

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property common_consequences ∷ Consequence Object List

Refers to the typical or expected negative effects that can result from exploiting the weakness. This could include anything from unauthorized access to data, denial of service, system crashes or other things.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Consequence Object Value
  • Details: Consequence Object

Property description ∷ MarkdownString

Should be short and limited to the key points that define this weakness.

• This entry is required

  • Markdown Markdown string with at most 5000 characters.

Property detection_methods ∷ DetectionMethod Object List

Identifies methods that may be employed to detect this weakness, including their strengths and limitations.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• DetectionMethod Object Value
  • Details: DetectionMethod Object

Property external_ids ∷ String List

It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

Property external_references ∷ ExternalReference Object List

Specifies a list of external references which refers to non-CTIM information.

Similar to external_ids field with major differences:

• external_ids field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The external_ids field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems.

• external_references field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The external_references field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• ExternalReference Object Value
  • Details: ExternalReference Object

Property functional_areas ∷ FunctionalAreaString List

Identifies the functional area of the software in which the weakness is most likely to occur.

• This entry is optional

• This entry's type is sequential (allows zero or more values)

  • FunctionalArea Defines the different functional areas of software in which the weakness may appear.
  • Allowed Values:
    • Authentication
    • Authorization
    • Code Libraries
    • Counters
    • Cryptography
    • Error Handling
    • File Processing
    • Functional-Area-Independent
    • Interprocess Communication
    • Logging
    • Memory Management
    • Networking
    • Number Processing
    • Program Invocation
    • Protection Mechanism
    • Session Management
    • Signals
    • String Processing
  • Reference: FunctionalAreaEnumeration

Property id ∷ String

Globally unique URI identifying this object.

• This entry is required

  • IDs are URIs, for example https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014 for a Judgement. This ID type compares to the STIX id field. The optional STIX idref field is not used.

Property language ∷ ShortStringString

The language field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.

For example, if an incident involves an attack on a system in a country where a specific language is predominant, the language field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The language field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.

• This entry is optional

  • ShortString String with at most 1024 characters.

Property languages ∷ Language Object List

Applicable Languages.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Language Object Value
  • Details: Language Object

Property likelihood ∷ HighMedLowString

Likelihood of exploit.

• This entry is optional

  • Allowed Values:
    • High
    • Info
    • Low
    • Medium
    • None
    • Unknown
  • Reference: HighMedLowVocab

Property modes_of_introduction ∷ ModeOfIntroduction Object List

Information about how and when a given weakness may be introduced.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• ModeOfIntroduction Object Value
  • Details: ModeOfIntroduction Object

Property notes ∷ Note Object List

Provides any additional comments about the weakness.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Note Object Value
  • Details: Note Object

Property operating_systems ∷ OperatingSystem Object List

Applicable operating systems.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• OperatingSystem Object Value
  • Details: OperatingSystem Object

Property paradigms ∷ Paradigm Object List

Applicable paradigms.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Paradigm Object Value
  • Details: Paradigm Object

Property potential_mitigations ∷ Mitigation Object List

Describes potential mitigations associated with a weakness.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Mitigation Object Value
  • Details: Mitigation Object

Property revision ∷ Integer

A monotonically increasing revision, incremented each time the object is changed.

• This entry is optional

  • Zero, or a positive integer.

Property schema_version ∷ String

CTIM schema version for this entity.

• This entry is required

  • A semantic version matching the CTIM version against which this object should be valid.

Property short_description ∷ MedStringString

A single line, short summary of the object.

• This entry is optional

  • MedString String with at most 2048 characters.

Property source ∷ MedStringString

Represents the source of the intelligence that led to the creation of the entity.

• This entry is optional

  • MedString String with at most 2048 characters.

Property source_uri ∷ String

URI of the source of the intelligence that led to the creation of the entity.

• This entry is optional

  • A URI

Property structure ∷ WeaknessStructureString

Defines the structural nature of the weakness.

• This entry is optional

  • WeaknessStructure Structural nature of a weakness. Useful as it categorizes weaknesses based on their dependencies and complexity and helps analysts to prioritize their response efforts based on the potential impact of the vulnerability.

• Chain: A chain weakness might involve an attacker chaining together multiple vulnerabilities and exploits in order to achieve their end goal. For example, an attacker might use a phishing attack to gain access to a user's email account, then use information from that account to socially engineer their way through additional systems until they gain access to an internal network. In this case, the attacker is chaining multiple weaknesses together in order to achieve their ultimate objective.

• Composite: A composite weakness might involve multiple vulnerabilities that exist in different layers or components of a system. For example, a composite weakness in a web application might involve both an injection vulnerability and a cross-site scripting vulnerability. An attacker could use these weaknesses in tandem to steal data or take over the system.

• Simple: A simple weakness might involve a single vulnerability or exploit that can be used to achieve a specific objective. An example of a simple weakness might be a buffer overflow vulnerability in a software application. If an attacker can exploit this vulnerability, they may be able to execute arbitrary code on the system.

  • Allowed Values:
    • Chain
    • Composite
    • Simple
  • Reference: StructureEnumeration)

Property technologies ∷ Technology Object List

Applicable technologies.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

• Technology Object Value
  • Details: Technology Object

Property timestamp ∷ Inst (Date)

The time this object was created at, or last modified.

• This entry is optional

  • ISO8601 Timestamp Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property title ∷ ShortStringString

A short title for this object, used as primary display and reference value.

• This entry is optional

  • ShortString String with at most 1024 characters.

Property tlp ∷ TLPString

TLP stands for Traffic Light Protocol, which indicates precisely how a resource is intended to be shared, replicated, copied, etc.

It is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.

For example, an entity containing information about a critical vulnerability in a widely-used software might be marked as red, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as amber or green, indicating that it can be shared more broadly within an organization.

• This entry is optional

  • Allowed Values:
    • amber
    • green
    • red
    • white

Property type ∷ WeaknessTypeIdentifierString

The fixed value weakness

• This entry is required

  • WeaknessTypeIdentifier The fixed value "weakness"
  • Must equal: "weakness"

ExternalReference Object

ExternalReference External references are used to describe pointers to information represented outside of CTIM. For example, a Malware object could use an external reference to indicate an ID for that malware in an external database or a report could use references to represent source material.

Property	Type	Description	Required?
source_name	MedStringString	The source within which the external-reference is defined (system, registry, organization, etc.)	✓
description	MarkdownString
external_id	String	An identifier for the external reference content.
hashes	String List	Specifies a dictionary of hashes for the contents of the url.
url	String	A URL reference to an external resource.

• Reference: External Reference

Property description ∷ MarkdownString

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property external_id ∷ String

An identifier for the external reference content.

• This entry is optional

Property hashes ∷ String List

Specifies a dictionary of hashes for the contents of the url.

• This entry is optional
• This entry's type is sequential (allows zero or more values)

Property source_name ∷ MedStringString

The source within which the external-reference is defined (system, registry, organization, etc.)

• This entry is required

  • MedString String with at most 2048 characters.

Property url ∷ String

A URL reference to an external resource.

• This entry is optional

  • A URI

Language Object

Property	Type	Description	Required?
prevalence	PrevalenceString	Defines the different regularities that guide the applicability of platforms.	✓
class	LanguageClassString	Class of language.
name	ShortStringString	Language name (Clojure, Java, ...)

Property class ∷ LanguageClassString

Class of language.

• This entry is optional

  • LanguageClass Class of source code language.
  • Allowed Values:
    • Assembly
    • Compiled
    • Interpreted
  • Reference: LanguageClassEnumeration

Property name ∷ ShortStringString

Language name (Clojure, Java, ...)

• This entry is optional

  • ShortString String with at most 1024 characters.

Property prevalence ∷ PrevalenceString

Defines the different regularities that guide the applicability of platforms.

• This entry is required

  • Prevalence Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Often
    • Rarely
    • Sometimes
    • Undetermined
  • Reference: PrevalenceEnumeration

OperatingSystem Object

Property	Type	Description	Required?
prevalence	PrevalenceString	Defines the different regularities that guide the applicability of platforms.	✓
class	OperatingSystemClassString
cpe_id	ShortStringString
name	ShortStringString
version	ShortStringString

Property class ∷ OperatingSystemClassString

• This entry is optional

  • OperatingSystemClass Class of Operating System.
  • Allowed Values:
    • Android
    • Apple iOS
    • Cisco IOS
    • Linux
    • Unix
    • Windows
    • macOs
  • Reference: OperatingSystemClassEnumeration

Property cpe_id ∷ ShortStringString

• This entry is optional

  • ShortString String with at most 1024 characters.

Property name ∷ ShortStringString

• This entry is optional

  • ShortString String with at most 1024 characters.

Property prevalence ∷ PrevalenceString

Defines the different regularities that guide the applicability of platforms.

• This entry is required

  • Prevalence Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Often
    • Rarely
    • Sometimes
    • Undetermined
  • Reference: PrevalenceEnumeration

Property version ∷ ShortStringString

• This entry is optional

  • ShortString String with at most 1024 characters.

Architecture Object

Property	Type	Description	Required?
prevalence	PrevalenceString	Defines the different regularities that guide the applicability of platforms.	✓
class	ArchitectureClassString	Class of architecture
name	ShortStringString	Architecture name (ARM, x86, ...)

Property class ∷ ArchitectureClassString

Class of architecture

• This entry is optional

  • Allowed Values:
    • Embedded
    • Microcomputer
    • Workstation
  • Reference: ArchitectureClassEnumeration

Property name ∷ ShortStringString

Architecture name (ARM, x86, ...)

• This entry is optional

  • ShortString String with at most 1024 characters.

Property prevalence ∷ PrevalenceString

Defines the different regularities that guide the applicability of platforms.

• This entry is required

  • Prevalence Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Often
    • Rarely
    • Sometimes
    • Undetermined
  • Reference: PrevalenceEnumeration

Paradigm Object

Property	Type	Description	Required?
prevalence	PrevalenceString	Defines the different regularities that guide the applicability of platforms.	✓
name	ShortStringString	Paradigm name (Client Server, Mainframe)

Property name ∷ ShortStringString

Paradigm name (Client Server, Mainframe)

• This entry is optional

  • ShortString String with at most 1024 characters.

Property prevalence ∷ PrevalenceString

Defines the different regularities that guide the applicability of platforms.

• This entry is required

  • Prevalence Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Often
    • Rarely
    • Sometimes
    • Undetermined
  • Reference: PrevalenceEnumeration

Technology Object

Property	Type	Description	Required?
prevalence	PrevalenceString	Defines the different regularities that guide the applicability of platforms.	✓
name	ShortStringString	Technology name (Web Server, Web Client)

Property name ∷ ShortStringString

Technology name (Web Server, Web Client)

• This entry is optional

  • ShortString String with at most 1024 characters.

Property prevalence ∷ PrevalenceString

Defines the different regularities that guide the applicability of platforms.

• This entry is required

  • Prevalence Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Often
    • Rarely
    • Sometimes
    • Undetermined
  • Reference: PrevalenceEnumeration

AlternateTerm Object

Property	Type	Description	Required?
term	ShortStringString	The actual alternate term.	✓
description	MarkdownString	Provides context for the alternate term by which this weakness may be known.

Property description ∷ MarkdownString

Provides context for the alternate term by which this weakness may be known.

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property term ∷ ShortStringString

The actual alternate term.

• This entry is required

  • ShortString String with at most 1024 characters.

ModeOfIntroduction Object

Property	Type	Description	Required?
phase	SoftwarePhaseString	Identifies the point in the software life cycle at which the weakness may be introduced.	✓
note	MarkdownString	Provides a typical scenario related to introduction during the given phase.

• Reference: ModesOfIntroductionType

Property note ∷ MarkdownString

Provides a typical scenario related to introduction during the given phase.

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property phase ∷ SoftwarePhaseString

Identifies the point in the software life cycle at which the weakness may be introduced.

• This entry is required

  • SoftwarePhase Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Architecture and Design
    • Build and Compilation
    • Bundling
    • Distribution
    • Documentation
    • Implementation
    • Installation
    • Operation
    • Patching and Maintenance
    • Policy
    • Porting
    • Requirements
    • System Configuration
    • Testing
  • Reference: PhaseEnumeration

Consequence Object

Property	Type	Description	Required?
scopes	ConsequenceScopeString List	Identifies the security property that is violated.	✓
impacts	TechnicalImpactString List	Describes the technical impact that arises if an adversary succeeds in exploiting this weakness.
likelihood	HighMedLowString	How likely the specific consequence is expected to be seen relative to the other consequences.
note	MarkdownString	Additional commentary about a consequence.

• Reference: CommonConsequencesType

Property impacts ∷ TechnicalImpactString List

Describes the technical impact that arises if an adversary succeeds in exploiting this weakness.

• This entry is optional

• This entry's type is sequential (allows zero or more values)

  • Allowed Values:
    • Alter Execution Logic
    • Bypass Protection Mechanism
    • DoS: Amplification
    • DoS: Crash, Exit, or Restart
    • DoS: Instability
    • DoS: Resource Consumption (CPU)
    • DoS: Resource Consumption (Memory)
    • DoS: Resource Consumption (Other)
    • Execute Unauthorized Code or Commands
    • Gain Privileges or Assume Identity
    • Hide Activities
    • Modify Application Data
    • Modify Files or Directories
    • Modify Memory
    • Quality Degradation
    • Read Application Data
    • Read Files or Directories
    • Read Memory
    • Unexpected State
    • Varies by Context
  • Reference: TechnicalImpactEnumeration

Property likelihood ∷ HighMedLowString

How likely the specific consequence is expected to be seen relative to the other consequences.

• This entry is optional

  • Allowed Values:
    • High
    • Info
    • Low
    • Medium
    • None
    • Unknown
  • Reference: HighMedLowVocab

Property note ∷ MarkdownString

Additional commentary about a consequence.

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property scopes ∷ ConsequenceScopeString List

Identifies the security property that is violated.

• This entry is required

• This entry's type is sequential (allows zero or more values)

  • ConsequenceScope Defines the different areas of software security that can be affected by exploiting a weakness.
  • Allowed Values:
    • Access Control
    • Accountability
    • Authentication
    • Authorization
    • Availability
    • Confidentiality
    • Integrity
    • Non-Repudiation
  • Reference: ScopeEnumeration

DetectionMethod Object

Property	Type	Description	Required?
description	MarkdownString	Provides some context of how this method can be applied to a specific weakness.	✓
method	DetectionMethodString	Identifies the particular detection method being described.	✓
effectiveness	DetectionEffectivenessString	How effective the detection method may be in detecting the associated weakness.
effectiveness_notes	MarkdownString	Provides additional discussion of the strengths and shortcomings of this detection method.

• Reference: DetectionMethodsType

Property description ∷ MarkdownString

Provides some context of how this method can be applied to a specific weakness.

• This entry is required

  • Markdown Markdown string with at most 5000 characters.

Property effectiveness ∷ DetectionEffectivenessString

How effective the detection method may be in detecting the associated weakness.

• This entry is optional

  • DetectionEffectiveness Level of effectiveness that a detection method may have in detecting an associated weakness.
  • Allowed Values:
    • High
    • Limited
    • Moderate
    • None
    • Opportunistic
    • SOAR Partial
  • Reference: DetectionEffectivenessEnumeration

Property effectiveness_notes ∷ MarkdownString

Provides additional discussion of the strengths and shortcomings of this detection method.

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property method ∷ DetectionMethodString

Identifies the particular detection method being described.

• This entry is required

  • DetectionMethod Method used to detect a weakness.
  • Allowed Values:
    • Architecture or Design Review
    • Automated Analysis
    • Automated Dynamic Analysis
    • Automated Static Analysis
    • Automated Static Analysis - Binary or Bytecode
    • Automated Static Analysis - Source Code
    • Black Box
    • Dynamic Analysis with Automated Results Interpretation
    • Dynamic Analysis with Manual Results Interpretation
    • Fuzzing
    • Manual Analysis
    • Manual Dynamic Analysis
    • Manual Static Analysis
    • Manual Static Analysis - Binary or Bytecode
    • Manual Static Analysis - Source Code
    • Other
    • White Box
  • Reference: DetectionMethodEnumeration

Mitigation Object

Property	Type	Description	Required?
description	MarkdownString	A description of this individual mitigation including any strengths and shortcomings of this mitigation for the weakness.	✓
effectiveness	EffectivenessString	Summarizes how effective the mitigation may be in preventing the weakness.
effectiveness_notes	MarkdownString
phases	SoftwarePhaseString List	Indicates the development life cycle phase during which this particular mitigation may be applied.
strategy	MitigationStrategyString	A general strategy for protecting a system to which this mitigation contributes.

• Reference: PotentialMitigationsType

Property description ∷ MarkdownString

A description of this individual mitigation including any strengths and shortcomings of this mitigation for the weakness.

• This entry is required

  • Markdown Markdown string with at most 5000 characters.

Property effectiveness ∷ EffectivenessString

Summarizes how effective the mitigation may be in preventing the weakness.

• This entry is optional

  • Effectiveness Related to how effective a mitigation may be in preventing the weakness.
  • Allowed Values:
    • Defense in Depth
    • High
    • Incidental
    • Limited
    • Moderate
    • None
  • Reference: EffectivenessEnumeration

Property effectiveness_notes ∷ MarkdownString

• This entry is optional

  • Markdown Markdown string with at most 5000 characters.

Property phases ∷ SoftwarePhaseString List

Indicates the development life cycle phase during which this particular mitigation may be applied.

• This entry is optional

• This entry's type is sequential (allows zero or more values)

  • SoftwarePhase Defines the different regularities that guide the applicability of platforms.
  • Allowed Values:
    • Architecture and Design
    • Build and Compilation
    • Bundling
    • Distribution
    • Documentation
    • Implementation
    • Installation
    • Operation
    • Patching and Maintenance
    • Policy
    • Porting
    • Requirements
    • System Configuration
    • Testing
  • Reference: PhaseEnumeration

Property strategy ∷ MitigationStrategyString

A general strategy for protecting a system to which this mitigation contributes.

• This entry is optional

  • MitigationStrategy Strategy for protecting a system to which a mitigation contributes.
  • Allowed Values:
    • Attack Surface Reduction
    • Compilation or Build Hardening
    • Enforcement by Conversion
    • Environment Hardening
    • Firewall
    • Input Validation
    • Language Selection
    • Libraries or Frameworks
    • Output Encoding
    • Parameterization
    • Refactoring
    • Resource Limitation
    • Sandbox or Jail
    • Separation of Privilege
  • Reference: MitigationStrategyEnumeration

Note Object

Property	Type	Description	Required?
note	MarkdownString		✓
type	NoteTypeString		✓

Property note ∷ MarkdownString

• This entry is required

  • Markdown Markdown string with at most 5000 characters.

Property type ∷ NoteTypeString

• This entry is required

  • NoteType Defines the different types of notes that can be associated with a weakness.
  • Allowed Values:
    • Applicable Platform
    • Maintenance
    • Relationship
    • Research Gap
    • Terminology
    • Theoretical
  • Reference: [NoteTypeEnumeration] (https://cwe.mitre.org/documents/schema/#NoteTypeEnumeration)