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_intentsDEPRECATED. A collection of VocabString defining the intent of the parent STIXPackage.
  • descriptionDEPRECATED. A description of the intent or purpose of the parent STIXPackage.
  • short_descriptionDEPRECATED. A short description of the intent or purpose of the parent STIXPackage.
  • titleDEPRECATED. 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