certbot-dns-directadmin 0.0.3__zip

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin/__init__.py

@@ -0,0 +1 @@
+"""Directadmin dns-01 authenticator plugin"""

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin/directadmin.py

@@ -0,0 +1,142 @@
+import base64
+from collections import OrderedDict
+import requests
+
+try:
+    #  python 3
+    from urllib.request import urlopen, Request
+    from urllib.parse import urlencode, parse_qs
+except ImportError:
+    #  python 2
+    from urllib import urlencode
+    from urllib2 import urlopen, Request
+    from cgi import parse_qs
+
+
+class DirectAdminClient:
+
+    def __init__(self, url, username, password):
+
+        self.version = "0.0.3"
+        self.client = requests.session()
+        self.headers = {'user-agent': 'pyDirectAdmin/' + str(self.version),
+                        'Authorization': 'Basic %s' % base64.b64encode(("%s:%s" %
+                                                                        (username, password))
+                                                                       .encode()).decode('utf8'),
+                        }
+        self.url = url
+
+    def make_request(self, endpoint, data=None):
+        response = None  # Empty response variable
+
+        if data is not None:
+            #  Data is present add the fields to call
+            response = urlopen(
+                Request(
+                    "%s?%s" % (self.url + '/{}'.format(endpoint), urlencode(data)),
+                    headers=self.headers,
+                )
+            )
+        elif data is None:
+            #  Data is not present so we don't need addition field.
+            response = urlopen(
+                Request(
+                    "%s?" % (self.url + '/{}'.format(endpoint)),
+                    headers=self.headers,
+                )
+            )
+
+        return response
+
+    @staticmethod
+    def __process_response__(response):
+        if int(response['error'][0]) > 0:
+            # There was an error
+            raise Exception(response['text'][0])
+        elif int(response['error'][0]) == 0:
+            # Everything succeeded
+            return {'error': response['error'][0],
+                    'message': response['text'][0]
+                    }
+
+    def get_domain_list(self):
+        r = self.make_request('CMD_API_SHOW_DOMAINS')
+
+        domains = parse_qs(r.read().decode('utf8'),
+                           keep_blank_values=0,
+                           strict_parsing=1)
+        response = list()
+        for domain in domains.values():
+            response.append(domain[0])
+        return response
+
+    def get_zone_list(self, domain):
+        params = OrderedDict([('domain', domain)])
+        r = self.make_request('CMD_API_DNS_CONTROL', params)
+
+        return r.read()
+
+    def add_dns_record(self, domain, record_type, record_name, record_value, record_ttl=None):
+
+        params = OrderedDict([('domain', domain),
+                              ('action', 'add'),
+                              ('type', record_type.upper()),
+                              ('name', record_name),
+                              ('value', record_value)])
+
+        if record_ttl is not None:
+            params.update({'ttl': record_ttl})
+
+        response = self.make_request('CMD_API_DNS_CONTROL', data=params)
+        response = parse_qs(response.read().decode('utf8'),
+                            keep_blank_values=0,
+                            strict_parsing=1)
+
+        return self.__process_response__(response)
+
+    def update_dns_record(self, domain, record_type, record_name, record_value_old, record_value_new, record_ttl=None):
+
+        params = OrderedDict([('domain', domain),
+                              ('action', 'edit'),
+                              ('type', record_type.upper()),
+                              (record_type.lower() + "recs0", 'name={}&value={}'.format(record_name, record_value_old)),
+                              ('name', record_name),
+                              ('value', record_value_new)])
+
+        if record_ttl is not None:
+            params.update({'ttl': record_ttl})
+
+        response = self.make_request('CMD_API_DNS_CONTROL', data=params)
+        response = parse_qs(response.read().decode('utf8'),
+                            keep_blank_values=0,
+                            strict_parsing=1)
+
+        return self.__process_response__(response)
+
+    def delete_dns_record(self, domain, record_type, record_name, record_value):
+        params = OrderedDict([('domain', domain),
+                              ('action', 'select'),
+                              (record_type.lower() + "recs0", 'name={}&value={}'.format(record_name, record_value))
+                              ])
+
+        response = self.make_request('CMD_API_DNS_CONTROL', data=params)
+        response = parse_qs(response.read().decode('utf8'),
+                            keep_blank_values=0,
+                            strict_parsing=1)
+
+        return self.__process_response__(response)
+
+    def override_domain_ttl(self, domain, record_name, ttl):
+        params = OrderedDict([('domain', domain),
+                              ('action', 'ttl'),
+                              ('ttl_select', 'custom'),
+                              ('name', record_name),
+                              ('ttl', ttl)])
+
+        response = self.make_request('CMD_API_DNS_CONTROL', data=params)
+        response = parse_qs(response.read().decode('utf8'),
+                            keep_blank_values=0,
+                            strict_parsing=1)
+
+        return self.__process_response__(response)
+

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin/dns_directadmin.py

