Skip to main content

ispconfig DNS Authenticator plugin for Certbot

Project description

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


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)
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.)


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).


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

certbot certonly \\
  --authenticator certbot-dns-netcup:dns-netcup \\
  --certbot-dns-netcup:dns-netcup-credentials ~/.secrets/certbot/netcup.ini \\
  --certbot-dns-netcup:dns-netcup-propagation-seconds 900 \\
  --server \
  -d '' \\
  -d '*'


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 \
       /var/lib/letsencrypt/ispconfig_credentials.ini \
   --no-self-upgrade \
   --keep-until-expiring --non-interactive --expand \
   --server \
   -d -d '*'

You may want to change the volumes /var/lib/letsencrypt and /etc/letsencrypt to local directories where the certificates and configuration should be stored.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for certbot-dns-ispconfig, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size certbot_dns_ispconfig-0.2.0-py2.py3-none-any.whl (13.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size certbot-dns-ispconfig-0.2.0.tar.gz (8.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page