Wedos DNS Authenticator plugin for Certbot
Project description
CertBot DNS plugin
This plugin uses certbot's dns-01 challenge to create and delete TXT records on a Wedos domain server, thanks to the API interface called WAPI provided by Wedos. With this plugin you can make wildcard ssl.
Installation
Prerequirements
For the functionality of this plugin, you will need to install these programs/softwares.
Name | Install | Version |
---|---|---|
python | Link | >= 3.8 |
pip | Link | >= 19.2.3 |
certbot | Link | >= 2.8.0 |
Note that in theory, even an older version should work, but it has not been tested.
You will also need to have WAPI activated for communication between Wedos and the plugin. To activate WAPI, you can read the article from Wedos, available at this link WAPI activation and settings.
CAUTION: Please note that the IP address of the server where Certbot with the plugin will be located must be allowed on WAPI, otherwise it will not work.
The Install
From pip
pip install certbot-dns-wedos
Manual with git
git clone https://github.com/clazzor/certbot-dns-wedos.git
pip3 install ./certbot-dns-wedos --break-system-packages
After installation, the created folders may be deleted.
rm -r certbot-dns-wedos
Setup
Certbot Command
The basic structure of the command is the same as with all other plugins, we define the plugin, propagation-seconds, credentials file and domains, like this:
certbot certonly \
--authenticator dns-wedos \
--dns-wedos-propagation‑seconds 420 \
--dns-wedos-credentials /path/to/the/file.ini \
-d sub.example.com
Arguments and credentials
Name | Argument | Credential | Description |
---|---|---|---|
propagation‑seconds | Optional (default 360) | Not allowed | Seconds to wait for DNS propagation before verifying DNS record with ACME server. |
credentials | Required | Not allowed | The complete path to the INI file for credentials. |
user | Not allowed | Required | The user (username) for WAPI. |
auth | Not allowed | Required | The auth (password) for WAPI |
- The prefix
dns_wedos_
is required in arguments and credentials file
Credentials file
The /path/to/the/file.ini
file:
dns_wedos_user=user@example.com
dns_wedos_auth=examplepassword
- Values are written after an equal sign
=
. For values with spaces, such ashello world
, a space can be used. - For the ini file you should apply permission:
chmod 600 file.ini
Errors
If an error occurs, Certbot will display the type of error that has occurred.
- If 420 seconds
- If you encounter an HTTP error related to communication with WAPI, you will receive an HTTP error.
- If it is an error related to communication between the plugin and WAPI, you will receive a return code. Wedos has a list of error codes on their website, which you can access through this link WAPI list of return codes.
Used Modules/Libraries
I just want to mention which modules/libraries this plugin uses for better debugging of errors in the future, in case any occur.
Name | License |
---|---|
certbot | Apache 2.0 |
datetime | PSF |
hashlib | PSF |
json | PSF |
logging | PSF |
pytz | MIT |
re | PSF |
requests | Apache 2.0 |
setuptools | MIT |
typing | PSF |
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
File details
Details for the file certbot_dns_wedos-2.0.tar.gz
.
File metadata
- Download URL: certbot_dns_wedos-2.0.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7392c10a4c3753d67f0b4ae6bbd012638297de4c7fac28620b9ad7fcb4d286fe |
|
MD5 | 303fc123426dc40fe769563af29fc92c |
|
BLAKE2b-256 | a9d84ed0bca271e5821d47a25f8ad121bfeee3a7944eb4e9e5ca5e577b500e35 |
File details
Details for the file certbot_dns_wedos-2.0-py2.py3-none-any.whl
.
File metadata
- Download URL: certbot_dns_wedos-2.0-py2.py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8aa20acdc9b137fdb0f0de4c65df27c3f68e36c167a24e6fbe1fbc3cb06b087b |
|
MD5 | f42a40a185b3b36137f84bc101fd3e57 |
|
BLAKE2b-256 | d6cae3e1b5f682201ac80bbaa6135a084f6cf497d090ddb24d96aab8f850101a |