Source code for illumio.secpolicy

# -*- coding: utf-8 -*-

"""This module provides classes for security policy provisioning.

Copyright:
    © 2022 Illumio

License:
    Apache2, see LICENSE for more details.
"""
import re
from dataclasses import dataclass
from typing import List

from .exceptions import IllumioException
from .util import (
    JsonObject,
    Reference,
    MutableObject,
    ImmutableObject,
    HREF_REGEX,
    pce_api
)
from .policyobjects import LabelSet




@dataclass
@pce_api('firewall_settings', is_sec_policy=True)
class FirewallSetting(MutableObject):
    """Represents firewall settings in the PCE.

    Firewall settings are singleton objects under security policy.
    They support GET and PUT only (no create/delete).
    """
    allow_dhcp_client: bool = None
    log_dropped_multicast: bool = None
    log_dropped_broadcast: bool = None
    allow_traceroute: bool = None
    allow_ipv6: bool = None
    ipv6_mode: str = None
    network_detection_mode: str = None
    ike_authentication_type: str = None
    static_policy_scopes: List[LabelSet] = None
    firewall_coexistence: List[LabelSet] = None
    containers_inherit_host_policy_scopes: List[LabelSet] = None
    blocked_connection_reject_scopes: List[LabelSet] = None
    loopback_interfaces_in_policy_scopes: List[LabelSet] = None



@dataclass
class PolicyChangeset(JsonObject):
    label_groups: List[Reference] = None
    services: List[Reference] = None
    rule_sets: List[Reference] = None
    ip_lists: List[Reference] = None
    virtual_services: List[Reference] = None
    firewall_settings: List[Reference] = None
    enforcement_boundaries: List[Reference] = None
    secure_connect_gateways: List[Reference] = None
    virtual_servers: List[Reference] = None

    @staticmethod
    def build(hrefs: List[str]):
        changeset = PolicyChangeset()
        for href in hrefs:
            match = re.match(HREF_REGEX, href)
            if match:
                object_type = match.group('type')
                arr = getattr(changeset, object_type) or []
                arr.append(Reference(href=href))
                setattr(changeset, object_type, arr)
            else:
                raise IllumioException('Invalid HREF in policy provision changeset: {}'.format(href))
        return changeset


@dataclass
class PolicyObjectCounts(JsonObject):
    label_groups: int = None
    services: int = None
    rule_sets: int = None
    ip_lists: int = None
    virtual_services: int = None
    firewall_settings: int = None
    enforcement_boundaries: int = None
    secure_connect_gateways: int = None
    virtual_servers: int = None


@dataclass
class PolicyVersion(ImmutableObject):
    commit_message: str = None
    version: int = None
    workloads_affected: int = None
    object_counts: PolicyObjectCounts = None




@dataclass
class PolicyDependency(JsonObject):
    """Represents a dependency between security policy objects."""
    href: str = None
    type: str = None
    name: str = None
    dependent_type: str = None
    dependent_href: str = None
    dependent_name: str = None





@dataclass
class PolicyCheck(JsonObject):
    """Represents the result of a policy check."""
    status: str = None
    errors: List[dict] = None
    warnings: List[dict] = None





@dataclass
class ModifiedObject(JsonObject):
    """Represents a modified policy object pending provisioning."""
    href: str = None
    token: str = None
    name: str = None
    change_type: str = None



__all__ = [
    'FirewallSetting',
    'PolicyVersion',
    'PolicyObjectCounts',
    'PolicyChangeset',
    'PolicyDependency',
    'PolicyCheck',
    'ModifiedObject',
]