certbot-dns-e2econfig
E2EConfig 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 E2EConfig Remote API.
Configuration of E2EConfig
In the System -> Remote Users
you have to have a user, with the following rights
- Client Functions
- DNS zone functions
- DNS txt functions
_certbot: https://certbot.eff.org/
Installation
pip install certbot-dns-e2econfig
Named Arguments
To start using DNS authentication for e2econfig, pass the following arguments on certbot's command line:
``--authenticator dns-e2econfig`` select the authenticator plugin (Required)
``--dns-e2econfig-credentials`` e2econfig Remote User credentials
INI file. (Required)
``--dns-e2econfig-propagation-seconds`` | waiting time for DNS to propagate before asking
| the ACME server to verify the DNS record.
| (Default: 20, Recommended: >= 600)
(Note that the verbose and seemingly redundant dns-e2econfig:
prefix
is currently imposed by certbot for external plugins.)
Credentials
An example credentials.ini
file:
dns_e2econfig_api_key='api key'
dns_e2econfig_api_token='api token'
The path to this file can be provided interactively or using the
--dns-e2econfig-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 e2econfig account. Users who can read this file can use these credentials to issue arbitrary API calls on your behalf.
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 20 seconds for DNS propagation:
certbot certonly \
--authenticator dns-e2econfig \
--dns-e2econfig-credentials /etc/letsencrypt/.secrets/e2e.ini \
--dns-e2econfig-propagation-seconds 900 \
--server https://acme-v02.api.letsencrypt.org/directory \
--agree-tos \
--rsa-key-size 4096 \
-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