Version: 1.2.0.0

python-stix 1.2.0.0 Documentation¶

The python-stix library provides an API for developing and consuming Structured Threat Information eXpression (STIX) content. Developers can leverage the API to develop applications that create, consume, translate, or otherwise process STIX content. This page should help new developers get started with using this library. For more information about STIX, please refer to the STIX website.

Note

These docs provide standard reference for this Python library. For documentation on idiomatic usage and common patterns, as well as various STIX-related information and utilities, please visit the STIXProject at GitHub.

Versions¶

Each version of python-stix is designed to work with a single version of the STIX Language. The table below shows the latest version the library for each version of STIX.

STIX Version	python-stix Version
1.2	1.2.0.0 (PyPI) (GitHub)
1.1.1	1.1.1.5 (PyPI) (GitHub)
1.1.0	1.1.0.6 (PyPI) (GitHub)
1.0.1	1.0.1.1 (PyPI) (GitHub)
1.0	1.0.0a7 (PyPI) (GitHub)

Users and developers working with multiple versions of STIX content may want to take a look at stix-ramrod, which is a library designed to update STIX and CybOX content.

Check out the Working with python-stix section for examples on how to integrate stix-ramrod and python-stix.

Contents¶

Version: 1.2.0.0

Installation¶

The installation of python-stix can be accomplished through a few different workflows.

Recommended Installation¶

Use pypi and pip:

$ pip install stix

You might also want to consider using a virtualenv. Please refer to the pip installation instructions for details regarding the installation of pip.

Dependencies¶

The python-stix library relies on some non-standard Python libraries for the processing of STIX content. Revisions of python-stix may depend on particular versions of dependencies to function correctly. These versions are detailed within the distutils setup.py installation script.

The following libraries are required to use python-stix:

lxml - A Pythonic binding for the C libraries libxml2 and libxslt.
python-cybox - A library for consuming and producing CybOX content.
python-dateutil - A library for parsing datetime information.

Each of these can be installed with pip or by manually downloading packages from PyPI. On Windows, you will probably have the most luck using pre-compiled binaries for lxml. On Ubuntu (12.04 or 14.04), you should make sure the following packages are installed before attempting to compile lxml from source:

libxml2-dev
libxslt1-dev
zlib1g-dev

Warning

Users have encountered errors with versions of libxml2 (a dependency of lxml) prior to version 2.9.1. The default version of libxml2 provided on Ubuntu 12.04 is currently 2.7.8. Users are encouraged to upgrade libxml2 manually if they have any issues. Ubuntu 14.04 provides libxml2 version 2.9.1.

Manual Installation¶

If you are unable to use pip, you can also install python-stix with setuptools. If you don’t already have setuptools installed, please install it before continuing.

Download and install the dependencies above. Although setuptools will generally install dependencies automatically, installing the dependencies manually beforehand helps distinguish errors in dependency installation from errors in stix installation. Make sure you check to ensure the versions you install are compatible with the version of stix you plan to install.
Download the desired version of stix from PyPI or the GitHub releases page. The steps below assume you are using the 1.2.0.0 release.
Extract the downloaded file. This will leave you with a directory named stix-1.2.0.0.

$ tar -zxf stix-1.2.0.0.tar.gz
$ ls
stix-1.2.0.0 stix-1.2.0.0.tar.gz

OR

$ unzip stix-1.2.0.0.zip
$ ls
stix-1.2.0.0 stix-1.2.0.0.zip

Run the installation script.

$ cd stix-1.2.0.0
$ python setup.py install

Test the installation.

$ python
Python 2.7.6 (default, Mar 22 2014, 22:59:56)
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import stix
>>>

If you don’t see an ImportError, the installation was successful.

Further Information¶

If you’re new to installing Python packages, you can learn more at the Python Packaging User Guide, specifically the Installing Python Packages section.

Version: 1.2.0.0

Getting Started¶

This page gives an introduction to python-stix and how to use it.

Note

This page is being actively worked on; feedback is always welcome.

Prerequisites¶

The python-stix library provides an API for creating or processing STIX content. As such, it is a developer tool that can be leveraged by those who know Python 2.6/2.7 and are familiar with object-oriented programming practices, Python package layouts, and are comfortable with the installation of Python libraries. To contribute code to the python-stix repository, users must be familiar with git and GitHub pull request methodologies. Understanding XML, XML Schema, and the STIX language is also incredibly helpful when using python-stix in an application.

Your First STIX Application¶

Once you have installed python-stix, you can begin writing Python applications that consume or create STIX content!

Note

The python-stix library provides bindings and APIs, both of which can be used to parse and write STIX XML files. For in-depth description of the APIs, bindings, and the differences between the two, please refer to APIs or bindings?

Creating a STIX Package¶

from stix.core import STIXPackage, STIXHeader   # Import the STIX Package and STIX Header APIs

stix_package = STIXPackage()                    # Create an instance of STIXPackage
stix_header = STIXHeader()                      # Create an instance of STIXHeader
stix_header.description = "Getting Started!"    # Set the description
stix_package.stix_header = stix_header          # Link the STIX Head to our STIX Package

print(stix_package.to_xml())                    # print the XML for this STIX Package

Parsing STIX XML¶

from stix.core import STIXPackage        # Import the STIX Package API

fn = 'stix_content.xml'                  # The STIX content filename
stix_package = STIXPackage.from_xml(fn)  # Parse using the from_xml() method

Examples¶

The python-stix GitHub repository contains several example scripts that help illustrate the capabilities of the APIs. These examples can be found here. Accompanying walkthrough slides are available. These scripts are simple command line utilities that can be executed by passing the name of the script to a Python interpreter.

Example:
$ python ex_01.py

Note

You must install python-stix before running these example scripts.

Version: 1.2.0.0

Overview¶

This page provides a quick overview needed to understand the inner workings of the python-stix library. If you prefer a more hands-on approach, browse the Examples.

Version: 1.2.0.0

ID Namespaces¶

By default, python-stix sets the default ID namespace to http://example.com with an alias of example. This results in STIX id declarations that look like id="example:Package-2813128d-f45e-41f7-b10a-20a5656e3785".

To change this, use the stix.utils.idgen.set_id_namespace() method which takes a dictionary as a parameter.

from stix.core import STIXPackage
from stix.utils import set_id_namespace

NAMESPACE = {"http://MY-NAMESPACE.com" : "myNS"}
set_id_namespace(NAMESPACE) # new ids will be prefixed by "myNS"

stix_package = STIXPackage() # id will be created automatically
print stix_package.to_xml()

Which outputs:

<stix:STIX_Package
    xmlns:myNS="http://MY-NAMESPACE.com"
    xmlns:stixCommon="http://stix.mitre.org/common-1"
    xmlns:stixVocabs="http://stix.mitre.org/default_vocabularies-1"
    xmlns:stix="http://stix.mitre.org/stix-1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    id="myNS:Package-b2039368-9476-4a5b-8c1d-0ef5d1b37e06" version="1.2"/>

Success! The xmlns:myNS="http://MY-NAMESPACE.com" matches our NAMESPACE dictionary and the id attribute includes the myNS namespace alias.

Working With CybOX¶

When setting the ID namespace in python-stix, the ID namespace will also be set in python-cybox.

Version: 1.2.0.0

Controlled Vocabularies¶

Many fields in STIX leverage the stixCommon:ControlledVocabularyStringType, which acts as a base type for controlled vocabulary implementations. The STIX language defines a set of default controlled vocabularies which are found in the stix_default_vocabs.xsd XML Schema file.

The python-stix library contains a stix.common.vocabs module, which defines the VocabString class implementation of the schema ControlledVocabularyStringType as well as VocabString implementations which correspond to default controlled vocabularies.

For example, the stix_default_vocabularies.xsd schema defines a controlled vocabulary for STIX Package Intents: PackageIntentVocab-1.0. The stix.common.vocabs module contains an analogous PackageIntent class, which acts as a derivation of VocabString.

Each VocabString implementation contains:

A static list of class-level term attributes, each beginning with TERM_` (e.g., ``TERM_INDICATORS)
A tuple containing all allowed vocabulary terms: _ALLOWED_VALUES, which is use for input validation. This is generated via the vocabs.register_vocab() class decorator.
Methods found on stix.Entity, such as to_xml(), to_dict(), from_dict(), etc.

Interacting With VocabString Fields¶

The following sections define ways of interacting with VocabString fields.

Default Vocabulary Terms¶

The STIX Language often suggested a default controlled vocabulary type for a given controlled vocabulary field. Each controlled vocabulary contains an enumeration of allowed terms.

Each VocabString implementation found in the stix.common.vocabs module contains static class-level attributes for each vocabulary term. When setting controlled vocabulary field values, it is recommended that users take advantage of these class-level attributes.

The following demonstrates setting the Package_Intent field with a default vocabulary term. Note that the STIXHeader.package_intents property returns a list. As such, we use the append() method to add terms. Other STIX controlled vocabulary fields may only allow one value rather than a list of values.

from stix.core import STIXHeader
from stix.common.vocabs import PackageIntent

header = STIXHeader()
header.package_intents.append(PackageIntent.TERM_INDICATORS)

print header.to_xml()

Which outputs:

<stix:STIXHeaderType>
    <stix:Package_Intent xsi:type="stixVocabs:PackageIntentVocab-1.0">Indicators</stix:Package_Intent>
</stix:STIXHeaderType>

Non-Default Vocabulary Terms¶

Though it is suggested, STIX content authors are not required to use the default controlled vocabulary for a given field. As such, python-stix allows users to pass in non-default values for controlled vocabulary fields.

To set a controlled vocabulary to a non-default vocabulary term, pass a VocabString instance into a controlled vocabulary field.

A raw VocabString field will contain no xsi:type information or _ALLOWED_VALUES members, which removes the input and schema validation requirements.

from stix.core import STIXHeader
from stix.common.vocabs import VocabString, PackageIntent

header = STIXHeader()
non_default_term = VocabString("NON-DEFAULT VOCABULARY TERM")
header.package_intents.append(non_default_term)

print header.to_xml()

Which outputs:

<stix:STIXHeaderType>
    <stix:Package_Intent>NON-DEFAULT VOCABULARY TERM</stix:Package_Intent>
</stix:STIXHeaderType>

Notice that the <stix:Package_Intent> field does not have an xsi:type attribute. As such, this field can contain any string value and is not bound by a controlled vocabulary enumeration of terms.

Working With Custom Controlled Vocabularies¶

STIX allows content authors and developers to extend the ControlledVocabularyStringType schema type for the definition of new controlled vocabularies. The python-stix library allows developers to create and register Python types which mirror the custom XML Schema vocabulary types.

XSD Example¶

The following XML Schema example shows the definition of a a new custom controlled vocabulary schema type. Instances of this schema type could be used wherever a ControlledVocabularyStringType instance is expected (e.g., the STIX_Header/Package_Intent field).

Filename: customVocabs.xsd

<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:customVocabs="http://customvocabs.com/vocabs-1"
    xmlns:stixVocabs="http://stix.mitre.org/default_vocabularies-1"
    xmlns:stixCommon="http://stix.mitre.org/common-1"
    targetNamespace="http://customvocabs.com/vocabs-1"
    elementFormDefault="qualified"
    version="1.2"
    xml:lang="English">
    <xs:import namespace="http://stix.mitre.org/common-1" schemaLocation="http://stix.mitre.org/XMLSchema/common/1.2/stix_common.xsd"/>
    <xs:complexType name="CustomVocab-1.0">
        <xs:simpleContent>
            <xs:restriction base="stixCommon:ControlledVocabularyStringType">
                <xs:simpleType>
                    <xs:union memberTypes="customVocabs:CustomEnum-1.0"/>
                </xs:simpleType>
                <xs:attribute name="vocab_name" type="xs:string" use="optional" fixed="Test Vocab"/>
                <xs:attribute name="vocab_reference" type="xs:anyURI" use="optional" fixed="http://example.com/TestVocab"/>
            </xs:restriction>
        </xs:simpleContent>
    </xs:complexType>
    <xs:simpleType name="CustomEnum-1.0">
        <xs:restriction base="xs:string">
            <xs:enumeration value="FOO"/>
            <xs:enumeration value="BAR"/>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

XML Instance Sample¶

The following STIX XML instance document shows a potential use of this field. Note the xsi:type=customVocabs:CustomVocab-1.0 on the Package_Intent field.

Filename: customVocabs.xml

<stix:STIX_Package
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:stixExample="http://stix.mitre.org/example"
    xmlns:stix="http://stix.mitre.org/stix-1"
    xmlns:customVocabs="http://customvocabs.com/vocabs-1"
    xsi:schemaLocation="
    http://stix.mitre.org/stix-1 /path/to/stix_core.xsd
    http://customvocabs.com/vocabs-1 /path/to/customVocabs.xsd"
    id="stixExample:STIXPackage-33fe3b22-0201-47cf-85d0-97c02164528d"
    version="1.2">
    <stix:STIX_Header>
        <stix:Package_Intent xsi:type="customVocabs:CustomVocab-1.0">FOO</stix:Package_Intent>
    </stix:STIX_Header>
</stix:STIX_Package>

Python Code¶

To parse content which uses custom controlled vocabularies, Python developers don’t have to do anything special–you just call STIXPackage.from_xml() on the input and all the namespaces, xsi:types, etc. are attached to each instance of VocabString. When serializing the document, the input namespaces and xsi:type attributes are retained!

However, to create new content which utilizes a schema defined and enforced custom controlled vocabulary, developers must create a VocabString implementation which mirrors the schema definition.

For our CustomVocab-1.0 schema type, the Python would look like this:

from stix.common import vocabs

# Create a custom vocabulary type
@vocabs.register_vocab
class CustomVocab(vocabs.VocabString):
    _namespace = 'http://customvocabs.com/vocabs-1'
    _XSI_TYPE = 'customVocabs:CustomVocab-1.0'

    # Valid terms
    TERM_FOO = 'FOO'
    TERM_BAR = 'BAR'

As you can see, we can express a lot of the same information found in the XML Schema definition, but in Python!

_namespace: The targetNamespace for our custom vocabulary
_XSI_TYPE: The xsi:type attribute value to write out for instances of this vocabulary.
TERM_FOO|BAR: Allowable terms for the vocabulary. These terms are collected for input validation.

Note

The @register_vocab class decorator registers the class and its xsi:type as a VocabString implementation so python-stix will know to build instances of CustomVocab when parsed content contains CustomVocab-1.0 content.

This also inspects the class attributes for any that begin with TERM_ and collects their values for the purpose of input validation.

Warning

Before python-stix 1.2.0.0, users registered custom VocabString implementations via the stix.common.vocabs.add_vocab() method. This method still exists but is considered DEPRECATED in favor of the stix.common.vocabs.register_vocab() class decorator.

# builtin
from StringIO import StringIO

# python-stix modules
from stix.core import STIXPackage
from stix.common.vocabs import VocabString, register_vocab

XML = \
"""
<stix:STIX_Package
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:stix="http://stix.mitre.org/stix-1"
    xmlns:customVocabs="http://customvocabs.com/vocabs-1"
    xmlns:example="http://example.com/"
    xsi:schemaLocation="
    http://stix.mitre.org/stix-1 /path/to/stix_core.xsd
    http://customvocabs.com/vocabs-1 /path/to/customVocabs.xsd"
    id="example:STIXPackage-33fe3b22-0201-47cf-85d0-97c02164528d"
    version="1.2">
    <stix:STIX_Header>
        <stix:Package_Intent xsi:type="customVocabs:CustomVocab-1.0">FOO</stix:Package_Intent>
    </stix:STIX_Header>
</stix:STIX_Package>
"""

# Create a VocabString class for our CustomVocab-1.0 vocabulary which
@register_vocab
class CustomVocab(VocabString):
    _namespace = 'http://customvocabs.com/vocabs-1'
    _XSI_TYPE  = 'customVocabs:CustomVocab-1.0'
    TERM_FOO   = 'FOO'
    TERM_BAR   = 'BAR'

# Parse the input document
sio = StringIO(XML)
package = STIXPackage.from_xml(sio)

# Retrieve the first (and only) Package_Intent entry
package_intent = package.stix_header.package_intents[0]

# Print information about the input Package_Intent
print type(package_intent), package_intent.xsi_type, package_intent

# Add another Package Intent
bar = CustomVocab('BAR')
package.stix_header.add_package_intent(bar)

# This will include the 'BAR' CustomVocab entry
print package.to_xml()

Version: 1.2.0.0

Examples¶

This page includes some basic examples of creating and parsing STIX content.

There are a couple things we do in these examples for purposes of demonstration that shouldn’t be done in production code:

In some examples, we use set_id_method(IDGenerator.METHOD_INT) to make IDs for STIX constructs easier to read and cross-reference within the XML document. In production code, you should omit this statement, which causes random UUIDs to be created instead, or create explicit IDs yourself for STIX constructs.

See the STIX Idioms documentation for more great examples of how to use python-stix.

Creating a STIX Package¶

from stix.core import STIXPackage, STIXHeader
from stix.utils import IDGenerator, set_id_method

set_id_method(IDGenerator.METHOD_INT) # For testing and demonstration only!

stix_package = STIXPackage()
stix_header = STIXHeader()
stix_header.description = "Getting Started!"
stix_package.stix_header = stix_header

print stix_package.to_xml()

Which outputs:

<stix:STIX_Package id="example:Package-1" version="1.2">
    <stix:STIX_Header>
        <stix:Description>Getting Started!</stix:Description>
    </stix:STIX_Header>
</stix:STIX_Package>

Controlled Vocabularies: VocabString¶

This section has moved! Head over to Controlled Vocabularies for the documentation.

ID Namespaces¶

This section has moved! Head over to ID Namespaces for the documentation.

Version: 1.2.0.0

APIs or bindings?¶

This page describes both the APIs and the bindings provided by the python-stix library.

Overview¶

The python-stix library provides APIs and utilities that aid in the creation, consumption, and processing of Structured Threat Information eXpression (STIX) content. The APIs that drive much of the functionality of python-stix sit on top of a binding layer that acts as a direct connection between Python and the STIX XML. Because both the APIs and the bindings allow for the creation and development of STIX content, developers that are new to python-stix may not understand the differences between the two. This document aims to identify the purpose and uses of the APIs and bindings.

Bindings¶

The python-stix library leverages machine generated XML-to-Python bindings for the creation and processing of STIX content. These bindings are created using the generateDS utility and can be found under stix.bindings within the package hierarchy.

The STIX bindings allow for a direct, complete mapping between Python classes and STIX XML Schema data structures. That being said, it is possible (though not advised) to use only the STIX bindings to create STIX documents. However, because the code is generated from XML Schema without contextual knowledge of relationships or broader organizational/developmental schemes, it is often a cumbersome and laborious task to create even the simplest of STIX documents.

Developers within the python-stix team felt that the binding code did not lend itself to rapid development or natural navigation of data, and so it was decided that a higher-level API should be created.

APIs¶

The python-stix APIs are classes and utilities that leverage the STIX bindings for the creation and processing of STIX content. The APIs are designed to behave more naturally when working with STIX content, allowing developers to conceptualize and interact with STIX documents as pure Python objects and not XML Schema objects.

The APIs provide validation of inputs, multiple input and output formats, more Pythonic access of data structure internals and interaction with classes, and better interpretation of a developers intent through datatype coercion and implicit instantiation.

Note

The python-stix APIs are under constant development. Our goal is to provide full API coverage of the STIX data structures, but not all structures are exposed via the APIs yet. Please refer to the API Reference for API coverage details.

Brevity Wins¶

The two code examples show the difference in creating and printing a simple STIX document consisting of only a STIX Package and a STIX Header with a description and produced time using the python-stix and python-cybox bindings. Both examples will produce the same STIX XML!

API Example

from datetime import datetime
from stix.core import STIXPackage, STIXHeader
from stix.common import InformationSource
from cybox.common import Time

# Create the STIX Package and STIX Header objects
stix_package = STIXPackage()
stix_header = STIXHeader()

# Set the description
stix_header.description = 'APIs vs. Bindings Wiki Example'

# Set the produced time to now
stix_header.information_source = InformationSource()
stix_header.information_source.time = Time()
stix_header.information_source.time.produced_time = datetime.now()

# Build document
stix_package.stix_header = stix_header

# Print the document to stdout
print(stix_package.to_xml())

Binding Example

import sys
from datetime import datetime

import stix.bindings.stix_core as stix_core_binding
import stix.bindings.stix_common as stix_common_binding
import cybox.bindings.cybox_common as cybox_common_binding

# Create the STIX Package and STIX Header objects
stix_package = stix_core_binding.STIXType()
stix_header = stix_core_binding.STIXHeaderType()

# Set the description
stix_header_description = stix_common_binding.StructuredTextType()
stix_header_description.set_valueOf_('APIs vs. Bindings Wiki Example')

# Set the produced time to now
stix_header_time = cybox_common_binding.TimeType()
stix_header_time.set_Produced_Time(datetime.now())

# Bind the time to the STIX Header's Information Source element
stix_header_info_source = stix_common_binding.InformationSourceType()
stix_header_info_source.set_Time(stix_header_time)

# Build the document
stix_header.set_Description(stix_header_description)
stix_header.set_Information_Source(stix_header_info_source)
stix_package.set_STIX_Header(stix_header)

# Print the document to stdout
stix_package.export(sys.stdout, 0, stix_core_binding.DEFAULT_XML_NS_MAP)

Feedback¶

If there is a problem with the APIs or bindings, or if there is functionality missing from the APIs that forces the use of the bindings, let us know in the python-stix issue tracker

API Reference¶

Version: 1.2.0.0

API Reference¶

The python-stix APIs are the recommended tools for reading, writing, and manipulating STIX XML documents.

Note

The python-stix APIs are currently under development. As such, API coverage of STIX data constructs is incomplete; please bear with us as we work toward complete coverage. This documentation also serves to outline current API coverage.

STIX¶

Modules located in the base stix package

Version: 1.2.0.0

`stix.base` Module¶

Classes¶

class stix.base.Entity¶

Base class for all classes in the STIX API.

classmethod dict_from_object(entity_obj)¶: Convert from object representation to dict representation.

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

classmethod from_dict(d, return_obj=None)¶: Convert from dict representation to object representation. This should be overriden by a subclass

classmethod from_json(json_doc)¶

Parses the JSON document json_doc and returns a STIX Entity implementation instance.

Parameters:	json_doc – Input JSON representation of a STIX entity. This can be a readable object or a JSON string.
Returns:	An implementation of – class:.Entity (e.g., `STIXPackage`).

classmethod from_obj(obj, return_obj=None)¶: Create an object from a binding object

classmethod object_from_dict(entity_dict)¶: Convert from dict representation to object representation.

to_dict()¶: Converts a STIX Entity implementation into a Python dictionary. This may be overridden by derived classes.

to_obj(return_obj=None, ns_info=None)¶: Converts an Entity into a binding object.

Note

This needs to be overridden by derived classes.

to_xml(include_namespaces=True, include_schemalocs=False, ns_dict=None, schemaloc_dict=None, pretty=True, auto_namespace=True, encoding='utf-8')¶

Serializes a Entity instance to an XML string.

The default character encoding is utf-8 and can be set via the encoding parameter. If encoding is None, a unicode string is returned.

Parameters:

auto_namespace – Automatically discover and export XML namespaces for a STIX Entity instance.
include_namespaces – Export namespace definitions in the output XML. Default is True.
include_schemalocs – Export xsi:schemaLocation attribute in the output document. This will attempt to associate namespaces declared in the STIX document with schema locations. If a namespace cannot be resolved to a schemaLocation, a Python warning will be raised. Schemalocations will only be exported if include_namespaces is also True.
ns_dict – Dictionary of XML definitions (namespace is key, alias is value) to include in the exported document. This must be passed in if auto_namespace is False.
schemaloc_dict – Dictionary of XML namespace: schema location mappings to include in the exported document. These will only be included if auto_namespace is False.
pretty – Pretty-print the XML.
encoding – The output character encoding. Default is utf-8. If encoding is set to None, a unicode string is returned.

Returns:

An XML string for this Entity instance. Default character encoding is utf-8.

class stix.base.EntityList(*args)¶: Bases: _abcoll.MutableSequence, stix.base.Entity

Version: 1.2.0.0

`stix.data_marking` Module¶

Classes¶

class stix.data_marking.Marking(markings=None)¶: Bases: stix.base.Entity

class stix.data_marking.MarkingSpecification(controlled_structure=None, marking_structures=None)¶: Bases: stix.base.Entity

class stix.data_marking.MarkingStructure¶: Bases: stix.base.Entity

Functions¶

stix.data_marking.add_extension(cls)¶

Registers a stix.Entity class as an implementation of an xml type.

Classes must have an _XSI_TYPE class attributes to be registered. The value of this attribute must be a valid xsi:type.

Note

This was designed for internal use.

STIX Campaign¶

Modules located in the stix.campaign package

Version: 1.2.0.0

`stix.campaign` Module¶

Overview¶

The stix.campaign module implements Campaign.

Campaigns are instances of ThreatActors pursuing an intent, as observed through sets of Incidents and/or TTP, potentially across organizations.

Documentation Resources¶

Campaign Data Model

Classes¶

class stix.campaign.Campaign(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of the STIX Campaign.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description – A description of the purpose or intent of this object.
short_description – A short description of the intent or purpose of this object.
title – The title of this object.

activity¶: A collection of Activity objects. This behaves like a MutableSequence type.

add_activity(value)¶: Adds an Activity object to the activity collection.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

attribution¶: A collection of Attribution objects. This behaves like a MutableSequence type.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

intended_effects¶: A collection of Statement objects. This behaves like a MutableSequence type.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

status¶

The status of the Campaign. This is a VocabString field.

If set to a string, an attempt will be made to convert it to a CampaignStatus object.

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

class stix.campaign.AssociatedCampaigns(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.campaign.Attribution(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.campaign.Names(*args)¶: Bases: stix.base.EntityList

class stix.campaign.RelatedIncidents(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.campaign.RelatedIndicators(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.campaign.RelatedTTPs(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

STIX Common¶

Modules located in the stix.common package

Version: 1.2.0.0

`stix.common` Module¶

Classes¶

class stix.common.EncodedCDATA(value=None, encoded=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.common.activity` Module¶

