Skip to main content

Produce and consume STIX 2 JSON content

Project description

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+.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

misp-lib-stix2-3.0.1.1.tar.gz (328.6 kB view details)

Uploaded Source

Built Distribution

misp_lib_stix2-3.0.1.1-py3-none-any.whl (436.2 kB view details)

Uploaded Python 3

File details

Details for the file misp-lib-stix2-3.0.1.1.tar.gz.

File metadata

  • Download URL: misp-lib-stix2-3.0.1.1.tar.gz
  • Upload date:
  • Size: 328.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.4 Linux/5.15.0-46-generic

File hashes

Hashes for misp-lib-stix2-3.0.1.1.tar.gz
Algorithm Hash digest
SHA256 e4575765b484cab81a24a1fc17d73aad810a7b0b0b7855c27236223c7a454af2
MD5 688763912b1d3882a2c0ec64a321697b
BLAKE2b-256 6c07a5a34f61f83694f21a6598491e1c1e7d1e2e19c95fd45e757a975f6ee601

See more details on using hashes here.

File details

Details for the file misp_lib_stix2-3.0.1.1-py3-none-any.whl.

File metadata

  • Download URL: misp_lib_stix2-3.0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 436.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.4 Linux/5.15.0-46-generic

File hashes

Hashes for misp_lib_stix2-3.0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e28ce8ffdd374caa32980278e5ddff0d5e5e05eeaac4182ec634e803ac705c0d
MD5 7ed80449b7ae09cb04ad4dab95af517f
BLAKE2b-256 577f1dfa32faa66f4f12d3696043257d646708bdaa21616919adb5af2ef6b18b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page