Liking cljdoc? Tell your friends :D

Campaign Object

Campaign Represents a campaign by an actor pursing an intent

PropertyTypeDescriptionRequired?
campaign_typeShortStringString
idStringGlobally unique URI identifying this object.
schema_versionStringCTIM schema version for this entity
typeCampaignTypeIdentifierString
valid_timeValidTime ObjectTimestamp for the definition of a specific version of a campaign
activityActivity Object ListActions taken in regards to this Campaign
confidenceHighMedLowStringLevel of confidence held in the characterization of this Campaign
descriptionMarkdownStringA description of object, which may be detailed.
external_idsString List
external_referencesExternalReference Object ListSpecifies a list of external references which refers to non-CTIM information. This property is used to provide one or more URLs, descriptions, or IDs to records in other systems.
intended_effectIntendedEffectString ListCharacterizes the intended effect of this cyber threat campaign
languageShortStringStringThe human language this object is specified in.
namesShortStringString ListNames used to identify this campaign
revisionIntegerA monotonically increasing revision, incremented each time the object is changed.
short_descriptionMedStringStringA single line, short summary of the object.
sourceMedStringString
source_uriString
statusCampaignStatusStringStatus of this Campaign
timestampInst (Date)The time this object was created at, or last modified.
titleShortStringStringA short title for this object, used as primary display and reference value
tlpTLPStringSpecification for how, and to whom, this object can be shared.

Property activity ∷ Activity Object List

Actions taken in regards to this Campaign

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

Property campaign_type ∷ ShortStringString

  • This entry is required

  • Dev Notes: Should we define a vocabulary for this?

    • ShortString String with at most 1024 characters

Property confidence ∷ HighMedLowString

Level of confidence held in the characterization of this Campaign

  • This entry is optional

Property description ∷ MarkdownString

A description of object, which may be detailed.

  • This entry is optional

    • Markdown Markdown string with at most 5000 characters

Property external_ids ∷ String List

  • 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. This property is used to provide one or more URLs, descriptions, or IDs to records in other systems.

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

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 intended_effect ∷ IntendedEffectString List

Characterizes the intended effect of this cyber threat campaign

  • This entry is optional

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

    • Allowed Values:
      • Account Takeover
      • Advantage
      • Advantage - Economic
      • Advantage - Military
      • Advantage - Political
      • Brand Damage
      • Competitive Advantage
      • Degradation of Service
      • Denial and Deception
      • Destruction
      • Disruption
      • Embarrassment
      • Exposure
      • Extortion
      • Fraud
      • Harassment
      • ICS Control
      • Theft
      • Theft - Credential Theft
      • Theft - Identity Theft
      • Theft - Intellectual Property
      • Theft - Theft of Proprietary Information
      • Traffic Diversion
      • Unauthorized Access

Property language ∷ ShortStringString

The human language this object is specified in.

  • This entry is optional

    • ShortString String with at most 1024 characters

Property names ∷ ShortStringString List

Names used to identify this campaign

  • This entry is optional

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

    • ShortString String with at most 1024 characters

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

  • This entry is optional

    • MedString String with at most 2048 characters

Property source_uri ∷ String

  • This entry is optional

    • A URI

Property status ∷ CampaignStatusString

Status of this Campaign

  • This entry is optional

    • Allowed Values:
      • Future
      • Historic
      • Ongoing

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

Specification for how, and to whom, this object can be shared.

  • This entry is optional

    • TLP TLP stands for Traffic Light Protocol, which indicates precisely how this resource is intended to be shared, replicated, copied, etc.
    • Default: green
    • Allowed Values:
      • amber
      • green
      • red
      • white

Property type ∷ CampaignTypeIdentifierString

  • This entry is required

    • Must equal: "campaign"

Property valid_time ∷ ValidTime Object

Timestamp for the definition of a specific version of a campaign

  • This entry is required

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.

PropertyTypeDescriptionRequired?
source_nameMedStringStringThe source within which the external-reference is defined (system, registry, organization, etc.)
descriptionMarkdownString
external_idStringAn identifier for the external reference content.
hashesString ListSpecifies a dictionary of hashes for the contents of the url.
urlStringA URL reference to an external resource

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

ValidTime Object

ValidTime Period of time when a cyber observation is valid.

PropertyTypeDescriptionRequired?
end_timeInst (Date)If end_time is not present, then the valid time position of the object does not have an upper bound.
start_timeInst (Date)If not present, the valid time position of the indicator does not have an upper bound

Property end_time ∷ Inst (Date)

If end_time is not present, then the valid time position of the object does not have an upper bound.

  • 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 start_time ∷ Inst (Date)

If not present, the valid time position of the indicator does not have an upper bound

  • 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.

Activity Object

Activity What happend, when?

PropertyTypeDescriptionRequired?
date_timeInst (Date)Specifies the date and time at which the activity occured
descriptionMarkdownStringA description of the activity

Property date_time ∷ Inst (Date)

Specifies the date and time at which the activity occured

  • This entry is required

    • 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 description ∷ MarkdownString

A description of the activity

  • This entry is required

    • Markdown Markdown string with at most 5000 characters

Can you improve this documentation? These fine people already did:
Stephen Sloan, Yann Esposito (Yogsototh), Guillaume Buisson, Ambrose Bonnaire-Sergeant, Craig Brozefsky, Matthieu Sprunck & Yann Esposito
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close