Draft: read DNS cache as string

.gitignore

+.venv

dns_unbound_cache_reader/__init__.py

+from dns_unbound_cache_reader import read_unbound_cache

dns_unbound_cache_reader/dns_unbound_cache_reader.py

+import subprocess
+from fabric import Connection, Config
+
+
+## Global variables
+localhost = [
+    "localhost",
+    "127.0.0.1"
+]
+cmd = "unbound-control dump_cache"
+
+
+def read_unbound_cache(host: str = "127.0.0.1"):
+    """
+    Read the Unbound DNS cache and return it as a dictionary.
+
+    Args:
+        host (str): IP address of the Unbound DNS server. Default is localhost.
+    """
+    if host in localhost:
+
+        ## Unbound runs on localhost
+        proc = subprocess.run(cmd.split(), capture_output=True)
+        dns_cache = proc.stdout.decode().strip().split("\n")
+    
+
+    else:
+
+        ## Unbound runs on a remote host
+        
+        # SSH connection with remote host
+        ssh_config = Config(overrides={"run": {"hide": True}})
+        remote = Connection(host, config=ssh_config)
+        result = remote.run(cmd)
+        dns_cache = result.stdout.strip().split("\n")
+    
+
+    return dns_cache

pyproject.toml

+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "dns-unbound-cache-reader"
+version = "0.1.0"
+description = "Read DNS cache from unbound"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE"}
+keywords = ["network", "dns", "unbound"]
+authors = [
+  {name = "François De Keersmaeker", email = "francois.dekeersmaeker@uclouvain.be" }
+]
+maintainers = [
+  {name = "François De Keersmaeker", email = "francois.dekeersmaeker@uclouvain.be" }
+]
+
+# Classifiers help users find your project by categorizing it.
+#
+# For a list of valid classifiers, see https://pypi.org/classifiers/
+classifiers = [
+  # How mature is this project? Common values are
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 3 - Alpha",
+
+  # Pick your license as you wish
+  "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+
+  # Specify the Python versions you support here. In particular, ensure
+  # that you indicate you support Python 3. These classifiers are *not*
+  # checked by "pip install". See instead "requires-python" key in this file.
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3 :: Only",
+
+  "Operating System :: OS Independent"
+]
+
+# TODO: update dependencies
+dependencies = [
+    "fabric"
+]
+
+[project.urls]
+"Homepage" = "https://forge.uclouvain.be/smart-home-network-security/dns-unbound-cache-reader"
+"Source" = "https://forge.uclouvain.be/smart-home-network-security/dns-unbound-cache-reader"

test.py

+from dns_unbound_cache_reader import read_unbound_cache
+
+read_unbound_cache