pdnsbackup 0.0.2__tar.gz

pdnsbackup-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Denis Machard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pdnsbackup-0.0.2/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: pdnsbackup
+Version: 0.0.2
+Summary: Backup tool for PowerDNS database
+Home-page: https://github.com/dmachard/python-pdnsbackup
+Author: Denis MACHARD
+Author-email: d.machard@gmail.com
+Keywords: powerdns pdns database backup
+Platform: any
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiomysql
+Requires-Dist: dnspython
+
+# What is this?
+
+Backup tool for PowerDNS database.
+
+## Docker run
+
+```bash
+sudo docker run -d --env-file ./.env --name=pdnsbackup dmachard/pdnsbackup:latest
+```
+
+## Environment variables
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_DEBUG | debug mode 1 or 0 |
+| PDNSBACKUP_INTERVAL | delay between backup, default is 3600s |
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_GMYSQL_ENABLED | enable gmysql backend, default is 1 |
+| PDNSBACKUP_GMYSQL_HOST | mysql port, default is 127.0.0.1 |
+| PDNSBACKUP_GMYSQL_PORT | mysql port, default is 3306 |
+| PDNSBACKUP_GMYSQL_SSL | enable ssl, default is 0 |
+| PDNSBACKUP_GMYSQL_DBNAME | mysql database name |
+| PDNSBACKUP_GMYSQL_USER | mysql user |
+| PDNSBACKUP_GMYSQL_PASSWORD | mysql password  |
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_FILE_ENABLED | enable backup to file, defaut is 1 |
+| PDNSBACKUP_FILE_PATH_BIND | zone bind path  |
+| PDNSBACKUP_FILE_PATH_OUTPUT | output folder |
+
+## Run from source
+
+Create a `.env` file to populate your variable
+
+Create a virtualenv
+
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+
+Install requirements and run-it
+
+```bash
+python3 -m pip install -r requirements.txt
+python3 -c "import pdnsbackup; pdnsbackup.start_backup();"
+```
+
+## Build and run from docker image
+
+```bash
+sudo docker build . --file Dockerfile -t pdnsbackup
+```

pdnsbackup-0.0.2/README.md

@@ -0,0 +1,56 @@
+# What is this?
+
+Backup tool for PowerDNS database.
+
+## Docker run
+
+```bash
+sudo docker run -d --env-file ./.env --name=pdnsbackup dmachard/pdnsbackup:latest
+```
+
+## Environment variables
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_DEBUG | debug mode 1 or 0 |
+| PDNSBACKUP_INTERVAL | delay between backup, default is 3600s |
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_GMYSQL_ENABLED | enable gmysql backend, default is 1 |
+| PDNSBACKUP_GMYSQL_HOST | mysql port, default is 127.0.0.1 |
+| PDNSBACKUP_GMYSQL_PORT | mysql port, default is 3306 |
+| PDNSBACKUP_GMYSQL_SSL | enable ssl, default is 0 |
+| PDNSBACKUP_GMYSQL_DBNAME | mysql database name |
+| PDNSBACKUP_GMYSQL_USER | mysql user |
+| PDNSBACKUP_GMYSQL_PASSWORD | mysql password  |
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_FILE_ENABLED | enable backup to file, defaut is 1 |
+| PDNSBACKUP_FILE_PATH_BIND | zone bind path  |
+| PDNSBACKUP_FILE_PATH_OUTPUT | output folder |
+
+## Run from source
+
+Create a `.env` file to populate your variable
+
+Create a virtualenv
+
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+
+Install requirements and run-it
+
+```bash
+python3 -m pip install -r requirements.txt
+python3 -c "import pdnsbackup; pdnsbackup.start_backup();"
+```
+
+## Build and run from docker image
+
+```bash
+sudo docker build . --file Dockerfile -t pdnsbackup
+```

pdnsbackup-0.0.2/pdnsbackup/__init__.py

@@ -0,0 +1 @@
+from pdnsbackup.backup import start_backup

pdnsbackup-0.0.2/pdnsbackup/backup.py

