revengai 1.1.1__py3-none-any.whl

revengai/models/file_format.py

@@ -0,0 +1,38 @@
+# 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
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class FileFormat(str, Enum):
+    """
+    FileFormat
+    """
+
+    """
+    allowed enum values
+    """
+    PE = 'pe'
+    ELF = 'elf'
+    BLOB = 'blob'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FileFormat from a JSON string"""
+        return cls(json.loads(json_str))
+
+

revengai/models/file_hashes.py

@@ -0,0 +1,141 @@
+# 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
+
+
+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,97 @@
+# 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
+
+
+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/file_options.py

@@ -0,0 +1,41 @@
+# 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
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class FileOptions(str, Enum):
+    """
+    Custom Enum for the file options
+    """
+
+    """
+    allowed enum values
+    """
+    AUTO = 'Auto'
+    PE = 'PE'
+    ELF = 'ELF'
+    RAW = 'RAW'
+    EXE = 'EXE'
+    DLL = 'dll'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FileOptions from a JSON string"""
+        return cls(json.loads(json_str))
+
+

revengai/models/filters.py

@@ -0,0 +1,40 @@
+# 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
+
+
+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_analysis_threat_score_data.py

@@ -0,0 +1,99 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionAnalysisThreatScoreData(BaseModel):
+    """
+    FunctionAnalysisThreatScoreData
+    """ # noqa: E501
+    min: Union[StrictFloat, StrictInt] = Field(description="The minimum value for the analysis score")
+    max: Union[StrictFloat, StrictInt] = Field(description="The maximum value for the analysis score")
+    average: Union[StrictFloat, StrictInt] = Field(description="The average value for the analysis score")
+    upper: Union[StrictFloat, StrictInt] = Field(description="The upper limit for the analysis score")
+    lower: Union[StrictFloat, StrictInt] = Field(description="The lower limit for the analysis score")
+    malware_count: StrictInt = Field(description="Number of malware binaries used in threat score calculation")
+    benign_count: StrictInt = Field(description="Number of benign binaries used in threat score calculation")
+    __properties: ClassVar[List[str]] = ["min", "max", "average", "upper", "lower", "malware_count", "benign_count"]
+
+    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 FunctionAnalysisThreatScoreData 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 FunctionAnalysisThreatScoreData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "min": obj.get("min"),
+            "max": obj.get("max"),
+            "average": obj.get("average"),
+            "upper": obj.get("upper"),
+            "lower": obj.get("lower"),
+            "malware_count": obj.get("malware_count"),
+            "benign_count": obj.get("benign_count")
+        })
+        return _obj
+
+

revengai/models/function_batch_ann.py

@@ -0,0 +1,106 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionBatchAnn(BaseModel):
+    """
+    FunctionBatchAnn
+    """ # noqa: E501
+    success: Optional[Any] = None
+    settings: Optional[Any]
+    function_matches: Optional[Any]
+    __properties: ClassVar[List[str]] = ["success", "settings", "function_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 FunctionBatchAnn 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 success (nullable) is None
+        # and model_fields_set contains the field
+        if self.success is None and "success" in self.model_fields_set:
+            _dict['success'] = None
+
+        # set to None if settings (nullable) is None
+        # and model_fields_set contains the field
+        if self.settings is None and "settings" in self.model_fields_set:
+            _dict['settings'] = None
+
+        # set to None if function_matches (nullable) is None
+        # and model_fields_set contains the field
+        if self.function_matches is None and "function_matches" in self.model_fields_set:
+            _dict['function_matches'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionBatchAnn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "success": obj.get("success"),
+            "settings": obj.get("settings"),
+            "function_matches": obj.get("function_matches")
+        })
+        return _obj
+
+

revengai/models/function_block_destination_response.py

@@ -0,0 +1,96 @@
+# 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
+
+
+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
+
+