@@ -0,0 +1,132 @@
+"""Directadmin dns-01 authenticator plugin"""
+import logging
+import tldextract
+
+try:
+    #  python 3
+    from urllib.request import urlopen, Request
+    from urllib.parse import urlencode
+except ImportError:
+    #  python 2
+    from urllib import urlencode
+    from urllib2 import urlopen, Request
+
+import zope.interface
+
+from certbot import errors
+from certbot import interfaces
+from certbot.plugins import dns_common
+from certbot_dns_directadmin.directadmin import DirectAdminClient
+
+logger = logging.getLogger(__name__)
+
+
+@zope.interface.implementer(interfaces.IAuthenticator)
+@zope.interface.provider(interfaces.IPluginFactory)
+class Authenticator(dns_common.DNSAuthenticator):
+    """directadmin dns-01 authenticator plugin"""
+
+    description = "Obtain a certificate using a DNS TXT record in directadmin"
+    problem = "a"
+
+    def __init__(self, *args, **kwargs):
+        super(Authenticator, self).__init__(*args, **kwargs)
+        self.credentials = None
+
+    @classmethod
+    def add_parser_arguments(cls, add):  # pylint: disable=arguments-differ
+        super(Authenticator, cls).add_parser_arguments(add, default_propagation_seconds=10)
+        add("credentials",
+            type=str,
+            help="The directadmin credentials INI file")
+
+    def more_info(self):  # pylint: disable=missing-docstring
+        return self.description
+
+    def _setup_credentials(self):
+        self.credentials = self._configure_credentials(
+            'credentials',
+            'The directadmin credentials INI file',
+            {
+                'url': 'directadmin url',
+                'username': 'directadmin username',
+                'password': 'directadmin password'
+            }
+        )
+
+    def _perform(self, domain, validation_domain_name, validation):
+        self._get_directadmin_client().add_txt_record(validation_domain_name, validation)
+
+    def _cleanup(self, domain, validation_domain_name, validation):
+        self._get_directadmin_client().del_txt_record(validation_domain_name, validation)
+
+    def _get_directadmin_client(self):
+        return _DirectadminClient(
+            self.credentials.conf('url'),
+            self.credentials.conf('username'),
+            self.credentials.conf('password')
+        )
+
+
+class _DirectadminClient:
+    """Encapsulate communications with the directadmin API"""
+
+    def __init__(self, url, username, password):
+        self.url = url
+        self.client = DirectAdminClient(url, username, password)
+
+    def add_txt_record(self, record_name, record_content, record_ttl=60):
+        """Add a TXT record
+        :param str record_name: the domain name to add
+        :param str record_content: the content of the TXT record to add
+        :param int record_ttl: the TTL of the record to add
+        """
+        (directadmin_zone, directadmin_name) = self._get_zone_and_name(record_name)
+
+        try:
+            response = self.client.add_dns_record(directadmin_zone,
+                                                  'txt',
+                                                  directadmin_name,
+                                                  record_value=record_content,
+                                                  record_ttl=record_ttl)
+
+            logger.debug(response)
+            if int(response['error']) == 0:
+                logger.info("Successfully added TXT record for %s", record_name)
+        except Exception as e:
+            raise errors.PluginError("Error adding TXT record: %s" % e)
+
+    def del_txt_record(self, record_name, record_content, record_ttl=60):
+        """Remove a TXT record
+        :param str record_name: the domain name to remove
+        :param str record_content: the content of the TXT record to remove
+        :param int record_ttl: the TTL of the record to remove
+        """
+        (directadmin_zone, directadmin_name) = self._get_zone_and_name(record_name)
+
+        try:
+            response = self.client.delete_dns_record(directadmin_zone, 'txt', directadmin_name, record_content)
+            logger.debug(response)
+            if int(response['error']) == 0:
+                logger.info("Successfully removed TXT record for %s", record_name)
+        except Exception as e:
+            raise errors.PluginError("Error removing TXT record: %s" % e)
+
+    def _get_zone_and_name(self, record_domain):
+        """Find a suitable zone for a domain
+        :param str record_name: the domain name
+        :returns: (the zone, the name in the zone)
+        :rtype: tuple
+        """
+        directadmin_zone = ''
+        directadmin_name = ''
+        logger.debug('Record Domain: ' + record_domain)
+        (subdomain, domain, suffix) = tldextract.extract(record_domain)
+        logger.debug('Subdomain: ' + subdomain)
+        logger.debug('Domain: ' + domain)
+        logger.debug('Suffix: ' + suffix)
+
+        directadmin_zone = ".".join((domain, suffix))
+        directadmin_name = subdomain
+
+        return directadmin_zone, directadmin_name

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin-0.0.3-py3.7.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: certbot-dns-directadmin
+Version: 0.0.3
+Summary: certbot plugin to allow acme dns-01 authentication of a name managed in DirectAdmin.
+Home-page: https://github.com/cybercinch/certbot-dns-directadmin
+Author: Aaron Guise
+Author-email: aaron@guise.net.nz
+License: Apache Licence 2.0
+Description: # certbot-dns-directadmin
+        
+        Plugin to allow acme dns-01 authentication of a name managed in DirectAdmin. Useful for automating and creating a Let's Encrypt certificate (wildcard or not) for a service with a name managed by DirectAdmin, but installed on a server not managed in DirectAdmin.
+        
+        ## How to use
+        ### 1. Install
+        First, install certbot and the plugin using pip:
+        ```
+        pip install certbot certbot-dns-directadmin
+        ```
+        ### 2. Configure
+        Download the file `credentials.ini.example` and rename it to `directadmin-credentials.ini`. Edit it to set your DirectAdmin url, username and password.
+        ```
+        # The url DirectAdmin url
+        # include the scheme and the port number (usually 2222)
+        certbot_dns_directadmin:directadmin_url = https://directadmin.example.com:2222
+        # The DirectAdmin username
+        certbot_dns_directadmin:directadmin_username = user
+        
+        # The DirectAdmin password
+        certbot_dns_directadmin:directadmin_password = hunter2
+        ```
+        ### 3. Run
+        You can now run certbot using the plugin and feeding the credentials file.  
+        For example, to get a certificate for example.com and www.example.com:
+        ```
+        certbot certonly \
+        --authenticator certbot-dns-directadmin:directadmin \
+        --certbot-dns-directadmin:panel-credentials /path/to/directadmin-credentials.ini \
+        -d example.com \
+        -d www.example.com
+        ```
+        To create a wildcard certificate *.example.com and install it on an apache server, the installer plugin must be specified with the `--installer` option.
+        You will need to install the apache plugin if it's not already present on your system.
+        ```
+        pip install certbot-apache
+        certbot run \
+        --apache \
+        --authenticator certbot-dns-directadmin:directadmin \
+        --installer apache \
+        --certbot-dns-directadmin:directadmin-credentials /path/to/directadmin-credentials.ini \
+        -d '*.example.com'
+        ```
+        The certbot documentation has some additionnal informations about combining authenticator and installer plugins: https://certbot.eff.org/docs/using.html#getting-certificates-and-choosing-plugins
+        
+        ## Docker
+        A docker image based on [certbot/certbot](https://hub.docker.com/r/certbot/certbot/) is provided for your convenience:
+        ```
+        docker run \
+        -v /path/to/credentials.ini:/tmp/credentials.ini \
+        cybercinch/certbot-dns-directadmin \
+        certonly \
+        --authenticator certbot-dns-directadmin:directadmin \
+        --certbot-dns-cpanel:cpanel-credentials /tmp/directadmin-credentials.ini \
+        -d example.com \
+        -d www.example.com
+        ```
+        
+        ## Additional documentation
+        * https://certbot.eff.org/docs/
+        
+Keywords: certbot letsencrypt directadmin da dns-01 plugin
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin-0.0.3-py3.7.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+setup.cfg
+setup.py
+certbot_dns_directadmin/__init__.py
+certbot_dns_directadmin/directadmin.py
+certbot_dns_directadmin/dns_directadmin.py
+certbot_dns_directadmin.egg-info/PKG-INFO
+certbot_dns_directadmin.egg-info/SOURCES.txt
+certbot_dns_directadmin.egg-info/dependency_links.txt
+certbot_dns_directadmin.egg-info/entry_points.txt
+certbot_dns_directadmin.egg-info/requires.txt
+certbot_dns_directadmin.egg-info/top_level.txt

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin-0.0.3-py3.7.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin-0.0.3-py3.7.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[certbot.plugins]
+directadmin = certbot_dns_directadmin.dns_directadmin:Authenticator
+

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin-0.0.3-py3.7.egg-info/requires.txt

@@ -0,0 +1,3 @@
+certbot
+zope.interface
+tldextract

Storage/OneDrive/OneDrive - WHS/Projects/certbot-dns-directadmin/.venv/Lib/site-packages/certbot_dns_directadmin-0.0.3-py3.7.egg-info/top_level.txt

@@ -0,0 +1 @@
+certbot_dns_directadmin