Skip to content

Commit 12d3912

Browse files
author
Bryan Worrell
committed
Added high-level overview docs to each of the top-level component classes.
1 parent d167928 commit 12d3912

7 files changed

Lines changed: 97 additions & 7 deletions

File tree

docs/api/campaign/campaign.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@
33

44
.. module:: stix.campaign
55

6+
Overview
7+
--------
8+
9+
The :mod:`stix.campaign` module implements :class:`.Campaign`.
10+
11+
Campaigns are instances of ThreatActors pursuing an intent, as observed through
12+
sets of Incidents and/or TTP, potentially across organizations.
13+
14+
15+
Documentation Resources
16+
~~~~~~~~~~~~~~~~~~~~~~~
17+
18+
* `Campaign Data Model <http://stixproject.github.io/data-model/1.2/campaign/CampaignType/>`_
19+
620
Classes
721
-------
822

docs/api/coa/coa.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
:mod:`stix.coa` Module
2-
==================================
2+
======================
33

44
.. module:: stix.coa
55

6+
Overview
7+
--------
8+
9+
The :mod:`stix.coa` module implements :class:`.CourseOfAction`.
10+
11+
CoursesOfAction are specific measures to be taken to address threat whether
12+
they are corrective or preventative to address ExploitTargets, or responsive to
13+
counter or mitigate the potential impacts of Incidents
14+
15+
16+
Documentation Resources
17+
~~~~~~~~~~~~~~~~~~~~~~~
18+
19+
* `Course Of Action Data Model <http://stixproject.github.io/data-model/1.2/coa/CourseOfActionType/>`_
20+
21+
622
Classes
723
-------
824

docs/api/exploit_target/exploit_target.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,18 @@
55

66
Overview
77
--------
8-
The :mod:`stix.exploit_target` module implements ``ExploitTarget``.
9-
This denotes the specific vulnerability, weakness, or software configuration that creates a security risk.
8+
9+
The :mod:`stix.exploit_target` module implements :class:`.ExploitTarget`.
10+
11+
This denotes the specific vulnerability, weakness, or software configuration
12+
that creates a security risk.
1013

1114

1215
Documentation Resources
1316
~~~~~~~~~~~~~~~~~~~~~~~
1417

15-
* `ExploitTarget Data Model <https://stixproject.github.io/data-model/1.2/et/ExploitTargetType/>`_
16-
* `ExploitTarget Idioms <https://stixproject.github.io/documentation/idioms/cve/>`_
18+
* `Exploit Target Data Model <https://stixproject.github.io/data-model/1.2/et/ExploitTargetType/>`_
19+
* `Exploit Target Idioms <https://stixproject.github.io/documentation/idioms/cve/>`_
1720

1821
Classes
1922
-------

docs/api/incident/incident.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
:mod:`stix.incident` Module
2-
==================================
2+
===========================
33

44
.. module:: stix.incident
55

6+
Overview
7+
--------
8+
9+
The :mod:`stix.incident` module implements :class:`.Incident`.
10+
11+
Incidents are discrete instances of Indicators affecting an organization along
12+
with information discovered or decided during an incident response investigation.
13+
14+
15+
Documentation Resources
16+
~~~~~~~~~~~~~~~~~~~~~~~
17+
18+
* `Incident Data Model <https://stixproject.github.io/data-model/1.2/incident/IncidentType/>`_
19+
620
Classes
721
-------
822

docs/api/report/report.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@
33

44
.. module:: stix.report
55

6+
Overview
7+
--------
8+
9+
The :mod:`stix.report` module implements :class:`.Report`.
10+
11+
A Report defines a contextual wrapper for a grouping of STIX content.
12+
13+
14+
Documentation Resources
15+
~~~~~~~~~~~~~~~~~~~~~~~
16+
17+
* `Report Data Model <https://stixproject.github.io/data-model/1.2/report/ReportType/>`_
18+
19+
620
Classes
721
-------
822

docs/api/threat_actor/threat_actor.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33

44
.. module:: stix.threat_actor
55

6+
Overview
7+
--------
8+
9+
The :mod:`stix.threat_actor` module implements :class:`.ThreatActor`.
10+
11+
ThreatActors are characterizations of malicious actors (or adversaries)
12+
representing a cyber attack threat including presumed intent and historically
13+
observed behavior.
14+
15+
16+
Documentation Resources
17+
~~~~~~~~~~~~~~~~~~~~~~~
18+
19+
* `Threat Actor Data Model <https://stixproject.github.io/data-model/1.2/ta/ThreatActorType/>`_
20+
21+
622
Classes
723
-------
824

docs/api/ttp/ttp.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
:mod:`stix.ttp` Module
2-
==================================
2+
======================
33

44
.. module:: stix.ttp
55

6+
Overview
7+
--------
8+
9+
The :mod:`stix.ttp` module implements :class:`.TTP`.
10+
11+
TTPs are representations of the behavior or modus operandi of cyber adversaries.
12+
13+
14+
Documentation Resources
15+
~~~~~~~~~~~~~~~~~~~~~~~
16+
17+
* `TTP Data Model <https://stixproject.github.io/data-model/1.2/ttp/TTPType/>`_
18+
619
Classes
720
-------
821

0 commit comments

Comments
 (0)