Merge pull request #27 from anikobartos/master

Rename OPSWAT Filescan Sandbox to MetaDefender Sandbox

README.rst

@@ -23,7 +23,7 @@ This library currently supports the following sandbox systems:
 * `FireEye AX Series`_
 * `Hatching Triage`_
 * `Joe Sandbox`_
-* `OPSWAT Filescan Sandbox`_
+* `MetaDefender Sandbox`_
 * `VMRay Analyzer`_
 * `WildFire Sandbox`_
 
@@ -230,23 +230,23 @@ Example::
 Currently, only the WildFire cloud sandbox is supported and not the WildFire appliance.
 
 
-OPSWAT Filescan Sandbox
-~~~~~~~~~~~~~~~~~~~~~~~
+MetaDefender Sandbox
+~~~~~~~~~~~~~~~~~~~~
 
 Constructor signature::
 
-    OPSWATSandboxAPI(api_key, url=None, verify_ssl=True)
+    MetaDefenderSandboxAPI(api_key, url=None, verify_ssl=True)
 
 Example::
 
-    OPSWATSandboxAPI('mykey')
+    MetaDefenderSandboxAPI('mykey')
 
-OPSWAT Filescan Sandbox. You can use the Activation Key that you received 
+MetaDefender Sandbox (previously known as OPSWAT Filescan Sandbox). You can use the Activation Key that you received 
 from your OPSWAT Sales Representative, and follow the instructions on the 
 `OPSWAT Licence Activation`_ page or you can create an API key on the 
-`OPSWAT Filescan Community Site`_ under API Key tab.
+`MetaDefender Sandbox Community Site`_ under API Key tab.
 
-More details in the `OPSWAT Filescan Sandbox API documentation`_.
+More details in the `MetaDefender Sandbox API documentation`_.
 
 
 Hatching Triage
@@ -278,6 +278,7 @@ number of online analysis services.
 .. _Cuckoo Sandbox: https://www.cuckoosandbox.org/
 .. _Fireeye AX Series: https://www.fireeye.com/products/malware-analysis.html
 .. _Joe Sandbox: https://www.joesecurity.org/
+.. _MetaDefender Sandbox: https://docs.opswat.com/filescan
 .. _VMRay Analyzer: https://www.vmray.com/
 .. _Falcon Sandbox: https://www.falcon-sandbox.com/
 .. _WildFire Sandbox: https://www.paloaltonetworks.com/products/secure-the-network/wildfire
@@ -289,8 +290,8 @@ number of online analysis services.
 .. _official Joe Sandbox library: https://github.com/joesecurity/joesandboxcloudapi
 .. _official Falcon library: https://github.com/PayloadSecurity/VxAPI
 .. _OPSWAT Licence Activation: https://docs.opswat.com/filescan/installation/license-activation
-.. _OPSWAT Filescan Community Site: https://www.filescan.io/users/profile
-.. _OPSWAT Filescan Sandbox API documentation: https://docs.opswat.com/filescan/opswat-filescan
+.. _MetaDefender Sandbox Community Site: https://www.filescan.io/users/profile?active=apikeyinfo
+.. _MetaDefender Sandbox API documentation: https://docs.opswat.com/filescan/metadefender-sandbox-api-reference-v1
 .. _malsub: https://github.com/diogo-fernan/malsub
 .. _Triage public cloud: https://tria.ge/
 .. _Triage API documentation: https://tria.ge/docs/

sandboxapi/opswat.py

@@ -5,18 +5,18 @@
 import time
 
 
-class OPSWATSandboxAPI(sandboxapi.SandboxAPI):
-    """OPSWAT Filescan Sandbox API wrapper."""
+class MetaDefenderSandboxAPI(sandboxapi.SandboxAPI):
+    """MetaDefender Sandbox API wrapper."""
 
     def __init__(
         self, api_key, url="https://www.filescan.io", verify_ssl=True, **kwargs
     ):
