././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/0000775000175100017510000000000000000000000015410 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/LICENSE.txt0000664000175100017510000002504200000000000017236 0ustar00ericaerica00000000000000 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/MANIFEST.in0000664000175100017510000000021600000000000017145 0ustar00ericaerica00000000000000include LICENSE.txt include README.rst recursive-include docs * recursive-include tests * global-exclude __pycache__ global-exclude *.py[cod] ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/PKG-INFO0000664000175100017510000000237400000000000016513 0ustar00ericaerica00000000000000Metadata-Version: 2.1 Name: certbot-dns-linode Version: 1.7.0 Summary: Linode DNS Authenticator plugin for Certbot Home-page: https://github.com/certbot/certbot Author: Certbot Project Author-email: client-dev@letsencrypt.org License: Apache License 2.0 Description: UNKNOWN Platform: UNKNOWN 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 :: 2 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 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: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.* Provides-Extra: docs ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/README.rst0000664000175100017510000000005400000000000017076 0ustar00ericaerica00000000000000Linode DNS Authenticator plugin for Certbot ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/certbot_dns_linode/0000775000175100017510000000000000000000000021250 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/certbot_dns_linode/__init__.py0000664000175100017510000000741500000000000023370 0ustar00ericaerica00000000000000""" The `~certbot_dns_linode.dns_linode` plugin automates the process of completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and subsequently removing, TXT records using the Linode API. Named Arguments --------------- ========================================== =================================== ``--dns-linode-credentials`` Linode credentials_ INI file. (Required) ``--dns-linode-propagation-seconds`` The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 120 because Linode updates its first DNS every 60 seconds and we allow 60 more seconds for the update to reach other 5 servers) ========================================== =================================== Credentials ----------- Use of this plugin requires a configuration file containing Linode API credentials, obtained from your Linode account's `Applications & API Tokens page (legacy) `_ or `Applications & API Tokens page (new) `_. .. code-block:: ini :name: credentials.ini :caption: Example credentials file: # Linode API credentials used by Certbot dns_linode_key = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ64 dns_linode_version = [|3|4] The path to this file can be provided interactively or using the ``--dns-linode-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 Linode 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-linode \\ --dns-linode-credentials ~/.secrets/certbot/linode.ini \\ -d example.com .. code-block:: bash :caption: To acquire a single certificate for both ``example.com`` and ``www.example.com`` certbot certonly \\ --dns-linode \\ --dns-linode-credentials ~/.secrets/certbot/linode.ini \\ -d example.com \\ -d www.example.com .. code-block:: bash :caption: To acquire a certificate for ``example.com``, waiting 120 seconds for DNS propagation (Linode updates its first DNS every minute and we allow some extra time for the update to reach other 5 servers) certbot certonly \\ --dns-linode \\ --dns-linode-credentials ~/.secrets/certbot/linode.ini \\ --dns-linode-propagation-seconds 120 \\ -d example.com """ ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/certbot_dns_linode/_internal/0000775000175100017510000000000000000000000023223 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/certbot_dns_linode/_internal/__init__.py0000664000175100017510000000011200000000000025326 0ustar00ericaerica00000000000000"""Internal implementation of `~certbot_dns_linode.dns_linode` plugin.""" ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/certbot_dns_linode/_internal/dns_linode.py0000664000175100017510000000730700000000000025722 0ustar00ericaerica00000000000000"""DNS Authenticator for Linode.""" import logging import re from lexicon.providers import linode from lexicon.providers import linode4 import zope.interface from certbot import errors from certbot import interfaces from certbot.plugins import dns_common from certbot.plugins import dns_common_lexicon logger = logging.getLogger(__name__) API_KEY_URL = 'https://manager.linode.com/profile/api' API_KEY_URL_V4 = 'https://cloud.linode.com/profile/tokens' @zope.interface.implementer(interfaces.IAuthenticator) @zope.interface.provider(interfaces.IPluginFactory) class Authenticator(dns_common.DNSAuthenticator): """DNS Authenticator for Linode This Authenticator uses the Linode API to fulfill a dns-01 challenge. """ description = 'Obtain certs using a DNS TXT record (if you are using Linode for DNS).' def __init__(self, *args, **kwargs): super(Authenticator, self).__init__(*args, **kwargs) self.credentials = None @classmethod def add_parser_arguments(cls, add): # pylint: disable=arguments-differ super(Authenticator, cls).add_parser_arguments(add, default_propagation_seconds=120) add('credentials', help='Linode credentials INI file.') def more_info(self): # pylint: disable=missing-function-docstring return 'This plugin configures a DNS TXT record to respond to a dns-01 challenge using ' + \ 'the Linode API.' def _setup_credentials(self): self.credentials = self._configure_credentials( 'credentials', 'Linode credentials INI file', { 'key': 'API key for Linode account, obtained from {0} or {1}' .format(API_KEY_URL, API_KEY_URL_V4) } ) def _perform(self, domain, validation_name, validation): self._get_linode_client().add_txt_record(domain, validation_name, validation) def _cleanup(self, domain, validation_name, validation): self._get_linode_client().del_txt_record(domain, validation_name, validation) def _get_linode_client(self): api_key = self.credentials.conf('key') api_version = self.credentials.conf('version') if api_version == '': api_version = None if not api_version: api_version = 3 # Match for v4 api key regex_v4 = re.compile('^[0-9a-f]{64}$') regex_match = regex_v4.match(api_key) if regex_match: api_version = 4 else: api_version = int(api_version) return _LinodeLexiconClient(api_key, api_version) class _LinodeLexiconClient(dns_common_lexicon.LexiconClient): """ Encapsulates all communication with the Linode API. """ def __init__(self, api_key, api_version): super(_LinodeLexiconClient, self).__init__() self.api_version = api_version if api_version == 3: config = dns_common_lexicon.build_lexicon_config('linode', {}, { 'auth_token': api_key, }) self.provider = linode.Provider(config) elif api_version == 4: config = dns_common_lexicon.build_lexicon_config('linode4', {}, { 'auth_token': api_key, }) self.provider = linode4.Provider(config) else: raise errors.PluginError('Invalid api version specified: {0}. (Supported: 3, 4)' .format(api_version)) def _handle_general_error(self, e, domain_name): if not str(e).startswith('Domain not found'): return errors.PluginError('Unexpected error determining zone identifier for {0}: {1}' .format(domain_name, e)) return None ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/0000775000175100017510000000000000000000000022742 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565239.0 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/PKG-INFO0000664000175100017510000000237400000000000024045 0ustar00ericaerica00000000000000Metadata-Version: 2.1 Name: certbot-dns-linode Version: 1.7.0 Summary: Linode DNS Authenticator plugin for Certbot Home-page: https://github.com/certbot/certbot Author: Certbot Project Author-email: client-dev@letsencrypt.org License: Apache License 2.0 Description: UNKNOWN Platform: UNKNOWN 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 :: 2 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 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: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.* Provides-Extra: docs ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565239.0 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/SOURCES.txt0000664000175100017510000000102400000000000024623 0ustar00ericaerica00000000000000LICENSE.txt MANIFEST.in README.rst setup.cfg setup.py certbot_dns_linode/__init__.py certbot_dns_linode.egg-info/PKG-INFO certbot_dns_linode.egg-info/SOURCES.txt certbot_dns_linode.egg-info/dependency_links.txt certbot_dns_linode.egg-info/entry_points.txt certbot_dns_linode.egg-info/requires.txt certbot_dns_linode.egg-info/top_level.txt certbot_dns_linode/_internal/__init__.py certbot_dns_linode/_internal/dns_linode.py docs/.gitignore docs/Makefile docs/api.rst docs/conf.py docs/index.rst docs/make.bat tests/dns_linode_test.py././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565239.0 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/dependency_links.txt0000664000175100017510000000000100000000000027010 0ustar00ericaerica00000000000000 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565239.0 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/entry_points.txt0000664000175100017510000000012600000000000026237 0ustar00ericaerica00000000000000[certbot.plugins] dns-linode = certbot_dns_linode._internal.dns_linode:Authenticator ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565239.0 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/requires.txt0000664000175100017510000000021600000000000025341 0ustar00ericaerica00000000000000dns-lexicon>=2.2.3 setuptools zope.interface acme>=0.31.0 certbot>=1.1.0 [:python_version < "3.3"] mock [docs] Sphinx>=1.0 sphinx_rtd_theme ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565239.0 certbot-dns-linode-1.7.0/certbot_dns_linode.egg-info/top_level.txt0000664000175100017510000000002300000000000025467 0ustar00ericaerica00000000000000certbot_dns_linode ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/docs/0000775000175100017510000000000000000000000016340 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/docs/.gitignore0000664000175100017510000000001100000000000020320 0ustar00ericaerica00000000000000/_build/ ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/docs/Makefile0000664000175100017510000000115000000000000017775 0ustar00ericaerica00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = certbot-dns-linode 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) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/docs/api.rst0000664000175100017510000000022500000000000017642 0ustar00ericaerica00000000000000================= API Documentation ================= Certbot plugins implement the Certbot plugins API, and do not otherwise have an external API. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/docs/conf.py0000664000175100017510000001324000000000000017637 0ustar00ericaerica00000000000000# -*- coding: utf-8 -*- # # certbot-dns-linode 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-linode' 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. # # http://docs.readthedocs.org/en/latest/theme.html#how-do-i-use-this-locally-and-on-read-the-docs # 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-linodedoc' # -- 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-linode.tex', u'certbot-dns-linode 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-linode', u'certbot-dns-linode 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-linode', u'certbot-dns-linode Documentation', author, 'certbot-dns-linode', '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://certbot.eff.org/docs/', None), } ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/docs/index.rst0000664000175100017510000000106300000000000020201 0ustar00ericaerica00000000000000.. certbot-dns-linode 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-linode's documentation! ==================================================== .. toctree:: :maxdepth: 2 :caption: Contents: .. toctree:: :maxdepth: 1 api .. automodule:: certbot_dns_linode :members: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/docs/make.bat0000664000175100017510000000146600000000000017754 0ustar00ericaerica00000000000000@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-linode 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.http://sphinx-doc.org/ exit /b 1 ) %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% goto end :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% :end popd ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/setup.cfg0000664000175100017510000000010300000000000017223 0ustar00ericaerica00000000000000[bdist_wheel] universal = 1 [egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565216.0 certbot-dns-linode-1.7.0/setup.py0000664000175100017510000000652700000000000017134 0ustar00ericaerica00000000000000from distutils.version import LooseVersion import os import sys from setuptools import __version__ as setuptools_version from setuptools import find_packages from setuptools import setup from setuptools.command.test import test as TestCommand version = '1.7.0' # Please update tox.ini when modifying dependency version requirements install_requires = [ 'dns-lexicon>=2.2.3', 'setuptools', 'zope.interface', ] if not os.environ.get('SNAP_BUILD'): install_requires.extend([ 'acme>=0.31.0', 'certbot>=1.1.0', ]) 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') setuptools_known_environment_markers = (LooseVersion(setuptools_version) >= LooseVersion('36.2')) if setuptools_known_environment_markers: install_requires.append('mock ; python_version < "3.3"') elif 'bdist_wheel' in sys.argv[1:]: raise RuntimeError('Error, you are trying to build certbot wheels using an old version ' 'of setuptools. Version 36.2+ of setuptools is required.') elif sys.version_info < (3,3): install_requires.append('mock') docs_extras = [ 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags 'sphinx_rtd_theme', ] class PyTest(TestCommand): user_options = [] def initialize_options(self): TestCommand.initialize_options(self) self.pytest_args = '' def run_tests(self): import shlex # import here, cause outside the eggs aren't loaded import pytest errno = pytest.main(shlex.split(self.pytest_args)) sys.exit(errno) setup( name='certbot-dns-linode', version=version, description="Linode DNS Authenticator plugin for Certbot", url='https://github.com/certbot/certbot', author="Certbot Project", author_email='client-dev@letsencrypt.org', license='Apache License 2.0', python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*', 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 :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', '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-linode = certbot_dns_linode._internal.dns_linode:Authenticator', ], }, tests_require=["pytest"], test_suite='certbot_dns_linode', cmdclass={"test": PyTest}, ) ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1596565239.1207821 certbot-dns-linode-1.7.0/tests/0000775000175100017510000000000000000000000016552 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1596565215.0 certbot-dns-linode-1.7.0/tests/dns_linode_test.py0000664000175100017510000001332200000000000022302 0ustar00ericaerica00000000000000"""Tests for certbot_dns_linode._internal.dns_linode.""" import unittest try: import mock except ImportError: # pragma: no cover from unittest import mock # type: ignore from certbot import errors from certbot.compat import os from certbot.plugins import dns_test_common from certbot.plugins import dns_test_common_lexicon from certbot.tests import util as test_util from certbot_dns_linode._internal.dns_linode import Authenticator TOKEN = 'a-token' TOKEN_V3 = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ64' TOKEN_V4 = '0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef' class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common_lexicon.BaseLexiconAuthenticatorTest): def setUp(self): super(AuthenticatorTest, self).setUp() path = os.path.join(self.tempdir, 'file.ini') dns_test_common.write({"linode_key": TOKEN}, path) self.config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) # don't wait during tests self.auth = Authenticator(self.config, "linode") self.mock_client = mock.MagicMock() # _get_linode_client | pylint: disable=protected-access self.auth._get_linode_client = mock.MagicMock(return_value=self.mock_client) # pylint: disable=protected-access def test_api_version_3_detection(self): path = os.path.join(self.tempdir, 'file_3_auto.ini') dns_test_common.write({"linode_key": TOKEN_V3}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() client = auth._get_linode_client() self.assertEqual(3, client.api_version) # pylint: disable=protected-access def test_api_version_4_detection(self): path = os.path.join(self.tempdir, 'file_4_auto.ini') dns_test_common.write({"linode_key": TOKEN_V4}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() client = auth._get_linode_client() self.assertEqual(4, client.api_version) # pylint: disable=protected-access def test_api_version_3_detection_empty_version(self): path = os.path.join(self.tempdir, 'file_3_auto_empty.ini') dns_test_common.write({"linode_key": TOKEN_V3, "linode_version": ""}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() client = auth._get_linode_client() self.assertEqual(3, client.api_version) # pylint: disable=protected-access def test_api_version_4_detection_empty_version(self): path = os.path.join(self.tempdir, 'file_4_auto_empty.ini') dns_test_common.write({"linode_key": TOKEN_V4, "linode_version": ""}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() client = auth._get_linode_client() self.assertEqual(4, client.api_version) # pylint: disable=protected-access def test_api_version_3_manual(self): path = os.path.join(self.tempdir, 'file_3_manual.ini') dns_test_common.write({"linode_key": TOKEN_V4, "linode_version": 3}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() client = auth._get_linode_client() self.assertEqual(3, client.api_version) # pylint: disable=protected-access def test_api_version_4_manual(self): path = os.path.join(self.tempdir, 'file_4_manual.ini') dns_test_common.write({"linode_key": TOKEN_V3, "linode_version": 4}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() client = auth._get_linode_client() self.assertEqual(4, client.api_version) # pylint: disable=protected-access def test_api_version_error(self): path = os.path.join(self.tempdir, 'file_version_error.ini') dns_test_common.write({"linode_key": TOKEN_V3, "linode_version": 5}, path) config = mock.MagicMock(linode_credentials=path, linode_propagation_seconds=0) auth = Authenticator(config, "linode") auth._setup_credentials() self.assertRaises(errors.PluginError, auth._get_linode_client) class LinodeLexiconClientTest(unittest.TestCase, dns_test_common_lexicon.BaseLexiconClientTest): DOMAIN_NOT_FOUND = Exception('Domain not found') def setUp(self): from certbot_dns_linode._internal.dns_linode import _LinodeLexiconClient self.client = _LinodeLexiconClient(TOKEN, 3) self.provider_mock = mock.MagicMock() self.client.provider = self.provider_mock class Linode4LexiconClientTest(unittest.TestCase, dns_test_common_lexicon.BaseLexiconClientTest): DOMAIN_NOT_FOUND = Exception('Domain not found') def setUp(self): from certbot_dns_linode._internal.dns_linode import _LinodeLexiconClient self.client = _LinodeLexiconClient(TOKEN, 4) self.provider_mock = mock.MagicMock() self.client.provider = self.provider_mock if __name__ == "__main__": unittest.main() # pragma: no cover