polyswarm-api 3.7.0__tar.gz → 3.8.0__tar.gz

{polyswarm-api-3.7.0/src/polyswarm_api.egg-info → polyswarm-api-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyswarm-api
-Version: 3.7.0
+Version: 3.8.0
 Summary: Client library to simplify interacting with the PolySwarm consumer API
 Home-page: https://github.com/polyswarm/polyswarm-api
 Author: PolySwarm Developers

{polyswarm-api-3.7.0 → polyswarm-api-3.8.0}/setup.py

@@ -9,7 +9,7 @@ with open('README.md', 'r') as readme:
 
 setup(
     name='polyswarm-api',
-    version='3.7.0',
+    version='3.8.0',
     description='Client library to simplify interacting with the PolySwarm consumer API',
     long_description=long_description,
     long_description_content_type='text/markdown',

{polyswarm-api-3.7.0 → polyswarm-api-3.8.0}/src/polyswarm_api/__init__.py

@@ -1,5 +1,5 @@
 # https://www.python.org/dev/peps/pep-0008/#module-level-dunder-names
-__version__ = '3.7.0'
+__version__ = '3.8.0'
 __release_url__ = 'https://api.github.com/repos/polyswarm/polyswarm-api/releases/latest'
 
 from . import api

{polyswarm-api-3.7.0 → polyswarm-api-3.8.0}/src/polyswarm_api/api.py

@@ -211,14 +211,26 @@ class PolyswarmAPI:
         logger.info('Deleting known good ioc %s', id)
         return resources.IOC.delete_known_good(self, id).result()
 
-    def submit(self, artifact, artifact_type=resources.ArtifactType.FILE, artifact_name=None, scan_config=None):
-        """
-        Submit artifacts to polyswarm and return UUIDs
+    def submit(
+            self,
+            artifact,
+            artifact_type=resources.ArtifactType.FILE,
+            artifact_name=None,
+            scan_config=None,
+            is_zip=False,
+            zip_password=None,
+    ):
+        """
+        Submit artifacts to polyswarm
 
         :param artifact: A file-like, path to file, url or LocalArtifact instance
         :param artifact_type: The ArtifactType or strings containing "file" or "url"
         :param artifact_name: An appropriate filename for the Artifact
         :param scan_config: The scan configuration to be used, e.g.: "default", "more-time", "most-time"
+        :param is_zip: If this flag is set, will handle the file as a zip
+          in the server and decompress before processing.
+        :param zip_password: Will use this password to decompress the zip file.
+          If provided, will handle the file as a zip.
         :return: An ArtifactInstance resource
         """
         logger.info('Submitting artifact of type %s', artifact_type)
@@ -239,11 +251,15 @@ class PolyswarmAPI:
         if artifact_type == resources.ArtifactType.URL:
             scan_config = scan_config or 'more-time'
         if isinstance(artifact, resources.LocalArtifact):
-            instance = resources.ArtifactInstance.create(self,
-                                                         artifact_name=artifact.artifact_name,
-                                                         artifact_type=artifact.artifact_type.name,
-                                                         scan_config=scan_config,
-                                                         community=self.community).result()
+            instance = resources.ArtifactInstance.create(
+                self,
+                artifact_name=artifact.artifact_name,
+                artifact_type=artifact.artifact_type.name,
+                scan_config=scan_config,
+                community=self.community,
+                is_zip=is_zip,
+                zip_password=zip_password,
+            ).result()
             instance.upload_file(artifact)
             return resources.ArtifactInstance.update(self, id=instance.id, community=self.community).result()
         else:
@@ -690,7 +706,17 @@ class PolyswarmAPI:
         return resources.SandboxTask.create(self, artifact_id=instance_id, provider_slug=provider_slug, vm_slug=vm_slug,
                                             network_enabled=network_enabled).result()
 
-    def sandbox_file(self, artifact, provider_slug, vm_slug, artifact_type=resources.ArtifactType.FILE, artifact_name=None, network_enabled=True):
+    def sandbox_file(
+            self,
+            artifact,
+            provider_slug,
+            vm_slug,
+            artifact_type=resources.ArtifactType.FILE,
+            artifact_name=None,
+            network_enabled=True,
+            is_zip=False,
+            zip_password=None,
+    ):
         logger.info('Sandboxing file in provider %s vm %s', provider_slug, vm_slug)
         artifact_type = resources.ArtifactType.parse(artifact_type)
         # TODO This is a python 2.7 check if artifact is a file-like instance, consider changing
@@ -708,13 +734,17 @@ class PolyswarmAPI:
                                                                 artifact_name=artifact_name or artifact,
                                                                 artifact_type=artifact_type)
         if isinstance(artifact, resources.LocalArtifact):
-            task = resources.SandboxTask.create_file(self,
-                                                     artifact_name=artifact.artifact_name,
-                                                     artifact_type=artifact.artifact_type.name,
-                                                     community=self.community,
-                                                     provider_slug=provider_slug,
-                                                     vm_slug=vm_slug,
-                                                     network_enabled=network_enabled).result()
+            task = resources.SandboxTask.create_file(
+                self,
+                artifact_name=artifact.artifact_name,
+                artifact_type=artifact.artifact_type.name,
+                community=self.community,
+                provider_slug=provider_slug,
+                vm_slug=vm_slug,
+                network_enabled=network_enabled,
+                is_zip=is_zip,
+                zip_password=zip_password,
+            ).result()
             task.upload_file(artifact)
             return resources.SandboxTask.update_file(self, id=task.id, community=self.community).result()
         else:
@@ -823,18 +853,62 @@ class PolyswarmAPI:
         logger.info('List events')
         return resources.Events.list(self, **kwargs).result()
 
-    def report_create(self, **kwargs):
-        return resources.ReportTask.create(self, **kwargs).result()
-
-    def report_get(self, **kwargs):
-        return resources.ReportTask.get(self, **kwargs).result()
+    def report_create(self,
+                      type,
+                      format,
+                      instance_id=None,
+                      sandbox_task_id=None,
+                      template_id=None,
+                      template_metadata=None,
+                      **kwargs):
+        """
+        Create a report, either 'pdf' or 'html' (format argument).
+        Regarding the type argument, either instance_id (type='scan')
+        or sandbox_task_id (type='sandbox') has to be provided.
+        """
+        report = resources.ReportTask.create(self,
+                                             type=type,
+                                             format=format,
+                                             instance_id=instance_id,
+                                             sandbox_task_id=sandbox_task_id,
+                                             template_id=template_id,
+                                             template_metadata=template_metadata,
+                                             **kwargs).result()
+        return report
+
+    def report_get(self, id, **kwargs):
+        return resources.ReportTask.get(self, id=id, **kwargs).result()
 
     def report_download(self, report_id, folder):
         report = resources.ReportTask.get(self, id=report_id).result()
+        if report.state == 'PENDING':
+            raise exceptions.InvalidValueException('Report is in PENDING state, wait for completion first')
+        if report.state == 'FAILED':
+            raise exceptions.InvalidValueException("Report is in FAILED state, won't be generated")
         result = report.download_report(folder=folder).result()
         result.handle.close()
         return result
 
+    def report_wait_for(self, report_id, timeout=settings.DEFAULT_REPORT_TIMEOUT):
+        """
+        Wait for a Report to finish successfully.
+
+        :param report_id: Report id to wait for
+        :param timeout: Maximum time in seconds to wait before raising a TimeoutException
+        :return: The ReportTask resource waited on, either in 'SUCCEEDED' or 'FAILED' state
+        """
+        logger.info('Waiting for report %s', report_id)
+        start = time.time()
+        while True:
+            report_result = self.report_get(id=report_id)
+            if report_result.state != 'PENDING':
+                return report_result
+            elif -1 < timeout < time.time() - start:
+                raise exceptions.TimeoutException(
+                    f'Timed out waiting for report {report_id} to finish. Please try again.')
+            else:
+                time.sleep(settings.POLL_FREQUENCY)
+
     def report_template_logo_download(self, template_id, folder):
         report = resources.ReportTemplate.get(self, id=template_id).result()
         result = report.download_logo(folder).result()
@@ -851,11 +925,50 @@ class PolyswarmAPI:
         result = report.upload_logo(logo_file, content_tpe).result()
         return result
 
-    def report_template_create(self, **kwargs):
-        return resources.ReportTemplate.create(self, **kwargs).result()
-
-    def report_template_update(self, template_id, **kwargs):
-        return resources.ReportTemplate.update(self, id=template_id, **kwargs).result()
+    def report_template_create(self,
+                               template_name,
+                               is_default=False,
+                               primary_color=None,
+                               footer_text=None,
+                               last_page_text=None,
+                               includes=None,
+                               **kwargs):
+        """
+        Create a template for reports.
+        A team account can have multiple templates, and setting is_default=True
+        makes it the default when a report is created without specifying template_id
+        (see report_create method).
+        The includes argument can be a list with sections to be included
+        in the reports. The list can include any of the following section names:
+        summary, detections, fileMetadata, network, droppedFiles, extractedConfig, analysis.
+        """
+        return resources.ReportTemplate.create(self,
+                                               template_name=template_name,
+                                               is_default=is_default,
+                                               primary_color=primary_color,
+                                               footer_text=footer_text,
+                                               last_page_text=last_page_text,
+                                               includes=includes,
+                                               **kwargs).result()
+
+    def report_template_update(self,
+                               template_id,
+                               template_name=None,
+                               is_default=None,
+                               primary_color=None,
+                               footer_text=None,
+                               last_page_text=None,
+                               includes=None,
+                               **kwargs):
+        return resources.ReportTemplate.update(self,
+                                               id=template_id,
+                                               template_name=template_name,
+                                               is_default=is_default,
+                                               primary_color=primary_color,
+                                               footer_text=footer_text,
+                                               last_page_text=last_page_text,
+                                               includes=includes,
+                                               **kwargs).result()
 
     def report_template_get(self, template_id):
         return resources.ReportTemplate.get(self, id=template_id).result()
@@ -863,8 +976,5 @@ class PolyswarmAPI:
     def report_template_delete(self, template_id):
         return resources.ReportTemplate.delete(self, id=template_id).result()
 
-    def report_template_list(self, is_default=None):
-        params = {}
-        if is_default is not None:
-            params['is_default'] = is_default
-        return resources.ReportTemplate.list(self, **params).result()
+    def report_template_list(self, is_default=None, **kwargs):
+        return resources.ReportTemplate.list(self, is_default=is_default, **kwargs).result()

{polyswarm-api-3.7.0 → polyswarm-api-3.8.0}/src/polyswarm_api/settings.py

@@ -7,6 +7,7 @@ DEFAULT_GLOBAL_API = 'https://api.polyswarm.network/v3'
 DEFAULT_PERMALINK_BASE = os.getenv('POLYSWARM_PORTAL_URI', 'https://polyswarm.network/scan/results/file')
 DEFAULT_COMMUNITY = 'default'
 DEFAULT_SCAN_TIMEOUT = 60*15
+DEFAULT_REPORT_TIMEOUT = 30
 RESULT_CHUNK_SIZE = 100
 POLL_FREQUENCY = 1
 

{polyswarm-api-3.7.0 → polyswarm-api-3.8.0/src/polyswarm_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyswarm-api
-Version: 3.7.0
+Version: 3.8.0
 Summary: Client library to simplify interacting with the PolySwarm consumer API
 Home-page: https://github.com/polyswarm/polyswarm-api
 Author: PolySwarm Developers