/certbot-dns-corenetworks

A certbot plugin for enabling DNS authentication with Core Networks

Primary LanguagePythonOtherNOASSERTION

certbot-dns-corenetworks

Core_Networks 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 Core Networks beta API.

Configuration of Core Networks

In the Allgemein -> Profil -> API-Benutzer you have to have a user with a login name and password

Installation

pip install certbot-dns-corenetworks

Named Arguments

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

--authenticator certbot-dns-corenetworks:dns-corenetworks select the authenticator plugin (Required)
--certbot-dns-corenetworks:dns-corenetworks-credentials Core Networks Remote User credentials INI file. (Required)
--certbot-dns-corenetworks:dns-corenetworks-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-corenetworks: prefix is currently imposed by certbot for external plugins.)

Credentials

An example credentials.ini file:

certbot_dns_corenetworks:dns_corenetworks_username = myremoteuser
certbot_dns_corenetworks:dns_corenetworks_password = verysecureremoteuserpassword

The path to this file can be provided interactively or using the --certbot-dns-corenetworks:dns-corenetworks-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 Core Networks 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-corenetworks:dns-corenetworks \
  --certbot-dns-corenetworks:dns-corenetworks-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
  --certbot-dns-corenetworks:dns-corenetworks-propagation-seconds 900 \
  --server https://acme-v02.api.letsencrypt.org/directory \
  --agree-tos \
  --rsa-key-size 4096 \
  -d 'example.com' \
  -d '*.example.com'