Fabio/certbot-dns-ionos
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
DorianCoding 2024-10-15 13:08:56 +02:00 committed by GitHub
parent cbd3045a82
commit 9f20694196
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 50 additions and 93 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

143
README.md
View file

@ -1,64 +1,40 @@
# certbot-dns-ionos # certbot-dns-ionos
IONOS DNS Authenticator plugin for Certbot IONOS DNS Authenticator plugin for Certbot
![Ionos](https://www.ionos.co.uk/newsroom/wp-content/uploads/sites/7/2021/12/LOGO_IONOS_Blue_RGB-1.png) ![Ionos](https://www.ionos.co.uk/newsroom/wp-content/uploads/sites/7/2021/12/LOGO_IONOS_Blue_RGB-1.png)
This plugin automates the process of completing a ``dns-01`` challenge by This plugin automates the process of completing a ``dns-01`` challenge by
creating, and subsequently removing, TXT records using the IONOS Remote API. creating, and subsequently removing, TXT records using the IONOS Remote API.
## Configuration of IONOS ## Configuration of IONOS
In the `System -> Remote Users` you have to have a user, with the following rights In the `System -> Remote Users` you have to have a user, with the following rights
- Client Functions - Client Functions
- DNS zone functions - DNS zone functions
- DNS txt functions - DNS txt functions
.. _IONOS: https://www.ionos.de/ .. _IONOS: https://www.ionos.de/
.. _Certbot: https://certbot.eff.org/ .. _Certbot: https://certbot.eff.org/
## Installation ## Installation
### Snap ### Snap
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/certbot-dns-ionos) [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/certbot-dns-ionos)
### Pip ### Pip
`pip install certbot-dns-ionos` `pip install certbot-dns-ionos`
## Named Arguments ## Named Arguments
To start using DNS authentication for ionos, pass the following arguments on To start using DNS authentication for ionos, pass the following arguments on
certbot's command line: certbot's command line:
| Command args | Command definition | | Command args | Command definition |
| --- | --- | | --- | --- |
|``--authenticator dns-ionos`` | select the authenticator plugin (Required) | |``--authenticator dns-ionos`` | select the authenticator plugin (Required) |
|``--dns-ionos-credentials`` |ionos Remote User credentials INI file. (Required) | |``--dns-ionos-credentials`` |ionos Remote User credentials INI file. (Required) |
|``--dns-ionos-propagation-seconds``|waiting time for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 10, Recommended: >= 600) | |``--dns-ionos-propagation-seconds``|waiting time for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 30, Recommended: 60) |
## Credentials ## Credentials
An example ``credentials.ini`` file: An example ``credentials.ini`` file:
```ini ```ini
dns_ionos_prefix = myapikeyprefix dns_ionos_prefix = myapikeyprefix
dns_ionos_secret = verysecureapikeysecret dns_ionos_secret = verysecureapikeysecret
dns_ionos_endpoint = https://api.hosting.ionos.com dns_ionos_endpoint = https://api.hosting.ionos.com
``` ```
The key can be managed under the following link: https://developer.hosting.ionos.de/?source=IonosControlPanel The key can be managed under the following link: https://developer.hosting.ionos.de/?source=IonosControlPanel
The path to this file can be provided interactively or using the The path to this file can be provided interactively or using the
`--dns-ionos-credentials` command-line argument. Certbot `--dns-ionos-credentials` command-line argument. Certbot
records the path to this file for use during renewal, but does not store the records the path to this file for use during renewal, but does not store the
file's contents. file's contents.
> [!CAUTION] > [!CAUTION]
> You should protect these API credentials as you would the > You should protect these API credentials as you would the
password to your ionos account. Users who can read this file can use these password to your ionos account. Users who can read this file can use these
@ -66,63 +42,54 @@ 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 Certbot to run using these credentials can complete a ``dns-01`` challenge to
acquire new certificates or revoke existing certificates for associated acquire new certificates or revoke existing certificates for associated
domains, even if those domains aren't being managed by this server. 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 > 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 accessed by other users on your system. The warning reads "Unsafe permissions
on credentials configuration file", followed by the path to the credentials on credentials configuration file", followed by the path to the credentials
file. This warning will be emitted each time Certbot uses the credentials file, 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 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 and (e.g., by using a command like ``chmod 600`` to restrict access to the file and
``chmod 700`` to restrict access to the folder). ``chmod 700`` to restrict access to the folder).
## Examples ## Examples
To acquire a single certificate for both ``example.com`` and To acquire a single certificate for both ``example.com`` and
``*.example.com``, waiting 900 seconds for DNS propagation: ``*.example.com``, waiting 900 seconds for DNS propagation:
```bash ```bash
certbot certonly \ certbot certonly \
--authenticator dns-ionos \ --authenticator dns-ionos \
--dns-ionos-credentials /etc/letsencrypt/.secrets/domain.tld.ini \ --dns-ionos-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
--dns-ionos-propagation-seconds 900 \ --dns-ionos-propagation-seconds 900 \
--server https://acme-v02.api.letsencrypt.org/directory \ --server https://acme-v02.api.letsencrypt.org/directory \
--agree-tos \ --agree-tos \
--rsa-key-size 4096 \ --rsa-key-size 4096 \
-d 'example.com' \ -d 'example.com' \
-d '*.example.com' -d '*.example.com'
``` ```
## Docker ## Docker
In order to create a docker container with a certbot-dns-ionos installation, In order to create a docker container with a certbot-dns-ionos installation,
create an empty directory with the following ``Dockerfile``: create an empty directory with the following ``Dockerfile``:
```docker ```docker
FROM certbot/certbot
FROM certbot/certbot RUN pip install certbot-dns-ionos
RUN pip install certbot-dns-ionos
``` ```
Proceed to build the image Proceed to build the image
```docker ```docker
docker build -t certbot/dns-ionos . docker build -t certbot/dns-ionos .
``` ```
Once that's finished, the application can be run as follows:: Once that's finished, the application can be run as follows::
```docker ```docker
docker run --rm \ docker run --rm \
-v /var/lib/letsencrypt:/var/lib/letsencrypt \ -v /var/lib/letsencrypt:/var/lib/letsencrypt \
-v /etc/letsencrypt:/etc/letsencrypt \ -v /etc/letsencrypt:/etc/letsencrypt \
--cap-drop=all \ --cap-drop=all \
certbot/dns-ionos certonly \ certbot/dns-ionos certonly \
--authenticator dns-ionos \ --authenticator dns-ionos \
--dns-ionos-propagation-seconds 900 \ --dns-ionos-propagation-seconds 900 \
--dns-ionos-credentials \ --dns-ionos-credentials \
/etc/letsencrypt/.secrets/domain.tld.ini \ /etc/letsencrypt/.secrets/domain.tld.ini \
--no-self-upgrade \ --no-self-upgrade \
--keep-until-expiring --non-interactive --expand \ --keep-until-expiring --non-interactive --expand \
--server https://acme-v02.api.letsencrypt.org/directory \ --server https://acme-v02.api.letsencrypt.org/directory \
-d example.com -d '*.example.com' -d example.com -d '*.example.com'
``` ```
It is suggested to secure the folder as follows It is suggested to secure the folder as follows
```bash ```bash
@ -130,33 +97,23 @@ chown root:root /etc/letsencrypt/.secrets
chmod 700 /etc/letsencrypt/.secrets chmod 700 /etc/letsencrypt/.secrets
``` ```
The file 'domain.tld.ini' must be replaced with the version of the example 'credentials.ini' adapted to your provider. The file 'domain.tld.ini' must be replaced with the version of the example 'credentials.ini' adapted to your provider.
## Changelog ## Changelog
* 2024.10.15
- 2024.01.08 * Update README.md, changed from README.rst
* Addition of a snap
- Update README.rst * Correction in case of API error
- Add Link to IONOS control panel and reference between credentials.ini and domain.tld.ini * 2024.01.08
* Update README.rst
- 2023.11.13 * Add Link to IONOS control panel and reference between credentials.ini and domain.tld.ini
* 2023.11.13
- Fix managed zone lookup to ensure correct domain is selected where there are two domains with the same ending e.g. example.com and thisisanexample.com (PR #22) * Fix managed zone lookup to ensure correct domain is selected where there are two domains with the same ending e.g. example.com and thisisanexample.com (PR #22)
* 2022.11.24
- 2022.11.24 * Remove zope to fix compatibility with Certbot 2.x (Fixes #19)
* As a reminder, Certbot will default to issuing ECDSA certificates from release 2.0.0.
- remove zope to fix compatibility with Certbot 2.x (Fixes #19) * If you update from a prior certbot release, run the plugin once manually. You will be prompted to update RSA key type to ECDSA.
* 2022.05.15
As a reminder, Certbot will default to issuing ECDSA certificates from release 2.0.0. * Added capability to handle multiple domain validations #16
If you update from a prior certbot release, run the plugin once manually. You will be prompted * 2021.09.20.post1
to update RSA key type to ECDSA. * Fix version number
* 2021.09.20
- 2022.05.15 * Fix #9 Domain not known when using subdomain
- Added capability to handle multiple domain validations #16
- 2021.09.20.post1
- Fix version number
- 2021.09.20
- Fix #9 Domain not known when using subdomain