stackit-ufw 0.1.0__py3-none-any.whl

stackit/ufw/models/rule_response.py

@@ -0,0 +1,151 @@
+# coding: utf-8
+
+"""
+STACKIT Unified Firewall API
+
+API for managing and controlling the STACKIT Unified Firewall.
+
+The version of the OpenAPI document: 1.0.0
+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 typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class RuleResponse(BaseModel):
+    """
+    RuleResponse
+    """  # noqa: E501
+
+    description: Optional[StrictStr] = None
+    destination: StrictStr
+    direction: Optional[StrictStr] = None
+    error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage")
+    ether_type: Optional[StrictStr] = Field(default=None, alias="etherType")
+    instance_id: StrictStr = Field(alias="instanceId")
+    instance_name: Optional[StrictStr] = Field(default=None, alias="instanceName")
+    ip_range: Optional[StrictStr] = Field(default=None, alias="ipRange")
+    offset: Optional[StrictInt] = None
+    port_range: Optional[StrictStr] = Field(default=None, alias="portRange")
+    product: StrictStr
+    protocol: Optional[StrictStr] = None
+    region: Optional[StrictStr] = None
+    remote_security_group_id: Optional[StrictStr] = Field(default=None, alias="remoteSecurityGroupId")
+    security_group: Optional[StrictStr] = Field(default=None, alias="securityGroup")
+    security_group_id: Optional[StrictStr] = Field(default=None, alias="securityGroupId")
+    source_ip: StrictStr = Field(alias="sourceIP")
+    status: StrictStr = Field(description="The current state of the resource.")
+    type: StrictStr
+    __properties: ClassVar[List[str]] = [
+        "description",
+        "destination",
+        "direction",
+        "errorMessage",
+        "etherType",
+        "instanceId",
+        "instanceName",
+        "ipRange",
+        "offset",
+        "portRange",
+        "product",
+        "protocol",
+        "region",
+        "remoteSecurityGroupId",
+        "securityGroup",
+        "securityGroupId",
+        "sourceIP",
+        "status",
+        "type",
+    ]
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["Active", "Error", "Pending", "Updating", "Deleting", "Creating"]):
+            raise ValueError(
+                "must be one of enum values ('Active', 'Error', 'Pending', 'Updating', 'Deleting', 'Creating')"
+            )
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RuleResponse 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 RuleResponse 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"),
+                "destination": obj.get("destination"),
+                "direction": obj.get("direction"),
+                "errorMessage": obj.get("errorMessage"),
+                "etherType": obj.get("etherType"),
+                "instanceId": obj.get("instanceId"),
+                "instanceName": obj.get("instanceName"),
+                "ipRange": obj.get("ipRange"),
+                "offset": obj.get("offset"),
+                "portRange": obj.get("portRange"),
+                "product": obj.get("product"),
+                "protocol": obj.get("protocol"),
+                "region": obj.get("region"),
+                "remoteSecurityGroupId": obj.get("remoteSecurityGroupId"),
+                "securityGroup": obj.get("securityGroup"),
+                "securityGroupId": obj.get("securityGroupId"),
+                "sourceIP": obj.get("sourceIP"),
+                "status": obj.get("status"),
+                "type": obj.get("type"),
+            }
+        )
+        return _obj

stackit/ufw/models/update_rule_payload.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+STACKIT Unified Firewall API
+
+API for managing and controlling the STACKIT Unified Firewall.
+
+The version of the OpenAPI document: 1.0.0
+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 typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class UpdateRulePayload(BaseModel):
+    """
+    The request body for updating a security rule.
+    """  # noqa: E501
+
+    direction: Optional[StrictStr] = Field(
+        default=None, description='The direction of the traffic, typically "ingress" or "egress".'
+    )
+    ether_type: Optional[StrictStr] = Field(
+        default=None, description="Specifies the bound of the rule.", alias="etherType"
+    )
+    port_range: Optional[StrictStr] = Field(
+        default=None, description="The Port range to which the rule applies.", alias="portRange"
+    )
+    protocol: Optional[StrictStr] = Field(
+        default=None, description='The network protocol (e.g., "TCP", "UDP", "ICMP").'
+    )
+    security_group_id: Optional[StrictStr] = Field(
+        default=None, description="The ID of the Group.", alias="securityGroupId"
+    )
+    source_ip: StrictStr = Field(description="The IP (CIDR) to which the rule applies.", alias="sourceIP")
+    __properties: ClassVar[List[str]] = [
+        "direction",
+        "etherType",
+        "portRange",
+        "protocol",
+        "securityGroupId",
+        "sourceIP",
+    ]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UpdateRulePayload 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 UpdateRulePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "direction": obj.get("direction"),
+                "etherType": obj.get("etherType"),
+                "portRange": obj.get("portRange"),
+                "protocol": obj.get("protocol"),
+                "securityGroupId": obj.get("securityGroupId"),
+                "sourceIP": obj.get("sourceIP"),
+            }
+        )
+        return _obj

stackit/ufw/models/update_rule_response.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+"""
+STACKIT Unified Firewall API
+
+API for managing and controlling the STACKIT Unified Firewall.
+
+The version of the OpenAPI document: 1.0.0
+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 typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class UpdateRuleResponse(BaseModel):
+    """
+    UpdateRuleResponse
+    """  # noqa: E501
+
+    ref_id: Optional[StrictStr] = Field(
+        default=None, description="Represents the uuid of the updated rule", alias="refId"
+    )
+    __properties: ClassVar[List[str]] = ["refId"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UpdateRuleResponse 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 UpdateRuleResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"refId": obj.get("refId")})
+        return _obj

