Package security.whisper.javastix.sdo.objects

Interface ToolSdo

All Superinterfaces:

BundleableObject, DomainObject, SdoDefaultValidator, Serializable, Stix, StixCommonProperties, StixCustomProperties, StixLabels, StixModified, StixRevoked, StixSpecVersion

All Known Implementing Classes:

Tool

@Immutable
@DefaultTypeValue(value="tool",
                  groups=DefaultValuesProcessor.class)
@Redactable
public interface ToolSdo
extends DomainObject

tool

Tools are legitimate software that can be used by threat actors to perform attacks. This SDO MUST NOT be used to characterize malware. Further, Tool MUST NOT be used to characterise tools used as part of a course of action in response to an attack.

Field Summary

Fields inherited from interface security.whisper.javastix.validation.SdoDefaultValidator

VALIDATOR

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDescription()
default @NotNull Set<KillChainPhaseType>	getKillChainPhases()
default @NotNull @Vocab(ToolLabels.class) Set<@Length(min=1) String>	getLabels()
@NotBlank String	getName()
Optional<String>	getToolVersion()

Methods inherited from interface security.whisper.javastix.sdo.DomainObject

getRelationships

Methods inherited from interface security.whisper.javastix.validation.SdoDefaultValidator

validate, validateOnlyId

Methods inherited from interface security.whisper.javastix.common.StixCommonProperties

checkHydrationValidation, getCreated, getCreatedByRef, getExternalReferences, getGranularMarkings, getHydrated, getId, getLang, getObjectMarkingRefs, getType, toJsonString

Methods inherited from interface security.whisper.javastix.common.StixCustomProperties

getCustomProperties

Methods inherited from interface security.whisper.javastix.common.StixModified

getModified

Methods inherited from interface security.whisper.javastix.common.StixRevoked

getRevoked

Methods inherited from interface security.whisper.javastix.common.StixSpecVersion

getSpecVersion

Method Details

getLabels

@Default
@NotNull
@Vocab(ToolLabels.class)
@JsonPropertyDescription("The kind(s) of tool(s) being described. Open Vocab - tool-label-ov")
@Redactable(useMask=true)
default @NotNull @Vocab(ToolLabels.class) Set<@Length(min=1) String> getLabels()

Specified by:

getLabels in interface StixLabels

getName

@NotBlank
@JsonPropertyDescription("The name used to identify the Tool.")
@Redactable(useMask=true)
@NotBlank String getName()

getDescription

@JsonPropertyDescription("Provides more context and details about the Tool object.")
@Redactable
Optional<String> getDescription()

getKillChainPhases

@Default
@NotNull
@JsonPropertyDescription("The list of kill chain phases for which this Tool instance can be used.")
@Redactable
default @NotNull Set<KillChainPhaseType> getKillChainPhases()

getToolVersion

@JsonPropertyDescription("The version identifier associated with the tool.")
@Redactable
Optional<String> getToolVersion()