Merge pull request #263 from STIXProject/next-1.2.0.0-dev

1.2.0.0

Author: Bryan Worrell

CHANGES.txt

@@ -1,3 +1,24 @@
+Version 1.2.0.0
+2015-05-15
+- Support for parsing and creating STIX 1.2 content.
+- Added VocabString implementations for deprecated default STIX controlled
+  vocabularies.
+- Refactored internal class resolution for xsi:types.
+- #262 Added support for STIX Report content
+- #261 Added deprecation warnings when setting fields that have been 
+  deprecated in STIX 1.2.
+- #260 Added Versioning controlled vocabulary.
+- #253 Added support for Kill Chain Phases and Related Pacakges on TTP 
+
+Version 1.1.1.5
+2015-04-29
+- #200 Refactored ns_dict behavior in to_xml() to allow custom namespace mappings
+- #254 Added information_source to MarkingSpecification class.
+- #188 Added nationalities to CIQ Identity extension.
+- #246 Added coa_requested to Incident class.
+- #248 Set include_schemalocs to False by default in to_xml()
+- #249 Removed "Work In Progress" label from RTD documentation.
+
 Version 1.1.1.4
 2015-03-19
 - #44 Added StructuredCOA support. This completes the COA structure.

README.rst

@@ -1,7 +1,7 @@
 python-stix
 ===========
 
-A python library for parsing, manipulating, and generating STIX v1.1.1 content.
+A python library for parsing, manipulating, and generating STIX v1.2 content.
 
 :Source: https://github.com/STIXProject/python-stix
 :Documentation: http://stix.readthedocs.org
@@ -67,36 +67,38 @@ Layout
 
 The python-stix package layout is as follows:
 
-* ``stix/`` : root level package
+* ``stix/`` : root level package.
 
-* ``examples/`` : example python scripts that leverage the python-stix library
+* ``examples/`` : example python scripts that leverage the python-stix library.
 
 * ``stix/utils/`` : utility classes and modules used internally by the python-stix
-  library
+  library.
 
 * ``stix/bindings/`` : generateDS generated xml-to-python bindings (leveraged for
-  parsing and output of STIX XML content)
+  parsing and output of STIX XML content).
 
-* ``stix/campaign/`` : APIs for STIX Campaign constructs
+* ``stix/campaign/`` : APIs for STIX Campaign constructs.
 
-* ``stix/coa/`` : APIs for STIX Course Of Action constructs
+* ``stix/coa/`` : APIs for STIX Course Of Action constructs.
 
-* ``stix/core/`` : APIs for core STIX constructs (e.g., STIX Header, STIX Package)
+* ``stix/core/`` : APIs for core STIX constructs (e.g., STIX Header, STIX Package).
 
 * ``stix/common/`` : APIs for common STIX constructs (e.g., Structured Text,
-  Information Source)
+  Information Source).
 
-* ``stix/exploit_target/`` : APIs for STIX Exploit Target constructs
+* ``stix/exploit_target/`` : APIs for STIX Exploit Target constructs.
 
-* ``stix/incident/`` : APIs for common Incident constructs
+* ``stix/incident/`` : APIs for common Incident constructs.
 
-* ``stix/indicator/`` : APIs for STIX Indicator constructs
+* ``stix/indicator/`` : APIs for STIX Indicator constructs.
 
-* ``stix/extensions/`` : APIs for STIX extensions (e.g., CIQ Identity)
+* ``stix/extensions/`` : APIs for STIX extensions (e.g., CIQ Identity).
 
-* ``stix/threat_actor/`` : APIs for STIX Threat Actor constructs
+* ``stix/report/``: APIs for STIX Report constructs.
 
-* ``stix/ttp/`` : APIs for STIX TTP constructs
+* ``stix/threat_actor/`` : APIs for STIX Threat Actor constructs.
+
+* ``stix/ttp/`` : APIs for STIX TTP constructs.
 
 Please refer to examples for concrete examples of how to interact with the
-python-stix library
+python-stix library.

docs/api/campaign/campaign.rst

@@ -3,33 +3,51 @@
 
 .. module:: stix.campaign
 
+Overview
+--------
+
+The :mod:`stix.campaign` module implements :class:`.Campaign`.
+
+Campaigns are instances of ThreatActors pursuing an intent, as observed through
+sets of Incidents and/or TTP, potentially across organizations.
+
+
+Documentation Resources
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* `Campaign Data Model <http://stixproject.github.io/data-model/1.2/campaign/CampaignType/>`_
+
 Classes
 -------
 
 .. autoclass:: Campaign
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members: activity, add_activity, add_description, add_intended_effect,
+        add_short_description, attribution, description, descriptions, find, id_,
+        idref, information_source, intended_effects, short_description,
+        short_descriptions, status, timestamp, title, to_dict, to_json, to_obj,
+        version, walk
 
 .. autoclass:: AssociatedCampaigns
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: Attribution
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: Names
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: RelatedIncidents
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: RelatedIndicators
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: RelatedTTPs
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:

docs/api/coa/coa.rst

@@ -1,14 +1,34 @@
 :mod:`stix.coa` Module
-==================================
+======================
 
 .. module:: stix.coa
 
+Overview
+--------
+
+The :mod:`stix.coa` module implements :class:`.CourseOfAction`.
+
+CoursesOfAction are specific measures to be taken to address threat whether
+they are corrective or preventative to address ExploitTargets, or responsive to
+counter or mitigate the potential impacts of Incidents
+
+
+Documentation Resources
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* `Course Of Action Data Model <http://stixproject.github.io/data-model/1.2/coa/CourseOfActionType/>`_
+
+
 Classes
 -------
 
 .. autoclass:: CourseOfAction
     :show-inheritance:
-    :members:
+    :members: add_description, add_short_description, cost, description,
+        descriptions, efficacy, find, handling, id_, idref, impact,
+        information_source, objective, short_description, short_descriptions,
+        stage, structured_coa, timestamp, title, to_dict, to_json, to_obj, type_,
+        version, walk
 
 .. autoclass:: RelatedCOAs
     :show-inheritance:

docs/api/common/identity.rst

@@ -19,7 +19,3 @@ Functions
 
 .. autofunction:: add_extension
 
-Constants
----------
-
-.. autodata:: _EXTENSION_MAP

docs/api/common/kill_chains.rst

@@ -7,24 +7,24 @@ Classes
 -------
 
 .. autoclass:: KillChain
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: KillChains
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: KillChainPhase
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: KillChainPhaseReference
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 .. autoclass:: KillChainPhasesReference
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members:
 
 Lockheed Martin Kill Chain
 --------------------------

docs/api/common/related.rst

@@ -1,5 +1,5 @@
 :mod:`stix.common.related` Module
-==================================
+=================================
 
 .. module:: stix.common.related
 
@@ -61,3 +61,12 @@ Classes
 .. autoclass:: RelatedTTP
 	:show-inheritance:
 	:members:
+
+.. autoclass:: RelatedReports
+    :show-inheritance:
+    :members:
+
+.. autoclass:: RelatedReport
+    :show-inheritance:
+    :members:
+

docs/api/common/structured_text.rst

@@ -7,5 +7,13 @@ Classes
 -------
 
 .. autoclass:: StructuredText
-	:show-inheritance:
-	:members:
+    :show-inheritance:
+    :members: to_obj, from_obj, to_dict, from_dict, ordinality,
+        __str__, __unicode__
+
+.. autoclass:: StructuredTextList
+    :show-inheritance:
+    :members: __getitem__, __delitem__, __iter__, add, update,
+        insert, remove, reset, sorted, next_ordinality, to_obj, to_dict
+
+