Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/couchtyp/certbot-dns-schlundtech
SchlundTech XML Gateway DNS Authenticator plugin for EFF's Certbot
https://github.com/couchtyp/certbot-dns-schlundtech
acme-v2 letsencrypt letsencrypt-plugin python
Last synced: 2 months ago
JSON representation
SchlundTech XML Gateway DNS Authenticator plugin for EFF's Certbot
- Host: GitHub
- URL: https://github.com/couchtyp/certbot-dns-schlundtech
- Owner: couchtyp
- License: mit
- Created: 2018-04-17T07:54:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T14:51:43.000Z (over 1 year ago)
- Last Synced: 2024-04-24T04:29:47.274Z (5 months ago)
- Topics: acme-v2, letsencrypt, letsencrypt-plugin, python
- Language: Python
- Size: 22.5 KB
- Stars: 22
- Watchers: 9
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## SchlundTech XML Gateway DNS Authenticator plugin for Certbot
The `certbot_dns_schlundtech.dns_schlundtech` plugin automates the process of
completing a ``dns-01`` challenge (`acme.challenges.DNS01`) by creating, and
subsequently removing, TXT records using the SchlundTech XML Gateway API.
### Named Arguments
| Argument | Description |
| ---: | :--- |
| `--dns-schlundtech-credentials` | SchlundTech credentials_ INI file. (Required) |
| `--dns-schlundtech-propagation-seconds` | The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 60) |
### Credentials
Use of this plugin requires a configuration file containing SchlundTech XML
Gateway API credentials:
* `user`
* `password`
* `context`
* `token`
```ini
# credentials.ini
dns_schlundtech_user = 54321
dns_schlundtech_password = PASSWORD
dns_schlundtech_context = 10
dns_schlundtech_token = SECRET-2FA-TOKEN
```
The path to this file can be provided interactively or using the
`--dns-schlundtech-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 credentials. Users who can read this file can use
these credentials to issue some types of API calls on your behalf, limited
by the permissions assigned to the account. 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 domains these
credentials are authorized to manage.
### Examples
##### To acquire a certificate for `example.com`:
```bash
certbot certonly \
--server https://acme-v02.api.letsencrypt.org/directory \
-a dns-schlundtech \
--dns-schlundtech-credentials ~/.secrets/certbot/schlundtech.ini \
-d example.com
```
##### To acquire a single certificate for both `example.com` and `www.example.com`:
```bash
certbot certonly \
--server https://acme-v02.api.letsencrypt.org/directory \
-a dns-schlundtech \
--dns-schlundtech-credentials ~/.secrets/certbot/schlundtech.ini \
-d example.com \
-d www.example.com
```
##### To acquire a certificate for `example.com`, waiting 60 seconds for DNS propagation:
```bash
certbot certonly \
--server https://acme-v02.api.letsencrypt.org/directory \
-a dns-schlundtech \
--dns-schlundtech-credentials ~/.secrets/certbot/schlundtech.ini \
--dns-schlundtech-propagation-seconds 60 \
-d example.com
```
### Using docker
Using the provided [Dockerfile](Dockerfile) you can create a docker container based on the original `certbot/certbot`
image plus this plugin. Using the *--pull* option makes sure the latest certbot image is pulled.
```bash
docker build --pull -t certbot/dns-schlundtech .
```
The resulting container image can be run with the options provided above.
```bash
docker run -it --rm \
-v /etc/letsencrypt:/etc/letsencrypt \
-v /var/lib/letsencrypt:/var/lib/letsencrypt \
-v /var/log/letsencrypt:/var/log/letsencrypt \
-v /tmp:/tmp \
certbot/dns-schlundtech \
certonly \
--server https://acme-v02.api.letsencrypt.org/directory \
-a dns-schlundtech \
--dns-schlundtech-credentials /etc/letsencrypt/schlundtech.ini \
-d example.com
```