Skip to content

Latest commit

 

History

History
155 lines (113 loc) · 6.7 KB

README.rst

File metadata and controls

155 lines (113 loc) · 6.7 KB
Raw

Build Status Coverage Version Downloads

cti-python-stix2

This is the MISP core team STIX2 library forked from the OASIS TC Open Repository.

This repository provides Python APIs for serializing and de-serializing STIX2 JSON content, along with higher-level APIs for common tasks, including data markings, versioning, and for resolving STIX IDs across multiple data sources.

For more information, see the documentation on ReadTheDocs.

Installation

Install with pip:

$ pip install misp-lib-stix2

Note: The library requires Python 3.7+.

PyPI module: misp-lib-stix2.

Usage

To create a STIX object, provide keyword arguments to the type's constructor. Certain required attributes of all objects, such as type or id, will be set automatically if not provided as keyword arguments.

from stix2 import Indicator

indicator = Indicator(name="File hash for malware variant",
                      indicator_types=["malicious-activity"],
                      pattern_type="stix",
                      pattern="[file:hashes.md5 = 'd41d8cd98f00b204e9800998ecf8427e']")

To parse a STIX JSON string into a Python STIX object, use parse(). To serialize a STIX object, use serialize():

from stix2 import parse

indicator = parse("""{
    "type": "indicator",
    "spec_version": "2.1",
    "id": "indicator--dbcbd659-c927-4f9a-994f-0a2632274394",
    "created": "2017-09-26T23:33:39.829Z",
    "modified": "2017-09-26T23:33:39.829Z",
    "name": "File hash for malware variant",
    "indicator_types": [
        "malicious-activity"
    ],
    "pattern_type": "stix",
    "pattern_version": "2.1",
    "pattern": "[file:hashes.md5 ='d41d8cd98f00b204e9800998ecf8427e']",
    "valid_from": "2017-09-26T23:33:39.829952Z"
}""")

print(indicator.serialize(pretty=True))

For more in-depth documentation, please see https://stix2.readthedocs.io/.

STIX 2 Technical Specification Support

This version of cti-python-stix2 brings support to STIX Version 2.1 published on 10 June 2021 currently at the Committee Specification (CS) 03 level, also know as the "OASIS Standard".

The stix2 Python library supports multiple versions of the STIX 2 Technical Specification. The library will be updated to support new Committee Specification Drafts (CSDs) as they are released, but modules for these versions must be imported manually until the CSD reaches CS level. In new major releases of stix2 the import stix2 implicit import statement will be updated to automatically load the STIX Objects equivalent to the most recently supported CS. Please see the library documentation for details.

Contributing

This is the MISP core team STIX2 library forked from the OASIS TC Open Repository.

The contributing rules of this repository is the MISP standard rules bound to the Developer Certificate of Origin.

If you want to contribute, no need to sign a CLA.

Maintainers

TC Open Repository Maintainers are responsible for oversight of this project's community development activities, including evaluation of GitHub pull requests and preserving 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 persons to serve as Maintainer(s); subsequently, participating community members may select additional or substitute Maintainers, per consensus agreements.

Current Maintainers of this TC Open Repository

About OASIS TC Open Repositories

Feedback

Questions or comments about this TC Open Repository's activities should be 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 Maintainer(s) listed above. Please send general questions about TC Open Repository participation to OASIS Staff at [email protected] and any specific CLA-related questions to [email protected].