pycti 6.8.12__tar.gz

pycti-6.8.12/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: pycti
+Version: 6.8.12
+Summary: Python API client for OpenCTI.
+Home-page: https://github.com/OpenCTI-Platform/opencti
+Author: Filigran
+Author-email: contact@filigran.io
+Maintainer: Filigran
+License: Apache
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Natural Language :: French
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: datefinder~=0.7.3
+Requires-Dist: pika~=1.3.0
+Requires-Dist: pydantic<3,>=2.8.2
+Requires-Dist: python-magic~=0.4.27; sys_platform == "linux" or sys_platform == "darwin"
+Requires-Dist: python-magic-bin~=0.4.14; sys_platform == "win32"
+Requires-Dist: python_json_logger~=3.3.0
+Requires-Dist: PyYAML~=6.0
+Requires-Dist: requests<3,>=2.32.0
+Requires-Dist: setuptools~=80.9.0
+Requires-Dist: cachetools~=5.5.2
+Requires-Dist: prometheus-client~=0.22.1
+Requires-Dist: opentelemetry-api~=1.35.0
+Requires-Dist: opentelemetry-sdk~=1.35.0
+Requires-Dist: deprecation~=2.1.0
+Requires-Dist: fastapi<0.117.0,>=0.115.2
+Requires-Dist: uvicorn[standard]<0.36.0,>=0.34.0
+Requires-Dist: filigran-sseclient>=1.0.2
+Requires-Dist: stix2~=3.0.1
+Provides-Extra: dev
+Requires-Dist: black~=25.1.0; extra == "dev"
+Requires-Dist: build~=1.2.1; extra == "dev"
+Requires-Dist: isort~=6.0.0; extra == "dev"
+Requires-Dist: types-pytz~=2025.2.0.20250326; extra == "dev"
+Requires-Dist: pre-commit~=4.2.0; extra == "dev"
+Requires-Dist: pytest-cases~=3.9.1; extra == "dev"
+Requires-Dist: pytest-cov~=6.2.1; extra == "dev"
+Requires-Dist: pytest_randomly~=3.16.0; extra == "dev"
+Requires-Dist: pytest~=8.4.1; extra == "dev"
+Requires-Dist: types-python-dateutil~=2.9.0; extra == "dev"
+Requires-Dist: wheel~=0.45.1; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: autoapi~=2.0.1; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints~=3.2.0; extra == "doc"
+Requires-Dist: sphinx-rtd-theme~=3.0.2; extra == "doc"
+
+# OpenCTI client for Python
+
+[![Website](https://img.shields.io/badge/website-opencti.io-blue.svg)](https://opencti.io)
+[![readthedocs](https://readthedocs.org/projects/opencti-client-for-python/badge/?style=flat)](https://opencti-client-for-python.readthedocs.io/en/latest/)
+[![Number of PyPI downloads](https://img.shields.io/pypi/dm/pycti.svg)](https://pypi.python.org/pypi/pycti/)
+[![Slack Status](https://img.shields.io/badge/slack-3K%2B%20members-4A154B)](https://community.filigran.io)
+
+The official OpenCTI Python client helps developers to use the OpenCTI API by providing easy to use methods and utils.
+This client is also used by some OpenCTI components.
+
+## Install
+
+To install the latest Python client library, please use `pip`:
+
+```bash
+$ pip3 install pycti
+```
+
+## Local development
+
+```bash
+# Fork the current repository, then clone your fork
+$ git clone https://github.com/YOUR-USERNAME/opencti.git
+$ cd client-python
+$ git remote add upstream https://github.com/OpenCTI-Platform/opencti.git
+# Create a branch for your feature/fix
+$ git checkout -b [branch-name]
+# Create a virtualenv
+$ cd client-python
+$ python3 -m venv .venv
+$ source .venv/bin/activate
+# Install the client-python and dependencies for the development and the documentation
+$ python3 -m pip install -e .[dev,doc]
+# Set up the git hook scripts
+$ pre-commit install
+# Create your feature/fix
+# Create tests for your changes
+$ pytest
+# Push you feature/fix on Github
+$ git add [file(s)]
+$ git commit -m "[descriptive message]"
+$ git push origin [branch-name]
+# Open a pull request
+```
+
+### Install the package locally
+
+```bash
+$ pip install -e .
+```
+
+## Documentation
+
+### Client usage
+
+To learn about how to use the OpenCTI Python client and read some examples and cases, refer to [the client documentation](https://opencti-client-for-python.readthedocs.io/en/latest/client_usage/getting_started.html).
+
+### API reference
+
+To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://opencti-client-for-python.readthedocs.io/en/latest/pycti/pycti.html).
+
+## Tests
+
+### Install dependencies
+
+```bash
+$ pip install -r ./test-requirements.txt
+```
+
+[pytest](https://docs.pytest.org/en/7.2.x/) is used to launch the tests.
+
+### Launch tests
+
+#### Prerequisite
+
+Your OpenCTI API should be running.
+Your conftest.py should be configured with your API url, your token, and if applicable, your mTLS cert/key.
+
+#### Launching
+
+Unit tests
+```bash
+$ pytest ./tests/01-unit/
+```
+
+Integration testing
+```bash
+$ pytest ./tests/02-integration/
+```
+
+Example testing:
+
+> OpenCTI must be running
+
+```bash
+cd examples
+# Configure with you local instance of OpenCTI
+export OPENCTI_API_URL="http://localhost:4000"
+export OPENCTI_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxx"
+
+#Run one example file
+python get_indicators_of_malware.py
+```
+
+## About
+
+OpenCTI is a product designed and developed by the company [Filigran](https://filigran.io).
+
+<a href="https://filigran.io" alt="Filigran"><img src="https://github.com/OpenCTI-Platform/opencti/raw/master/.github/img/logo_filigran.png" width="300" /></a>

pycti-6.8.12/README.md

@@ -0,0 +1,109 @@
+# OpenCTI client for Python
+
+[![Website](https://img.shields.io/badge/website-opencti.io-blue.svg)](https://opencti.io)
+[![readthedocs](https://readthedocs.org/projects/opencti-client-for-python/badge/?style=flat)](https://opencti-client-for-python.readthedocs.io/en/latest/)
+[![Number of PyPI downloads](https://img.shields.io/pypi/dm/pycti.svg)](https://pypi.python.org/pypi/pycti/)
+[![Slack Status](https://img.shields.io/badge/slack-3K%2B%20members-4A154B)](https://community.filigran.io)
+
+The official OpenCTI Python client helps developers to use the OpenCTI API by providing easy to use methods and utils.
+This client is also used by some OpenCTI components.
+
+## Install
+
+To install the latest Python client library, please use `pip`:
+
+```bash
+$ pip3 install pycti
+```
+
+## Local development
+
+```bash
+# Fork the current repository, then clone your fork
+$ git clone https://github.com/YOUR-USERNAME/opencti.git
+$ cd client-python
+$ git remote add upstream https://github.com/OpenCTI-Platform/opencti.git
+# Create a branch for your feature/fix
+$ git checkout -b [branch-name]
+# Create a virtualenv
+$ cd client-python
+$ python3 -m venv .venv
+$ source .venv/bin/activate
+# Install the client-python and dependencies for the development and the documentation
+$ python3 -m pip install -e .[dev,doc]
+# Set up the git hook scripts
+$ pre-commit install
+# Create your feature/fix
+# Create tests for your changes
+$ pytest
+# Push you feature/fix on Github
+$ git add [file(s)]
+$ git commit -m "[descriptive message]"
+$ git push origin [branch-name]
+# Open a pull request
+```
+
+### Install the package locally
+
+```bash
+$ pip install -e .
+```
+
+## Documentation
+
+### Client usage
+
+To learn about how to use the OpenCTI Python client and read some examples and cases, refer to [the client documentation](https://opencti-client-for-python.readthedocs.io/en/latest/client_usage/getting_started.html).
+
+### API reference
+
+To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://opencti-client-for-python.readthedocs.io/en/latest/pycti/pycti.html).
+
+## Tests
+
+### Install dependencies
+
+```bash
+$ pip install -r ./test-requirements.txt
+```
+
+[pytest](https://docs.pytest.org/en/7.2.x/) is used to launch the tests.
+
+### Launch tests
+
+#### Prerequisite
+
+Your OpenCTI API should be running.
+Your conftest.py should be configured with your API url, your token, and if applicable, your mTLS cert/key.
+
+#### Launching
+
+Unit tests
+```bash
+$ pytest ./tests/01-unit/
+```
+
+Integration testing
+```bash
+$ pytest ./tests/02-integration/
+```
+
+Example testing:
+
+> OpenCTI must be running
+
+```bash
+cd examples
+# Configure with you local instance of OpenCTI
+export OPENCTI_API_URL="http://localhost:4000"
+export OPENCTI_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxx"
+
+#Run one example file
+python get_indicators_of_malware.py
+```
+
+## About
+
+OpenCTI is a product designed and developed by the company [Filigran](https://filigran.io).
+
+<a href="https://filigran.io" alt="Filigran"><img src="https://github.com/OpenCTI-Platform/opencti/raw/master/.github/img/logo_filigran.png" width="300" /></a>

pycti-6.8.12/pycti/__init__.py

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+__version__ = "6.8.12"
+
+from .api.opencti_api_client import OpenCTIApiClient
+from .api.opencti_api_connector import OpenCTIApiConnector
+from .api.opencti_api_work import OpenCTIApiWork
+from .connector.opencti_connector import ConnectorType, OpenCTIConnector
+from .connector.opencti_connector_helper import (
+    OpenCTIConnectorHelper,
+    get_config_variable,
+)
+from .connector.opencti_metric_handler import OpenCTIMetricHandler
+from .entities.opencti_attack_pattern import AttackPattern
+from .entities.opencti_campaign import Campaign
+
+# Administrative entities
+from .entities.opencti_capability import Capability
+from .entities.opencti_case_incident import CaseIncident
+from .entities.opencti_case_rfi import CaseRfi
+from .entities.opencti_case_rft import CaseRft
+from .entities.opencti_channel import Channel
+from .entities.opencti_course_of_action import CourseOfAction
+from .entities.opencti_data_component import DataComponent
+from .entities.opencti_data_source import DataSource
+from .entities.opencti_external_reference import ExternalReference
+from .entities.opencti_feedback import Feedback
+from .entities.opencti_group import Group
+from .entities.opencti_grouping import Grouping
+from .entities.opencti_identity import Identity
+from .entities.opencti_incident import Incident
+from .entities.opencti_indicator import Indicator
+from .entities.opencti_infrastructure import Infrastructure
+from .entities.opencti_intrusion_set import IntrusionSet
+from .entities.opencti_kill_chain_phase import KillChainPhase
+from .entities.opencti_label import Label
+from .entities.opencti_location import Location
+from .entities.opencti_malware import Malware
+from .entities.opencti_malware_analysis import MalwareAnalysis
+from .entities.opencti_marking_definition import MarkingDefinition
+from .entities.opencti_note import Note
+from .entities.opencti_observed_data import ObservedData
+from .entities.opencti_opinion import Opinion
+from .entities.opencti_report import Report
+from .entities.opencti_role import Role
+from .entities.opencti_settings import Settings
+from .entities.opencti_stix_core_relationship import StixCoreRelationship
+from .entities.opencti_stix_cyber_observable import StixCyberObservable
+from .entities.opencti_stix_domain_object import StixDomainObject
+from .entities.opencti_stix_nested_ref_relationship import StixNestedRefRelationship
+from .entities.opencti_stix_object_or_stix_relationship import (
+    StixObjectOrStixRelationship,
+)
+from .entities.opencti_stix_sighting_relationship import StixSightingRelationship
+from .entities.opencti_task import Task
+from .entities.opencti_threat_actor import ThreatActor
+from .entities.opencti_threat_actor_group import ThreatActorGroup
+from .entities.opencti_threat_actor_individual import ThreatActorIndividual
+from .entities.opencti_tool import Tool
+from .entities.opencti_user import User
+from .entities.opencti_vulnerability import Vulnerability
+from .utils.constants import (
+    CustomObjectCaseIncident,
+    CustomObjectChannel,
+    CustomObjectTask,
+    CustomObservableBankAccount,
+    CustomObservableCredential,
+    CustomObservableCryptocurrencyWallet,
+    CustomObservableCryptographicKey,
+    CustomObservableHostname,
+    CustomObservableMediaContent,
+    CustomObservablePaymentCard,
+    CustomObservablePersona,
+    CustomObservablePhoneNumber,
+    CustomObservableText,
+    CustomObservableTrackingNumber,
+    CustomObservableUserAgent,
+    MultipleRefRelationship,
+    StixCyberObservableTypes,
+    StixMetaTypes,
+)
+from .utils.opencti_stix2 import (
+    STIX_EXT_MITRE,
+    STIX_EXT_OCTI,
+    STIX_EXT_OCTI_SCO,
+    OpenCTIStix2,
+)
+from .utils.opencti_stix2_splitter import OpenCTIStix2Splitter
+from .utils.opencti_stix2_update import OpenCTIStix2Update
+from .utils.opencti_stix2_utils import OpenCTIStix2Utils
+
+__all__ = [
+    "AttackPattern",
+    "Campaign",
+    "CaseIncident",
+    "CaseRfi",
+    "CaseRft",
+    "Channel",
+    "Task",
+    "ConnectorType",
+    "CourseOfAction",
+    "DataComponent",
+    "DataSource",
+    "ExternalReference",
+    "Feedback",
+    "Grouping",
+    "Identity",
+    "Incident",
+    "Indicator",
+    "Infrastructure",
+    "IntrusionSet",
+    "KillChainPhase",
+    "Label",
+    "Location",
+    "Malware",
+    "MalwareAnalysis",
+    "MarkingDefinition",
+    "Note",
+    "ObservedData",
+    "OpenCTIApiClient",
+    "OpenCTIApiConnector",
+    "OpenCTIApiWork",
+    "OpenCTIConnector",
+    "OpenCTIConnectorHelper",
+    "OpenCTIMetricHandler",
+    "OpenCTIStix2",
+    "OpenCTIStix2Splitter",
+    "OpenCTIStix2Update",
+    "OpenCTIStix2Utils",
+    "Opinion",
+    "Report",
+    "StixCoreRelationship",
+    "StixCyberObservable",
+    "StixNestedRefRelationship",
+    "StixCyberObservableTypes",
+    "StixDomainObject",
+    "StixMetaTypes",
+    "MultipleRefRelationship",
+    "StixObjectOrStixRelationship",
+    "StixSightingRelationship",
+    "ThreatActor",
+    "ThreatActorGroup",
+    "ThreatActorIndividual",
+    "Tool",
+    "Vulnerability",
+    "get_config_variable",
+    "CustomObjectCaseIncident",
+    "CustomObjectTask",
+    "CustomObjectChannel",
+    "StixCyberObservableTypes",
+    "CustomObservableCredential",
+    "CustomObservableHostname",
+    "CustomObservableUserAgent",
+    "CustomObservableBankAccount",
+    "CustomObservableCryptographicKey",
+    "CustomObservableCryptocurrencyWallet",
+    "CustomObservablePaymentCard",
+    "CustomObservablePersona",
+    "CustomObservablePhoneNumber",
+    "CustomObservableTrackingNumber",
+    "CustomObservableText",
+    "CustomObservableMediaContent",
+    "STIX_EXT_MITRE",
+    "STIX_EXT_OCTI_SCO",
+    "STIX_EXT_OCTI",
+    "Capability",
+    "Role",
+    "Group",
+    "User",
+    "Settings",
+]