Skip to main content

All-Inkl KAS DNS Authenticator plugin for Certbot

Project description

certbot-dns-kas

A Certbot DNS authenticator plugin for All-Inkl (KAS). It solves dns-01 ACME challenges by creating and removing the required _acme-challenge TXT records through the All-Inkl KAS API — so you can issue and auto-renew certificates (including wildcards) for domains hosted at All-Inkl without any manual DNS edits.

It talks to the KAS SOAP API directly using only requests; there is no dependency on kasserver, zeep or lxml.

Highlights

  • Wildcard + apex in one certificateexample.com and *.example.com together work correctly (two TXT records with the same name coexist).
  • Correct zone detection for every TLD depth — resolves the hosted zone from your account's domain list, so multi-label public suffixes like .or.at, .co.uk or .com.au work out of the box.
  • Safe cleanup — removes exactly the challenge record it created, matched by name, type and content; no leftover _acme-challenge records.
  • Lightweight & self-contained — pure requests + the Python standard library. No SOAP framework, no runtime schema downloads.

Requirements

  • Python ≥ 3.9
  • Certbot ≥ 2.0
  • An All-Inkl account with KAS API access enabled, and a KAS login whose API permissions include reading and writing DNS records.

Installation

pip install certbot-dns-kas

Make sure you install it into the same Python environment as Certbot.

Credentials

Create an INI file, e.g. kas-credentials.ini:

dns_kas_user     = your_kas_login
dns_kas_password = your_kas_password

Protect it, since it contains your KAS password:

chmod 600 kas-credentials.ini

Usage

certbot certonly \
  --authenticator dns-kas \
  --dns-kas-credentials /path/to/kas-credentials.ini \
  --dns-kas-propagation-seconds 120 \
  -d example.com -d "*.example.com"
Argument Description Default
--dns-kas-credentials Path to the KAS credentials INI file
--dns-kas-propagation-seconds Seconds to wait for DNS propagation before validation 120

If validation fails with "Incorrect TXT record found", the record usually just needs more time to propagate — raise --dns-kas-propagation-seconds (e.g. to 240).

Nginx Proxy Manager

All-Inkl (KAS) is available as a DNS provider in Nginx Proxy Manager. NPM ships its own pinned list of DNS plugins, so to use this version make sure the kas entry in NPM's dns-plugins.json points at a current release:

"kas": {
    "name": "All-Inkl",
    "package_name": "certbot-dns-kas",
    "version": "~=1.0",
    "dependencies": "",
    "full_plugin_name": "dns-kas",
    "credentials": "dns_kas_user = your_kas_user\ndns_kas_password = your_kas_password"
}

Then add an SSL certificate in NPM, choose All-Inkl as the DNS provider, enter your KAS credentials, and enable wildcard if you need *.example.com.

How it works

For each challenge the plugin:

  1. resolves the hosted DNS zone for the validation name by matching it against your account's domains (get_domains), choosing the longest matching zone;
  2. creates the _acme-challenge TXT record via add_dns_settings (always an add, never an overwrite, so multiple challenges for the same name coexist);
  3. after validation, deletes that exact record by its KAS record id.

KAS flood protection is handled automatically with bounded retries.

Development

pip install -e .
pip install pytest
python -m pytest

The test suite validates the SOAP response parser against real captured KAS responses and covers zone resolution, flood-protection retries, idempotent record creation and cleanup.

License

Apache License 2.0 — see LICENSE.

Project details


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_kas-1.0.0.tar.gz (11.1 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_kas-1.0.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file certbot_dns_kas-1.0.0.tar.gz.

File metadata

  • Download URL: certbot_dns_kas-1.0.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for certbot_dns_kas-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8cbab6647c4c0365fd99766509805f2cc033f90621914718d488d76db73e8e70
MD5 c5575a17df062586b2ce4ed01c50d11a
BLAKE2b-256 1527b3b1385e23c3f53e140f537b73cf7c63b88f06da4773eed3c89c67bd2824

See more details on using hashes here.

File details

Details for the file certbot_dns_kas-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for certbot_dns_kas-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a2fe03ca98bf28e3f99da79dff22c3d619942ff48b423939a10ed58951b0578
MD5 aa83079e7fa213f3cb1fcf88604ab2df
BLAKE2b-256 aad125eb0397551f04679fcdac6fa365b93e2ff97df794ed8c0e6ff6d41f17f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page