revengai 1.1.1__py3-none-any.whl

revengai/models/binary_config.py

@@ -0,0 +1,109 @@
+# 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 revengai.models.file_format import FileFormat
+from revengai.models.isa import ISA
+from revengai.models.platform import Platform
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BinaryConfig(BaseModel):
+    """
+    BinaryConfig
+    """ # noqa: E501
+    isa: Optional[ISA] = None
+    platform: Optional[Platform] = None
+    file_format: Optional[FileFormat] = None
+    __properties: ClassVar[List[str]] = ["isa", "platform", "file_format"]
+
+    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 BinaryConfig 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 isa (nullable) is None
+        # and model_fields_set contains the field
+        if self.isa is None and "isa" in self.model_fields_set:
+            _dict['isa'] = None
+
+        # set to None if platform (nullable) is None
+        # and model_fields_set contains the field
+        if self.platform is None and "platform" in self.model_fields_set:
+            _dict['platform'] = None
+
+        # set to None if file_format (nullable) is None
+        # and model_fields_set contains the field
+        if self.file_format is None and "file_format" in self.model_fields_set:
+            _dict['file_format'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BinaryConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "isa": obj.get("isa"),
+            "platform": obj.get("platform"),
+            "file_format": obj.get("file_format")
+        })
+        return _obj
+
+

revengai/models/binary_details_response.py

@@ -0,0 +1,126 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BinaryDetailsResponse(BaseModel):
+    """
+    BinaryDetailsResponse
+    """ # noqa: E501
+    arch: StrictStr = Field(description="The architecture of the binary")
+    bits: StrictInt = Field(description="The size of the binary in bits")
+    crc32: StrictStr
+    var_class: StrictStr = Field(alias="Class")
+    entropy: Union[StrictFloat, StrictInt]
+    file_size: StrictInt
+    language: StrictStr
+    md5: StrictStr
+    machine: StrictStr
+    os: StrictStr = Field(description="OS target of the binary")
+    sha1: StrictStr = Field(description="SHA1 hash of the binary")
+    sha256: StrictStr = Field(description="SHA256 hash of the binary")
+    ssdeep: StrictStr
+    static: StrictBool
+    stripped: StrictBool
+    sub_sys: StrictStr
+    tlsh: StrictStr
+    type: StrictStr
+    debug: StrictBool
+    first_seen: datetime
+    __properties: ClassVar[List[str]] = ["arch", "bits", "crc32", "Class", "entropy", "file_size", "language", "md5", "machine", "os", "sha1", "sha256", "ssdeep", "static", "stripped", "sub_sys", "tlsh", "type", "debug", "first_seen"]
+
+    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 BinaryDetailsResponse 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 BinaryDetailsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "arch": obj.get("arch"),
+            "bits": obj.get("bits"),
+            "crc32": obj.get("crc32"),
+            "Class": obj.get("Class"),
+            "entropy": obj.get("entropy"),
+            "file_size": obj.get("file_size"),
+            "language": obj.get("language"),
+            "md5": obj.get("md5"),
+            "machine": obj.get("machine"),
+            "os": obj.get("os"),
+            "sha1": obj.get("sha1"),
+            "sha256": obj.get("sha256"),
+            "ssdeep": obj.get("ssdeep"),
+            "static": obj.get("static"),
+            "stripped": obj.get("stripped"),
+            "sub_sys": obj.get("sub_sys"),
+            "tlsh": obj.get("tlsh"),
+            "type": obj.get("type"),
+            "debug": obj.get("debug"),
+            "first_seen": obj.get("first_seen")
+        })
+        return _obj
+
+

revengai/models/binary_externals_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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BinaryExternalsResponse(BaseModel):
+    """
+    BinaryExternalsResponse
+    """ # noqa: E501
+    sha_256_hash: StrictStr = Field(description="SHA256 hash of the binary")
+    vt: Dict[str, Any] = Field(description="VirusTotal information")
+    vt_last_updated: datetime = Field(description="VirusTotal last updated date")
+    mb: Dict[str, Any] = Field(description="MalwareBazaar information")
+    mb_last_updated: datetime = Field(description="MalwareBazaar last updated date")
+    __properties: ClassVar[List[str]] = ["sha_256_hash", "vt", "vt_last_updated", "mb", "mb_last_updated"]
+
+    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 BinaryExternalsResponse 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 BinaryExternalsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sha_256_hash": obj.get("sha_256_hash"),
+            "vt": obj.get("vt"),
+            "vt_last_updated": obj.get("vt_last_updated"),
+            "mb": obj.get("mb"),
+            "mb_last_updated": obj.get("mb_last_updated")
+        })
+        return _obj
+
+

revengai/models/binary_search_response.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from revengai.models.binary_search_result import BinarySearchResult
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BinarySearchResponse(BaseModel):
+    """
+    BinarySearchResponse
+    """ # noqa: E501
+    results: List[BinarySearchResult] = Field(description="The results of the search")
+    __properties: ClassVar[List[str]] = ["results"]
+
+    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 BinarySearchResponse 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 results (list)
+        _items = []
+        if self.results:
+            for _item_results in self.results:
+                if _item_results:
+                    _items.append(_item_results.to_dict())
+            _dict['results'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BinarySearchResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "results": [BinarySearchResult.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None
+        })
+        return _obj
+
+

revengai/models/binary_search_result.py

@@ -0,0 +1,109 @@
+# 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 datetime import datetime
+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 BinarySearchResult(BaseModel):
+    """
+    BinarySearchResult
+    """ # noqa: E501
+    binary_id: StrictInt = Field(description="The binary ID")
+    binary_name: StrictStr = Field(description="The name of the binary")
+    analysis_id: StrictInt = Field(description="The analysis ID")
+    sha_256_hash: StrictStr = Field(description="The SHA-256 hash of the binary")
+    tags: Optional[List[StrictStr]]
+    created_at: datetime = Field(description="The creation date of the binary")
+    model_id: StrictInt = Field(description="The model ID of the binary")
+    model_name: StrictStr = Field(description="The name of the model")
+    owned_by: StrictStr = Field(description="The owner of the binary")
+    __properties: ClassVar[List[str]] = ["binary_id", "binary_name", "analysis_id", "sha_256_hash", "tags", "created_at", "model_id", "model_name", "owned_by"]
+
+    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 BinarySearchResult 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 tags (nullable) is None
+        # and model_fields_set contains the field
+        if self.tags is None and "tags" in self.model_fields_set:
+            _dict['tags'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BinarySearchResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "binary_id": obj.get("binary_id"),
+            "binary_name": obj.get("binary_name"),
+            "analysis_id": obj.get("analysis_id"),
+            "sha_256_hash": obj.get("sha_256_hash"),
+            "tags": obj.get("tags"),
+            "created_at": obj.get("created_at"),
+            "model_id": obj.get("model_id"),
+            "model_name": obj.get("model_name"),
+            "owned_by": obj.get("owned_by")
+        })
+        return _obj
+
+

revengai/models/binary_task_status.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 BinaryTaskStatus(str, Enum):
+    """
+    BinaryTaskStatus
+    """
+
+    """
+    allowed enum values
+    """
+    UNINITIALISED = 'UNINITIALISED'
+    PENDING = 'PENDING'
+    RUNNING = 'RUNNING'
+    COMPLETED = 'COMPLETED'
+    FAILED = 'FAILED'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BinaryTaskStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

revengai/models/block.py

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