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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: taegis-sdk-python
-Version: 1.6.15
+Version: 1.6.17
 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.17}/taegis_sdk_python/_version.py

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

taegis_sdk_python-1.6.17/taegis_sdk_python/commons/__init__.py

@@ -0,0 +1,33 @@
+"""Taegis Commons - Imports."""
+
+from taegis_sdk_python.commons._introspection import (
+    introspection_mutation,
+    introspection_query,
+    introspection_subscription,
+)
+from taegis_sdk_python.commons.alerts.search import alerts_search
+from taegis_sdk_python.commons.cases.search import cases_search
+from taegis_sdk_python.commons.events.search import events_search
+from taegis_sdk_python.commons.investigations.search import investigations_search
+from taegis_sdk_python.commons.sharelinks.create import (
+    create_alerts_query_sharelink,
+    create_cases_sharelink,
+    create_events_query_sharelink,
+    create_investigations_sharelink,
+    create_sharelink,
+)
+
+__all__ = [
+    "introspection_query",
+    "introspection_mutation",
+    "introspection_subscription",
+    "alerts_search",
+    "cases_search",
+    "events_search",
+    "investigations_search",
+    "create_sharelink",
+    "create_alerts_query_sharelink",
+    "create_events_query_sharelink",
+    "create_investigations_sharelink",
+    "create_cases_sharelink",
+]

taegis_sdk_python-1.6.17/taegis_sdk_python/commons/_introspection.py

@@ -0,0 +1,122 @@
+"""Taegis Commons - Introspection GraphQL operations."""
+
+from typing import Any, Optional
+
+from graphql import GraphQLSchema
+
+from taegis_sdk_python import (
+    GraphQLService,
+    build_output_string_from_introspection,
+    prepare_input,
+)
+
+
+def introspection_query(
+    service: GraphQLService,
+    endpoint: str,
+    schema: Optional[GraphQLSchema] = None,
+    **kwargs
+) -> Any:
+    """Generate a GraphQL Query operation with output based on server-side introspection.
+
+    Parameters
+    ----------
+    service : GraphQLService
+    endpoint : str
+    schema : Optional[GraphQLSchema], optional
+        If not provided, the latest schema will be retrieved from the GQL endpoint. By default, None.
+        Useful when the schmea is not on the core service, but is on a child service (e.g. EventService) that shares the same GQL endpoint.
+    Returns
+    -------
+    Any
+        Usually a dict or list of dicts, depending on the query.
+    """
+    # retreive the latest schema from the GQL endpoint
+    if schema is None:
+        schema = service.core.schema
+    # parse the correct output fields for the desired query from the schema
+    field = schema.query_type.fields.get(endpoint)
+
+    output = build_output_string_from_introspection(field)
+
+    results = service.core.execute_query(
+        endpoint=endpoint,
+        variables={key: prepare_input(value) for key, value in kwargs.items()},
+        output=output,
+    )
+
+    return results.get(endpoint)
+
+
+def introspection_mutation(
+    service: GraphQLService,
+    endpoint: str,
+    schema: Optional[GraphQLSchema] = None,
+    **kwargs
+) -> Any:
+    """Generate a GraphQL Mutation operation with output based on server-side introspection.
+
+    Parameters
+    ----------
+    service : GraphQLService
+    endpoint : str
+    schema : Optional[GraphQLSchema], optional
+        If not provided, the latest schema will be retrieved from the GQL endpoint. By default, None.
+        Useful when the schmea is not on the core service, but is on a child service (e.g. EventService) that shares the same GQL endpoint.
+    Returns
+    -------
+    Any
+        Usually a dict or list of dicts, depending on the query.
+    """
+    # retreive the latest schema from the GQL endpoint
+    if schema is None:
+        schema = service.core.schema
+    # parse the correct output fields for the desired query from the schema
+    field = schema.mutation_type.fields.get(endpoint)
+
+    output = build_output_string_from_introspection(field)
+
+    results = service.core.execute_query(
+        endpoint=endpoint,
+        variables={key: prepare_input(value) for key, value in kwargs.items()},
+        output=output,
+    )
+
+    return results.get(endpoint)
+
+
+def introspection_subscription(
+    service: GraphQLService,
+    endpoint: str,
+    schema: Optional[GraphQLSchema] = None,
+    **kwargs
+) -> Any:
+    """Generate a GraphQL Subscription operation with output based on server-side introspection.
+
+    Parameters
+    ----------
+    service : GraphQLService
+    endpoint : str
+    schema : Optional[GraphQLSchema], optional
+        If not provided, the latest schema will be retrieved from the GQL endpoint. By default, None.
+        Useful when the schmea is not on the core service, but is on a child service (e.g. EventService) that shares the same GQL endpoint.
+    Returns
+    -------
+    Any
+        Usually a dict or list of dicts, depending on the query.
+    """
+    # retreive the latest schema from the GQL endpoint
+    if schema is None:
+        schema = service.core.schema
+    # parse the correct output fields for the desired query from the schema
+    field = schema.subscription_type.fields.get(endpoint)
+
+    output = build_output_string_from_introspection(field)
+
+    results = service.core.execute_query(
+        endpoint=endpoint,
+        variables={key: prepare_input(value) for key, value in kwargs.items()},
+        output=output,
+    )
+
+    return results.get(endpoint)

{taegis_sdk_python-1.6.15 → taegis_sdk_python-1.6.17}/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.17/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.17}/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.17}/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."""