././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/0000775000175000017500000000000014336736106015447 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/LICENSE.txt0000664000175000017500000002504214336736074017301 0ustar00willgwillg Copyright 2015 Electronic Frontier Foundation and others Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/MANIFEST.in0000664000175000017500000000027014336736074017210 0ustar00willgwillginclude LICENSE.txt include README.rst recursive-include docs * recursive-include tests * include certbot_dns_digitalocean/py.typed global-exclude __pycache__ global-exclude *.py[cod] ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/PKG-INFO0000664000175000017500000000223114336736106016542 0ustar00willgwillgMetadata-Version: 2.1 Name: certbot-dns-digitalocean Version: 2.0.0 Summary: DigitalOcean DNS Authenticator plugin for Certbot Home-page: https://github.com/certbot/certbot Author: Certbot Project Author-email: certbot-dev@eff.org License: Apache License 2.0 Classifier: Development Status :: 5 - Production/Stable 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: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 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 Requires-Python: >=3.7 Provides-Extra: docs License-File: LICENSE.txt ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/README.rst0000664000175000017500000000006214336736074017140 0ustar00willgwillgDigitalOcean DNS Authenticator plugin for Certbot ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean/0000775000175000017500000000000014336736106022460 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean/__init__.py0000664000175000017500000000746414336736074024610 0ustar00willgwillg""" The `~certbot_dns_digitalocean.dns_digitalocean` plugin automates the process of completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and subsequently removing, TXT records using the DigitalOcean API. .. note:: The plugin is not installed by default. It can be installed by heading to `certbot.eff.org `_, choosing your system and selecting the Wildcard tab. Named Arguments --------------- ========================================== =================================== ``--dns-digitalocean-credentials`` DigitalOcean credentials_ INI file. (Required) ``--dns-digitalocean-propagation-seconds`` The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 10) ========================================== =================================== Credentials ----------- Use of this plugin requires a configuration file containing DigitalOcean API credentials, obtained from your DigitalOcean account's `Applications & API Tokens page `_. .. code-block:: ini :name: credentials.ini :caption: Example credentials file: # DigitalOcean API credentials used by Certbot dns_digitalocean_token = 0000111122223333444455556666777788889999aaaabbbbccccddddeeeeffff The path to this file can be provided interactively or using the ``--dns-digitalocean-credentials`` command-line argument. Certbot records the path to this file for use during renewal, but does not store the file's contents. .. caution:: You should protect these API credentials as you would the password to your DigitalOcean account. Users who can read this file can use these credentials to issue arbitrary API calls on your behalf. Users who can cause Certbot to run using these credentials can complete a ``dns-01`` challenge to acquire new certificates or revoke existing certificates for associated domains, even if those domains aren't being managed by this server. Certbot will emit a warning if it detects that the credentials file can be accessed by other users on your system. The warning reads "Unsafe permissions on credentials configuration file", followed by the path to the credentials file. This warning will be emitted each time Certbot uses the credentials file, including for renewal, and cannot be silenced except by addressing the issue (e.g., by using a command like ``chmod 600`` to restrict access to the file). Examples -------- .. code-block:: bash :caption: To acquire a certificate for ``example.com`` certbot certonly \\ --dns-digitalocean \\ --dns-digitalocean-credentials ~/.secrets/certbot/digitalocean.ini \\ -d example.com .. code-block:: bash :caption: To acquire a single certificate for both ``example.com`` and ``www.example.com`` certbot certonly \\ --dns-digitalocean \\ --dns-digitalocean-credentials ~/.secrets/certbot/digitalocean.ini \\ -d example.com \\ -d www.example.com .. code-block:: bash :caption: To acquire a wildcard certificate for ``*.example.com`` certbot certonly \\ --dns-digitalocean \\ --dns-digitalocean-credentials ~/.secrets/certbot/digitalocean.ini \\ -d example.com \\ -d '*.example.com' .. code-block:: bash :caption: To acquire a certificate for ``example.com``, waiting 60 seconds for DNS propagation certbot certonly \\ --dns-digitalocean \\ --dns-digitalocean-credentials ~/.secrets/certbot/digitalocean.ini \\ --dns-digitalocean-propagation-seconds 60 \\ -d example.com """ ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean/_internal/0000775000175000017500000000000014336736106024433 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean/_internal/__init__.py0000664000175000017500000000012614336736074026547 0ustar00willgwillg"""Internal implementation of `~certbot_dns_digitalocean.dns_digitalocean` plugin.""" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean/_internal/dns_digitalocean.py0000664000175000017500000001667314336736074030315 0ustar00willgwillg"""DNS Authenticator for DigitalOcean.""" import logging from typing import Any from typing import Callable from typing import Optional import digitalocean from certbot import errors from certbot.plugins import dns_common from certbot.plugins.dns_common import CredentialsConfiguration logger = logging.getLogger(__name__) class Authenticator(dns_common.DNSAuthenticator): """DNS Authenticator for DigitalOcean This Authenticator uses the DigitalOcean API to fulfill a dns-01 challenge. """ description = 'Obtain certificates using a DNS TXT record (if you are ' + \ 'using DigitalOcean for DNS).' ttl = 30 def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) self.credentials: Optional[CredentialsConfiguration] = None @classmethod def add_parser_arguments(cls, add: Callable[..., None], default_propagation_seconds: int = 10) -> None: super().add_parser_arguments(add, default_propagation_seconds) add('credentials', help='DigitalOcean credentials INI file.') def more_info(self) -> str: return 'This plugin configures a DNS TXT record to respond to a dns-01 challenge using ' + \ 'the DigitalOcean API.' def _setup_credentials(self) -> None: self.credentials = self._configure_credentials( 'credentials', 'DigitalOcean credentials INI file', { 'token': 'API token for DigitalOcean account' } ) def _perform(self, domain: str, validation_name: str, validation: str) -> None: self._get_digitalocean_client().add_txt_record(domain, validation_name, validation, self.ttl) def _cleanup(self, domain: str, validation_name: str, validation: str) -> None: self._get_digitalocean_client().del_txt_record(domain, validation_name, validation) def _get_digitalocean_client(self) -> "_DigitalOceanClient": if not self.credentials: # pragma: no cover raise errors.Error("Plugin has not been prepared.") return _DigitalOceanClient(self.credentials.conf('token')) class _DigitalOceanClient: """ Encapsulates all communication with the DigitalOcean API. """ def __init__(self, token: str) -> None: self.manager = digitalocean.Manager(token=token) def add_txt_record(self, domain_name: str, record_name: str, record_content: str, record_ttl: int) -> None: """ Add a TXT record using the supplied information. :param str domain_name: The domain to use to associate the record with. :param str record_name: The record name (typically beginning with '_acme-challenge.'). :param str record_content: The record content (typically the challenge validation). :param int record_ttl: The record TTL. :raises certbot.errors.PluginError: if an error occurs communicating with the DigitalOcean API """ try: domain = self._find_domain(domain_name) # The TTL value is set to the SOA record's TTL. Unless set to a falsy value, # the optional TTL argument to add_txt_record() would be ignored. # See https://github.com/certbot/certbot/pull/9149 for details. domain.ttl = None except digitalocean.Error as e: hint = None if str(e).startswith("Unable to authenticate"): hint = 'Did you provide a valid API token?' logger.debug('Error finding domain using the DigitalOcean API: %s', e) raise errors.PluginError('Error finding domain using the DigitalOcean API: {0}{1}' .format(e, ' ({0})'.format(hint) if hint else '')) try: result = domain.create_new_domain_record( type='TXT', name=self._compute_record_name(domain, record_name), data=record_content, ttl=record_ttl) # ttl kwarg is only effective starting python-digitalocean 1.15.0 record_id = result['domain_record']['id'] logger.debug('Successfully added TXT record with id: %d', record_id) except digitalocean.Error as e: logger.debug('Error adding TXT record using the DigitalOcean API: %s', e) raise errors.PluginError('Error adding TXT record using the DigitalOcean API: {0}' .format(e)) def del_txt_record(self, domain_name: str, record_name: str, record_content: str) -> None: """ Delete a TXT record using the supplied information. Note that both the record's name and content are used to ensure that similar records created concurrently (e.g., due to concurrent invocations of this plugin) are not deleted. Failures are logged, but not raised. :param str domain_name: The domain to use to associate the record with. :param str record_name: The record name (typically beginning with '_acme-challenge.'). :param str record_content: The record content (typically the challenge validation). """ try: domain = self._find_domain(domain_name) except digitalocean.Error as e: logger.debug('Error finding domain using the DigitalOcean API: %s', e) return try: domain_records = domain.get_records() matching_records = [record for record in domain_records if record.type == 'TXT' and record.name == self._compute_record_name(domain, record_name) and record.data == record_content] except digitalocean.Error as e: logger.debug('Error getting DNS records using the DigitalOcean API: %s', e) return for record in matching_records: try: logger.debug('Removing TXT record with id: %s', record.id) record.destroy() except digitalocean.Error as e: logger.warning('Error deleting TXT record %s using the DigitalOcean API: %s', record.id, e) def _find_domain(self, domain_name: str) -> digitalocean.Domain: """ Find the domain object for a given domain name. :param str domain_name: The domain name for which to find the corresponding Domain. :returns: The Domain, if found. :rtype: `~digitalocean.Domain` :raises certbot.errors.PluginError: if no matching Domain is found. """ domain_name_guesses = dns_common.base_domain_name_guesses(domain_name) domains = self.manager.get_all_domains() for guess in domain_name_guesses: matches = [domain for domain in domains if domain.name == guess] if matches: domain = matches[0] logger.debug('Found base domain for %s using name %s', domain_name, guess) return domain raise errors.PluginError(f'Unable to determine base domain for {domain_name} using names: ' f'{domain_name_guesses}.') @staticmethod def _compute_record_name(domain: digitalocean.Domain, full_record_name: str) -> str: # The domain, from DigitalOcean's point of view, is automatically appended. return full_record_name.rpartition("." + domain.name)[0] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean/py.typed0000664000175000017500000000000014336736074024151 0ustar00willgwillg././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/0000775000175000017500000000000014336736106024152 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053509.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/PKG-INFO0000664000175000017500000000223114336736105025244 0ustar00willgwillgMetadata-Version: 2.1 Name: certbot-dns-digitalocean Version: 2.0.0 Summary: DigitalOcean DNS Authenticator plugin for Certbot Home-page: https://github.com/certbot/certbot Author: Certbot Project Author-email: certbot-dev@eff.org License: Apache License 2.0 Classifier: Development Status :: 5 - Production/Stable 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: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 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 Requires-Python: >=3.7 Provides-Extra: docs License-File: LICENSE.txt ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053509.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/SOURCES.txt0000664000175000017500000000115614336736105026040 0ustar00willgwillgLICENSE.txt MANIFEST.in README.rst setup.py certbot_dns_digitalocean/__init__.py certbot_dns_digitalocean/py.typed certbot_dns_digitalocean.egg-info/PKG-INFO certbot_dns_digitalocean.egg-info/SOURCES.txt certbot_dns_digitalocean.egg-info/dependency_links.txt certbot_dns_digitalocean.egg-info/entry_points.txt certbot_dns_digitalocean.egg-info/requires.txt certbot_dns_digitalocean.egg-info/top_level.txt certbot_dns_digitalocean/_internal/__init__.py certbot_dns_digitalocean/_internal/dns_digitalocean.py docs/.gitignore docs/Makefile docs/api.rst docs/conf.py docs/index.rst docs/make.bat tests/dns_digitalocean_test.py././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053509.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/dependency_links.txt0000664000175000017500000000000114336736105030217 0ustar00willgwillg ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053509.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/entry_points.txt0000664000175000017500000000014714336736105027451 0ustar00willgwillg[certbot.plugins] dns-digitalocean = certbot_dns_digitalocean._internal.dns_digitalocean:Authenticator ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053509.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/requires.txt0000664000175000017500000000015514336736105026552 0ustar00willgwillgpython-digitalocean>=1.11 setuptools>=41.6.0 acme>=2.0.0 certbot>=2.0.0 [docs] Sphinx>=1.0 sphinx_rtd_theme ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053509.0 certbot-dns-digitalocean-2.0.0/certbot_dns_digitalocean.egg-info/top_level.txt0000664000175000017500000000003114336736105026675 0ustar00willgwillgcertbot_dns_digitalocean ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/docs/0000775000175000017500000000000014336736106016377 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/docs/.gitignore0000664000175000017500000000001114336736074020363 0ustar00willgwillg/_build/ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/docs/Makefile0000664000175000017500000000115514336736074020045 0ustar00willgwillg# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = certbot-dns-digitalocean SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/docs/api.rst0000664000175000017500000000022514336736074017705 0ustar00willgwillg================= API Documentation ================= Certbot plugins implement the Certbot plugins API, and do not otherwise have an external API. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/docs/conf.py0000664000175000017500000001335214336736074017706 0ustar00willgwillg# -*- coding: utf-8 -*- # # certbot-dns-digitalocean documentation build configuration file, created by # sphinx-quickstart on Wed May 10 10:52:06 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] autodoc_member_order = 'bysource' autodoc_default_flags = ['show-inheritance'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = u'certbot-dns-digitalocean' copyright = u'2017, Certbot Project' author = u'Certbot Project' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = u'0' # The full version, including alpha/beta/rc tags. release = u'0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] default_role = 'py:obj' # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # # https://docs.readthedocs.io/en/stable/faq.html#i-want-to-use-the-read-the-docs-theme-locally # on_rtd is whether we are on readthedocs.org on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if not on_rtd: # only import and set the theme if we're building docs locally import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # otherwise, readthedocs.org uses their theme by default, so no need to specify it # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". #html_static_path = ['_static'] # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'certbot-dns-digitaloceandoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'certbot-dns-digitalocean.tex', u'certbot-dns-digitalocean Documentation', u'Certbot Project', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'certbot-dns-digitalocean', u'certbot-dns-digitalocean Documentation', [author], 1) ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'certbot-dns-digitalocean', u'certbot-dns-digitalocean Documentation', author, 'certbot-dns-digitalocean', 'One line description of project.', 'Miscellaneous'), ] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'python': ('https://docs.python.org/', None), 'acme': ('https://acme-python.readthedocs.org/en/latest/', None), 'certbot': ('https://eff-certbot.readthedocs.io/en/stable/', None), } ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/docs/index.rst0000664000175000017500000000110514336736074020241 0ustar00willgwillg.. certbot-dns-digitalocean documentation master file, created by sphinx-quickstart on Wed May 10 10:52:06 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to certbot-dns-digitalocean's documentation! ==================================================== .. toctree:: :maxdepth: 2 :caption: Contents: .. automodule:: certbot_dns_digitalocean :members: .. toctree:: :maxdepth: 1 api Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/docs/make.bat0000664000175000017500000000150114336736074020005 0ustar00willgwillg@ECHO OFF pushd %~dp0 REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=. set BUILDDIR=_build set SPHINXPROJ=certbot-dns-digitalocean if "%1" == "" goto help %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.https://www.sphinx-doc.org/ exit /b 1 ) %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% goto end :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% :end popd ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/setup.cfg0000664000175000017500000000004614336736106017270 0ustar00willgwillg[egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/setup.py0000664000175000017500000000455514336736074017176 0ustar00willgwillgimport os import sys from setuptools import find_packages from setuptools import setup version = '2.0.0' install_requires = [ 'python-digitalocean>=1.11', # 1.15.0 or newer is recommended for TTL support 'setuptools>=41.6.0', ] if not os.environ.get('SNAP_BUILD'): install_requires.extend([ # We specify the minimum acme and certbot version as the current plugin # version for simplicity. See # https://github.com/certbot/certbot/issues/8761 for more info. f'acme>={version}', f'certbot>={version}', ]) elif 'bdist_wheel' in sys.argv[1:]: raise RuntimeError('Unset SNAP_BUILD when building wheels ' 'to include certbot dependencies.') if os.environ.get('SNAP_BUILD'): install_requires.append('packaging') docs_extras = [ 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags 'sphinx_rtd_theme', ] setup( name='certbot-dns-digitalocean', version=version, description="DigitalOcean DNS Authenticator plugin for Certbot", url='https://github.com/certbot/certbot', author="Certbot Project", author_email='certbot-dev@eff.org', license='Apache License 2.0', python_requires='>=3.7', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Environment :: Plugins', 'Intended Audience :: System Administrators', 'License :: OSI Approved :: Apache Software License', 'Operating System :: POSIX :: Linux', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', 'Topic :: Internet :: WWW/HTTP', 'Topic :: Security', 'Topic :: System :: Installation/Setup', 'Topic :: System :: Networking', 'Topic :: System :: Systems Administration', 'Topic :: Utilities', ], packages=find_packages(), include_package_data=True, install_requires=install_requires, extras_require={ 'docs': docs_extras, }, entry_points={ 'certbot.plugins': [ 'dns-digitalocean = certbot_dns_digitalocean._internal.dns_digitalocean:Authenticator', ], }, ) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053509.8316436 certbot-dns-digitalocean-2.0.0/tests/0000775000175000017500000000000014336736106016611 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-digitalocean-2.0.0/tests/dns_digitalocean_test.py0000664000175000017500000001521714336736074023523 0ustar00willgwillg"""Tests for certbot_dns_digitalocean._internal.dns_digitalocean.""" import unittest from unittest import mock import digitalocean from certbot import errors from certbot.compat import os from certbot.plugins import dns_test_common from certbot.plugins.dns_test_common import DOMAIN from certbot.tests import util as test_util API_ERROR = digitalocean.DataReadError() TOKEN = 'a-token' class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common.BaseAuthenticatorTest): def setUp(self): from certbot_dns_digitalocean._internal.dns_digitalocean import Authenticator super().setUp() path = os.path.join(self.tempdir, 'file.ini') dns_test_common.write({"digitalocean_token": TOKEN}, path) self.config = mock.MagicMock(digitalocean_credentials=path, digitalocean_propagation_seconds=0) # don't wait during tests self.auth = Authenticator(self.config, "digitalocean") self.mock_client = mock.MagicMock() # _get_digitalocean_client | pylint: disable=protected-access self.auth._get_digitalocean_client = mock.MagicMock(return_value=self.mock_client) @test_util.patch_display_util() def test_perform(self, unused_mock_get_utility): self.auth.perform([self.achall]) expected = [mock.call.add_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY, 30)] self.assertEqual(expected, self.mock_client.mock_calls) def test_cleanup(self): # _attempt_cleanup | pylint: disable=protected-access self.auth._attempt_cleanup = True self.auth.cleanup([self.achall]) expected = [mock.call.del_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY)] self.assertEqual(expected, self.mock_client.mock_calls) class DigitalOceanClientTest(unittest.TestCase): id_num = 1 record_prefix = "_acme-challenge" record_name = record_prefix + "." + DOMAIN record_content = "bar" record_ttl = 60 def setUp(self): from certbot_dns_digitalocean._internal.dns_digitalocean import _DigitalOceanClient self.digitalocean_client = _DigitalOceanClient(TOKEN) self.manager = mock.MagicMock() self.digitalocean_client.manager = self.manager def test_add_txt_record(self): wrong_domain_mock = mock.MagicMock() wrong_domain_mock.name = "other.invalid" wrong_domain_mock.create_new_domain_record.side_effect = AssertionError('Wrong Domain') domain_mock = mock.MagicMock() domain_mock.name = DOMAIN domain_mock.create_new_domain_record.return_value = {'domain_record': {'id': self.id_num}} self.manager.get_all_domains.return_value = [wrong_domain_mock, domain_mock] self.digitalocean_client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl) domain_mock.create_new_domain_record.assert_called_with(type='TXT', name=self.record_prefix, data=self.record_content, ttl=self.record_ttl) def test_add_txt_record_fail_to_find_domain(self): self.manager.get_all_domains.return_value = [] self.assertRaises(errors.PluginError, self.digitalocean_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_add_txt_record_error_finding_domain(self): self.manager.get_all_domains.side_effect = API_ERROR self.assertRaises(errors.PluginError, self.digitalocean_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_add_txt_record_error_creating_record(self): domain_mock = mock.MagicMock() domain_mock.name = DOMAIN domain_mock.create_new_domain_record.side_effect = API_ERROR self.manager.get_all_domains.return_value = [domain_mock] self.assertRaises(errors.PluginError, self.digitalocean_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_del_txt_record(self): first_record_mock = mock.MagicMock() first_record_mock.type = 'TXT' first_record_mock.name = "DIFFERENT" first_record_mock.data = self.record_content correct_record_mock = mock.MagicMock() correct_record_mock.type = 'TXT' correct_record_mock.name = self.record_prefix correct_record_mock.data = self.record_content last_record_mock = mock.MagicMock() last_record_mock.type = 'TXT' last_record_mock.name = self.record_prefix last_record_mock.data = "DIFFERENT" domain_mock = mock.MagicMock() domain_mock.name = DOMAIN domain_mock.get_records.return_value = [first_record_mock, correct_record_mock, last_record_mock] self.manager.get_all_domains.return_value = [domain_mock] self.digitalocean_client.del_txt_record(DOMAIN, self.record_name, self.record_content) self.assertTrue(correct_record_mock.destroy.called) self.assertFalse(first_record_mock.destroy.call_args_list) self.assertFalse(last_record_mock.destroy.call_args_list) def test_del_txt_record_error_finding_domain(self): self.manager.get_all_domains.side_effect = API_ERROR self.digitalocean_client.del_txt_record(DOMAIN, self.record_name, self.record_content) def test_del_txt_record_error_finding_record(self): domain_mock = mock.MagicMock() domain_mock.name = DOMAIN domain_mock.get_records.side_effect = API_ERROR self.manager.get_all_domains.return_value = [domain_mock] self.digitalocean_client.del_txt_record(DOMAIN, self.record_name, self.record_content) def test_del_txt_record_error_deleting_record(self): record_mock = mock.MagicMock() record_mock.type = 'TXT' record_mock.name = self.record_prefix record_mock.data = self.record_content record_mock.destroy.side_effect = API_ERROR domain_mock = mock.MagicMock() domain_mock.name = DOMAIN domain_mock.get_records.return_value = [record_mock] self.manager.get_all_domains.return_value = [domain_mock] self.digitalocean_client.del_txt_record(DOMAIN, self.record_name, self.record_content) if __name__ == "__main__": unittest.main() # pragma: no cover