Added Gandi support to ddclient native backend. (#4066)

* Added Gandi support to ddclient native backend. * bump date to 2024, cosmetic simplification to logic * allow to be sorted alphabetically --------- Co-authored-by: Jonathan Grande <jonathan@grande.live>
2026-05-22 18:44:07 -07:00 · 2024-06-30 11:39:45 -06:00
parent f1d5434657
commit 978e4a982d
1 changed files with 81 additions and 0 deletions
@@ -0,0 +1,81 @@
+"""
+    Copyright (c) 2024 Thomas Cekal <thomas@cekal.org>
+    Copyright (c) 2024 Ad Schellevis <ad@opnsense.org>
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+"""
+import json
+import syslog
+import requests
+from . import BaseAccount
+
+
+class Gandi(BaseAccount):
+    _services = {
+        'gandi': 'api.gandi.net'
+    }
+
+    def __init__(self, account: dict):
+        super().__init__(account)
+
+    @staticmethod
+    def known_services():
+        return  Gandi._services.keys()
+
+    @staticmethod
+    def match(account):
+        return account.get('service') in Gandi._services
+
+    def execute(self):
+        if super().execute():
+            # IPv4/IPv6
+            recordType = "AAAA" if str(self.current_address).find(':') > 1 else "A"
+
+            # Use bearer (api key) authentication
+            url = "https://api.gandi.net/v5/livedns/domains/" + self.settings.get('zone') + "/records/" + self.settings.get('hostnames') + "/" + recordType
+            payload = "{\"rrset_values\":[\"" + self.current_address + "\"],\"rrset_ttl\":300}"
+            headers = {
+                'authorization': "Bearer " + self.settings.get('password'),
+                'content-type': "application/json",
+                'User-Agent': 'OPNsense-dyndns'
+            }
+            # Send IP address update
+            req = requests.request("PUT", url, data=payload, headers=headers)
+            if 200 <= req.status_code < 300:
+                if self.is_verbose:
+                    syslog.syslog(
+                        syslog.LOG_NOTICE,
+                        "Account %s set new ip %s [%s]" % (self.description, self.current_address, req.text.strip())
+                    )
+
+                self.update_state(address=self.current_address, status=req.text.split()[0] if req.text else '')
+                return True
+            else:
+                syslog.syslog(
+                    syslog.LOG_ERR,
+                    "Account %s failed to set new ip %s [%d - %s]" % (
+                        self.description, self.current_address, req.status_code, req.text.replace('\n', '')
+                    )
+                )
+
+        return False