Skip to main content

Manage domains hosted on All-Inkl.com through the KAS server API

Project description

GitHub Actions CI Status codecov Status PyPI Version

kasserver - Manage domains hosted on All-Inkl.com through the KAS server API

This project consists of the Python library kasserver and a few command line utilities to manage domains of the German webhoster All-Inkl.com through their KAS server API.

At the moment the main focus is managing DNS record as this allows to automate the creation of Let's Encrypt (wildcard) certificates with the ACME DNS-01 challenge.

Installation

kasserver (and its dependencies) can be installed from PyPI with: pip3 install kasserver

Authentication

Both library and command line utilities require access to the KAS credentials. Username and password are read from the KASSERVER_USER and KASSERVER_PASSWORD environment variables or from the ~/.netrc file:

machine kasapi.kasserver.com
login USERNAME
password PASSWORD

The file must be accessible only by your user account: chmod 600 ~/.netrc.

Scripts

kasserver-dns

A generic program to manage DNS records.

DNS records can be listed with:

$ kasserver-dns list example.com
ID C Zone        Name Type  Data               Aux
 1 Y example.com      A     X.X.X.X            0
 0 N example.com      NS    ns5.kasserver.com. 0
 0 N example.com      NS    ns6.kasserver.com. 0
 0 N example.com www  CNAME example.com        0

A new DNS record is added with:

kasserver-dns add test.example.com CNAME example.com

An existing DNS record is removed with:

kasserver-dns remove test.example.com CNAME

kasserver-dns-*

The following programs are designed to be used together with ACME clients to automate DNS record creation/removal as it is required by a Let's Encryt ACME DNS-01 challenge for automatic certificate renewal.

kasserver-dns-certbot

This program is designed to be used with Certbot:

certbot certonly -d foo.exmaple.com --preferred-challenges dns \
                 --manual --manual-auth-hook kasserver-dns-certbot \
                          --manual-cleanup-hook kasserver-dns-certbot \
                 -m invalid@example.com

kasserver-dns-lego

This program is designed to be used with lego:

EXEC_PATH=kasserver-dns-lego lego --dns exec \
    --domains foo.example.com --email invalid@example.com run

License

This projected is licensed under the terms of the MIT 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

kasserver-0.4.2.tar.gz (42.6 kB view details)

Uploaded Source

Built Distribution

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

kasserver-0.4.2-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file kasserver-0.4.2.tar.gz.

File metadata

  • Download URL: kasserver-0.4.2.tar.gz
  • Upload date:
  • Size: 42.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kasserver-0.4.2.tar.gz
Algorithm Hash digest
SHA256 1447b86c12751aa78979d0adea4d775067c0c0c93ffd9a52fbd9440691d3a7d3
MD5 38eaf460d002e52f6d383d7f3ae91208
BLAKE2b-256 281b38e832a4704ad56081282233f88d1ea3c0886c318b0167b1924b6db363ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for kasserver-0.4.2.tar.gz:

Publisher: check.yml on fetzerch/kasserver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kasserver-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: kasserver-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kasserver-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7740fb891cd7aa7d96b73996649d0071374eab335a9d400d242fdd5863255b0a
MD5 8377ffaba514a77ee9cda059a1a75e57
BLAKE2b-256 f8423419a4c3a493f0af74f94d002f8ed49f982f5c3d13b1503eb080c7c90828

See more details on using hashes here.

Provenance

The following attestation bundles were made for kasserver-0.4.2-py3-none-any.whl:

Publisher: check.yml on fetzerch/kasserver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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