Liking cljdoc? Tell your friends :D

Sighting Object

A single sighting of an indicator

PropertyTypeDescriptionRequired?
confidenceHighMedLow String
countIntegerThe number of times the sighting was seen
idStringGlobally unique URI identifying this object.
observed_timeObservedTime Object
schema_versionStringCTIM schema version for this entity
typeSightingTypeIdentifier String
dataSightingDataTable ObjectAn embedded data table for the Sighting.
descriptionMarkdown StringA 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.
internalBooleanIs it internal to our network
languageShortString StringThe human language this object is specified in.
observablesObservable Object ListThe object(s) of interest
relationsObservedRelation Object ListProvide any context we can about where the observable came from
resolutionResolution String
revisionIntegerA monotonically increasing revision, incremented each time the object is changed.
sensorSensor StringThe OpenC2 Actuator name that best fits the device that is creating this sighting (e.g. network.firewall)
sensor_coordinatesSensorCoordinates Object
severityHighMedLow String
short_descriptionMedString StringA single line, short summary of the object.
sourceMedString String
source_uriString
targetsTargetCoordinates Object ListThe target device. Where the sighting came from.
timestampInst (Date)The time this object was created at, or last modified.
titleShortString StringA short title for this object, used as primary display and reference value
tlpTLP StringSpecification for how, and to whom, this object can be shared.

Property confidence ∷ HighMedLow String

  • This entry is required

Property count ∷ Integer

The number of times the sighting was seen

  • This entry is required

    • Zero, or a positive integer

Property data ∷ SightingDataTable Object

An embedded data table for the Sighting.

  • This entry is optional

Property description ∷ Markdown String

A description of object, which may be detailed.

  • This entry is optional

    • 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 internal ∷ Boolean

Is it internal to our network

  • This entry is optional

Property language ∷ ShortString String

The human language this object is specified in.

  • This entry is optional

    • String with at most 1024 characters

Property observables ∷ Observable Object List

The object(s) of interest

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

Property observed_time ∷ ObservedTime Object

  • This entry is required

Property relations ∷ ObservedRelation Object List

Provide any context we can about where the observable came from

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

Property resolution ∷ Resolution String

  • This entry is optional

    • indicates if the sensor that is reporting the Sighting already took action on it, for instance a Firewall blocking the IP
    • Default: detected
    • Allowed Values:
      • allowed
      • blocked
      • contained
      • detected

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 sensor ∷ Sensor String

The OpenC2 Actuator name that best fits the device that is creating this sighting (e.g. network.firewall)

  • This entry is optional

    • The openC2 Actuator name that best fits a device See also the Open C2 Language Description, Actuator Vocabulary, page 24.
    • Allowed Values:
      • endpoint
      • endpoint.digital-telephone-handset
      • endpoint.laptop
      • endpoint.pos-terminal
      • endpoint.printer
      • endpoint.sensor
      • endpoint.server
      • endpoint.smart-meter
      • endpoint.smart-phone
      • endpoint.tablet
      • endpoint.workstation
      • network
      • network.bridge
      • network.firewall
      • network.gateway
      • network.guard
      • network.hips
      • network.hub
      • network.ids
      • network.ips
      • network.modem
      • network.nic
      • network.proxy
      • network.router
      • network.security_manager
      • network.sense_making
      • network.sensor
      • network.switch
      • network.vpn
      • network.wap
      • process
      • process.aaa-server
      • process.anti-virus-scanner
      • process.connection-scanner
      • process.directory-service
      • process.dns-server
      • process.email-service
      • process.file-scanner
      • process.location-service
      • process.network-scanner
      • process.remediation-service
      • process.reputation-service
      • process.sandbox
      • process.virtualization-service
      • process.vulnerability-scanner
    • Reference: OpenC2 Language Description

Property sensor_coordinates ∷ SensorCoordinates Object

  • This entry is optional

Property severity ∷ HighMedLow String

  • This entry is optional

Property short_description ∷ MedString String

A single line, short summary of the object.

  • This entry is optional

    • String with at most 2048 characters

Property source ∷ MedString String

  • This entry is optional

    • String with at most 2048 characters

Property source_uri ∷ String

  • This entry is optional

    • A URI

Property targets ∷ TargetCoordinates Object List

The target device. Where the sighting came from.

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

Property timestamp ∷ Inst (Date)

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

  • This entry is optional

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

Property title ∷ ShortString String

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

  • This entry is optional

    • String with at most 1024 characters

Property tlp ∷ TLP String

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

  • This entry is optional

    • 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 ∷ SightingTypeIdentifier String

  • This entry is required

    • Must equal: "sighting"