@@ -0,0 +1,231 @@
+import logging
+import sys
+import os
+import asyncio
+import aiomysql
+import dns
+import dns.zone
+import signal
+
+from pathlib import Path
+from dotenv import load_dotenv
+
+from pdnsbackup import webapi
+
+loop = asyncio.get_event_loop()
+
+logger = logging.getLogger("pdnsbackup")
+
+default_named = """zone "%s" {
+   file "%sdb.%s";
+   type master;
+};"""
+
+shutdown_task = None
+
+def start_shutdown_task(signal, loop, start_shutdown):
+    global shutdown_task
+    if not shutdown_task:
+        shutdown_task = asyncio.create_task(shutdown(signal, loop, start_shutdown))
+
+async def shutdown(signal, loop, start_shutdown):
+    """perform graceful shutdown"""
+    logger.info("stopping program...")
+    start_shutdown.set()
+
+    current_task = asyncio.current_task()
+    tasks = [
+        task for task in asyncio.all_tasks()
+        if task is not current_task
+    ]
+
+    for task in tasks:
+        task.cancel()
+
+    # close the loop
+    loop.stop()
+    
+def setup_logger(debug):
+    loglevel = logging.DEBUG if debug else logging.INFO
+    logfmt = '%(asctime)s %(levelname)s %(message)s'
+    
+    logger.setLevel(loglevel)
+    logger.propagate = False
+    
+    lh = logging.StreamHandler(stream=sys.stdout )
+    lh.setLevel(loglevel)
+    lh.setFormatter(logging.Formatter(logfmt))    
+    
+    logger.addHandler(lh)
+
+def setup_config(args):
+    pass
+
+async def backup(cfg, start_shutdown):
+    """backup"""
+    while not start_shutdown.is_set():
+        conn = None
+        cursor = None
+        domains = []
+        records = []
+        zones_dns = []
+
+        # first step, fetch all data
+        logger.info("connecting to powerdns...")
+        try:
+            if cfg["gmysql_enable"]:
+                logger.debug("fetching data with gmysql backend")
+                conn = await aiomysql.connect( host=cfg['gmysql_host'], port=int(cfg['gmysql_port']),
+                                               user=cfg['gmysql_user'], password=cfg['gmysql_password'], 
+                                               db=cfg['gmysql_dbname'], loop=loop )
+                logger.debug("succesfully connected to database")
+
+                # fetch all domains
+                cursor = await conn.cursor()
+                await cursor.execute("SELECT id,name FROM domains;")
+                rows = await cursor.fetchall()
+                domains = list(rows)
+
+                # fetch all records
+                await cursor.execute("SELECT domain_id, name, type, content, ttl FROM records")
+                rows = await cursor.fetchall()
+                records = list(rows)
+
+                logger.debug("%s domains and %s records retrieved..." % (len(domains),len(records)))
+        except Exception as e:
+            logger.error("fetcher - %s" % e)
+        finally:
+            await cursor.close()
+            conn.close()
+            logger.debug("database connection closed")
+
+        # second step, convert data to dns.zone
+        
+        for zone_id, zone_name in domains:
+            try:
+                soa_record = []
+                for domain_id, rr_name, rr_type, rr_data, rr_ttl in records:
+                    if domain_id == zone_id and rr_type in ["SOA", "NS"]:
+                        soa_record.append( (rr_name, rr_type, rr_data, rr_ttl) )
+
+                # init zone
+                zone_dns = dns.zone.Zone(".")
+                for rr_name, rr_type, rr_data, rr_ttl in soa_record:
+                    rrtype = dns.rdatatype.from_text(rr_type)
+                    rr = zone_dns.get_rdataset(rr_name, rrtype, create=True)
+                    rr.ttl = rr_ttl
+                    rr.add(dns.rdata.from_text(dns.rdataclass.IN, rrtype, rr_data))
+
+                # add records
+                for domain_id, rr_name, rr_type, rr_data, rr_ttl in records:
+                    if domain_id == zone_id and rr_type not in ["SOA", "NS"]:
+                        rrtype = dns.rdatatype.from_text(rr_type)
+                        rr = zone_dns.get_rdataset(rr_name, rrtype, create=True)
+                        rr.ttl = rr_ttl
+                        rr.add(dns.rdata.from_text(dns.rdataclass.IN, rrtype, rr_data))
+                
+                # append the zone
+                zones_dns.append( (zone_name, zone_dns))
+            except Exception as e:
+                logger.error("convert - %s" % e)
+
+        # third step, export zones
+        logger.info("%s zones to export..." % len(zones_dns))
+        try:
+            # export to file
+            if cfg["file_enable"]:
+                namedconf = []
+                for zname, zdns in zones_dns:
+                    filename = f"{cfg['file_path_output']}/db.{zname}"
+                    with open(filename, "w") as zone_file:
+                        zone_file.write(zdns.to_text())
+                    logger.debug(f">> file {filename} created")
+
+                    namedconf.append( default_named % (zname, cfg["file_path_bind"], zname) )
+
+                with open(f"{cfg['file_path_output']}/named.conf", "w") as bind_file:
+                    bind_file.write( "\n\n".join(namedconf) )
+                logger.info(f"bind configuration created")
+
+        except Exception as e:
+            logger.error("export - %s" % e)
+
+        logger.debug("sleeping for %s seconds" % cfg["interval"])
+        await asyncio.sleep(cfg["interval"])
+
+def start_backup(cfg=None):
+    debug = False
+    # load env from file
+    load_dotenv()
+
+    appcfg = {}
+    appcfg["interval"] = 3600
+
+    appcfg["web_listen_ip"] = "127.0.0.1"
+    appcfg["web_listen_port"] = "8080"
+
+    appcfg["gmysql_enable"] = True
+    appcfg["gmysql_host"] = "127.0.0.1"
+    appcfg["gmysql_port"] = "3306"
+    appcfg["gmysql_ssl"] = False 
+    appcfg["gmysql_dbname"] = "pdns"
+    appcfg["gmysql_user"] = "pdns"
+    appcfg["gmysql_password"] = "pdns"
+
+    appcfg["file_enable"] = True 
+    appcfg["file_path_bind"] = "/var/lib/powerdns/"
+    appcfg["file_path_output"] = "/tmp/"
+
+    if cfg is not None: appcfg=cfg
+
+    # read environment variables
+    debug_env = os.getenv('PDNSBACKUP_DEBUG')
+    if debug_env is not None:
+        debug = bool( int(debug_env) )
+
+    # enable logger
+    setup_logger(debug=debug)
+
+    logger.debug("read env variables")
+
+    delay_env = os.getenv('PDNSBACKUP_INTERVAL')
+    if delay_env is not None:
+        appcfg["interval"] = int(delay_env)
+    
+    gmysql_enable_env = os.getenv('PDNSBACKUP_GMYSQL_ENABLED')
+    if gmysql_enable_env is not None:
+        appcfg["gmysql_enable"] = int(gmysql_enable_env)
+
+    appcfg["gmysql_host"] = os.getenv('PDNSBACKUP_GMYSQL_HOST')
+    appcfg["gmysql_port"] = os.getenv('PDNSBACKUP_GMYSQL_PORT')
+
+    gmysql_ssl_env = os.getenv('PDNSBACKUP_GMYSQL_SSL')
+    if gmysql_ssl_env is not None:
+        appcfg["gmysql_ssl"] = int(gmysql_ssl_env)
+
+    appcfg["gmysql_dbname"] = os.getenv('PDNSBACKUP_GMYSQL_DBNAME')
+    appcfg["gmysql_user"] = os.getenv('PDNSBACKUP_GMYSQL_USER')
+    appcfg["gmysql_password"] = os.getenv('PDNSBACKUP_GMYSQL_PASSWORD')
+    
+
+    file_enable_env = os.getenv('PDNSBACKUP_FILE_ENABLED')
+    if file_enable_env is not None:
+        appcfg["file_enable"] = int(file_enable_env)
+    appcfg["file_path_bind"] = os.getenv('PDNSBACKUP_FILE_PATH_BIND')
+    appcfg["file_path_output"] = os.getenv('PDNSBACKUP_FILE_PATH_OUTPUT')
+
+
+    # prepare shutdown handling
+    start_shutdown = asyncio.Event()
+    for sig in (signal.SIGHUP, signal.SIGTERM, signal.SIGINT):
+        loop.add_signal_handler(sig, lambda: start_shutdown_task(sig, loop, start_shutdown))
+
+    loop.create_task(backup(appcfg, start_shutdown))
+
+    api = webapi.setup(loop, cfg=appcfg)
+    if api is None: return
+    loop.create_task(api)
+
+    # Run the event loop, block until close is called
+    loop.run_forever()
+    logger.info("program terminated")

