Add support for network objects and profiles in UniFi integration (#97)

- Introduced new API endpoints and paths for managing network objects, port profiles, WLAN rate profiles, RADIUS profiles, and WAN SLA profiles.
- Added a service to sync remote curated groups from specified URLs, enhancing firewall group management.
- Updated the manifest version to 3.3.0 and required aiounifi version to 84.0.0.
- Implemented mixins for handling various profile types and added utility functions for fetching and parsing curated lists.

Author: sirkirby

custom_components/unifi_network_rules/const.py

@@ -137,6 +137,17 @@
 API_ENDPOINT_QOS_RULES_BATCH = "/proxy/network/v2/api/site/{site}/qos-rules/batch"
 API_ENDPOINT_NETWORK_CONF = "/proxy/network/api/s/{site}/rest/networkconf"
 API_ENDPOINT_NETWORK_CONF_DETAIL = "/proxy/network/api/s/{site}/rest/networkconf/{network_id}"
+# Objects and Profiles
+API_ENDPOINT_OBJECTS = "/proxy/network/v2/api/site/{site}/objects"
+API_ENDPOINT_OBJECT_DETAIL = "/proxy/network/v2/api/site/{site}/objects/{object_id}"
+API_ENDPOINT_PORT_PROFILES = "/proxy/network/api/s/{site}/rest/portconf"
+API_ENDPOINT_PORT_PROFILE_DETAIL = "/proxy/network/api/s/{site}/rest/portconf/{profile_id}"
+API_ENDPOINT_WLAN_RATE_PROFILES = "/proxy/network/v2/api/site/{site}/profiles/wlanrate"
+API_ENDPOINT_WLAN_RATE_PROFILE_DETAIL = "/proxy/network/v2/api/site/{site}/profiles/wlanrate/{profile_id}"
+API_ENDPOINT_RADIUS_PROFILES = "/proxy/network/api/s/{site}/rest/radiusprofile"
+API_ENDPOINT_RADIUS_PROFILE_DETAIL = "/proxy/network/api/s/{site}/rest/radiusprofile/{profile_id}"
+API_ENDPOINT_WAN_SLA_PROFILES = "/proxy/network/v2/api/site/{site}/profiles/wansla"
+API_ENDPOINT_WAN_SLA_PROFILE_DETAIL = "/proxy/network/v2/api/site/{site}/profiles/wansla/{profile_id}"
 
 # API Paths used for aiounifi API Requests
 API_PATH_FIREWALL_POLICIES = "/firewall-policies"
@@ -161,6 +172,17 @@
 API_PATH_QOS_RULES_BATCH_DELETE = "/qos-rules/batch-delete"
 API_PATH_NETWORK_CONF = "/rest/networkconf"
 API_PATH_NETWORK_CONF_DETAIL = "/rest/networkconf/{network_id}"
+# Objects and Profiles (aiounifi path fragments)
+API_PATH_PORT_PROFILES = "/rest/portconf"
+API_PATH_PORT_PROFILE_DETAIL = "/rest/portconf/{profile_id}"
+API_PATH_WLAN_RATE_PROFILES = "/profiles/wlanrate"
+API_PATH_WLAN_RATE_PROFILE_DETAIL = "/profiles/wlanrate/{profile_id}"
+API_PATH_RADIUS_PROFILES = "/rest/radiusprofile"
+API_PATH_RADIUS_PROFILE_DETAIL = "/rest/radiusprofile/{profile_id}"
+API_PATH_WAN_SLA_PROFILES = "/profiles/wansla"
+API_PATH_WAN_SLA_PROFILE_DETAIL = "/profiles/wansla/{profile_id}"
+API_PATH_FIREWALL_GROUPS = "/rest/firewallgroup"
+API_PATH_FIREWALL_GROUP_DETAIL = "/rest/firewallgroup/{group_id}"
 
 # Detection endpoints
 API_ENDPOINT_SDN_STATUS = "/proxy/network/api/s/{site}/stat/sdn"

custom_components/unifi_network_rules/manifest.json

@@ -12,8 +12,8 @@
     "quality_scale": "custom",
     "requirements": [
         "aiohttp",
-        "aiounifi>=82.0.0",
+        "aiounifi>=84.0.0",
         "orjson>=3.8.0"
     ],
-    "version": "3.2.0"
+    "version": "3.3.0"
 }

