Skip to main content

Certbot DNS Plugin for the UK DNS Privacy Project

Project description

certbot-dns-dnsprivacy

certbot-dns-dnsprivacy is a Certbot plugin that automates the process of creating and cleaning up DNS TXT records for domain validation using the UK DNS Privacy Project API.

Installation

To install the package, use the following command:

pip install certbot-dns-dnsprivacy

Usage

This plugin allows Certbot to perform DNS-01 challenges using the UK DNS Privacy Project API. Below is an example of how to use it:

  1. Create a credentials.ini file with the following content:

    # credentials.ini
    dns_dnsprivacy_token = YOUR_API_TOKEN
    

    Replace YOUR_API_TOKEN with your API token from the UK DNS Privacy Project API settings.

  2. Run Certbot with the following command:

    certbot certonly \
      --authenticator dns-dnsprivacy \
      --dns-dnsprivacy-credentials ./credentials.ini \
      --dns-dnsprivacy-propagation-seconds 60 \
      -d example.com
    

    Replace example.com with your domain name.

Development

To set up a development environment:

  1. Clone the repository and navigate to the project directory.

  2. Create a virtual environment and activate it:

    python -m venv venv
    source venv/bin/activate
    
  3. Install the package in editable mode:

    pip install -e .
    
  4. Run the test script:

    ./test.sh
    

Contributing

If you would like to contribute to this project, please fork the repository, create a feature branch, and submit a pull request. Contributions are welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.

Links

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_dnsprivacy-0.4.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

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

certbot_dns_dnsprivacy-0.4.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file certbot_dns_dnsprivacy-0.4.0.tar.gz.

File metadata

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

File hashes

Hashes for certbot_dns_dnsprivacy-0.4.0.tar.gz
Algorithm Hash digest
SHA256 752574bb0e2ef92a4a69db1940789ea8f593406e9a379e413604eb4570ee0bd3
MD5 ad9b96a244e113127b9a372df2689494
BLAKE2b-256 ef96dabdf67929c70a995cec0d366c06534bdd388e492e41fe074dbc4ef72f2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for certbot_dns_dnsprivacy-0.4.0.tar.gz:

Publisher: publish.yml on UK-DNS-Privacy-Project/certbot-dns-dnsprivacy

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

File details

Details for the file certbot_dns_dnsprivacy-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for certbot_dns_dnsprivacy-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 596e21577b4d95434fcfbbdb520660d5c3f28a69a29cb88dbc06fee7a280ecdb
MD5 ab84ece2fa9ec7bfe9e1eb0271365869
BLAKE2b-256 a1d5d3da8ba9dd9531e1884db25b24b3c1df3acee9f1a3521855e9f75b801bf5

See more details on using hashes here.

Provenance

The following attestation bundles were made for certbot_dns_dnsprivacy-0.4.0-py3-none-any.whl:

Publisher: publish.yml on UK-DNS-Privacy-Project/certbot-dns-dnsprivacy

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