SafeDNS Authenticator plugin for Certbot

ansgroup/certbot-dns-safedns - Docker image

About

This container uses the SafeDNS Authenticator plugin for Certbot. It utilizes API calls to create and remove DNS TXT records for domain ownership validation.

How to use this image

1, Create the /etc/letsencrypt to house your configuration and your certificates

mkdir -p /etc/letsencrypt

2, Create the /etc/letsencrypt/safedns.ini configuration file with the below content

dns_safedns_auth_token = <YOUR API KEY HERE>
dns_safedns_propagation_seconds = 60

3, Set permissions for the newly created configuration file

chmod 0600 /etc/letsencrypt/safedns.ini

4, Test run the container

docker run -it \
  -v /etc/letsencrypt:/etc/letsencrypt \
  ansgroup/certbot-dns-safedns:latest \
    certonly \
      -d yourdomain.com \
      --agree-tos \
      --no-eff-email \
      --email email@yourdomain.com \
      --test-cert

Usage examples

Verify current certificates

docker run -it \
  -v /etc/letsencrypt:/etc/letsencrypt \
  ansgroup/certbot-dns-safedns:latest \
    certificates

Delete a certificate

docker run -it \
  -v /etc/letsencrypt:/etc/letsencrypt \
  ansgroup/certbot-dns-safedns:latest \
    delete --cert-name yourdomain.com

Renew all certificates

docker run -it \
  -v /etc/letsencrypt:/etc/letsencrypt \
  ansgroup/certbot-dns-safedns:latest \
    renew

The certbot-dns-safedns Plugin

Setup

apt install certbot python3-pip
pip3 install --upgrade certbot-dns-safedns

Execution

certbot certonly --authenticator dns_safedns

Warning: Certbot might tell you that it doesn't have permissions to write to its log file. However, if you run certbot as sudo, you won't have access to the SafeDNS plugin if you didn't install the plugin as sudo.

This will result in the following error from Certbot:

Could not choose appropriate plugin: The requested dns_safedns plugin does not appear to be installed

To get around this just do:

sudo pip3 install --upgrade certbot-dns-safedns
sudo certbot certonly --authenticator dns_safedns

If you get any Python cryptography errors, such as:

ContextualVersionConflict: ...

Just make sure to upgrade your pyopenssl.

sudo pip install --upgrade pyopenssl

Credentials and Config Options

Use of this plugin can be simplified by using a configuration file containing SafeDNS API credentials, obtained from your ANS Portal account page. See also the SafeDNS API documentation.

An example safedns.ini file:

dns_safedns_auth_token = 0123456789abcdef0123456789abcdef01234567
dns_safedns_propagation_seconds = 20

The path to this file can be provided interactively or using the --dns_safedns-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 ANS Portal 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 dns_safedns \
  --dns_safedns-credentials ~/.secrets/certbot/safedns.ini \
  --dns_safedns-propagation-seconds 900 \
  -d 'example.com' \
  -d '*.example.com'

Build

The package for the SafeDNS plugin is hosted on PyPI here: https://pypi.org/project/certbot-dns-safedns/

The package version is generated automatically by CI from a VERSION file (not committed to source control) and is not set manually.

Delete the build, dist and .egg-info directories if they are present from a previous build.

Then run:

echo "0.0.0" > VERSION  # placeholder, CI writes the real release version
uv build

Deployment

uv publish

Warning: Use the username: __token__, along with the token registered on PyPI.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ans-devops from gravatar.com ans-devops

Credits

Author: ANS Group Product Team

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Provides Extra

docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

certbot_dns_safedns-0.1.56.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

certbot_dns_safedns-0.1.56-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file certbot_dns_safedns-0.1.56.tar.gz.

File metadata

  • Download URL: certbot_dns_safedns-0.1.56.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for certbot_dns_safedns-0.1.56.tar.gz
Algorithm Hash digest
SHA256 cdcceec506bc2eac6c63bd7bea3e66f6bee142151eafc57904bcc8babefcaec9
MD5 d6c5069daa1146e7b047f1c45ad628da
BLAKE2b-256 080147e08605467c434c48bcbf1452f36c98bc59a8ff5b0ef7b71be560d3df65

See more details on using hashes here.

File details

Details for the file certbot_dns_safedns-0.1.56-py3-none-any.whl.

File metadata

  • Download URL: certbot_dns_safedns-0.1.56-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for certbot_dns_safedns-0.1.56-py3-none-any.whl
Algorithm Hash digest
SHA256 d359b8fa0486cbfc072d74bf5f9859586d1aa67e0c150713f573775ef02b7ae1
MD5 4b3e46c5dc829304ec86a305fbbdbc39
BLAKE2b-256 40105db9a2b3a885c0e1612516cf8150b8e94da5bf8042d35e43298a642014d4

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.56 This release

2 files

0.1.55

2 files

0.1.54

2 files

0.1.53

2 files

0.1.52

2 files

0.1.51

2 files

0.1.50

2 files

0.1.49

2 files

0.1.48

2 files

0.1.46

2 files

0.1.45

2 files

0.1.44

2 files

0.1.43

2 files

0.1.40

2 files

0.1.38

2 files

0.1.37

2 files

0.1.36

2 files

0.1.35

2 files

0.1.34

2 files

0.1.33

2 files

0.1.32

2 files

0.1.31

2 files

0.1.30

2 files

0.1.29

2 files

0.1.28

2 files

0.1.27

2 files

0.1.26

2 files

0.1.25

2 files

0.1.24

2 files

0.1.23

2 files

0.1.22

2 files

0.1.21

2 files

0.1.20

2 files

0.1.19

2 files

0.1.18

2 files

0.1.16

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.9.3

2 files

0.1.9.2

2 files

0.1.9.1

2 files

0.1.8

2 files

0.1.4

2 files

0.1.2

3 files

0.1.1

2 files

0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page