reait 1.2.1__py3-none-any.whl → 1.2.3__py3-none-any.whl

reait/api.py

@@ -15,11 +15,12 @@ from pandas import DataFrame
 from requests import request, Response, HTTPError
 from sklearn.metrics.pairwise import cosine_similarity
 
-__version__ = "1.2.1"
+__version__ = "1.2.3"
 
 re_conf = {
     "apikey": environ.get("REAI_API_KEY", ""),
     "host": environ.get("REAI_API_HOST", "https://api.reveng.ai"),
+    "user_agent": environ.get("REAI_USER_AGENT", "RevEng.AI Toolkit"),
 }
 
 
@@ -65,7 +66,8 @@ def reveng_req(
     :param files: Dictionary of files to send to the specified URL
     """
     url = f"{re_conf['host']}/{end_point if end_point[0] != '/' else end_point[1:]}"
-    headers = {"Authorization": re_conf["apikey"]}
+    headers = {"Authorization": re_conf["apikey"],
+               "User-Agent": re_conf["user_agent"]}
 
     if ex_headers:
         headers.update(ex_headers)
@@ -246,7 +248,7 @@ def RE_analyse(
     skip_scraping: bool = False,
     skip_capabilities: bool = False,
     skip_sbom: bool = False,
-    advanced_analysis: bool = False
+    advanced_analysis: bool = False,
 ) -> Response:
     """
     Start analysis job for binary file
@@ -308,7 +310,8 @@ def RE_analyse(
         "skip_scraping",
         "skip_capabilities",
         "skip_sbom",
-        "advanced_analysis"
+        "advanced_analysis",
+        "skip_cves",
     ):
         p_value = locals()[p_name]
 
@@ -335,43 +338,25 @@ def RE_upload(fpath: str) -> Response:
     :param fpath: File path for binary to analyse
     """
     bin_id = re_binary_id(fpath)
-    result = re_hash_check(bin_id)
 
-    if result:
+    with open(fpath, "rb") as fd:
+        res: Response = reveng_req(
+            requests.post, "v1/upload", files={"file": fd})
+
+    if res.ok:
         logger.info(
-            "File %s - %s already uploaded. Skipping upload...", fpath, bin_id)
-
-        res = Response()
-        res.status_code = 200
-        res.url = f"{re_conf['host']}/v1/upload"
-        res._content = (
-            (
-                '{0}"success": true,'
-                '"message": "File already uploaded!",'
-                '"sha_256_hash": "{1}"{2}'
-            )
-            .format("{", bin_id, "}")
-            .encode()
+            "Successfully uploaded binary to your account. %s - %s", fpath, bin_id
+        )
+    elif res.status_code == 400:
+        if "error" in res.json().keys():
+            logger.warning("Error uploading %s - %s",
+                           fpath, res.json()["error"])
+    elif res.status_code == 413:
+        logger.warning("File too large. Please upload files under 10MB.")
+    elif res.status_code == 500:
+        logger.error(
+            "Internal Server Error. Please contact support. Skipping upload..."
         )
-    else:
-        with open(fpath, "rb") as fd:
-            res: Response = reveng_req(
-                requests.post, "v1/upload", files={"file": fd})
-
-        if res.ok:
-            logger.info(
-                "Successfully uploaded binary to your account. %s - %s", fpath, bin_id
-            )
-        elif res.status_code == 400:
-            if "error" in res.json().keys():
-                logger.warning("Error uploading %s - %s",
-                               fpath, res.json()["error"])
-        elif res.status_code == 413:
-            logger.warning("File too large. Please upload files under 10MB.")
-        elif res.status_code == 500:
-            logger.error(
-                "Internal Server Error. Please contact support. Skipping upload..."
-            )
 
     res.raise_for_status()
     return res
@@ -759,9 +744,7 @@ def RE_functions_list(
         params["max_v_address"] = max_v_address
 
     res: Response = reveng_req(
-        requests.get,
-        f"/v2/analyses/{analysis_id}/functions/list",
-        params=params
+        requests.get, f"/v2/analyses/{analysis_id}/functions/list", params=params
     )
 
     res.raise_for_status()
@@ -868,12 +851,10 @@ def _binary_format(binary: Binary) -> str:
         return "Mach-O"
 
     logger.error(
-        "Error, could not determine or unsupported"
-        f" binary format: {binary.format}."
+        "Error, could not determine or unsupported" f" binary format: {binary.format}."
     )
     raise RuntimeError(
-        "Error, could not determine or "
-        f"unsupported binary format: {binary.format}"
+        "Error, could not determine or " f"unsupported binary format: {binary.format}"
     )
 
 
@@ -969,10 +950,7 @@ def RE_functions_data_types_poll(
     return res
 
 
-def RE_generate_data_types(
-    analysis_id: int,
-    function_ids: list[int]
-) -> Response:
+def RE_generate_data_types(analysis_id: int, function_ids: list[int]) -> Response:
     """
     Generate data types for the analysis
     :param aid: Analysis ID
@@ -1032,10 +1010,7 @@ def RE_begin_ai_decompilation(function_id: int) -> Response:
     return res
 
 
-def RE_poll_ai_decompilation(
-    function_id: int,
-    summarise: bool = False
-) -> Response:
+def RE_poll_ai_decompilation(function_id: int, summarise: bool = False) -> Response:
     """
     Poll AI decompilation for the function
     :param function_id: Function ID
@@ -1068,9 +1043,9 @@ def RE_analysis_lookup(binary_id: int) -> Response:
 
 
 def RE_collections_search(
-        page: int = 1,
-        page_size: int = 10,
-        query: dict = {},
+    page: int = 1,
+    page_size: int = 10,
+    query: dict = {},
 ) -> Response:
     """
     Search for collections in the database
@@ -1110,9 +1085,9 @@ def RE_collections_search(
 
 
 def RE_binaries_search(
-        page: int = 1,
-        page_size: int = 10,
-        query: dict = {},
+    page: int = 1,
+    page_size: int = 10,
+    query: dict = {},
 ) -> Response:
     """
     Search for binaries in the database
@@ -1271,6 +1246,40 @@ def RE_recent_analysis(
     return res
 
 
+def RE_recent_analysis_v2(
+    search: str = "",
+    workspace: str = "personal",
+    status: str = "All",
+    users: list[str] = [],
+    limit: int = 50
+) -> Response:
+    """
+    Get recent analysis using the v2 API
+    :param status: Status of the analysis (default: "All")
+    :param scope: Scope of the analysis (default: "ALL")
+    :param nb_analysis: Number of analysis to retrieve (default: 50)
+    """
+    res: Response = reveng_req(
+        requests.get,
+        "/v2/analyses/list",
+        params={
+            "search_term": search, "status": status, "workspace": workspace,
+            "limit": limit, "usernames": users},
+    )
+
+    res.raise_for_status()
+    return res
+
+
+def RE_users_me() -> Response:
+    """
+    Get the current user's information
+    """
+    res: Response = reveng_req(requests.get, "/v2/users/me")
+    res.raise_for_status()
+    return res
+
+
 def RE_search(fpath: str) -> Response:
     bin_id = re_binary_id(fpath)
 
@@ -1301,3 +1310,76 @@ def RE_similar_functions(
 
     res.raise_for_status()
     return res
+
+
+def RE_binary_ann(
+    analysis_id: int,
+    confidence: float = 0.0,
+    nns: int = 1,
+    collection_ids: list[int] = None,
+    binary_ids: list[int] = None,
+) -> Response:
+    """
+    Perform binary ANN (Approximate Nearest Neighbor) search.
+    :param analysis_id: Analysis ID
+    :param confidence: Confidence threshold for the search
+    :param nns: Number of nearest neighbors to retrieve
+    :param collection_ids: List of collection IDs to search within
+    :param binary_ids: List of binary IDs to search within
+    """
+    end_point = f"v2/binary_ann/{analysis_id}"
+    json_data = {
+        "confidence": confidence,
+        "nns": nns,
+        "collection_ids": collection_ids or [],
+        "binary_ids": binary_ids or [],
+    }
+
+    res: Response = reveng_req(requests.post, end_point, json_data=json_data)
+    res.raise_for_status()
+    return res
+
+
+def RE_name_score(functions: list, is_debug: bool = False) -> Response:
+
+    body = {"functions": functions, "is_debug": is_debug}
+    res: Response = reveng_req(
+        requests.post, "v2/confidence/functions/name_score", json_data=body
+    )
+
+    res.raise_for_status()
+    return res
+
+
+def RE_get_analysis_id_from_binary_id(binary_id: int) -> Response:
+
+    res: Response = reveng_req(requests.get, f"v2/analyses/lookup/{binary_id}")
+
+    res.raise_for_status()
+    return res
+
+
+def RE_get_functions_from_analysis(analysis_id: int) -> Response:
+
+    res: Response = reveng_req(
+        requests.get, f"v2/analyses/{analysis_id}/functions/list"
+    )
+
+    res.raise_for_status()
+    return res
+
+
+def RE_update_collection_description(
+    collection_id: int,
+    description: str = "",
+):
+    params = {
+        "description": description,
+    }
+
+    res: Response = reveng_req(
+        requests.patch, f"v2/collections/{collection_id}", json_data=params
+    )
+
+    res.raise_for_status()
+    return res

{reait-1.2.1.dist-info → reait-1.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reait
-Version: 1.2.1
+Version: 1.2.3
 Summary: RevEng.AI Toolkit and Python API
 Home-page: https://github.com/RevEng-AI/reait
 Author: James Patrick-Evans

reait-1.2.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+reait/__init__.py,sha256=EoVCKwQwWxEBfwe-iEE5rFKvhi1gPEA8NPhnzXJTb2Y,42
+reait/api.py,sha256=Y7SZVr8d8gTE0y1Y7FVpEJGGzWhFtD00aHTtV7VXM8Q,38872
+reait/main.py,sha256=rSzEowDrK2KFmmLdbRNVsfVpvMLZNXA3fQOrBw03T4Y,20396
+reait-1.2.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+reait-1.2.3.dist-info/METADATA,sha256=Ue_-BK0dEm_0kI1O4WlBZeiYsvJJKeUyWA8lrYfmcy4,47663
+reait-1.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+reait-1.2.3.dist-info/entry_points.txt,sha256=8Ek11o7a6O8hjBFw6-1vmkBfbv_45O2vOKj5CDUB1e4,42
+reait-1.2.3.dist-info/top_level.txt,sha256=EnJssmctKe3Ugjcmu66L9_Q4elLdAwaXK6M8E6E8f_M,6
+reait-1.2.3.dist-info/RECORD,,

{reait-1.2.1.dist-info → reait-1.2.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

reait-1.2.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-reait/__init__.py,sha256=EoVCKwQwWxEBfwe-iEE5rFKvhi1gPEA8NPhnzXJTb2Y,42
-reait/api.py,sha256=ztgJEvd76L_ddN7vLxtCtLY4n3pxddMvu4VP7YA2a1w,36642
-reait/main.py,sha256=rSzEowDrK2KFmmLdbRNVsfVpvMLZNXA3fQOrBw03T4Y,20396
-reait-1.2.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-reait-1.2.1.dist-info/METADATA,sha256=Twgqyouwxy3lRCDP1YDAlct5_ltT2sPio0eHg5rX0eA,47663
-reait-1.2.1.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-reait-1.2.1.dist-info/entry_points.txt,sha256=8Ek11o7a6O8hjBFw6-1vmkBfbv_45O2vOKj5CDUB1e4,42
-reait-1.2.1.dist-info/top_level.txt,sha256=EnJssmctKe3Ugjcmu66L9_Q4elLdAwaXK6M8E6E8f_M,6
-reait-1.2.1.dist-info/RECORD,,