psengine 2.0.4__py3-none-any.whl

psengine/collective_insights/constants.py

@@ -0,0 +1,44 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+ENTITY_IP = 'ip'
+ENTITY_DOMAIN = 'domain'
+ENTITY_HASH = 'hash'
+ENTITY_URL = 'url'
+ENTITY_VULNERABILITY = 'vulnerability'
+VALID_ENTITY_TYPES = [ENTITY_IP, ENTITY_DOMAIN, ENTITY_HASH, ENTITY_URL, ENTITY_VULNERABILITY]
+
+TIMESTAMP_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+
+DETECTION_TYPE_CORRELATION = 'correlation'
+DETECTION_TYPE_PLAYBOOK = 'playbook'
+DETECTION_TYPE_RULE = 'detection_rule'
+VALID_DETECTION_TYPES = [DETECTION_TYPE_CORRELATION, DETECTION_TYPE_PLAYBOOK, DETECTION_TYPE_RULE]
+
+DETECTION_SUB_TYPE_SIGMA = 'sigma'
+DETECTION_SUB_TYPE_YARA = 'yara'
+DETECTION_SUB_TYPE_SNORT = 'snort'
+VALID_DETECTION_RULE_SUB_TYPES = ['sigma', 'yara', 'snort']
+DETECTION_SUB_FORMAT_MAPPING = {
+    'ioc_type': ['ioc', 'type'],
+    'ioc_value': ['ioc', 'value'],
+    'ioc_field': ['ioc', 'field'],
+    'ioc_source_type': ['ioc', 'source_type'],
+    'incident_id': ['incident', 'id'],
+    'incident_name': ['incident', 'name'],
+    'incident_type': ['incident', 'type'],
+    'detection_id': ['detection', 'id'],
+    'detection_name': ['detection', 'name'],
+    'detection_type': ['detection', 'type'],
+}
+SUMMARY_DEFAULT = True

psengine/collective_insights/errors.py

@@ -0,0 +1,18 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+from ..errors import RecordedFutureError
+
+
+class CollectiveInsightsError(RecordedFutureError):
+    """Error raised when there was an error with the Collective Insights API."""

psengine/collective_insights/insight.py

@@ -0,0 +1,89 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+from datetime import datetime
+from functools import total_ordering
+from typing import Optional
+
+from ..common_models import IdNameType, RFBaseModel
+from ..constants import TIMESTAMP_STR
+from .models import (
+    RequestDetection,
+    RequestIOC,
+    RequestOptions,
+    SubmissionResult,
+)
+
+
+@total_ordering
+class Insight(RFBaseModel):
+    """Validate a single insight.
+
+    Methods:
+        __hash__:
+            Returns a hash value based on the IOC value.
+
+        __eq__:
+            Checks equality between two Insight instances based on their IOC value and timestamp.
+
+        __gt__:
+            Defines a greater-than comparison between two Insight instances based on their
+            timestamp and IOC value.
+
+        __str__:
+            Returns a string representation of the Insight instance with:
+            IOC value, timestamp, and detection type.
+
+            >>> print(insight)
+            IOC: mal_dom.com, Timestamp: 2024-05-21 10:42:30AM, Detection Type: sandbox
+
+    Total Ordering:
+        Ordering of Insight instances is determined primarily by the timestamp. If two instances
+        have the same timestamp, their IOC value is used as a secondary criterion for ordering.
+    """
+
+    timestamp: datetime
+    ioc: RequestIOC
+    incident: Optional[IdNameType] = None
+    mitre_codes: Optional[list[str]] = None
+    malwares: Optional[list[str]] = None
+    detection: RequestDetection
+
+    def __hash__(self):
+        return hash(self.ioc.value)
+
+    def __eq__(self, other: 'Insight'):
+        return (self.ioc.value, self.timestamp) == (other.ioc.value, other.timestamp)
+
+    def __gt__(self, other: 'Insight'):
+        return (self.timestamp, self.ioc.value) > (other.timestamp, other.ioc.value)
+
+    def __str__(self):
+        return (
+            f'IOC: {self.ioc.value}, Timestamp: {self.timestamp.strftime(TIMESTAMP_STR)}, '
+            f'Detection Type: {self.detection.type_}'
+        )
+
+
+class InsightsOut(RFBaseModel):
+    """Validate data sent to CI."""
+
+    options: Optional[RequestOptions] = None
+    organization_ids: Optional[list[str]] = None
+    data: list[Insight]
+
+
+class InsightsIn(RFBaseModel):
+    """Validate data received from CI."""
+
+    result: SubmissionResult

psengine/collective_insights/models.py

