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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyswarm-api
-Version: 3.5.2
+Version: 3.7.0
 Summary: Client library to simplify interacting with the PolySwarm consumer API
 Home-page: https://github.com/polyswarm/polyswarm-api
 Author: PolySwarm Developers
@@ -11,8 +11,12 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
+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 :: Implementation :: PyPy
-Requires-Python: >3.5,<4
+Requires-Python: >=3.7,<4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -21,7 +25,7 @@ License-File: LICENSE
 An interface to the PolySwarm Customer APIs.
 For an easy-to-use CLI tool, or as an example of how to use these APIs, please see [polyswarm-cli](https://github.com/polyswarm/polyswarm-cli)
 
-Supports Python 2.7 and greater.
+Supports Python 3.7 and greater.
 
 ## Installation
 

{polyswarm-api-3.5.2 → polyswarm-api-3.7.0}/README.md

@@ -3,7 +3,7 @@
 An interface to the PolySwarm Customer APIs.
 For an easy-to-use CLI tool, or as an example of how to use these APIs, please see [polyswarm-cli](https://github.com/polyswarm/polyswarm-cli)
 
-Supports Python 2.7 and greater.
+Supports Python 3.7 and greater.
 
 ## Installation
 

polyswarm-api-3.7.0/requirements.txt

@@ -0,0 +1,7 @@
+requests>=2.31
+pytest~=7.4
+jsonschema~=3.0.2
+responses==0.23.3
+python-dateutil==2.9.0
+vcrpy~=4.4; python_version == "3.7"
+vcrpy~=5.0; python_version > "3.7"

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

@@ -9,7 +9,7 @@ with open('README.md', 'r') as readme:
 
 setup(
     name='polyswarm-api',
-    version='3.5.2',
+    version='3.7.0',
     description='Client library to simplify interacting with the PolySwarm consumer API',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -17,13 +17,11 @@ setup(
     author_email='info@polyswarm.io',
     url='https://github.com/polyswarm/polyswarm-api',
     license='MIT',
-    python_requires='>3.5,<4',
+    python_requires='>=3.7,<4',
     install_requires=[
-        'requests~=2.22',
-        'future~=0.18',
-        'python-dateutil~=2.8',
+        'requests~=2.31',
+        'python-dateutil~=2.9',
     ],
-    extras_require={':python_version < "3.0"': ['enum34==1.1.6']},
     include_package_data=True,
     packages=find_packages('src'),
     package_dir={'': 'src'},
@@ -33,6 +31,10 @@ setup(
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
         'Programming Language :: Python :: Implementation :: PyPy',
     ]
 )

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

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

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

@@ -3,19 +3,14 @@ import time
 
 import polyswarm_api.core
 
-try:
-    from urllib.parse import urlparse
-except ImportError:
-    from urlparse import urlparse
-
-from future.utils import string_types
+from urllib.parse import urlparse
 
 from polyswarm_api import exceptions, resources, settings
 
 logger = logging.getLogger(__name__)
 
 
-class PolyswarmAPI(object):
+class PolyswarmAPI:
     """A synchronous interface to the public and private PolySwarm APIs."""
 
     def __init__(self, key, uri=None, community=None, timeout=None, verify=True, **kwargs):
@@ -35,6 +30,11 @@ class PolyswarmAPI(object):
         self.session = polyswarm_api.core.PolyswarmSession(key, retries=settings.DEFAULT_RETRIES, verify=verify, **kwargs)
         self._engines = None
 
+    def __repr__(self):
+        clsname = f'{self.__class__.__module__}.{self.__class__.__name__}'
+        attrs = f'uri={self.uri!r}, community={self.community!r}, timeout={self.timeout!r}'
+        return f'<{clsname}({attrs}) at 0x{id(self):x}>'
+
     @property
     def engines(self):
         if not self._engines:
@@ -44,11 +44,11 @@ class PolyswarmAPI(object):
 
     def refresh_engine_cache(self):
         """
-        Rrefresh the cached engine listing
+        Refresh the cached engine listing
         """
         engines = list(resources.Engine.list(self).result())
         if not engines:
-            raise exceptions.InvalidValueException("Recieved empty engines listing")
+            raise exceptions.InvalidValueException("Received empty engines listing")
         self._engines = engines
 
     def wait_for(self, scan, timeout=settings.DEFAULT_SCAN_TIMEOUT):
@@ -66,8 +66,8 @@ class PolyswarmAPI(object):
             if scan_result.failed or scan_result.window_closed:
                 return scan_result
             elif -1 < timeout < time.time() - start:
-                raise exceptions.TimeoutException('Timed out waiting for scan {} to finish. Please try again.'
-                                                  .format(scan))
+                raise exceptions.TimeoutException(
+                    f'Timed out waiting for scan {scan} to finish. Please try again.')
             else:
                 time.sleep(settings.POLL_FREQUENCY)
 
@@ -229,7 +229,7 @@ class PolyswarmAPI(object):
         if hasattr(artifact, 'read') and hasattr(artifact.read, '__call__'):
             artifact = resources.LocalArtifact.from_handle(self, artifact, artifact_name=artifact_name or '',
                                                            artifact_type=artifact_type)
-        elif isinstance(artifact, string_types):
+        elif isinstance(artifact, str):
             if artifact_type == resources.ArtifactType.FILE:
                 artifact = resources.LocalArtifact.from_path(self, artifact, artifact_type=artifact_type,
                                                              artifact_name=artifact_name)
@@ -245,7 +245,7 @@ class PolyswarmAPI(object):
                                                          scan_config=scan_config,
                                                          community=self.community).result()
             instance.upload_file(artifact)
-            return resources.ArtifactInstance.update(self, id=instance.id).result()
+            return resources.ArtifactInstance.update(self, id=instance.id, community=self.community).result()
         else:
             raise exceptions.InvalidValueException('Artifacts should be a path to a file or a LocalArtifact instance')
 
@@ -284,7 +284,7 @@ class PolyswarmAPI(object):
         return resources.ArtifactInstance.rescan_id(self, scan, scan_config=scan_config).result()
 
     def _parse_rule(self, rule):
-        if isinstance(rule, string_types):
+        if isinstance(rule, str):
             rule, rule_id = resources.YaraRuleset(dict(yara=rule), api=self), None
         elif isinstance(rule, (resources.YaraRuleset, int)):
             rule, rule_id = None, rule
@@ -699,7 +699,7 @@ class PolyswarmAPI(object):
         if hasattr(artifact, 'read') and hasattr(artifact.read, '__call__'):
             artifact = resources.LocalArtifact.from_handle(self, artifact, artifact_name=artifact_name or '',
                                                            artifact_type=artifact_type)
-        elif isinstance(artifact, string_types):
+        elif isinstance(artifact, str):
             if artifact_type == resources.ArtifactType.FILE:
                 artifact = resources.LocalArtifact.from_path(self, artifact, artifact_type=artifact_type,
                                                              artifact_name=artifact_name)
@@ -716,7 +716,7 @@ class PolyswarmAPI(object):
                                                      vm_slug=vm_slug,
                                                      network_enabled=network_enabled).result()
             task.upload_file(artifact)
-            return resources.SandboxTask.update_file(self, id=task.id).result()
+            return resources.SandboxTask.update_file(self, id=task.id, community=self.community).result()
         else:
             raise exceptions.InvalidValueException(
                 'Artifacts should be a path to a file or a LocalArtifact instance')
@@ -733,7 +733,7 @@ class PolyswarmAPI(object):
                                                  browser=browser,
                                                  network_enabled=True).result()
         task.upload_file(artifact)
