catalystwan 0.41.2__py3-none-any.whl → 0.41.2.dev0__py3-none-any.whl

catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/ssl_decryption_profile.py

@@ -0,0 +1,165 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+from uuid import UUID
+
+from pydantic import AliasPath, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase
+from catalystwan.models.configuration.feature_profile.common import RefIdItem
+
+Categories = Literal[
+    "abortion",
+    "abused-drugs",
+    "adult-and-pornography",
+    "alcohol-and-tobacco",
+    "auctions",
+    "bot-nets",
+    "business-and-economy",
+    "cdns",
+    "cheating",
+    "computer-and-internet-info",
+    "computer-and-internet-security",
+    "confirmed-spam-sources",
+    "cult-and-occult",
+    "dating",
+    "dead-sites",
+    "dynamic-content",
+    "educational-institutions",
+    "entertainment-and-arts",
+    "fashion-and-beauty",
+    "financial-services",
+    "gambling",
+    "games",
+    "government",
+    "gross",
+    "hacking",
+    "hate-and-racism",
+    "health-and-medicine",
+    "home",
+    "hunting-and-fishing",
+    "illegal",
+    "image-and-video-search",
+    "individual-stock-advice-and-tools",
+    "internet-communications",
+    "internet-portals",
+    "job-search",
+    "keyloggers-and-monitoring",
+    "kids",
+    "legal",
+    "local-information",
+    "malware-sites",
+    "marijuana",
+    "military",
+    "motor-vehicles",
+    "music",
+    "news-and-media",
+    "nudity",
+    "online-greeting-cards",
+    "online-personal-storage",
+    "open-http-proxies",
+    "p2p",
+    "parked-sites",
+    "pay-to-surf",
+    "personal-sites-and-blogs",
+    "philosophy-and-political-advocacy",
+    "phishing-and-other-frauds",
+    "private-ip-addresses",
+    "proxy-avoid-and-anonymizers",
+    "questionable",
+    "real-estate",
+    "recreation-and-hobbies",
+    "reference-and-research",
+    "religion",
+    "search-engines",
+    "sex-education",
+    "shareware-and-freeware",
+    "shopping",
+    "social-network",
+    "society",
+    "spam-urls",
+    "sports",
+    "spyware-and-adware",
+    "streaming-media",
+    "swimsuits-and-intimate-apparel",
+    "training-and-tools",
+    "translation",
+    "travel",
+    "uncategorized",
+    "unconfirmed-spam-sources",
+    "violence",
+    "weapons",
+    "web-advertisements",
+    "web-based-email",
+    "web-hosting",
+]
+
+DecryptThreshold = Literal["high-risk", "low-risk", "moderate-risk", "suspicious", "trustworthy"]
+
+
+class SslDecryptionProfileParcel(_ParcelBase):
+    model_config = ConfigDict(populate_by_name=True)
+    type_: Literal["unified/ssl-decryption-profile"] = Field(default="unified/ssl-decryption-profile", exclude=True)
+    parcel_description: str = Field(
+        default="",
+        serialization_alias="description",
+        validation_alias="description",
+        description="Set the parcel description",
+    )
+    decrypt_categories: Global[List[Categories]] = Field(
+        default=Global[List[Categories]](value=[]), validation_alias=AliasPath("data", "decryptCategories")
+    )
+    never_decrypt_categories: Global[List[Categories]] = Field(
+        default=Global[List[Categories]](value=[]), validation_alias=AliasPath("data", "neverDecryptCategories")
+    )
+    skip_decrypt_categories: Global[List[Categories]] = Field(
+        default=Global[List[Categories]](value=[]), validation_alias=AliasPath("data", "skipDecryptCategories")
+    )
+    reputation: Global[bool] = Field(
+        default=Global[bool](value=False), validation_alias=AliasPath("data", "reputation")
+    )
+    decrypt_threshold: Optional[Global[DecryptThreshold]] = Field(
+        default=None, validation_alias=AliasPath("data", "decryptThreshold")
+    )
+    skip_decrypt_threshold: Optional[Global[DecryptThreshold]] = Field(
+        default=None, validation_alias=AliasPath("data", "skipDecryptThreshold")
+    )
+    fail_decrypt: Global[bool] = Field(
+        default=Global[bool](value=False), validation_alias=AliasPath("data", "failDecrypt")
+    )
+    url_allowed_list: Optional[RefIdItem] = Field(default=None, validation_alias=AliasPath("data", "urlAllowedList"))
+    url_blocked_list: Optional[RefIdItem] = Field(default=None, validation_alias=AliasPath("data", "urlBlockedList"))
+
+    @classmethod
+    def create(
+        cls,
+        parcel_name: str,
+        parcel_description: str,
+        decrypt_categories: List[Categories],
+        never_decrypt_categories: List[Categories],
+        skip_decrypt_categories: List[Categories],
+        reputation: bool,
+        fail_decrypt: bool,
+        skip_decrypt_threshold: Optional[DecryptThreshold] = None,
+        decrypt_threshold: Optional[DecryptThreshold] = None,
+        url_allowed_list: Optional[UUID] = None,
+        url_blocked_list: Optional[UUID] = None,
+    ) -> "SslDecryptionProfileParcel":
+        ual = RefIdItem.from_uuid(url_allowed_list) if url_allowed_list else None
+        ubl = RefIdItem.from_uuid(url_blocked_list) if url_blocked_list else None
+        dt = Global[DecryptThreshold](value=decrypt_threshold) if decrypt_threshold else None
+        sdt = Global[DecryptThreshold](value=skip_decrypt_threshold) if skip_decrypt_threshold else None
+
+        return cls(
+            parcel_name=parcel_name,
+            parcel_description=parcel_description,
+            decrypt_categories=Global[List[Categories]](value=decrypt_categories),
+            never_decrypt_categories=Global[List[Categories]](value=never_decrypt_categories),
+            skip_decrypt_categories=Global[List[Categories]](value=skip_decrypt_categories),
+            reputation=Global[bool](value=reputation),
+            fail_decrypt=Global[bool](value=fail_decrypt),
+            decrypt_threshold=dt,
+            skip_decrypt_threshold=sdt,
+            url_allowed_list=ual,
+            url_blocked_list=ubl,
+        )

catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/url.py

@@ -1,27 +1,32 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
-from typing import List
+from typing import List, Literal
 
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
+from pydantic import AliasPath, ConfigDict, Field
 
-from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global
+from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, _ParcelEntry, as_global
 
 
-class BaseURLListEntry(BaseModel):
+class BaseURLListEntry(_ParcelEntry):
     model_config = ConfigDict(populate_by_name=True)
     pattern: Global[str]
 
 
-class BaseURLParcel(_ParcelBase):
-    entries: List[BaseURLListEntry] = Field(default=[], validation_alias=AliasPath("data", "entries"))
+class URLParcel(_ParcelBase):
+    model_config = ConfigDict(populate_by_name=True)
+    type_: Literal["security-urllist"] = Field(default="security-urllist", exclude=True)
+    type: Literal["urlallowed", "urlblocked"]
+    entries: List[BaseURLListEntry] = Field(default_factory=list, validation_alias=AliasPath("data", "entries"))
 
     def add_url(self, pattern: str):
         self.entries.append(BaseURLListEntry(pattern=as_global(pattern)))
 
 
-class URLAllowParcel(BaseURLParcel):
-    parcel_type: str = Field(default="urlallowed", validation_alias="type", serialization_alias="type")
+class URLAllowParcel(URLParcel):
+    model_config = ConfigDict(populate_by_name=True)
+    type: Literal["urlallowed"] = "urlallowed"
 
 
-class URLBlockParcel(BaseURLParcel):
-    parcel_type: str = Field(default="urlblocked", validation_alias="type", serialization_alias="type")
+class URLBlockParcel(URLParcel):
+    model_config = ConfigDict(populate_by_name=True)
+    type: Literal["urlblocked"] = "urlblocked"

catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/url_filtering.py

