revengai 1.1.1__py3-none-any.whl

revengai/rest.py

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from revengai.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

revengai/test/test_addr.py

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from revengai.models.addr import Addr
+
+class TestAddr(unittest.TestCase):
+    """Addr unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> Addr:
+        """Test Addr
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `Addr`
+        """
+        model = Addr()
+        if include_optional:
+            return Addr(
+            )
+        else:
+            return Addr(
+        )
+        """
+
+    def testAddr(self):
+        """Test Addr"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

revengai/test/test_ai_decompilation_rating.py

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from revengai.models.ai_decompilation_rating import AiDecompilationRating
+
+class TestAiDecompilationRating(unittest.TestCase):
+    """AiDecompilationRating unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testAiDecompilationRating(self):
+        """Test AiDecompilationRating"""
+        # inst = AiDecompilationRating()
+
+if __name__ == '__main__':
+    unittest.main()

revengai/test/test_analyse_created.py

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from revengai.models.analyse_created import AnalyseCreated
+
+class TestAnalyseCreated(unittest.TestCase):
+    """AnalyseCreated unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AnalyseCreated:
+        """Test AnalyseCreated
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `AnalyseCreated`
+        """
+        model = AnalyseCreated()
+        if include_optional:
+            return AnalyseCreated(
+                success = None,
+                binary_id = None
+            )
+        else:
+            return AnalyseCreated(
+                binary_id = None,
+        )
+        """
+
+    def testAnalyseCreated(self):
+        """Test AnalyseCreated"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

revengai/test/test_analyses_comments_api.py

@@ -0,0 +1,59 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from revengai.api.analyses_comments_api import AnalysesCommentsApi
+
+
+class TestAnalysesCommentsApi(unittest.TestCase):
+    """AnalysesCommentsApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = AnalysesCommentsApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_create_analysis_comment(self) -> None:
+        """Test case for create_analysis_comment
+
+        Create a comment for this analysis
+        """
+        pass
+
+    def test_delete_analysis_comment(self) -> None:
+        """Test case for delete_analysis_comment
+
+        Delete a comment
+        """
+        pass
+
+    def test_get_analysis_comments(self) -> None:
+        """Test case for get_analysis_comments
+
+        Get comments for this analysis
+        """
+        pass
+
+    def test_update_analysis_comment(self) -> None:
+        """Test case for update_analysis_comment
+
+        Update a comment
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

revengai/test/test_analyses_core_api.py

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from revengai.api.analyses_core_api import AnalysesCoreApi
+
+
+class TestAnalysesCoreApi(unittest.TestCase):
+    """AnalysesCoreApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = AnalysesCoreApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_create_analysis(self) -> None:
+        """Test case for create_analysis
+
+        Create Analysis
+        """
+        pass
+
+    def test_delete_analysis(self) -> None:
+        """Test case for delete_analysis
+
+        Delete Analysis
+        """
+        pass
+
+    def test_find_similar_functions_batch(self) -> None:
+        """Test case for find_similar_functions_batch
+
+        Batch Symbol ANN using Analysis ID
+        """
+        pass
+
+    def test_get_analysis_basic_info(self) -> None:
+        """Test case for get_analysis_basic_info
+
+        Gets basic analysis information
+        """
+        pass
+
+    def test_get_analysis_basic_info_deprecated(self) -> None:
+        """Test case for get_analysis_basic_info_deprecated
+
+        Gets basic analysis information
+        """
+        pass
+
+    def test_get_analysis_logs(self) -> None:
+        """Test case for get_analysis_logs
+
+        Gets the logs of an analysis
+        """
+        pass
+
+    def test_get_analysis_params(self) -> None:
+        """Test case for get_analysis_params
+
+        Gets analysis param information
+        """
+        pass
+
+    def test_get_analysis_status(self) -> None:
+        """Test case for get_analysis_status
+
+        Gets the status of an analysis
+        """
+        pass
+
+    def test_get_binary_ann(self) -> None:
+        """Test case for get_binary_ann
+
+        Binary Ann
+        """
+        pass
+
+    def test_get_symbol_info_for_binary(self) -> None:
+        """Test case for get_symbol_info_for_binary
+
+        Gets the symbol information of a binary
+        """
+        pass
+
+    def test_list_analyses(self) -> None:
+        """Test case for list_analyses
+
+        Gets the most recent analyses
+        """
+        pass
+
+    def test_lookup_binary_id(self) -> None:
+        """Test case for lookup_binary_id
+
+        Gets the analysis ID from binary ID
+        """
+        pass
+
+    def test_requeue_analysis(self) -> None:
+        """Test case for requeue_analysis
+
+        Requeue Analysis
+        """
+        pass
+
+    def test_update_analysis(self) -> None:
+        """Test case for update_analysis
+
+        Update Analysis
+        """
+        pass
+
+    def test_update_analysis_tags(self) -> None:
+        """Test case for update_analysis_tags
+
+        Update Analysis Tags
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

revengai/test/test_analyses_dynamic_execution_api.py

@@ -0,0 +1,80 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from revengai.api.analyses_dynamic_execution_api import AnalysesDynamicExecutionApi
+
+
+class TestAnalysesDynamicExecutionApi(unittest.TestCase):
+    """AnalysesDynamicExecutionApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = AnalysesDynamicExecutionApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_get_dynamic_execution_status(self) -> None:
+        """Test case for get_dynamic_execution_status
+
+        Get the status of a dynamic execution task
+        """
+        pass
+
+    def test_get_network_overview(self) -> None:
+        """Test case for get_network_overview
+
+        Get the dynamic execution results for network overview
+        """
+        pass
+
+    def test_get_process_dump(self) -> None:
+        """Test case for get_process_dump
+
+        Get the dynamic execution results for a specific process dump
+        """
+        pass
+
+    def test_get_process_dumps(self) -> None:
+        """Test case for get_process_dumps
+
+        Get the dynamic execution results for process dumps
+        """
+        pass
+
+    def test_get_process_registry(self) -> None:
+        """Test case for get_process_registry
+
+        Get the dynamic execution results for process registry
+        """
+        pass
+
+    def test_get_process_tree(self) -> None:
+        """Test case for get_process_tree
+
+        Get the dynamic execution results for process tree
+        """
+        pass
+
+    def test_get_ttps(self) -> None:
+        """Test case for get_ttps
+
+        Get the dynamic execution results for ttps
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()