Merge pull request #272 from polyswarm/develop

base64 and 7zip support

Author: sbneto

.gitlab-ci.yml

@@ -27,10 +27,12 @@ dev-pypi:
   stage: build
   before_script:
     - pip3 install -q --upgrade pip build twine bump-my-version
+    - pip install -q $END_TO_END_LIB@$CI_COMMIT_REF_NAME || pip install -q $END_TO_END_LIB
+    - e2e init
   script:
     - bump-my-version bump --no-commit --no-tag dev
     - python -m build
-    - twine upload --skip-existing --disable-progress-bar --non-interactive dist/*
+    - e2e release --dev --skip-tag
 
 ###############################################################
 # Test Stage

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "polyswarm_api"
-version = "3.14.0"
+version = "3.14.1"
 description = "Client library to simplify interacting with the PolySwarm consumer API"
 readme = "README.md"
 requires-python = ">=3.10,<4"
@@ -42,7 +42,7 @@ package-dir = { "" = "src" }
 where = ["src"]
 
 [tool.bumpversion]
-current_version = "3.14.0"
+current_version = "3.14.1"
 commit = true
 tag = false
 sign_tags = true

src/polyswarm_api/__init__.py

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

src/polyswarm_api/api.py

@@ -229,11 +229,14 @@ def submit(
         :param scan_config: The scan configuration to be used, e.g.: "default", "more-time", "most-time"
         :param preprocessing: Preprocessing settings to be applied to the artifact, None means no preprocessing,
                               otherwise a dict with the following attributes can be passed:
-                              - type (string): either "zip" or "qrcode", the first mean the file is a zip that
-                                the server has to decompress to then scan the content (only one file inside allowed).
-                                "qrcode" means the file is a QR Code image with a URL as payload, and you want
-                                to scan the URL, not the actual file (artifact_type has to be "URL").
-                              - password (string, optional): will use this password to decompress the zip file.
+                              - type (string): either "zip", "base64", "7zip", or "qrcode". "zip" means the file is a
+                                zip that the server has to decompress to then scan the content (only one file inside
+                                allowed). "base64" means the file content is base64-encoded and the server has to
+                                decode it before scanning. "7zip" means the file is a 7zip archive that the server
+                                has to decompress to then scan the content (only one file inside allowed). "qrcode"
+                                means the file is a QR Code image with a URL as payload, and you want to scan the URL,
+                                not the actual file (artifact_type has to be "URL").
+                              - password (string, optional): will use this password to decompress the zip or 7zip file.
         :return: An ArtifactInstance resource
         """
         logger.info('Submitting artifact of type %s', artifact_type)
@@ -757,10 +760,11 @@ def sandbox_file(
                         the list of VMs available.
         :param preprocessing: Preprocessing settings to be applied to the artifact, None means no preprocessing,
                               otherwise a dict with the following attributes can be passed:
-                              - type (string): either "zip" or "qrcode", the first means the file is a zip that
+                              - type (string): either "zip", "base64", or "qrcode". "zip" means the file is a zip that
                                 the server has to decompress to then scan the content (only one file inside allowed).
-                                "qrcode" means the file is a QR Code image with a URL as payload, and you want
-                                to scan the URL, not the actual file (artifact_type has to be "URL").
+                                "base64" means the file content is base64-encoded and the server has to decode it
+                                before scanning. "qrcode" means the file is a QR Code image with a URL as payload,
+                                and you want to scan the URL, not the actual file (artifact_type has to be "URL").
                               - password (string, optional): will use this password to decompress the zip file.
         :param arguments: The arguments to be passed to the sample being sandboxed, e.g. '--some-param="<PARAM VAL>"'
         :return: An ArtifactInstance resource