https://github.com/runfalk/certbot-dns-glesys

GleSYS DNS authentication plugin for Certbot
https://github.com/runfalk/certbot-dns-glesys

letsencrypt letsencrypt-plugin ssl

Last synced: 3 months ago
JSON representation

GleSYS DNS authentication plugin for Certbot

• Host: GitHub
• URL: https://github.com/runfalk/certbot-dns-glesys
• Owner: runfalk
• License: other
• Created: 2017-09-30T11:56:58.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-08-21T10:53:40.000Z (about 3 years ago)
• Last Synced: 2025-03-23T10:46:32.286Z (8 months ago)
• Topics: letsencrypt, letsencrypt-plugin, ssl
• Language: Python
• Homepage: https://pypi.python.org/pypi/certbot-dns-glesys/
• Size: 20.5 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
GleSYS DNS Authenticator for Certbot

====================================

This allows automatic completion of `Certbot's `_

DNS01 challange for domains managed on `GleSYS `_ DNS.

Installing

----------

Installation of Certbot plugins are a bit tricky. The least bad way is to create

a Python virtual environment as *root* and install it there.

.. code-block::

   $ cd /root/

   $ python3 -m venv --prompt=certbot certbot

   $ source certbot/bin/activate

   $ pip install --upgrade pip setuptools

   $ pip install certbot-dns-glesys

You can now run Certbot using ``/root/certbot/bin/certbot``.

If you use Fedora like me I have prepared

`an RPM `_ you can use

instead.

.. code-block::

   $ sudo dnf install https://github.com/runfalk/certbot-dns-glesys/releases/download/2.0.0/python3-certbot-dns-glesys-2.0.0-1.fedora33.noarch.rpm

If you use another RPM based distribution you may be able to build it yourself.

On Fedora I install `rpmdevtools` before this. Note that this command must not

be run inside a virtualenv (or the installation path will be incorrect). You can

verify the installation path using `rpm -qpl dist/*.rpm`.

.. code-block::

   $ ./make_rpm.sh

PRs are welcome for other distributions.

Usage

-----

Create an API key with the following permissions:

- ``domain:list``

- ``domain:listrecords``

- ``domain:addrecord``

- ``domain:deleterecord``

Don't forget to give access to the appropriate IP-address range. If you want

to be able to run the client from anywhere, enter ``0.0.0.0/0``.

To use the authenticator you need to provide some required options:

``--dns-glesys-credentials`` *(required)*

  INI file with ``user`` and ``password`` for your GlesSYS API user.

The credentials file must have the following format:

.. code-block::

   dns_glesys_user = CL00000

   dns_glesys_password = apikeygoeshere

For safety reasons the file must not be world readable. You can solve this by

running:

.. code-block::

   $ chmod 600 credentials.ini

Then you can run ``certbot`` using:

.. code-block::

   $ certbot certonly \

       --authenticator dns-glesys \

       --dns-glesys-credentials credentials.ini \

       -d domain.com

If you want to obtain a wildcard certificate you can use the the domain

``-d "*.domain.com"``.

Disclaimer

----------

This plugin is neither affiliated with nor endorsed by GleSYS Internet Services

AB.

Changelog

=========

Version 2.1.0

-------------

Released 21st August 2022

- Fixed plugin not being detected by newer certbot versions.

Version 2.0.0

-------------

Released 28th December 2020

**This is a breaking change. The CLI arguments and the name of the package has

changed to match other DNS authenticator plugins.**

- Updated name to `certbot-dns-glesys` to match other DNS plugins

- Move away from legacy Certbot API (means you need to reconfigure your

  authenticator). All arguments and parameters are now prefix-less

- Dropped Python 2 support

- Dropped Python 3.5 support

Version 1.0.0

-------------

Released 11th April 2020

- Changed to GleSYS JSON API

- Added RPM as an installation option

- Dropped support for EOL Python versions

Version 0.2.0

-------------

Released on 23rd April 2018

**This is a breaking change since it requires the** ``domain:list``

**permission.**

- Added proper support for sub domain guessing, pull request

  `#4 `_

  (`@Lillecarl `_)

Version 0.1.1

-------------

Released on 15th March, 2018

- Bumped default propagation time to 90 seconds to improve reliability

- Fixed wrong base url in ``GlesysDomainApiClient``, pull request

  `#2 `_

  (`@montaniasystemab `_)

Version 0.1.0

-------------

Released on 30th September, 2017

- Initial release