Auto commit from main repo: manual-sync

Author: GitHub Actions

armis_sdk/clients/collectors_client.py

@@ -0,0 +1,124 @@
+import contextlib
+from typing import AsyncIterator
+from typing import Generator
+from typing import IO
+from typing import Union
+
+import httpx
+import universalasync
+
+from armis_sdk.core import response_utils
+from armis_sdk.core.base_entity_client import BaseEntityClient
+from armis_sdk.entities.collector_image import CollectorImage
+from armis_sdk.entities.download_progress import DownloadProgress
+from armis_sdk.enums.collector_image_type import CollectorImageType
+
+
+@universalasync.wrap
+class CollectorsClient(BaseEntityClient):
+    # pylint: disable=line-too-long
+    """
+    A client for interacting with Armis collectors.
+
+    The primary entity for this client is [CollectorImage][armis_sdk.entities.collector_image.CollectorImage].
+    """
+
+    async def download_image(
+        self,
+        destination: Union[str, IO[bytes]],
+        image_type: CollectorImageType = CollectorImageType.OVA,
+    ) -> AsyncIterator[DownloadProgress]:
+        """Download a collector image to a specified destination path / file.
+
+        Args:
+            destination: The file path or file-like object where the collector image will be saved.
+            image_type: The type of collector image to download. Defaults to "OVA".
+
+        Returns:
+            An (async) iterator of `DownloadProgress` object.
+
+        Example:
+            ```python linenums="1" hl_lines="10 15"
+            import asyncio
+
+            from armis_sdk.clients.collectors_client import CollectorsClient
+
+
+            async def main():
+                collectors_client = CollectorsClient()
+
+                # Download to a path
+                async for progress in armis_sdk.collectors.download_image("/tmp/collector.ova"):
+                    print(progress.percent)
+
+                # Download to a file
+                with open("/tmp/collector.ova", "wb") as file:
+                    async for progress in armis_sdk.collectors.download_image(file):
+                        print(progress.percent)
+
+            asyncio.run(main())
+            ```
+            Will output:
+            ```python linenums="1"
+            1%
+            2%
+            3%
+            ```
+            etc.
+        """
+        collector_image = await self.get_image(image_type=image_type)
+        async with httpx.AsyncClient() as client:
+            async with client.stream("GET", collector_image.url) as response:
+                response.raise_for_status()
+                total_size = int(response.headers.get("Content-Length", "0"))
+                with self.open_file(destination) as file:
+                    async for chunk in response.aiter_bytes():
+                        file.write(chunk)
+                        yield DownloadProgress(downloaded=file.tell(), total=total_size)
+
+    async def get_image(
+        self, image_type: CollectorImageType = CollectorImageType.OVA
+    ) -> CollectorImage:
+        """Get collector image information including download URL and credentials.
+
+        Args:
+            image_type: The type of collector image to retrieve. Defaults to "OVA".
+
+        Returns:
+            A `CollectorImage` object.
+
+        Example:
+            ```python linenums="1" hl_lines="8"
+            import asyncio
+
+            from armis_sdk.clients.collectors_client import CollectorsClient
+
+
+            async def main():
+                collectors_client = CollectorsClient()
+                print(await collectors_client.get_image(image_type="OVA"))
+
+            asyncio.run(main())
+            ```
+            Will output:
+            ```python linenums="1"
+            CollectorImage(url="...", ...)
+            ```
+        """
+        async with self._armis_client.client() as client:
+            response = await client.get(
+                "/v3/collectors/_image", params={"image_type": image_type.value}
+            )
+            data = response_utils.get_data_dict(response)
+            return CollectorImage.model_validate(data)
+
+    @classmethod
+    @contextlib.contextmanager
+    def open_file(
+        cls, destination: Union[str, IO[bytes]]
+    ) -> Generator[IO[bytes], None, None]:
+        if isinstance(destination, str):
+            with open(destination, "wb") as file:
+                yield file
+        else:
+            yield destination