Classes¶

class stix.common.activity.Activity¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

Version: 1.2.0.0

`stix.common.confidence` Module¶

Classes¶

class stix.common.confidence.Confidence(value=None, timestamp=None, description=None, source=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

Version: 1.2.0.0

`stix.common.datetimewithprecision` Module¶

Classes¶

class stix.common.datetimewithprecision.DateTimeWithPrecision(value=None, precision='second')¶: Bases: stix.base.Entity

Constants¶

stix.common.datetimewithprecision.DATE_PRECISION_VALUES = ('year', 'month', 'day')¶

tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable’s items

If the argument is a tuple, the return value is the same object.

stix.common.datetimewithprecision.TIME_PRECISION_VALUES = ('hour', 'minute', 'second')¶

tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable’s items

If the argument is a tuple, the return value is the same object.

stix.common.datetimewithprecision.DATETIME_PRECISION_VALUES = ('year', 'month', 'day', 'hour', 'minute', 'second')¶

tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable’s items

If the argument is a tuple, the return value is the same object.

Version: 1.2.0.0

`stix.common.identity` Module¶

Classes¶

class stix.common.identity.Identity(id_=None, idref=None, name=None, related_identities=None)¶: Bases: stix.base.Entity

class stix.common.identity.RelatedIdentities(*args)¶: Bases: stix.base.EntityList

Functions¶

stix.common.identity.add_extension(cls)¶

Registers a stix.Entity class as an implementation of an xml type.

Classes must have an _XSI_TYPE class attributes to be registered. The value of this attribute must be a valid xsi:type.

Note

This was designed for internal use.

Version: 1.2.0.0

`stix.common.information_source` Module¶

Classes¶

class stix.common.information_source.InformationSource(description=None, identity=None, time=None, tools=None, contributing_sources=None, references=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

class stix.common.information_source.ContributingSources(*args)¶: Bases: stix.base.EntityList

Version: 1.2.0.0

`stix.common.kill_chains` Module¶

Classes¶

class stix.common.kill_chains.KillChain(id_=None, name=None, definer=None, reference=None)¶: Bases: stix.base.Entity

class stix.common.kill_chains.KillChains(*args)¶: Bases: stix.base.EntityList

class stix.common.kill_chains.KillChainPhase(phase_id=None, name=None, ordinality=None)¶: Bases: stix.base.Entity

class stix.common.kill_chains.KillChainPhaseReference(phase_id=None, name=None, ordinality=None, kill_chain_id=None, kill_chain_name=None)¶: Bases: stix.common.kill_chains.KillChainPhase

class stix.common.kill_chains.KillChainPhasesReference(*args)¶: Bases: stix.base.EntityList

Lockheed Martin Kill Chain¶

There is a shortcuts for adding kill chain phases from the Lockheed Martin Cyber Kill Chain to indicators:

from stix.common.kill_chains.lmco import PHASE_RECONNAISSANCE
from stix.indicator import Indicator
i = Indicator()
i.add_kill_chain_phase(PHASE_RECONNAISSANCE)
print i.to_xml(include_namespaces=False)

<indicator:Indicator id="example:indicator-2bb1c0ea-7dd8-40fb-af64-7199f00719c1"
        timestamp="2015-03-17T19:14:22.797675+00:00" xsi:type='indicator:IndicatorType'>
    <indicator:Kill_Chain_Phases>
        <stixCommon:Kill_Chain_Phase phase_id="stix:TTP-af1016d6-a744-4ed7-ac91-00fe2272185a"/>
    </indicator:Kill_Chain_Phases>
</indicator:Indicator>

Version: 1.2.0.0

`stix.common.related` Module¶

Classes¶

class stix.common.related.GenericRelationship(confidence=None, information_source=None, relationship=None)¶: Bases: stix.base.Entity

class stix.common.related.GenericRelationshipList(scope=None, *args)¶: Bases: stix.base.EntityList

class stix.common.related.RelatedPackageRef(idref=None, timestamp=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related.GenericRelationship

class stix.common.related.RelatedPackageRefs(*args)¶: Bases: stix.base.EntityList

class stix.common.related._BaseRelated(item=None, confidence=None, information_source=None, relationship=None)¶

Bases: stix.common.related.GenericRelationship

A base class for related types.

This class is not a real STIX type and should not be directly instantiated.

class stix.common.related.RelatedCampaign(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedCOA(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedExploitTarget(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedIdentity(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedIncident(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedIndicator(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedObservable(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedThreatActor(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedTTP(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

class stix.common.related.RelatedReports(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.common.related.RelatedReport(item=None, confidence=None, information_source=None, relationship=None)¶: Bases: stix.common.related._BaseRelated

Version: 1.2.0.0

`stix.common.statement` Module¶

Classes¶

class stix.common.statement.Statement(value=None, timestamp=None, description=None, source=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

Version: 1.2.0.0

`stix.common.structured_text` Module¶

Classes¶

class stix.common.structured_text.StructuredText(value=None, ordinality=None)¶

Bases: stix.base.Entity

Used for storing descriptive text elements.

id_¶: An id for the text element, typically used for controlled structure xpath selectors.

value¶: The text value of this object.

structuring_format¶: The format of the text. For example, html5.

__str__()¶: Returns a UTF-8 encoded string representation of the value.

__unicode__()¶: Returns a unicode string representation of the value.

classmethod from_dict(d, return_obj=None)¶

Creates an object from the input dictionary.

Parameters:	d – A dictionary representation of this object.

classmethod from_obj(obj, return_obj=None)¶

Create an object from the input binding object.

Parameters:	obj – A generateDS binding object.

to_dict()¶: Converts this object into a dictionary representation.

Note

If no properies or attributes are set other than value, this will return a string.

to_obj(return_obj=None, ns_info=None)¶: Converts this object into a binding object.

class stix.common.structured_text.StructuredTextList(*args)¶

Bases: stix.base.TypedCollection, _abcoll.Sequence

A sequence type used to store StructureText objects.

Parameters:	*args – A variable-length argument list which can contain single `StructuredText` objects or sequences of objects.

__delitem__(key)¶

Removes the item with a given ordinality.

Parameters:	key – An ordinality value.
Raises:	`KeyError` – If the key does not match the ordinality for any object in the collection.

__getitem__(key)¶

Returns the StructuredText object with a matching ordinality.

Parameters:	key – An ordinality value.
Raises:	`KeyError` – If key does not match the ordinality of any `StructuredText` object.

__iter__()¶: Returns an iterator for the collection sorted by ordinality.

add(value)¶

Adds the StructuredText value to the collection.

If value is not a StructuredText object, an attempt will be made to convert it to one.

Note

If value does not have an ordinality set, one will be assigned. If value has an ordinality which matches one already in the collection, value will replace the existing item.

Parameters:	value – A `StructuredText` object.

insert(value)¶

Inserts value into the collection.

If value has an ordinality which conflicts with an existing value, the existing value (and any contiguous values) will have their ordinality values incremented by one.

next_ordinality¶: Returns the “+1” of the highest ordinality in the collection.

remove(value)¶: Removes the value from the collection.

reset()¶: Assigns sequential ordinality values to each of the sorted StructuredText objects, starting with 1 and ending at len(self).

sorted¶: Returns a copy of the collection of internal StructuredText objects, sorted by their ordinality.

to_dict()¶

Returns a list of dictionary representations of the contained objects.

An attempt is made to flatten out the returned list when there is only one item in the collection. This is to support backwards compatibility with previous versions of python-stix.

If the list repr has more than one item, return the list.
If there is only one item, inspect it.
- If the item is not a dictionary, return it.
- If its ordinality key has a corresponding value of 1, remove it from the dictionary since it’s assumed if there is only one item.
- After removing ordinality, if the only key left is value, just return the value of value (a string).

to_obj(ns_info=None)¶

Returns a binding object list for the StructuredTextList.

If the list has a length of 1, and its member has an ordinality of 1, the ordinality will be unset.

update(iterable)¶

Adds each item of iterable to the collection.

Note

Any existing objects with conflicting ordinality values will be overwritten.

Parameters:	iterable – An iterable collection of `StructuredText` objects to add to this collection.

Version: 1.2.0.0

`stix.common.tools` Module¶

Classes¶

class stix.common.tools.ToolInformation(title=None, short_description=None, tool_name=None, tool_vendor=None)¶

Bases: stix.base.Entity, cybox.common.tools.ToolInformation

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the short description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Version: 1.2.0.0

`stix.common.vocabs` Module¶

Classes¶

class stix.common.vocabs.AssetType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ACCESS_READER = 'Access reader'¶

TERM_ADMINISTRATOR = 'Administrator'¶

TERM_ATM = 'ATM'¶

TERM_AUDITOR = 'Auditor'¶

TERM_AUTH_TOKEN = 'Auth token'¶

TERM_BACKUP = 'Backup'¶

TERM_BROADBAND = 'Broadband'¶

TERM_CALL_CENTER = 'Call center'¶

TERM_CAMERA = 'Camera'¶

TERM_CASHIER = 'Cashier'¶

TERM_CUSTOMER = 'Customer'¶

TERM_DATABASE = 'Database'¶

TERM_DCS = 'DCS'¶

TERM_DESKTOP = 'Desktop'¶

TERM_DEVELOPER = 'Developer'¶

TERM_DHCP = 'DHCP'¶

TERM_DIRECTORY = 'Directory'¶

TERM_DISK_DRIVE = 'Disk drive'¶

TERM_DISK_MEDIA = 'Disk media'¶

TERM_DNS = 'DNS'¶

TERM_DOCUMENTS = 'Documents'¶

TERM_ENDUSER = 'End-user'¶

TERM_EXECUTIVE = 'Executive'¶

TERM_FILE = 'File'¶

TERM_FINANCE = 'Finance'¶

TERM_FIREWALL = 'Firewall'¶

TERM_FLASH_DRIVE = 'Flash drive'¶

TERM_FORMER_EMPLOYEE = 'Former employee'¶

TERM_GAS_TERMINAL = 'Gas terminal'¶

TERM_GUARD = 'Guard'¶

TERM_HELPDESK = 'Helpdesk'¶

TERM_HSM = 'HSM'¶

TERM_HUMAN_RESOURCES = 'Human resources'¶

TERM_IDS = 'IDS'¶

TERM_KIOSK = 'Kiosk'¶

TERM_LAN = 'LAN'¶

TERM_LAPTOP = 'Laptop'¶

TERM_LOG = 'Log'¶

TERM_MAIL = 'Mail'¶

TERM_MAINFRAME = 'Mainframe'¶

TERM_MAINTENANCE = 'Maintenance'¶

TERM_MANAGER = 'Manager'¶

TERM_MEDIA = 'Media'¶

TERM_MOBILE_PHONE = 'Mobile phone'¶

TERM_NETWORK = 'Network'¶

TERM_PARTNER = 'Partner'¶

TERM_PAYMENT_CARD = 'Payment card'¶

TERM_PAYMENT_SWITCH = 'Payment switch'¶

TERM_PBX = 'PBX'¶

TERM_PED_PAD = 'PED pad'¶

TERM_PERIPHERAL = 'Peripheral'¶

TERM_PERSON = 'Person'¶

TERM_PLC = 'PLC'¶

TERM_POS_CONTROLLER = 'POS controller'¶

TERM_POS_TERMINAL = 'POS terminal'¶

TERM_PRINT = 'Print'¶

TERM_PRIVATE_WAN = 'Private WAN'¶

TERM_PROXY = 'Proxy'¶

TERM_PUBLIC_WAN = 'Public WAN'¶

TERM_REMOTE_ACCESS = 'Remote access'¶

TERM_ROUTER_OR_SWITCH = 'Router or switch'¶

TERM_RTU = 'RTU'¶

TERM_SAN = 'SAN'¶

TERM_SCADA = 'SCADA'¶

TERM_SERVER = 'Server'¶

TERM_SMART_CARD = 'Smart card'¶

TERM_TABLET = 'Tablet'¶

TERM_TAPES = 'Tapes'¶

TERM_TELEPHONE = 'Telephone'¶

TERM_UNKNOWN = 'Unknown'¶

TERM_USER_DEVICE = 'User Device'¶

TERM_VOIP_ADAPTER = 'VoIP adapter'¶

TERM_VOIP_PHONE = 'VoIP phone'¶

TERM_WEB_APPLICATION = 'Web application'¶

TERM_WLAN = 'WLAN'¶

class stix.common.vocabs.AttackerInfrastructureType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ANONYMIZATION = 'Anonymization'¶

TERM_ANONYMIZATION_PROXY = 'Anonymization - Proxy'¶

TERM_ANONYMIZATION_TOR_NETWORK = 'Anonymization - TOR Network'¶

TERM_ANONYMIZATION_VPN = 'Anonymization - VPN'¶

TERM_COMMUNICATIONS = 'Communications'¶

TERM_COMMUNICATIONS_BLOGS = 'Communications - Blogs'¶

TERM_COMMUNICATIONS_FORUMS = 'Communications - Forums'¶

TERM_COMMUNICATIONS_INTERNET_RELAY_CHAT = 'Communications - Internet Relay Chat'¶

TERM_COMMUNICATIONS_MICROBLOGS = 'Communications - Micro-Blogs'¶

TERM_COMMUNICATIONS_MOBILE_COMMUNICATIONS = 'Communications - Mobile Communications'¶

TERM_COMMUNICATIONS_SOCIAL_NETWORKS = 'Communications - Social Networks'¶

TERM_COMMUNICATIONS_USERGENERATED_CONTENT_WEBSITES = 'Communications - User-Generated Content Websites'¶

TERM_DOMAIN_REGISTRATION = 'Domain Registration'¶

TERM_DOMAIN_REGISTRATION_DYNAMIC_DNS_SERVICES = 'Domain Registration - Dynamic DNS Services'¶

TERM_DOMAIN_REGISTRATION_LEGITIMATE_DOMAIN_REGISTRATION_SERVICES = 'Domain Registration - Legitimate Domain Registration Services'¶

TERM_DOMAIN_REGISTRATION_MALICIOUS_DOMAIN_REGISTRARS = 'Domain Registration - Malicious Domain Registrars'¶

TERM_DOMAIN_REGISTRATION_TOPLEVEL_DOMAIN_REGISTRARS = 'Domain Registration - Top-Level Domain Registrars'¶

TERM_ELECTRONIC_PAYMENT_METHODS = 'Electronic Payment Methods'¶

TERM_HOSTING = 'Hosting'¶

TERM_HOSTING_BULLETPROOF_OR_ROGUE_HOSTING = 'Hosting - Bulletproof / Rogue Hosting'¶

TERM_HOSTING_CLOUD_HOSTING = 'Hosting - Cloud Hosting'¶

TERM_HOSTING_COMPROMISED_SERVER = 'Hosting - Compromised Server'¶

TERM_HOSTING_FAST_FLUX_BOTNET_HOSTING = 'Hosting - Fast Flux Botnet Hosting'¶

TERM_HOSTING_LEGITIMATE_HOSTING = 'Hosting - Legitimate Hosting'¶

class stix.common.vocabs.AttackerToolType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_APPLICATION_SCANNER = 'Application Scanner'¶

TERM_MALWARE = 'Malware'¶

TERM_PASSWORD_CRACKING = 'Password Cracking'¶

TERM_PENETRATION_TESTING = 'Penetration Testing'¶

TERM_PORT_SCANNER = 'Port Scanner'¶

TERM_TRAFFIC_SCANNER = 'Traffic Scanner'¶

TERM_VULNERABILITY_SCANNER = 'Vulnerability Scanner'¶

class stix.common.vocabs.AvailabilityLossType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ACCELERATION = 'Acceleration'¶

TERM_DEGREDATION = 'Degredation'¶

TERM_DESTRUCTION = 'Destruction'¶

TERM_INTERRUPTION = 'Interruption'¶

TERM_LOSS = 'Loss'¶

TERM_OBSCURATION = 'Obscuration'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.AvailabilityLossType_1_1_1(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ACCELERATION = 'Acceleration'¶

TERM_DEGRADATION = 'Degradation'¶

TERM_DESTRUCTION = 'Destruction'¶

TERM_INTERRUPTION = 'Interruption'¶

TERM_LOSS = 'Loss'¶

TERM_OBSCURATION = 'Obscuration'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.COAStage_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_REMEDY = 'Remedy'¶

TERM_RESPONSE = 'Response'¶

class stix.common.vocabs.CampaignStatus_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_FUTURE = 'Future'¶

TERM_HISTORIC = 'Historic'¶

TERM_ONGOING = 'Ongoing'¶

class stix.common.vocabs.CourseOfActionType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_DIPLOMATIC_ACTIONS = 'Diplomatic Actions'¶

TERM_ERADICATION = 'Eradication'¶

TERM_HARDENING = 'Hardening'¶

TERM_INTERNAL_BLOCKING = 'Internal Blocking'¶

TERM_LOGICAL_ACCESS_RESTRICTIONS = 'Logical Access Restrictions'¶

TERM_MONITORING = 'Monitoring'¶

TERM_OTHER = 'Other'¶

TERM_PATCHING = 'Patching'¶

TERM_PERIMETER_BLOCKING = 'Perimeter Blocking'¶

TERM_PHYSICAL_ACCESS_RESTRICTIONS = 'Physical Access Restrictions'¶

TERM_POLICY_ACTIONS = 'Policy Actions'¶

TERM_PUBLIC_DISCLOSURE = 'Public Disclosure'¶

TERM_REBUILDING = 'Rebuilding'¶

TERM_REDIRECTION = 'Redirection'¶

TERM_REDIRECTION_HONEY_POT = 'Redirection (Honey Pot)'¶

TERM_TRAINING = 'Training'¶

class stix.common.vocabs.DiscoveryMethod_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_AGENT_DISCLOSURE = 'Agent Disclosure'¶

TERM_ANTIVIRUS = 'Antivirus'¶

TERM_AUDIT = 'Audit'¶

TERM_CUSTOMER = 'Customer'¶

TERM_FINANCIAL_AUDIT = 'Financial Audit'¶

TERM_FRAUD_DETECTION = 'Fraud Detection'¶

TERM_HIPS = 'HIPS'¶

TERM_INCIDENT_RESPONSE = 'Incident Response'¶

TERM_IT_AUDIT = 'IT Audit'¶

TERM_LAW_ENFORCEMENT = 'Law Enforcement'¶

TERM_LOG_REVIEW = 'Log Review'¶

TERM_MONITORING_SERVICE = 'Monitoring Service'¶

TERM_NIDS = 'NIDS'¶

TERM_SECURITY_ALARM = 'Security Alarm'¶

TERM_UNKNOWN = 'Unknown'¶

TERM_UNRELATED_PARTY = 'Unrelated Party'¶

TERM_USER = 'User'¶

class stix.common.vocabs.DiscoveryMethod_2_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_AGENT_DISCLOSURE = 'Agent Disclosure'¶

TERM_ANTIVIRUS = 'Antivirus'¶

TERM_AUDIT = 'Audit'¶

TERM_CUSTOMER = 'Customer'¶

TERM_EXTERNAL_FRAUD_DETECTION = 'External - Fraud Detection'¶

TERM_FINANCIAL_AUDIT = 'Financial Audit'¶

TERM_HIPS = 'HIPS'¶

TERM_INCIDENT_RESPONSE = 'Incident Response'¶

TERM_INTERNAL_FRAUD_DETECTION = 'Internal - Fraud Detection'¶

TERM_IT_AUDIT = 'IT Audit'¶

TERM_LAW_ENFORCEMENT = 'Law Enforcement'¶

TERM_LOG_REVIEW = 'Log Review'¶

TERM_MONITORING_SERVICE = 'Monitoring Service'¶

TERM_NIDS = 'NIDS'¶

TERM_SECURITY_ALARM = 'Security Alarm'¶

TERM_UNKNOWN = 'Unknown'¶

TERM_UNRELATED_PARTY = 'Unrelated Party'¶

TERM_USER = 'User'¶

class stix.common.vocabs.HighMediumLow_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_HIGH = 'High'¶

TERM_LOW = 'Low'¶

TERM_MEDIUM = 'Medium'¶

TERM_NONE = 'None'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.ImpactQualification_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_CATASTROPHIC = 'Catastrophic'¶

TERM_DAMAGING = 'Damaging'¶

TERM_DISTRACTING = 'Distracting'¶

TERM_INSIGNIFICANT = 'Insignificant'¶

TERM_PAINFUL = 'Painful'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.ImpactRating_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_MAJOR = 'Major'¶

TERM_MINOR = 'Minor'¶

TERM_MODERATE = 'Moderate'¶

TERM_NONE = 'None'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.IncidentCategory_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_DENIAL_OF_SERVICE = 'Denial of Service'¶

TERM_EXERCISEORNETWORK_DEFENSE_TESTING = 'Exercise/Network Defense Testing'¶

TERM_IMPROPER_USAGE = 'Improper Usage'¶

TERM_INVESTIGATION = 'Investigation'¶

TERM_MALICIOUS_CODE = 'Malicious Code'¶

TERM_SCANSORPROBESORATTEMPTED_ACCESS = 'Scans/Probes/Attempted Access'¶

TERM_UNAUTHORIZED_ACCESS = 'Unauthorized Access'¶

class stix.common.vocabs.IncidentEffect_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_BRAND_OR_IMAGE_DEGRADATION = 'Brand or Image Degradation'¶

TERM_DATA_BREACH_OR_COMPROMISE = 'Data Breach or Compromise'¶

TERM_DEGRADATION_OF_SERVICE = 'Degradation of Service'¶

TERM_DESTRUCTION = 'Destruction'¶

TERM_DISRUPTION_OF_SERVICE_OR_OPERATIONS = 'Disruption of Service / Operations'¶

TERM_FINANCIAL_LOSS = 'Financial Loss'¶

TERM_LOSS_OF_COMPETITIVE_ADVANTAGE = 'Loss of Competitive Advantage'¶

TERM_LOSS_OF_COMPETITIVE_ADVANTAGE_ECONOMIC = 'Loss of Competitive Advantage - Economic'¶

TERM_LOSS_OF_COMPETITIVE_ADVANTAGE_MILITARY = 'Loss of Competitive Advantage - Military'¶

TERM_LOSS_OF_COMPETITIVE_ADVANTAGE_POLITICAL = 'Loss of Competitive Advantage - Political'¶

TERM_LOSS_OF_CONFIDENTIAL_OR_PROPRIETARY_INFORMATION_OR_INTELLECTUAL_PROPERTY = 'Loss of Confidential / Proprietary Information or Intellectual Property'¶

TERM_REGULATORY_COMPLIANCE_OR_LEGAL_IMPACT = 'Regulatory, Compliance or Legal Impact'¶

TERM_UNINTENDED_ACCESS = 'Unintended Access'¶

TERM_USER_DATA_LOSS = 'User Data Loss'¶

class stix.common.vocabs.IncidentStatus_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_CLOSED = 'Closed'¶

TERM_CONTAINMENT_ACHIEVED = 'Containment Achieved'¶

TERM_DELETED = 'Deleted'¶

TERM_INCIDENT_REPORTED = 'Incident Reported'¶

TERM_NEW = 'New'¶

TERM_OPEN = 'Open'¶

TERM_REJECTED = 'Rejected'¶

TERM_RESTORATION_ACHIEVED = 'Restoration Achieved'¶

TERM_STALLED = 'Stalled'¶

class stix.common.vocabs.IndicatorType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ANONYMIZATION = 'Anonymization'¶

TERM_C2 = 'C2'¶

TERM_DOMAIN_WATCHLIST = 'Domain Watchlist'¶

TERM_EXFILTRATION = 'Exfiltration'¶

TERM_FILE_HASH_WATCHLIST = 'File Hash Watchlist'¶

TERM_HOST_CHARACTERISTICS = 'Host Characteristics'¶

TERM_IP_WATCHLIST = 'IP Watchlist'¶

TERM_MALICIOUS_EMAIL = 'Malicious E-mail'¶

TERM_MALWARE_ARTIFACTS = 'Malware Artifacts'¶

TERM_URL_WATCHLIST = 'URL Watchlist'¶

class stix.common.vocabs.IndicatorType_1_1(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ANONYMIZATION = 'Anonymization'¶

TERM_C2 = 'C2'¶

TERM_COMPROMISED_PKI_CERTIFICATE = 'Compromised PKI Certificate'¶

TERM_DOMAIN_WATCHLIST = 'Domain Watchlist'¶

TERM_EXFILTRATION = 'Exfiltration'¶

TERM_FILE_HASH_WATCHLIST = 'File Hash Watchlist'¶

TERM_HOST_CHARACTERISTICS = 'Host Characteristics'¶

TERM_IMEI_WATCHLIST = 'IMEI Watchlist'¶

TERM_IMSI_WATCHLIST = 'IMSI Watchlist'¶

TERM_IP_WATCHLIST = 'IP Watchlist'¶

TERM_LOGIN_NAME = 'Login Name'¶

TERM_MALICIOUS_EMAIL = 'Malicious E-mail'¶

TERM_MALWARE_ARTIFACTS = 'Malware Artifacts'¶

TERM_URL_WATCHLIST = 'URL Watchlist'¶

class stix.common.vocabs.InformationSourceRole_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_AGGREGATOR = 'Aggregator'¶

TERM_CONTENT_ENHANCERORREFINER = 'Content Enhancer/Refiner'¶

TERM_INITIAL_AUTHOR = 'Initial Author'¶

TERM_TRANSFORMERORTRANSLATOR = 'Transformer/Translator'¶

class stix.common.vocabs.InformationType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_AUTHENTICATION_COOKIES = 'Authentication Cookies'¶

TERM_INFORMATION_ASSETS = 'Information Assets'¶

TERM_INFORMATION_ASSETS_CORPORATE_EMPLOYEE_INFORMATION = 'Information Assets - Corporate Employee Information'¶

TERM_INFORMATION_ASSETS_CUSTOMER_PII = 'Information Assets - Customer PII'¶

TERM_INFORMATION_ASSETS_EMAIL_LISTS_OR_ARCHIVES = 'Information Assets - Email Lists / Archives'¶

TERM_INFORMATION_ASSETS_FINANCIAL_DATA = 'Information Assets - Financial Data'¶

TERM_INFORMATION_ASSETS_INTELLECTUAL_PROPERTY = 'Information Assets - Intellectual Property'¶

TERM_INFORMATION_ASSETS_MOBILE_PHONE_CONTACTS = 'Information Assets - Mobile Phone Contacts'¶

TERM_INFORMATION_ASSETS_USER_CREDENTIALS = 'Information Assets - User Credentials'¶

class stix.common.vocabs.IntendedEffect_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ACCOUNT_TAKEOVER = 'Account Takeover'¶

TERM_ADVANTAGE = 'Advantage'¶

TERM_ADVANTAGE_ECONOMIC = 'Advantage - Economic'¶

TERM_ADVANTAGE_MILITARY = 'Advantage - Military'¶

TERM_ADVANTAGE_POLITICAL = 'Advantage - Political'¶

TERM_BRAND_DAMAGE = 'Brand Damage'¶

TERM_COMPETITIVE_ADVANTAGE = 'Competitive Advantage'¶

TERM_DEGRADATION_OF_SERVICE = 'Degradation of Service'¶

TERM_DENIAL_AND_DECEPTION = 'Denial and Deception'¶

TERM_DESTRUCTION = 'Destruction'¶

TERM_DISRUPTION = 'Disruption'¶

TERM_EMBARRASSMENT = 'Embarrassment'¶

TERM_EXPOSURE = 'Exposure'¶

TERM_EXTORTION = 'Extortion'¶

TERM_FRAUD = 'Fraud'¶

TERM_HARASSMENT = 'Harassment'¶

TERM_ICS_CONTROL = 'ICS Control'¶

TERM_THEFT = 'Theft'¶

TERM_THEFT_CREDENTIAL_THEFT = 'Theft - Credential Theft'¶

TERM_THEFT_IDENTITY_THEFT = 'Theft - Identity Theft'¶

TERM_THEFT_INTELLECTUAL_PROPERTY = 'Theft - Intellectual Property'¶

TERM_THEFT_THEFT_OF_PROPRIETARY_INFORMATION = 'Theft - Theft of Proprietary Information'¶

TERM_TRAFFIC_DIVERSION = 'Traffic Diversion'¶

TERM_UNAUTHORIZED_ACCESS = 'Unauthorized Access'¶

class stix.common.vocabs.LocationClass_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_COLOCATED = 'Co-Located'¶

TERM_EXTERNALLYLOCATED = 'Externally-Located'¶

TERM_INTERNALLYLOCATED = 'Internally-Located'¶

TERM_MOBILE = 'Mobile'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.LossDuration_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_DAYS = 'Days'¶

TERM_HOURS = 'Hours'¶

TERM_MINUTES = 'Minutes'¶

TERM_PERMANENT = 'Permanent'¶

TERM_SECONDS = 'Seconds'¶

TERM_UNKNOWN = 'Unknown'¶

TERM_WEEKS = 'Weeks'¶

class stix.common.vocabs.LossProperty_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ACCOUNTABILITY = 'Accountability'¶

TERM_AVAILABILITY = 'Availability'¶

TERM_CONFIDENTIALITY = 'Confidentiality'¶

TERM_INTEGRITY = 'Integrity'¶

TERM_NONREPUDIATION = 'Non-Repudiation'¶

class stix.common.vocabs.MalwareType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ADWARE = 'Adware'¶

TERM_AUTOMATED_TRANSFER_SCRIPTS = 'Automated Transfer Scripts'¶

TERM_BOT = 'Bot'¶

TERM_BOT_CREDENTIAL_THEFT = 'Bot - Credential Theft'¶

TERM_BOT_DDOS = 'Bot - DDoS'¶

TERM_BOT_LOADER = 'Bot - Loader'¶

TERM_BOT_SPAM = 'Bot - Spam'¶

TERM_DIALER = 'Dialer'¶

TERM_DOS_OR_DDOS = 'DoS / DDoS'¶

TERM_DOS_OR_DDOS_PARTICIPATORY = 'DoS / DDoS - Participatory'¶

TERM_DOS_OR_DDOS_SCRIPT = 'DoS / DDoS - Script'¶

TERM_DOS_OR_DDOS_STRESS_TEST_TOOLS = 'DoS / DDoS - Stress Test Tools'¶

TERM_EXPLOIT_KITS = 'Exploit Kits'¶

TERM_POS_OR_ATM_MALWARE = 'POS / ATM Malware'¶

TERM_RANSOMWARE = 'Ransomware'¶

TERM_REMOTE_ACCESS_TROJAN = 'Remote Access Trojan'¶

TERM_ROGUE_ANTIVIRUS = 'Rogue Antivirus'¶

TERM_ROOTKIT = 'Rootkit'¶

class stix.common.vocabs.ManagementClass_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_COMANAGEMENT = 'Co-Management'¶

TERM_EXTERNALLYMANAGEMENT = 'Externally-Management'¶

TERM_INTERNALLYMANAGED = 'Internally-Managed'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.Motivation_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_EGO = 'Ego'¶

TERM_FINANCIAL_OR_ECONOMIC = 'Financial or Economic'¶

TERM_IDEOLOGICAL = 'Ideological'¶

TERM_IDEOLOGICAL_ANTICORRUPTION = 'Ideological - Anti-Corruption'¶

TERM_IDEOLOGICAL_ANTIESTABLISMENT = 'Ideological - Anti-Establisment'¶

TERM_IDEOLOGICAL_ENVIRONMENTAL = 'Ideological - Environmental'¶

TERM_IDEOLOGICAL_ETHNIC_NATIONALIST = 'Ideological - Ethnic / Nationalist'¶

TERM_IDEOLOGICAL_HUMAN_RIGHTS = 'Ideological - Human Rights'¶

TERM_IDEOLOGICAL_INFORMATION_FREEDOM = 'Ideological - Information Freedom'¶

TERM_IDEOLOGICAL_RELIGIOUS = 'Ideological - Religious'¶

TERM_IDEOLOGICAL_SECURITY_AWARENESS = 'Ideological - Security Awareness'¶

TERM_MILITARY = 'Military'¶

TERM_OPPORTUNISTIC = 'Opportunistic'¶

TERM_POLICITAL = 'Policital'¶

class stix.common.vocabs.Motivation_1_0_1(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_EGO = 'Ego'¶

TERM_FINANCIAL_OR_ECONOMIC = 'Financial or Economic'¶

TERM_IDEOLOGICAL = 'Ideological'¶

TERM_IDEOLOGICAL_ANTI_CORRUPTION = 'Ideological - Anti-Corruption'¶

TERM_IDEOLOGICAL_ANTI_ESTABLISHMENT = 'Ideological - Anti-Establishment'¶

TERM_IDEOLOGICAL_ENVIRONMENTAL = 'Ideological - Environmental'¶

TERM_IDEOLOGICAL_ETHNIC_NATIONALIST = 'Ideological - Ethnic / Nationalist'¶

TERM_IDEOLOGICAL_HUMAN_RIGHTS = 'Ideological - Human Rights'¶

TERM_IDEOLOGICAL_INFORMATION_FREEDOM = 'Ideological - Information Freedom'¶

TERM_IDEOLOGICAL_SECURITY_AWARENESS = 'Ideological - Security Awareness'¶

TERM_IDEOLOGICAL__RELIGIOUS = 'Ideological - Religious'¶

TERM_MILITARY = 'Military'¶

TERM_OPPORTUNISTIC = 'Opportunistic'¶

TERM_POLICITAL = 'Policital'¶

class stix.common.vocabs.Motivation_1_1(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_EGO = 'Ego'¶

TERM_FINANCIAL_OR_ECONOMIC = 'Financial or Economic'¶

TERM_IDEOLOGICAL = 'Ideological'¶

TERM_IDEOLOGICAL_ANTICORRUPTION = 'Ideological - Anti-Corruption'¶

TERM_IDEOLOGICAL_ANTIESTABLISHMENT = 'Ideological - Anti-Establishment'¶

TERM_IDEOLOGICAL_ENVIRONMENTAL = 'Ideological - Environmental'¶

TERM_IDEOLOGICAL_ETHNIC_NATIONALIST = 'Ideological - Ethnic / Nationalist'¶

TERM_IDEOLOGICAL_HUMAN_RIGHTS = 'Ideological - Human Rights'¶

TERM_IDEOLOGICAL_INFORMATION_FREEDOM = 'Ideological - Information Freedom'¶

TERM_IDEOLOGICAL_RELIGIOUS = 'Ideological - Religious'¶

TERM_IDEOLOGICAL_SECURITY_AWARENESS = 'Ideological - Security Awareness'¶

TERM_MILITARY = 'Military'¶

TERM_OPPORTUNISTIC = 'Opportunistic'¶

TERM_POLITICAL = 'Political'¶

class stix.common.vocabs.OwnershipClass_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_CUSTOMEROWNED = 'Customer-Owned'¶

TERM_EMPLOYEEOWNED = 'Employee-Owned'¶

TERM_INTERNALLYOWNED = 'Internally-Owned'¶

TERM_PARTNEROWNED = 'Partner-Owned'¶

TERM_UNKNOWN = 'Unknown'¶

class stix.common.vocabs.PackageIntent_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ATTACK_PATTERN_CHARACTERIZATION = 'Attack Pattern Characterization'¶

TERM_CAMPAIGN_CHARACTERIZATION = 'Campaign Characterization'¶

TERM_COLLECTIVE_THREAT_INTELLIGENCE = 'Collective Threat Intelligence'¶

TERM_COURSES_OF_ACTION = 'Courses of Action'¶

TERM_EXPLOIT_CHARACTERIZATION = 'Exploit Characterization'¶

TERM_INCIDENT = 'Incident'¶

TERM_INDICATORS = 'Indicators'¶

TERM_INDICATORS_ENDPOINT_CHARACTERISTICS = 'Indicators - Endpoint Characteristics'¶

TERM_INDICATORS_MALWARE_ARTIFACTS = 'Indicators - Malware Artifacts'¶

TERM_INDICATORS_NETWORK_ACTIVITY = 'Indicators - Network Activity'¶

TERM_INDICATORS_PHISHING = 'Indicators - Phishing'¶

TERM_INDICATORS_WATCHLIST = 'Indicators - Watchlist'¶

TERM_MALWARE_CHARACTERIZATION = 'Malware Characterization'¶

TERM_MALWARE_SAMPLES = 'Malware Samples'¶

TERM_OBSERVATIONS = 'Observations'¶

TERM_OBSERVATIONS_EMAIL = 'Observations - Email'¶

TERM_THREAT_ACTOR_CHARACTERIZATION = 'Threat Actor Characterization'¶

TERM_THREAT_REPORT = 'Threat Report'¶

TERM_TTP_INFRASTRUCTURE = 'TTP - Infrastructure'¶

TERM_TTP_TOOLS = 'TTP - Tools'¶

class stix.common.vocabs.PlanningAndOperationalSupport_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_DATA_EXPLOITATION = 'Data Exploitation'¶

TERM_DATA_EXPLOITATION_ANALYTIC_SUPPORT = 'Data Exploitation - Analytic Support'¶

TERM_DATA_EXPLOITATION_TRANSLATION_SUPPORT = 'Data Exploitation - Translation Support'¶

TERM_FINANCIAL_RESOURCES = 'Financial Resources'¶

TERM_FINANCIAL_RESOURCES_ACADEMIC = 'Financial Resources - Academic'¶

TERM_FINANCIAL_RESOURCES_COMMERCIAL = 'Financial Resources - Commercial'¶

TERM_FINANCIAL_RESOURCES_GOVERNMENT = 'Financial Resources - Government'¶

TERM_FINANCIAL_RESOURCES_HACKTIVIST_OR_GRASSROOT = 'Financial Resources - Hacktivist or Grassroot'¶

TERM_FINANCIAL_RESOURCES_NONATTRIBUTABLE_FINANCE = 'Financial Resources - Non-Attributable Finance'¶

TERM_PLANNING = 'Planning '¶

TERM_PLANNING_OPEN_SOURCE_INTELLIGENCE_OSINT_GETHERING = 'Planning - Open-Source Intelligence (OSINT) Gethering'¶

TERM_PLANNING_OPERATIONAL_COVER_PLAN = 'Planning - Operational Cover Plan'¶

TERM_PLANNING_PRE_OPERATIONAL_SURVEILLANCE_AND_RECONNAISSANCE = 'Planning - Pre-Operational Surveillance and Reconnaissance'¶

TERM_PLANNING_TARGET_SELECTION = 'Planning - Target Selection'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT = 'Skill Development / Recruitment'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_CONTRACTING_AND_HIRING = 'Skill Development / Recruitment - Contracting and Hiring'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_DOCUMENT_EXPLOITATION_DOCEX_TRAINING = 'Skill Development / Recruitment - Document Exploitation (DOCEX) Training'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_INTERNAL_TRAINING = 'Skill Development / Recruitment - Internal Training'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_MILITARY_PROGRAMS = 'Skill Development / Recruitment - Military Programs'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_SECURITY_HACKER_CONFERENCES = 'Skill Development / Recruitment - Security / Hacker Conferences'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_UNDERGROUND_FORUMS = 'Skill Development / Recruitment - Underground Forums'¶

TERM_SKILL_DEVELOPMENT_RECRUITMENT_UNIVERSITY_PROGRAMS = 'Skill Development / Recruitment - University Programs'¶

class stix.common.vocabs.PlanningAndOperationalSupport_1_0_1(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_DATA_EXPLOITATION = 'Data Exploitation'¶

TERM_DATA_EXPLOITATION_ANALYTIC_SUPPORT = 'Data Exploitation - Analytic Support'¶

TERM_DATA_EXPLOITATION_TRANSLATION_SUPPORT = 'Data Exploitation - Translation Support'¶

TERM_FINANCIAL_RESOURCES = 'Financial Resources'¶

TERM_FINANCIAL_RESOURCES_ACADEMIC = 'Financial Resources - Academic'¶

TERM_FINANCIAL_RESOURCES_COMMERCIAL = 'Financial Resources - Commercial'¶

TERM_FINANCIAL_RESOURCES_GOVERNMENT = 'Financial Resources - Government'¶

TERM_FINANCIAL_RESOURCES_HACKTIVIST_OR_GRASSROOT = 'Financial Resources - Hacktivist or Grassroot'¶

TERM_FINANCIAL_RESOURCES_NONATTRIBUTABLE_FINANCE = 'Financial Resources - Non-Attributable Finance'¶

TERM_PLANNING = 'Planning'¶

TERM_PLANNING_OPENSOURCE_INTELLIGENCE_OSINT_GATHERING = 'Planning - Open-Source Intelligence (OSINT) Gathering'¶

TERM_PLANNING_OPERATIONAL_COVER_PLAN = 'Planning - Operational Cover Plan'¶

TERM_PLANNING_PREOPERATIONAL_SURVEILLANCE_AND_RECONNAISSANCE = 'Planning - Pre-Operational Surveillance and Reconnaissance'¶

TERM_PLANNING_TARGET_SELECTION = 'Planning - Target Selection'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT = 'Skill Development / Recruitment'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_CONTRACTING_AND_HIRING = 'Skill Development / Recruitment - Contracting and Hiring'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_DOCUMENT_EXPLOITATION_DOCEX_TRAINING = 'Skill Development / Recruitment - Document Exploitation (DOCEX) Training'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_INTERNAL_TRAINING = 'Skill Development / Recruitment - Internal Training'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_MILITARY_PROGRAMS = 'Skill Development / Recruitment - Military Programs'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_SECURITY_OR_HACKER_CONFERENCES = 'Skill Development / Recruitment - Security / Hacker Conferences'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_UNDERGROUND_FORUMS = 'Skill Development / Recruitment - Underground Forums'¶

TERM_SKILL_DEVELOPMENT_OR_RECRUITMENT_UNIVERSITY_PROGRAMS = 'Skill Development / Recruitment - University Programs'¶

class stix.common.vocabs.ReportIntent_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ATTACK_PATTERN_CHARACTERIZATION = 'Attack Pattern Characterization'¶

TERM_CAMPAIGN_CHARACTERIZATION = 'Campaign Characterization'¶

TERM_COLLECTIVE_THREAT_INTELLIGENCE = 'Collective Threat Intelligence'¶

TERM_COURSES_OF_ACTION = 'Courses of Action'¶

TERM_EXPLOIT_CHARACTERIZATION = 'Exploit Characterization'¶

TERM_INCIDENT = 'Incident'¶

TERM_INDICATORS = 'Indicators'¶

TERM_INDICATORS_ENDPOINT_CHARACTERISTICS = 'Indicators - Endpoint Characteristics'¶

TERM_INDICATORS_MALWARE_ARTIFACTS = 'Indicators - Malware Artifacts'¶

TERM_INDICATORS_NETWORK_ACTIVITY = 'Indicators - Network Activity'¶

TERM_INDICATORS_PHISHING = 'Indicators - Phishing'¶

TERM_INDICATORS_WATCHLIST = 'Indicators - Watchlist'¶

TERM_MALWARE_CHARACTERIZATION = 'Malware Characterization'¶

TERM_MALWARE_SAMPLES = 'Malware Samples'¶

TERM_OBSERVATIONS = 'Observations'¶

TERM_OBSERVATIONS_EMAIL = 'Observations - Email'¶

TERM_THREAT_ACTOR_CHARACTERIZATION = 'Threat Actor Characterization'¶

TERM_THREAT_REPORT = 'Threat Report'¶

TERM_TTP_INFRASTRUCTURE = 'TTP - Infrastructure'¶

TERM_TTP_TOOLS = 'TTP - Tools'¶

class stix.common.vocabs.SecurityCompromise_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_NO = 'No'¶

TERM_SUSPECTED = 'Suspected'¶

TERM_UNKNOWN = 'Unknown'¶

TERM_YES = 'Yes'¶

class stix.common.vocabs.SystemType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ENTERPRISE_SYSTEMS = 'Enterprise Systems'¶

TERM_ENTERPRISE_SYSTEMS_APPLICATION_LAYER = 'Enterprise Systems - Application Layer'¶

TERM_ENTERPRISE_SYSTEMS_DATABASE_LAYER = 'Enterprise Systems - Database Layer'¶

TERM_ENTERPRISE_SYSTEMS_ENTERPRISE_TECHNOLOGIES_AND_SUPPORT_INFRASTRUCTURE = 'Enterprise Systems - Enterprise Technologies and Support Infrastructure'¶

TERM_ENTERPRISE_SYSTEMS_NETWORKING_DEVICES = 'Enterprise Systems - Networking Devices'¶

TERM_ENTERPRISE_SYSTEMS_NETWORK_SYSTEMS = 'Enterprise Systems - Network Systems'¶

TERM_ENTERPRISE_SYSTEMS_VOIP = 'Enterprise Systems - VoIP'¶

TERM_ENTERPRISE_SYSTEMS_WEB_LAYER = 'Enterprise Systems - Web Layer'¶

TERM_INDUSTRIAL_CONTROL_SYSTEMS = 'Industrial Control Systems'¶

TERM_INDUSTRIAL_CONTROL_SYSTEMS_EQUIPMENT_UNDER_CONTROL = 'Industrial Control Systems - Equipment Under Control'¶

TERM_INDUSTRIAL_CONTROL_SYSTEMS_OPERATIONS_MANAGEMENT = 'Industrial Control Systems - Operations Management'¶

TERM_INDUSTRIAL_CONTROL_SYSTEMS_SAFETY_PROTECTION_AND_LOCAL_CONTROL = 'Industrial Control Systems - Safety, Protection and Local Control'¶

TERM_INDUSTRIAL_CONTROL_SYSTEMS_SUPERVISORY_CONTROL = 'Industrial Control Systems - Supervisory Control'¶

TERM_MOBILE_SYSTEMS = 'Mobile Systems'¶

TERM_MOBILE_SYSTEMS_MOBILE_DEVICES = 'Mobile Systems - Mobile Devices'¶

TERM_MOBILE_SYSTEMS_MOBILE_OPERATING_SYSTEMS = 'Mobile Systems - Mobile Operating Systems'¶

TERM_MOBILE_SYSTEMS_NEAR_FIELD_COMMUNICATIONS = 'Mobile Systems - Near Field Communications'¶

TERM_THIRDPARTY_SERVICES = 'Third-Party Services'¶

TERM_THIRDPARTY_SERVICES_APPLICATION_STORES = 'Third-Party Services - Application Stores'¶

TERM_THIRDPARTY_SERVICES_CLOUD_SERVICES = 'Third-Party Services - Cloud Services'¶

TERM_THIRDPARTY_SERVICES_SECURITY_VENDORS = 'Third-Party Services - Security Vendors'¶

TERM_THIRDPARTY_SERVICES_SOCIAL_MEDIA = 'Third-Party Services - Social Media'¶

TERM_THIRDPARTY_SERVICES_SOFTWARE_UPDATE = 'Third-Party Services - Software Update'¶

TERM_USERS = 'Users'¶

TERM_USERS_APPLICATION_AND_SOFTWARE = 'Users - Application And Software'¶

TERM_USERS_REMOVABLE_MEDIA = 'Users - Removable Media'¶

TERM_USERS_WORKSTATION = 'Users - Workstation'¶

class stix.common.vocabs.ThreatActorSophistication_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_ASPIRANT = 'Aspirant'¶

TERM_EXPERT = 'Expert'¶

TERM_INNOVATOR = 'Innovator'¶

TERM_NOVICE = 'Novice'¶

TERM_PRACTITIONER = 'Practitioner'¶

class stix.common.vocabs.ThreatActorType_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_CYBER_ESPIONAGE_OPERATIONS = 'Cyber Espionage Operations'¶

TERM_DISGRUNTLED_CUSTOMER_OR_USER = 'Disgruntled Customer / User'¶

TERM_ECRIME_ACTOR_CREDENTIAL_THEFT_BOTNET_OPERATOR = 'eCrime Actor - Credential Theft Botnet Operator'¶

TERM_ECRIME_ACTOR_CREDENTIAL_THEFT_BOTNET_SERVICE = 'eCrime Actor - Credential Theft Botnet Service'¶

TERM_ECRIME_ACTOR_MALWARE_DEVELOPER = 'eCrime Actor - Malware Developer'¶

TERM_ECRIME_ACTOR_MONEY_LAUNDERING_NETWORK = 'eCrime Actor - Money Laundering Network'¶

TERM_ECRIME_ACTOR_ORGANIZED_CRIME_ACTOR = 'eCrime Actor - Organized Crime Actor'¶

TERM_ECRIME_ACTOR_SPAM_SERVICE = 'eCrime Actor - Spam Service'¶

TERM_ECRIME_ACTOR_TRAFFIC_SERVICE = 'eCrime Actor - Traffic Service'¶

TERM_ECRIME_ACTOR_UNDERGROUND_CALL_SERVICE = 'eCrime Actor - Underground Call Service'¶

TERM_HACKER = 'Hacker'¶

TERM_HACKER_BLACK_HAT = 'Hacker - Black hat'¶

TERM_HACKER_GRAY_HAT = 'Hacker - Gray hat'¶

TERM_HACKER_WHITE_HAT = 'Hacker - White hat'¶

TERM_HACKTIVIST = 'Hacktivist'¶

TERM_INSIDER_THREAT = 'Insider Threat'¶

TERM_STATE_ACTOR_OR_AGENCY = 'State Actor / Agency'¶

class stix.common.vocabs.Versioning_1_0(value=None)¶

Bases: stix.common.vocabs.VocabString

TERM_REVOKES = 'Revokes'¶

TERM_UPDATES_REVISES = 'Updates - Revises'¶

TERM_UPDATE_CORRECTS = 'Updates - Corrects'¶

class stix.common.vocabs.VocabString(value=None)¶

Bases: stix.base.Entity

is_plain()¶: Whether the VocabString can be represented as a single value.

stix.common.vocabs.AssetType¶: alias of AssetType_1_0

stix.common.vocabs.AttackerInfrastructureType¶: alias of AttackerInfrastructureType_1_0

stix.common.vocabs.AttackerToolType¶: alias of AttackerToolType_1_0

stix.common.vocabs.AvailabilityLossType¶: alias of AvailabilityLossType_1_1_1

stix.common.vocabs.CampaignStatus¶: alias of CampaignStatus_1_0

stix.common.vocabs.COAStage¶: alias of COAStage_1_0

stix.common.vocabs.CourseOfActionType¶: alias of CourseOfActionType_1_0

stix.common.vocabs.DiscoveryMethod¶: alias of DiscoveryMethod_2_0

stix.common.vocabs.HighMediumLow¶: alias of HighMediumLow_1_0

stix.common.vocabs.ImpactQualification¶: alias of ImpactQualification_1_0

stix.common.vocabs.ImpactRating¶: alias of ImpactRating_1_0

stix.common.vocabs.IncidentCategory¶: alias of IncidentCategory_1_0

stix.common.vocabs.IncidentEffect¶: alias of IncidentEffect_1_0

stix.common.vocabs.IncidentStatus¶: alias of IncidentStatus_1_0

stix.common.vocabs.IndicatorType¶: alias of IndicatorType_1_1

stix.common.vocabs.InformationSourceRole¶: alias of InformationSourceRole_1_0

stix.common.vocabs.InformationType¶: alias of InformationType_1_0

stix.common.vocabs.IntendedEffect¶: alias of IntendedEffect_1_0

stix.common.vocabs.LocationClass¶: alias of LocationClass_1_0

stix.common.vocabs.LossDuration¶: alias of LossDuration_1_0

stix.common.vocabs.LossProperty¶: alias of LossProperty_1_0

stix.common.vocabs.MalwareType¶: alias of MalwareType_1_0

stix.common.vocabs.ManagementClass¶: alias of ManagementClass_1_0

stix.common.vocabs.Motivation¶: alias of Motivation_1_1

stix.common.vocabs.OwnershipClass¶: alias of OwnershipClass_1_0

stix.common.vocabs.PackageIntent¶: alias of PackageIntent_1_0

stix.common.vocabs.PlanningAndOperationalSupport¶: alias of PlanningAndOperationalSupport_1_0_1

stix.common.vocabs.SecurityCompromise¶: alias of SecurityCompromise_1_0

stix.common.vocabs.SystemType¶: alias of SystemType_1_0

stix.common.vocabs.ThreatActorSophistication¶: alias of ThreatActorSophistication_1_0

stix.common.vocabs.ThreatActorType¶: alias of ThreatActorType_1_0

Functions¶

stix.common.vocabs.add_vocab(cls)¶: Registers a VocabString subclass.

Note

The register_vocab() class decorator has replaced this method.

stix.common.vocabs.register_vocab(cls)¶

Class decorator that registers a VocabString subclass.

Also, calculate all the permitted values for class being decorated by adding an _ALLOWED_VALUES tuple of all the values of class members beginning with TERM_.

STIX Core¶

Modules located in the stix.core package

Version: 1.2.0.0

`stix.core.stix_header` Module¶

Classes¶

class stix.core.stix_header.STIXHeader(package_intents=None, description=None, handling=None, information_source=None, title=None, short_description=None)¶

Bases: stix.base.Entity

The STIX Package Header.

Parameters:

handling – The data marking section of the Header.
information_source – The InformationSource section of the Header.
package_intents – DEPRECATED. A collection of VocabString defining the intent of the parent STIXPackage.
description – DEPRECATED. A description of the intent or purpose of the parent STIXPackage.
short_description – DEPRECATED. A short description of the intent or purpose of the parent STIXPackage.
title – DEPRECATED. The title of the STIXPackage.

profiles¶: A collection of STIX Profiles the parent STIXPackage conforms to.

title¶: DEPRECATED. The title of the parent STIXPackage.

add_description(description)¶

DEPRECATED. Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_package_intent(package_intent)¶

DEPRECATED. Adds VocabString object to the package_intents collection.

If the input is not an instance of VocabString, an effort will be made to convert it into an instance of PackageIntent.

add_profile(profile)¶: Adds a profile to the STIX Header. A Profile is represented by a string URI.

add_short_description(description)¶

DEPRECATED. Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

DEPRECATED. A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

DEPRECATED. A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

handling¶: The Marking section of this Header. This section contains data marking information.

information_source¶: The InformationSource section of the STIX Header.

package_intents¶: DEPRECATED. A collection of VocabString controlled vocabulary objects defining the intent of the STIX Package.

short_description¶

DEPRECATED. A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

DEPRECATED. A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Version: 1.2.0.0

`stix.core.stix_package` Module¶

Overview¶

The stix.core.stix_package module implements STIXPackage.

STIXType defines a bundle of information characterized in the Structured Threat Information eXpression (STIX) language.

Documentation Resources¶

STIX Package Data Model

Classes¶

class stix.core.stix_package.STIXPackage(id_=None, idref=None, timestamp=None, stix_header=None, courses_of_action=None, exploit_targets=None, indicators=None, observables=None, incidents=None, threat_actors=None, ttps=None, campaigns=None, related_packages=None, reports=None)¶

Bases: stix.base.Entity

A STIX Package object.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref – DEPRECATED An identifier reference. If set this will unset the id_ property.
timestamp – DEPRECATED A timestamp value. Can be an instance of datetime.datetime or str.
header – A Report Header object.
campaigns – A collection of Campaign objects.
course_of_action – A collection of CourseOfAction objects.
exploit_targets – A collection of ExploitTarget objects.
incidents – A collection of Incident objects.
indicators – A collection of Indicator objects.
threat_actors – A collection of ThreatActor objects.
ttps – A collection of TTP objects.
related_packages – DEPRECATED. A collection of RelatedPackage objects.
reports – A collection of Report objects.

add(entity)¶: Adds entity to a top-level collection. For example, if entity is an Indicator object, the entity will be added to the indicators top-level collection.

add_campaign(campaign)¶: Adds a Campaign object to the campaigns collection.

add_course_of_action(course_of_action)¶: Adds an CourseOfAction object to the courses_of_action collection.

add_exploit_target(exploit_target)¶: Adds an ExploitTarget object to the exploit_targets collection.

add_incident(incident)¶: Adds an Incident object to the incidents collection.

add_indicator(indicator)¶: Adds an Indicator object to the indicators collection.

add_observable(observable)¶

Adds an Observable object to the observables collection.

If observable is not an Observable instance, an effort will be made to convert it to one.

add_related_package(related_package)¶: Adds a RelatedPackage object to the related_packages collection.

add_report(report)¶: Adds a Report object to the reports collection.

add_threat_actor(threat_actor)¶: Adds an ThreatActor object to the threat_actors collection.

add_ttp(ttp)¶: Adds an TTP object to the ttps collection.

campaigns¶: The top-level Campaign collection. This behaves like a MutableSequence type.

courses_of_action¶: The top-level CourseOfAction collection. This behaves like a MutableSequence type.

exploit_targets¶: The top-level ExploitTarget collection. This behaves like a MutableSequence type.

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

classmethod from_xml(xml_file, encoding=None)¶

Parses the xml_file file-like object and returns a STIXPackage instance.

Parameters:	xml_file – A file, file-like object, etree._Element, or etree._ElementTree instance. encoding – The character encoding of the xml_file input. If `None`, an attempt will be made to determine the input character encoding. Default is `None`.
Returns:	An instance of – class:STIXPackage.

id_¶: A globally unique identifier for this Report. By default, one will be generated automatically.

idref¶: A reference to another Report identifier. Setting this will unset any previous id values.

incidents¶: The top-level Incident collection. This behaves like a MutableSequence type.

indicators¶: The top-level Indicator collection. This behaves like a MutableSequence type.

observables¶: The top-level Observable collection. This behaves like a MutableSequence type.

related_packages¶: DEPRECATED. A collection of RelatedPackage objects.

reports¶: A collection of Report objects. This behaves like a MutableSequence object.

stix_header¶: The STIXHeader section of the STIX Package.

threat_actors¶: The top-level ThreatActor collection. This behaves like a MutableSequence type.

timestamp¶: Specifies a timestamp for the definition of this specifc Report object.

to_xml(include_namespaces=True, include_schemalocs=False, ns_dict=None, schemaloc_dict=None, pretty=True, auto_namespace=True, encoding='utf-8')¶

Serializes a Entity instance to an XML string.

The default character encoding is utf-8 and can be set via the encoding parameter. If encoding is None, a unicode string is returned.

Parameters:

auto_namespace – Automatically discover and export XML namespaces for a STIX Entity instance.
include_namespaces – Export namespace definitions in the output XML. Default is True.
include_schemalocs – Export xsi:schemaLocation attribute in the output document. This will attempt to associate namespaces declared in the STIX document with schema locations. If a namespace cannot be resolved to a schemaLocation, a Python warning will be raised. Schemalocations will only be exported if include_namespaces is also True.
ns_dict – Dictionary of XML definitions (namespace is key, alias is value) to include in the exported document. This must be passed in if auto_namespace is False.
schemaloc_dict – Dictionary of XML namespace: schema location mappings to include in the exported document. These will only be included if auto_namespace is False.
pretty – Pretty-print the XML.
encoding – The output character encoding. Default is utf-8. If encoding is set to None, a unicode string is returned.

Returns:

An XML string for this Entity instance. Default character encoding is utf-8.

ttps¶: The top-level TTP collection. This behaves like a MutableSequence type.

version¶

The schematic version of this component.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: ‘1.2’

class stix.core.stix_package.RelatedPackages(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.core.ttps` Module¶

Classes¶

class stix.core.ttps.TTPs(ttps=None)¶: Bases: stix.base.EntityList

STIX Course of Action (COA)¶

Modules located in the stix.coa package

Version: 1.2.0.0

`stix.coa` Module¶

Overview¶

The stix.coa module implements CourseOfAction.

CoursesOfAction are specific measures to be taken to address threat whether they are corrective or preventative to address ExploitTargets, or responsive to counter or mitigate the potential impacts of Incidents

Documentation Resources¶

Course Of Action Data Model

Classes¶

class stix.coa.CourseOfAction(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of the STIX Course of Action.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description – A description of the purpose or intent of this object.
short_description – A short description of the intent or purpose of this object.
title – The title of this object.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

cost¶

The cost of this COA. This is a Statement property.

If set to a string, an attempt will be made to convert it into a Statement object.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

efficacy¶

The efficacy of this COA. This is a Statement property.

If set to a string, an attempt will be made to convert it into a Statement object.

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

impact¶

The impact of this COA. This is a Statement property.

If set to a string, an attempt will be made to convert it into a Statement object.

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

objective¶: A Objective field.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

stage¶: A VocabString property. If set to a string, an attempt will be made to convert it to an instance of Stage.

structured_coa¶: A structured Course of Action extension point. This can be set to implementations of this extension point, such as GenericStructuredCOA.

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

type_¶: A VocabString property. If set to a string, an attempt will be made to convert it to an instance of COAType.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

class stix.coa.RelatedCOAs(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.coa.objective` Module¶

Classes¶

class stix.coa.objective.Objective(description=None, short_description=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

STIX Exploit Target¶

Modules located in the stix.exploit_target package

Version: 1.2.0.0

`stix.exploit_target` Module¶

Overview¶

The stix.exploit_target module implements ExploitTarget.

This denotes the specific vulnerability, weakness, or software configuration that creates a security risk.

Documentation Resources¶

Classes¶

class stix.exploit_target.ExploitTarget(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of STIX Exploit Target.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
title (optional) – A string title.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description (optional) – A string description.
short_description (optional) – A string short description.

add_configuration(value)¶

Adds a configuration to the configurations list property.

Note

If None is passed in no value is added

Parameters:	value – A configuration value.
Raises:	`ValueError` – If the value param is of type `Configuration`

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

add_vulnerability(value)¶

Adds a vulnerability to the vulnerabilities list property.

Note

If None is passed in no value is added

Parameters:	value – A `Vulnerability` object..
Raises:	`ValueError` – if the value param is of type `Vulnerability`

add_weakness(value)¶

Adds a weakness to the weaknesses list property.

Note

If None is passed in no value is added

Parameters:	value – A `Weakness` object.

Raises: ValueError if the value param is of type Weakness

configuration¶

A list of Configuration objects. This behaves like a MutableSequence type.

Default Value: None

Returns:	A list of – class:.Configuration objects.
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `Configuration`.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

vulnerabilities¶

A collection of Vulnerability objects. This behaves like a MutableSequence type.

Default Value: None

Returns:	A list of – class:.Vulnerability
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `Vulnerability`

weaknesses¶

A collection of Weakness objects. This behaves like a MutableSequence type.

Default Value: None

Returns:	A list of – class:.Weakness objects.
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `Weakness`

class stix.exploit_target.PotentialCOAs(coas=None, scope=None)¶

Bases: stix.common.related.GenericRelationshipList

A list of Potential_COA objects, defaults to empty array

class stix.exploit_target.RelatedExploitTargets(related_exploit_targets=None, scope=None)¶

Bases: stix.common.related.GenericRelationshipList

A list of RelatedExploitTargets objects, defaults to empty array

Version: 1.2.0.0

`stix.exploit_target.configuration` Module¶

Overview¶

The stix.exploit_target.configuration module captures the software configuration that causes a vulnerability in a system.

Classes¶

class stix.exploit_target.configuration.Configuration(description=None, short_description=None, cce_id=None)¶

Bases: stix.base.Entity

Implementation of STIX Configuration.

Parameters:	cce_id (optional) – Common Configuration Enumeration value as a string description (optional) – A string description. short_description (optional) – A string short description.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

cce_id¶

Common Configuration Enumeration value for this Configuration.

Default Value: None

Returns:	A string representing the CCE ID

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Version: 1.2.0.0

`stix.exploit_target.vulnerability` Module¶

Overview¶

The stix.exploit_target.vulnerability module captures the software version and specific bug that causes an exploitable condition.

Classes¶

class stix.exploit_target.vulnerability.Vulnerability(title=None, description=None, short_description=None)¶

Bases: stix.base.Entity

Implementation of STIX Vulnerability.

Parameters:	title (optional) – A string title. description (optional) – A string description. short_description (optional) – A string short description.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

discovered_datetime¶

Returns:	The time this vulnerability was discovered, represented as class:DateTimeWithPrecision

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

title¶: String representing the Vulnerability Title

class stix.exploit_target.vulnerability.CVSSVector¶

Bases: stix.base.Entity

Common Vulnerabilit Scoring System object, representing its component measures

class stix.exploit_target.vulnerability.AffectedSoftware(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.exploit_target.weakness` Module¶

Overview¶

The stix.exploit_target.weakness module captures a given software weakness as enumerated by CWE

Classes¶

class stix.exploit_target.weakness.Weakness(description=None, cwe_id=None)¶

Bases: stix.base.Entity

Implementation of STIX Weakness.

Parameters:	cwe_id (optional) – Common Weakness Enumeration value as a string description (optional) – A string description.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

cwe_id¶: Common Weakness Enumeration value as a string

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

STIX Extensions¶

Modules located in the stix.extensions package

Version: 1.2.0.0

`stix.extensions.identity.ciq_identity_3_0` Module¶

Classes¶

class stix.extensions.identity.ciq_identity_3_0.CIQIdentity3_0Instance(roles=None, specification=None)¶: Bases: stix.common.identity.Identity

class stix.extensions.identity.ciq_identity_3_0.STIXCIQIdentity3_0(party_name=None, languages=None, addresses=None, organisation_info=None, electronic_address_identifiers=None, free_text_lines=None, contact_numbers=None, nationalities=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.Address(free_text_address=None, country=None, administrative_area=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.AdministrativeArea(name_elements=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0._BaseNameElement(value=None)¶

Bases: stix.base.Entity

Do not instantiate directly: use PersonNameElement or OrganisationNameElement

class stix.extensions.identity.ciq_identity_3_0.ContactNumber(contact_number_elements=None, communication_media_type=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.ContactNumberElement(value=None, type_=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.Country(name_elements=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.ElectronicAddressIdentifier(value=None, type_=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.FreeTextAddress(address_lines=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.FreeTextLine(value=None, type_=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.Language(value=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.NameElement(value=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.NameLine(value=None, type_=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.OrganisationInfo(industry_type=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.OrganisationName(name_elements=None, subdivision_names=None, type_=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.OrganisationNameElement(value=None, element_type=None)¶: Bases: stix.extensions.identity.ciq_identity_3_0._BaseNameElement

class stix.extensions.identity.ciq_identity_3_0.PartyName(name_lines=None, person_names=None, organisation_names=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.PersonName(name_elements=None)¶: Bases: stix.base.Entity

class stix.extensions.identity.ciq_identity_3_0.PersonNameElement(value=None, element_type=None)¶: Bases: stix.extensions.identity.ciq_identity_3_0._BaseNameElement

class stix.extensions.identity.ciq_identity_3_0.SubDivisionName(value=None, type_=None)¶: Bases: stix.base.Entity

Constants¶

stix.extensions.identity.ciq_identity_3_0.XML_NS_XPIL = 'urn:oasis:names:tc:ciq:xpil:3'¶

str(object=’‘) -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

stix.extensions.identity.ciq_identity_3_0.XML_NS_XNL = 'urn:oasis:names:tc:ciq:xnl:3'¶

str(object=’‘) -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

stix.extensions.identity.ciq_identity_3_0.XML_NS_XAL = 'urn:oasis:names:tc:ciq:xal:3'¶

str(object=’‘) -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

stix.extensions.identity.ciq_identity_3_0.XML_NS_STIX_EXT = 'http://stix.mitre.org/extensions/Identity#CIQIdentity3.0-1'¶

str(object=’‘) -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Version: 1.2.0.0

`stix.extensions.malware.maec_4_1_malware` Module¶

Classes¶

class stix.extensions.malware.maec_4_1_malware.MAECInstance(maec=None)¶: Bases: stix.ttp.malware_instance.MalwareInstance

Version: 1.2.0.0

`stix.extensions.marking.simple_marking` Module¶

Classes¶

class stix.extensions.marking.simple_marking.SimpleMarkingStructure(statement=None)¶: Bases: stix.data_marking.MarkingStructure

Version: 1.2.0.0

`stix.extensions.marking.terms_of_use_marking` Module¶

Classes¶

class stix.extensions.marking.terms_of_use_marking.TermsOfUseMarkingStructure(terms_of_use=None)¶: Bases: stix.data_marking.MarkingStructure

Version: 1.2.0.0

`stix.extensions.marking.tlp` Module¶

Classes¶

class stix.extensions.marking.tlp.TLPMarkingStructure(color=None)¶: Bases: stix.data_marking.MarkingStructure

Version: 1.2.0.0

`stix.extensions.structured_coa.generic_structured_coa` Module¶

Classes¶

class stix.extensions.structured_coa.generic_structured_coa.GenericStructuredCOA(id_=None, idref=None)¶

Bases: stix.coa.structured_coa._BaseStructuredCOA

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

Version: 1.2.0.0

`stix.extensions.test_mechanism.generic_test_mechanism` Module¶

Classes¶

class stix.extensions.test_mechanism.generic_test_mechanism.GenericTestMechanism(id_=None, idref=None)¶

Bases: stix.indicator.test_mechanism._BaseTestMechanism

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

Version: 1.2.0.0

`stix.extensions.test_mechanism.open_ioc_2010_test_mechanism` Module¶

Classes¶

class stix.extensions.test_mechanism.open_ioc_2010_test_mechanism.OpenIOCTestMechanism(id_=None, idref=None)¶: Bases: stix.indicator.test_mechanism._BaseTestMechanism

Version: 1.2.0.0

`stix.extensions.test_mechanism.snort_test_mechanism` Module¶

Classes¶

class stix.extensions.test_mechanism.snort_test_mechanism.SnortTestMechanism(id_=None, idref=None)¶: Bases: stix.indicator.test_mechanism._BaseTestMechanism

Version: 1.2.0.0

`stix.extensions.test_mechanism.yara_test_mechanism` Module¶

Classes¶

class stix.extensions.test_mechanism.yara_test_mechanism.YaraTestMechanism(id_=None, idref=None)¶: Bases: stix.indicator.test_mechanism._BaseTestMechanism

STIX Incident¶

Modules located in the stix.incident package

Version: 1.2.0.0

`stix.incident` Module¶

Overview¶

The stix.incident module implements Incident.

Incidents are discrete instances of Indicators affecting an organization along with information discovered or decided during an incident response investigation.

Documentation Resources¶

Incident Data Model

Classes¶

class stix.incident.Incident(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of the STIX Incident.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description – A description of the purpose or intent of this object.
short_description – A short description of the intent or purpose of this object.
title – The title of this object.

add_affected_asset(v)¶: Adds a AffectedAsset object to the affected_assets collection.

add_category(category)¶

Adds a VocabString object to the categories collection.

If category is a string, an attempt will be made to convert it into an instance of IncidentCategory.

add_coa_requested(value)¶: Adds a COARequested object to the coas_requested collection.

add_coa_taken(value)¶: Adds a COATaken object to the coas_taken collection.

add_coordinator(value)¶: Adds a InformationSource object to the coordinators collection.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_discovery_method(value)¶

Adds a VocabString object to the discovery_methods collection.

If value is a string, an attempt will be made to convert it to an instance of DiscoveryMethod.

add_external_id(value)¶: Adds a ExternalID object to the external_ids collection.

add_intended_effect(value)¶

Adds a Statement object to the intended_effects collection.

If value is a string, an attempt will be made to convert it into an instance of Statement.

add_related_indicator(value)¶

Adds an Related Indicator to the related_indicators list property of this Incident.

The indicator parameter must be an instance of RelatedIndicator or Indicator.

If the indicator parameter is None, no item wil be added to the related_indicators list property.

Calling this method is the same as calling append() on the related_indicators property.

See also

The RelatedIndicators documentation.

Note

If the indicator parameter is not an instance of RelatedIndicator an attempt will be made to convert it to one.

Parameters:	indicator – An instance of `Indicator` or `RelatedIndicator`.
Raises:	`ValueError` – If the indicator parameter cannot be converted into an instance of `RelatedIndicator`

add_related_observable(value)¶

Adds a Related Observable to the related_observables list property of this Incident.

The observable parameter must be an instance of RelatedObservable or Observable.

If the observable parameter is None, no item will be added to the related_observables list property.

Calling this method is the same as calling append() on the related_observables property.

See also

The RelatedObservables documentation.

Note

If the observable parameter is not an instance of RelatedObservable an attempt will be made to convert it to one.

Parameters:	observable – An instance of `Observable` or `RelatedObservable`.
Raises:	`ValueError` – If the value parameter cannot be converted into an instance of `RelatedObservable`

add_responder(value)¶: Adds a InformationSource object to the responders collection.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

add_victim(victim)¶: Adds a IdentityType value to the victims collection.

affected_assets¶: A collection of AffectedAsset objects. This behaves like a MutableSequence type.

categories¶: A collection of VocabString objects. This behaves like a MutableSequence type.

coa_requested¶

A collection of COARequested objects which characterize courses of action requested for response to this incident.

This behaves like a MutableSequence type.

coa_taken¶

A collection of COATaken objects which characterize courses of action taken during the incident.

This behaves like a MutableSequence type.

confidence¶: A Confidence field.

coordinators¶: A class of InformationSource objects. This behaves like a MutableSequence type.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

discovery_methods¶: A VocabString collection. This behaves like a MutableSequence type.

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

impact_assessment¶: A class ImpactAssessment field.

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

intended_effects¶

The impact of this intended effects of this Incident. This is a collection of Statement objects and behaves like a MutableSequence type.

If set to a string, an attempt will be made to convert it into a Statement object with its value set to an instance of IntendedEffect.

related_indicators¶: A collection of RelatedIndicator objects characterizing indicators related to this incident.

reporter¶: A InformationSource field.

responders¶

A class of InformationSource objects which contain information about incident responders.

This behaves like a MutableSequence type.

security_compromise¶: A VocabString field. If set to a string, an attempt will be made to convert it into an instance of SecurityCompromise.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

status¶: A VocabString property. If set to a string, an attempt will be made to convert it to an instance of IncidentStatus.

time¶: Time section of the Incident. This is a time.Time field.

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

victims¶: A collection of victim Identity objects. This behaves like a MutableSequence type.

class stix.incident.AttributedThreatActors(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.incident.LeveragedTTPs(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.incident.RelatedIndicators(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.incident.RelatedObservables(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.incident.RelatedIncidents(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.incident.affected_asset` Module¶

Classes¶

class stix.incident.affected_asset.AffectedAsset¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

class stix.incident.affected_asset.AssetType(value=None, count_affected=None)¶

Bases: stix.common.vocabs.VocabString

is_plain()¶: Override VocabString.is_plain()

Version: 1.2.0.0

`stix.incident.coa` Module¶

Classes¶

class stix.incident.coa.COATaken(course_of_action=None)¶: Bases: stix.base.Entity

class stix.incident.coa.COARequested(course_of_action=None)¶: Bases: stix.incident.coa.COATaken

class stix.incident.coa.COATime(start=None, end=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.contributors` Module¶

Classes¶

class stix.incident.contributors.Contributors(*args)¶: Bases: stix.base.EntityList

Version: 1.2.0.0

`stix.incident.direct_impact_summary` Module¶

Classes¶

class stix.incident.direct_impact_summary.DirectImpactSummary¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.external_id` Module¶

Classes¶

class stix.incident.external_id.ExternalID(value=None, source=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.history` Module¶

Classes¶

class stix.incident.history.History(*args)¶: Bases: stix.base.EntityList

class stix.incident.history.HistoryItem¶: Bases: stix.base.Entity

class stix.incident.history.JournalEntry(value=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.impact_assessment` Module¶

Classes¶

class stix.incident.impact_assessment.ImpactAssessment¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.indirect_impact_summary` Module¶

Classes¶

class stix.incident.indirect_impact_summary.IndirectImpactSummary¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.loss_estimation` Module¶

Classes¶

class stix.incident.loss_estimation.LossEstimation¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.property_affected` Module¶

Classes¶

class stix.incident.property_affected.PropertyAffected¶

Bases: stix.base.Entity

description_of_effect¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

class stix.incident.property_affected.NonPublicDataCompromised(value=None, data_encrypted=None)¶: Bases: stix.common.vocabs.VocabString

Version: 1.2.0.0

`stix.incident.time` Module¶

Classes¶

class stix.incident.time.Time(first_malicious_action=None, initial_compromise=None, first_data_exfiltration=None, incident_discovery=None, incident_opened=None, containment_achieved=None, restoration_achieved=None, incident_reported=None, incident_closed=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.incident.total_loss_estimation` Module¶

Classes¶

class stix.incident.total_loss_estimation.TotalLossEstimation¶: Bases: stix.base.Entity

STIX Indicator¶

Modules located in the stix.indicator package

Version: 1.2.0.0

`stix.indicator.indicator` Module¶

Overview¶

The stix.indicator.indicator module implements IndicatorType STIX Language construct. The IndicatorType characterizes a cyber threat indicator made up of a pattern identifying certain observable conditions as well as contextual information about the patterns meaning, how and when it should be acted on, etc.

Documentation Resources¶

Classes¶

class stix.indicator.indicator.Indicator(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of the STIX Indicator.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
title (optional) – A string title.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description (optional) – A string description.
short_description (optional) – A string short description.

add_alternative_id(value)¶

Adds an alternative id to the alternative_id list property.

Note

If None is passed in no value is added to the alternative_id list property.

Parameters:	value – An identifier value.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_indicated_ttp(v)¶

Adds an Indicated TTP to the indicated_ttps list property of this Indicator.

The v parameter must be an instance of stix.common.related.RelatedTTP or stix.ttp.TTP.

If the v parameter is None, no item wil be added to the indicated_ttps list property.

Note

If the v parameter is not an instance of stix.common.related.RelatedTTP an attempt will be made to convert it to one.

Parameters:	v – An instance of `stix.common.related.RelatedTTP` or `stix.ttp.TTP`.
Raises:	`ValueError` – If the v parameter cannot be converted into an instance of `stix.common.related.RelatedTTP`

add_indicator_type(value)¶

Adds a value to the indicator_types list property.

The value parameter can be a str or an instance of stix.common.vocabs.VocabString.

Note

If the value parameter is a str instance, an attempt will be made to convert it into an instance of stix.common.vocabs.IndicatorType

Parameters:	value – An instance of `stix.common.vocabs.VocabString` or `str`.
Raises:	`ValueError` – If the value param is a `str` instance that cannot be converted into an instance of `stix.common.vocabs.IndicatorType`.

add_kill_chain_phase(value)¶

Add a new Kill Chain Phase reference to this Indicator.

Parameters:	value – a `stix.common.kill_chains.KillChainPhase` or a str representing the phase_id of. Note that you if you are defining a custom Kill Chain, you need to add it to the STIX package separately.

add_object(object_)¶

Adds a python-cybox Object instance to the observables list property.

This is the same as calling indicator.add_observable(object_).

Note

If the object param is not an instance of cybox.core.Object an attempt will be made to to convert it into one before wrapping it in an cybox.core.Observable layer.

Parameters:	object_ – An instance of `cybox.core.Object` or an object that can be converted into an instance of `cybox.core.Observable`
Raises:	`ValueError` – if the object_ param cannot be converted to an instance of `cybox.core.Observable`.

add_observable(observable)¶

Adds an observable to the observables list property of the Indicator.

If the observable parameter is None, no item will be added to the observables list.

Note

The STIX Language dictates that an Indicator can have only one Observable under it. Because of this, the to_xml() method will convert the observables list into an cybox.core.ObservableComposition instance, in which each item in the observables list will be added to the composition. By default, the operator of the composition layer will be set to "OR". The operator value can be changed via the observable_composition_operator property.

Parameters:	observable – An instance of `cybox.core.Observable` or an object type that can be converted into one.
Raises:	`ValueError` – If the observable param cannot be converted into an instance of `cybox.core.Observable`.

add_related_campaign(value)¶

Adds a Related Campaign to this Indicator.

The value parameter must be an instance of RelatedCampaignRef or CampaignRef.

If the value parameter is None, no item wil be added to the related_campaigns collection.

Calling this method is the same as calling append() on the related_campaigns property.

See also

The RelatedCampaignRef documentation.

Note

If the value parameter is not an instance of RelatedCampaignRef an attempt will be made to convert it to one.

Parameters:	value – An instance of `RelatedCampaignRef` or `Campaign`.
Raises:	`ValueError` – If the value parameter cannot be converted into an instance of `RelatedCampaignRef`

add_related_indicator(indicator)¶

Adds an Related Indicator to the related_indicators list property of this Indicator.

The indicator parameter must be an instance of stix.common.related.RelatedIndicator or Indicator.

If the indicator parameter is None, no item wil be added to the related_indicators list property.

Calling this method is the same as calling append() on the related_indicators proeprty.

See also

The RelatedIndicators documentation.

Note

If the tm parameter is not an instance of stix.common.related.RelatedIndicator an attempt will be made to convert it to one.

Parameters:	indicator – An instance of `Indicator` or `stix.common.related.RelatedIndicator`.
Raises:	`ValueError` – If the indicator parameter cannot be converted into an instance of `stix.common.related.RelatedIndicator`

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

add_test_mechanism(tm)¶

Adds an Test Mechanism to the test_mechanisms list property of this Indicator.

The tm parameter must be an instance of a stix.indicator.test_mechanism._BaseTestMechanism implementation.

If the tm parameter is None, no item will be added to the test_mechanisms list property.

See also

Test Mechanism implementations are found under the stix.extensions.test_mechanism package.

Parameters:	tm – An instance of a `stix.indicator.test_mechanism._BaseTestMechanism` implementation.
Raises:	`ValueError` – If the tm parameter is not an instance of `stix.indicator.test_mechanism._BaseTestMechanism`

add_valid_time_position(value)¶

Adds an valid time position to the valid_time_positions property list.

If value is None, no item is added to the value_time_positions list.

Parameters:	value – An instance of `stix.indicator.valid_time.ValidTime`.
Raises:	`ValueError` – If the value argument is not an instance of `stix.indicator.valid_time.ValidTime`.

alternative_id¶

An alternative identifi er for this Indicator

This property can be set to a single string identifier or a list of identifiers. If set to a single object, the object will be inserted into an empty list internally.

Default Value: Empty list

Returns:	A list of alternative ids.

confidence¶

The confidence for this Indicator.

This property can be set to an instance of str, stix.common.vocabs.VocabString, or stix.common.confidence.Confidence.

Default Value: None

Note

If set to an instance of str or stix.common.vocabs.VocabString, that value will be wrapped in an instance of stix.common.confidence.Confidence.

Returns:	An instance of of `stix.common.confidence.Confidence`.
Raises:	`ValueError` – If set to a `str` value that cannot be converted into an instance of `stix.common.confidence.Confidence`.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

get_produced_time()¶

Gets the produced time for this Indicator.

This is the same as calling produced_time = indicator.producer.time.produced_time.

Returns:	`None` or an instance of `cybox.common.DateTimeWithPrecision`.

get_received_time()¶

Gets the received time for this Indicator.

This is the same as calling received_time = indicator.producer.time.received_time.

Returns:	`None` or an instance of `cybox.common.DateTimeWithPrecision`.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

indicator_types¶

A list of indicator types for this Indicator.

This property can be set to lists or single instances of str or stix.common.vocabs.VocabString or an instance of IndicatorTypes.

Note

If an instance of str is passed in (or a list containing str values) an attempt will be made to convert that string value to an instance of stix.common.vocabs.IndicatorType.

Default Value: An empty IndicatorTypes instance.

See also

Documentation for IndicatorTypes.

Returns:	An instance of `IndicatorTypes`.

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

observable¶

A convenience property for accessing or setting the only cybox.core.Observable instance held by this Indicator.

Default Value: Empty list.

Setting this property results in the observables property being reinitialized to an empty list and appending the input value, resulting in a list containing one value.

Note

If the observables list contains more than one item, this property will only return the first item in the list.

Returns:	An instance of `cybox.core.Observable`.
Raises:	`ValueError` – If set to a value that cannot be converted to an instance of `cybox.core.Observable`.

observables¶

A list of cybox.core.Observable instances. This can be set to a single object instance or a list of objects.

Note

If the input value or values are not instance(s) of cybox.core.Observable, an attempt will be made to convert the value to an instance of cybox.core.Observable.

Default Value: Empty list

Returns:	A `list` of `cybox.core.Observable` instances.
Raises:	`ValueError` – If set to a value that cannot be converted to an instance of `cybox.core.Observable`.

producer¶

Contains information about the source of the Indicator.

Default Value: None

Returns:	An instance of `stix.common.information_source.InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `stix.common.information_source.InformationSource`

set_produced_time(produced_time)¶

Sets the produced_time property of the producer property instance fo produced_time.

This is the same as calling indicator.producer.time.produced_time = produced_time.

The produced_time parameter must be an instance of str, datetime.datetime, or cybox.common.DateTimeWithPrecision.

Note

If produced_time is a str or datetime.datetime instance an attempt will be made to convert it into an instance of cybox.common.DateTimeWithPrecision.

Parameters:	produced_time – An instance of `str`, `datetime.datetime`, or `cybox.common.DateTimeWithPrecision`.

set_producer_identity(identity)¶

Sets the name of the producer of this indicator.

This is the same as calling indicator.producer.identity.name = identity.

If the producer property is None, it will be initialized to an instance of stix.common.information_source.InformationSource.

If the identity property of the producer instance is None, it will be initialized to an instance of stix.common.identity.Identity.

Note

if the identity parameter is not an instance stix.common.identity.Identity an attempt will be made to convert it to one.

Parameters:	identity – An instance of `str` or `stix.common.identity.Identity`.

set_received_time(received_time)¶

Sets the received time for this Indicator.

This is the same as calling indicator.producer.time.produced_time = produced_time.

The received_time parameter must be an instance of str, datetime.datetime, or cybox.common.DateTimeWithPrecision.

Parameters:	received_time – An instance of `str`, `datetime.datetime`, or `cybox.common.DateTimeWithPrecision`.

Note

If received_time is a str or datetime.datetime instance an attempt will be made to convert it into an instance of cybox.common.DateTimeWithPrecision.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

valid_time_positions¶

A list of valid time positions for this Indicator.

This property can be set to a single instance or a list of stix.indicator.valid_time.ValidTime instances. If set to a single instance, that object is converted into a list containing one item.

Default Value: Empty list

Returns:	A list of `stix.indicator.valid_time.ValidTime` instances.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

class stix.indicator.indicator.CompositeIndicatorExpression(operator='OR', *args)¶

Bases: stix.base.EntityList

Implementation of the STIX CompositeIndicatorExpressionType.

The CompositeIndicatorExpression class implements methods found on collections.MutableSequence and as such can be interacted with as a list (e.g., append()).

Note

The append() method can only accept instances of Indicator.

Examples

Add a Indicator instance to an instance of CompositeIndicatorExpression:

>>> i = Indicator()
>>> comp = CompositeIndicatorExpression()
>>> comp.append(i)

Create a CompositeIndicatorExpression from a list of Indicator instances using *args argument list:

>>> list_indicators = [Indicator() for i in xrange(10)]
>>> comp = CompositeIndicatorExpression(CompositeIndicatorExpression.OP_OR, *list_indicators)
>>> len(comp)
10

Parameters:	operator (str, optional) – The logical composition operator. Must be `"AND"` or `"OR"`. *args – Variable length argument list of `Indicator` instances.

OP_AND str¶: String "AND"

OP_OR str¶: String "OR"

OPERATORS tuple¶: Tuple of allowed operator values.

operator str¶: The logical composition operator. Must be "AND" or "OR".

class stix.indicator.indicator.RelatedIndicators(related_indicators=None, scope=None)¶

Bases: stix.common.related.GenericRelationshipList

The RelatedIndicators class provides functionality for adding stix.common.related.RelatedIndicator instances to an Indicator instance.

The RelatedIndicators class implements methods found on collections.MutableSequence and as such can be interacted with as a list (e.g., append()).

The append() method can accept instances of stix.common.related.RelatedIndicator or Indicator as an argument.

Note

Calling append() with an instance of stix.coa.CourseOfAction will wrap that instance in a stix.common.related.RelatedIndicator layer, with item set to the Indicator instance.

Examples

Append an instance of Indicator to the Indicator.related_indicators property. The instance of Indicator will be wrapped in an instance of stix.common.related.RelatedIndicator:

>>> related = Indicator()
>>> parent_indicator = Indicator()
>>> parent_indicator.related_indicators.append(related)
>>> print type(indicator.related_indicators[0])
<class 'stix.common.related.RelatedIndicator'>

Iterate over the related_indicators property of an Indicator instance and print the ids of each underlying Indicator` instance:

>>> for related in indicator.related_indicators:
>>>     print related.item.id_

Parameters:	related_indicators (list, optional) – A list of `Indicator` or `stix.common.related.RelatedIndicator` instances. scope (str, optional) – The scope of the items. Can be set to `"inclusive"` or `"exclusive"`. See `stix.common.related.GenericRelationshipList` documentation for more information.

scope str¶: The scope of the items. Can be set to "inclusive" or "exclusive". See stix.common.related.GenericRelationshipList documentation for more information.

class stix.indicator.indicator.RelatedCampaignRefs(related_campaign_refs=None, scope=None)¶: Bases: stix.common.related.GenericRelationshipList

class stix.indicator.indicator.SuggestedCOAs(suggested_coas=None, scope=None)¶

Bases: stix.common.related.GenericRelationshipList

The SuggestedCOAs class provides functionality for adding stix.common.related.RelatedCOA instances to an Indicator instance.

The SuggestedCOAs class implements methods found on collections.MutableSequence and as such can be interacted with as a list (e.g., append()).

The append() method can accept instances of stix.common.related.RelatedCOA or stix.coa.CourseOfAction as an argument.

Note

Calling append() with an instance of stix.coa.CourseOfAction will wrap that instance in a stix.common.related.RelatedCOA layer, with the item set to the stix.coa.CourseOfAction instance.

Examples

Append an instance of stix.coa.CourseOfAction to the Indicator.suggested_coas property. The instance of stix.coa.CourseOfAction will be wrapped in an instance of stix.common.related.RelatedCOA.

>>> coa = CourseOfAction()
>>> indicator = Indicator()
>>> indicator.suggested_coas.append(coa)
>>> print type(indicator.suggested_coas[0])
<class 'stix.common.related.RelatedCOA'>

Iterate over the suggested_coas property of an Indicator instance and print the ids of each underlying stix.coa.CourseOfAction instance.

>>> for related_coa in indicator.suggested_coas:
>>>     print related_coa.item.id_

Parameters:	suggested_coas (list) – A list of `stix.coa.CourseOfAction` or `stix.common.related.RelatedCOA` instances. scope (str) – The scope of the items. Can be set to `"inclusive"` or `"exclusive"`. See `stix.common.related.GenericRelationshipList` documentation for more information.

scope str¶: The scope of the items. Can be set to "inclusive" or "exclusive". See stix.common.related.GenericRelationshipList documentation for more information.

class stix.indicator.indicator.IndicatorTypes(*args)¶

Bases: stix.base.TypedList

A stix.common.vocabs.VocabString collection which defaults to stix.common.vocabs.IndicatorType. This class implements methods found on collections.MutableSequence and as such can be interacted with like a list.

Note

The append() method can accept str or stix.common.vocabs.VocabString instances. If a str instance is passed in, an attempt will be made to convert it to an instance of stix.common.vocabs.IndicatorType.

Examples

Add an instance of stix.common.vocabs.IndicatorType:

>>> from stix.common.vocabs import IndicatorType
>>> itypes = IndicatorTypes()
>>> type_ = IndicatorType(IndicatorType.TERM_IP_WATCHLIST)
>>> itypes.append(type_)
>>> print len(itypes)
1

Add a string value:

>>> from stix.common.vocabs import IndicatorType
>>> itypes = IndicatorTypes()
>>> type(IndicatorType.TERM_IP_WATCHLIST)
<type 'str'>
>>> itypes.append(IndicatorType.TERM_IP_WATCHLIST)
>>> print len(itypes)
1

Parameters:	*args – Variable length argument list of strings or `stix.common.vocabs.VocabString` instances.

Version: 1.2.0.0

`stix.indicator.sightings` Module¶

Classes¶

class stix.indicator.sightings.Sighting(timestamp=None, timestamp_precision=None, description=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

class stix.indicator.sightings.Sightings(sightings_count=None, *args)¶: Bases: stix.base.EntityList

class stix.indicator.sightings.RelatedObservables(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.indicator.test_mechanism` Module¶

Classes¶

class stix.indicator.test_mechanism._BaseTestMechanism(id_=None, idref=None)¶: Bases: stix.base.Entity

Functions¶

stix.indicator.test_mechanism.add_extension(cls)¶

Registers a stix.Entity class as an implementation of an xml type.

Classes must have an _XSI_TYPE class attributes to be registered. The value of this attribute must be a valid xsi:type.

Note

This was designed for internal use.

Version: 1.2.0.0

`stix.indicator.valid_time` Module¶

Classes¶

class stix.indicator.valid_time.ValidTime(start_time=None, end_time=None)¶: Bases: stix.base.Entity

STIX Report¶

Modules located in the stix.report package

Version: 1.2.0.0

`stix.report` Module¶

Overview¶

The stix.report module implements Report.

A Report defines a contextual wrapper for a grouping of STIX content.

Documentation Resources¶

Report Data Model

Classes¶

class stix.report.Report(id_=None, idref=None, timestamp=None, header=None, courses_of_action=None, exploit_targets=None, indicators=None, observables=None, incidents=None, threat_actors=None, ttps=None, campaigns=None, related_reports=None)¶

Bases: stix.base.Entity

A STIX Report Object.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
header – A Report Header object.
campaigns – A collection of Campaign objects.
course_of_action – A collection of CourseOfAction objects.
exploit_targets – A collection of ExploitTarget objects.
incidents – A collection of Incident objects.
indicators – A collection of Indicator objects.
threat_actors – A collection of ThreatActor objects.
ttps – A collection of TTP objects.
related_reports – A collection of RelatedReport objects.

add(entity)¶: Adds entity to a top-level collection. For example, if entity is an Indicator object, the entity will be added to the indicators top-level collection.

add_campaign(campaign)¶: Adds a Campaign object to the campaigns collection.

add_course_of_action(course_of_action)¶: Adds an CourseOfAction object to the courses_of_action collection.

add_exploit_target(exploit_target)¶: Adds an ExploitTarget object to the exploit_targets collection.

add_incident(incident)¶: Adds an Incident object to the incidents collection.

add_indicator(indicator)¶: Adds an Indicator object to the indicators collection.

add_observable(observable)¶

Adds an Observable object to the observables collection.

If observable is not an Observable instance, an effort will be made to convert it to one.

add_related_report(related_report)¶: Adds an RelatedReport object to the related_reports collection.

add_threat_actor(threat_actor)¶: Adds an ThreatActor object to the threat_actors collection.

add_ttp(ttp)¶: Adds an TTP object to the ttps collection.

campaigns¶: The top-level Campaign collection. This behaves like a MutableSequence type.

courses_of_action¶: The top-level CourseOfAction collection. This behaves like a MutableSequence type.

exploit_targets¶: The top-level ExploitTarget collection. This behaves like a MutableSequence type.

header¶: The Header section for the Report.

id_¶: A globally unique identifier for this Report. By default, one will be generated automatically.

idref¶: A reference to another Report identifier. Setting this will unset any previous id values.

incidents¶: The top-level Incident collection. This behaves like a MutableSequence type.

indicators¶: The top-level Indicator collection. This behaves like a MutableSequence type.

observables¶: The top-level Observable collection. This behaves like a MutableSequence type.

related_reports¶: The top-level RelatedReports collection. This behaves like a MutableSequence type.

threat_actors¶: The top-level ThreatActor collection. This behaves like a MutableSequence type.

timestamp¶: Specifies a timestamp for the definition of this specific Report object.

ttps¶: The top-level TTP collection. This behaves like a MutableSequence type.

Version: 1.2.0.0

`stix.report.header` Module¶

Classes¶

class stix.report.header.Header(title=None, description=None, short_description=None, handling=None, intents=None, information_source=None)¶

Bases: stix.base.Entity

The Report Header.

Parameters:

handling – The data marking section of the Header.
information_source – The InformationSource section of the Header.
intents – A collection of VocabString defining the intent of the parent Report.
description – A description of the intent or purpose of the parent Report.
short_description – A short description of the intent or purpose of the parent Report.
title – The title of the Report.

title¶: The title of the parent Report.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_intent(intent)¶

Adds VocabString object to the intents collection.

If the input is not an instance of VocabString, an effort will be made to convert it into an instance of ReportIntent.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

handling¶: The Marking section of this Header. This section contains data marking information.

information_source¶: The InformationSource section of the Header.

intents¶: A collection of VocabString controlled vocabulary objects.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

STIX Threat Actor¶

Modules located in the stix.threat_actor package

Version: 1.2.0.0

`stix.threat_actor` Module¶

Overview¶

The stix.threat_actor module implements ThreatActor.

ThreatActors are characterizations of malicious actors (or adversaries) representing a cyber attack threat including presumed intent and historically observed behavior.

Documentation Resources¶

Threat Actor Data Model

Classes¶

class stix.threat_actor.ThreatActor(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of the STIX Threat Actor.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description – A description of the purpose or intent of this object.
short_description – A short description of the intent or purpose of this object.
title – The title of this object.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_intended_effect(value)¶

Adds a Statement object to the intended_effects collection.

If value is a string, an attempt will be made to convert it into an instance of Statement.

add_motivation(value)¶: Adds a Motivation object to the motivations collection.

add_planning_and_operational_support(value)¶

Adds a VocabString object to the planning_and_operational_supports collection.

If value is a string, an attempt will be made to convert it to an instance of PlanningAndOperationalSupport.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

add_sophistication(value)¶

Adds a VocabString object to the sophistications collection.

If value is a string, an attempt will be made to convert it to an instance of ThreatActorSophistication.

add_type(value)¶

Adds a VocabString object to the types collection.

If set to a string, an attempt will be made to convert it into an instance of ThreatActorType.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

identity¶: A Identity field characterizing information about the threat actor.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

intended_effects¶

A collection of Statement objects. This behaves like a MutableSequence type.

If set to a string, an attempt will be made to convert it into a Statement object with its value set to an instance of IntendedEffect.

motivations¶

A collection of VocabString objects. Default is Motivation.

This behaves like a MutableSequence type.

planning_and_operational_supports¶

A collection of VocabString objects. Default is PlanningAndOperationalSupport.

This behaves like a MutableSequence type.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

sophistications¶

A collection of VocabString objects. Default is ThreatActorSophistication.

This behaves like a MutableSequence type.

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

types¶

A collection of VocabString objects. Default is ThreatActorType.

This behaves like a MutableSequence type.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

class stix.threat_actor.AssociatedActors(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.threat_actor.AssociatedCampaigns(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

class stix.threat_actor.ObservedTTPs(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

STIX Tactics, Techniques, and Procedures (TTP)¶

Modules located in the stix.ttp package

Version: 1.2.0.0

`stix.ttp` Module¶

Overview¶

The stix.ttp module implements TTP.

TTPs are representations of the behavior or modus operandi of cyber adversaries.

Documentation Resources¶

TTP Data Model

Classes¶

class stix.ttp.TTP(id_=None, idref=None, timestamp=None, title=None, description=None, short_description=None)¶

Bases: stix.base.BaseCoreComponent

Implementation of the STIX TTP.

Parameters:

id_ (optional) – An identifier. If None, a value will be generated via stix.utils.create_id(). If set, this will unset the idref property.
idref (optional) – An identifier reference. If set this will unset the id_ property.
timestamp (optional) – A timestamp value. Can be an instance of datetime.datetime or str.
description – A description of the purpose or intent of this object.
short_description – A short description of the intent or purpose of this object.
title – The title of this object.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_intended_effect(value)¶

Adds a Statement object to the intended_effects collection.

If value is a string, an attempt will be made to convert it into an instance of Statement.

add_kill_chain_phase(value)¶

Adds a KillChainPhaseReference to the kill_chain_phases collection.

Parameters:	value – A `KillChainPhase`, `KillChainPhaseReference` or a `str` representing the phase_id of. Note that you if you are defining a custom Kill Chain, you need to add it to the STIX package separately.

add_related_package(value)¶

Adds a RelatedPackageRef object to the related_packages collection.

Parameters:	value – A `RelatedPackageRef` or a `STIXPackage` object.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

behavior¶: A Behavior field.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

exploit_targets¶: A collection of ExploitTarget objects. This behaves like a MutableSequence type.

find(id_)¶: Searches the children of a Entity implementation for an object with an id_ property that matches id_.

id_¶

The id_ property serves as an identifier. This is automatically set during __init__().

Default Value: None

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	A string id.

idref¶

The idref property must be set to the id_ value of another object instance of the same type. An idref does not need to resolve to a local object instance.

Default Value: None.

Note

Both the id_ and idref properties cannot be set at the same time. Setting one will unset the other!

Returns:	The value of the `idref` property

information_source¶

Contains information about the source of this object.

Default Value: None

Returns:	An instance of `InformationSource`
Raises:	`ValueError` – If set to a value that is not `None` and not an instance of `InformationSource`

intended_effects¶

A collection of Statement objects. This behaves like a MutableSequence type.

If set to a string, an attempt will be made to convert it into a Statement object with its value set to an instance of IntendedEffect.

kill_chain_phases¶: A collection of KillChainPhaseReference objects. This behaves like a MutableSequence type.

related_packages¶: DEPRECATED: A collection of RelatedPackageRef objects. This behaves like a MutableSequence.

related_ttps¶: A collection of RelatedTTP objects. This behaves like a MutableSequence Type.

resources¶: A collection of Resource objects. This behaves like a MutableSequence type.

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

timestamp¶

The timestam property declares the time of creation and is automatically set in __init__().

This property can accept datetime.datetime or str values. If an str value is supplied, a best-effort attempt is made to parse it into an instance of datetime.datetime.

Default Value: A datetime.dateime instance with a value of the date/time when __init__() was called.

Note

If an idref is set during __init__(), the value of timestamp will not automatically generated and instead default to the timestamp parameter, which has a default value of None.

Returns:	An instance of `datetime.datetime`.

version¶

The schematic version of this component. This property will always return None unless it is set to a value different than self.__class__._version.

Note

This property refers to the version of the schema component type and should not be used for the purpose of content versioning.

Default Value: None

Returns:	The value of the `version` property if set to a value different than `self.__class__._version`

victim_targeting¶: A collection of VictimTargeting objects. This behaves like a MutableSequence type.

Version: 1.2.0.0

`stix.ttp.attack_pattern` Module¶

Classes¶

class stix.ttp.attack_pattern.AttackPattern(id_=None, title=None, description=None, short_description=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Version: 1.2.0.0

`stix.ttp.behavior` Module¶

Classes¶

class stix.ttp.behavior.Behavior(malware_instances=None, attack_patterns=None, exploits=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.ttp.exploit` Module¶

Classes¶

class stix.ttp.exploit.Exploit(id_=None, title=None, description=None, short_description=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Version: 1.2.0.0

`stix.ttp.exploit_targets` Module¶

Classes¶

class stix.ttp.exploit_targets.ExploitTargets(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.ttp.infrastructure` Module¶

Classes¶

class stix.ttp.infrastructure.Infrastructure(id_=None, title=None, description=None, short_description=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Version: 1.2.0.0

`stix.ttp.malware_instance` Module¶

Classes¶

class stix.ttp.malware_instance.MalwareInstance(id_=None, title=None, description=None, short_description=None)¶

Bases: stix.base.Entity

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of `StructuredText`

descriptions¶

A StructuredTextList object, containing descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of `StructuredTextList`

short_description¶

“A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of – class:.StructuredText

short_descriptions¶

A StructuredTextList object, containing short descriptions about the purpose or intent of this object.

This is typically used for the purpose of providing multiple short descriptions with different classificaton markings.

Iterating over this object will yield its contents sorted by their ordinality value.

Default Value: Empty StructuredTextList object.

Note

IF this is set to a value that is not an instance of StructuredText, an effort will ne made to convert it. If this is set to an iterable, any values contained that are not an instance of StructuredText will be be converted.

Returns:	An instance of – class:.StructuredTextList

Functions¶

stix.ttp.malware_instance.add_extension(cls)¶

Registers a stix.Entity class as an implementation of an xml type.

Classes must have an _XSI_TYPE class attributes to be registered. The value of this attribute must be a valid xsi:type.

Note

This was designed for internal use.

Version: 1.2.0.0

`stix.ttp.related_ttps` Module¶

Classes¶

class stix.ttp.related_ttps.RelatedTTPs(scope=None, *args)¶: Bases: stix.common.related.GenericRelationshipList

Version: 1.2.0.0

`stix.ttp.resource` Module¶

Classes¶

class stix.ttp.resource.Resource(tools=None, infrastructure=None, personas=None)¶: Bases: stix.base.Entity

Version: 1.2.0.0

`stix.ttp.victim_targeting` Module¶

Classes¶

class stix.ttp.victim_targeting.VictimTargeting¶: Bases: stix.base.Entity

STIX Utils¶

Modules located in the stix.utils package

Version: 1.2.0.0

`stix.utils` Module¶

Functions¶

stix.utils.is_cdata(text)¶

Returns True if text contains a CDATA block.

Example

>>> is_cdata("<![CDATA[Foo]]>")
True
>>> is_cdata("NOPE")
False

stix.utils.strip_cdata(text)¶

Removes all CDATA blocks from text if it contains them.

Note

If the function contains escaped XML characters outside of a CDATA block, they will be unescaped.

Parameters:	A string containing one or more CDATA blocks.
Returns:	An XML unescaped string with CDATA block qualifiers removed.

stix.utils.cdata(text)¶

Wraps the input text in a <![CDATA[ ]]> block.

If the text contains CDATA sections already, they are stripped and replaced by the application of an outer-most CDATA block.

Parameters:	text – A string to wrap in a CDATA block.
Returns:	The text value wrapped in `<![CDATA[]]>`

stix.utils.raise_warnings(func)¶

Function decorator that causes all Python warnings to be raised as exceptions in the wrapped function.

Example

>>> @raise_warnings
>>> def foo():
>>>     warnings.warn("this will raise an exception")

stix.utils.silence_warnings(func)¶

Function decorator that silences/ignores all Python warnings in the wrapped function.

Example

>>> @silence_warnings
>>> def foo():
>>>     warnings.warn("this will not appear")

stix.utils.xml_bool(value)¶: Returns True if value is an acceptable xs:boolean True value. Returns False if value is an acceptable xs:boolean False value. If value is None, this function will return None.

Version: 1.2.0.0

`stix.utils.dates` Module¶

Functions¶

stix.utils.dates.parse_value(value)¶

Attempts to parse value into an instance of datetime.datetime. If value is None, this function will return None.

Parameters:	value – A timestamp. This can be a string or datetime.datetime value.

stix.utils.dates.serialize_value(value)¶

Attempts to convert value into an ISO8601-compliant timestamp string. If value is None, None will be returned.

Parameters:	value – A datetime.datetime value.
Returns:	An ISO8601 formatted timestamp string.

stix.utils.dates.parse_date(value)¶

Attempts to parse value into an instance of datetime.date. If value is None, this function will return None.

Parameters:	value – A timestamp. This can be a string, datetime.date, or datetime.datetime value.

stix.utils.dates.serialize_value(value)

Attempts to convert value into an ISO8601-compliant timestamp string. If value is None, None will be returned.

Parameters:	value – A datetime.datetime value.
Returns:	An ISO8601 formatted timestamp string.

stix.utils.dates.now()¶: Returns the current UTC datetime.datetime timestamp.

Version: 1.2.0.0

`stix.utils.idgen` Module¶

Classes¶

class stix.utils.idgen.IDGenerator(namespace=None, method=1)¶

Bases: object

Utility class for generating STIX ids

create_id(prefix='guid')¶

Create an ID.

Note that if prefix is not provided, it will be quid, even if the method is METHOD_INT.

class stix.utils.idgen.InvalidMethodError(method)¶: Bases: exceptions.ValueError

Functions¶

stix.utils.idgen._get_generator()¶

Return the stix.utils module’s generator object.

Only under rare circumstances should this function be called by external code. More likely, external code should initialize its own IDGenerator or use the set_id_namespace, set_id_method, or create_id functions of the stix.utils module.

stix.utils.idgen.set_id_namespace(namespace)¶: Set the namespace for the module-level ID Generator

stix.utils.idgen.set_id_method(method)¶: Set the method for the module-level ID Generator

stix.utils.idgen.get_id_namespace()¶: Return the namespace associated with generated ids

stix.utils.idgen.get_id_namespace_alias()¶: Returns the namespace alias assoicated with generated ids

stix.utils.idgen.create_id(prefix=None)¶: Create an ID using the module-level ID Generator

Constants¶

stix.utils.idgen.__generator = None¶

stix.utils.idgen.EXAMPLE_NAMESPACE = {'http://example.com': 'example'}¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Version: 1.2.0.0

`stix.utils.nsparser` Module¶

Classes¶

class stix.utils.nsparser.NamespaceParser¶: Bases: object

Constants¶

stix.utils.nsparser.XML_NAMESPACES = {'http://www.w3.org/2000/09/xmldsig#': 'ds', 'http://www.w3.org/1999/xlink': 'xlink', 'http://www.w3.org/2001/XMLSchema': 'xs', 'http://www.w3.org/2001/XMLSchema-instance': 'xsi'}¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

stix.utils.nsparser.STIX_NS_TO_SCHEMALOCATION = {'http://stix.mitre.org/extensions/StructuredCOA#Generic-1': 'http://stix.mitre.org/XMLSchema/extensions/structured_coa/generic/1.2/generic_structured_coa.xsd', 'http://stix.mitre.org/extensions/Malware#MAEC4.1-1': 'http://stix.mitre.org/XMLSchema/extensions/malware/maec_4.1/1.1/maec_4.1_malware.xsd', 'http://data-marking.mitre.org/extensions/MarkingStructure#Terms_Of_Use-1': 'http://stix.mitre.org/XMLSchema/extensions/marking/terms_of_use/1.1/terms_of_use_marking.xsd', 'http://stix.mitre.org/common-1': 'http://stix.mitre.org/XMLSchema/common/1.2/stix_common.xsd', 'http://stix.mitre.org/extensions/TestMechanism#OVAL5.10-1': 'http://stix.mitre.org/XMLSchema/extensions/test_mechanism/oval_5.10/1.2/oval_5.10_test_mechanism.xsd', 'http://stix.mitre.org/extensions/Vulnerability#CVRF-1': 'http://stix.mitre.org/XMLSchema/extensions/vulnerability/cvrf_1.1/1.2/cvrf_1.1_vulnerability.xsd', 'http://data-marking.mitre.org/extensions/MarkingStructure#TLP-1': 'http://stix.mitre.org/XMLSchema/extensions/marking/tlp/1.2/tlp_marking.xsd', 'http://stix.mitre.org/extensions/AP#CAPEC2.7-1': 'http://stix.mitre.org/XMLSchema/extensions/attack_pattern/capec_2.7/1.1/capec_2.7_attack_pattern.xsd', 'http://stix.mitre.org/CourseOfAction-1': 'http://stix.mitre.org/XMLSchema/course_of_action/1.2/course_of_action.xsd', 'http://stix.mitre.org/stix-1': 'http://stix.mitre.org/XMLSchema/core/1.2/stix_core.xsd', 'http://data-marking.mitre.org/Marking-1': 'http://stix.mitre.org/XMLSchema/data_marking/1.2/data_marking.xsd', 'http://stix.mitre.org/extensions/TestMechanism#YARA-1': 'http://stix.mitre.org/XMLSchema/extensions/test_mechanism/yara/1.2/yara_test_mechanism.xsd', 'http://stix.mitre.org/extensions/TestMechanism#Generic-1': 'http://stix.mitre.org/XMLSchema/extensions/test_mechanism/generic/1.2/generic_test_mechanism.xsd', 'http://stix.mitre.org/Incident-1': 'http://stix.mitre.org/XMLSchema/incident/1.2/incident.xsd', 'http://stix.mitre.org/ThreatActor-1': 'http://stix.mitre.org/XMLSchema/threat_actor/1.2/threat_actor.xsd', 'http://data-marking.mitre.org/extensions/MarkingStructure#Simple-1': 'http://stix.mitre.org/XMLSchema/extensions/marking/simple/1.2/simple_marking.xsd', 'http://stix.mitre.org/extensions/Address#CIQAddress3.0-1': 'http://stix.mitre.org/XMLSchema/extensions/address/ciq_3.0/1.2/ciq_3.0_address.xsd', 'http://stix.mitre.org/ExploitTarget-1': 'http://stix.mitre.org/XMLSchema/exploit_target/1.2/exploit_target.xsd', 'http://stix.mitre.org/extensions/TestMechanism#OpenIOC2010-1': 'http://stix.mitre.org/XMLSchema/extensions/test_mechanism/open_ioc_2010/1.2/open_ioc_2010_test_mechanism.xsd', 'http://stix.mitre.org/default_vocabularies-1': 'http://stix.mitre.org/XMLSchema/default_vocabularies/1.2.0/stix_default_vocabularies.xsd', 'http://stix.mitre.org/Campaign-1': 'http://stix.mitre.org/XMLSchema/campaign/1.2/campaign.xsd', 'http://stix.mitre.org/TTP-1': 'http://stix.mitre.org/XMLSchema/ttp/1.2/ttp.xsd', 'http://stix.mitre.org/Indicator-2': 'http://stix.mitre.org/XMLSchema/indicator/2.2/indicator.xsd', 'http://stix.mitre.org/extensions/TestMechanism#Snort-1': 'http://stix.mitre.org/XMLSchema/extensions/test_mechanism/snort/1.2/snort_test_mechanism.xsd', 'http://stix.mitre.org/extensions/Identity#CIQIdentity3.0-1': 'http://stix.mitre.org/XMLSchema/extensions/identity/ciq_3.0/1.2/ciq_3.0_identity.xsd', 'http://stix.mitre.org/Report-1': 'http://stix.mitre.org/XMLSchema/report/1.0/report.xsd'}¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

stix.utils.nsparser.EXT_NS_TO_SCHEMALOCATION = {'urn:oasis:names:tc:ciq:xpil:3': 'http://stix.mitre.org/XMLSchema/external/oasis_ciq_3.0/xPIL.xsd', 'urn:oasis:names:tc:ciq:xal:3': 'http://stix.mitre.org/XMLSchema/external/oasis_ciq_3.0/xAL.xsd', 'urn:oasis:names:tc:ciq:xnl:3': 'http://stix.mitre.org/XMLSchema/external/oasis_ciq_3.0/xNL.xsd'}¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

stix.utils.nsparser.DEFAULT_STIX_NS_TO_PREFIX = {'http://stix.mitre.org/extensions/StructuredCOA#Generic-1': 'genericStructuredCOA', 'http://stix.mitre.org/extensions/Malware#MAEC4.1-1': 'stix-maec', 'http://data-marking.mitre.org/extensions/MarkingStructure#Terms_Of_Use-1': 'TOUMarking', 'http://stix.mitre.org/common-1': 'stixCommon', 'http://cybox.mitre.org/common-2': 'cyboxCommon', 'http://stix.mitre.org/extensions/TestMechanism#OVAL5.10-1': 'stix-oval', 'http://stix.mitre.org/extensions/Vulnerability#CVRF-1': 'stix-cvrf', 'http://data-marking.mitre.org/extensions/MarkingStructure#TLP-1': 'tlpMarking', 'http://stix.mitre.org/extensions/AP#CAPEC2.7-1': 'stix-capec', 'http://stix.mitre.org/CourseOfAction-1': 'coa', 'http://stix.mitre.org/stix-1': 'stix', 'http://cybox.mitre.org/cybox-2': 'cybox', 'http://data-marking.mitre.org/Marking-1': 'marking', 'http://stix.mitre.org/extensions/TestMechanism#YARA-1': 'yaraTM', 'http://stix.mitre.org/extensions/TestMechanism#Generic-1': 'genericTM', 'http://stix.mitre.org/Incident-1': 'incident', 'http://stix.mitre.org/ThreatActor-1': 'ta', 'http://data-marking.mitre.org/extensions/MarkingStructure#Simple-1': 'simpleMarking', 'http://stix.mitre.org/extensions/Address#CIQAddress3.0-1': 'stix-ciqaddress', 'http://stix.mitre.org/ExploitTarget-1': 'et', 'http://stix.mitre.org/extensions/TestMechanism#OpenIOC2010-1': 'stix-openioc', 'http://stix.mitre.org/default_vocabularies-1': 'stixVocabs', 'http://stix.mitre.org/Campaign-1': 'campaign', 'http://stix.mitre.org/TTP-1': 'ttp', 'http://stix.mitre.org/Indicator-2': 'indicator', 'http://stix.mitre.org/extensions/TestMechanism#Snort-1': 'snortTM', 'http://stix.mitre.org/extensions/Identity#CIQIdentity3.0-1': 'ciqIdentity', 'http://stix.mitre.org/Report-1': 'report'}¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

stix.utils.nsparser.DEFAULT_EXT_TO_PREFIX = {'http://capec.mitre.org/capec-2': 'capec', 'http://schemas.mandiant.com/2010/ioc/TR/': 'ioc-tr', 'http://schemas.mandiant.com/2010/ioc': 'ioc', 'http://oval.mitre.org/XMLSchema/oval-definitions-5': 'oval-def', 'http://maec.mitre.org/XMLSchema/maec-package-2': 'maecPackage', 'http://oval.mitre.org/XMLSchema/oval-variables-5': 'oval-var', 'http://www.icasi.org/CVRF/schema/cvrf/1.1': 'cvrf', 'urn:oasis:names:tc:ciq:xal:3': 'xal', 'urn:oasis:names:tc:ciq:xnl:3': 'xnl', 'urn:oasis:names:tc:ciq:xpil:3': 'xpil'}¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Version: 1.2.0.0

`stix.utils.parser` Module¶

Classes¶

class stix.utils.parser.UnsupportedVersionError(message, expected=None, found=None)¶

Bases: exceptions.Exception

Raised when a parsed STIX document contains a version that is not supported by this verison of python-stix.

class stix.utils.parser.UnknownVersionError¶

Bases: exceptions.Exception

Raised when a parsed STIX document contains no version information.

stix.utils.parser.UnsupportedRootElement¶: alias of UnsupportedRootElementError

class stix.utils.parser.EntityParser¶

Bases: object

parse_xml(xml_file, check_version=True, check_root=True, encoding=None)¶

Creates a python-stix STIXPackage object from the supplied xml_file.

Parameters:	xml_file – A filename/path or a file-like object representing a STIX instance document check_version – Inspect the version before parsing. check_root – Inspect the root element before parsing. encoding – The character encoding of the input xml_file. If `None`, an attempt will be made to determine the input character encoding.
Raises:	`UnknownVersionError` – If check_version is `True` and xml_file does not contain STIX version information. `UnsupportedVersionError` – If check_version is `False` and xml_file contains an unsupported STIX version. `UnsupportedRootElement` – If check_root is `True` and xml_file contains an invalid root element.

parse_xml_to_obj(xml_file, check_version=True, check_root=True, encoding=None)¶

Creates a STIX binding object from the supplied xml file.

Parameters:	xml_file – A filename/path or a file-like object representing a STIX instance document check_version – Inspect the version before parsing. check_root – Inspect the root element before parsing. encoding – The character encoding of the input xml_file.
Raises:	`UnknownVersionError` – If check_version is `True` and xml_file does not contain STIX version information. `UnsupportedVersionError` – If check_version is `False` and xml_file contains an unsupported STIX version. `UnsupportedRootElement` – If check_root is `True` and xml_file contains an invalid root element.

Version: 1.2.0.0

API Coverage¶

The python-stix APIs currently provide ⚠ partial coverage of all STIX-defined constructs. Development is ongoing toward the goal of providing ✓ full STIX language support in the APIs. Until such time that full coverage is provided, an overview of which constructs are available in these APIs will be maintained below.

Note

Many STIX constructs can contain CybOX constructs. The python-cybox project provides its own APIs for interacting with the CybOX specification. Please see the CybOX API Documentation for information about CybOX API coverage.

STIX Core¶

STIX Construct	API Coverage	Documentation
STIX Package	✓ Full	`stix.core.stix_package.STIXPackage`
STIX Header	✓ Full	`stix.core.stix_header.STIXHeader`
Related Packages	✓ Full	`stix.core.stix_package.RelatedPackages`

STIX Top-level Constructs¶

STIX Construct	API Coverage	Documentation
Campaign	✓ Full	`stix.campaign.Campaign`
Course of Action	✓ Full	`stix.coa.CourseOfAction`
Exploit Target	✓ Full	`stix.exploit_target.ExploitTarget`
Incident	⚠ Partial	`stix.incident.Incident`
Indicator	✓ Full	`stix.indicator.indicator.Indicator`
Observable	Provided by CybOX
Threat Actor	✓ Full	`stix.threat_actor.ThreatActor`
TTP	⚠ Partial	`stix.ttp.TTP`

STIX Features¶

STIX Construct	API Coverage	Documentation
Confidence	⚠ Partial	`stix.common.confidence.Confidence`
Handling	✓ Full	`stix.data_marking.Marking`
Markup in Structured Text	× None
Relationships	✓ Full

STIX Extensions¶

STIX Construct	API Coverage	Documentation
Address Extensions
CIQ Address	× None

Attack Pattern Extensions
CAPEC 2.7	× None

Identity Extensions
CIQ Identity	⚠ Partial	`stix.extensions.identity.ciq_identity_3_0.CIQIdentity3_0Instance`

Malware Extensions
MAEC	✓ Full	`stix.extensions.malware.maec_4_1_malware.MAECInstance`

Marking Extensions
Simple Marking	✓ Full	`stix.extensions.marking.simple_marking.SimpleMarkingStructure`
TLP	✓ Full	`stix.extensions.marking.tlp.TLPMarkingStructure`
Terms of Use	✓ Full	`stix.extensions.marking.terms_of_use_marking.TermsOfUseMarkingStructure`

Structured COA Extensions
Generic Structured COA	✓ Full	`stix.extensions.structured_coa.generic_structured_coa.GenericStructuredCOA`

Test Mechanism Extensions
Generic Test Mechanism	✓ Full	`stix.extensions.test_mechanism.generic_test_mechanism.GenericTestMechanism`
OVAL	× None
OpenIOC	✓ Full	`stix.extensions.test_mechanism.open_ioc_2010_test_mechanism.OpenIOCTestMechanism`
SNORT	✓ Full	`stix.extensions.test_mechanism.snort_test_mechanism.SnortTestMechanism`
YARA	✓ Full	`stix.extensions.test_mechanism.yara_test_mechanism.YaraTestMechanism`

Vulnerability Extensions
CVRF	× None

STIX Vocabularies¶

STIX Construct	API Coverage	Documentation
AssetTypeVocab-1.0	✓ Full	`stix.common.vocabs.AssetType_1_0`
AttackerInfrastructureTypeVocab-1.0	✓ Full	`stix.common.vocabs.AttackerInfrastructureType_1_0`
AttackerToolTypeVocab-1.0	✓ Full	`stix.common.vocabs.AttackerToolType_1_0`
AvailabilityLossTypeVocab-1.0	✓ Full	`stix.common.vocabs.AvailabilityLossType_1_0`
AvailabilityLossTypeVocab-1.1.1	✓ Full	`stix.common.vocabs.AvailabilityLossType_1_1_1`
COAStageVocab-1.0	✓ Full	`stix.common.vocabs.COAStage_1_0`
CampaignStatusVocab-1.0	✓ Full	`stix.common.vocabs.CampaignStatus_1_0`
CourseOfActionTypeVocab-1.0	✓ Full	`stix.common.vocabs.CourseOfActionType_1_0`
DiscoveryMethodVocab-1.0	✓ Full	`stix.common.vocabs.DiscoveryMethod_1_0`
DiscoveryMethodVocab-2.0	✓ Full	`stix.common.vocabs.DiscoveryMethod_2_0`
HighMediumLowVocab-1.0	✓ Full	`stix.common.vocabs.HighMediumLow_1_0`
ImpactQualificationVocab-1.0	✓ Full	`stix.common.vocabs.ImpactQualification_1_0`
ImpactRatingVocab-1.0	✓ Full	`stix.common.vocabs.ImpactRating_1_0`
IncidentCategoryVocab-1.0	✓ Full	`stix.common.vocabs.IncidentCategory_1_0`
IncidentEffectVocab-1.0	✓ Full	`stix.common.vocabs.IncidentEffect_1_0`
IncidentStatusVocab-1.0	✓ Full	`stix.common.vocabs.IncidentStatus_1_0`
IndicatorTypeVocab-1.0	✓ Full	`stix.common.vocabs.IndicatorType_1_0`
IndicatorTypeVocab-1.1	✓ Full	`stix.common.vocabs.IndicatorType_1_1`
InformationSourceRoleVocab-1.0	✓ Full	`stix.common.vocabs.InformationSourceRole_1_0`
InformationTypeVocab-1.0	✓ Full	`stix.common.vocabs.InformationType_1_0`
IntendedEffectVocab-1.0	✓ Full	`stix.common.vocabs.IntendedEffect_1_0`
LocationClassVocab-1.0	✓ Full	`stix.common.vocabs.LocationClass_1_0`
LossDurationVocab-1.0	✓ Full	`stix.common.vocabs.LossDuration_1_0`
LossPropertyVocab-1.0	✓ Full	`stix.common.vocabs.LossProperty_1_0`
MalwareTypeVocab-1.0	✓ Full	`stix.common.vocabs.MalwareType_1_0`
ManagementClassVocab-1.0	✓ Full	`stix.common.vocabs.ManagementClass_1_0`
MotivationVocab-1.0	✓ Full	`stix.common.vocabs.Motivation_1_0`
MotivationVocab-1.0.1	✓ Full	`stix.common.vocabs.Motivation_1_0_1`
MotivationVocab-1.1	✓ Full	`stix.common.vocabs.Motivation_1_1`
OwnershipClassVocab-1.0	✓ Full	`stix.common.vocabs.OwnershipClass_1_0`
PackageIntentVocab-1.0	✓ Full	`stix.common.vocabs.PackageIntent_1_0`
PlanningAndOperationalSupportVocab-1.0	✓ Full	`stix.common.vocabs.PlanningAndOperationalSupport_1_0`
PlanningAndOperationalSupportVocab-1.0.1	✓ Full	`stix.common.vocabs.PlanningAndOperationalSupport_1_0_1`
SecurityCompromiseVocab-1.0	✓ Full	`stix.common.vocabs.SecurityCompromise_1_0`
SystemTypeVocab-1.0	✓ Full	`stix.common.vocabs.SystemType_1_0`
ThreatActorSophisticationVocab-1.0	✓ Full	`stix.common.vocabs.ThreatActorSophistication_1_0`
ThreatActorTypeVocab-1.0	✓ Full	`stix.common.vocabs.ThreatActorType_1_0`

Contributing¶

If a bug is found, a feature is missing, or something just isn’t behaving the way you’d expect it to, please submit an issue to our tracker. If you’d like to contribute code to our repository, you can do so by issuing a pull request and we will work with you to try and integrate that code into our repository.

python-stix 1.2.0.0 Documentation¶

Versions¶

Contents¶

Installation¶

Recommended Installation¶

Dependencies¶

Manual Installation¶

Further Information¶

Getting Started¶

Prerequisites¶

Your First STIX Application¶

Creating a STIX Package¶

Parsing STIX XML¶

Examples¶

Overview¶

ID Namespaces¶

Working With CybOX¶

Controlled Vocabularies¶

Interacting With VocabString Fields¶

Default Vocabulary Terms¶

Non-Default Vocabulary Terms¶

Working With Custom Controlled Vocabularies¶

Examples¶

Creating a STIX Package¶

Controlled Vocabularies: VocabString¶

ID Namespaces¶

APIs or bindings?¶

Overview¶

Bindings¶

APIs¶

Brevity Wins¶

Feedback¶

API Reference¶

API Reference¶

STIX¶

stix.base Module¶

Classes¶

stix.data_marking Module¶

Classes¶

Functions¶

STIX Campaign¶

stix.campaign Module¶

Overview¶

Documentation Resources¶

Classes¶

STIX Common¶

stix.common Module¶

Classes¶

stix.common.activity Module¶

Classes¶

stix.common.confidence Module¶

Classes¶

stix.common.datetimewithprecision Module¶

Classes¶

Constants¶

stix.common.identity Module¶

Classes¶

Functions¶

stix.common.information_source Module¶

Classes¶

stix.common.kill_chains Module¶

Classes¶

Lockheed Martin Kill Chain¶

stix.common.related Module¶

Classes¶

stix.common.statement Module¶

Classes¶

stix.common.structured_text Module¶

Classes¶

stix.common.tools Module¶

Classes¶

stix.common.vocabs Module¶

Classes¶

Functions¶

STIX Core¶

stix.core.stix_header Module¶

Classes¶

stix.core.stix_package Module¶

Overview¶

Documentation Resources¶

`stix.base` Module¶

`stix.data_marking` Module¶

`stix.campaign` Module¶

`stix.common` Module¶

`stix.common.activity` Module¶

`stix.common.confidence` Module¶

`stix.common.datetimewithprecision` Module¶

`stix.common.identity` Module¶

`stix.common.information_source` Module¶

`stix.common.kill_chains` Module¶

`stix.common.related` Module¶

`stix.common.statement` Module¶

`stix.common.structured_text` Module¶

`stix.common.tools` Module¶

`stix.common.vocabs` Module¶

`stix.core.stix_header` Module¶

`stix.core.stix_package` Module¶

`stix.core.ttps` Module¶

`stix.coa` Module¶

`stix.coa.objective` Module¶

`stix.exploit_target` Module¶

`stix.exploit_target.configuration` Module¶

`stix.exploit_target.vulnerability` Module¶

`stix.exploit_target.weakness` Module¶

`stix.extensions.identity.ciq_identity_3_0` Module¶

`stix.extensions.malware.maec_4_1_malware` Module¶

`stix.extensions.marking.simple_marking` Module¶

`stix.extensions.marking.terms_of_use_marking` Module¶

`stix.extensions.marking.tlp` Module¶

`stix.extensions.structured_coa.generic_structured_coa` Module¶

`stix.extensions.test_mechanism.generic_test_mechanism` Module¶

`stix.extensions.test_mechanism.open_ioc_2010_test_mechanism` Module¶

`stix.extensions.test_mechanism.snort_test_mechanism` Module¶

`stix.extensions.test_mechanism.yara_test_mechanism` Module¶

`stix.incident` Module¶

`stix.incident.affected_asset` Module¶

`stix.incident.coa` Module¶

`stix.incident.contributors` Module¶

`stix.incident.direct_impact_summary` Module¶

`stix.incident.external_id` Module¶

`stix.incident.history` Module¶

`stix.incident.impact_assessment` Module¶

`stix.incident.indirect_impact_summary` Module¶

`stix.incident.loss_estimation` Module¶

`stix.incident.property_affected` Module¶