pdnsbackup-0.0.2/pdnsbackup/webapi.py

@@ -0,0 +1,25 @@
+import logging
+import aiohttp
+import aiohttp.web
+
+logger = logging.getLogger("pdnsbackup")
+
+# init web router
+router = aiohttp.web.RouteTableDef()
+
+async def setup(loop, cfg):
+    """setup the web api"""
+    # init the web application
+    app = aiohttp.web.Application()
+    app.add_routes(router)
+    app["cfg"] = cfg
+
+    # run api server
+    listen_address = (cfg["web_listen_ip"], cfg["web_listen_port"])
+    try:
+        srv = await loop.create_server(app.make_handler(access_log=None), *listen_address)
+    except OSError as e:
+        logger.error( "webapi: %s" % e)
+        return None
+    logger.debug("webapi: listening on %s:%s" % listen_address )
+    return srv

pdnsbackup-0.0.2/pdnsbackup.egg-info/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: pdnsbackup
+Version: 0.0.2
+Summary: Backup tool for PowerDNS database
+Home-page: https://github.com/dmachard/python-pdnsbackup
+Author: Denis MACHARD
+Author-email: d.machard@gmail.com
+Keywords: powerdns pdns database backup
+Platform: any
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiomysql
+Requires-Dist: dnspython
+
+# What is this?
+
+Backup tool for PowerDNS database.
+
+## Docker run
+
+```bash
+sudo docker run -d --env-file ./.env --name=pdnsbackup dmachard/pdnsbackup:latest
+```
+
+## Environment variables
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_DEBUG | debug mode 1 or 0 |
+| PDNSBACKUP_INTERVAL | delay between backup, default is 3600s |
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_GMYSQL_ENABLED | enable gmysql backend, default is 1 |
+| PDNSBACKUP_GMYSQL_HOST | mysql port, default is 127.0.0.1 |
+| PDNSBACKUP_GMYSQL_PORT | mysql port, default is 3306 |
+| PDNSBACKUP_GMYSQL_SSL | enable ssl, default is 0 |
+| PDNSBACKUP_GMYSQL_DBNAME | mysql database name |
+| PDNSBACKUP_GMYSQL_USER | mysql user |
+| PDNSBACKUP_GMYSQL_PASSWORD | mysql password  |
+
+| Variables | Description |
+| ------------- | ------------- |
+| PDNSBACKUP_FILE_ENABLED | enable backup to file, defaut is 1 |
+| PDNSBACKUP_FILE_PATH_BIND | zone bind path  |
+| PDNSBACKUP_FILE_PATH_OUTPUT | output folder |
+
+## Run from source
+
+Create a `.env` file to populate your variable
+
+Create a virtualenv
+
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+
+Install requirements and run-it
+
+```bash
+python3 -m pip install -r requirements.txt
+python3 -c "import pdnsbackup; pdnsbackup.start_backup();"
+```
+
+## Build and run from docker image
+
+```bash
+sudo docker build . --file Dockerfile -t pdnsbackup
+```

