taegis-sdk-python 1.6.15__tar.gz → 1.6.16__tar.gz

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: taegis-sdk-python
-Version: 1.6.15
+Version: 1.6.16
 Summary: Taegis Python SDK
 Project-URL: Homepage, https://github.com/secureworks/taegis-sdk-python
 Project-URL: Bug Reports, https://github.com/secureworks/taegis-sdk-python/issues

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.16}/taegis_sdk_python/_version.py

@@ -1,3 +1,3 @@
 """Version idenitier."""
 
-__version__ = "1.6.15"
+__version__ = "1.6.16"

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.16}/taegis_sdk_python/middlewares/__init__.py

@@ -1,6 +1,7 @@
 """Taegis SDK Middlewares."""
 
+from taegis_sdk_python.middlewares.curl import to_curl
 from taegis_sdk_python.middlewares.logging import headers_logging_middleware
 from taegis_sdk_python.middlewares.retry import retry_middleware
 
-__all__ = ["headers_logging_middleware", "retry_middleware"]
+__all__ = ["headers_logging_middleware", "retry_middleware", "to_curl"]

taegis_sdk_python-1.6.16/taegis_sdk_python/middlewares/curl/__init__.py

@@ -0,0 +1,5 @@
+"""Taegis SDK Curl Middlewares."""
+
+from ._default import to_curl
+
+__all__ = ["to_curl"]

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.16}/taegis_sdk_python/middlewares/curl/_default.py

@@ -3,12 +3,7 @@
 import logging
 from shlex import quote
 
-from aiohttp import (
-    BytesPayload,
-    ClientHandlerType,
-    ClientRequest,
-    ClientResponse,
-)
+from aiohttp import BytesPayload, ClientHandlerType, ClientRequest, ClientResponse
 
 from taegis_sdk_python.middlewares.utils import scrub_dict
 
@@ -42,7 +37,9 @@ async def to_curl(request: ClientRequest, handler: ClientHandlerType) -> ClientR
         if isinstance(body, (bytes, BytesPayload)):
             body = body.decode("utf-8")
         else:
-            log.error(f"Unsupported body type for curl middleware: {type(body)}, request.body must be bytes or BytesPayload")
+            log.error(
+                f"Unsupported body type for curl middleware: {type(body)}, request.body must be bytes or BytesPayload"
+            )
             return await handler(request)
 
         data_type = "-d"

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.16}/taegis_sdk_python/services/__init__.py

@@ -34,6 +34,7 @@ from taegis_sdk_python.services.byoti import ByotiService
 from taegis_sdk_python.services.clients import ClientsService
 from taegis_sdk_python.services.collector import CollectorService
 from taegis_sdk_python.services.comments import CommentsService
+from taegis_sdk_python.services.context_summarizer import ContextSummarizerService
 from taegis_sdk_python.services.contracted_endpoint import ContractedEndpointService
 from taegis_sdk_python.services.cql_metadata import CqlMetadataService
 from taegis_sdk_python.services.datasources import DatasourcesService