stackit/ufw/models/update_ufw_request.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+"""
+STACKIT Unified Firewall API
+
+API for managing and controlling the STACKIT Unified Firewall.
+
+The version of the OpenAPI document: 1.0.0
+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 typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Annotated, Self
+
+
+class UpdateUfwRequest(BaseModel):
+    """
+    UpdateUfwRequest
+    """  # noqa: E501
+
+    cidrs: Annotated[List[StrictStr], Field(max_length=128)] = Field(
+        description="The list of CIDRs currently set on the instance."
+    )
+    __properties: ClassVar[List[str]] = ["cidrs"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UpdateUfwRequest 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 UpdateUfwRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"cidrs": obj.get("cidrs")})
+        return _obj

stackit/ufw/models/version_response.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+"""
+STACKIT Unified Firewall API
+
+API for managing and controlling the STACKIT Unified Firewall.
+
+The version of the OpenAPI document: 1.0.0
+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 typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic_core import to_jsonable_python
+from typing_extensions import Self
+
+
+class VersionResponse(BaseModel):
+    """
+    VersionResponse
+    """  # noqa: E501
+
+    name: Optional[StrictStr] = None
+    version: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "version"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VersionResponse 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 VersionResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"name": obj.get("name"), "version": obj.get("version")})
+        return _obj

stackit/ufw/rest.py

@@ -0,0 +1,163 @@
+# coding: utf-8
+
+"""
+STACKIT Unified Firewall API
+
+API for managing and controlling the STACKIT Unified Firewall.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+import io
+import json
+import re
+
+import requests
+from stackit.core.authorization import Authorization
+from stackit.core.configuration import Configuration
+
+from stackit.ufw.exceptions import ApiException, ApiValueError
+
+RESTResponseType = requests.Response
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status_code
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.content
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+    def __init__(self, config: Configuration) -> None:
+        self.session = config.custom_http_session if config.custom_http_session else requests.Session()
+        authorization = Authorization(config)
+        self.session.auth = authorization.auth_method
+
+    def request(self, method, url, headers=None, body=None, post_params=None, _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        if method not in ["GET", "HEAD", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"]:
+            raise ValueError("Method %s not allowed", method)
+
+        if post_params and body:
+            raise ApiValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+
+                # no content type provided or payload is json
+                content_type = headers.get("Content-Type")
+                if not content_type or re.search("json", content_type, re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "application/x-www-form-urlencoded":
+                    r = self.session.request(
+                        method,
+                        url,
+                        params=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "multipart/form-data":
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers["Content-Type"]
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a, b) for a, b in post_params]
+                    r = self.session.request(
+                        method,
+                        url,
+                        files=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif headers["Content-Type"].startswith("text/") and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.session.request(
+                    method,
+                    url,
+                    params={},
+                    headers=headers,
+                    timeout=_request_timeout,
+                )
+        except requests.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)