././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/0000775000175000017500000000000014336736104015142 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/LICENSE.txt0000664000175000017500000002504214336736074016776 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-cloudflare-2.0.0/MANIFEST.in0000664000175000017500000000026614336736074016712 0ustar00willgwillginclude LICENSE.txt include README.rst recursive-include docs * recursive-include tests * include certbot_dns_cloudflare/py.typed global-exclude __pycache__ global-exclude *.py[cod] ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/PKG-INFO0000664000175000017500000000222514336736104016240 0ustar00willgwillgMetadata-Version: 2.1 Name: certbot-dns-cloudflare Version: 2.0.0 Summary: Cloudflare 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-cloudflare-2.0.0/README.rst0000664000175000017500000000006014336736074016633 0ustar00willgwillgCloudflare DNS Authenticator plugin for Certbot ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare/0000775000175000017500000000000014336736104021650 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare/__init__.py0000664000175000017500000001227514336736074023776 0ustar00willgwillg""" The `~certbot_dns_cloudflare.dns_cloudflare` plugin automates the process of completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and subsequently removing, TXT records using the Cloudflare 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-cloudflare-credentials`` Cloudflare credentials_ INI file. (Required) ``--dns-cloudflare-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 Cloudflare API credentials, obtained from your `Cloudflare dashboard `_. Previously, Cloudflare's "Global API Key" was used for authentication, however this key can access the entire Cloudflare API for all domains in your account, meaning it could cause a lot of damage if leaked. Cloudflare's newer API Tokens can be restricted to specific domains and operations, and are therefore now the recommended authentication option. The Token needed by Certbot requires ``Zone:DNS:Edit`` permissions for only the zones you need certificates for. Using Cloudflare Tokens also requires at least version 2.3.1 of the ``cloudflare`` Python module. If the version that automatically installed with this plugin is older than that, and you can't upgrade it on your system, you'll have to stick to the Global key. .. code-block:: ini :name: certbot_cloudflare_token.ini :caption: Example credentials file using restricted API Token (recommended): # Cloudflare API token used by Certbot dns_cloudflare_api_token = 0123456789abcdef0123456789abcdef01234567 .. code-block:: ini :name: certbot_cloudflare_key.ini :caption: Example credentials file using Global API Key (not recommended): # Cloudflare API credentials used by Certbot dns_cloudflare_email = cloudflare@example.com dns_cloudflare_api_key = 0123456789abcdef0123456789abcdef01234 The path to this file can be provided interactively or using the ``--dns-cloudflare-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 Cloudflare 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). .. note:: Please note that the ``cloudflare`` Python module used by the plugin has additional methods of providing credentials to the module, e.g. environment variables or the ``cloudflare.cfg`` configuration file. These methods are not supported by Certbot. If any of those additional methods of providing credentials is being used, they must provide the same credentials (i.e., email and API key *or* an API token) as the credentials file provided to Certbot. If there is a discrepancy, the ``cloudflare`` Python module will raise an error. Also note that the credentials provided to Certbot will take precedence over any other method of providing credentials to the ``cloudflare`` Python module. Examples -------- .. code-block:: bash :caption: To acquire a certificate for ``example.com`` certbot certonly \\ --dns-cloudflare \\ --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini \\ -d example.com .. code-block:: bash :caption: To acquire a single certificate for both ``example.com`` and ``www.example.com`` certbot certonly \\ --dns-cloudflare \\ --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini \\ -d example.com \\ -d www.example.com .. code-block:: bash :caption: To acquire a certificate for ``example.com``, waiting 60 seconds for DNS propagation certbot certonly \\ --dns-cloudflare \\ --dns-cloudflare-credentials ~/.secrets/certbot/cloudflare.ini \\ --dns-cloudflare-propagation-seconds 60 \\ -d example.com """ ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare/_internal/0000775000175000017500000000000014336736104023623 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare/_internal/__init__.py0000664000175000017500000000012214336736074025735 0ustar00willgwillg"""Internal implementation of `~certbot_dns_cloudflare.dns_cloudflare` plugin.""" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare/_internal/dns_cloudflare.py0000664000175000017500000003115714336736074027176 0ustar00willgwillg"""DNS Authenticator for Cloudflare.""" import logging from typing import Any from typing import Callable from typing import Dict from typing import List from typing import Optional import CloudFlare from certbot import errors from certbot.plugins import dns_common from certbot.plugins.dns_common import CredentialsConfiguration logger = logging.getLogger(__name__) ACCOUNT_URL = 'https://dash.cloudflare.com/?to=/:account/profile/api-tokens' class Authenticator(dns_common.DNSAuthenticator): """DNS Authenticator for Cloudflare This Authenticator uses the Cloudflare API to fulfill a dns-01 challenge. """ description = ('Obtain certificates using a DNS TXT record (if you are using Cloudflare for ' 'DNS).') ttl = 120 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='Cloudflare 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 Cloudflare API.' def _validate_credentials(self, credentials: CredentialsConfiguration) -> None: token = credentials.conf('api-token') email = credentials.conf('email') key = credentials.conf('api-key') if token: if email or key: raise errors.PluginError('{}: dns_cloudflare_email and dns_cloudflare_api_key are ' 'not needed when using an API Token' .format(credentials.confobj.filename)) elif email or key: if not email: raise errors.PluginError('{}: dns_cloudflare_email is required when using a Global ' 'API Key. (should be email address associated with ' 'Cloudflare account)'.format(credentials.confobj.filename)) if not key: raise errors.PluginError('{}: dns_cloudflare_api_key is required when using a ' 'Global API Key. (see {})' .format(credentials.confobj.filename, ACCOUNT_URL)) else: raise errors.PluginError('{}: Either dns_cloudflare_api_token (recommended), or ' 'dns_cloudflare_email and dns_cloudflare_api_key are required.' ' (see {})'.format(credentials.confobj.filename, ACCOUNT_URL)) def _setup_credentials(self) -> None: self.credentials = self._configure_credentials( 'credentials', 'Cloudflare credentials INI file', None, self._validate_credentials ) def _perform(self, domain: str, validation_name: str, validation: str) -> None: self._get_cloudflare_client().add_txt_record(domain, validation_name, validation, self.ttl) def _cleanup(self, domain: str, validation_name: str, validation: str) -> None: self._get_cloudflare_client().del_txt_record(domain, validation_name, validation) def _get_cloudflare_client(self) -> "_CloudflareClient": if not self.credentials: # pragma: no cover raise errors.Error("Plugin has not been prepared.") if self.credentials.conf('api-token'): return _CloudflareClient(api_token = self.credentials.conf('api-token')) return _CloudflareClient(email = self.credentials.conf('email'), api_key = self.credentials.conf('api-key')) class _CloudflareClient: """ Encapsulates all communication with the Cloudflare API. """ def __init__(self, email: Optional[str] = None, api_key: Optional[str] = None, api_token: Optional[str] = None) -> None: if email: # If an email was specified, we're using an email/key combination and not a token. # We can't use named arguments in this case, as it would break compatibility with # the Cloudflare library since version 2.10.1, as the `token` argument was used for # tokens and keys alike and the `key` argument did not exist in earlier versions. self.cf = CloudFlare.CloudFlare(email, api_key) else: # If no email was specified, we're using just a token. Let's use the named argument # for simplicity, which is compatible with all (current) versions of the Cloudflare # library. self.cf = CloudFlare.CloudFlare(token=api_token) def add_txt_record(self, domain: str, record_name: str, record_content: str, record_ttl: int) -> None: """ Add a TXT record using the supplied information. :param str domain: The domain to use to look up the Cloudflare zone. :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 (number of seconds that the record may be cached). :raises certbot.errors.PluginError: if an error occurs communicating with the Cloudflare API """ zone_id = self._find_zone_id(domain) data = {'type': 'TXT', 'name': record_name, 'content': record_content, 'ttl': record_ttl} try: logger.debug('Attempting to add record to zone %s: %s', zone_id, data) self.cf.zones.dns_records.post(zone_id, data=data) # zones | pylint: disable=no-member except CloudFlare.exceptions.CloudFlareAPIError as e: code = int(e) hint = None if code == 1009: hint = 'Does your API token have "Zone:DNS:Edit" permissions?' logger.error('Encountered CloudFlareAPIError adding TXT record: %d %s', e, e) raise errors.PluginError('Error communicating with the Cloudflare API: {0}{1}' .format(e, ' ({0})'.format(hint) if hint else '')) record_id = self._find_txt_record_id(zone_id, record_name, record_content) logger.debug('Successfully added TXT record with record_id: %s', record_id) def del_txt_record(self, domain: 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: The domain to use to look up the Cloudflare zone. :param str record_name: The record name (typically beginning with '_acme-challenge.'). :param str record_content: The record content (typically the challenge validation). """ try: zone_id = self._find_zone_id(domain) except errors.PluginError as e: logger.debug('Encountered error finding zone_id during deletion: %s', e) return if zone_id: record_id = self._find_txt_record_id(zone_id, record_name, record_content) if record_id: try: # zones | pylint: disable=no-member self.cf.zones.dns_records.delete(zone_id, record_id) logger.debug('Successfully deleted TXT record.') except CloudFlare.exceptions.CloudFlareAPIError as e: logger.warning('Encountered CloudFlareAPIError deleting TXT record: %s', e) else: logger.debug('TXT record not found; no cleanup needed.') else: logger.debug('Zone not found; no cleanup needed.') def _find_zone_id(self, domain: str) -> str: """ Find the zone_id for a given domain. :param str domain: The domain for which to find the zone_id. :returns: The zone_id, if found. :rtype: str :raises certbot.errors.PluginError: if no zone_id is found. """ zone_name_guesses = dns_common.base_domain_name_guesses(domain) zones: List[Dict[str, Any]] = [] code = msg = None for zone_name in zone_name_guesses: params = {'name': zone_name, 'per_page': 1} try: zones = self.cf.zones.get(params=params) # zones | pylint: disable=no-member except CloudFlare.exceptions.CloudFlareAPIError as e: code = int(e) msg = str(e) hint = None if code == 6003: hint = ('Did you copy your entire API token/key? To use Cloudflare tokens, ' 'you\'ll need the python package cloudflare>=2.3.1.{}' .format(' This certbot is running cloudflare ' + str(CloudFlare.__version__) if hasattr(CloudFlare, '__version__') else '')) elif code == 9103: hint = 'Did you enter the correct email address and Global key?' elif code == 9109: hint = 'Did you enter a valid Cloudflare Token?' if hint: raise errors.PluginError('Error determining zone_id: {0} {1}. Please confirm ' 'that you have supplied valid Cloudflare API credentials. ({2})' .format(code, msg, hint)) else: logger.debug('Unrecognised CloudFlareAPIError while finding zone_id: %d %s. ' 'Continuing with next zone guess...', e, e) if zones: zone_id = zones[0]['id'] logger.debug('Found zone_id of %s for %s using name %s', zone_id, domain, zone_name) return zone_id if msg is not None: if 'com.cloudflare.api.account.zone.list' in msg: raise errors.PluginError('Unable to determine zone_id for {0} using zone names: ' '{1}. Please confirm that the domain name has been ' 'entered correctly and your Cloudflare Token has access ' 'to the domain.'.format(domain, zone_name_guesses)) else: raise errors.PluginError('Unable to determine zone_id for {0} using zone names: ' '{1}. The error from Cloudflare was: {2} {3}.' .format(domain, zone_name_guesses, code, msg)) else: raise errors.PluginError('Unable to determine zone_id for {0} using zone names: ' '{1}. Please confirm that the domain name has been ' 'entered correctly and is already associated with the ' 'supplied Cloudflare account.' .format(domain, zone_name_guesses)) def _find_txt_record_id(self, zone_id: str, record_name: str, record_content: str) -> Optional[str]: """ Find the record_id for a TXT record with the given name and content. :param str zone_id: The zone_id which contains the record. :param str record_name: The record name (typically beginning with '_acme-challenge.'). :param str record_content: The record content (typically the challenge validation). :returns: The record_id, if found. :rtype: str """ params = {'type': 'TXT', 'name': record_name, 'content': record_content, 'per_page': 1} try: # zones | pylint: disable=no-member records = self.cf.zones.dns_records.get(zone_id, params=params) except CloudFlare.exceptions.CloudFlareAPIError as e: logger.debug('Encountered CloudFlareAPIError getting TXT record_id: %s', e) records = [] if records: # Cleanup is returning the system to the state we found it. If, for some reason, # there are multiple matching records, we only delete one because we only added one. return records[0]['id'] logger.debug('Unable to find TXT record.') return None ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare/py.typed0000664000175000017500000000000014336736074023343 0ustar00willgwillg././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/0000775000175000017500000000000014336736104023342 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053508.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/PKG-INFO0000664000175000017500000000222514336736104024440 0ustar00willgwillgMetadata-Version: 2.1 Name: certbot-dns-cloudflare Version: 2.0.0 Summary: Cloudflare 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=1669053508.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/SOURCES.txt0000664000175000017500000000112614336736104025226 0ustar00willgwillgLICENSE.txt MANIFEST.in README.rst setup.py certbot_dns_cloudflare/__init__.py certbot_dns_cloudflare/py.typed certbot_dns_cloudflare.egg-info/PKG-INFO certbot_dns_cloudflare.egg-info/SOURCES.txt certbot_dns_cloudflare.egg-info/dependency_links.txt certbot_dns_cloudflare.egg-info/entry_points.txt certbot_dns_cloudflare.egg-info/requires.txt certbot_dns_cloudflare.egg-info/top_level.txt certbot_dns_cloudflare/_internal/__init__.py certbot_dns_cloudflare/_internal/dns_cloudflare.py docs/.gitignore docs/Makefile docs/api.rst docs/conf.py docs/index.rst docs/make.bat tests/dns_cloudflare_test.py././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053508.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/dependency_links.txt0000664000175000017500000000000114336736104027410 0ustar00willgwillg ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053508.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/entry_points.txt0000664000175000017500000000014114336736104026634 0ustar00willgwillg[certbot.plugins] dns-cloudflare = certbot_dns_cloudflare._internal.dns_cloudflare:Authenticator ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053508.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/requires.txt0000664000175000017500000000014514336736104025742 0ustar00willgwillgcloudflare>=1.5.1 setuptools>=41.6.0 acme>=2.0.0 certbot>=2.0.0 [docs] Sphinx>=1.0 sphinx_rtd_theme ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053508.0 certbot-dns-cloudflare-2.0.0/certbot_dns_cloudflare.egg-info/top_level.txt0000664000175000017500000000002714336736104026073 0ustar00willgwillgcertbot_dns_cloudflare ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/docs/0000775000175000017500000000000014336736104016072 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/docs/.gitignore0000664000175000017500000000001114336736074020060 0ustar00willgwillg/_build/ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/docs/Makefile0000664000175000017500000000115414336736074017541 0ustar00willgwillg# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = certbot-dns-cloudflare 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-cloudflare-2.0.0/docs/api.rst0000664000175000017500000000022514336736074017402 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-cloudflare-2.0.0/docs/conf.py0000664000175000017500000001332614336736074017404 0ustar00willgwillg# -*- coding: utf-8 -*- # # certbot-dns-cloudflare documentation build configuration file, created by # sphinx-quickstart on Tue May 9 10:20:04 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-cloudflare' 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-cloudflaredoc' # -- 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-cloudflare.tex', u'certbot-dns-cloudflare 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-cloudflare', u'certbot-dns-cloudflare 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-cloudflare', u'certbot-dns-cloudflare Documentation', author, 'certbot-dns-cloudflare', '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-cloudflare-2.0.0/docs/index.rst0000664000175000017500000000107414336736074017743 0ustar00willgwillg.. certbot-dns-cloudflare documentation master file, created by sphinx-quickstart on Tue May 9 10:20:04 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to certbot-dns-cloudflare's documentation! ================================================== .. toctree:: :maxdepth: 2 :caption: Contents: .. automodule:: certbot_dns_cloudflare :members: .. toctree:: :maxdepth: 1 api Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/docs/make.bat0000664000175000017500000000147714336736074017516 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-cloudflare 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=1669053508.3476412 certbot-dns-cloudflare-2.0.0/setup.cfg0000664000175000017500000000004614336736104016763 0ustar00willgwillg[egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/setup.py0000664000175000017500000000445214336736074016667 0ustar00willgwillgimport os import sys from setuptools import find_packages from setuptools import setup version = '2.0.0' install_requires = [ 'cloudflare>=1.5.1', '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-cloudflare', version=version, description="Cloudflare 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-cloudflare = certbot_dns_cloudflare._internal.dns_cloudflare:Authenticator', ], }, ) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1669053508.3476412 certbot-dns-cloudflare-2.0.0/tests/0000775000175000017500000000000014336736104016304 5ustar00willgwillg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1669053500.0 certbot-dns-cloudflare-2.0.0/tests/dns_cloudflare_test.py0000664000175000017500000002400614336736074022711 0ustar00willgwillg"""Tests for certbot_dns_cloudflare._internal.dns_cloudflare.""" import unittest from unittest import mock import CloudFlare 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 = CloudFlare.exceptions.CloudFlareAPIError(1000, '', '') API_TOKEN = 'an-api-token' API_KEY = 'an-api-key' EMAIL = 'example@example.com' class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common.BaseAuthenticatorTest): def setUp(self): from certbot_dns_cloudflare._internal.dns_cloudflare import Authenticator super().setUp() path = os.path.join(self.tempdir, 'file.ini') dns_test_common.write({"cloudflare_email": EMAIL, "cloudflare_api_key": API_KEY}, path) self.config = mock.MagicMock(cloudflare_credentials=path, cloudflare_propagation_seconds=0) # don't wait during tests self.auth = Authenticator(self.config, "cloudflare") self.mock_client = mock.MagicMock() # _get_cloudflare_client | pylint: disable=protected-access self.auth._get_cloudflare_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, mock.ANY)] 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) @test_util.patch_display_util() def test_api_token(self, unused_mock_get_utility): dns_test_common.write({"cloudflare_api_token": API_TOKEN}, self.config.cloudflare_credentials) self.auth.perform([self.achall]) expected = [mock.call.add_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY, mock.ANY)] self.assertEqual(expected, self.mock_client.mock_calls) def test_no_creds(self): dns_test_common.write({}, self.config.cloudflare_credentials) self.assertRaises(errors.PluginError, self.auth.perform, [self.achall]) def test_missing_email_or_key(self): dns_test_common.write({"cloudflare_api_key": API_KEY}, self.config.cloudflare_credentials) self.assertRaises(errors.PluginError, self.auth.perform, [self.achall]) dns_test_common.write({"cloudflare_email": EMAIL}, self.config.cloudflare_credentials) self.assertRaises(errors.PluginError, self.auth.perform, [self.achall]) def test_email_or_key_with_token(self): dns_test_common.write({"cloudflare_api_token": API_TOKEN, "cloudflare_email": EMAIL}, self.config.cloudflare_credentials) self.assertRaises(errors.PluginError, self.auth.perform, [self.achall]) dns_test_common.write({"cloudflare_api_token": API_TOKEN, "cloudflare_api_key": API_KEY}, self.config.cloudflare_credentials) self.assertRaises(errors.PluginError, self.auth.perform, [self.achall]) dns_test_common.write({"cloudflare_api_token": API_TOKEN, "cloudflare_email": EMAIL, "cloudflare_api_key": API_KEY}, self.config.cloudflare_credentials) self.assertRaises(errors.PluginError, self.auth.perform, [self.achall]) class CloudflareClientTest(unittest.TestCase): record_name = "foo" record_content = "bar" record_ttl = 42 zone_id = 1 record_id = 2 def setUp(self): from certbot_dns_cloudflare._internal.dns_cloudflare import _CloudflareClient self.cloudflare_client = _CloudflareClient(EMAIL, API_KEY) self.cf = mock.MagicMock() self.cloudflare_client.cf = self.cf def test_add_txt_record(self): self.cf.zones.get.return_value = [{'id': self.zone_id}] self.cloudflare_client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl) self.cf.zones.dns_records.post.assert_called_with(self.zone_id, data=mock.ANY) post_data = self.cf.zones.dns_records.post.call_args[1]['data'] self.assertEqual('TXT', post_data['type']) self.assertEqual(self.record_name, post_data['name']) self.assertEqual(self.record_content, post_data['content']) self.assertEqual(self.record_ttl, post_data['ttl']) def test_add_txt_record_error(self): self.cf.zones.get.return_value = [{'id': self.zone_id}] self.cf.zones.dns_records.post.side_effect = CloudFlare.exceptions.CloudFlareAPIError(1009, '', '') self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_add_txt_record_error_during_zone_lookup(self): self.cf.zones.get.side_effect = API_ERROR self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_add_txt_record_zone_not_found(self): self.cf.zones.get.return_value = [] self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_add_txt_record_bad_creds(self): self.cf.zones.get.side_effect = CloudFlare.exceptions.CloudFlareAPIError(6003, '', '') self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) self.cf.zones.get.side_effect = CloudFlare.exceptions.CloudFlareAPIError(9103, '', '') self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) self.cf.zones.get.side_effect = CloudFlare.exceptions.CloudFlareAPIError(9109, '', '') self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) self.cf.zones.get.side_effect = CloudFlare.exceptions.CloudFlareAPIError(0, 'com.cloudflare.api.account.zone.list', '') self.assertRaises( errors.PluginError, self.cloudflare_client.add_txt_record, DOMAIN, self.record_name, self.record_content, self.record_ttl) def test_del_txt_record(self): self.cf.zones.get.return_value = [{'id': self.zone_id}] self.cf.zones.dns_records.get.return_value = [{'id': self.record_id}] self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content) expected = [mock.call.zones.get(params=mock.ANY), mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY), mock.call.zones.dns_records.delete(self.zone_id, self.record_id)] self.assertEqual(expected, self.cf.mock_calls) get_data = self.cf.zones.dns_records.get.call_args[1]['params'] self.assertEqual('TXT', get_data['type']) self.assertEqual(self.record_name, get_data['name']) self.assertEqual(self.record_content, get_data['content']) def test_del_txt_record_error_during_zone_lookup(self): self.cf.zones.get.side_effect = API_ERROR self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content) def test_del_txt_record_error_during_delete(self): self.cf.zones.get.return_value = [{'id': self.zone_id}] self.cf.zones.dns_records.get.return_value = [{'id': self.record_id}] self.cf.zones.dns_records.delete.side_effect = API_ERROR self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content) expected = [mock.call.zones.get(params=mock.ANY), mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY), mock.call.zones.dns_records.delete(self.zone_id, self.record_id)] self.assertEqual(expected, self.cf.mock_calls) def test_del_txt_record_error_during_get(self): self.cf.zones.get.return_value = [{'id': self.zone_id}] self.cf.zones.dns_records.get.side_effect = API_ERROR self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content) expected = [mock.call.zones.get(params=mock.ANY), mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY)] self.assertEqual(expected, self.cf.mock_calls) def test_del_txt_record_no_record(self): self.cf.zones.get.return_value = [{'id': self.zone_id}] self.cf.zones.dns_records.get.return_value = [] self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content) expected = [mock.call.zones.get(params=mock.ANY), mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY)] self.assertEqual(expected, self.cf.mock_calls) def test_del_txt_record_no_zone(self): self.cf.zones.get.return_value = [{'id': None}] self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content) expected = [mock.call.zones.get(params=mock.ANY)] self.assertEqual(expected, self.cf.mock_calls) if __name__ == "__main__": unittest.main() # pragma: no cover