revengai 2.74.0__py3-none-any.whl

revengai/models/file_hashes.py

@@ -0,0 +1,140 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileHashes(BaseModel):
+    """
+    FileHashes
+    """ # noqa: E501
+    md5: Optional[StrictStr]
+    sha1: Optional[StrictStr]
+    sha256: Optional[StrictStr]
+    sha512: Optional[StrictStr]
+    sha3_224: Optional[StrictStr]
+    sha3_256: Optional[StrictStr]
+    sha3_384: Optional[StrictStr]
+    sha3_512: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["md5", "sha1", "sha256", "sha512", "sha3_224", "sha3_256", "sha3_384", "sha3_512"]
+
+    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 FileHashes 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 md5 (nullable) is None
+        # and model_fields_set contains the field
+        if self.md5 is None and "md5" in self.model_fields_set:
+            _dict['md5'] = None
+
+        # set to None if sha1 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha1 is None and "sha1" in self.model_fields_set:
+            _dict['sha1'] = None
+
+        # set to None if sha256 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha256 is None and "sha256" in self.model_fields_set:
+            _dict['sha256'] = None
+
+        # set to None if sha512 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha512 is None and "sha512" in self.model_fields_set:
+            _dict['sha512'] = None
+
+        # set to None if sha3_224 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha3_224 is None and "sha3_224" in self.model_fields_set:
+            _dict['sha3_224'] = None
+
+        # set to None if sha3_256 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha3_256 is None and "sha3_256" in self.model_fields_set:
+            _dict['sha3_256'] = None
+
+        # set to None if sha3_384 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha3_384 is None and "sha3_384" in self.model_fields_set:
+            _dict['sha3_384'] = None
+
+        # set to None if sha3_512 (nullable) is None
+        # and model_fields_set contains the field
+        if self.sha3_512 is None and "sha3_512" in self.model_fields_set:
+            _dict['sha3_512'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FileHashes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "md5": obj.get("md5"),
+            "sha1": obj.get("sha1"),
+            "sha256": obj.get("sha256"),
+            "sha512": obj.get("sha512"),
+            "sha3_224": obj.get("sha3_224"),
+            "sha3_256": obj.get("sha3_256"),
+            "sha3_384": obj.get("sha3_384"),
+            "sha3_512": obj.get("sha3_512")
+        })
+        return _obj
+
+

revengai/models/file_metadata.py

@@ -0,0 +1,96 @@
+# 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, Union
+from revengai.models.file_hashes import FileHashes
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileMetadata(BaseModel):
+    """
+    FileMetadata
+    """ # noqa: E501
+    size: StrictInt
+    friendly_size: StrictStr
+    entropy: Union[StrictFloat, StrictInt]
+    hashes: FileHashes
+    __properties: ClassVar[List[str]] = ["size", "friendly_size", "entropy", "hashes"]
+
+    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 FileMetadata 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 hashes
+        if self.hashes:
+            _dict['hashes'] = self.hashes.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FileMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "size": obj.get("size"),
+            "friendly_size": obj.get("friendly_size"),
+            "entropy": obj.get("entropy"),
+            "hashes": FileHashes.from_dict(obj["hashes"]) if obj.get("hashes") is not None else None
+        })
+        return _obj
+
+

revengai/models/filters.py

