From 207256ad6666650d61854e2bbbefdfd16716eeb8 Mon Sep 17 00:00:00 2001 From: Maximilian Senftleben Date: Thu, 22 Sep 2022 23:55:32 +0200 Subject: [PATCH] Added do (domainoffensive) validation plugin for certbot. closes #262 # Conflicts: # readme-vars.yml # root/etc/cont-init.d/50-certbot --- Dockerfile | 1 + Dockerfile.aarch64 | 1 + Dockerfile.armhf | 1 + readme-vars.yml | 3 ++- root/defaults/dns-conf/do.ini | 3 +++ root/etc/cont-init.d/50-certbot | 5 +++-- 6 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 root/defaults/dns-conf/do.ini diff --git a/Dockerfile b/Dockerfile index ae0bedc..c2d35a7 100755 --- a/Dockerfile +++ b/Dockerfile @@ -114,6 +114,7 @@ RUN \ certbot-dns-dnsimple \ certbot-dns-dnsmadeeasy \ certbot-dns-dnspod \ + certbot-dns-do \ certbot-dns-domeneshop \ certbot-dns-dynu \ certbot-dns-google \ diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64 index 0099bd8..acef2e0 100755 --- a/Dockerfile.aarch64 +++ b/Dockerfile.aarch64 @@ -114,6 +114,7 @@ RUN \ certbot-dns-dnsimple \ certbot-dns-dnsmadeeasy \ certbot-dns-dnspod \ + certbot-dns-do \ certbot-dns-domeneshop \ certbot-dns-dynu \ certbot-dns-google \ diff --git a/Dockerfile.armhf b/Dockerfile.armhf index ba78601..741e9e1 100755 --- a/Dockerfile.armhf +++ b/Dockerfile.armhf @@ -115,6 +115,7 @@ RUN \ certbot-dns-dnsmadeeasy \ certbot-dns-dnspod \ certbot-dns-domeneshop \ + certbot-dns-do \ certbot-dns-dynu \ certbot-dns-google \ certbot-dns-he \ diff --git a/readme-vars.yml b/readme-vars.yml index 979b968..3b63448 100755 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -51,7 +51,7 @@ opt_param_usage_include_env: true opt_param_env_vars: - { env_var: "SUBDOMAINS", env_value: "www,", desc: "Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` (wildcard cert is available via `dns` and `duckdns` validation only)" } - { env_var: "CERTPROVIDER", env_value: "", desc: "Optionally define the cert provider. Set to `zerossl` for ZeroSSL certs (requires existing [ZeroSSL account](https://app.zerossl.com/signup) and the e-mail address entered in `EMAIL` env var). Otherwise defaults to Let's Encrypt." } - - { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `acmedns`,`aliyun`, `azure`, `cloudflare`, `cloudxns`, `cpanel`, `desec`, `digitalocean`, `directadmin`, `dnsimple`, `dnsmadeeasy`, `dnspod`, `domeneshop`, `dynu`, `gandi`, `gehirn`, `google`, `he`, `hetzner`, `infomaniak`, `inwx`, `ionos`, `linode`, `loopia`, `luadns`, `netcup`, `njalla`, `nsone`, `ovh`, `rfc2136`, `route53`, `sakuracloud`, `standalone`, `transip` and `vultr`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`." } + - { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `acmedns`,`aliyun`, `azure`, `cloudflare`, `cloudxns`, `cpanel`, `desec`, `digitalocean`, `directadmin`, `dnsimple`, `dnsmadeeasy`, `dnspod`, `do`, `domeneshop`, `dynu`, `gandi`, `gehirn`, `google`, `he`, `hetzner`, `infomaniak`, `inwx`, `ionos`, `linode`, `loopia`, `luadns`, `netcup`, `njalla`, `nsone`, `ovh`, `rfc2136`, `route53`, `sakuracloud`, `standalone`, `transip` and `vultr`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`." } - { env_var: "PROPAGATION", env_value: "", desc: "Optionally override (in seconds) the default propagation time for the dns plugins." } - { env_var: "DUCKDNSTOKEN", env_value: "", desc: "Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org" } - { env_var: "EMAIL", env_value: "", desc: "Optional e-mail address used for cert expiration notifications (Required for ZeroSSL)." } @@ -155,6 +155,7 @@ app_setup_nginx_reverse_proxy_block: "" # changelog changelogs: + - { date: "22.09.22:", desc: "Added support for DO DNS validation." } - { date: "22.09.22:", desc: "Added certbot-dns-acmedns for DNS01 validation." } - { date: "20.08.22:", desc: "[Existing users should update:](https://github.com/linuxserver/docker-swag/blob/master/README.md#updating-configs) nginx.conf - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))." } - { date: "10.08.22:", desc: "Added support for Dynu DNS validation." } diff --git a/root/defaults/dns-conf/do.ini b/root/defaults/dns-conf/do.ini new file mode 100644 index 0000000..4a170b5 --- /dev/null +++ b/root/defaults/dns-conf/do.ini @@ -0,0 +1,3 @@ +# Instructions: https://github.com/georgeto/certbot-dns-do/blob/master/certbot_dns_do/__init__.py#L32 +# Replace with your values +dns_do_api_token = YOUR_DO_LETSENCRYPT_API_KEY diff --git a/root/etc/cont-init.d/50-certbot b/root/etc/cont-init.d/50-certbot index 89a480e..f73968c 100644 --- a/root/etc/cont-init.d/50-certbot +++ b/root/etc/cont-init.d/50-certbot @@ -28,9 +28,10 @@ cp -n /defaults/dns-conf/* /config/dns-conf/ chown -R abc:abc /config/dns-conf # check to make sure DNSPLUGIN is selected if dns validation is used -if [[ "$VALIDATION" = "dns" ]] && [[ ! "$DNSPLUGIN" =~ ^(acmedns|aliyun|azure|cloudflare|cloudxns|cpanel|desec|digitalocean|directadmin|dnsimple|dnsmadeeasy|dnspod|domeneshop|dynu|gandi|gehirn|google|he|hetzner|infomaniak|inwx|ionos|linode|loopia|luadns|netcup|njalla|nsone|ovh|rfc2136|route53|sakuracloud|standalone|transip|vultr)$ ]]; then +if [[ "$VALIDATION" = "dns" ]] && [[ ! "$DNSPLUGIN" =~ ^(acmedns|aliyun|azure|cloudflare|cloudxns|cpanel|desec|digitalocean|directadmin|dnsimple|dnsmadeeasy|dnspod|do|domeneshop|dynu|gandi|gehirn|google|he|hetzner|infomaniak|inwx|ionos|linode|loopia|luadns|netcup|njalla|nsone|ovh|rfc2136|route53|sakuracloud|standalone|transip|vultr)$ ]]; then echo "Please set the DNSPLUGIN variable to a valid plugin name. See docker info for more details." sleep infinity + fi # create original config file if it doesn't exist, move non-hidden legacy file to hidden @@ -139,7 +140,7 @@ if [ "$VALIDATION" = "dns" ]; then elif [[ "$DNSPLUGIN" =~ ^(google)$ ]]; then if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--dns-${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi PREFCHAL="--dns-${DNSPLUGIN} --dns-${DNSPLUGIN}-credentials /config/dns-conf/${DNSPLUGIN}.json ${PROPAGATIONPARAM}" - elif [[ "$DNSPLUGIN" =~ ^(aliyun|desec|dnspod|domeneshop|dynu|he|hetzner|infomaniak|inwx|ionos|loopia|netcup|njalla|transip|vultr)$ ]]; then + elif [[ "$DNSPLUGIN" =~ ^(aliyun|desec|dnspod|do|domeneshop|dynu|he|hetzner|infomaniak|inwx|ionos|loopia|netcup|njalla|transip|vultr)$ ]]; then if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--dns-${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi PREFCHAL="-a dns-${DNSPLUGIN} --dns-${DNSPLUGIN}-credentials /config/dns-conf/${DNSPLUGIN}.ini ${PROPAGATIONPARAM}" elif [[ "$DNSPLUGIN" =~ ^(standalone)$ ]]; then