revengai 1.86.0__py3-none-any.whl → 1.88.0__py3-none-any.whl

revengai/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/v1.86.0/python'
+        self.user_agent = 'OpenAPI-Generator/v1.88.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

revengai/configuration.py

@@ -529,8 +529,8 @@ conf = revengai.Configuration(
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: v1.86.0\n"\
-               "SDK Package Version: v1.86.0".\
+               "Version of the API: v1.88.0\n"\
+               "SDK Package Version: v1.88.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

revengai/models/__init__.py

@@ -21,6 +21,7 @@ from revengai.models.analysis_create_request import AnalysisCreateRequest
 from revengai.models.analysis_create_response import AnalysisCreateResponse
 from revengai.models.analysis_detail_response import AnalysisDetailResponse
 from revengai.models.analysis_function_mapping import AnalysisFunctionMapping
+from revengai.models.analysis_function_matching_request import AnalysisFunctionMatchingRequest
 from revengai.models.analysis_functions import AnalysisFunctions
 from revengai.models.analysis_record import AnalysisRecord
 from revengai.models.analysis_scope import AnalysisScope
@@ -207,6 +208,10 @@ from revengai.models.function_info_output import FunctionInfoOutput
 from revengai.models.function_local_variable_response import FunctionLocalVariableResponse
 from revengai.models.function_mapping import FunctionMapping
 from revengai.models.function_mapping_full import FunctionMappingFull
+from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest
+from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+from revengai.models.function_matching_result_with_best_match import FunctionMatchingResultWithBestMatch
+from revengai.models.function_matching_scope_request import FunctionMatchingScopeRequest
 from revengai.models.function_name_confidence_body import FunctionNameConfidenceBody
 from revengai.models.function_name_history import FunctionNameHistory
 from revengai.models.function_name_input import FunctionNameInput
@@ -241,6 +246,7 @@ from revengai.models.list_collection_results import ListCollectionResults
 from revengai.models.login_request import LoginRequest
 from revengai.models.login_response import LoginResponse
 from revengai.models.logs import Logs
+from revengai.models.matched_function import MatchedFunction
 from revengai.models.matched_function_suggestion import MatchedFunctionSuggestion
 from revengai.models.meta_model import MetaModel
 from revengai.models.model_name import ModelName

revengai/models/analysis_function_matching_request.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalysisFunctionMatchingRequest(BaseModel):
+    """
+    AnalysisFunctionMatchingRequest
+    """ # noqa: E501
+    min_similarity: Optional[Union[Annotated[float, Field(le=1.0, strict=True, ge=0.0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.9, description="Minimum similarity expected for a match, default is 0.9")
+    __properties: ClassVar[List[str]] = ["min_similarity"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AnalysisFunctionMatchingRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AnalysisFunctionMatchingRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "min_similarity": obj.get("min_similarity") if obj.get("min_similarity") is not None else 0.9
+        })
+        return _obj
+
+

revengai/models/function_matching_batch_request.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.function_matching_scope_request import FunctionMatchingScopeRequest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionMatchingBatchRequest(BaseModel):
+    """
+    FunctionMatchingBatchRequest
+    """ # noqa: E501
+    model_id: Optional[StrictInt] = None
+    scope: FunctionMatchingScopeRequest = Field(description="Scope of the function matching request, used to limit the search to specific binaries, collections, and functions")
+    __properties: ClassVar[List[str]] = ["model_id", "scope"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FunctionMatchingBatchRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of scope
+        if self.scope:
+            _dict['scope'] = self.scope.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionMatchingBatchRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "model_id": obj.get("model_id"),
+            "scope": FunctionMatchingScopeRequest.from_dict(obj["scope"]) if obj.get("scope") is not None else None
+        })
+        return _obj
+
+

revengai/models/function_matching_batch_response.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.function_matching_result_with_best_match import FunctionMatchingResultWithBestMatch
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionMatchingBatchResponse(BaseModel):
+    """
+    FunctionMatchingBatchResponse
+    """ # noqa: E501
+    progress: Optional[StrictInt] = Field(default=0, description="Progress of the matching operation, represented as a percentage")
+    status: Optional[StrictStr] = None
+    total_time: Optional[StrictInt] = None
+    error_message: Optional[StrictStr] = None
+    matches: List[FunctionMatchingResultWithBestMatch]
+    __properties: ClassVar[List[str]] = ["progress", "status", "total_time", "error_message", "matches"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FunctionMatchingBatchResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in matches (list)
+        _items = []
+        if self.matches:
+            for _item_matches in self.matches:
+                if _item_matches:
+                    _items.append(_item_matches.to_dict())
+            _dict['matches'] = _items
+        # set to None if status (nullable) is None
+        # and model_fields_set contains the field
+        if self.status is None and "status" in self.model_fields_set:
+            _dict['status'] = None
+
+        # set to None if total_time (nullable) is None
+        # and model_fields_set contains the field
+        if self.total_time is None and "total_time" in self.model_fields_set:
+            _dict['total_time'] = None
+
+        # set to None if error_message (nullable) is None
+        # and model_fields_set contains the field
+        if self.error_message is None and "error_message" in self.model_fields_set:
+            _dict['error_message'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionMatchingBatchResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "progress": obj.get("progress") if obj.get("progress") is not None else 0,
+            "status": obj.get("status"),
+            "total_time": obj.get("total_time"),
+            "error_message": obj.get("error_message"),
+            "matches": [FunctionMatchingResultWithBestMatch.from_dict(_item) for _item in obj["matches"]] if obj.get("matches") is not None else None
+        })
+        return _obj
+
+

revengai/models/function_matching_result_with_best_match.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from revengai.models.matched_function import MatchedFunction
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionMatchingResultWithBestMatch(BaseModel):
+    """
+    FunctionMatchingResultWithBestMatch
+    """ # noqa: E501
+    function_id: StrictInt
+    similarity: Union[StrictFloat, StrictInt]
+    matched_function: MatchedFunction
+    suggested_name: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["function_id", "similarity", "matched_function", "suggested_name"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FunctionMatchingResultWithBestMatch from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of matched_function
+        if self.matched_function:
+            _dict['matched_function'] = self.matched_function.to_dict()
+        # set to None if suggested_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.suggested_name is None and "suggested_name" in self.model_fields_set:
+            _dict['suggested_name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionMatchingResultWithBestMatch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "function_id": obj.get("function_id"),
+            "similarity": obj.get("similarity"),
+            "matched_function": MatchedFunction.from_dict(obj["matched_function"]) if obj.get("matched_function") is not None else None,
+            "suggested_name": obj.get("suggested_name")
+        })
+        return _obj
+
+

revengai/models/function_matching_scope_request.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionMatchingScopeRequest(BaseModel):
+    """
+    FunctionMatchingScopeRequest
+    """ # noqa: E501
+    binary_ids: Optional[List[StrictInt]] = Field(default=None, description="ID's of binaries to limit the search to, if empty, search all scoped binaries")
+    collection_ids: Optional[List[StrictInt]] = Field(default=None, description="ID's of collections to limit the search to, if empty, search all scoped collections")
+    function_ids: Optional[List[StrictInt]] = Field(default=None, description="ID's of functions to limit the search to, if empty, search all scoped functions")
+    min_similarity: Optional[Union[Annotated[float, Field(le=1.0, strict=True, ge=0.0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.9, description="Minimum similarity expected for a match, default is 0.9")
+    debug_types: Optional[List[StrictStr]] = Field(default=None, description="Limit the search to specific debug types, if empty, search all scoped debug & non-debug functions")
+    __properties: ClassVar[List[str]] = ["binary_ids", "collection_ids", "function_ids", "min_similarity", "debug_types"]
+
+    @field_validator('debug_types')
+    def debug_types_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['USER', 'SYSTEM', 'EXTERNAL']):
+                raise ValueError("each list item must be one of ('USER', 'SYSTEM', 'EXTERNAL')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FunctionMatchingScopeRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionMatchingScopeRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "binary_ids": obj.get("binary_ids"),
+            "collection_ids": obj.get("collection_ids"),
+            "function_ids": obj.get("function_ids"),
+            "min_similarity": obj.get("min_similarity") if obj.get("min_similarity") is not None else 0.9,
+            "debug_types": obj.get("debug_types")
+        })
+        return _obj
+
+

revengai/models/matched_function.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MatchedFunction(BaseModel):
+    """
+    MatchedFunction
+    """ # noqa: E501
+    function_id: StrictInt
+    binary_id: StrictInt
+    function_name: StrictStr
+    function_vaddr: StrictInt
+    mangled_name: Optional[StrictStr]
+    debug: StrictBool
+    binary_name: StrictStr
+    sha_256_hash: StrictStr
+    analysis_id: StrictInt
+    similarity: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["function_id", "binary_id", "function_name", "function_vaddr", "mangled_name", "debug", "binary_name", "sha_256_hash", "analysis_id", "similarity"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MatchedFunction from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if mangled_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.mangled_name is None and "mangled_name" in self.model_fields_set:
+            _dict['mangled_name'] = None
+
+        # set to None if similarity (nullable) is None
+        # and model_fields_set contains the field
+        if self.similarity is None and "similarity" in self.model_fields_set:
+            _dict['similarity'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MatchedFunction from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "function_id": obj.get("function_id"),
+            "binary_id": obj.get("binary_id"),
+            "function_name": obj.get("function_name"),
+            "function_vaddr": obj.get("function_vaddr"),
+            "mangled_name": obj.get("mangled_name"),
+            "debug": obj.get("debug"),
+            "binary_name": obj.get("binary_name"),
+            "sha_256_hash": obj.get("sha_256_hash"),
+            "analysis_id": obj.get("analysis_id"),
+            "similarity": obj.get("similarity")
+        })
+        return _obj
+
+