Skip to content

Commit

Permalink
documentation for version 2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@rpiazza
rpiazza committed Jan 16, 2019
1 parent 716e901 commit 91a847c
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 10 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
View file
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/command-line.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/cyber-observables.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.

+-----------------------------------------------------------+--------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/stix-mappings.rst
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/warnings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 91a847c

Please sign in to comment.