Skip to content

Latest commit

 

History

History
116 lines (82 loc) · 4.49 KB

README.rst

File metadata and controls

116 lines (82 loc) · 4.49 KB
Raw

certbot-dns-domeneshop

Domeneshop 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 Domeneshop API.

Named Arguments

--dns-domeneshop-credentials domeneshop credentials INI file. (required)
--dns-domeneshop-propagation-seconds The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record(Default: 120)

Note that for certbot 1.6.0 and older, a prefix (certbot-dns-domeneshop:) is required in front of the arguments, see the examples below. The prefix is also required in the credentials file.

Installation

pip install certbot-dns-domeneshop

Credentials

Use of this plugin requires a configuration file containing Domeneshop API credentials.

See the Domeneshop API documentation for more information (in Norwegian).

An example credentials.ini file:

dns_domeneshop_client_token=1234567890abcdef
dns_domeneshop_client_secret=1234567890abcdefghijklmnopqrstuvxyz1234567890abcdefghijklmnopqrs

The path to this file can be provided interactively or using the --dns-domeneshop-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 Domeneshop user 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.

If applicable, we suggest that you create API credentials for domains used by your application, in order to reduce the potential impact of lost credentials.

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 www.example.com, waiting 120 seconds for DNS propagation (the default):

certbot certonly \
  --authenticator dns-domeneshop \
  --dns-domeneshop-credentials ~/.secrets/certbot/domeneshop.ini \
  --dns-domeneshop-propagation-seconds 120 \
  -d example.com \
  -d www.example.com

If you are using certbot 1.6.0 or older, you should call the plugin with prefixes the prefix:

certbot certonly \
  --authenticator certbot-dns-domeneshop:dns-domeneshop \
  --certbot-dns-domeneshop:dns-domeneshop-credentials ~/.secrets/certbot/domeneshop.ini \
  --certbot-dns-domeneshop:dns-domeneshop-propagation-seconds 120 \
  -d example.com \
  -d www.example.com

In this second example, make sure you are also adding the prefixes in ~/.secrets/certbot/domeneshop.ini (e.g. certbot-dns-domeneshop:dns_domeneshop_client_token). Certbot will fail to discover your credentials otherwise.

Docker image

A docker image is also available on Docker Hub.

Example usage (where the local directory /etc/letsencrypt/domeneshop.ini contains your secrets):

docker run --rm \
  -v /etc/letsencrypt:/etc/letsencrypt \
  -v /var/lib/letsencrypt:/var/lib/letsencrypt \
  domeneshop/certbot-dns-domeneshop \
  certonly \
  --authenticator dns-domeneshop \
  --dns-domeneshop-credentials /etc/letsencrypt/domeneshop.ini \
  --agree-tos \
  --email "[email protected]" \
  -d example.com