@@ -47,6 +48,7 @@ from taegis_sdk_python.services.endpoint_management_service import (
 from taegis_sdk_python.services.entity_context import EntityContextService
 from taegis_sdk_python.services.escalation_policies import EscalationPoliciesService
 from taegis_sdk_python.services.event_search import EventSearchService
+from taegis_sdk_python.services.event_stats import EventStatsService
 from taegis_sdk_python.services.events import EventsService
 from taegis_sdk_python.services.exports import ExportsService
 from taegis_sdk_python.services.fast_ioc import FastIocService
@@ -204,6 +206,7 @@ class GraphQLService:
         self._clients = None
         self._collector = None
         self._comments = None
+        self._context_summarizer = None
         self._contracted_endpoint = None
         self._cql_metadata = None
         self._datasources = None
@@ -212,6 +215,7 @@ class GraphQLService:
         self._endpoint_management_service = None
         self._entity_context = None
         self._event_search = None
+        self._event_stats = None
         self._escalation_policies = None
         self._events = None
         self._exports = None
@@ -584,6 +588,13 @@ class GraphQLService:
             self._comments = CommentsService(self)
         return self._comments
 
+    @property
+    def context_summarizer(self):
+        """Context Summarizer Service Endpoint."""
+        if not self._context_summarizer:
+            self._context_summarizer = ContextSummarizerService(self)
+        return self._context_summarizer
+
     @property
     def contracted_endpoint(self):
         """ContractedEndpoint Service Endpoint."""
@@ -647,6 +658,13 @@ class GraphQLService:
             self._event_search = EventSearchService(self)
         return self._event_search
 
+    @property
+    def event_stats(self):
+        """EventStats Service Endpoint."""
+        if not self._event_stats:
+            self._event_stats = EventStatsService(self)
+        return self._event_stats
+
     @property
     def events(self):
         """Events Service Endpoint."""

taegis_sdk_python-1.6.16/taegis_sdk_python/services/context_summarizer/__init__.py

@@ -0,0 +1,30 @@
+"""ContextSummarizer Service."""
+
+from taegis_sdk_python.service_core import ServiceCore
+from taegis_sdk_python.services.context_summarizer.mutations import TaegisSDKContextSummarizerMutation
+from taegis_sdk_python.services.context_summarizer.queries import TaegisSDKContextSummarizerQuery
+from taegis_sdk_python.services.context_summarizer.subscriptions import (
+    TaegisSDKContextSummarizerSubscription,
+)
+
+
+class ContextSummarizerService(ServiceCore):
+    """Taegis ContextSummarizer Service."""
+
+    @property
+    def query(self):
+        if not self._queries:
+            self._queries = TaegisSDKContextSummarizerQuery(self)
+        return self._queries
+
+    @property
+    def mutation(self):
+        if not self._mutations:
+            self._mutations = TaegisSDKContextSummarizerMutation(self)
+        return self._mutations
+
+    @property
+    def subscription(self):
+        if not self._subscriptions:
+            self._subscriptions = TaegisSDKContextSummarizerSubscription(self)
+        return self._subscriptions

taegis_sdk_python-1.6.16/taegis_sdk_python/services/context_summarizer/mutations.py

@@ -0,0 +1,33 @@
+"""ContextSummarizer Mutation."""
+
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python._consts import TaegisEnum
+from taegis_sdk_python.services.context_summarizer.types import *
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.context_summarizer import ContextSummarizerService
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKContextSummarizerMutation:
+    """Taegis Context_summarizer Mutation operations."""
+
+    def __init__(self, service: ContextSummarizerService):
+        self.service = service

taegis_sdk_python-1.6.16/taegis_sdk_python/services/context_summarizer/queries.py

@@ -0,0 +1,212 @@
+"""ContextSummarizer Query."""
+
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python._consts import TaegisEnum
+from taegis_sdk_python.services.context_summarizer.types import *
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.context_summarizer import ContextSummarizerService
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKContextSummarizerQuery:
+    """Taegis Context_summarizer Query operations."""
+
+    def __init__(self, service: ContextSummarizerService):
+        self.service = service
+
+    def generative_ai_monthly_billing(
+        self,
+        begin_year: int,
+        begin_month: int,
+        end_year: Optional[int] = None,
+        end_month: Optional[int] = None,
+    ) -> BillingMonthEstimate:
+        """Estimate the billing for a month, or many months."""
+        endpoint = "generativeAIMonthlyBilling"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "beginYear": prepare_input(begin_year),
+                "beginMonth": prepare_input(begin_month),
+                "endYear": prepare_input(end_year),
+                "endMonth": prepare_input(end_month),
+            },
+            output=build_output_string(
+                BillingMonthEstimate,
+                exclude_deprecated_output=self.service.exclude_deprecated_output,
+            ),
+        )
+        if result.get(endpoint) is not None:
+            return BillingMonthEstimate.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query generativeAIMonthlyBilling")
+
+    def generative_ai_alert_description(self, alert_id: str) -> str:
+        """Generate better alert descriptions using OpenAI and the alert's event filter rules."""
+        endpoint = "generativeAIAlertDescription"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "alertId": prepare_input(alert_id),
+            },
+            output="",
+        )
+        if result.get(endpoint) is not None:
+            return result.get(endpoint)
+        raise GraphQLNoRowsInResultSetError("for query generativeAIAlertDescription")
+
+    def generative_ai_alert_event_explain(self, alert_id: str) -> str:
+        """Explain the alert's events based on their content."""
+        endpoint = "generativeAIAlertEventExplain"
+
+        log.warning(
+            f"GraphQL Query `{endpoint}` is deprecated: 'Use generativeAIEventExplain instead'"
+        )
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "alertId": prepare_input(alert_id),
+            },
+            output="",
+        )
+        if result.get(endpoint) is not None:
+            return result.get(endpoint)
+        raise GraphQLNoRowsInResultSetError("for query generativeAIAlertEventExplain")
+
+    def generative_ai_event_explain(
+        self, input_: EventExplanationInput
+    ) -> List[EventExplanation]:
+        """Explain the alert's events based on their content."""
+        endpoint = "generativeAIEventExplain"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(
+                EventExplanation,
+                exclude_deprecated_output=self.service.exclude_deprecated_output,
+            ),
+        )
+        if result.get(endpoint) is not None:
+            return EventExplanation.schema().load(
+                [r or {} for r in result.get(endpoint)], many=True
+            )
+        raise GraphQLNoRowsInResultSetError("for query generativeAIEventExplain")
+
+    def explain_command_lines(
+        self, input_: CommandLineExplanationInput
+    ) -> List[CommandLineExplanation]:
+        """Explain the alert's command line events based on their content."""
+        endpoint = "explainCommandLines"
+
+        log.warning(
+            f"GraphQL Query `{endpoint}` is deprecated: 'Use generativeAIEventExplain instead'"
+        )
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "input": prepare_input(input_),
+            },
+            output=build_output_string(
+                CommandLineExplanation,
+                exclude_deprecated_output=self.service.exclude_deprecated_output,
+            ),
+        )
+        if result.get(endpoint) is not None:
+            return CommandLineExplanation.schema().load(
+                [r or {} for r in result.get(endpoint)], many=True
+            )
+        raise GraphQLNoRowsInResultSetError("for query explainCommandLines")
+
+    def generative_ai_alert_analysis(
+        self,
+        alert_id: str,
+        fetch_unconditionally: Optional[bool] = None,
+        follow_up_prompt: Optional[str] = None,
+    ) -> str:
+        """Derive an analysis of the alert from its overall content."""
+        endpoint = "generativeAIAlertAnalysis"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "alertId": prepare_input(alert_id),
+                "fetchUnconditionally": prepare_input(fetch_unconditionally),
+                "followUpPrompt": prepare_input(follow_up_prompt),
+            },
+            output="",
+        )
+        if result.get(endpoint) is not None:
+            return result.get(endpoint)
+        raise GraphQLNoRowsInResultSetError("for query generativeAIAlertAnalysis")
+
+    def generative_ai_case_summary(
+        self,
+        case_id: str,
+        cache_options: Optional[ContextSummarizerCacheOptions] = None,
+    ) -> ContextSummarizerCaseSummary:
+        """Generate a summary of a Case(formerly, Investigation) based on analyses of its Alerts."""
+        endpoint = "generativeAICaseSummary"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "caseId": prepare_input(case_id),
+                "cacheOptions": prepare_input(cache_options),
+            },
+            output=build_output_string(
+                ContextSummarizerCaseSummary,
+                exclude_deprecated_output=self.service.exclude_deprecated_output,
+            ),
+        )
+        if result.get(endpoint) is not None:
+            return ContextSummarizerCaseSummary.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query generativeAICaseSummary")
+
+    def generative_ai_key_findings(
+        self,
+        case_id: str,
+        cache_options: Optional[ContextSummarizerCacheOptions] = None,
+        output_format: Optional[Union[OutputFormat, TaegisEnum]] = None,
+    ) -> ContextSummarizerKeyFindings:
+        """Generate key findings for a Case based on analyses of its Alerts."""
+        endpoint = "generativeAIKeyFindings"
+
+        result = self.service.execute_query(
+            endpoint=endpoint,
+            variables={
+                "caseId": prepare_input(case_id),
+                "cacheOptions": prepare_input(cache_options),
+                "outputFormat": prepare_input(output_format),
+            },
+            output=build_output_string(
+                ContextSummarizerKeyFindings,
+                exclude_deprecated_output=self.service.exclude_deprecated_output,
+            ),
+        )
+        if result.get(endpoint) is not None:
+            return ContextSummarizerKeyFindings.from_dict(result.get(endpoint))
+        raise GraphQLNoRowsInResultSetError("for query generativeAIKeyFindings")

