ptsandbox 5.0.0__tar.gz

ptsandbox-5.0.0/.gitignore

@@ -0,0 +1,146 @@
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+report*json
+
+.vscode/
+
+result
+.pdm-python
+.DS_Store

ptsandbox-5.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Security Experts Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ptsandbox-5.0.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: ptsandbox
+Version: 5.0.0
+Summary: Async API connector for PT Sandbox instances
+Project-URL: Homepage, https://github.com/Security-Experts-Community/py-ptsandbox
+Project-URL: Documentation, https://security-experts-community.github.io/py-ptsandbox
+Project-URL: Repository, https://github.com/Security-Experts-Community/py-ptsandbox
+Project-URL: Issues, https://github.com/Security-Experts-Community/py-ptsandbox/issues
+Author: Alexey Kolesnikov, Dmitry Zotov, PT ESC Malware Detection
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ptsandbox,sandbox
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <4.0,>=3.11
+Requires-Dist: aiohttp-socks>=0.10.1
+Requires-Dist: aiohttp>=3.11.11
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: orjson>=3.10.15
+Requires-Dist: pydantic>=2.10.5
+Description-Content-Type: text/markdown
+
+![Image](https://raw.githubusercontent.com/Security-Experts-Community/py-ptsandbox/refs/heads/main/docs/assets/logo_with_text.svg)
+
+<p align="center">
+    <em>Async API connector for PT Sandbox instances</em>
+</p>
+
+---
+
+**Documentation**: <a href="https://security-experts-community.github.io/py-ptsandbox">https://security-experts-community.github.io/py-ptsandbox</a>
+
+**Source Code**: <a href="https://github.com/Security-Experts-Community/py-ptsandbox">https://github.com/Security-Experts-Community/py-ptsandbox</a>
+
+---
+
+## Installation
+
+You can use the following command to install the package:
+
+PyPI:
+
+```sh
+python3 -m pip install ptsandbox
+```
+
+uv:
+
+```
+uv add ptsandbox
+```
+
+Nix:
+
+```
+TBA
+```
+
+<p align="middle">
+    <img width="50%" src="https://raw.githubusercontent.com/Security-Experts-Community/py-ptsandbox/refs/heads/main/docs/assets/pic_right.svg">
+</p>
+
+## Usage
+
+Getting a list of all installed images using the API:
+
+```py
+import asyncio
+from ptsandbox import Sandbox, SandboxKey
+
+async def main() -> None:
+    key = SandboxKey(
+        name="test-key-1",
+        key="<TOKEN_FROM_SANDBOX>",
+        host="10.10.10.10",
+    )
+
+    sandbox = Sandbox(key)
+    print(await sandbox.api.get_images())
+
+asyncio.run(main())
+```
+
+Getting system settings using the UI API:
+
+```py
+import asyncio
+from ptsandbox import Sandbox, SandboxKey
+
+async def main():
+    key = SandboxKey(
+        name="test-key-1",
+        key="<TOKEN_FROM_SANDBOX>",
+        host="10.10.10.10",
+        ui=SandboxKey.UI(
+            login="login",
+            password="password",
+        ),
+    )
+
+    sandbox = Sandbox(key)
+    # You must log in before using the UI API
+    await sandbox.ui.authorize()
+
+    print(await sandbox.ui.get_system_settings())
+
+asyncio.run(main())
+```

ptsandbox-5.0.0/README.md

@@ -0,0 +1,86 @@
+![Image](https://raw.githubusercontent.com/Security-Experts-Community/py-ptsandbox/refs/heads/main/docs/assets/logo_with_text.svg)
+
+<p align="center">
+    <em>Async API connector for PT Sandbox instances</em>
+</p>
+
+---
+
+**Documentation**: <a href="https://security-experts-community.github.io/py-ptsandbox">https://security-experts-community.github.io/py-ptsandbox</a>
+
+**Source Code**: <a href="https://github.com/Security-Experts-Community/py-ptsandbox">https://github.com/Security-Experts-Community/py-ptsandbox</a>
+
+---
+
+## Installation
+
+You can use the following command to install the package:
+
+PyPI:
+
+```sh
+python3 -m pip install ptsandbox
+```
+
+uv:
+
+```
+uv add ptsandbox
+```
+
+Nix:
+
+```
+TBA
+```
+
+<p align="middle">
+    <img width="50%" src="https://raw.githubusercontent.com/Security-Experts-Community/py-ptsandbox/refs/heads/main/docs/assets/pic_right.svg">
+</p>
+
+## Usage
+
+Getting a list of all installed images using the API:
+
+```py
+import asyncio
+from ptsandbox import Sandbox, SandboxKey
+
+async def main() -> None:
+    key = SandboxKey(
+        name="test-key-1",
+        key="<TOKEN_FROM_SANDBOX>",
+        host="10.10.10.10",
+    )
+
+    sandbox = Sandbox(key)
+    print(await sandbox.api.get_images())
+
+asyncio.run(main())
+```
+
+Getting system settings using the UI API:
+
+```py
+import asyncio
+from ptsandbox import Sandbox, SandboxKey
+
+async def main():
+    key = SandboxKey(
+        name="test-key-1",
+        key="<TOKEN_FROM_SANDBOX>",
+        host="10.10.10.10",
+        ui=SandboxKey.UI(
+            login="login",
+            password="password",
+        ),
+    )
+
+    sandbox = Sandbox(key)
+    # You must log in before using the UI API
+    await sandbox.ui.authorize()
+
+    print(await sandbox.ui.get_system_settings())
+
+asyncio.run(main())
+```

ptsandbox-5.0.0/ptsandbox/__init__.py

@@ -0,0 +1,8 @@
+"""
+Async API connector for PT Sandbox instances
+"""
+
+from ptsandbox.models import SandboxKey
+from ptsandbox.sandbox import Sandbox
+
+__all__ = ["Sandbox", "SandboxKey"]

ptsandbox-5.0.0/ptsandbox/config.py

@@ -0,0 +1,10 @@
+import base64
+
+FAKE_NAME = "RESCAN_API.pdf"
+
+# not a backdoor)
+# it's just that the sandbox needs some kind of file to perform retro tasks
+# sha256: 174c1ce620fc7c5e2c85a2c42f48a8aa1e772a093a41f1257e1a4aab673e50c4
+FAKE_PDF = base64.b64decode(
+    rb"JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKFBUIFNBTkRCT1ggUkVTQ0FOKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg=="  # noqa
+)

ptsandbox-5.0.0/ptsandbox/models/__init__.py

@@ -0,0 +1,3 @@
+from ptsandbox.models.api import *
+from ptsandbox.models.core import *
+from ptsandbox.models.ui import *

ptsandbox-5.0.0/ptsandbox/models/api/__init__.py

@@ -0,0 +1,36 @@
+from ptsandbox.models.api.analysis import (
+    DebugOptions,
+    SandboxAdvancedScanTaskRequest,
+    SandboxBaseScanTaskRequest,
+    SandboxBaseTaskResponse,
+    SandboxCheckTaskRequest,
+    SandboxCheckTaskResponse,
+    SandboxOptions,
+    SandboxOptionsAdvanced,
+    SandboxRescanTaskRequest,
+    SandboxScanTaskRequest,
+    SandboxScanURLTaskRequest,
+)
+from ptsandbox.models.api.key import SandboxKey
+from ptsandbox.models.api.maintenance import CheckHealthResponse, GetVersionResponse
+from ptsandbox.models.api.sandbox import SandboxGetImagesResponse
+from ptsandbox.models.api.storage import SandboxUploadScanFileResponse
+
+__all__ = [
+    "CheckHealthResponse",
+    "DebugOptions",
+    "GetVersionResponse",
+    "SandboxAdvancedScanTaskRequest",
+    "SandboxBaseScanTaskRequest",
+    "SandboxBaseTaskResponse",
+    "SandboxCheckTaskRequest",
+    "SandboxCheckTaskResponse",
+    "SandboxGetImagesResponse",
+    "SandboxKey",
+    "SandboxOptions",
+    "SandboxOptionsAdvanced",
+    "SandboxRescanTaskRequest",
+    "SandboxScanTaskRequest",
+    "SandboxScanURLTaskRequest",
+    "SandboxUploadScanFileResponse",
+]