ExternalReference Object

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_nameMedString StringThe source within which the external-reference is defined (system, registry, organization, etc.)
descriptionMarkdown String
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 ∷ Markdown String

  • This entry is optional

    • 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 ∷ MedString String

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

  • This entry is required

    • String with at most 2048 characters

Property url ∷ String

A URL reference to an external resource

  • This entry is optional

    • A URI

ObservedTime Object

Period of time when a cyber observation is valid. start_time must come before end_time (if specified).

PropertyTypeDescriptionRequired?
start_timeInst (Date)Time of the observation. If the observation was made over a period of time, than this field indicates the start of that period
end_timeInst (Date)If the observation was made over a period of time, than this field indicates the end of that period

Property end_time ∷ Inst (Date)

If the observation was made over a period of time, than this field indicates the end of that period

  • This entry is optional

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

Time of the observation. If the observation was made over a period of time, than this field indicates the start of that period

  • This entry is required

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

SightingDataTable Object

An embedded data table for sightings data.

PropertyTypeDescriptionRequired?
columnsColumnDefinition Object Listan ordered list of column definitions
rowsAnything Listan ordered list of rows
row_countIntegerThe number of rows in the data table.

Property columns ∷ ColumnDefinition Object List

an ordered list of column definitions

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

Property row_count ∷ Integer

The number of rows in the data table.

  • This entry is optional

Property rows ∷ Anything List List

an ordered list of rows

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

ColumnDefinition Object

PropertyTypeDescriptionRequired?
nameString
typeColumnType String
descriptionMarkdown String
requiredBooleanIf true, the row entries for this column cannot contain nulls. Defaults to true
short_descriptionString

Property description ∷ Markdown String

  • This entry is optional

    • Markdown string with at most 5000 characters

Property name ∷ String

  • This entry is required

Property required ∷ Boolean

If true, the row entries for this column cannot contain nulls. Defaults to true

  • This entry is optional

Property short_description ∷ String

  • This entry is optional

Property type ∷ ColumnType String

  • This entry is required

    • Allowed Values:
      • integer
      • markdown
      • number
      • observable
      • string
      • url

SensorCoordinates Object

Describes the device that made the sighting (sensor) and contains identifying observables for the sensor.

PropertyTypeDescriptionRequired?
observablesObservable Object List
typeSensor String
osString

Property observables ∷ Observable Object List

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

Property os ∷ String

  • This entry is optional

Property type ∷ Sensor String

  • This entry is required

    • The openC2 Actuator name that best fits a device See also the Open C2 Language Description, Actuator Vocabulary, page 24.
    • Allowed Values:
      • endpoint
      • endpoint.digital-telephone-handset
      • endpoint.laptop
      • endpoint.pos-terminal
      • endpoint.printer
      • endpoint.sensor
      • endpoint.server
      • endpoint.smart-meter
      • endpoint.smart-phone
      • endpoint.tablet
      • endpoint.workstation
      • network
      • network.bridge
      • network.firewall
      • network.gateway
      • network.guard
      • network.hips
      • network.hub
      • network.ids
      • network.ips
      • network.modem
      • network.nic
      • network.proxy
      • network.router
      • network.security_manager
      • network.sense_making
      • network.sensor
      • network.switch
      • network.vpn
      • network.wap
      • process
      • process.aaa-server
      • process.anti-virus-scanner
      • process.connection-scanner
      • process.directory-service
      • process.dns-server
      • process.email-service
      • process.file-scanner
      • process.location-service
      • process.network-scanner
      • process.remediation-service
      • process.reputation-service
      • process.sandbox
      • process.virtualization-service
      • process.vulnerability-scanner
    • Reference: OpenC2 Language Description

Observable Object

A simple, atomic value which has a consistent identity, and is stable enough to be attributed an intent or nature. This is the classic 'indicator' which might appear in a data feed of bad IPs, or bad Domains. These do not exist as objects within the CTIA storage model, so you never create an observable.

PropertyTypeDescriptionRequired?
typeObservableTypeIdentifier String
valueString

Property type ∷ ObservableTypeIdentifier String

  • This entry is required

    • Observable type names
    • Allowed Values:
      • amp_computer_guid
      • cisco_mid
      • device
      • domain
      • email
      • email_messageid
      • email_subject
      • file_name
      • file_path
      • hostname
      • imei
      • imsi
      • ip
      • ipv6
      • mac_address
      • md5
      • mutex
      • ngfw_id
      • ngfw_name
      • odns_identity
      • odns_identity_label
      • pki_serial
      • sha1
      • sha256
      • url
      • user

Property value ∷ String

  • This entry is required

TargetCoordinates Object

Describes the target of the sighting and contains identifying observables for the target.

PropertyTypeDescriptionRequired?
observablesObservable Object List
observed_timeObservedTime Object
typeSensor String
osString

