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.3.0.tar.gz (4.3 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.3.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: certbot_dns_dnsprivacy-0.3.0.tar.gz
  • Upload date:
  • Size: 4.3 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.3.0.tar.gz
Algorithm Hash digest
SHA256 ba0df689f7fcc4737ec8ec6c7c134917d9797080e3317683e287621d5c2323b4
MD5 e956a8c79b72595d5a0b97e22785f469
BLAKE2b-256 d72752d92cc772ed913801a5bbb7a38423f0a04529f1a541759d5bdd513a7645

See more details on using hashes here.

Provenance

The following attestation bundles were made for certbot_dns_dnsprivacy-0.3.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.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for certbot_dns_dnsprivacy-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6930d488e961508aa58debd2bada0979ad65e5aaff141849e75138f5bb79de2
MD5 d84df59ad2c8aa0080888dcd4431adb8
BLAKE2b-256 fe72861292978dd38bd8b1499488f078320a9f3b2a3f12a536cd01c995ec4419

See more details on using hashes here.

Provenance

The following attestation bundles were made for certbot_dns_dnsprivacy-0.3.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