-        """Initialize the interface to OPSWAT Filescan Sandbox API.
+        """Initialize the interface to MetaDefender Sandbox API.
         :type   api_key:    str
-        :param  api_key:    OPSWAT Filescan Sandbox API key
+        :param  api_key:    MetaDefender Sandbox API key
 
         :type   url         str
-        :param  url         The url (including the port) of the OPSWAT Filescan Sandbox
+        :param  url         The url (including the port) of the MetaDefender Sandbox
                             instance defaults to https://www.filescan.io
         """
         sandboxapi.SandboxAPI.__init__(self, **kwargs)
@@ -95,18 +95,19 @@ def check(self, item_id):
             if "allFinished" in response.json() and response.json()["allFinished"]:
                 return True
             elif "allFinished" not in response.json():
-                    raise sandboxapi.SandboxError(
-                        "api error in check ({u}): {r}".format(
-                            u=response.url, r=response.content
-                        ))
+                raise sandboxapi.SandboxError(
+                    "api error in check ({u}): {r}".format(
+                        u=response.url, r=response.content
+                    )
+                )
 
         except ValueError as e:
             raise sandboxapi.SandboxError(e)
 
         return False
 
     def is_available(self):
-        """Determine if the OPSWAT Filescan Sandbox API server is alive.
+        """Determine if the MetaDefender Sandbox API server is alive.
 
         :rtype:  bool
         :return: True if service is available, False otherwise.
@@ -189,24 +190,24 @@ def score(self, report):
         return score
 
 
-def opswat_loop(opswat, filename):
+def md_sandbox_loop(md_sandbox, filename):
     # test run
     with open(arg, "rb") as handle:
-        flow_id = opswat.analyze(handle, filename)
+        flow_id = md_sandbox.analyze(handle, filename)
         print("file {f} submitted for analysis, id {i}".format(f=filename, i=flow_id))
 
-    while not opswat.check(flow_id):
+    while not md_sandbox.check(flow_id):
         print("not done yet, sleeping 10 seconds...")
         time.sleep(10)
 
     print("Analysis complete. fetching report...")
-    print(opswat.report(flow_id))
+    print(md_sandbox.report(flow_id))
 
 
 if __name__ == "__main__":
 
     def usage():
-        msg = "%s: <filescan_url> <api_key> <submit <file_path> | available | report <flow_id> | score <report> | analyze <file_path>"
+        msg = "%s: <sandbox_url> <api_key> <submit <file_path> | available | report <flow_id> | score <report> | analyze <file_path>"
         print(msg % sys.argv[0])
         sys.exit(1)
 
@@ -229,27 +230,27 @@ def usage():
     else:
         usage()
 
-    opswat = OPSWATSandboxAPI(api_key, url)
+    md_sandbox = MetaDefenderSandboxAPI(api_key, url)
 
     if arg is None and "available" not in cmd:
         usage()
 
     # process command line arguments.
     if "submit" in cmd:
         with open(arg, "rb") as handle:
-            print(opswat.analyze(handle, arg))
+            print(md_sandbox.analyze(handle, arg))
 
     elif "available" in cmd:
-        print(opswat.is_available())
+        print(md_sandbox.is_available())
 
     elif "report" in cmd:
-        print(opswat.report(arg))
+        print(md_sandbox.report(arg))
 
     elif "analyze" in cmd:
-        opswat_loop(opswat, arg)
+        md_sandbox_loop(md_sandbox, arg)
 
     elif "score" in cmd:
-        score = opswat.score(arg)
+        score = md_sandbox.score(arg)
         print(score)
 
     else:

tests/test_opswat.py

@@ -14,9 +14,9 @@
 URL = "http://filescanio.mock"
 
 
-class TestOPSWAT(TestCase):
+class TestMetaDefenderSandbox(TestCase):
     def setUp(self):
-        self.sandbox = sandboxapi.opswat.OPSWATSandboxAPI("key", URL, True)
+        self.sandbox = sandboxapi.opswat.MetaDefenderSandboxAPI("key", URL, True)
 
     # analyze
     @responses.activate