pdnsbackup-0.0.2/pdnsbackup.egg-info/SOURCES.txt

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

pdnsbackup-0.0.2/pdnsbackup.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pdnsbackup-0.0.2/pdnsbackup.egg-info/requires.txt

@@ -0,0 +1,2 @@
+aiomysql
+dnspython

pdnsbackup-0.0.2/pdnsbackup.egg-info/top_level.txt

@@ -0,0 +1 @@
+pdnsbackup

pdnsbackup-0.0.2/setup.cfg

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

pdnsbackup-0.0.2/setup.py

@@ -0,0 +1,33 @@
+#!/usr/bin/python
+
+import setuptools
+  
+with open("README.md", "r") as fh:
+    LONG_DESCRIPTION = fh.read()
+    
+KEYWORDS = ('powerdns pdns database backup')
+
+setuptools.setup(
+    name="pdnsbackup",
+    version="0.0.2",
+    author="Denis MACHARD",
+    author_email="d.machard@gmail.com",
+    description="Backup tool for PowerDNS database",
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type="text/markdown",
+    url="https://github.com/dmachard/python-pdnsbackup",
+    packages=['pdnsbackup'],
+    include_package_data=True,
+    platforms='any',
+    keywords=KEYWORDS,
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+        "Topic :: Software Development :: Libraries",
+    ],
+    install_requires=[
+        "aiomysql",
+        "dnspython",
+    ]
+)