@@ -0,0 +1,148 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+
+from pydantic import AliasPath, Field
+
+from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global
+from catalystwan.models.configuration.feature_profile.common import RefIdItem
+
+WebCategories = Literal[
+    "abortion",
+    "abused-drugs",
+    "adult-and-pornography",
+    "alcohol-and-tobacco",
+    "auctions",
+    "bot-nets",
+    "business-and-economy",
+    "cdns",
+    "cheating",
+    "computer-and-internet-info",
+    "computer-and-internet-security",
+    "confirmed-spam-sources",
+    "cult-and-occult",
+    "dating",
+    "dead-sites",
+    "dynamic-content",
+    "educational-institutions",
+    "entertainment-and-arts",
+    "fashion-and-beauty",
+    "financial-services",
+    "gambling",
+    "games",
+    "government",
+    "gross",
+    "hacking",
+    "hate-and-racism",
+    "health-and-medicine",
+    "home",
+    "hunting-and-fishing",
+    "illegal",
+    "image-and-video-search",
+    "individual-stock-advice-and-tools",
+    "internet-communications",
+    "internet-portals",
+    "job-search",
+    "keyloggers-and-monitoring",
+    "kids",
+    "legal",
+    "local-information",
+    "malware-sites",
+    "marijuana",
+    "military",
+    "motor-vehicles",
+    "music",
+    "news-and-media",
+    "nudity",
+    "online-greeting-cards",
+    "online-personal-storage",
+    "open-http-proxies",
+    "p2p",
+    "parked-sites",
+    "pay-to-surf",
+    "personal-sites-and-blogs",
+    "philosophy-and-political-advocacy",
+    "phishing-and-other-frauds",
+    "private-ip-addresses",
+    "proxy-avoid-and-anonymizers",
+    "questionable",
+    "real-estate",
+    "recreation-and-hobbies",
+    "reference-and-research",
+    "religion",
+    "search-engines",
+    "sex-education",
+    "shareware-and-freeware",
+    "shopping",
+    "social-network",
+    "society",
+    "spam-urls",
+    "sports",
+    "spyware-and-adware",
+    "streaming-media",
+    "swimsuits-and-intimate-apparel",
+    "training-and-tools",
+    "translation",
+    "travel",
+    "uncategorized",
+    "unconfirmed-spam-sources",
+    "violence",
+    "weapons",
+    "web-advertisements",
+    "web-based-email",
+    "web-hosting",
+]
+
+WebCategoriesAction = Literal["block", "allow"]
+WebReputation = Literal["high-risk", "low-risk", "moderate-risk", "suspicious", "trustworthy"]
+BlockPageAction = Literal["text", "redirect-url"]
+Alerts = Literal["blacklist", "whitelist", "categories-reputation"]
+
+
+class UrlFilteringParcel(_ParcelBase):
+    type_: Literal["unified/url-filtering"] = Field(default="unified/url-filtering", exclude=True)
+    web_categories_action: Global[WebCategoriesAction] = Field(
+        validation_alias=AliasPath("data", "webCategoriesAction")
+    )
+    web_categories: Global[List[WebCategories]] = Field(validation_alias=AliasPath("data", "webCategories"))
+    web_reputation: Global[WebReputation] = Field(validation_alias=AliasPath("data", "webReputation"))
+    url_allowed_list: Optional[RefIdItem] = Field(default=None, validation_alias=AliasPath("data", "urlAllowedList"))
+    url_blocked_list: Optional[RefIdItem] = Field(default=None, validation_alias=AliasPath("data", "urlBlockedList"))
+    block_page_action: Global[BlockPageAction] = Field(validation_alias=AliasPath("data", "blockPageAction"))
+    block_page_contents: Optional[Global[str]] = Field(
+        default=None, validation_alias=AliasPath("data", "blockPageContents")
+    )
+    redirect_url: Optional[Global[str]] = Field(default=None, validation_alias=AliasPath("data", "redirectUrl"))
+    enable_alerts: Global[bool] = Field(validation_alias=AliasPath("data", "enableAlerts"))
+    alerts: Optional[Global[List[Alerts]]] = Field(default=None, validation_alias=AliasPath("data", "alerts"))
+
+    @classmethod
+    def create(
+        cls,
+        parcel_name: str,
+        parcel_description: str,
+        web_categories_action: WebCategoriesAction,
+        web_categories: List[WebCategories],
+        web_reputation: WebReputation,
+        enable_alerts: bool,
+        block_page_action: BlockPageAction,
+        block_page_contents: str,
+        alerts: List[Alerts] = [],
+        url_allowed_list: Optional[RefIdItem] = None,
+        url_blocked_list: Optional[RefIdItem] = None,
+    ):
+        _alerts = Global[List[Alerts]](value=alerts) if alerts else None
+
+        return cls(
+            parcel_name=parcel_name,
+            parcel_description=parcel_description,
+            web_categories_action=as_global(web_categories_action, WebCategoriesAction),
+            web_categories=Global[List[WebCategories]](value=web_categories),
+            web_reputation=as_global(web_reputation, WebReputation),
+            block_page_action=as_global(block_page_action, BlockPageAction),
+            block_page_contents=as_global(block_page_contents),
+            enable_alerts=as_global(enable_alerts),
+            alerts=_alerts,
+            url_allowed_list=url_allowed_list,
+            url_blocked_list=url_blocked_list,
+        )

catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/zone.py

@@ -1,22 +1,16 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
-from typing import List, Optional
+from typing import List, Literal, Optional, Union
 
-from pydantic import AliasPath, BaseModel, Field, field_validator, model_validator
+from pydantic import AliasPath, ConfigDict, Field, model_validator
 
-from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global
-from catalystwan.models.common import InterfaceType, check_fields_exclusive
+from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, _ParcelEntry
+from catalystwan.models.common import InterfaceStr, check_fields_exclusive
 
 
-class SecurityZoneListEntry(BaseModel):
-    vpn: Optional[Global[str]] = Field(default=None, description="0-65530 single number")
-    interface: Optional[Global[InterfaceType]] = None
-
-    @field_validator("vpn")
-    @classmethod
-    def check_vpn_range(cls, vpn: Global[str]):
-        assert 0 <= int(vpn.value) <= 65530
-        return vpn
+class SecurityZoneListEntry(_ParcelEntry):
+    vpn: Optional[Global[str]] = Field(default=None)
+    interface: Optional[Global[InterfaceStr]] = Field(default=None)
 
     @model_validator(mode="after")
     def check_vpn_xor_interface(self):
@@ -25,18 +19,20 @@ class SecurityZoneListEntry(BaseModel):
 
 
 class SecurityZoneListParcel(_ParcelBase):
-    entries: List[SecurityZoneListEntry] = Field(default=[], validation_alias=AliasPath("data", "entries"))
+    model_config = ConfigDict(populate_by_name=True)
+    type_: Literal["security-zone"] = Field(default="security-zone", exclude=True)
+    entries: List[SecurityZoneListEntry] = Field(default_factory=list, validation_alias=AliasPath("data", "entries"))
 
-    def add_interface(self, interface: InterfaceType):
+    def add_interface(self, interface: InterfaceStr):
         self.entries.append(
             SecurityZoneListEntry(
-                interface=as_global(interface, InterfaceType),
+                interface=Global[InterfaceStr](value=interface),
             )
         )
 
-    def add_vpn(self, vpn: str):
+    def add_vpn(self, vpn: Union[str, int]):
         self.entries.append(
             SecurityZoneListEntry(
-                vpn=as_global(vpn, InterfaceType),
+                vpn=Global[str](value=str(vpn)),
             )
         )

catalystwan/models/configuration/feature_profile/sdwan/routing/__init__.py

@@ -0,0 +1,26 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+from typing import List, Union
+
+from pydantic import Field
+from typing_extensions import Annotated
+
+from .bgp import RoutingBgpParcel
+from .ospf import RoutingOspfParcel
+from .ospfv3 import RoutingOspfv3IPv4Parcel, RoutingOspfv3IPv6Parcel
+
+AnyRoutingParcel = Annotated[
+    Union[RoutingBgpParcel, RoutingOspfParcel, RoutingOspfv3IPv6Parcel, RoutingOspfv3IPv4Parcel],
+    Field(discriminator="type_"),
+]
+
+__all__ = [
+    "RoutingBgpParcel",
+    "RoutingOspfParcel",
+    "RoutingOspfv3IPv4Parcel",
+    "RoutingOspfv3IPv6Parcel",
+    "AnyRoutingParcel",
+]
+
+
+def __dir__() -> "List[str]":
+    return list(__all__)