Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

letsencrypt: add support for Synergy Wholesale DNS challenge #3898

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+42 −2
Open

letsencrypt: add support for Synergy Wholesale DNS challenge #3898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15ac8b6
letsencrypt: add support for Synergy Wholesale DNS challenge
devbobo Jan 18, 2025
766a74d
letsencrypt: add support for Synergy Wholesale DNS challenge
devbobo Jan 18, 2025
5555d58
update docs for readability
devbobo Jan 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions letsencrypt/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 5.2.11

- Add Synergy Wholesale DNS support

## 5.2.10

- Add transip global_key parameter to config.yaml
Expand Down
23 changes: 23 additions & 0 deletions letsencrypt/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ dns-mijn-host
dns-njalla
dns-noris
dns-simply
dns-synergy-wholesale
dns-nsone
dns-ovh
dns-rfc2136
Expand Down Expand Up @@ -165,6 +166,8 @@ plesk_password: ''
plesk_api_url: ''
simply_account_name: ''
simply_api_key: ''
synergy_wholesale_reseller_id: ''
synergy_wholesale_api_key: ''
```
</details>

Expand Down Expand Up @@ -1083,6 +1086,26 @@ The API key assigned to your Simply.com account can be found in your Simply.com

</details>

<details>
<summary>Synergy Wholesale</summary>

To use a domain with this challenge, enable API access on your account. To
do this, go to Account Functions -> select the API Information and click the Enable API button.
Note: You must whitelist the IP address from where the certbot will run.

```yaml
email: [email protected]
domains:
- your.domain.tld
certfile: fullchain.pem
keyfile: privkey.pem
challenge: dns
dns:
provider: dns-synergy-wholesale
synergy_wholesale_reseller_id: 1234
synergy_wholesale_api_key: 0123456789abcdef0123456789abcdef01234
Comment on lines +1104 to +1106
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add information about obtaining the reseller ID.

Please add instructions on where users can find their reseller ID in the Synergy Wholesale control panel.

🧰 Tools
🪛 Gitleaks (8.21.2)

1106-1106: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

```
</details>

<details>
<summary>mijn.host DNS challenge</summary>
Expand Down
2 changes: 2 additions & 0 deletions letsencrypt/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ ARG \
CERTBOT_DNS_NAMECHEAP_VERSION \
CERTBOT_DNS_NORISNETWORK_VERSION \
CERTBOT_DNS_SIMPLY_VERSION \
CERTBOT_DNS_SYNERGY_WHOLESALE_VERSION \
CERTBOT_DNS_TRANSIP_VERSION \
CERTBOT_DNS_PORKBUN_VERSION \
CERTBOT_DNS_WEBSUPPORT_VERSION \
Expand Down Expand Up @@ -85,6 +86,7 @@ RUN \
certbot-dns-sakuracloud==${CERTBOT_VERSION} \
certbot-dns-namecheap==${CERTBOT_DNS_NAMECHEAP_VERSION} \
certbot-dns-simply==${CERTBOT_DNS_SIMPLY_VERSION} \
certbot-dns-synergy-wholesale==${CERTBOT_DNS_SYNERGY_WHOLESALE_VERSION} \
certbot-dns-netcup==${CERTBOT_NETCUP_VERSION} \
certbot-plugin-gandi==${CERTBOT_GANDI_VERSION} \
certbot-dns-transip==${CERTBOT_DNS_TRANSIP_VERSION} \
Expand Down
1 change: 1 addition & 0 deletions letsencrypt/build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ args:
CERTBOT_DNS_PORKBUN_VERSION: 0.8.0
CERTBOT_DNS_WEBSUPPORT_VERSION: 2.0.1
CERTBOT_DNS_SIMPLY_VERSION: 0.1.2
CERTBOT_DNS_SYNERGY_WHOLESALE_VERSION: 1.0.0
CERTBOT_GANDI_VERSION: 1.5.0
CERTBOT_NETCUP_VERSION: 1.4.3
CERTBOT_NJALLA_VERSION: 1.0.0
Expand Down
6 changes: 4 additions & 2 deletions letsencrypt/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: 5.2.10
version: 5.2.11
slug: letsencrypt
name: Let's Encrypt
description: Manage certificate from Let's Encrypt
Expand Down Expand Up @@ -93,6 +93,8 @@ schema:
netcup_customer_id: str?
simply_api_key: str?
simply_account_name: str?
synergy_wholesale_reseller_id: int?
synergy_wholesale_api_key: str?
njalla_token: str?
noris_token: str?
nsone_api_key: str?
Expand All @@ -110,7 +112,7 @@ schema:
dns-mijn-host|dns-njalla|dns-nsone|dns-porkbun|dns-ovh|dns-rfc2136|dns-route53|\
dns-sakuracloud|dns-namecheap|dns-netcup|dns-simply|dns-gandi|dns-transip|dns-inwx|\
dns-dreamhost|dns-he|dns-easydns|dns-domainoffensive|dns-websupport|dns-noris|\
dns-plesk)?"
dns-plesk|dns-synergy-wholesale)?"
rfc2136_algorithm: str?
rfc2136_name: str?
rfc2136_port: str?
Expand Down
2 changes: 2 additions & 0 deletions letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ echo -e "dns_desec_token = $(bashio::config 'dns.desec_token')\n" \
"dns_netcup_api_password = $(bashio::config 'dns.netcup_api_password')\n" \
"dns_simply_account_name = $(bashio::config 'dns.simply_account_name')\n" \
"dns_simply_api_key = $(bashio::config 'dns.simply_api_key')\n" \
"dns_synergy_wholesale_reseller_id = $(bashio::config 'dns.synergy_wholesale_reseller_id')\n" \
"dns_synergy_wholesale_api_key = $(bashio::config 'dns.synergy_wholesale_api_key')\n" \
"dns_njalla_token = $(bashio::config 'dns.njalla_token')\n" \
"dns_noris_token = $(bashio::config 'dns.noris_token')\n" \
"dns_nsone_api_key = $(bashio::config 'dns.nsone_api_key')\n" \
Expand Down
6 changes: 6 additions & 0 deletions letsencrypt/rootfs/etc/services.d/lets-encrypt/run
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,12 @@ elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-njalla" ]; then
elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-rfc2136" ]; then
PROVIDER_ARGUMENTS+=("--${DNS_PROVIDER}" "--${DNS_PROVIDER}-credentials" "/data/dnsapikey" "--dns-rfc2136-propagation-seconds" "${PROPAGATION_SECONDS}")

#Synergy Wholesale
elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-synergy-wholesale" ]; then
bashio::config.require 'dns.synergy_wholesale_reseller_id'
bashio::config.require 'dns.synergy_wholesale_api_key'
PROVIDER_ARGUMENTS+=("--authenticator" "${DNS_PROVIDER}" "--${DNS_PROVIDER}-credentials" "/data/dnsapikey" "--${DNS_PROVIDER}-propagation-seconds" "${PROPAGATION_SECONDS}")

# Azure
elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-azure" ]; then
bashio::config.require 'dns.azure_config'
Expand Down