@@ -0,0 +1,81 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import Field, model_validator
+
+from ..common_models import DetectionRuleType, IOCType, RFBaseModel
+
+
+class DetectionType(Enum):
+    detection_rule = 'detection_rule'
+    correlation = 'correlation'
+    playbook = 'playbook'
+    sandbox = 'sandbox'
+
+
+class SummaryProcessed(RFBaseModel):
+    ip: int
+    domain: int
+    hash_: int = Field(alias='hash')
+    vulnerability: int
+    url: int
+
+
+class ResponseSummary(RFBaseModel):
+    processed: SummaryProcessed
+
+
+class RequestOptions(RFBaseModel):
+    debug: bool = False
+    summary: bool = True
+
+
+class RequestIOC(RFBaseModel):
+    type_: IOCType = Field(alias='type')
+    value: str
+    source_type: Optional[str] = None
+    field: Optional[str] = None
+
+
+class RequestDetection(RFBaseModel):
+    id_: Optional[str] = Field(alias='id', default=None)
+    name: Optional[str] = None
+    type_: DetectionType = Field(alias='type')
+    sub_type: Optional[DetectionRuleType] = None
+
+    @model_validator(mode='before')
+    @classmethod
+    def validate_detection_rule(cls, data):
+        """Validate detection rule scenario.
+
+        - id must be present.
+        - sub_type must be present and should be one of DetectionRuleType
+        """
+        try:
+            detection_type = data['type']
+        except KeyError as e:
+            raise ValueError('type field is mandatory') from e
+
+        if detection_type == 'detection_rule' and not (data.get('id') and data.get('sub_type')):
+            raise ValueError(f'With {detection_type} the id and sub_type fields are mandatory')
+
+        return data
+
+
+class SubmissionResult(RFBaseModel):
+    status: str
+    debug: bool
+    summary: Optional[ResponseSummary] = None

psengine/common_models.py

@@ -0,0 +1,89 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+import os
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class RFBaseModel(BaseModel):
+    model_config = ConfigDict(extra=os.environ.get('RF_MODEL_EXTRA', 'ignore'))
+
+    def json(self, by_alias=True, exclude_none=True, auto_exclude_unset=True, **kwargs):
+        """JSON representation of models. It is inherited by every model.
+
+        Args:
+            by_alias (bool): If True, writes fields with their API alias (eg. ``IpAddress``) instead
+                of the Python alias (eg. ``ip_address``). Defaults to True.
+
+            exclude_none (bool): Whether fields equal to None should be excluded from the returned
+                dictionary. Defaults to True.
+
+            auto_exclude_unset (bool): Excludes values that are not set.
+
+                - True: Based on ``RF_EXTRA_MODEL``, decides if output should have unmapped fields.
+                  If the ``model_config`` extra is set to 'allow', includes unmapped values;
+                  otherwise, excludes them.
+
+                - False: You need to provide the boolean ``exclude_unset`` in the kwargs.
+
+            kwargs (dict, optional): Any other parameters.
+        """
+        if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
+            raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')
+
+        exclude_unset = (
+            bool(self.model_config['extra'] != 'allow')
+            if auto_exclude_unset
+            else kwargs['exclude_unset']
+        )
+        kwargs['exclude_unset'] = exclude_unset
+
+        return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)
+
+
+class IdName(RFBaseModel):
+    id_: str = Field(alias='id')
+    name: str
+
+
+class IdNameType(RFBaseModel):
+    id_: str = Field(alias='id', default=None)
+    name: Optional[str] = None
+    type_: str = Field(alias='type', default=None)
+
+
+class IdOptionalNameType(RFBaseModel):
+    id_: str = Field(alias='id', default=None)
+    name: Optional[str] = None
+    type_: str = Field(alias='type', default=None)
+
+
+class IdNameTypeDescription(IdNameType):
+    description: Optional[str] = None
+
+
+class IOCType(Enum):
+    ip = 'ip'
+    domain = 'domain'
+    hash = 'hash'  # noqa: A003
+    vulnerability = 'vulnerability'
+    url = 'url'
+
+
+class DetectionRuleType(Enum):
+    sigma = 'sigma'
+    yara = 'yara'
+    snort = 'snort'

psengine/config/__init__.py

@@ -0,0 +1,15 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+from .config import Config, ConfigModel, get_config
+from .errors import ConfigFileError

psengine/config/config.py

