Emmanuelle Vargas-Gonzalez
parent
7476456e46
commit
e0aa8abd0c
174
README.rst
174
README.rst
|
|
@ -3,40 +3,32 @@
|
||||||
cti-python-stix2
|
cti-python-stix2
|
||||||
================
|
================
|
||||||
|
|
||||||
This is an `OASIS TC Open
|
This is an `OASIS TC Open Repository <https://www.oasis-open.org/resources/open-repositories/>`__.
|
||||||
Repository <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/>`__.
|
|
||||||
See the `Governance <#governance>`__ section for more information.
|
See the `Governance <#governance>`__ section for more information.
|
||||||
|
|
||||||
This repository provides Python APIs for serializing and de-
|
This repository provides Python APIs for serializing and de-serializing STIX2
|
||||||
serializing
|
JSON content, along with higher-level APIs for common tasks, including data
|
||||||
STIX 2 JSON content, along with higher-level APIs for common tasks,
|
markings, versioning, and for resolving STIX IDs across multiple data sources.
|
||||||
including data markings, versioning, and for resolving STIX IDs across
|
|
||||||
multiple data sources.
|
|
||||||
|
|
||||||
For more information, see `the
|
For more information, see `the documentation <https://stix2.readthedocs.io/>`__ on ReadTheDocs.
|
||||||
documentation <https://stix2.readthedocs.io/>`__ on
|
|
||||||
ReadTheDocs.
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Install with `pip <https://pip.pypa.io/en/stable/>`__:
|
Install with `pip <https://pip.pypa.io/en/stable/>`__:
|
||||||
|
|
||||||
::
|
.. code-block:: bash
|
||||||
|
|
||||||
pip install stix2
|
$ pip install stix2
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
To create a STIX object, provide keyword arguments to the type's
|
To create a STIX object, provide keyword arguments to the type's constructor.
|
||||||
constructor. Certain required attributes of all objects, such as
|
Certain required attributes of all objects, such as ``type`` or ``id``, will
|
||||||
``type`` or
|
be set automatically if not provided as keyword arguments.
|
||||||
``id``, will be set automatically if not provided as keyword
|
|
||||||
arguments.
|
|
||||||
|
|
||||||
.. code:: python
|
.. code-block:: python
|
||||||
|
|
||||||
from stix2 import Indicator
|
from stix2 import Indicator
|
||||||
|
|
||||||
|
|
@ -44,10 +36,9 @@ arguments.
|
||||||
labels=["malicious-activity"],
|
labels=["malicious-activity"],
|
||||||
pattern="[file:hashes.md5 = 'd41d8cd98f00b204e9800998ecf8427e']")
|
pattern="[file:hashes.md5 = 'd41d8cd98f00b204e9800998ecf8427e']")
|
||||||
|
|
||||||
To parse a STIX JSON string into a Python STIX object, use
|
To parse a STIX JSON string into a Python STIX object, use ``parse()``:
|
||||||
``parse()``:
|
|
||||||
|
|
||||||
.. code:: python
|
.. code-block:: python
|
||||||
|
|
||||||
from stix2 import parse
|
from stix2 import parse
|
||||||
|
|
||||||
|
|
@ -63,10 +54,10 @@ To parse a STIX JSON string into a Python STIX object, use
|
||||||
"pattern": "[file:hashes.md5 ='d41d8cd98f00b204e9800998ecf8427e']",
|
"pattern": "[file:hashes.md5 ='d41d8cd98f00b204e9800998ecf8427e']",
|
||||||
"valid_from": "2017-09-26T23:33:39.829952Z"
|
"valid_from": "2017-09-26T23:33:39.829952Z"
|
||||||
}""")
|
}""")
|
||||||
|
|
||||||
print(indicator)
|
print(indicator)
|
||||||
|
|
||||||
For more in-depth documentation, please see
|
For more in-depth documentation, please see `https://stix2.readthedocs.io/ <https://stix2.readthedocs.io/>`__.
|
||||||
`https://stix2.readthedocs.io/ <https://stix2.readthedocs.io/>`__.
|
|
||||||
|
|
||||||
STIX 2.X Technical Specification Support
|
STIX 2.X Technical Specification Support
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
@ -81,127 +72,80 @@ for more details.
|
||||||
Governance
|
Governance
|
||||||
----------
|
----------
|
||||||
|
|
||||||
This GitHub public repository (
|
This GitHub public repository (**https://github.com/oasis-open/cti-python-stix2**) was
|
||||||
**https://github.com/oasis-open/cti-python-stix2** ) was
|
`proposed <https://lists.oasis-open.org/archives/cti/201702/msg00008.html>`__ and
|
||||||
`proposed <https://lists.oasis-
|
`approved <https://www.oasis-open.org/committees/download.php/60009/>`__
|
||||||
open.org/archives/cti/201702/msg00008.html>`__
|
|
||||||
and
|
|
||||||
`approved <https://www.oasis-
|
|
||||||
open.org/committees/download.php/60009/>`__
|
|
||||||
[`bis <https://issues.oasis-open.org/browse/TCADMIN-2549>`__] by the
|
[`bis <https://issues.oasis-open.org/browse/TCADMIN-2549>`__] by the
|
||||||
`OASIS Cyber Threat Intelligence (CTI)
|
`OASIS Cyber Threat Intelligence (CTI) TC <https://www.oasis-open.org/committees/cti/>`__
|
||||||
TC <https://www.oasis-open.org/committees/cti/>`__ as an `OASIS TC
|
as an `OASIS TC Open Repository <https://www.oasis-open.org/resources/open-repositories/>`__
|
||||||
Open
|
to support development of open source resources related to Technical Committee work.
|
||||||
Repository <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/>`__
|
|
||||||
to support development of open source resources related to Technical
|
|
||||||
Committee work.
|
|
||||||
|
|
||||||
While this TC Open Repository remains associated with the sponsor TC,
|
While this TC Open Repository remains associated with the sponsor TC, its
|
||||||
its
|
development priorities, leadership, intellectual property terms, participation
|
||||||
development priorities, leadership, intellectual property terms,
|
rules, and other matters of governance are `separate and distinct
|
||||||
participation rules, and other matters of governance are `separate and
|
<https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#governance-distinct-from-oasis-tc-process>`__
|
||||||
distinct <https://github.com/oasis-open/cti-python-
|
|
||||||
stix2/blob/master/CONTRIBUTING.md#governance-distinct-from-oasis-tc-
|
|
||||||
process>`__
|
|
||||||
from the OASIS TC Process and related policies.
|
from the OASIS TC Process and related policies.
|
||||||
|
|
||||||
All contributions made to this TC Open Repository are subject to open
|
All contributions made to this TC Open Repository are subject to open
|
||||||
source license terms expressed in the `BSD-3-Clause
|
source license terms expressed in the `BSD-3-Clause License <https://www.oasis-open.org/sites/www.oasis-open.org/files/BSD-3-Clause.txt>`__.
|
||||||
License <https://www.oasis-open.org/sites/www.oasis-
|
That license was selected as the declared `"Applicable License" <https://www.oasis-open.org/resources/open-repositories/licenses>`__
|
||||||
open.org/files/BSD-3-Clause.txt>`__.
|
|
||||||
That license was selected as the declared `"Applicable
|
|
||||||
License" <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/licenses>`__
|
|
||||||
when the TC Open Repository was created.
|
when the TC Open Repository was created.
|
||||||
|
|
||||||
As documented in `"Public Participation
|
As documented in `"Public Participation Invited
|
||||||
Invited <https://github.com/oasis-open/cti-python-
|
<https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#public-participation-invited>`__",
|
||||||
stix2/blob/master/CONTRIBUTING.md#public-participation-invited>`__",
|
contributions to this OASIS TC Open Repository are invited from all parties,
|
||||||
contributions to this OASIS TC Open Repository are invited from all
|
whether affiliated with OASIS or not. Participants must have a GitHub account,
|
||||||
parties, whether affiliated with OASIS or not. Participants must have
|
but no fees or OASIS membership obligations are required. Participation is
|
||||||
a
|
expected to be consistent with the `OASIS TC Open Repository Guidelines and Procedures
|
||||||
GitHub account, but no fees or OASIS membership obligations are
|
<https://www.oasis-open.org/policies-guidelines/open-repositories>`__,
|
||||||
required. Participation is expected to be consistent with the `OASIS
|
the open source `LICENSE <https://github.com/oasis-open/cti-python-stix2/blob/master/LICENSE>`__
|
||||||
TC Open Repository Guidelines and
|
|
||||||
Procedures <https://www.oasis-open.org/policies-guidelines/open-
|
|
||||||
repositories>`__,
|
|
||||||
the open source
|
|
||||||
`LICENSE <https://github.com/oasis-open/cti-python-
|
|
||||||
stix2/blob/master/LICENSE>`__
|
|
||||||
designated for this particular repository, and the requirement for an
|
designated for this particular repository, and the requirement for an
|
||||||
`Individual Contributor License
|
`Individual Contributor License Agreement <https://www.oasis-open.org/resources/open-repositories/cla/individual-cla>`__
|
||||||
Agreement <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/cla/individual-cla>`__
|
|
||||||
that governs intellectual property.
|
that governs intellectual property.
|
||||||
|
|
||||||
Maintainers
|
Maintainers
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
TC Open Repository
|
TC Open Repository `Maintainers <https://www.oasis-open.org/resources/open-repositories/maintainers-guide>`__
|
||||||
`Maintainers <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/maintainers-guide>`__
|
|
||||||
are responsible for oversight of this project's community development
|
are responsible for oversight of this project's community development
|
||||||
activities, including evaluation of GitHub `pull
|
activities, including evaluation of GitHub
|
||||||
requests <https://github.com/oasis-open/cti-python-
|
`pull requests <https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#fork-and-pull-collaboration-model>`__
|
||||||
stix2/blob/master/CONTRIBUTING.md#fork-and-pull-collaboration-
|
and `preserving <https://www.oasis-open.org/policies-guidelines/open-repositories#repositoryManagement>`__
|
||||||
model>`__
|
open source principles of openness and fairness. Maintainers are recognized
|
||||||
and
|
and trusted experts who serve to implement community goals and consensus design
|
||||||
`preserving <https://www.oasis-open.org/policies-guidelines/open-
|
preferences.
|
||||||
repositories#repositoryManagement>`__
|
|
||||||
open source principles of openness and fairness. Maintainers are
|
|
||||||
recognized and trusted experts who serve to implement community goals
|
|
||||||
and consensus design preferences.
|
|
||||||
|
|
||||||
Initially, the associated TC members have designated one or more
|
Initially, the associated TC members have designated one or more persons to
|
||||||
persons
|
serve as Maintainer(s); subsequently, participating community members may
|
||||||
to serve as Maintainer(s); subsequently, participating community
|
select additional or substitute Maintainers, per `consensus agreements
|
||||||
members
|
<https://www.oasis-open.org/resources/open-repositories/maintainers-guide#additionalMaintainers>`__.
|
||||||
may select additional or substitute Maintainers, per `consensus
|
|
||||||
agreements <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/maintainers-guide#additionalMaintainers>`__.
|
|
||||||
|
|
||||||
.. _currentMaintainers:
|
.. _currentmaintainers:
|
||||||
|
|
||||||
**Current Maintainers of this TC Open Repository**
|
**Current Maintainers of this TC Open Repository**
|
||||||
|
|
||||||
- `Greg Back <mailto:gback@mitre.org>`__; GitHub ID:
|
- `Greg Back <mailto:gback@mitre.org>`__; GitHub ID:
|
||||||
https://github.com/gtback/; WWW: `MITRE
|
https://github.com/gtback/; WWW: `MITRE Corporation <http://www.mitre.org/>`__
|
||||||
Corporation <http://www.mitre.org/>`__
|
|
||||||
- `Chris Lenk <mailto:clenk@mitre.org>`__; GitHub ID:
|
- `Chris Lenk <mailto:clenk@mitre.org>`__; GitHub ID:
|
||||||
https://github.com/clenk/; WWW: `MITRE
|
https://github.com/clenk/; WWW: `MITRE Corporation <http://www.mitre.org/>`__
|
||||||
Corporation <http://www.mitre.org/>`__
|
|
||||||
|
|
||||||
About OASIS TC Open Repositories
|
About OASIS TC Open Repositories
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
- `TC Open Repositories: Overview and
|
- `TC Open Repositories: Overview and Resources <https://www.oasis-open.org/resources/open-repositories/>`__
|
||||||
Resources <https://www.oasis-open.org/resources/open-
|
- `Frequently Asked Questions <https://www.oasis-open.org/resources/open-repositories/faq>`__
|
||||||
repositories/>`__
|
- `Open Source Licenses <https://www.oasis-open.org/resources/open-repositories/licenses>`__
|
||||||
- `Frequently Asked
|
- `Contributor License Agreements (CLAs) <https://www.oasis-open.org/resources/open-repositories/cla>`__
|
||||||
Questions <https://www.oasis-open.org/resources/open-
|
- `Maintainers' Guidelines and Agreement <https://www.oasis-open.org/resources/open-repositories/maintainers-guide>`__
|
||||||
repositories/faq>`__
|
|
||||||
- `Open Source
|
|
||||||
Licenses <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/licenses>`__
|
|
||||||
- `Contributor License Agreements
|
|
||||||
(CLAs) <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/cla>`__
|
|
||||||
- `Maintainers' Guidelines and
|
|
||||||
Agreement <https://www.oasis-open.org/resources/open-
|
|
||||||
repositories/maintainers-guide>`__
|
|
||||||
|
|
||||||
Feedback
|
Feedback
|
||||||
--------
|
--------
|
||||||
|
|
||||||
Questions or comments about this TC Open Repository's activities
|
Questions or comments about this TC Open Repository's activities should be
|
||||||
should be
|
composed as GitHub issues or comments. If use of an issue/comment is not
|
||||||
composed as GitHub issues or comments. If use of an issue/comment is
|
|
||||||
not
|
|
||||||
possible or appropriate, questions may be directed by email to the
|
possible or appropriate, questions may be directed by email to the
|
||||||
Maintainer(s) `listed above <#currentmaintainers>`__. Please send
|
Maintainer(s) `listed above <#currentmaintainers>`__. Please send general
|
||||||
general questions about TC Open Repository participation to OASIS
|
questions about TC Open Repository participation to OASIS Staff at
|
||||||
Staff at
|
|
||||||
repository-admin@oasis-open.org and any specific CLA-related questions
|
repository-admin@oasis-open.org and any specific CLA-related questions
|
||||||
to repository-cla@oasis-open.org.
|
to repository-cla@oasis-open.org.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue