Skip to main content

Certbot DNS-STACKIT Authenticator Plugin

License GitHub Release Python Version Downloads Code Size Contributors

The Certbot DNS-STACKIT Authenticator Plugin facilitates the procurement of SSL/TLS certificates from Let's Encrypt utilizing the DNS-01 challenge methodology in conjunction with STACKIT as the designated DNS service provider. This document elucidates the procedural steps for the installation and operational utilization of this plugin.

Installation

To initialize the Certbot DNS-STACKIT Authenticator Plugin, deploy the following pip command:

pip install certbot-dns-stackit

Usage

Upon successful integration of the plugin, it becomes viable to employ it with Certbot for the retrieval of SSL/TLS certificates. The subsequent section delineates the pertinent arguments and their respective examples:

Arguments

Argument Example Value Description
--authenticator dns-stackit Engages the STACKIT authenticator mechanism. This must be configured as dns-stackit. (Mandatory)
--dns-stackit-project-id '8a4c68b1-586a-4534-aa0c-9f8c12334a76' Sets the STACKIT project id if the service account authentication is used. (Recommended)
--dns-stackit-service-account ./service-account.pem Denotes the directory path to the STACKIT service account file. (Recommended)
--dns-stackit-credentials ./credentials.ini Denotes the directory path to the credentials file for STACKIT DNS. This document must encapsulate the dns_stackit_auth_token and dns_stackit_project_id variables.
--dns-stackit-base-url https://dns.api.stackit.cloud Sets the STACKIT DNS API base URL. (Default: https://dns.api.stackit.cloud)
--dns-stackit-token-url https://service-account.api.stackit.cloud/token Sets the STACKIT service account token endpoint URL when using service account authentication. (Default: https://service-account.api.stackit.cloud/token)
--dns-stackit-propagation-seconds 900 Configures the delay prior to initiating the DNS record query. A 900-second interval (equivalent to 15 minutes) is recommended. (Default: 900)
Either the --dns-stackit-credentials flag or the --dns-stackit-service-account and --dns-stackit-project-id flags are mandatory.

Example

Below is a structured example detailing the application of Certbot in conjunction with the DNS-STACKIT Authenticator Plugin to retrieve a certificate:

certbot certonly \
  --authenticator dns-stackit \
  --dns-stackit-credentials ./credentials.ini \
  --dns-stackit-propagation-seconds 900 \
  --server https://acme-v02.api.letsencrypt.org/directory \
  --agree-tos \
  --rsa-key-size 4096 \
  -d 'example.runs.onstackit.cloud' \
  -d '*.example.runs.onstackit.cloud'

For this example, example.runs.onstackit.cloud represents the designated domain (zone) for certificate procurement.

Example of credentials.ini

To operationalize the plugin, it's imperative to curate a credentials.ini file encompassing your STACKIT DNS credentials:

dns_stackit_auth_token = "your_token_here"
dns_stackit_project_id = "your_project_id_here"

It's crucial to replace "your_token_here" and "your_project_id_here" placeholders with the genuine STACKIT authentication token and project ID. The token's associated service account necessitates project membership privileges for record set creation.

Authentication via STACKIT service account

The service account allows the user to use a long lived authentication which generates short lived tokens. To setup a service account refer to the service account documentation. It's important to also set the --dns-stackit-project-id flag to the corresponding STACKIT project when using a service account.

Test Procedures

  • Unit Testing:

    make test
    
  • Linting:

    make lint
    

Contribute

See CONTRIBUTING.md

Metadata

Release files for certbot-dns-stackit 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for certbot-dns-stackit 0.1.11
File Size Uploaded Provenance Actions
certbot_dns_stackit-0.1.11.tar.gz 17.2 kB Without provenance Details for certbot_dns_stackit-0.1.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for certbot-dns-stackit 0.1.11
File Interpreter ABI Platform Actions
certbot_dns_stackit-0.1.11-py3-none-any.whl Python 3 none any Details for certbot_dns_stackit-0.1.11-py3-none-any.whl

Total release size: 33.0 kB

Release files / certbot_dns_stackit-0.1.11.tar.gz

Download URL certbot_dns_stackit-0.1.11.tar.gz
Size 17.2 kB
Tags Source
SHA-256 checksum
How to use checksums
fc581b600e1967bb86996df718c8f9fe33fa43072b06a73e15dc802966fc9ec9
BLAKE2b-256 checksum
How to use checksums
31509b0c4b2f5e624fd82dcfd7e7fe02eee2fd7c0150286af627e543c5d804c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / certbot_dns_stackit-0.1.11-py3-none-any.whl

Download URL certbot_dns_stackit-0.1.11-py3-none-any.whl
Size 15.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c6ebec2d486a21852392a802797e3914e7f83bf31218a68bc50194e819acbc62
BLAKE2b-256 checksum
How to use checksums
3b236cd9c293905776253b340a54774be2323a25a1fb75b8a34d72de265942e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for certbot-dns-stackit 0.1.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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