STACKIT DNS Authenticator plugin for Certbot
Project description
Certbot DNS-STACKIT Authenticator Plugin
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-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. (Mandatory) |
--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) |
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.
Test Procedures
-
Unit Testing:
make test
-
Linting:
make lint
Contribute
See CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for certbot-dns-stackit-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04e90383be5db61da0c08ede2c8d740c689365d4561d4187417c8f4aa5e03416 |
|
MD5 | 53f4515b743d0866eaec1863957ac8e6 |
|
BLAKE2b-256 | 1383a7136dc897e7ead6f468ff58e7f306e4af39d148528e29a9c064ea0e7237 |
Hashes for certbot_dns_stackit-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9865f9b98944ef50d685c508b4f60e480bd7d0992f22c9f56c19b0a12dd50a1c |
|
MD5 | 52e1064265fb76b72fed0695dcc01cc7 |
|
BLAKE2b-256 | bcfe9514c991be703590cc2eaf7954f7358b6258ace5f05cae3e8fb9d678cb6c |