hiddenlayer-sdk 0.1.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

hiddenlayer/sdk/rest/models/scan_detection_v3.py

@@ -0,0 +1,156 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from hiddenlayer.sdk.rest.models.mitre_atlas_inner import MITREAtlasInner
+from hiddenlayer.sdk.rest.models.rule_details_inner import RuleDetailsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScanDetectionV3(BaseModel):
+    """
+    ScanDetectionV3
+    """ # noqa: E501
+    description: StrictStr = Field(description="detection description")
+    risk: StrictStr = Field(description="detection risk")
+    severity: StrictStr = Field(description="detection severity")
+    detection_id: StrictStr = Field(description="unique identifier for the detection")
+    impact: Optional[StrictStr] = Field(default=None, description="detection impact")
+    likelihood: Optional[StrictStr] = Field(default=None, description="detection likelihood")
+    rule_details: Optional[List[RuleDetailsInner]] = None
+    rule_id: StrictStr = Field(description="unique identifier for the rule that sourced the detection")
+    category: StrictStr = Field(description="Vulnerability category for the detection")
+    mitre_atlas: List[MITREAtlasInner]
+    owasp: List[Annotated[str, Field(strict=True)]]
+    cve: Optional[List[Annotated[str, Field(strict=True)]]] = None
+    cwe: Optional[Annotated[str, Field(strict=True)]] = None
+    cwe_href: Optional[StrictStr] = Field(default=None, description="CWE URL for the detection")
+    technical_blog_href: Optional[StrictStr] = Field(default=None, description="Hiddenlayer Technical Blog URL for the detection")
+    __properties: ClassVar[List[str]] = ["description", "risk", "severity", "detection_id", "impact", "likelihood", "rule_details", "rule_id", "category", "mitre_atlas", "owasp", "cve", "cwe", "cwe_href", "technical_blog_href"]
+
+    @field_validator('risk')
+    def risk_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['MALICIOUS', 'SUSPICIOUS', 'BENIGN']):
+            raise ValueError("must be one of enum values ('MALICIOUS', 'SUSPICIOUS', 'BENIGN')")
+        return value
+
+    @field_validator('severity')
+    def severity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['low', 'medium', 'high', 'critical']):
+            raise ValueError("must be one of enum values ('low', 'medium', 'high', 'critical')")
+        return value
+
+    @field_validator('cwe')
+    def cwe_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^CWE-\d{1,4}.*$", value):
+            raise ValueError(r"must validate the regular expression /^CWE-\d{1,4}.*$/")
+        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 ScanDetectionV3 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 rule_details (list)
+        _items = []
+        if self.rule_details:
+            for _item in self.rule_details:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['rule_details'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in mitre_atlas (list)
+        _items = []
+        if self.mitre_atlas:
+            for _item in self.mitre_atlas:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['mitre_atlas'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScanDetectionV3 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": obj.get("description"),
+            "risk": obj.get("risk"),
+            "severity": obj.get("severity"),
+            "detection_id": obj.get("detection_id"),
+            "impact": obj.get("impact"),
+            "likelihood": obj.get("likelihood"),
+            "rule_details": [RuleDetailsInner.from_dict(_item) for _item in obj["rule_details"]] if obj.get("rule_details") is not None else None,
+            "rule_id": obj.get("rule_id"),
+            "category": obj.get("category"),
+            "mitre_atlas": [MITREAtlasInner.from_dict(_item) for _item in obj["mitre_atlas"]] if obj.get("mitre_atlas") is not None else None,
+            "owasp": obj.get("owasp"),
+            "cve": obj.get("cve"),
+            "cwe": obj.get("cwe"),
+            "cwe_href": obj.get("cwe_href"),
+            "technical_blog_href": obj.get("technical_blog_href")
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/scan_header_v3.py

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from hiddenlayer.sdk.rest.models.model_inventory_info import ModelInventoryInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScanHeaderV3(BaseModel):
+    """
+    ScanHeaderV3
+    """ # noqa: E501
+    file_count: StrictInt = Field(description="number of files scanned")
+    files_with_detections_count: StrictInt = Field(description="number of files with detections found")
+    detection_count: StrictInt = Field(description="number of detections found")
+    detection_categories: Optional[List[StrictStr]] = Field(default=None, description="list of detection categories found")
+    inventory: ModelInventoryInfo
+    version: StrictStr = Field(description="scanner version")
+    scan_id: StrictStr = Field(description="unique identifier for the scan")
+    start_time: datetime = Field(description="time the scan started")
+    end_time: Optional[datetime] = Field(default=None, description="time the scan ended")
+    status: StrictStr = Field(description="status of the scan")
+    severity: Optional[StrictStr] = Field(default=None, description="detection severity")
+    __properties: ClassVar[List[str]] = ["file_count", "files_with_detections_count", "detection_count", "detection_categories", "inventory", "version", "scan_id", "start_time", "end_time", "status", "severity"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['pending', 'running', 'done', 'failed', 'canceled']):
+            raise ValueError("must be one of enum values ('pending', 'running', 'done', 'failed', 'canceled')")
+        return value
+
+    @field_validator('severity')
+    def severity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['low', 'medium', 'high', 'critical', 'safe', 'unknown']):
+            raise ValueError("must be one of enum values ('low', 'medium', 'high', 'critical', 'safe', 'unknown')")
+        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 ScanHeaderV3 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 inventory
+        if self.inventory:
+            _dict['inventory'] = self.inventory.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScanHeaderV3 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_count": obj.get("file_count"),
+            "files_with_detections_count": obj.get("files_with_detections_count"),
+            "detection_count": obj.get("detection_count"),
+            "detection_categories": obj.get("detection_categories"),
+            "inventory": ModelInventoryInfo.from_dict(obj["inventory"]) if obj.get("inventory") is not None else None,
+            "version": obj.get("version"),
+            "scan_id": obj.get("scan_id"),
+            "start_time": obj.get("start_time"),
+            "end_time": obj.get("end_time"),
+            "status": obj.get("status"),
+            "severity": obj.get("severity")
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/scan_job.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from hiddenlayer.sdk.rest.models.scan_job_inventory import ScanJobInventory
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScanJob(BaseModel):
+    """
+    ScanJob
+    """ # noqa: E501
+    scan_id: Optional[StrictStr] = Field(default=None, description="unique identifier for the scan")
+    status: Optional[StrictStr] = Field(default=None, description="Status of the scan")
+    inventory: Optional[ScanJobInventory] = None
+    __properties: ClassVar[List[str]] = ["scan_id", "status", "inventory"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['pending', 'running', 'done', 'failed', 'canceled']):
+            raise ValueError("must be one of enum values ('pending', 'running', 'done', 'failed', 'canceled')")
+        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 ScanJob 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "scan_id",
+            "status",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of inventory
+        if self.inventory:
+            _dict['inventory'] = self.inventory.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScanJob from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "scan_id": obj.get("scan_id"),
+            "status": obj.get("status"),
+            "inventory": ScanJobInventory.from_dict(obj["inventory"]) if obj.get("inventory") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/scan_job_inventory.py

@@ -0,0 +1,137 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from hiddenlayer.sdk.rest.models.scan_model_details_v3 import ScanModelDetailsV3
+from hiddenlayer.sdk.rest.models.scan_model_ids_v3 import ScanModelIdsV3
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+SCANJOBINVENTORY_ONE_OF_SCHEMAS = ["ScanModelDetailsV3", "ScanModelIdsV3"]
+
+class ScanJobInventory(BaseModel):
+    """
+    ScanJobInventory
+    """
+    # data type: ScanModelDetailsV3
+    oneof_schema_1_validator: Optional[ScanModelDetailsV3] = None
+    # data type: ScanModelIdsV3
+    oneof_schema_2_validator: Optional[ScanModelIdsV3] = None
+    actual_instance: Optional[Union[ScanModelDetailsV3, ScanModelIdsV3]] = None
+    one_of_schemas: Set[str] = { "ScanModelDetailsV3", "ScanModelIdsV3" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = ScanJobInventory.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: ScanModelDetailsV3
+        if not isinstance(v, ScanModelDetailsV3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScanModelDetailsV3`")
+        else:
+            match += 1
+        # validate data type: ScanModelIdsV3
+        if not isinstance(v, ScanModelIdsV3):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScanModelIdsV3`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in ScanJobInventory with oneOf schemas: ScanModelDetailsV3, ScanModelIdsV3. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in ScanJobInventory with oneOf schemas: ScanModelDetailsV3, ScanModelIdsV3. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into ScanModelDetailsV3
+        try:
+            instance.actual_instance = ScanModelDetailsV3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScanModelIdsV3
+        try:
+            instance.actual_instance = ScanModelIdsV3.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into ScanJobInventory with oneOf schemas: ScanModelDetailsV3, ScanModelIdsV3. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into ScanJobInventory with oneOf schemas: ScanModelDetailsV3, ScanModelIdsV3. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], ScanModelDetailsV3, ScanModelIdsV3]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

hiddenlayer/sdk/rest/models/scan_model_details_v3.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScanModelDetailsV3(BaseModel):
+    """
+    ScanModelDetailsV3
+    """ # noqa: E501
+    model_name: StrictStr = Field(description="name of the model")
+    model_version: StrictStr = Field(description="version of the model")
+    model_source: StrictStr = Field(description="source (provider) info")
+    requested_scan_location: StrictStr = Field(description="Location to be scanned")
+    requesting_entity: Optional[StrictStr] = Field(default=None, description="Entity that requested the scan")
+    __properties: ClassVar[List[str]] = ["model_name", "model_version", "model_source", "requested_scan_location", "requesting_entity"]
+
+    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 ScanModelDetailsV3 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 ScanModelDetailsV3 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "model_name": obj.get("model_name"),
+            "model_version": obj.get("model_version"),
+            "model_source": obj.get("model_source"),
+            "requested_scan_location": obj.get("requested_scan_location"),
+            "requesting_entity": obj.get("requesting_entity")
+        })
+        return _obj
+
+