-        return resources.SandboxTask.update_file(self, id=task.id).result()
+        return resources.SandboxTask.update_file(self, id=task.id, community=self.community).result()
 
     def sandbox_providers(self):
         """
@@ -823,7 +823,48 @@ class PolyswarmAPI(object):
         logger.info('List events')
         return resources.Events.list(self, **kwargs).result()
 
-    def __repr__(self):
-        clsname = '{0.__module__}.{0.__name__}'.format(self.__class__)
-        attrs = 'uri={0.uri!r}, community={0.community!r}, timeout={0.timeout!r}'.format(self)
-        return '<{}({}) at 0x{:x}>'.format(clsname, attrs, id(self))
+    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_download(self, report_id, folder):
+        report = resources.ReportTask.get(self, id=report_id).result()
+        result = report.download_report(folder=folder).result()
+        result.handle.close()
+        return result
+
+    def report_template_logo_download(self, template_id, folder):
+        report = resources.ReportTemplate.get(self, id=template_id).result()
+        result = report.download_logo(folder).result()
+        result.handle.close()
+        return result
+
+    def report_template_logo_delete(self, template_id):
+        report = resources.ReportTemplate.get(self, id=template_id).result()
+        result = report.delete_logo().result()
+        return result
+
+    def report_template_logo_upload(self, template_id, logo_file, content_tpe):
+        report = resources.ReportTemplate.get(self, id=template_id).result()
+        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_get(self, template_id):
+        return resources.ReportTemplate.get(self, id=template_id).result()
+
+    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()

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

@@ -3,15 +3,11 @@ import logging
 from copy import deepcopy
 from urllib3 import Retry
 from binascii import unhexlify
-try:
-    from json.decoder import JSONDecodeError
-except ImportError:
-    JSONDecodeError = ValueError
+from json.decoder import JSONDecodeError
 
 import requests
 import datetime as dt
 from dateutil import parser
-from future.utils import raise_from
 from requests.adapters import HTTPAdapter
 from urllib3.exceptions import InsecureRequestWarning
 
@@ -22,7 +18,7 @@ logger = logging.getLogger(__name__)
 
 class PolyswarmSession(requests.Session):
     def __init__(self, key, retries, user_agent=settings.DEFAULT_USER_AGENT, verify=True, **kwargs):
-        super(PolyswarmSession, self).__init__(**kwargs)
+        super().__init__(**kwargs)
         logger.debug('Creating PolyswarmHTTP instance')
         self.requests_retry_session(retries=retries)
 
@@ -118,13 +114,12 @@ class PolyswarmRequest(object):
 
     def _bad_status_message(self):
         request_parameters = json.dumps(self.request_parameters, indent=4, sort_keys=True, cls=RequestParamsEncoder)
-        message = "Error when running the request:\n{}\n" \
-                  "Return code: {}\n" \
-                  "Message: {}".format(request_parameters,
-                                       self.status_code,
-                                       self._result)
+        message = f"Error when running the request:\n{request_parameters}\n" \
+                  f"Return code: {self.status_code}\n" \
+                  f"Message: {self._result}"
         if self.errors:
-            message = '{}\nErrors:\n{}'.format(message, '\n'.join(str(error) for error in self.errors))
+            errors = '\n'.join(str(error) for error in self.errors)
+            message = f'{message}\nErrors:\n{errors}'
         return message
 
     def _extract_json_body(self, result):
@@ -146,10 +141,10 @@ class PolyswarmRequest(object):
             if self.status_code // 100 != 2:
                 self._extract_json_body(result)
                 if self.status_code == 429:
-                    message = '{} This may mean you need to purchase a ' \
+                    message = f'{self._result} This may mean you need to purchase a ' \
                               'larger package, or that you have exceeded ' \
                               'rate limits. If you continue to have issues, ' \
-                              'please contact us at info@polyswarm.io.'.format(self._result)
+                              'please contact us at info@polyswarm.io.'
                     raise exceptions.UsageLimitsExceededException(self, message)
                 elif self.status_code == 404:
                     raise exceptions.NotFoundException(self, self._result)
@@ -185,10 +180,10 @@ class PolyswarmRequest(object):
                 self._result = self.result_parser.parse_result(self.api_instance, result, **self.parser_kwargs)
         except JSONDecodeError as e:
             if self.status_code == 404:
-                raise raise_from(exceptions.NotFoundException(self, 'The requested endpoint does not exist.'), e)
+                raise exceptions.NotFoundException(self, 'The requested endpoint does not exist.') from e
             else:
-                err_msg = 'Server returned non-JSON response [{}]: {}'.format(self.status_code, result)
-                raise raise_from(exceptions.RequestException(self, err_msg), e)
+                err_msg = f'Server returned non-JSON response [{self.status_code}]: {result}'
+                raise exceptions.RequestException(self, err_msg) from e
 
     def __iter__(self):
         return self.consume_results()
@@ -232,12 +227,12 @@ class PolyswarmRequest(object):
         ).execute()
 
 
-class BaseResource(object):
+class BaseResource:
     def __init__(self, content, *args, **kwargs):
         # hack to behave as in python 3, signature should be
         # __init__(self, content, *args, api=None, **kwargs)
         api = kwargs.pop('api', None)
-        super(BaseResource, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
         self.api = api
         self._content = content
 
@@ -252,13 +247,13 @@ class BaseJsonResource(BaseResource):
     RESOURCE_ID_KEYS = ['id']
 
     def __init__(self, content, *args, **kwargs):
-        super(BaseJsonResource, self).__init__(content, *args, **kwargs)
+        super().__init__(content, *args, **kwargs)
         self.json = content
 
     def __int__(self):
         id_ = getattr(self, 'id', None)
         if id_ is None:
-            raise TypeError('Resource {} does not have an id and can not be cast to int'.format(type(self).__name__))
+            raise TypeError(f'Resource {type(self).__name__} does not have an id and can not be cast to int')
         return int(id_)
 
     def _get(self, path, default=None, content=None):
@@ -271,16 +266,16 @@ class BaseJsonResource(BaseResource):
         try:
             for attribute in path.split('.'):
                 if obj is None:
-                    raise KeyError('{} is None, can not resolve full path'.format(previous_attribute))
+                    raise KeyError(f'{previous_attribute} is None, can not resolve full path')
                 if attribute.endswith(']'):
                     # handling the list case, e.g.: "root.list_attr[2]"
                     attribute, _, index = attribute.rpartition('[')
                     index = int(index.rstrip(']'))
                     obj = obj[attribute]
                     if obj is None:
-                        raise KeyError('{} is None, but is it supposed to be a list'.format(attribute))
+                        raise KeyError(f'{attribute} is None, but is it supposed to be a list')
                     elif not isinstance(obj, list):
-                        raise ValueError('Can not access index for {}, it is not a list.'.format(attribute))
+                        raise ValueError(f'Can not access index for {attribute}, it is not a list.')
                     else:
                         obj = obj[index]
                 else:
@@ -469,7 +464,7 @@ def is_valid_sha256(value):
     return is_hex(value)
 
 
-class Hashable(object):
+class Hashable:
     SUPPORTED_HASH_TYPES = {
         'sha1': is_valid_sha1,
         'sha256': is_valid_sha256,
@@ -482,7 +477,7 @@ class Hashable(object):
         hash_value = kwargs.pop('hash_value', None)
         hash_type = kwargs.pop('hash_type', None)
         validate_hash = kwargs.pop('validate_hash', False)
-        super(Hashable, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
         self._hash = hash_value.strip() if hash_value is not None else None
 
@@ -494,7 +489,7 @@ class Hashable(object):
             self._hash_type = self.resolve_hash_type()
 
         if self._hash_type is None:
-            raise exceptions.InvalidValueException('Invalid hash provided: {}'.format(self._hash))
+            raise exceptions.InvalidValueException(f'Invalid hash provided: {self._hash}')
 
         if validate_hash:
             self.validate()
@@ -514,8 +509,8 @@ class Hashable(object):
     def validate(self):
         hash_type = self.resolve_hash_type()
         if self.hash_type != hash_type:
-            raise exceptions.InvalidValueException('Detected hash type {}, got type {} for hash {}'
-                                                   .format(hash_type, self.hash_type, self.hash))
+            raise exceptions.InvalidValueException(
+                f'Detected hash type {hash_type}, got type {self.hash_type} for hash {self.hash}')
 
     def resolve_hash_type(self):
         for hash_type, validator in self.SUPPORTED_HASH_TYPES.items():

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

@@ -20,7 +20,7 @@ class TimeoutException(PolyswarmAPIException):
 
 class RequestException(PolyswarmException):
     def __init__(self, request, *args):
-        super(PolyswarmException, self).__init__(*args)
+        super().__init__(*args)
         self.request = request
 
 

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

@@ -5,15 +5,9 @@ import functools
 import requests
 from enum import Enum
 from hashlib import sha256 as _sha256, sha1 as _sha1, md5 as _md5
+from urllib.parse import urlparse
 
-try:
-    from urllib.parse import urlparse
-except ImportError:
-    from urlparse import urlparse
-
-from future.utils import raise_from, string_types
-
-# Windows might rase an OSError instead of an ImportError like this
+# Windows might raise an OSError instead of an ImportError like this
 # OSError: [WinError 193] %1 is not a valid Win32 application
 try:
     import yara
@@ -33,7 +27,7 @@ class Engine(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/microengines'
 
     def __init__(self, content, api=None):
-        super(Engine, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.id = str(content['id'])
         self.name = content['name']
 
@@ -95,7 +89,7 @@ class Metadata(core.BaseJsonResource):
     KNOWN_KEYS = {'artifact', 'exiftool', 'hash', 'lief', 'pefile', 'scan', 'strings'}
 
     def __init__(self, content, api=None):
-        super(Metadata, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.created = core.parse_isoformat(self.artifact.get('created'))
 
         self.id = self._get('artifact.id')
@@ -144,7 +138,7 @@ class Metadata(core.BaseJsonResource):
         params.extend(('ips', v) for v in ips)
         params.extend(('urls', v) for v in urls)
         params.extend(('domains', v) for v in domains)
-        super_params, json_params = super(Metadata, cls)._get_params(**kwargs)
+        super_params, json_params = super()._get_params(**kwargs)
         params.extend(super_params.items())
         return params, json_params
 
@@ -159,7 +153,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'GET',
-                'url': '{}/{}/{}/{}'.format(api.uri, path, hash_type, hash_value),
+                'url': f'{api.uri}/{path}/{hash_type}/{hash_value}',
                 'params': {
                     'hide_known_good': hide_known_good,
                     'community': api.community,
@@ -183,7 +177,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'GET',
-                'url': '{}/ioc/search'.format(api.uri),
+                'url': f'{api.uri}/ioc/search',
                 'params': params
             },
             result_parser=cls,
@@ -195,7 +189,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'GET',
-                'url': '{}/ioc/known'.format(api.uri),
+                'url': f'{api.uri}/ioc/known',
                 'params': {
                     'ip': ips,
                     'domain': domains
@@ -210,7 +204,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'POST',
-                'url': '{}/ioc/known'.format(api.uri),
+                'url': f'{api.uri}/ioc/known',
                 'json': {
                     'type': type,
                     'host': host,
@@ -227,7 +221,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'POST',
-                'url': '{}/ioc/known'.format(api.uri),
+                'url': f'{api.uri}/ioc/known',
                 'json': {
                     'type': type,
                     'host': host,
@@ -244,7 +238,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'PUT',
-                'url': '{}/ioc/known'.format(api.uri),
+                'url': f'{api.uri}/ioc/known',
                 'json': {
                     'id': id,
                     'type': type,
@@ -262,7 +256,7 @@ class IOC(core.BaseJsonResource):
             api,
             {
                 'method': 'DELETE',
-                'url': '{}/ioc/known'.format(api.uri),
+                'url': f'{api.uri}/ioc/known',
                 'params': {
                     'id': id
                 }
@@ -275,8 +269,8 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
     RESOURCE_ENDPOINT = '/instance'
 
     def __init__(self, content, api=None):
-        super(ArtifactInstance, self).__init__(content=content, api=api,
-                                               hash_value=content['sha256'], hash_type='sha256')
+        super().__init__(content=content, api=api,
+                         hash_value=content['sha256'], hash_type='sha256')
         # Artifact fields
         self.sha256 = content['sha256']
         self.artifact_id = content.get('artifact_id')
@@ -307,7 +301,10 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
         self.votes = [Vote(v, api=api, scanfile=self) for v in content.get('votes', [])]
         self.window_closed = content.get('window_closed')
         self.polyscore = float(content['polyscore']) if content.get('polyscore') is not None else None
-        self.permalink = settings.DEFAULT_PERMALINK_BASE + '/' + str(self.hash) + '/' + str(self.id)
+        if content.get('permalink'):
+            self.permalink = content.get('permalink')
+        else:
+            self.permalink = settings.DEFAULT_PERMALINK_BASE + '/' + str(self.hash) + '/' + str(self.id)
 
         self._malicious_assertions = None
         self._benign_assertions = None
@@ -339,7 +336,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
             api,
             {
                 'method': 'HEAD',
-                'url': '{}/search/hash/{}'.format(api.uri, hash_type),
+                'url': f'{api.uri}/search/hash/{hash_type}',
                 'params': {
                     'hash': hash_value,
                     'community': api.community,
@@ -353,7 +350,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
             api,
             {
                 'method': 'GET',
-                'url': '{}/search/hash/{}'.format(api.uri, hash_type),
+                'url': f'{api.uri}/search/hash/{hash_type}',
                 'params': {
                     'hash': hash_value,
                     'community': api.community,
@@ -368,7 +365,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
             api,
             {
                 'method': 'GET',
-                'url': '{}/search/url'.format(api.uri),
+                'url': f'{api.uri}/search/url',
                 'params': {
                     'url': url,
                     'community': api.community,
@@ -383,7 +380,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
             api,
             {
                 'method': 'GET',
-                'url': '{}/search/instances'.format(api.uri),
+                'url': f'{api.uri}/search/instances',
                 'params': {
                     'hash': hash_value,
                     'community': api.community,
@@ -396,7 +393,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
     def submit(cls, api, artifact, artifact_name, artifact_type, scan_config=None):
         parameters = {
             'method': 'POST',
-            'url': '{}/consumer/submission/{}'.format(api.uri, api.community),
+            'url': f'{api.uri}/consumer/submission/{api.community}',
             'files': {
                 'file': (artifact_name, artifact),
             },
@@ -417,8 +414,8 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
     def rescan(cls, api, hash_value, hash_type, scan_config=None):
         parameters = {
             'method': 'POST',
-            'url': '{}/consumer/submission/{}/rescan/{}/{}'.format(api.uri, api.community, hash_type, hash_value),
-            'data': { 'community': api.community }
+            'url': f'{api.uri}/consumer/submission/{api.community}/rescan/{hash_type}/{hash_value}',
+            'data': {'community': api.community}
         }
         if scan_config:
             parameters['data']['scan-config'] = scan_config
@@ -432,7 +429,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
     def rescan_id(cls, api, submission_id, scan_config=None):
         parameters = {
             'method': 'POST',
-            'url': '{}/consumer/submission/{}/rescan/{}'.format(api.uri, api.community, int(submission_id)),
+            'url': f'{api.uri}/consumer/submission/{api.community}/rescan/{int(submission_id)}',
         }
         if scan_config:
             parameters.setdefault('data', {})['scan-config'] = scan_config
@@ -448,7 +445,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
             api,
             {
                 'method': 'GET',
-                'url': '{}/consumer/submission/{}/{}'.format(api.uri, api.community, int(submission_id)),
+                'url': f'{api.uri}/consumer/submission/{api.community}/{int(submission_id)}',
             },
             result_parser=cls,
         ).execute()
@@ -457,7 +454,7 @@ class ArtifactInstance(core.BaseJsonResource, core.Hashable):
     def metadata_rerun(cls, api, hashes, analyses=None, skip_es=None):
         parameters = {
             'method': 'POST',
-            'url': '{}/consumer/metadata'.format(api.uri),
+            'url': f'{api.uri}/consumer/metadata',
             'json': {'hashes': hashes},
         }
         if analyses:
@@ -496,7 +493,7 @@ class ArtifactArchive(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/consumer/download/stream'
 
     def __init__(self, content, api=None):
-        super(ArtifactArchive, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.id = content['id']
         self.community = content['community']
         self.created = core.parse_isoformat(content['created'])
@@ -507,7 +504,7 @@ class AssertionsJob(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/consumer/assertions-job'
 
     def __init__(self, content, api=None):
-        super(AssertionsJob, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.id = content['id']
         self.engine_id = content['engine_id']
         self.created = core.parse_isoformat(content['created'])
@@ -527,7 +524,7 @@ class VotesJob(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/consumer/votes-job'
 
     def __init__(self, content, api=None):
-        super(VotesJob, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.id = content['id']
         self.engine_id = content['engine_id']
         self.created = core.parse_isoformat(content['created'])
@@ -578,7 +575,7 @@ class LocalArtifact(core.BaseResource, core.Hashable):
             raise exceptions.InvalidValueException('At least one of path or handle must be defined.')
 
         # initialize super classes and default values
-        super(LocalArtifact, self).__init__(response, api=api, hash_type='sha256')
+        super().__init__(response, api=api, hash_type='sha256')
         self.sha256 = None
         self.sha1 = None
         self.md5 = None
@@ -611,13 +608,8 @@ class LocalArtifact(core.BaseResource, core.Hashable):
         remove_on_error = False
         try:
             if folder:
-                # TODO: this should be replaced with os.makedirs(path, exist_ok=True)
-                #  once we drop support to python 2.7
                 if not os.path.exists(folder):
-                    try:
-                        os.makedirs(folder)
-                    except FileExistsError:
-                        pass
+                    os.makedirs(folder, exist_ok=True)
                 remove_on_error = True
                 self.handle = open(os.path.join(folder, self.artifact_name), mode='wb+', **kwargs)
             else:
@@ -649,7 +641,7 @@ class LocalArtifact(core.BaseResource, core.Hashable):
             api,
             {
                 'method': 'GET',
-                'url': '{}/consumer/download/{}/{}'.format(api.uri, hash_type, hash_value),
+                'url': f'{api.uri}/consumer/download/{hash_type}/{hash_value}',
                 'stream': True,
                 'params': { 'community': api.community },
             },
@@ -665,7 +657,7 @@ class LocalArtifact(core.BaseResource, core.Hashable):
             api,
             {
                 'method': 'GET',
-                'url': '{}/instance/download'.format(api.uri),
+                'url': f'{api.uri}/instance/download',
                 'stream': True,
                 'params': {'instance_id': instance_id},
             },
@@ -726,7 +718,7 @@ class LocalArtifact(core.BaseResource, core.Hashable):
 
     @classmethod
     def from_path(cls, api, path, artifact_type=None, analyze=False, artifact_name=None, **kwargs):
-        if not isinstance(path, string_types):
+        if not isinstance(path, str):
             raise exceptions.InvalidValueException('Path should be a string')
         artifact_name = artifact_name or os.path.basename(path)
         handle = open(path, mode='rb', **kwargs)
@@ -736,7 +728,7 @@ class LocalArtifact(core.BaseResource, core.Hashable):
 
     @classmethod
     def from_content(cls, api, content, artifact_name=None, artifact_type=None, analyze=False):
-        if isinstance(content, string_types):
+        if isinstance(content, str):
             content = content.encode("utf8")
         handle = io.BytesIO(content)
         # create the LocalHandle with the given handle and don't write anything to it
@@ -746,7 +738,7 @@ class LocalArtifact(core.BaseResource, core.Hashable):
     @property
     def hash(self):
         self.analyze_artifact()
-        return super(LocalArtifact, self).hash
+        return super().hash
 
     def analyze_artifact(self, force=False):
         if not self.analyzed or force:
@@ -773,7 +765,7 @@ class YaraRuleset(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/hunt/rule'
 
     def __init__(self, content, api=None):
-        super(YaraRuleset, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.id = content.get('id')
         self.livescan_id = content.get('livescan_id')
         self.livescan_created = content.get('livescan_created')
@@ -793,7 +785,7 @@ class LiveHuntResult(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/hunt/live'
 
     def __init__(self, content, api=None):
-        super(LiveHuntResult, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.id = content['id']
         self.livescan_id = content['livescan_id']
         self.instance_id = content['instance_id']
@@ -817,7 +809,7 @@ class HistoricalHunt(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/hunt/historical'
 
     def __init__(self, content, api=None):
-        super(HistoricalHunt, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         # active only present for live   hunts
         self.id = content['id']
         self.created = core.parse_isoformat(content['created'])
@@ -839,7 +831,7 @@ class HistoricalHuntResult(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/hunt/historical/results'
 
     def __init__(self, content, api=None):
-        super(HistoricalHuntResult, self).__init__(content=content, api=api)
+        super().__init__(content=content, api=api)
         self.id = content['id']
         self.historicalscan_id = content['historicalscan_id']
         self.instance_id = content['instance_id']
@@ -853,6 +845,7 @@ class HistoricalHuntResult(core.BaseJsonResource):
         self.download_url = content.get('download_url')
         self.community = content.get('community')
 
+
 class HistoricalHuntResultList(HistoricalHuntResult):
     RESOURCE_ENDPOINT = '/hunt/historical/results/list'
 
@@ -862,7 +855,7 @@ class TagLink(core.BaseJsonResource):
     RESOURCE_ID_KEYS = ['hash']
 
     def __init__(self, content, api=None):
-        super(TagLink, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.id = content.get('id')
         self.sha256 = content.get('sha256')
         self.created = core.parse_isoformat(content.get('created'))
@@ -889,7 +882,7 @@ class MalwareFamily(core.BaseJsonResource):
     RESOURCE_ID_KEYS = ['name']
 
     def __init__(self, content, api=None):
-        super(MalwareFamily, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.id = content.get('id')
         self.created = core.parse_isoformat(content.get('created'))
         self.updated = core.parse_isoformat(content.get('updated'))
@@ -902,7 +895,7 @@ class Tag(core.BaseJsonResource):
     RESOURCE_ID_KEYS = ['name']
 
     def __init__(self, content, api=None):
-        super(Tag, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.id = content.get('id')
         self.created = core.parse_isoformat(content.get('created'))
         self.updated = core.parse_isoformat(content.get('updated'))
@@ -916,7 +909,7 @@ class Tag(core.BaseJsonResource):
 
 class Assertion(core.BaseJsonResource):
     def __init__(self, content, api=None, scanfile=None):
-        super(Assertion, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.scanfile = scanfile
         self.author = content['author']
         self.author_name = content['author_name']
@@ -933,7 +926,7 @@ class Assertion(core.BaseJsonResource):
 
 class Vote(core.BaseJsonResource):
     def __init__(self, content, api=None, scanfile=None):
-        super(Vote, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.scanfile = scanfile
         self.arbiter = content['arbiter']
         self.vote = content['vote']
@@ -958,9 +951,8 @@ class ArtifactType(Enum):
         try:
             return ArtifactType[value.upper()]
         except Exception as e:
-            raise raise_from(
-                exceptions.InvalidValueException(
-                    'Unable to get the artifact type from the provided value {}'.format(value)), e)
+            raise exceptions.InvalidValueException(
+                    f'Unable to get the artifact type from the provided value {value}') from e
 
     @staticmethod
     def to_string(artifact_type):
@@ -981,7 +973,7 @@ class ArtifactType(Enum):
 
 class Hash(core.Hashable):
     def __init__(self, hash_, hash_type=None, validate_hash=True):
-        super(Hash, self).__init__(hash_value=hash_, hash_type=hash_type, validate_hash=validate_hash)
+        super().__init__(hash_value=hash_, hash_type=hash_type, validate_hash=validate_hash)
 
     @classmethod
     def from_hashable(cls, hash_, hash_type=None):
@@ -995,8 +987,8 @@ class Hash(core.Hashable):
         """
         if issubclass(type(hash_), core.Hashable):
             if hash_type and hash_.hash_type != hash_type:
