mirror of
https://github.com/smkrv/ha-text-ai.git
synced 2026-07-21 22:54:00 +08:00
SMKRV
c45828953d
Replace Creative Commons Attribution-NonCommercial-ShareAlike 4.0 with PolyForm Noncommercial License 1.0.0 across all files: LICENSE, README badge/footer, and all Python module headers.
95 lines
3.1 KiB
Python
95 lines
3.1 KiB
Python
"""
|
|
Utility functions for HA Text AI integration.
|
|
|
|
@license: PolyForm Noncommercial 1.0.0 (https://polyformproject.org/licenses/noncommercial/1.0.0)
|
|
@author: SMKRV
|
|
@github: https://github.com/smkrv/ha-text-ai
|
|
@source: https://github.com/smkrv/ha-text-ai
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import ipaddress
|
|
import socket
|
|
from typing import Any
|
|
from urllib.parse import urlparse
|
|
|
|
from homeassistant.const import CONF_API_KEY
|
|
from homeassistant.core import HomeAssistant
|
|
|
|
|
|
def normalize_name(name: str) -> str:
|
|
"""Normalize name to conform to HA naming convention using underscores."""
|
|
normalized = ''.join(c if c.isalnum() or c == '_' else '_' for c in name)
|
|
normalized = '_'.join(filter(None, normalized.split('_')))
|
|
return normalized.lower()
|
|
|
|
|
|
def safe_log_data(
|
|
data: dict[str, Any],
|
|
sensitive_keys: tuple[str, ...] = (CONF_API_KEY,),
|
|
) -> dict[str, Any]:
|
|
"""Filter sensitive keys from data for safe logging."""
|
|
return {k: "***" if k in sensitive_keys else v for k, v in data.items()}
|
|
|
|
|
|
class _RestrictedIPError(ValueError):
|
|
"""Raised when an IP address is in a restricted range."""
|
|
|
|
|
|
def _check_ip_restricted(addr: ipaddress.IPv4Address | ipaddress.IPv6Address) -> bool:
|
|
"""Check if an IP address is in a restricted range."""
|
|
return (
|
|
addr.is_private
|
|
or addr.is_reserved
|
|
or addr.is_loopback
|
|
or addr.is_link_local
|
|
or addr.is_multicast
|
|
or addr.is_unspecified
|
|
)
|
|
|
|
|
|
async def validate_endpoint(hass: HomeAssistant, endpoint: str) -> str:
|
|
"""Validate API endpoint URL for security.
|
|
|
|
Ensures HTTPS-only and blocks private/reserved IP ranges (SSRF protection).
|
|
Uses async DNS resolution to avoid blocking the event loop.
|
|
Returns the validated endpoint stripped of trailing slashes.
|
|
|
|
Raises:
|
|
ValueError: If the endpoint fails validation.
|
|
"""
|
|
parsed = urlparse(endpoint)
|
|
|
|
if parsed.scheme not in ("https",):
|
|
raise ValueError("Only HTTPS endpoints are allowed")
|
|
|
|
hostname = parsed.hostname
|
|
if not hostname:
|
|
raise ValueError("Invalid endpoint URL: no hostname")
|
|
|
|
# Block private/reserved IPs (direct IP or resolved hostname)
|
|
try:
|
|
addr = ipaddress.ip_address(hostname)
|
|
if _check_ip_restricted(addr):
|
|
raise _RestrictedIPError("Private/reserved IP addresses are not allowed")
|
|
except _RestrictedIPError:
|
|
raise
|
|
except ValueError:
|
|
# Not an IP literal — resolve hostname and check all resolved IPs
|
|
# to prevent DNS rebinding attacks
|
|
try:
|
|
addrinfos = await hass.async_add_executor_job(
|
|
socket.getaddrinfo, hostname, None
|
|
)
|
|
for family, _type, _proto, _canonname, sockaddr in addrinfos:
|
|
ip_str = sockaddr[0]
|
|
resolved_addr = ipaddress.ip_address(ip_str)
|
|
if _check_ip_restricted(resolved_addr):
|
|
raise ValueError(
|
|
"Hostname resolves to a restricted IP range"
|
|
)
|
|
except socket.gaierror as err:
|
|
raise ValueError(f"Cannot resolve hostname: {hostname}") from err
|
|
|
|
return endpoint.rstrip("/")
|