Property observables ∷ Observable Object List

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

Property observed_time ∷ ObservedTime Object

  • This entry is required

Property os ∷ String

  • This entry is optional

Property type ∷ Sensor String

  • This entry is required

    • The openC2 Actuator name that best fits a device See also the Open C2 Language Description, Actuator Vocabulary, page 24.
    • Allowed Values:
      • endpoint
      • endpoint.digital-telephone-handset
      • endpoint.laptop
      • endpoint.pos-terminal
      • endpoint.printer
      • endpoint.sensor
      • endpoint.server
      • endpoint.smart-meter
      • endpoint.smart-phone
      • endpoint.tablet
      • endpoint.workstation
      • network
      • network.bridge
      • network.firewall
      • network.gateway
      • network.guard
      • network.hips
      • network.hub
      • network.ids
      • network.ips
      • network.modem
      • network.nic
      • network.proxy
      • network.router
      • network.security_manager
      • network.sense_making
      • network.sensor
      • network.switch
      • network.vpn
      • network.wap
      • process
      • process.aaa-server
      • process.anti-virus-scanner
      • process.connection-scanner
      • process.directory-service
      • process.dns-server
      • process.email-service
      • process.file-scanner
      • process.location-service
      • process.network-scanner
      • process.remediation-service
      • process.reputation-service
      • process.sandbox
      • process.virtualization-service
      • process.vulnerability-scanner
    • Reference: OpenC2 Language Description

ObservedTime Object

Period of time when a cyber observation is valid. start_time must come before end_time (if specified).

PropertyTypeDescriptionRequired?
start_timeInst (Date)Time of the observation. If the observation was made over a period of time, than this field indicates the start of that period
end_timeInst (Date)If the observation was made over a period of time, than this field indicates the end of that period

Property end_time ∷ Inst (Date)

If the observation was made over a period of time, than this field indicates the end of that period

  • This entry is optional

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

Time of the observation. If the observation was made over a period of time, than this field indicates the start of that period

  • This entry is required

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

Observable Object

A simple, atomic value which has a consistent identity, and is stable enough to be attributed an intent or nature. This is the classic 'indicator' which might appear in a data feed of bad IPs, or bad Domains. These do not exist as objects within the CTIA storage model, so you never create an observable.

PropertyTypeDescriptionRequired?
typeObservableTypeIdentifier String
valueString

Property type ∷ ObservableTypeIdentifier String

  • This entry is required

    • Observable type names
    • Allowed Values:
      • amp_computer_guid
      • cisco_mid
      • device
      • domain
      • email
      • email_messageid
      • email_subject
      • file_name
      • file_path
      • hostname
      • imei
      • imsi
      • ip
      • ipv6
      • mac_address
      • md5
      • mutex
      • ngfw_id
      • ngfw_name
      • odns_identity
      • odns_identity_label
      • pki_serial
      • sha1
      • sha256
      • url
      • user

Property value ∷ String

  • This entry is required

Observable Object

A simple, atomic value which has a consistent identity, and is stable enough to be attributed an intent or nature. This is the classic 'indicator' which might appear in a data feed of bad IPs, or bad Domains. These do not exist as objects within the CTIA storage model, so you never create an observable.

PropertyTypeDescriptionRequired?
typeObservableTypeIdentifier String
valueString

Property type ∷ ObservableTypeIdentifier String

  • This entry is required

    • Observable type names
    • Allowed Values:
      • amp_computer_guid
      • cisco_mid
      • device
      • domain
      • email
      • email_messageid
      • email_subject
      • file_name
      • file_path
      • hostname
      • imei
      • imsi
      • ip
      • ipv6
      • mac_address
      • md5
      • mutex
      • ngfw_id
      • ngfw_name
      • odns_identity
      • odns_identity_label
      • pki_serial
      • sha1
      • sha256
      • url
      • user

Property value ∷ String

  • This entry is required

ObservedRelation Object

A relation inside a Sighting.

PropertyTypeDescriptionRequired?
originString
relatedObservable Object
relationObservableRelationType String
sourceObservable Object
origin_uriString
relation_infoObject

Property origin ∷ String

  • This entry is required

Property origin_uri ∷ String

  • This entry is optional

    • A URI

Property related ∷ Observable Object

  • This entry is required

