././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/0000775000175100017510000000000000000000000015474 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/LICENSE.txt0000664000175100017510000002504200000000000017322 0ustar00ericaerica00000000000000 Copyright 2018 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=1628021578.0 certbot-dns-gehirn-1.18.0/MANIFEST.in0000664000175100017510000000021600000000000017231 0ustar00ericaerica00000000000000include LICENSE.txt include README.rst recursive-include docs * recursive-include tests * global-exclude __pycache__ global-exclude *.py[cod] ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/PKG-INFO0000664000175100017510000000221500000000000016571 0ustar00ericaerica00000000000000Metadata-Version: 2.1 Name: certbot-dns-gehirn Version: 1.18.0 Summary: Gehirn Infrastructure Service 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 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 :: 3 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 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.6 Provides-Extra: docs License-File: LICENSE.txt UNKNOWN ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/README.rst0000664000175100017510000000010300000000000017155 0ustar00ericaerica00000000000000Gehirn Infrastructure Service DNS Authenticator plugin for Certbot ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn/0000775000175100017510000000000000000000000021336 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn/__init__.py0000664000175100017510000000705200000000000023453 0ustar00ericaerica00000000000000""" The `~certbot_dns_gehirn.dns_gehirn` plugin automates the process of completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and subsequently removing, TXT records using the Gehirn Infrastructure Service DNS 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-gehirn-credentials`` Gehirn Infrastructure Service credentials_ INI file. (Required) ``--dns-gehirn-propagation-seconds`` The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 30) ======================================== ===================================== Credentials ----------- Use of this plugin requires a configuration file containing Gehirn Infrastructure Service DNS API credentials, obtained from your Gehirn Infrastructure Service `dashboard `_. .. code-block:: ini :name: credentials.ini :caption: Example credentials file: # Gehirn Infrastructure Service API credentials used by Certbot dns_gehirn_api_token = 00000000-0000-0000-0000-000000000000 dns_gehirn_api_secret = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw The path to this file can be provided interactively or using the ``--dns-gehirn-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 Gehirn Infrastructure Service 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-gehirn \\ --dns-gehirn-credentials ~/.secrets/certbot/gehirn.ini \\ -d example.com .. code-block:: bash :caption: To acquire a single certificate for both ``example.com`` and ``www.example.com`` certbot certonly \\ --dns-gehirn \\ --dns-gehirn-credentials ~/.secrets/certbot/gehirn.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-gehirn \\ --dns-gehirn-credentials ~/.secrets/certbot/gehirn.ini \\ --dns-gehirn-propagation-seconds 60 \\ -d example.com """ ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn/_internal/0000775000175100017510000000000000000000000023311 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn/_internal/__init__.py0000664000175100017510000000011200000000000025414 0ustar00ericaerica00000000000000"""Internal implementation of `~certbot_dns_gehirn.dns_gehirn` plugin.""" ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn/_internal/dns_gehirn.py0000664000175100017510000000640700000000000026012 0ustar00ericaerica00000000000000"""DNS Authenticator for Gehirn Infrastructure Service DNS.""" import logging from typing import Optional from lexicon.providers import gehirn from certbot import errors from certbot.plugins import dns_common from certbot.plugins import dns_common_lexicon from certbot.plugins.dns_common import CredentialsConfiguration logger = logging.getLogger(__name__) DASHBOARD_URL = "https://gis.gehirn.jp/" class Authenticator(dns_common.DNSAuthenticator): """DNS Authenticator for Gehirn Infrastructure Service DNS This Authenticator uses the Gehirn Infrastructure Service API to fulfill a dns-01 challenge. """ description = 'Obtain certificates using a DNS TXT record ' + \ '(if you are using Gehirn Infrastructure Service for DNS).' ttl = 60 def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.credentials: Optional[CredentialsConfiguration] = None @classmethod def add_parser_arguments(cls, add): # pylint: disable=arguments-differ super().add_parser_arguments(add, default_propagation_seconds=30) add('credentials', help='Gehirn Infrastructure Service credentials 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 Gehirn Infrastructure Service API.' def _setup_credentials(self): self.credentials = self._configure_credentials( 'credentials', 'Gehirn Infrastructure Service credentials file', { 'api-token': 'API token for Gehirn Infrastructure Service ' + \ 'API obtained from {0}'.format(DASHBOARD_URL), 'api-secret': 'API secret for Gehirn Infrastructure Service ' + \ 'API obtained from {0}'.format(DASHBOARD_URL), } ) def _perform(self, domain, validation_name, validation): self._get_gehirn_client().add_txt_record(domain, validation_name, validation) def _cleanup(self, domain, validation_name, validation): self._get_gehirn_client().del_txt_record(domain, validation_name, validation) def _get_gehirn_client(self): if not self.credentials: # pragma: no cover raise errors.Error("Plugin has not been prepared.") return _GehirnLexiconClient( self.credentials.conf('api-token'), self.credentials.conf('api-secret'), self.ttl ) class _GehirnLexiconClient(dns_common_lexicon.LexiconClient): """ Encapsulates all communication with the Gehirn Infrastructure Service via Lexicon. """ def __init__(self, api_token, api_secret, ttl): super().__init__() config = dns_common_lexicon.build_lexicon_config('gehirn', { 'ttl': ttl, }, { 'auth_token': api_token, 'auth_secret': api_secret, }) self.provider = gehirn.Provider(config) def _handle_http_error(self, e, domain_name): if domain_name in str(e) and (str(e).startswith('404 Client Error: Not Found for url:')): return None # Expected errors when zone name guess is wrong return super()._handle_http_error(e, domain_name) ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/0000775000175100017510000000000000000000000023030 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021871.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/PKG-INFO0000664000175100017510000000221500000000000024125 0ustar00ericaerica00000000000000Metadata-Version: 2.1 Name: certbot-dns-gehirn Version: 1.18.0 Summary: Gehirn Infrastructure Service 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 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 :: 3 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 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.6 Provides-Extra: docs License-File: LICENSE.txt UNKNOWN ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021871.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/SOURCES.txt0000664000175100017510000000102400000000000024711 0ustar00ericaerica00000000000000LICENSE.txt MANIFEST.in README.rst setup.cfg setup.py certbot_dns_gehirn/__init__.py certbot_dns_gehirn.egg-info/PKG-INFO certbot_dns_gehirn.egg-info/SOURCES.txt certbot_dns_gehirn.egg-info/dependency_links.txt certbot_dns_gehirn.egg-info/entry_points.txt certbot_dns_gehirn.egg-info/requires.txt certbot_dns_gehirn.egg-info/top_level.txt certbot_dns_gehirn/_internal/__init__.py certbot_dns_gehirn/_internal/dns_gehirn.py docs/.gitignore docs/Makefile docs/api.rst docs/conf.py docs/index.rst docs/make.bat tests/dns_gehirn_test.py././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021871.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/dependency_links.txt0000664000175100017510000000000100000000000027076 0ustar00ericaerica00000000000000 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021871.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/entry_points.txt0000664000175100017510000000012600000000000026325 0ustar00ericaerica00000000000000[certbot.plugins] dns-gehirn = certbot_dns_gehirn._internal.dns_gehirn:Authenticator ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021871.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/requires.txt0000664000175100017510000000016700000000000025434 0ustar00ericaerica00000000000000dns-lexicon>=3.2.1 setuptools>=39.0.1 zope.interface acme>=1.18.0 certbot>=1.18.0 [docs] Sphinx>=1.0 sphinx_rtd_theme ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021871.0 certbot-dns-gehirn-1.18.0/certbot_dns_gehirn.egg-info/top_level.txt0000664000175100017510000000002300000000000025555 0ustar00ericaerica00000000000000certbot_dns_gehirn ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/docs/0000775000175100017510000000000000000000000016424 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/docs/.gitignore0000664000175100017510000000001100000000000020404 0ustar00ericaerica00000000000000/_build/ ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/docs/Makefile0000664000175100017510000000114700000000000020067 0ustar00ericaerica00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = certbot-dns-gehirn 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=1628021578.0 certbot-dns-gehirn-1.18.0/docs/api.rst0000664000175100017510000000022500000000000017726 0ustar00ericaerica00000000000000================= API Documentation ================= Certbot plugins implement the Certbot plugins API, and do not otherwise have an external API. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/docs/conf.py0000664000175100017510000001323600000000000017730 0ustar00ericaerica00000000000000# -*- coding: utf-8 -*- # # certbot-dns-gehirn documentation build configuration file, created by # sphinx-quickstart on Wed May 10 18:30:40 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-gehirn' copyright = u'2018, 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-gehirndoc' # -- 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-gehirn.tex', u'certbot-dns-gehirn 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-gehirn', u'certbot-dns-gehirn 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-gehirn', u'certbot-dns-gehirn Documentation', author, 'certbot-dns-gehirn', '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=1628021578.0 certbot-dns-gehirn-1.18.0/docs/index.rst0000664000175100017510000000105500000000000020266 0ustar00ericaerica00000000000000.. certbot-dns-gehirn documentation master file, created by sphinx-quickstart on Wed May 10 18:30:40 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to certbot-dns-gehirn's documentation! ============================================== .. toctree:: :maxdepth: 2 :caption: Contents: .. toctree:: :maxdepth: 1 api .. automodule:: certbot_dns_gehirn :members: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/docs/make.bat0000664000175100017510000000147300000000000020036 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-gehirn 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 ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/setup.cfg0000664000175100017510000000010300000000000017307 0ustar00ericaerica00000000000000[bdist_wheel] universal = 1 [egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021579.0 certbot-dns-gehirn-1.18.0/setup.py0000664000175100017510000000442200000000000017210 0ustar00ericaerica00000000000000import os import sys from setuptools import find_packages from setuptools import setup version = '1.18.0' install_requires = [ 'dns-lexicon>=3.2.1', 'setuptools>=39.0.1', 'zope.interface', ] 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-gehirn', version=version, description="Gehirn Infrastructure Service 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.6', 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.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', '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-gehirn = certbot_dns_gehirn._internal.dns_gehirn:Authenticator', ], }, ) ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1628021871.3809814 certbot-dns-gehirn-1.18.0/tests/0000775000175100017510000000000000000000000016636 5ustar00ericaerica00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1628021578.0 certbot-dns-gehirn-1.18.0/tests/dns_gehirn_test.py0000664000175100017510000000375200000000000022376 0ustar00ericaerica00000000000000"""Tests for certbot_dns_gehirn._internal.dns_gehirn.""" import unittest try: import mock except ImportError: # pragma: no cover from unittest import mock # type: ignore from requests.exceptions import HTTPError from certbot.compat import os from certbot.plugins import dns_test_common from certbot.plugins import dns_test_common_lexicon from certbot.plugins.dns_test_common import DOMAIN from certbot.tests import util as test_util API_TOKEN = '00000000-0000-0000-0000-000000000000' API_SECRET = 'MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw' class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common_lexicon.BaseLexiconAuthenticatorTest): def setUp(self): super().setUp() from certbot_dns_gehirn._internal.dns_gehirn import Authenticator path = os.path.join(self.tempdir, 'file.ini') dns_test_common.write( {"gehirn_api_token": API_TOKEN, "gehirn_api_secret": API_SECRET}, path ) self.config = mock.MagicMock(gehirn_credentials=path, gehirn_propagation_seconds=0) # don't wait during tests self.auth = Authenticator(self.config, "gehirn") self.mock_client = mock.MagicMock() # _get_gehirn_client | pylint: disable=protected-access self.auth._get_gehirn_client = mock.MagicMock(return_value=self.mock_client) class GehirnLexiconClientTest(unittest.TestCase, dns_test_common_lexicon.BaseLexiconClientTest): DOMAIN_NOT_FOUND = HTTPError('404 Client Error: Not Found for url: {0}.'.format(DOMAIN)) LOGIN_ERROR = HTTPError('401 Client Error: Unauthorized for url: {0}.'.format(DOMAIN)) def setUp(self): from certbot_dns_gehirn._internal.dns_gehirn import _GehirnLexiconClient self.client = _GehirnLexiconClient(API_TOKEN, API_SECRET, 0) self.provider_mock = mock.MagicMock() self.client.provider = self.provider_mock if __name__ == "__main__": unittest.main() # pragma: no cover