Skip to main content

Certbot plugin for authentication using Websupport REST API

This is a plugin for Certbot that uses the Websupport REST API to allow Websupport customers to prove control of a domain name.

Usage

  1. Obtain an API key and API secret (see Account Page)

  2. Install the plugin using pip install certbot-plugin-websupport

  3. Create a websupport.ini config file with the following contents and apply chmod 600 websupport.ini on it:

    dns_websupport_api_key = APIKEY
    dns_websupport_api_secret = SECRET
    

    Replace APIKEY with your Websupport API key, SECRET with your API secret and ensure permissions are set to disallow access to other users.

  4. Run certbot and direct it to use the plugin for authentication and to use the config file previously created:

    certbot certonly -a dns-websupport --dns-websupport-credentials websupport.ini -d domain.com
    

    Add additional options as required to specify an installation plugin etc.

Please note that this solution is usually not relevant if you're using Websupport's web hosting services as Websupport offers free automated certificates for all simplehosting plans having SSL in the admin interface.

Updates

This plugin can be updated by running:

pip install certbot-plugin-websupport --upgrade

Wildcard certificates

This plugin is particularly useful when you need to obtain a wildcard certificate using dns challenges:

certbot certonly -a dns-websupport --dns-websupport-credentials websupport.ini -d domain.com -d \*.domain.com

Automatic renewal

You can setup automatic renewal using crontab with the following job for weekly renewal attempts:

0 0 * * 0 certbot renew -q -a dns-websupport --dns-websupport-credentials /etc/letsencrypt/websupport.ini

Release files for certbot-plugin-websupport 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for certbot-plugin-websupport 0.2.0
File Size Uploaded
certbot_plugin_websupport-0.2.0.tar.gz 6.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for certbot-plugin-websupport 0.2.0
File Interpreter ABI Platform
certbot_plugin_websupport-0.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 14.4 kB

Release files / certbot_plugin_websupport-0.2.0.tar.gz

Download URL certbot_plugin_websupport-0.2.0.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
db9eb562351a34df6a5fd6085085cf126d67d94c0ccfc710da313a1a9100e6d3
BLAKE2b-256 checksum
How to use checksums
45cb71ee9c2862cdd1641479ab80aaca756b5362485fee87618ace5fe539903a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 8, 2024.

Transparency log

Release files / certbot_plugin_websupport-0.2.0-py2.py3-none-any.whl

Download URL certbot_plugin_websupport-0.2.0-py2.py3-none-any.whl
Size 7.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
aa282436906a6098159472b57d115797781c897dbca50d926e24c3035b15b730
BLAKE2b-256 checksum
How to use checksums
42abb6f2e274f35ec2ca4fd749a86760dbb321f2b89b948a0abc9dd195f21c28
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 8, 2024.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page