E2E Networks Plugins
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
Installation
pip install e2enetworks
Named Arguments
To start using DNS authentication for ispconfig, pass the following arguments on certbot’s command line:
--authenticator e2enetworks:dns-ispconfig select |
the authenticator plugin (Required) |
--e2enetworks:dns-ispconfig-credentials ispconfig |
Remote User credentials INI file. (Required) |
--e2enetworks:dns-ispconfig-propagation-seconds | waiting |
time for DNS to propagate before asking | the ACME server to verify the DNS record. | (Default: 120, Recommended: >= 600) |
(Note that the verbose and seemingly redundant e2enetworks: 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://you.ipsconfig.host:8080/remote/json.php
The path to this file can be provided interactively or using the --e2enetworks: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 e2enetworks:dns-ispconfig \
--e2enetworks:dns-ispconfig-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
--e2enetworks: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 e2enetworks installation, create an empty directory with the following Dockerfile:
FROM certbot/certbot
RUN pip install e2enetworks
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 e2enetworks:dns-ispconfig \ --e2enetworks:dns-ispconfig-propagation-seconds 900 \ --e2enetworks: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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for e2enetworks-0.0.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2964141474cb8e6f971b84686ef4442264f9ded45779ba134a41f6790901fdb8 |
|
MD5 | f000a12a3c986143082c2b44be769402 |
|
BLAKE2b-256 | b866b75d56a0ee33a5ff0a386b910f129eedf36deb02a1e9b9d2e6c6b4e81ebb |