custom_components/unifi_network_rules/models/network_object.py

@@ -0,0 +1,63 @@
+"""Network Object models for UniFi Network Rules integration.
+
+Represents v2 Objects (addresses, address-groups, ports, etc.).
+"""
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any, Literal, Optional, TypedDict
+
+from aiounifi.models.api import ApiItem
+
+
+class TypedObjectMember(TypedDict):
+    type: Literal[
+        "ipv4-address",
+        "ipv6-address",
+        "ipv4-subnet",
+        "ipv6-subnet",
+        "port",
+    ]
+    value: str
+
+
+class TypedNetworkObject(TypedDict, total=False):
+    _id: str
+    name: str
+    description: str
+    type: Literal[
+        "address",
+        "address-group",
+        "ipv6-address-group",
+        "port-group",
+    ]
+    members: list[TypedObjectMember]
+    site_id: str
+
+
+"""Typed representation of an object-like firewall group."""
+
+
+class NetworkObject(ApiItem):
+    raw: TypedNetworkObject
+
+    @property
+    def id(self) -> str:
+        return self.raw.get("_id", "")
+
+    @property
+    def name(self) -> str:
+        return self.raw.get("name", "")
+
+    @property
+    def type(self) -> str:
+        return self.raw.get("type", "")
+
+    @property
+    def members(self) -> list[TypedObjectMember]:
+        return self.raw.get("members", [])
+
+    def to_dict(self) -> dict[str, Any]:
+        return dict(self.raw)
+
+

custom_components/unifi_network_rules/services.yaml

@@ -241,3 +241,25 @@ force_remove_stale:
 websocket_diagnostics:
   name: WebSocket Diagnostics
   description: Run diagnostics on the WebSocket connection and attempt to repair if needed