@@ -0,0 +1,39 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class Filters(str, Enum):
+    """
+    Filters
+    """
+
+    """
+    allowed enum values
+    """
+    OFFICIAL_ONLY = 'official_only'
+    USER_ONLY = 'user_only'
+    TEAM_ONLY = 'team_only'
+    PUBLIC_ONLY = 'public_only'
+    HIDE_EMPTY = 'hide_empty'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Filters from a JSON string"""
+        return cls(json.loads(json_str))
+
+

revengai/models/function_block_destination_response.py

@@ -0,0 +1,95 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionBlockDestinationResponse(BaseModel):
+    """
+    FunctionBlockDestinationResponse
+    """ # noqa: E501
+    destination_block_id: Optional[StrictInt]
+    flowtype: StrictStr = Field(description="The type of execution flow between chunks")
+    vaddr: StrictStr = Field(description="The vaddr of the destination where the execution flow continues from")
+    __properties: ClassVar[List[str]] = ["destination_block_id", "flowtype", "vaddr"]
+
+    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 FunctionBlockDestinationResponse 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 destination_block_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.destination_block_id is None and "destination_block_id" in self.model_fields_set:
+            _dict['destination_block_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionBlockDestinationResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "destination_block_id": obj.get("destination_block_id"),
+            "flowtype": obj.get("flowtype"),
+            "vaddr": obj.get("vaddr")
+        })
+        return _obj
+
+

revengai/models/function_block_response.py

@@ -0,0 +1,109 @@
+# 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_block_destination_response import FunctionBlockDestinationResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionBlockResponse(BaseModel):
+    """
+    FunctionBlockResponse
+    """ # noqa: E501
+    asm: List[StrictStr] = Field(description="The ordered assembly strings for this chunk")
+    id: StrictInt = Field(description="ID of the block")
+    min_addr: StrictInt = Field(description="The minimum vaddr of the block")
+    max_addr: StrictInt = Field(description="The maximum vaddr of the block")
+    destinations: List[FunctionBlockDestinationResponse] = Field(description="The potential execution flow destinations from this block")
+    comment: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["asm", "id", "min_addr", "max_addr", "destinations", "comment"]
+
+    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 FunctionBlockResponse 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 destinations (list)
+        _items = []
+        if self.destinations:
+            for _item_destinations in self.destinations:
+                if _item_destinations:
+                    _items.append(_item_destinations.to_dict())
+            _dict['destinations'] = _items
+        # set to None if comment (nullable) is None
+        # and model_fields_set contains the field
+        if self.comment is None and "comment" in self.model_fields_set:
+            _dict['comment'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionBlockResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "asm": obj.get("asm"),
+            "id": obj.get("id"),
+            "min_addr": obj.get("min_addr"),
+            "max_addr": obj.get("max_addr"),
+            "destinations": [FunctionBlockDestinationResponse.from_dict(_item) for _item in obj["destinations"]] if obj.get("destinations") is not None else None,
+            "comment": obj.get("comment")
+        })
+        return _obj
+
+

revengai/models/function_blocks_response.py

@@ -0,0 +1,121 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.function_block_response import FunctionBlockResponse
+from revengai.models.function_local_variable_response import FunctionLocalVariableResponse
+from revengai.models.function_param_response import FunctionParamResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionBlocksResponse(BaseModel):
+    """
+    Response for returning disassembly of a function.
+    """ # noqa: E501
+    blocks: List[FunctionBlockResponse] = Field(description="Disassembly is broken into control flow blocks")
+    local_variables: List[FunctionLocalVariableResponse] = Field(description="Local variables associated with this function")
+    params: List[FunctionParamResponse] = Field(description="Params associated with this function")
+    overview_comment: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["blocks", "local_variables", "params", "overview_comment"]
+
+    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 FunctionBlocksResponse 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 blocks (list)
+        _items = []
+        if self.blocks:
+            for _item_blocks in self.blocks:
+                if _item_blocks:
+                    _items.append(_item_blocks.to_dict())
+            _dict['blocks'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in local_variables (list)
+        _items = []
+        if self.local_variables:
+            for _item_local_variables in self.local_variables:
+                if _item_local_variables:
+                    _items.append(_item_local_variables.to_dict())
+            _dict['local_variables'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in params (list)
+        _items = []
+        if self.params:
+            for _item_params in self.params:
+                if _item_params:
+                    _items.append(_item_params.to_dict())
+            _dict['params'] = _items
+        # set to None if overview_comment (nullable) is None
+        # and model_fields_set contains the field
+        if self.overview_comment is None and "overview_comment" in self.model_fields_set:
+            _dict['overview_comment'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionBlocksResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "blocks": [FunctionBlockResponse.from_dict(_item) for _item in obj["blocks"]] if obj.get("blocks") is not None else None,
+            "local_variables": [FunctionLocalVariableResponse.from_dict(_item) for _item in obj["local_variables"]] if obj.get("local_variables") is not None else None,
+            "params": [FunctionParamResponse.from_dict(_item) for _item in obj["params"]] if obj.get("params") is not None else None,
+            "overview_comment": obj.get("overview_comment")
+        })
+        return _obj
+
+

revengai/models/function_boundary.py

@@ -0,0 +1,90 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionBoundary(BaseModel):
+    """
+    FunctionBoundary
+    """ # noqa: E501
+    mangled_name: StrictStr
+    start_address: StrictInt
+    end_address: StrictInt
+    __properties: ClassVar[List[str]] = ["mangled_name", "start_address", "end_address"]
+
+    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 FunctionBoundary 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 FunctionBoundary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "mangled_name": obj.get("mangled_name"),
+            "start_address": obj.get("start_address"),
+            "end_address": obj.get("end_address")
+        })
+        return _obj
+
+