taegis_sdk_python-1.6.16/taegis_sdk_python/services/context_summarizer/subscriptions.py

@@ -0,0 +1,33 @@
+"""ContextSummarizer Subscription."""
+
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code, wildcard-import, unused-wildcard-import, cyclic-import
+
+
+# Autogenerated
+# DO NOT MODIFY
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+
+from taegis_sdk_python import GraphQLNoRowsInResultSetError
+from taegis_sdk_python._consts import TaegisEnum
+from taegis_sdk_python.services.context_summarizer.types import *
+from taegis_sdk_python.utils import (
+    build_output_string,
+    parse_union_result,
+    prepare_input,
+)
+
+if TYPE_CHECKING:  # pragma: no cover
+    from taegis_sdk_python.services.context_summarizer import ContextSummarizerService
+
+log = logging.getLogger(__name__)
+
+
+class TaegisSDKContextSummarizerSubscription:
+    """Taegis Context_summarizer Subscription operations."""
+
+    def __init__(self, service: ContextSummarizerService):
+        self.service = service

taegis_sdk_python-1.6.16/taegis_sdk_python/services/context_summarizer/types.py

@@ -0,0 +1,187 @@
+"""ContextSummarizer Types and Enums."""
+
+# pylint: disable=no-member, unused-argument, too-many-locals, duplicate-code
+
+# Autogenerated
+# DO NOT MODIFY
+
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+from dataclasses_json import config, dataclass_json
+
+from taegis_sdk_python._consts import TaegisEnum
+from taegis_sdk_python.utils import decode_enum, encode_enum, parse_union_result
+
+
+class CacheState(str, Enum):
+    """CacheState."""
+
+    IN_PROGRESS = "IN_PROGRESS"
+    CACHE_HIT = "CACHE_HIT"
+    CACHE_MISS = "CACHE_MISS"
+
+
+class ContextSummarizerCacheStyle(str, Enum):
+    """ContextSummarizerCacheStyle."""
+
+    ONLY = "only"
+    FIRST = "first"
+    LAST = "last"
+    NEVER = "never"
+
+
+class OutputFormat(str, Enum):
+    """OutputFormat."""
+
+    TEXT = "TEXT"
+    MARKDOWN = "MARKDOWN"
+    RICH_TEXT = "RICH_TEXT"
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class CommandLineExplanationInput:
+    """CommandLineExplanationInput."""
+
+    events: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="events")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class EventExplanationInput:
+    """EventExplanationInput."""
+
+    events: Optional[List[str]] = field(
+        default=None, metadata=config(field_name="events")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class CommandLineExplanation:
+    """CommandLineExplanation."""
+
+    command: Optional[str] = field(default=None, metadata=config(field_name="command"))
+    explanation: Optional[str] = field(
+        default=None, metadata=config(field_name="explanation")
+    )
+    event: Optional[str] = field(default=None, metadata=config(field_name="event"))
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class EventExplanation:
+    """EventExplanation."""
+
+    explanation: Optional[str] = field(
+        default=None, metadata=config(field_name="explanation")
+    )
+    error: Optional[str] = field(default=None, metadata=config(field_name="error"))
+    event: Optional[str] = field(default=None, metadata=config(field_name="event"))
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class TenantAmount:
+    """TenantAmount."""
+
+    tenant_id: Optional[str] = field(
+        default=None, metadata=config(field_name="tenantId")
+    )
+    amount: Optional[float] = field(default=None, metadata=config(field_name="amount"))
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class BillingMonthEstimate:
+    """BillingMonthEstimate."""
+
+    begin_year: Optional[int] = field(
+        default=None, metadata=config(field_name="beginYear")
+    )
+    begin_month: Optional[int] = field(
+        default=None, metadata=config(field_name="beginMonth")
+    )
+    end_year: Optional[int] = field(default=None, metadata=config(field_name="endYear"))
+    end_month: Optional[int] = field(
+        default=None, metadata=config(field_name="endMonth")
+    )
+    usd_total: Optional[float] = field(
+        default=None, metadata=config(field_name="usdTotal")
+    )
+    usd_per_tenant_id: Optional[List[TenantAmount]] = field(
+        default=None, metadata=config(field_name="usdPerTenantId")
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class ContextSummarizerCacheResults:
+    """ContextSummarizerCacheResults."""
+
+    generated_at: Optional[int] = field(
+        default=None, metadata=config(field_name="generatedAt")
+    )
+    generated_at_str: Optional[str] = field(
+        default=None, metadata=config(field_name="generatedAtStr")
+    )
+    cache_state: Optional[Union[CacheState, TaegisEnum]] = field(
+        default=None,
+        metadata=config(
+            encoder=encode_enum,
+            decoder=lambda x: decode_enum(CacheState, x),
+            field_name="cacheState",
+        ),
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class ContextSummarizerCacheOptions:
+    """ContextSummarizerCacheOptions."""
+
+    try_cache_how: Optional[Union[ContextSummarizerCacheStyle, TaegisEnum]] = field(
+        default=None,
+        metadata=config(
+            encoder=encode_enum,
+            decoder=lambda x: decode_enum(ContextSummarizerCacheStyle, x),
+            field_name="tryCacheHow",
+        ),
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class ContextSummarizerKeyFindings:
+    """ContextSummarizerKeyFindings."""
+
+    summary: Optional[str] = field(default=None, metadata=config(field_name="summary"))
+    key_findings: Optional[str] = field(
+        default=None, metadata=config(field_name="keyFindings")
+    )
+    cache_results: Optional[ContextSummarizerCacheResults] = field(
+        default=None, metadata=config(field_name="cacheResults")
+    )
+    output_format: Optional[Union[OutputFormat, TaegisEnum]] = field(
+        default=None,
+        metadata=config(
+            encoder=encode_enum,
+            decoder=lambda x: decode_enum(OutputFormat, x),
+            field_name="outputFormat",
+        ),
+    )
+
+
+@dataclass_json
+@dataclass(order=True, eq=True, frozen=True)
+class ContextSummarizerCaseSummary:
+    """ContextSummarizerCaseSummary."""
+
+    summary: Optional[str] = field(default=None, metadata=config(field_name="summary"))
+    cache_results: Optional[ContextSummarizerCacheResults] = field(
+        default=None, metadata=config(field_name="cacheResults")
+    )

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.16}/taegis_sdk_python/services/entity_context/mutations.py

@@ -62,3 +62,20 @@ class TaegisSDKEntityContextMutation:
                 result.get(endpoint)
             )
         raise GraphQLNoRowsInResultSetError("for mutation entityContextAddTo")
+
+    def entity_context_identity_teardown(self, provider_id: str) -> bool:
+        """No developer notes."""
+        endpoint = "entityContextIdentityTeardown"
+
+        result = self.service.execute_mutation(
+            endpoint=endpoint,
+            variables={
+                "providerID": prepare_input(provider_id),
+            },
+            output="",
+        )
+        if result.get(endpoint) is not None:
+            return result.get(endpoint)
+        raise GraphQLNoRowsInResultSetError(
+            "for mutation entityContextIdentityTeardown"
+        )

taegis_sdk_python-1.6.16/taegis_sdk_python/services/event_stats/__init__.py

@@ -0,0 +1,30 @@
+"""EventStats Service."""
+
+from taegis_sdk_python.service_core import ServiceCore
+from taegis_sdk_python.services.event_stats.mutations import TaegisSDKEventStatsMutation
+from taegis_sdk_python.services.event_stats.queries import TaegisSDKEventStatsQuery
+from taegis_sdk_python.services.event_stats.subscriptions import (
+    TaegisSDKEventStatsSubscription,
+)
+
+
+class EventStatsService(ServiceCore):
+    """Taegis EventStats Service."""
+
+    @property
+    def query(self):
+        if not self._queries:
+            self._queries = TaegisSDKEventStatsQuery(self)
+        return self._queries
+
+    @property
+    def mutation(self):
+        if not self._mutations:
+            self._mutations = TaegisSDKEventStatsMutation(self)
+        return self._mutations
+
+    @property
+    def subscription(self):
+        if not self._subscriptions:
+            self._subscriptions = TaegisSDKEventStatsSubscription(self)
+        return self._subscriptions