DNS Authenticator for certbot using the PowerDNS API
Project description
Certbot DNS Authenticator for PowerDNS
PowerDNS DNS Authenticator plugin for Certbot. This plugin uses the PowerDNS HTTP API to request modifications for the DNS-01 challenge.
A design goal of this plugin is to use the minimal amount of custom code to achieve integration with PowerDNS. As such it uses the existing Lexicon-based DNS framework in Certbot.
Installation
-
Install the plugin from PyPI
pip install certbot-dns-pdns
Alternatively you can also install both certbot and the plugin using
pipx
:pipx install certbot certbot-dns-pdns
-
Verify that the plugin is installed:
$ certbot plugins - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - * dns-pdns Description: Obtain certificates using a DNS TXT record (if you are using PowerDNS for DNS). Interfaces: Authenticator, Plugin Entry point: EntryPoint(name='dns-pdns', value='certbot_dns_pdns.dns_pdns:Authenticator', group='certbot.plugins') [...]
Usage
Create a credentials file to use with this plugin:
~/pdns-credentials.ini
dns_pdns_endpoint = https://pdns-api.example.com
dns_pdns_api_key = <Your API Key>
dns_pdns_server_id = localhost # see https://doc.powerdns.com/authoritative/http-api/server.html
dns_pdns_disable_notify = false # Disable notification of secondaries after record changes
The available configuration options correspond to the DNS-Lexicon settings for the PowerDNS provider.
Run Certbot using the plugin as the authenticator:
certbot certonly \
--authenticator dns-pdns \
--dns-pdns-credentials ~/pdns-credentials.ini \
...
Contributing
Pull requests are welcome. GitHub automatically runs pre-commit
on any pull
requests, so you may want to enable pre-commit
on your end, so your PR doesn't
fail these checks.
This repository uses Conventional Commits commit messages. Check the git log for examples on how to use them.
License
Apache License 2.0
Maintainer
- Felix Kaechele felix@kaechele.ca
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_pdns-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e0bf82245323d33ca1c889c9facc24349c5f3ffc951136fe8bf88e1c82060fe |
|
MD5 | 2f0ca0900f999c71704bfd687dea35f2 |
|
BLAKE2b-256 | 01aaf777db00f1a36a6dd2a91a9a94e4d0af25fd2efeefbc059e14be20577fe4 |