udyndns 0.0.1__tar.gz

udyndns-0.0.1/LICENSE

@@ -0,0 +1,13 @@
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

udyndns-0.0.1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: udyndns
+Version: 0.0.1
+Summary: A very simple OVH dyndns client to workaround difficulties with Ubiquity unadyn...
+Home-page: https://github.com/KurisuD/udyndns
+Author: KurisuD
+Author-email: KurisuD@pypi.darnand.net
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: Public Domain
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Internet :: Name Service (DNS)
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiounifi
+Requires-Dist: pap_logger

udyndns-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

udyndns-0.0.1/setup.py

@@ -0,0 +1,28 @@
+# coding=utf-8
+import setuptools
+
+from udyndns.version import __version__
+
+with open("README.md") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="udyndns",
+    version=__version__,
+    author="KurisuD",
+    author_email="KurisuD@pypi.darnand.net",
+    description="A very simple OVH dyndns client to workaround difficulties with Ubiquity unadyn...",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/KurisuD/udyndns",
+    packages=setuptools.find_packages(),
+    install_requires=['aiounifi', 'pap_logger'],
+    classifiers=[
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.10",
+        "License :: Public Domain",
+        "Operating System :: POSIX :: Linux",
+        "Topic :: Home Automation",
+        "Topic :: Internet :: Name Service (DNS)"
+    ],
+)

udyndns-0.0.1/udyndns/__init__.py

@@ -0,0 +1,110 @@
+import asyncio
+import logging
+from typing import Optional
+
+import aiounifi
+import requests
+from aiohttp import ClientSession
+from aiounifi.controller import Controller
+from aiounifi.models.configuration import Configuration
+from requests.auth import HTTPBasicAuth
+
+
+async def get_wan_ip(host: str, port: int, username: str, password: str, timeout: int = 10) -> [Optional[str]]:
+    """
+    obtains the WAN IP address of the unifi gateway
+
+    :param host: hostname or ip address of your unifi gateway / dream machine / ...
+    :param port: port to your unifi gateway / dream machine / ...
+    :param username: username to authenticate on your unifi device.
+    :param password: password to authenticate on your unifi device.
+    :param timeout: number of seconds to wait for your unifi device to respond.
+    :return: the WAN IP address of the unifi gateway / dream machine / ...
+    :type host: str
+    :type port: int
+    :type username: str
+    :type password: str
+    :type timeout: int
+    :rtype: str | None
+
+    """
+    async with ClientSession() as _session:
+        _config = Configuration(session=_session, host=host, username=username, port=port, password=password)
+        api = Controller(config=_config)
+        try:
+            async with asyncio.timeout(10):
+                await api.login()
+        except aiounifi.Unauthorized as err:
+            logging.warning(f"Connected to {host}:{port} but user {username} is not registered: {err}")
+
+        except (
+                TimeoutError,
+                aiounifi.BadGateway,
+                aiounifi.Forbidden,
+                aiounifi.ServiceUnavailable,
+                aiounifi.RequestError,
+                aiounifi.ResponseError,
+        ) as err:
+            logging.error(f"Error connecting to the UniFi Network at {host}:{port}: {err}")
+            return None
+        _proxy_network_str = "/proxy/network" if api.connectivity.is_unifi_os else ""
+        health_data = await _session.get(
+            f"https://{host}:{port}{_proxy_network_str}/api/s/default/stat/health",
+            headers={"Accept": "application/json",
+                     "Content-Type": "application/json"},
+            timeout=timeout,
+            ssl=_config.ssl_context
+        )
+        health = await health_data.json()
+        wan_ip = [subsystem for subsystem in health['data'] if subsystem["subsystem"] == "wan"][0]["wan_ip"]
+        logging.info(f"WAN IP for {host}:{port}: {wan_ip}")
+        return wan_ip
+
+
+def update_ovh_dyn_dns(fqdn: str, ip: str, username: str, password: str) -> bool:
+    """
+    Updates the OVH Dyndns's registered wan ip address for your domain, if necessary.
+    :param fqdn: The fully qualified domain name to be updated.
+    :param ip: the wan ip address to be used for the update.
+    :param username: your ovh dyndns username for updating this fqdn.
+    :param password: your ovh dyndns password for updating this fqdn.
+    :return: True on success, False otherwise.
+    :type fqdn: str
+    :type ip: str
+    :type username: str
+    :type password: str
+    :rtype: bool
+    """
+    logging.info(f"Checking dynamic DNS for {fqdn}")
+    session = requests.Session()
+    session.auth = HTTPBasicAuth(username=username, password=password)
+    current_ip_url = f"https://www.ovh.com/nic/update?system=dyndns&hostname={fqdn}"
+    current_ip_resp = session.get(current_ip_url)
+    if current_ip_resp.ok:
+        logging.info(current_ip_resp.status_code)
+        logging.info(current_ip_resp.text)
+        current = current_ip_resp.text.split(" ")[1].strip()
+        if current != ip:
+            logging.info(f"Need to update IP from '{current}' to '{ip}'")
+            new_ip_url = f"{current_ip_url}&myip={ip}"
+            logging.info(new_ip_url)
+            new_ip_resp = session.get(new_ip_url)
+            if new_ip_resp.ok:
+                logging.info(f"New IP results: {new_ip_resp.text}")
+                return True
+            else:
+                logging.warning(new_ip_resp.status_code)
+                logging.warning(new_ip_resp.reason)
+                return False
+        else:
+            logging.info(f"Our unifi API retrieved IP {ip} is the same as our current IP: {current}")
+            return True
+    else:
+        logging.error(f"Unable to authenticate to the {current_ip_url}")
+        logging.error(current_ip_resp.status_code)
+        logging.error(current_ip_resp.reason)
+        logging.error(current_ip_resp.text)
+        return False
+
+
+__all__ = ["get_wan_ip", "update_ovh_dyn_dns"]

