Package: certbot-dns-netcup
netcupDNS Authenticator plugin forcertbot.This plugin automates the process of completing adns-01challenge by
creating, and subsequently removing,TXTrecords using the netcupCCP
APIvialexicon.Note:This manual assumes certbot ≥ v1.7, which has improved the naming
scheme for external plugins. If you cannot upgrade, please also refer to theOld option naming schemesection below.InstallationSince this package acts as a plugin forcertbot, the installation method can
vary depending on how certbot is installed.pipIf certbot is installed normally as a python package, the plugin can be
installed using:pip install certbot-dns-netcupsnapIf certbot is installed as a snap, you’ll have to install this plugin as
follows:sudo snap install certbot-dns-netcupFurthermore, the following seems to be required in order to connect the plugin
to certbot:sudo snap set certbot trust-plugin-with-root=ok
sudo snap connect certbot:plugin certbot-dns-netcupdockerUsing docker, you can pull an image that contains both certbot and a matching
version of the plugin:docker pull coldfix/certbot-dns-netcupUsageTo acquire a single certificate for bothexample.comand*.example.com, waiting 1200 seconds (20min) for DNS propagation:certbot certonly \\
  --authenticator dns-netcup \\
  --dns-netcup-credentials ~/.secrets/certbot/netcup.ini \\
  --dns-netcup-propagation-seconds 1200 \\
  --keep-until-expiring --non-interactive --expand \
  --server https://acme-v02.api.letsencrypt.org/directory \
  -d 'example.com' \\
  -d '*.example.com'The parameters and the format of the credentials file are described below.Named ArgumentsTo start using DNS authentication for netcup, pass the following arguments on
certbot’s command line:--authenticatordns-netcupselect the authenticator
plugin (Required)--dns-netcup-credentialsFILEnetcupcredentialsINI file. (Required)--dns-netcup-propagation-secondsNUMwaiting time for DNS to propagate before askingthe ACME server to verify the DNS record.(Default: 900, Recommended: >= 600)NOTE:You may need to set an unexpectedly high propagation time (≥ 900 seconds) to
give the netcup DNS time to propagate the entries! This may be annoying when
calling certbot manually but should not be a problem in automated setups.
In exceptional cases, 20 minutes may be required. See#28.CredentialsUse of this plugin requires a configuration file containing netcup API
credentials, obtained from your netcupaccount page. See also theCCP
APIdocumentation.An examplecredentials.inifile:dns_netcup_customer_id=123456dns_netcup_api_key=0123456789abcdef0123456789abcdef01234567dns_netcup_api_password=abcdef0123456789abcdef01234567abcdef0123The path to this file can be provided interactively or using the--dns-netcup-credentialscommand-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 netcup 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 adns-01challenge 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 likechmod 600to restrict access to the file).DockerYou can pull the latest version of the docker image directly from Docker Hub
as follows:docker pull coldfix/certbot-dns-netcupAlternatively, the docker image can be built from a local checkout and the
includedDockerfileas follows:docker build -t coldfix/certbot-dns-netcup .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 \
  coldfix/certbot-dns-netcup certbot certonly \
    --authenticator dns-netcup \
    --dns-netcup-propagation-seconds 900 \
    --dns-netcup-credentials /var/lib/letsencrypt/netcup_credentials.ini \
    --keep-until-expiring --non-interactive --expand \
    --server https://acme-v02.api.letsencrypt.org/directory \
    --agree-tos --email "webmaster@example.com" \
    -d example.com -d '*.example.com'You may want to change the volumes/var/lib/letsencryptand/etc/letsencryptto local directories where the certificates and
configuration should be stored.Old option naming schemeIt is recommended to use the newest certbot version, at leastv1.7.If you’re using a certbot version belowv1.7all options related to
external plugins (such as this one) must be prefixed by the name of the
plugin. This means that every occurence ofdns-netcupin the command line
options must be replaced bycertbot-dns-netcup:dns-netcup, i.e.:--authenticator certbot-dns-netcup:dns-netcup
--certbot-dns-netcup:dns-netcup-credentials
--certbot-dns-netcup:dns-netcup-propagation-secondsFurther, every occurence ofdns_netcupin the config file must be prefixed
bycertbot_dns_netcup:, resulting in a file like this:certbot_dns_netcup:dns_netcup_customer_id  = ...certbot_dns_netcup:dns_netcup_api_key      = ...certbot_dns_netcup:dns_netcup_api_password = ...