ziadmansourm / cheapbot Goto Github PK

"""
This module defines a certbot plugin to automate the process of completing a
`dns-01` challenge (`~acme.challenges.DNS01`) by creating, and subsequently
removing, TXT records using the Namecheap API.
"""

import logging

import zope.interface
from certbot import errors, interfaces
from certbot.plugins import dns_common, dns_common_lexicon
from lexicon.providers import namecheap
from requests.exceptions import RequestException
import tldextract

logger = logging.getLogger(__name__)


@zope.interface.implementer(interfaces.IAuthenticator)
@zope.interface.provider(interfaces.IPluginFactory)
class Authenticator(dns_common.DNSAuthenticator):
    """DNS Authenticator for Namecheap

    This Authenticator uses the Namecheap API to fulfill a dns-01 challenge.
    """

    description = ('Obtain certificates using a DNS TXT record (if you are '
                   'using Namecheap for DNS).')

    def __init__(self, *args, **kwargs):
        super(Authenticator, self).__init__(*args, **kwargs)
        self.credentials = None

    @classmethod
    def add_parser_arguments(cls, add):
        super(Authenticator, cls).add_parser_arguments(add, default_propagation_seconds=30)
        add('credentials', help='Namecheap credentials INI file.')

    def more_info(self):
        return ('This plugin configures a DNS TXT record to respond to a '
                'dns-01 challenge using the Namecheap API.')

    def _setup_credentials(self):
        self.credentials = self._configure_credentials(
            'credentials',
            'namecheap credentials INI file',
            {
                'api_user': 'Namecheap API user',
                'api_key': 'Namecheap API key',
                'client_ip': 'Your client IP address',
                'username': 'Namecheap username',
            }
        )

    def _perform(self, domain, validation_name, validation):
        return self.namecheap_client.add_txt_record(domain, validation_name, validation)

    def _cleanup(self, domain, validation_name, validation):
        return self.namecheap_client.del_txt_record(domain, validation_name, validation)

    @property
    def namecheap_client(self):
        return _NamecheapLexiconClient(credentials=self.credentials.conf)


class _NamecheapLexiconClient(dns_common_lexicon.LexiconClient):
    """Encapsulates all communication with Namecheap via Lexicon."""

    def __init__(self, credentials):
        super(_NamecheapLexiconClient, self).__init__()
        config = dns_common_lexicon.build_lexicon_config('namecheap', {}, {
            'auth_username': credentials('api_user'),
            'auth_token': credentials('api_key'),
            'client_ip': credentials('client_ip')
        })

        self.provider = namecheap.Provider(config)

    def add_txt_record(self, domain, record_name, record_content):
        ex = tldextract.extract(domain)
        try:
            self._find_domain_id(ex.registered_domain)
        except errors.PluginError as e:
            logger.debug('Encountered error finding domain_id during add: %s', e, exc_info=True)
            return

        try:
            self.provider.create_record(rtype='TXT', name=record_name, content=record_content)
        except RequestException as e:
            logger.debug('Encountered error adding TXT record: %s', e, exc_info=True)
            raise errors.PluginError('Error adding TXT record: {0}'.format(e)) from e

    def del_txt_record(self, domain, record_name, record_content):
        ex = tldextract.extract(domain)
        try:
            self._find_domain_id(ex.registered_domain)
        except errors.PluginError as e:
            logger.debug('Encountered error finding domain_id during deletion: %s', e, exc_info=True)
            return

        try:
            self.provider.delete_record(rtype='TXT', name=record_name, content=record_content)
        except RequestException as e:
            logger.debug('Encountered error deleting TXT record: %s', e, exc_info=True)
            raise errors.PluginError('Error deleting TXT record: {0}'.format(e)) from e