udyndns-0.0.1/udyndns/__main__.py

@@ -0,0 +1,35 @@
+import asyncio
+import json
+import logging
+import sys
+from pathlib import Path
+
+from __init__ import get_wan_ip, update_ovh_dyn_dns
+
+
+def main():
+    """
+    Updates OVH dyndns based on the WAN IP retrieved from the unifi API since unadyn is so stubbornly unable to do so.
+    """
+    udyndns_config_file = Path("~").expanduser() / ".udyndns.json"
+    if not udyndns_config_file.exists():
+        raise FileNotFoundError(f"{udyndns_config_file} not found")
+    for fqdn, config in json.loads(udyndns_config_file.read_text()).items():
+        unifi_config = config["unifi"]
+        wan_ip = asyncio.run(get_wan_ip(**unifi_config))
+        if wan_ip:
+            ovh_config = config["ovh"]
+            ovh_config.update({"fqdn": fqdn, "ip": wan_ip})
+            logging.info(f"Will check and update {fqdn} with {wan_ip} if necessary")
+            update_ovh_dyn_dns(**ovh_config)
+
+
+if __name__ == '__main__':
+    from pap_logger import PaPLogger
+
+    p = PaPLogger(level=logging.INFO)
+    try:
+        main()
+    except Exception as e:
+        logging.error(f"Sorry, we could not proceed: {e}")
+        sys.exit(1)

udyndns-0.0.1/udyndns/version.py

@@ -0,0 +1 @@
+__version__ = '0.0.1'

udyndns-0.0.1/udyndns.egg-info/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: udyndns
+Version: 0.0.1
+Summary: A very simple OVH dyndns client to workaround difficulties with Ubiquity unadyn...
+Home-page: https://github.com/KurisuD/udyndns
+Author: KurisuD
+Author-email: KurisuD@pypi.darnand.net
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: Public Domain
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Internet :: Name Service (DNS)
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiounifi
+Requires-Dist: pap_logger

udyndns-0.0.1/udyndns.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.py
+udyndns/__init__.py
+udyndns/__main__.py
+udyndns/version.py
+udyndns.egg-info/PKG-INFO
+udyndns.egg-info/SOURCES.txt
+udyndns.egg-info/dependency_links.txt
+udyndns.egg-info/requires.txt
+udyndns.egg-info/top_level.txt

udyndns-0.0.1/udyndns.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

udyndns-0.0.1/udyndns.egg-info/requires.txt

@@ -0,0 +1,2 @@
+aiounifi
+pap_logger

udyndns-0.0.1/udyndns.egg-info/top_level.txt

@@ -0,0 +1 @@
+udyndns