Property relation ∷ ObservableRelationType String

  • This entry is required

    • Allowed Values:
      • Allocated
      • Allocated_By
      • Attached_To
      • Bound
      • Bound_By
      • Characterized_By
      • Characterizes
      • Child_Of
      • Closed
      • Closed_By
      • Compressed
      • Compressed_By
      • Compressed_From
      • Compressed_Into
      • Connected_From
      • Connected_To
      • Contained_Within
      • Contains
      • Copied
      • Copied_By
      • Copied_From
      • Copied_To
      • Created
      • Created_By
      • Decoded
      • Decoded_By
      • Decompressed
      • Decompressed_By
      • Decrypted
      • Decrypted_By
      • Deleted
      • Deleted_By
      • Deleted_From
      • Downloaded
      • Downloaded_By
      • Downloaded_From
      • Downloaded_To
      • Dropped
      • Dropped_By
      • Encoded
      • Encoded_By
      • Encrypted
      • Encrypted_By
      • Encrypted_From
      • Encrypted_To
      • Extracted_From
      • FQDN_Of
      • Freed
      • Freed_By
      • Hooked
      • Hooked_By
      • Initialized_By
      • Initialized_To
      • Injected
      • Injected_As
      • Injected_By
      • Injected_Into
      • Installed
      • Installed_By
      • Joined
      • Joined_By
      • Killed
      • Killed_By
      • Listened_On
      • Listened_On_By
      • Loaded_From
      • Loaded_Into
      • Locked
      • Locked_By
      • Mapped_By
      • Mapped_Into
      • Merged
      • Merged_By
      • Modified_Properties_Of
      • Monitored
      • Monitored_By
      • Moved
      • Moved_By
      • Moved_From
      • Moved_To
      • Opened
      • Opened_By
      • Packed
      • Packed_By
      • Packed_From
      • Packed_Into
      • Parent_Of
      • Paused
      • Paused_By
      • Previously_Contained
      • Properties_Modified_By
      • Properties_Queried
      • Properties_Queried_By
      • Read_From
      • Read_From_By
      • Received
      • Received_By
      • Received_From
      • Received_Via_Upload
      • Redirects_To
      • Refers_To
      • Related_To
      • Renamed
      • Renamed_By
      • Renamed_From
      • Renamed_To
      • Resolved_To
      • Resumed
      • Resumed_By
      • Root_Domain_Of
      • Searched_For
      • Searched_For_By
      • Sent
      • Sent_By
      • Sent_To
      • Sent_Via_Upload
      • Set_From
      • Set_To
      • Sub-domain_Of
      • Supra-domain_Of
      • Suspended
      • Suspended_By
      • Unhooked
      • Unhooked_By
      • Unlocked
      • Unlocked_By
      • Unpacked
      • Unpacked_By
      • Uploaded
      • Uploaded_By
      • Uploaded_From
      • Uploaded_To
      • Used
      • Used_By
      • Values_Enumerated
      • Values_Enumerated_By
      • Written_To_By
      • Wrote_To

Property relation_info ∷ Object

  • This entry is optional

Property source ∷ Observable Object

  • This entry is required

Observable Object

A simple, atomic value which has a consistent identity, and is stable enough to be attributed an intent or nature. This is the classic 'indicator' which might appear in a data feed of bad IPs, or bad Domains. These do not exist as objects within the CTIA storage model, so you never create an observable.

PropertyTypeDescriptionRequired?
typeObservableTypeIdentifier String
valueString

Property type ∷ ObservableTypeIdentifier String

  • This entry is required

    • Observable type names
    • Allowed Values:
      • amp_computer_guid
      • cisco_mid
      • device
      • domain
      • email
      • email_messageid
      • email_subject
      • file_name
      • file_path
      • hostname
      • imei
      • imsi
      • ip
      • ipv6
      • mac_address
      • md5
      • mutex
      • ngfw_id
      • ngfw_name
      • odns_identity
      • odns_identity_label
      • pki_serial
      • sha1
      • sha256
      • url
      • user

Property value ∷ String

  • This entry is required

Observable Object

A simple, atomic value which has a consistent identity, and is stable enough to be attributed an intent or nature. This is the classic 'indicator' which might appear in a data feed of bad IPs, or bad Domains. These do not exist as objects within the CTIA storage model, so you never create an observable.

PropertyTypeDescriptionRequired?
typeObservableTypeIdentifier String
valueString

Property type ∷ ObservableTypeIdentifier String

  • This entry is required

    • Observable type names
    • Allowed Values:
      • amp_computer_guid
      • cisco_mid
      • device
      • domain
      • email
      • email_messageid
      • email_subject
      • file_name
      • file_path
      • hostname
      • imei
      • imsi
      • ip
      • ipv6
      • mac_address
      • md5
      • mutex
      • ngfw_id
      • ngfw_name
      • odns_identity
      • odns_identity_label
      • pki_serial
      • sha1
      • sha256
      • url
      • user

Property value ∷ String

  • This entry is required

Object

PropertyTypeDescriptionRequired?
KeywordAnything

Property Keyword ∷ Anything

  • This entry is required

Can you improve this documentation?Edit on GitHub

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

× close