From 91a847c29b2a3492d7696a96cf72a2701aa9238e Mon Sep 17 00:00:00 2001 From: Richard Piazza Date: Wed, 16 Jan 2019 13:12:28 -0500 Subject: [PATCH] documentation for version 2.0.1 --- CHANGELOG | 4 ++++ README.rst | 2 +- docs/command-line.rst | 6 +++--- docs/cyber-observables.rst | 6 +++--- docs/stix-mappings.rst | 2 +- docs/warnings.rst | 4 ++-- 6 files changed, 14 insertions(+), 10 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 9bce89f0..ddbaa45f 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,10 @@ CHANGELOG ========= +2.0.1 - 2019-01-16 + + * #145 - Pass version option given in the command line to the stix-validator + 2.0.0 - 2019-01-04 * Introduce the "stepper" to convert STIX 2.0 content to STIX 2.1 content diff --git a/README.rst b/README.rst index 236d2aa6..33b758c5 100644 --- a/README.rst +++ b/README.rst @@ -109,7 +109,7 @@ STIX 1.1.1 - 1.2.1 content to STIX 2.0 or 2.1 content:: [-v VERSION] file -stix2-elevator v2.0.0 +stix2-elevator v2.0.1 The stix2-elevator is a work-in-progress. It should be used to explore how existing STIX 1.x would potentially be represented in STIX 2.x. Using the diff --git a/docs/command-line.rst b/docs/command-line.rst index 6dfb18e5..090dfc78 100644 --- a/docs/command-line.rst +++ b/docs/command-line.rst @@ -2,7 +2,7 @@ =========================== The elevator comes with a bundled script which you can use to elevate -STIX 1.1.1 - 1.2.1 content to STIX 2.0 content: +STIX 1.x content to STIX 2.x content: .. code-block:: text @@ -19,7 +19,7 @@ STIX 1.1.1 - 1.2.1 content to STIX 2.0 content: file -stix2-elevator v1.2.0 +stix2-elevator v2.0.1 The stix2-elevator is a work-in-progress. It should be used to explore how existing STIX 1.x would potentially be represented in STIX 2.0. Using the @@ -41,7 +41,7 @@ optional arguments: --no-squirrel-gaps Do not include STIX 1.x content that cannot be - represented directly in STIX 2.0 using the description + represented directly in STIX 2.x using the description property. --package-created-by-id PACKAGE_CREATED_BY_ID diff --git a/docs/cyber-observables.rst b/docs/cyber-observables.rst index 05b1e1a3..d993f181 100644 --- a/docs/cyber-observables.rst +++ b/docs/cyber-observables.rst @@ -8,7 +8,7 @@ CybOX object types not listed have no corresponding STIX 2.x cyber observable ty converted by the elevator. =============================== ============================================= ============================================== -**Cybox 2.x Object Type** **STIX 2.x Cyber Observable Type** **Converted in version 1.2 of the Elevator** +**Cybox 2.x Object Type** **STIX 2.x Cyber Observable Type** **Converted in version 2.0.1 of the Elevator** =============================== ============================================= ============================================== ``Address`` ``email-addr`` yes ``Address`` ``ipv4-addr`` yes @@ -52,7 +52,7 @@ converted by the elevator. Converting Network Cyber Observables ------------------------------------------ -Most of the mappings between CybOX 2.x objects and STIX 2.0 cyber +Most of the mappings between CybOX 2.x objects and STIX 2.x cyber observables are straightforward, therefore, they will not be detailed in this document. However, it would be advantageous to detail the mappings of ``network-traffic``, a "catch-all" STIX 2.0 cyber observable type for @@ -67,7 +67,7 @@ This information is organized very differently than in CybOX 2.x. In addition, many CybOX 2.x properties are not available in the ``network-traffic`` object. -Notice that although both STIX 1.x and 2.0 have object types to represent TCP packets, +Notice that although both STIX 1.x and 2.x have object types to represent TCP packets, they are not compatible, so no conversion is made. +-----------------------------------------------------------+--------------------------------------+ diff --git a/docs/stix-mappings.rst b/docs/stix-mappings.rst index 459a177f..1a76bdc1 100644 --- a/docs/stix-mappings.rst +++ b/docs/stix-mappings.rst @@ -1,4 +1,4 @@ -​Mappings from STIX 1.x to STIX 2.0 +​Mappings from STIX 1.x to STIX 2.x ======================================= This section outlines the disposition of each property of the top-level objects when converted. diff --git a/docs/warnings.rst b/docs/warnings.rst index cbf8252b..47ef310d 100644 --- a/docs/warnings.rst +++ b/docs/warnings.rst @@ -47,7 +47,7 @@ Dropping Content not supported in STIX 2.x ============================================================================================================================================== ==== ===== Message Code Level ============================================================================================================================================== ==== ===== -``Information Source`` on *[id]* is not representable in STIX 2.0 401 warn +``Information Source`` on *[id]* is not representable in STIX 2.x 401 warn ``Related_Packages`` type in *[id]* not supported in STIX 2.x 402 warn ``Campaign/Activity`` type in *[id]* not supported in STIX 2.x 403 warn Structured COAs type in *[id]* are not supported in STIX 2.x 404 warn @@ -67,7 +67,7 @@ No STIX 2.x object generated from embedded object *[id]* The *[property]* property of *[STIX 1.x object type]* is not part of STIX 2.x 418 warn ``NO MESSAGE ASSIGNED`` 419 Windows Handles are not a part of STIX 2.x 420 warn -The address type [address] is not part of STIX 2.0 421 warn +The address type [address] is not part of STIX 2.x 421 warn No pattern term was created from *[id]* 422 warn *[id]* is used as a pattern, therefore it is not included as an observed_data instance 423 warn *[xxx]* content is not supported in STIX 2.x 424 warn