couchtyp / certbot-dns-schlundtech

SchlundTech XML Gateway DNS Authenticator plugin for Certbot

The certbot_dns_schlundtech.dns_schlundtech plugin automates the process of completing a dns-01 challenge (acme.challenges.DNS01) by creating, and subsequently removing, TXT records using the SchlundTech XML Gateway API.

Named Arguments

Credentials

Use of this plugin requires a configuration file containing SchlundTech XML Gateway API credentials:

• user
• password
• context

# credentials.ini
dns_schlundtech_user = 54321
dns_schlundtech_password = PASSWORD
dns_schlundtech_context = 10

The path to this file can be provided interactively or using the --dns-schlundtech-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 credentials. Users who can read this file can use these credentials to issue some types of API calls on your behalf, limited by the permissions assigned to the account. 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 domains these credentials are authorized to manage.

Examples

To acquire a certificate for example.com:

certbot certonly \
    --server https://acme-v02.api.letsencrypt.org/directory \
    -a dns-schlundtech \
    --dns-schlundtech-credentials ~/.secrets/certbot/schlundtech.ini \
    -d example.com

To acquire a single certificate for both example.com and www.example.com:

certbot certonly \
    --server https://acme-v02.api.letsencrypt.org/directory \
    -a dns-schlundtech \
    --dns-schlundtech-credentials ~/.secrets/certbot/schlundtech.ini \
    -d example.com \
    -d www.example.com

To acquire a certificate for example.com, waiting 60 seconds for DNS propagation:

certbot certonly \
    --server https://acme-v02.api.letsencrypt.org/directory \
    -a dns-schlundtech \
    --dns-schlundtech-credentials ~/.secrets/certbot/schlundtech.ini \
    --dns-schlundtech-propagation-seconds 60 \
    -d example.com

Using docker

Using the provided Dockerfile you can create a docker container based on the original certbot/certbot image plus this plugin. Using the --pull option makes sure the latest certbot image is pulled.

docker build --pull -t certbot/dns-schlundtech .

The resulting container image can be run with the options provided above.

docker run -it --rm \
    -v /etc/letsencrypt:/etc/letsencrypt \
    -v /var/lib/letsencrypt:/var/lib/letsencrypt \
    -v /var/log/letsencrypt:/var/log/letsencrypt \
    -v /tmp:/tmp \
    certbot/dns-schlundtech \
        certonly \
        --server https://acme-v02.api.letsencrypt.org/directory \
        -a dns-schlundtech \
        --dns-schlundtech-credentials /etc/letsencrypt/schlundtech.ini \
        -d example.com