pycti.entities.opencti_infrastructure
Classes
Main Infrastructure class for OpenCTI |
Module Contents
- class pycti.entities.opencti_infrastructure.Infrastructure(opencti)[source]
Main Infrastructure class for OpenCTI
Manages threat infrastructure (servers, domains, etc.) in the OpenCTI platform.
- Parameters:
opencti (OpenCTIApiClient) – instance of
OpenCTIApiClient
Initialize the Infrastructure instance.
- Parameters:
opencti (OpenCTIApiClient) – OpenCTI API client instance
- properties = Multiline-String[source]
Show Value
""" id standard_id entity_type parent_types spec_version created_at updated_at status { id template { id name color } } createdBy { ... on Identity { id standard_id entity_type parent_types spec_version identity_class name description roles contact_information x_opencti_aliases created modified objectLabel { id value color } } ... on Organization { x_opencti_organization_type x_opencti_reliability } ... on Individual { x_opencti_firstname x_opencti_lastname } } objectOrganization { id standard_id name } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } objectLabel { id value color } externalReferences { edges { node { id standard_id entity_type source_name description url hash external_id created modified } } } revoked confidence created modified name description infrastructure_types first_seen last_seen killChainPhases { id standard_id entity_type kill_chain_name phase_name x_opencti_order created modified } """
- properties_with_files = Multiline-String[source]
Show Value
""" id standard_id entity_type parent_types spec_version created_at updated_at status { id template { id name color } } createdBy { ... on Identity { id standard_id entity_type parent_types spec_version identity_class name description roles contact_information x_opencti_aliases created modified objectLabel { id value color } } ... on Organization { x_opencti_organization_type x_opencti_reliability } ... on Individual { x_opencti_firstname x_opencti_lastname } } objectOrganization { id standard_id name } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } objectLabel { id value color } externalReferences { edges { node { id standard_id entity_type source_name description url hash external_id created modified importFiles { edges { node { id name size metaData { mimetype version } } } } } } } revoked confidence created modified name description infrastructure_types first_seen last_seen killChainPhases { id standard_id entity_type kill_chain_name phase_name x_opencti_order created modified } importFiles { edges { node { id name size metaData { mimetype version } objectMarking { id standard_id entity_type definition_type definition created modified x_opencti_order x_opencti_color } } } } """
- static generate_id(name)[source]
Generate a STIX ID for an Infrastructure.
- Parameters:
name (str) – The name of the infrastructure
- Returns:
STIX ID for the infrastructure
- Return type:
str
- static generate_id_from_data(data)[source]
Generate a STIX ID from infrastructure data.
- Parameters:
data (dict) – Dictionary containing ‘name’ key
- Returns:
STIX ID for the infrastructure
- Return type:
str
- list(**kwargs)[source]
List Infrastructure objects.
- Parameters:
filters (dict) – (optional) the filters to apply
search (str) – (optional) a search keyword to apply for the listing
first (int) – (optional) return the first n rows from the after ID or the beginning if not set
after (str) – (optional) OpenCTI object ID of the first row for pagination
orderBy (str) – (optional) the field to order the response on
orderMode (str) – (optional) either “asc” or “desc”
customAttributes (str) – (optional) list of attributes keys to return
getAll (bool) – (optional) switch to return all entries (be careful to use this without any other filters)
withPagination (bool) – (optional) switch to use pagination
withFiles (bool) – (optional) include files in response
- Returns:
List of Infrastructure objects
- Return type:
list
- read(**kwargs)[source]
Read an Infrastructure object.
Read can be either used with a known OpenCTI entity id or by using a valid filter to search and return a single Infrastructure entity or None.
Note: either id or filters is required.
- Parameters:
id (str) – the id of the Infrastructure
filters (dict) – the filters to apply if no id provided
customAttributes (str) – custom attributes to return
withFiles (bool) – whether to include files
- Returns:
Infrastructure object
- Return type:
dict or None
- create(**kwargs)[source]
Create an Infrastructure object.
- Parameters:
name (str) – the name of the Infrastructure (required)
stix_id (str) – (optional) the STIX ID
createdBy (str) – (optional) the author ID
objectMarking (list) – (optional) list of marking definition IDs
objectLabel (list) – (optional) list of label IDs
externalReferences (list) – (optional) list of external reference IDs
revoked (bool) – (optional) whether the infrastructure is revoked
confidence (int) – (optional) confidence level (0-100)
lang (str) – (optional) language
created (str) – (optional) creation date
modified (str) – (optional) modification date
description (str) – (optional) description
aliases (list) – (optional) list of aliases
infrastructure_types (list) – (optional) list of infrastructure types
first_seen (str) – (optional) first seen date
last_seen (str) – (optional) last seen date
killChainPhases (list) – (optional) list of kill chain phase IDs
x_opencti_stix_ids (list) – (optional) list of additional STIX IDs
objectOrganization (list) – (optional) list of organization IDs
x_opencti_workflow_id (str) – (optional) workflow ID
x_opencti_modified_at (str) – (optional) custom modification date
update (bool) – (optional) whether to update if exists (default: False)
files (list) – (optional) list of File objects to attach
filesMarkings (list) – (optional) list of lists of marking definition IDs for each file
- Returns:
Infrastructure object
- Return type:
dict or None
- import_from_stix2(**kwargs)[source]
Import an Infrastructure object from a STIX2 object.
- Parameters:
stixObject (dict) – the STIX2 Infrastructure object
extras (dict) – extra parameters including created_by_id, object_marking_ids, etc.
update (bool) – whether to update if the entity already exists
- Returns:
Infrastructure object
- Return type:
dict or None