@@ -0,0 +1,284 @@
+#################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+import logging
+import os
+import re
+from copy import deepcopy
+from pathlib import Path
+from typing import Optional, Union
+
+from pydantic import Field, Secret, field_validator, validate_call
+from pydantic_settings import (
+    BaseSettings,
+    DotEnvSettingsSource,
+    EnvSettingsSource,
+    JsonConfigSettingsSource,
+    PydanticBaseSettingsSource,
+    SettingsConfigDict,
+    TomlConfigSettingsSource,
+)
+
+from ..constants import (
+    BACKOFF_FACTOR,
+    POOL_MAX_SIZE,
+    REQUEST_TIMEOUT,
+    RETRY_TOTAL,
+    RF_TOKEN_ENV_VAR,
+    RF_TOKEN_VALIDATION_REGEX,
+    ROOT_DIR,
+    SSL_VERIFY,
+    STATUS_FORCELIST,
+)
+from ..helpers import OSHelpers
+from .errors import ConfigFileError
+
+PLAT_REGEX = r'^([A-Z]|[a-z])+(\/\d+)?((\.\d+)*?)$'
+APP_ID_REGEX = r'^\S+\/\d+((\.\d+)*?)$'
+
+
+class RFToken(Secret[str]):
+    """Recorded Future token mask."""
+
+    def _display(self) -> str:
+        return '********' + self.get_secret_value()[-4:]
+
+
+class ConfigModel(BaseSettings):
+    """Global configuration settings.
+
+    This class is used to store global configuration settings for the application.
+
+    Supports config with .toml, .json and .env extensions.
+    Regular expression validation:
+
+        - app_id must be ``<str>/<int>[.<int>][.<int>]``
+        - platform_id must be ``<str>[/<int>][.<int>][.<int>]``
+
+    Example:
+        Initialize the ``Config`` with ``config_path``
+
+        .. code-block:: python
+            :linenos:
+
+            from psengine.config import Config, get_config
+            Config.init(config_path=<filepath>)
+
+            config = get_config()
+
+        Initialize the ``Config`` from python itself:
+
+        .. code-block:: python
+            :linenos:
+
+            from psengine.config import Config, get_config
+            Config.init(my_setting='example', my_second_setting='example2')
+
+            config = get_config()
+            config.my_setting
+    """
+
+    config_path: Union[str, Path, None] = None
+    model_config = SettingsConfigDict(arbitrary_types_allowed=True, extra='allow', frozen=True)
+
+    platform_id: Optional[str] = Field(default=None, pattern=PLAT_REGEX, examples=['Splunk/8.0.0'])
+    app_id: Optional[str] = Field(default=None, pattern=APP_ID_REGEX, examples=['get-alerts/1.0.0'])
+    rf_token: Optional[RFToken] = Field(default=os.environ.get(RF_TOKEN_ENV_VAR, ''))
+    http_proxy: Optional[str] = None
+    https_proxy: Optional[str] = None
+    client_ssl_verify: Optional[bool] = SSL_VERIFY
+    client_basic_auth: Optional[tuple[str, str]] = None
+    client_cert: Optional[Union[str, tuple[str, str]]] = None
+    client_timeout: Optional[int] = REQUEST_TIMEOUT
+    client_retries: Optional[int] = RETRY_TOTAL
+    client_backoff_factor: Optional[int] = BACKOFF_FACTOR
+    client_status_forcelist: Optional[list[int]] = STATUS_FORCELIST
+    client_pool_max_size: Optional[int] = POOL_MAX_SIZE
+
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+    ) -> tuple[PydanticBaseSettingsSource, ...]:
+        """Set config file sources correctly for Config.
+
+        In the case where a value is specified for the same Settings field in multiple ways, the
+        selected value is determined as follows (in descending order of priority):
+
+            1. Arguments passed to the Config class initialiser (``Config.init``)
+            2. Environment variables
+            3. Config file specified in the config_path field
+            4. Variables loaded from the secrets directory
+            5. Default values for the Config model
+
+        Args:
+            settings_cls (Type[BaseSettings]): class settings
+            init_settings (PydanticBaseSettingsSource): initial settings callable
+            env_settings (PydanticBaseSettingsSource): environment settings callable
+            dotenv_settings (PydanticBaseSettingsSource): .env file settings callable
+            file_secret_settings (PydanticBaseSettingsSource): secrets file settings callable
+
+        Returns:
+            Tuple[PydanticBaseSettingsSource, ...]: A tuple containing the sources and their order
+                                                    for loading the settings values.
+        """
+        env_settings = EnvSettingsSource(settings_cls, env_prefix='RF_', env_nested_delimiter='__')
+        sources = [
+            init_settings,
+            env_settings,
+            dotenv_settings,
+            file_secret_settings,
+        ]
+
+        if config := init_settings.init_kwargs.get('config_path'):
+            config = config if isinstance(config, str) else config.as_posix()
+            if config.endswith('.toml'):
+                sources.insert(2, TomlConfigSettingsSource(settings_cls, Path(config)))
+            elif config.endswith('.json'):
+                sources.insert(2, JsonConfigSettingsSource(settings_cls, Path(config)))
+            elif config.endswith('.env'):
+                sources.insert(
+                    2,
+                    DotEnvSettingsSource(
+                        settings_cls,
+                        env_file=Path(config),
+                        env_nested_delimiter='.',
+                        env_prefix='RF_',
+                    ),
+                )
+            else:
+                raise ValueError('The config file extension must be .toml or .json or .env')
+        return tuple(sources)
+
+    @field_validator('rf_token', mode='before')
+    @classmethod
+    def validate_token(cls, rf_token):
+        """Validate Recorded Future token.
+
+        Args:
+            rf_token (str): Recorded Future token
+
+        Raises:
+            ValueError: when token is not 32 alphanumeric characters in ``[a-f][0-9]`` range.
+
+        Returns:
+            str: token
+        """
+        rf_token = rf_token or os.environ.get(RF_TOKEN_ENV_VAR)
+        if not rf_token:
+            # Edge case: when RF_RF_TOKEN env var is set, it is used and RF_TOKEN is ignored
+            # So we check if RF_TOKEN is set and validate it
+            return ''
+        if not re.match(RF_TOKEN_VALIDATION_REGEX, rf_token):
+            raise ValueError(
+                f'Invalid Recorded Future API token, must match regex {RF_TOKEN_VALIDATION_REGEX}'
+            )
+
+        return rf_token
+
+    @validate_call
+    def save_config(
+        self,
+        directory: Union[str, Path] = Path(ROOT_DIR) / 'config',
+        file: Union[str, Path] = 'config.json',
+    ):
+        """Writes the current values in Config, in the file provided as JSON.
+
+        If the file already exists, the content will be deleted.
+        The config will be saved in the ``<project_directory>/config/config.json``
+
+        """
+        directory = Path(directory)
+        log = logging.getLogger(__name__)
+        data = self.model_dump_json(exclude='rf_token', indent=4)
+        OSHelpers.mkdir(directory)
+        config_path = directory / file
+        log.info(f'Saving config in {config_path.as_posix()}')
+
+        with config_path.open('w') as f:
+            f.write(data)
+
+
+class Config:
+    """Singleton class to manage Config instances.
+
+    Note that the config is Read Only. Once initialized, attributes cannot be changed unless you
+    initialize the config with new values.
+    """
+
+    _instance = None
+
+    @classmethod
+    def _get_instance(cls) -> Union[ConfigModel, None]:
+        """Get instance of ``Config``.
+
+        ``get_config()`` should be used instead of calling this method directly
+        """
+        if not cls._instance:
+            cls._instance = ConfigModel()
+
+        return cls._instance
+
+    @classmethod
+    def reset_instance(cls):
+        """Method used for testing to clear up the previous instances of ``Config``."""
+        cls._instance = None
+
+    @classmethod
+    def init(cls, config_class=ConfigModel, **kwargs):
+        """Initialize Config instance.
+
+        Call directly on class ``Config.init(config_path=<filepath>)``
+
+        Args:
+            config_class (ConfigModel): ConfigModel class
+            config_path (str): Path to the config file
+            platform_id (str): Name & version of the tool this integrates with, example: ES/8.0.0
+            app_id (str): Name & version of the integration itself, example: get-alerts/1.0.0
+            rf_token (str): Recorded Future API token
+            http_proxy (str): HTTP proxy
+            https_proxy (str): HTTPS proxy
+            client_ssl_verify (bool): SSL verification. Default is True
+            client_basic_auth (tuple): Basic auth credentials
+            client_cert (str or tuple): Client certificate
+            client_timeout (int): Request timeout. Default is 120
+            client_retries (int): Request retries. Default is 5
+            client_backoff_factor (int): Request backoff factor. Default is 1
+            client_status_forcelist (list): Request status forcelist. Default is [502, 503, 504]
+            client_pool_max_size (int): Request pool max size. Default is 120
+            kwargs: Additional arguments
+
+        """
+        config_path = kwargs.get('config_path')
+        if config_path and not Path(config_path).exists():
+            raise ConfigFileError(f'File {config_path} does not exists.')
+
+        log = logging.getLogger(__name__)
+        cls._instance = config_class(**kwargs)
+        gc = cls._instance
+
+        config = deepcopy(gc.model_dump())
+        config.update(gc.model_extra)
+        log.info(f'Configuration Settings: {config}')
+
+
+def get_config():
+    """Return an instance of ``Config``.
+
+    Use this instead of initializing Config directly, so that the same instance is used.
+    """
+    return Config._get_instance()

psengine/config/errors.py

@@ -0,0 +1,18 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+from ..errors import RecordedFutureError
+
+
+class ConfigFileError(RecordedFutureError):
+    """Error raised when config file provided doesnt exist or is not readbale."""