Skip to main content

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

  1. 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
    
  2. 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

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_pdns-0.1.1.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

certbot_dns_pdns-0.1.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file certbot_dns_pdns-0.1.1.tar.gz.

File metadata

  • Download URL: certbot_dns_pdns-0.1.1.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for certbot_dns_pdns-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d059d1c1cc21eab259a24ee69c1d9d8fb077fd90f58cf8de904b0f5bd576986f
MD5 766c67c3d739c58927668bfbc598c6d0
BLAKE2b-256 1f2afbfd103249b03e842e3886d95725b6860013c6a0d052e6d8013bd4446964

See more details on using hashes here.

File details

Details for the file certbot_dns_pdns-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for certbot_dns_pdns-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e0bf82245323d33ca1c889c9facc24349c5f3ffc951136fe8bf88e1c82060fe
MD5 2f0ca0900f999c71704bfd687dea35f2
BLAKE2b-256 01aaf777db00f1a36a6dd2a91a9a94e4d0af25fd2efeefbc059e14be20577fe4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page