-                raise exceptions.InvalidValueException('Detected hash type {}, got {} for hashable {}'
-                                                       .format(hash_.hash_type, hash_type, hash_.hash))
+                raise exceptions.InvalidValueException(
+                    f'Detected hash type {hash_.hash_type}, got {hash_type} for hashable {hash_.hash}')
             return Hash(hash_.hash, hash_type=hash_type)
         return Hash(hash_, hash_type=hash_type)
 
@@ -1007,14 +999,14 @@ class Hash(core.Hashable):
         return self.hash
 
     def __repr__(self):
-        return "{}={}".format(self.hash_type, self.hash)
+        return f"{self.hash_type}={self.hash}"
 
 
 class SandboxTask(core.BaseJsonResource):
     RESOURCE_ENDPOINT = '/sandbox/sandboxtask'
 
     def __init__(self, content, api=None):
-        super(SandboxTask, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.id = content['id']
         self.community = content['community']
         self.sandbox = content['sandbox']
@@ -1080,7 +1072,7 @@ class SandboxTask(core.BaseJsonResource):
 
 class SandboxArtifact(core.BaseJsonResource):
     def __init__(self, content, api=None):
-        super(SandboxArtifact, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.created = content['created']
         self.id = content['id']
         self.instance_id = content['instance_id']
@@ -1094,7 +1086,7 @@ class SandboxProvider(core.BaseJsonResource):
     RESOURCE_ENDPOINT = "/sandbox/provider"
 
     def __init__(self, content, api=None):
-        super(SandboxProvider, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.slug = content['slug']
         self.name = content['name']
         self.tool = content['tool']
@@ -1110,9 +1102,104 @@ class Events(core.BaseJsonResource):
     RESOURCE_ENDPOINT = "/activity"
 
     def __init__(self, content, api=None):
-        super(Events, self).__init__(content, api=api)
+        super().__init__(content, api=api)
         self.event_timestamp = content['event_timestamp']
         self.event_type = content['event_type']
         self.source = content['source']
         self.team_account_id = content['team_account_id']
         self.user_account_id = content['user_account_id']
+
+
+class ReportTask(core.BaseJsonResource):
+    RESOURCE_ENDPOINT = "/reports"
+
+    def __init__(self, content, api=None):
+        super().__init__(content, api=api)
+        self.id = content['id']
+        self.type = content['type']
+        self.format = content['format']
+        self.state = content['state']
+        self.community = content['community']
+        self.created = content['created']
+        self.template_id = content.get('template_id')
+        self.template_metadata = content.get('template_metadata', {})
+        self.sandbox_task_id = content.get('sandbox_task_id')
+        self.instance_id = content.get('instance_id')
+        self.url = content['url']
+
+    def download_report(self, folder=None):
+        """ This method is special, in that it is simply for downloading from S3 """
+        return core.PolyswarmRequest(
+            self.api,
+            {
+                'method': 'GET',
+                'url': self.url,
+                'stream': True,
+                'headers': {'Authorization': None}
+            },
+            result_parser=LocalArtifact,
+            folder=folder,
+        ).execute()
+
+
+class ReportTemplate(core.BaseJsonResource):
+    RESOURCE_ENDPOINT = "/reports/templates"
+
+    def __init__(self, content, api=None):
+        super().__init__(content, api=api)
+        if content:
+            self.id = content['id']
+            self.created = content['created']
+            self.template_name = content['template_name']
+            self.includes = content.get('includes')
+            self.primary_color = content.get('primary_color')
+            self.footer_text = content.get('footer_text')
+            self.last_page_text = content.get('last_page_text')
+            self.is_default = content.get('is_default', False)
+            self.logo_content_length = content.get('logo_content_length')
+            self.logo_url = f"{self.api.uri}/reports/templates/logo?id={self.id}"
+            self.logo_content_type = content.get('logo_content_type')
+            self.logo_height = content.get('logo_height')
+            self.logo_width = content.get('logo_width')
+
+    def download_logo(self, folder):
+        return core.PolyswarmRequest(
+            self.api,
+            {
+                'method': 'GET',
+                'url': self.logo_url,
+            },
+            result_parser=LocalArtifact,
+            folder=folder,
+        ).execute()
+
+    def delete_logo(self):
+        return core.PolyswarmRequest(
+            self.api,
+            {
+                'method': 'DELETE',
+                'url': self.logo_url,
+            },
+        ).execute()
+
+    def upload_logo(self, logo_file, content_tpe):
+        if not logo_file:
+            raise exceptions.InvalidValueException('A local file must be provided in order to upload')
+        logo_file.seek(0, io.SEEK_END)
+        length = logo_file.tell()
+        logo_file.seek(0)
+        if not length:
+            raise exceptions.InvalidValueException('Empty file')
+        # r = requests.put(self.upload_url, data=logo_file, **kwargs)
+        # r.raise_for_status()
+        # return r
+        return core.PolyswarmRequest(
+            self.api,
+            {
+                'method': 'PUT',
+                'url': f'{self.api.uri}/reports/templates/logo?id={self.id}',
+                'data': logo_file,
+                'headers': {'Content-Type': content_tpe}
+            },
+            result_parser=self.__class__
+        ).execute()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyswarm-api
-Version: 3.5.2
+Version: 3.7.0
 Summary: Client library to simplify interacting with the PolySwarm consumer API
 Home-page: https://github.com/polyswarm/polyswarm-api
 Author: PolySwarm Developers
@@ -11,8 +11,12 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
+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 :: Implementation :: PyPy
-Requires-Python: >3.5,<4
+Requires-Python: >=3.7,<4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -21,7 +25,7 @@ License-File: LICENSE
 An interface to the PolySwarm Customer APIs.
 For an easy-to-use CLI tool, or as an example of how to use these APIs, please see [polyswarm-cli](https://github.com/polyswarm/polyswarm-cli)
 
-Supports Python 2.7 and greater.
+Supports Python 3.7 and greater.
 
 ## Installation
 

polyswarm-api-3.7.0/src/polyswarm_api.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests~=2.31
+python-dateutil~=2.9

polyswarm-api-3.5.2/requirements.txt

@@ -1,7 +0,0 @@
-requests>=2.20
-pytest~=7.2
-jsonschema~=3.0.2
-responses==0.10.6
-python-dateutil==2.8.1
-future==0.18.2
-vcrpy~=5.0

polyswarm-api-3.5.2/src/polyswarm_api.egg-info/requires.txt

@@ -1,6 +0,0 @@
-requests~=2.22
-future~=0.18
-python-dateutil~=2.8
-
-[:python_version < "3.0"]
-enum34==1.1.6