Skip to content
A certbot plugin for enabling DNS authentication with ISPConfig
Python
Branch: master
Clone or download
Latest commit 73e50fc Sep 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
certbot_dns_ispconfig fixed author and formatting Aug 15, 2019
LICENSE.txt Initial Version of plugin Aug 15, 2019
README.rst Update README.rst Sep 15, 2019
setup.cfg Initial Version of plugin Aug 15, 2019
setup.py fixed author and formatting Aug 15, 2019

README.rst

certbot-dns-ispconfig

ISPConfig DNS Authenticator plugin for Certbot

This plugin automates the process of completing a dns-01 challenge by creating, and subsequently removing, TXT records using the ISPConfig Remote API.

Configuration of ISPConfig

In the System -> Remote Users you have to have a user, with the following rights

  • Client Functions
  • DNS zone functions
  • DNS txt functions

Installation

pip install certbot-dns-ispconfig

Named Arguments

To start using DNS authentication for ispconfig, pass the following arguments on certbot's command line:

--authenticator certbot-dns-ispconfig:dns-netcup select the authenticator plugin (Required)
--certbot-dns-ispconfig:dns-ispconfig-credentials ispconfig Remote User credentials INI file. (Required)
--certbot-dns-ispconfig:dns-ispconfig-propagation-seconds
waiting time for DNS to propagate before asking
the ACME server to verify the DNS record.
(Default: 10, Recommended: >= 600)

(Note that the verbose and seemingly redundant certbot-dns-ispconfig: prefix is currently imposed by certbot for external plugins.)

Credentials

An example credentials.ini file:

certbot_dns_ispconfig:dns_ispconfig_username = myremoteuser
certbot_dns_ispconfig:dns_ispconfig_password = verysecureremoteuserpassword
certbot_dns_ispconfig:dns_ispconfig_endpoint = https://localhost:8080

The path to this file can be provided interactively or using the --certbot-dns-ispconfig:dns-ispconfig-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 ispconfig 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

To acquire a single certificate for both example.com and *.example.com, waiting 900 seconds for DNS propagation:

certbot certonly \
  --authenticator certbot-dns-ispconfig:dns-ispconfig \
  --certbot-dns-ispconfig:dns-ispconfig-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
  --certbot-dns-ispconfig:dns-ispconfig-propagation-seconds 900 \
  --server https://acme-v02.api.letsencrypt.org/directory \
  --agree-tos \
  --rsa-key-size 4096 \
  -d 'example.com' \
  -d '*.example.com'

Docker

In order to create a docker container with a certbot-dns-ispconfig installation, create an empty directory with the following Dockerfile:

FROM certbot/certbot
RUN pip install certbot-dns-ispconfig

Proceed to build the image:

docker build -t certbot/dns-ispconfig .

Once that's finished, the application can be run as follows:

docker run --rm \
   -v /var/lib/letsencrypt:/var/lib/letsencrypt \
   -v /etc/letsencrypt:/etc/letsencrypt \
   --cap-drop=all \
   certbot/dns-ispconfig certonly \
   --authenticator certbot-dns-ispconfig:dns-ispconfig \
   --certbot-dns-ispconfig:dns-ispconfig-propagation-seconds 900 \
   --certbot-dns-ispconfig:dns-ispconfig-credentials \
       /etc/letsencrypt/.secrets/domain.tld.ini \
   --no-self-upgrade \
   --keep-until-expiring --non-interactive --expand \
   --server https://acme-v02.api.letsencrypt.org/directory \
   -d example.com -d '*.example.com'

It is suggested to secure the folder as follows:: chown root:root /etc/letsencrypt/.secrets chmod 600 /etc/letsencrypt/.secrets

You can’t perform that action at this time.