Skip to main content

All-Inkl KAS DNS Authenticator plugin for Certbot

Project description

Certbot DNS All-Inkl (KAS) Plugin

This is a Certbot plugin for the All-Inkl DNS service (KAS).
It automates the process of completing dns-01 challenges by creating and removing TXT records via the KAS API.

Disclaimer: This plugin was developed with the assistance of AI. While it has been verified to work in production environments, please review the code and test carefully before using it in critical systems. Use at your own risk.

Installation

Via Pip (PyPI)

pip install certbot-dns-kas

From Source

pip install git+https://github.com/mobilandi/certbot-dns-kas.git

Usage

  1. Create a credentials file (e.g., credentials.ini):

    dns_kas_user = your_kas_login
    dns_kas_password = your_kas_password
    

    (Ensure this file is only readable by root/owner: chmod 600 credentials.ini)

  2. Run Certbot:

    certbot certonly \
      --authenticator dns-kas \
      --dns-kas-credentials credentials.ini \
      -d example.com -d *.example.com
    

Nginx Proxy Manager Integration

To use this plugin with Nginx Proxy Manager, you can install it into the running container.

  1. Enter the container and install:

    docker exec -it nginx-proxy-manager sh -c "export SETUPTOOLS_USE_DISTUTILS=stdlib && pip install git+https://github.com/mobilandi/certbot-dns-kas.git"
    
  2. Configure dns-plugins.json (usually in /app/certbot/dns-plugins.json):

    "kas": {
      "name": "All-Inkl (KAS)",
      "package_name": "certbot-dns-kas",
      "version": "~=1.0",
      "dependencies": "",
      "credentials": "dns_kas_user = your_kas_user\ndns_kas_password = your_kas_password",
      "full_plugin_name": "dns-kas"
    }
    
  3. Restart the container.

Development

Running Tests

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

How it works

The plugin talks to the All-Inkl KAS SOAP API directly (only requests is required at runtime) and resolves the correct DNS zone from your account's domain list, so it works for any TLD depth including multi-label suffixes such as .or.at or .co.uk.

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.0rc1.tar.gz (10.0 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.0rc1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: certbot_dns_kas-1.0.0rc1.tar.gz
  • Upload date:
  • Size: 10.0 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.0rc1.tar.gz
Algorithm Hash digest
SHA256 6f07c9fd9219dce4fb9c87f111d387a41de948f6033983868eea734b33c09e6f
MD5 95ce79e7237c28b763750b3225852480
BLAKE2b-256 1fd550b6719a90ec0ead30f2b78c72811c0c1207548650e822b37245600cfdb5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for certbot_dns_kas-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 38c7775d6a69eafa9fec564c65f4864c3f4728bc06e5b2dd280eb72d9b690bac
MD5 7e1db6205edb7c8b99c8c913b90e7e20
BLAKE2b-256 a47d46cb5ce619f2c480f6aae66327f1051741fc95ef10dab6606366bf755235

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