taegis-sdk-python 1.0.6__tar.gz → 1.6.9__tar.gz

taegis_sdk_python-1.6.9/.gitignore

@@ -0,0 +1,170 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# MacOS directories
+.Trash
+.DS_Store
+
+# VS Code project files
+.vs/
+.vscode/
+
+local_notebooks/

taegis_sdk_python-1.6.9/PKG-INFO

@@ -0,0 +1,321 @@
+Metadata-Version: 2.4
+Name: taegis-sdk-python
+Version: 1.6.9
+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
+Project-URL: Source, https://github.com/secureworks/taegis-sdk-python
+Project-URL: Package, https://pypi.org/project/taegis-sdk-python/
+Author-email: Micah Pegman <sdks@secureworks.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: aiohttp
+Requires-Dist: backoff
+Requires-Dist: dataclasses-json
+Requires-Dist: filelock>=3.12.4
+Requires-Dist: gql>=4
+Requires-Dist: graphql-core
+Requires-Dist: jinja2
+Requires-Dist: oauthlib
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: python-dateutil
+Requires-Dist: requests
+Requires-Dist: requests-oauthlib
+Requires-Dist: requests-toolbelt
+Requires-Dist: websockets
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: pylint==3.2.3; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Taegis SDK for Python
+
+The Taegis SDK is a Python library for interfacing with the GraphQL APIs in Taegis.
+
+## Prerequisites
+
+- Python 3.8 or higher.
+
+## Authentication
+
+- Set `CLIENT_ID` and `CLIENT_SECRET` environment variables as described in the [Taegis XDR Documenation](https://docs.ctpx.secureworks.com/apis/api_authenticate/).
+
+OR
+
+- Login using username/password with mfa upon service creation
+
+OR
+
+- Device Code SSO
+
+
+## Installation
+
+```bash
+python -m pip install taegis-sdk-python
+```
+
+
+## Using the SDK
+
+To use the SDK, you must first import the `GraphQLService`
+
+
+```python
+from taegis_sdk_python import GraphQLService
+from pprint import pprint as pp
+service = GraphQLService()
+```
+
+Now that you have the `GraphQLService`, you can make requests and process responses for `Taegis XDR Services`. The following example uses the `Investigations Service` to send a query to get all available investigations
+
+```python
+result = service.investigations.query.investigations_search(
+    page=1,
+    per_page=3,
+    query="WHERE deleted_at IS NOT NULL EARLIEST=-90d"
+)
+pp(result)
+```
+
+```python
+result = service.tenants.query.tenants(tenants_query=TenantsQuery(
+    max_results=10,
+    page_num=1,
+))
+pp(result)
+```
+
+```python
+results = service.events.subscription.event_query(
+    query="FROM process EARLIEST=-1d",
+    options=EventQueryOptions(
+        max_rows=20,
+        page_size=10,
+        skip_cache=True,
+    ),
+)
+pp(results)
+print()
+try:
+    next_page = next(
+        iter(
+            {
+                result.next
+                for result in results
+                if result.next
+            }
+        )
+    )
+except StopIteration:
+    next_page = None
+
+if next_page:
+    results = service.events.subscription.event_page(page_id=next_page)
+    pp(results)
+```
+
+### Getting Started Exploring the Schema
+
+```python
+from taegis_sdk_python import GraphQLService
+
+service = GraphQLService()
+schema = service.core.get_sync_schema()
+```
+
+For more in depth analysis see: [Exploring the Schema](docs/exploring_the_schema.md)
+
+
+###
+
+For more information see the [Getting Started](docs/getting_started.md)

taegis_sdk_python-1.6.9/README.md

@@ -0,0 +1,102 @@
+# Taegis SDK for Python
+
+The Taegis SDK is a Python library for interfacing with the GraphQL APIs in Taegis.
+
+## Prerequisites
+
+- Python 3.8 or higher.
+
+## Authentication
+
+- Set `CLIENT_ID` and `CLIENT_SECRET` environment variables as described in the [Taegis XDR Documenation](https://docs.ctpx.secureworks.com/apis/api_authenticate/).
+
+OR
+
+- Login using username/password with mfa upon service creation
+
+OR
+
+- Device Code SSO
+
+
+## Installation
+
+```bash
+python -m pip install taegis-sdk-python
+```
+
+
+## Using the SDK
+
+To use the SDK, you must first import the `GraphQLService`
+
+
+```python
+from taegis_sdk_python import GraphQLService
+from pprint import pprint as pp
+service = GraphQLService()
+```
+
+Now that you have the `GraphQLService`, you can make requests and process responses for `Taegis XDR Services`. The following example uses the `Investigations Service` to send a query to get all available investigations
+
+```python
+result = service.investigations.query.investigations_search(
+    page=1,
+    per_page=3,
+    query="WHERE deleted_at IS NOT NULL EARLIEST=-90d"
+)
+pp(result)
+```
+
+```python
+result = service.tenants.query.tenants(tenants_query=TenantsQuery(
+    max_results=10,
+    page_num=1,
+))
+pp(result)
+```
+
+```python
+results = service.events.subscription.event_query(
+    query="FROM process EARLIEST=-1d",
+    options=EventQueryOptions(
+        max_rows=20,
+        page_size=10,
+        skip_cache=True,
+    ),
+)
+pp(results)
+print()
+try:
+    next_page = next(
+        iter(
+            {
+                result.next
+                for result in results
+                if result.next
+            }
+        )
+    )
+except StopIteration:
+    next_page = None
+
+if next_page:
+    results = service.events.subscription.event_page(page_id=next_page)
+    pp(results)
+```
+
+### Getting Started Exploring the Schema
+
+```python
+from taegis_sdk_python import GraphQLService
+
+service = GraphQLService()
+schema = service.core.get_sync_schema()
+```
+
+For more in depth analysis see: [Exploring the Schema](docs/exploring_the_schema.md)
+
+
+###
+
+For more information see the [Getting Started](docs/getting_started.md)

taegis_sdk_python-1.6.9/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "taegis-sdk-python"
+dynamic = ["version"]
+description = "Taegis Python SDK"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+authors = [{ name = "Micah Pegman", email = "sdks@secureworks.com" }]
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "aiohttp",
+    "dataclasses-json",
+    "filelock>=3.12.4",
+    "gql>=4",
+    "graphql-core",
+    "oauthlib",
+    "pyjwt>=2.8.0",
+    "python-dateutil",
+    "requests",
+    "requests-oauthlib",
+    "requests-toolbelt",
+    "websockets",
+    "jinja2",
+    "backoff",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-mock",
+    "coverage",
+]
+dev = [
+    "pylint==3.2.3",
+    "black",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/secureworks/taegis-sdk-python"
+"Bug Reports" = "https://github.com/secureworks/taegis-sdk-python/issues"
+"Source" = "https://github.com/secureworks/taegis-sdk-python"
+"Package" = "https://pypi.org/project/taegis-sdk-python/"
+
+[tool.hatch.version]
+path = "taegis_sdk_python/_version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/taegis_sdk_python",
+]
+
+[tool.hatch.envs.venv]
+type = "virtual"
+installer = "uv"

{taegis-sdk-python-1.0.6 → taegis_sdk_python-1.6.9}/taegis_sdk_python/__init__.py

@@ -1,27 +1,28 @@
 """
 Commonly-used functions and data types from this package.
 """
+
 from taegis_sdk_python.errors import (
-    ServiceCoreException,
-    InvalidAuthenticationMethod,
     AccessTokenException,
-    MissingAccessTokenError,
-    InvalidAccessTokenError,
     GraphQLNoRowsInResultSetError,
     InvalidAccessTokenClaims,
+    InvalidAccessTokenError,
+    InvalidAuthenticationMethod,
     InvalidGraphQLEndpoint,
+    MissingAccessTokenError,
+    ServiceCoreException,
 )
-
 from taegis_sdk_python.services import GraphQLService
 from taegis_sdk_python.utils import (
     build_output_string,
+    build_output_string_from_introspection,
+    parse_union_result,
     prepare_input,
     prepare_variables,
-    parse_union_result,
-    build_output_string_from_introspection,
 )
 
-__all__ = [  # pylint: disable=duplicate-code
+# pylint: disable=duplicate-code
+__all__ = [
     "GraphQLService",
     "ServiceCoreException",
     "InvalidAuthenticationMethod",