+
+sync_remote_curated:
+  name: Sync Remote Curated Groups
+  description: >-
+    Fetch curated list file(s) from public raw URLs and create/update firewall group(s).
+    Each file should follow the UNR Lists format (see docs at https://github.com/sirkirby/unr-lists).
+    Header lines start with '# key: value' (name, type, description), then one entry per line.
+  fields:
+    entry_id:
+      name: Entry ID
+      description: Optional specific configuration entry ID to target
+      required: false
+      selector:
+        text:
+    urls:
+      name: Curated list URLs
+      description: >-
+        One or more raw text URLs. Provide a list (YAML) or paste multiple lines here,
+        one URL per line. Example: https://raw.githubusercontent.com/sirkirby/unr-lists/main/dns-ipv4.txt
+      required: true
+      selector:
+        object:

custom_components/unifi_network_rules/services/constants.py

@@ -13,6 +13,7 @@
 SERVICE_WEBSOCKET_DIAGNOSTICS = "websocket_diagnostics"
 SERVICE_TOGGLE_RULE = "toggle_rule"
 SERVICE_REFRESH_DATA = "refresh_data"
+SERVICE_SYNC_REMOTE_CURATED = "sync_remote_curated"
 
 # Schema fields
 CONF_FILENAME = "filename"
@@ -25,6 +26,12 @@
 CONF_STATE = "state"
 CONF_RULE_ID = "rule_id"
 CONF_RULE_TYPE = "rule_type"
+CONF_OBJECT_SETS = "object_sets"
+CONF_GITHUB_CLONE_URL = "github_clone_url"
+CONF_GITHUB_REF = "ref"
+CONF_REMOTE_FILE = "file"
+CONF_REMOTE_FILES = "files"
+CONF_REMOTE_URLS = "urls"
 
 # Signal for entity cleanup
 SIGNAL_ENTITIES_CLEANUP = "unifi_network_rules_cleanup" 

custom_components/unifi_network_rules/services/system_services.py

@@ -5,17 +5,21 @@
 from typing import Any, Dict, List, Optional
 
 import voluptuous as vol
+import re
 
 from homeassistant.core import HomeAssistant, ServiceCall
 from homeassistant.helpers import config_validation as cv
 from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from ..const import DOMAIN, LOGGER
 from .constants import (
     SERVICE_REFRESH,
     SERVICE_REFRESH_DATA,
     SERVICE_WEBSOCKET_DIAGNOSTICS,
+    SERVICE_SYNC_REMOTE_CURATED,
 )
+from ..utils.remote_lists import parse_curated_text
 
 # Schema for refresh service
 REFRESH_DATA_SCHEMA = vol.Schema(
@@ -211,4 +215,76 @@ async def handle_websocket_diagnostics(call: ServiceCall) -> None:
 
     hass.services.async_register(
         DOMAIN, SERVICE_WEBSOCKET_DIAGNOSTICS, handle_websocket_diagnostics, schema=vol.Schema({})
-    ) 
+    )
+
+    # Remote curated file sync
+    async def handle_sync_remote_curated(call: ServiceCall) -> None:
+        entry_id = call.data.get("entry_id")
+        urls_input = call.data.get("urls")
+        url_list: list[str] = []
+        if isinstance(urls_input, list):
+            # Flatten any strings that might contain multiple URLs
+            for item in urls_input:
+                if isinstance(item, str):
+                    found = re.findall(r"https?://\S+", item)
+                    url_list.extend(found if found else [item])
+        elif isinstance(urls_input, str):
+            # Extract all http(s) URLs from the string (handles spaces, newlines)
+            url_list = re.findall(r"https?://\S+", urls_input)
+        if not url_list:
+            raise HomeAssistantError("'urls' must contain at least one valid http(s) URL")
+
+        targets = (
+            {entry_id: coordinators.get(entry_id)} if entry_id and entry_id in coordinators else coordinators
+        )
+        for _entry, coord in targets.items():
+            if not coord:
+                continue
+            api = getattr(coord, "api", None) or getattr(coord, "_api", None)
+            if not api:
+                continue
+            for raw_url in url_list:
+                try:
+                    session = async_get_clientsession(hass)
+                    async with session.get(raw_url) as resp:
+                        if resp.status != 200:
+                            raise HomeAssistantError(f"Failed to fetch remote list '{raw_url}': {resp.status} {await resp.text()}")
+                        content = await resp.text()
+
+                    payload = parse_curated_text(content)
+                    # Enforce type-specific members
+                    obj_type = payload.get("type", "address-group")
+                    if obj_type == "port-group":
+                        filtered = [m for m in payload.get("members", []) if m.get("type") == "port"]
+                    elif obj_type == "ipv6-address-group":
+                        filtered = [m for m in payload.get("members", []) if m.get("type", "").startswith("ipv6")]
+                    else:
+                        filtered = [m for m in payload.get("members", []) if m.get("type", "").startswith("ipv4")]
+                    payload = {**payload, "members": filtered}
+
+                    existing = await api.get_objects()
+                    existing_by_name = {o.name: o for o in existing}
+                    name = payload.get("name")
+                    if name in existing_by_name:
+                        obj = existing_by_name[name]
+                        to_update = obj.to_dict()
+                        to_update.update({
+                            "description": payload.get("description", to_update.get("description")),
+                            "type": obj_type,
+                            "members": payload.get("members", to_update.get("members", [])),
+                        })
+                        await api.update_object(to_update)
+                    else:
+                        await api.add_object(payload)
+                except Exception as err:
+                    LOGGER.error("Remote curated sync failed for '%s': %s", raw_url, err)
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_SYNC_REMOTE_CURATED,
+        handle_sync_remote_curated,
+        schema=vol.Schema({
+            vol.Optional("entry_id"): cv.string,
+            vol.Required("urls"): vol.Any(cv.ensure_list(cv.string), cv.string),
+        }),
+    )

custom_components/unifi_network_rules/udm/api.py

@@ -16,11 +16,18 @@
 from .network import NetworkMixin
 from .qos import QoSMixin
 from .vpn import VPNMixin
+from .objects import ObjectsMixin
+from .profiles import PortProfilesMixin, WlanRateProfilesMixin, RadiusProfilesMixin, WanSlaProfilesMixin
 
 from ..const import LOGGER
 from ..queue import ApiOperationQueue
 
 class UDMAPI(
+    ObjectsMixin,
+    PortProfilesMixin,
+    WlanRateProfilesMixin,
+    RadiusProfilesMixin,
+    WanSlaProfilesMixin,
     NetworkMixin,
     RoutesMixin,
     PortForwardMixin,