armis_sdk/core/armis_sdk.py

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from armis_sdk.clients.assets_client import AssetsClient
+from armis_sdk.clients.collectors_client import CollectorsClient
 from armis_sdk.clients.data_export_client import DataExportClient
 from armis_sdk.clients.device_custom_properties_client import (
     DeviceCustomPropertiesClient,
@@ -19,6 +20,7 @@ class ArmisSdk:  # pylint: disable=too-few-public-methods
     Attributes:
         client (ArmisClient): An instance of [ArmisClient][armis_sdk.core.armis_client.ArmisClient]
         assets (AssetsClient): An instance of [AssetsClient][armis_sdk.clients.assets_client.AssetsClient]
+        collectors (CollectorsClient): An instance of [CollectorsClient][armis_sdk.clients.collectors_client.CollectorsClient]
         data_export (DataExportClient): An instance of [DataExportClient][armis_sdk.clients.data_export_client.DataExportClient]
         device_custom_properties (DeviceCustomPropertiesClient): An instance of [DeviceCustomPropertiesClient][armis_sdk.clients.device_custom_properties_client.DeviceCustomPropertiesClient]
         sites (SitesClient): An instance of [SitesClient][armis_sdk.clients.sites_client.SitesClient]
@@ -42,6 +44,7 @@ async def main():
     def __init__(self, credentials: Optional[ClientCredentials] = None):
         self.client: ArmisClient = ArmisClient(credentials=credentials)
         self.assets: AssetsClient = AssetsClient(self.client)
+        self.collectors: CollectorsClient = CollectorsClient(self.client)
         self.data_export: DataExportClient = DataExportClient(self.client)
         self.device_custom_properties: DeviceCustomPropertiesClient = (
             DeviceCustomPropertiesClient(self.client)

armis_sdk/entities/collector_image.py

@@ -0,0 +1,23 @@
+import datetime
+
+from armis_sdk.core.base_entity import BaseEntity
+from armis_sdk.enums.collector_image_type import CollectorImageType
+from pydantic import Field
+
+
+class CollectorImage(BaseEntity):
+    """
+    An entity that represents the details required to download and run a collector image.
+    """
+
+    image_type: CollectorImageType = Field(strict=False)
+    """The type of the image."""
+
+    image_password: str
+    """The password for the OS that is encapsulated by the image."""
+
+    url: str
+    """The temporary, presigned URL from which the OS image file can be downloaded."""
+
+    url_expiration_date: datetime.datetime = Field(strict=False)
+    """Expiration date of the URL."""

armis_sdk/entities/download_progress.py

@@ -0,0 +1,14 @@
+from armis_sdk.core.base_entity import BaseEntity
+
+
+class DownloadProgress(BaseEntity):
+    downloaded: int
+    """How much bytes were already downloaded."""
+
+    total: int
+    """Total number of bytes to download."""
+
+    @property
+    def percent(self) -> str:
+        """Percentage of progress."""
+        return f"{self.downloaded/self.total:.4%}"

armis_sdk/enums/collector_image_type.py

@@ -0,0 +1,36 @@
+from enum import StrEnum
+
+
+class CollectorImageType(StrEnum):
+    DARWIN_AMD64_BROKER = "DARWIN_AMD64_BROKER"
+    """"""
+
+    DARWIN_ARM64_BROKER = "DARWIN_ARM64_BROKER"
+    """"""
+
+    DEB = "DEB"
+    """"""
+
+    LINUX_AMD64_BROKER = "LINUX_AMD64_BROKER"
+    """"""
+
+    LINUX_ARM64_BROKER = "LINUX_ARM64_BROKER"
+    """"""
+
+    OVA = "OVA"
+    """"""
+
+    QCOW2 = "QCOW2"
+    """"""
+
+    RPM = "RPM"
+    """"""
+
+    VHD = "VHD"
+    """"""
+
+    VHDX = "VHDX"
+    """"""
+
+    WINDOWS_BROKER = "WINDOWS_BROKER"
+    """"""

docs/clients/CollectorsClient.md

@@ -0,0 +1 @@
+::: armis_sdk.clients.collectors_client.CollectorsClient

docs/entities/CollectorImage.md

@@ -0,0 +1 @@
+::: armis_sdk.entities.collector_image.CollectorImage

docs/entities/DownloadProgress.md

@@ -0,0 +1 @@
+::: armis_sdk.entities.download_progress.DownloadProgress

docs/enums/CollectorImageType.md

@@ -0,0 +1 @@
+::: armis_sdk.enums.collector_image_type.CollectorImageType

mkdocs.yml

@@ -13,19 +13,24 @@ nav:
         - RiskFactor: entities/data_export/RiskFactor.md
         - Vulnerability: entities/data_export/Vulnerability.md
       - Boundary: entities/Boundary.md
+      - CollectorImage: entities/CollectorImage.md
       - Device: entities/Device.md
       - DeviceCustomProperty: entities/DeviceCustomProperty.md
+      - DownloadProgress: entities/DownloadProgress.md
       - NetworkInterface: entities/NetworkInterface.md
       - Site: entities/Site.md
   - Clients:
       - AssetsClient: clients/AssetsClient.md
+      - CollectorsClient: clients/CollectorsClient.md
       - DataExportClient: clients/DataExportClient.md
       - DeviceCustomPropertiesClient: clients/DeviceCustomPropertiesClient.md
       - SitesClient: clients/SitesClient.md
   - Core:
       - ArmisClient: core/ArmisClient.md
       - ArmisSdk: core/ArmisSdk.md
       - Errors: core/errors.md
+  - Enums:
+      - CollectorImageType: enums/CollectorImageType.md
   - About Armis: about.md
 
 theme: