shellrent DNS Authenticator plugin for Certbot
Project description
certbot-dns-shellrent
Shellrent_ DNS Authenticator plugin for Certbot_
This plugin automates the process of completing a dns-01
challenge by
creating, and subsequently removing, TXT records using the Shellrent Remote API.
.. _Shellrent: https://www.shellrent.org/ .. _Certbot: https://certbot.eff.org/
Configuration of Shellrent
You will need your username and an API token for filling up the .ini configuration file. To generate your token you have to log in to https://manager.shellrent.com, then go to "My Profile" in the upper right corner, on the left click on "API Key" and finally on "Generate API token".
Remember that you need to set up your authorized IP access first, from the "Profile security" menu voice. Every IP that should use certbot with this plugin need to be added to the authorized ip access list. More info: https://guide.shellrent.com/controllo-degli-accessi-tramite-ip/
Installation
::
pip install certbot-dns-shellrent
Named Arguments
To start using DNS authentication for shellrent, pass the following arguments on certbot's command line:
============================================================= ==============================================
--authenticator dns-shellrent
select the authenticator plugin (Required)
--dns-shellrent-credentials
shellrent Remote User credentials
INI file. (Required)
--dns-shellrent-propagation-seconds
| waiting time for DNS to propagate before asking
| the ACME server to verify the DNS record.
| (Default: 10, Recommended: >= 600)
============================================================= ==============================================
(Note that the verbose and seemingly redundant certbot-dns-shellrent:
prefix
is currently imposed by certbot for external plugins.)
Credentials
An example credentials.ini
file:
.. code-block:: ini
dns_shellrent_username = myremoteuser dns_shellrent_token = verysecureremoteusertoken dns_shellrent_endpoint = https://manager.shellrent.com/api2
The path to this file can be provided interactively or using the
--dns-shellrent-credentials
command-line argument. Certbot
records the path to this file for use during renewal, but does not store the
file's contents.
CAUTION: You should protect these API credentials as you would the
token to your shellrent account. Users who can read this file can use these
credentials to issue arbitrary API calls on your behalf. Users who can cause
Certbot to run using these credentials can complete a dns-01
challenge to
acquire new certificates or revoke existing certificates for associated
domains, even if those domains aren't being managed by this server.
Certbot will emit a warning if it detects that the credentials file can be
accessed by other users on your system. The warning reads "Unsafe permissions
on credentials configuration file", followed by the path to the credentials
file. This warning will be emitted each time Certbot uses the credentials file,
including for renewal, and cannot be silenced except by addressing the issue
(e.g., by using a command like chmod 600
to restrict access to the file).
Examples
To acquire a single certificate for both example.com
and
*.example.com
, waiting 900 seconds for DNS propagation:
.. code-block:: bash
certbot certonly
--authenticator dns-shellrent
--dns-shellrent-credentials /etc/letsencrypt/.secrets/domain.tld.ini
--dns-shellrent-propagation-seconds 900
--server https://acme-v02.api.letsencrypt.org/directory
--agree-tos
--rsa-key-size 4096
-d 'example.com'
-d '*.example.com'
Docker
In order to create a docker container with a certbot-dns-shellrent installation,
create an empty directory with the following Dockerfile
:
.. code-block:: docker
FROM certbot/certbot
RUN pip install certbot-dns-shellrent
Proceed to build the image::
docker build -t certbot/dns-shellrent .
Once that's finished, the application can be run as follows::
docker run --rm \
-v /var/lib/letsencrypt:/var/lib/letsencrypt \
-v /etc/letsencrypt:/etc/letsencrypt \
--cap-drop=all \
certbot/dns-shellrent certonly \
--authenticator dns-shellrent \
--dns-shellrent-propagation-seconds 900 \
--dns-shellrent-credentials \
/etc/letsencrypt/.secrets/domain.tld.ini \
--no-self-upgrade \
--keep-until-expiring --non-interactive --expand \
--server https://acme-v02.api.letsencrypt.org/directory \
-d example.com -d '*.example.com'
It is suggested to secure the folder as follows:: chown root:root /etc/letsencrypt/.secrets chmod 600 /etc/letsencrypt/.secrets
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-shellrent-0.1.1.tar.gz
.
File metadata
- Download URL: certbot-dns-shellrent-0.1.1.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef0e2fa8a9c59bd710b798898a7d25dec7d59b150ebbc24ccf62ff764f7cacd1 |
|
MD5 | 592f3277d938e58c515d52a329f4c693 |
|
BLAKE2b-256 | 1058c8ce8e91f6f5241228a81e936027592eaee52d330d9ad2e2ddaf9ea9016e |
File details
Details for the file certbot_dns_shellrent-0.1.1-py2.py3-none-any.whl
.
File metadata
- Download URL: certbot_dns_shellrent-0.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9214057ae64867fa38be85c8bfcd18c7cf802564ce276bfd4c25c08b59804875 |
|
MD5 | a0b48125f8e765eddec8a5625004ab3c |
|
BLAKE2b-256 | d3b7c74aeeb2ebf4af95c5b0ede49a6393d7eef7bb685bf0595b0850a0ee704c |