3 # This is the OpenProvider API wrapper for acme.sh
5 # Author: Sylvia van Os
6 # Report Bugs here: https://github.com/acmesh-official/acme.sh/issues/2104
8 # export OPENPROVIDER_USER="username"
9 # export OPENPROVIDER_PASSWORDHASH="hashed_password"
12 # acme.sh --issue --dns dns_openprovider -d example.com
14 OPENPROVIDER_API
="https://api.openprovider.eu/"
15 #OPENPROVIDER_API="https://api.cte.openprovider.eu/" # Test API
17 ######## Public functions #####################
19 #Usage: dns_openprovider_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
20 dns_openprovider_add
() {
24 OPENPROVIDER_USER
="${OPENPROVIDER_USER:-$(_readaccountconf_mutable OPENPROVIDER_USER)}"
25 OPENPROVIDER_PASSWORDHASH
="${OPENPROVIDER_PASSWORDHASH:-$(_readaccountconf_mutable OPENPROVIDER_PASSWORDHASH)}"
27 if [ -z "$OPENPROVIDER_USER" ] ||
[ -z "$OPENPROVIDER_PASSWORDHASH" ]; then
28 _err
"You didn't specify the openprovider user and/or password hash."
32 # save the username and password to the account conf file.
33 _saveaccountconf_mutable OPENPROVIDER_USER
"$OPENPROVIDER_USER"
34 _saveaccountconf_mutable OPENPROVIDER_PASSWORDHASH
"$OPENPROVIDER_PASSWORDHASH"
36 _debug
"First detect the root zone"
37 if ! _get_root
"$fulldomain"; then
42 _debug _domain_name
"$_domain_name"
43 _debug _domain_extension
"$_domain_extension"
45 _debug
"Getting current records"
49 _openprovider_request
"$(printf '<searchZoneRecordDnsRequest><name>%s.%s</name><offset>%s</offset></searchZoneRecordDnsRequest>' "$_domain_name" "$_domain_extension" "$results_retrieved")"
53 item
="$(echo "$items" | _egrep_o '<openXML>.*<\/openXML>' | sed -n 's/.*\(<item>.*<\/item>\).*/\1/p')"
54 _debug existing_items
"$existing_items"
55 _debug results_retrieved
"$results_retrieved"
58 if [ -z "$item" ]; then
62 items
="$(echo "$items" | sed "s|
${item}||
")"
64 results_retrieved
="$(_math "$results_retrieved" + 1)"
65 new_item
="$(echo "$item" | sed -n 's/.*<item>.*\(<name>\(.*\)\.'"$_domain_name"'\.'"$_domain_extension"'<\/name>.*\(<type>.*<\/type>\).*\(<value>.*<\/value>\).*\(<prio>.*<\/prio>\).*\(<ttl>.*<\/ttl>\)\).*<\/item>.*/<item><name>\2<\/name>\3\4\5\6<\/item>/p')"
66 if [ -z "$new_item" ]; then
68 new_item
="$(echo "$item" | sed -n 's/.*<item>.*\(<name>\(.*\)'"$_domain_name"'\.'"$_domain_extension"'<\/name>.*\(<type>.*<\/type>\).*\(<value>.*<\/value>\).*\(<prio>.*<\/prio>\).*\(<ttl>.*<\/ttl>\)\).*<\/item>.*/<item><name>\2<\/name>\3\4\5\6<\/item>/p')"
71 if [ -z "$(echo "$new_item" | _egrep_o ".
*<type>(A|AAAA|CNAME|MX|SPF|SRV|TXT|TLSA|SSHFP|CAA
)<\
/type>.
*")" ]; then
72 _debug
"not an allowed record type, skipping" "$new_item"
76 existing_items
="$existing_items$new_item"
79 total
="$(echo "$response" | _egrep_o '<total>.*?<\/total>' | sed -n 's/.*<total>\(.*\)<\/total>.*/\1/p')"
82 if [ "$results_retrieved" -eq "$total" ]; then
87 _debug
"Creating acme record"
88 acme_record
="$(echo "$fulldomain" | sed -e "s
/.
$_domain_name.
$_domain_extension$
//")"
89 _openprovider_request
"$(printf '<modifyZoneDnsRequest><domain><name>%s</name><extension>%s</extension></domain><type>master</type><records><array>%s<item><name>%s</name><type>TXT</type><value>%s</value><ttl>86400</ttl></item></array></records></modifyZoneDnsRequest>' "$_domain_name" "$_domain_extension" "$existing_items" "$acme_record" "$txtvalue")"
94 #Usage: fulldomain txtvalue
95 #Remove the txt record after validation.
96 dns_openprovider_rm
() {
100 OPENPROVIDER_USER
="${OPENPROVIDER_USER:-$(_readaccountconf_mutable OPENPROVIDER_USER)}"
101 OPENPROVIDER_PASSWORDHASH
="${OPENPROVIDER_PASSWORDHASH:-$(_readaccountconf_mutable OPENPROVIDER_PASSWORDHASH)}"
103 if [ -z "$OPENPROVIDER_USER" ] ||
[ -z "$OPENPROVIDER_PASSWORDHASH" ]; then
104 _err
"You didn't specify the openprovider user and/or password hash."
108 # save the username and password to the account conf file.
109 _saveaccountconf_mutable OPENPROVIDER_USER
"$OPENPROVIDER_USER"
110 _saveaccountconf_mutable OPENPROVIDER_PASSWORDHASH
"$OPENPROVIDER_PASSWORDHASH"
112 _debug
"First detect the root zone"
113 if ! _get_root
"$fulldomain"; then
114 _err
"invalid domain"
118 _debug _domain_name
"$_domain_name"
119 _debug _domain_extension
"$_domain_extension"
121 _debug
"Getting current records"
125 _openprovider_request
"$(printf '<searchZoneRecordDnsRequest><name>%s.%s</name><offset>%s</offset></searchZoneRecordDnsRequest>' "$_domain_name" "$_domain_extension" "$results_retrieved")"
127 # Remove acme records from items
130 item
="$(echo "$items" | _egrep_o '<openXML>.*<\/openXML>' | sed -n 's/.*\(<item>.*<\/item>\).*/\1/p')"
131 _debug existing_items
"$existing_items"
132 _debug results_retrieved
"$results_retrieved"
135 if [ -z "$item" ]; then
139 items
="$(echo "$items" | sed "s|
${item}||
")"
141 results_retrieved
="$(_math "$results_retrieved" + 1)"
142 if ! echo "$item" |
grep -v "$fulldomain"; then
143 _debug
"acme record, skipping" "$item"
147 new_item
="$(echo "$item" | sed -n 's/.*<item>.*\(<name>\(.*\)\.'"$_domain_name"'\.'"$_domain_extension"'<\/name>.*\(<type>.*<\/type>\).*\(<value>.*<\/value>\).*\(<prio>.*<\/prio>\).*\(<ttl>.*<\/ttl>\)\).*<\/item>.*/<item><name>\2<\/name>\3\4\5\6<\/item>/p')"
149 if [ -z "$new_item" ]; then
151 new_item
="$(echo "$item" | sed -n 's/.*<item>.*\(<name>\(.*\)'"$_domain_name"'\.'"$_domain_extension"'<\/name>.*\(<type>.*<\/type>\).*\(<value>.*<\/value>\).*\(<prio>.*<\/prio>\).*\(<ttl>.*<\/ttl>\)\).*<\/item>.*/<item><name>\2<\/name>\3\4\5\6<\/item>/p')"
154 if [ -z "$(echo "$new_item" | _egrep_o ".
*<type>(A|AAAA|CNAME|MX|SPF|SRV|TXT|TLSA|SSHFP|CAA
)<\
/type>.
*")" ]; then
155 _debug
"not an allowed record type, skipping" "$new_item"
159 existing_items
="$existing_items$new_item"
162 total
="$(echo "$response" | _egrep_o '<total>.*?<\/total>' | sed -n 's/.*<total>\(.*\)<\/total>.*/\1/p')"
164 _debug total
"$total"
166 if [ "$results_retrieved" -eq "$total" ]; then
171 _debug
"Removing acme record"
172 _openprovider_request
"$(printf '<modifyZoneDnsRequest><domain><name>%s</name><extension>%s</extension></domain><type>master</type><records><array>%s</array></records></modifyZoneDnsRequest>' "$_domain_name" "$_domain_extension" "$existing_items")"
177 #################### Private functions below ##################################
178 #_acme-challenge.www.domain.com
180 # _domain_name=domain
181 # _domain_extension=com
188 h
=$
(echo "$domain" | cut
-d .
-f $i-100)
195 _openprovider_request
"$(printf '<searchDomainRequest><domainNamePattern>%s</domainNamePattern><offset>%s</offset></searchDomainRequest>' "$
(echo "$h" | cut
-d .
-f 1)" "$results_retrieved")"
199 item
="$(echo "$items" | _egrep_o '<openXML>.*<\/openXML>' | sed -n 's/.*\(<domain>.*<\/domain>\).*/\1/p')"
200 _debug existing_items
"$existing_items"
201 _debug results_retrieved
"$results_retrieved"
204 if [ -z "$item" ]; then
208 items
="$(echo "$items" | sed "s|
${item}||
")"
210 results_retrieved
="$(_math "$results_retrieved" + 1)"
212 _domain_name
="$(echo "$item" | sed -n 's/.*<domain>.*<name>\(.*\)<\/name>.*<\/domain>.*/\1/p')"
213 _domain_extension
="$(echo "$item" | sed -n 's/.*<domain>.*<extension>\(.*\)<\/extension>.*<\/domain>.*/\1/p')"
214 _debug _domain_name
"$_domain_name"
215 _debug _domain_extension
"$_domain_extension"
216 if [ "$_domain_name.$_domain_extension" = "$h" ]; then
221 total
="$(echo "$response" | _egrep_o '<total>.*?<\/total>' | sed -n 's/.*<total>\(.*\)<\/total>.*/\1/p')"
223 _debug total
"$total"
225 if [ "$results_retrieved" -eq "$total" ]; then
227 i
="$(_math "$i" + 1)"
233 _openprovider_request
() {
236 xml_prefix
='<?xml version="1.0" encoding="UTF-8"?>'
237 xml_content
=$
(printf '<openXML><credentials><username>%s</username><hash>%s</hash></credentials>%s</openXML>' "$OPENPROVIDER_USER" "$OPENPROVIDER_PASSWORDHASH" "$request_xml")
238 response
="$(_post "$
(echo "$xml_prefix$xml_content" |
tr -d '\n')" "$OPENPROVIDER_API" "" "POST
" "application
/xml
")"
239 _debug response
"$response"
240 if ! _contains
"$response" "<openXML><reply><code>0</code>.*</reply></openXML>"; then
241 _err
"API request failed."