certbot-dns-ngenix 0.0.2

NGENIX DNS Authenticator plugin for Certbot

NGENIX 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 NGENIX Remote API.

Named Arguments

To start using DNS authentication for NGENIX, pass the following arguments on certbot’s command line:

--authenticator dns-ngenix	select the authenticator plugin (Required)
--dns-ngenix-credentials	NGENIX Remote User credentials INI file. (Required)
--dns-ngenix-propagation-seconds	waiting time for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 300, Recommended: >= 600)

Credentials

An example credentials.ini file:

# NGENIX API credentials used by Certbot
dns_ngenix_email     = [e-mail]
dns_ngenix_api_token = ngenix_token

The path to this file can be provided interactively or using the --dns-ngenix-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 a password. 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

certbot certonly \\
  --dns-ngenix \\
  --dns-ngenix-credentials ~/.secrets/certbot/ngenix.ini \\
  -d example.com

certbot certonly \\
  --dns-ngenix \\
  --dns-ngenix-credentials ~/.secrets/certbot/ngenix.ini \\
  -d example.com \\
  -d www.example.com

certbot certonly \\
  --dns-ngenix \\
  --dns-ngenix-credentials ~/.secrets/certbot/ngenix.ini \\
  --dns-ngenix-propagation-seconds 240 \\
  -d example.com