6b7b5caf54
Instead of using comments declare info in a special variable.
Then the variable can be used to print the DNS API provider usage.
The usage can be parsed on UI and show all needed inputs for options.
The info is stored in plain string that it's both human-readable and easy to parse:
dns_example_info='API name
An extended description.
Multiline.
Domains: list of alternative domains to find
Site: the dns provider website e.g. example.com
Docs: Link to ACME.sh wiki for the provider
Options:
VARIABLE1 Title for the option1.
VARIABLE2 Title for the option2. Default "default value".
VARIABLE3 Title for the option3. Description to show on UI. Optional.
Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh
Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>;
'
Here:
VARIABLE1 will be required.
VARIABLE2 will be required too but will be populated with a "default value".
VARIABLE3 is optional and can be empty.
A DNS provider may have alternative options like CloudFlare may use API KEY or API Token.
You can use a second section OptionsAlt: section.
Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud.
Add them to Domains: section.
Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
182 lines
8.6 KiB
Bash
182 lines
8.6 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_hostingde_info='Hosting.de
|
|
Site: Hosting.de
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_hostingde
|
|
Options:
|
|
HOSTINGDE_ENDPOINT Endpoint. E.g. "https://secure.hosting.de"
|
|
HOSTINGDE_APIKEY API Key
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2058
|
|
'
|
|
|
|
######## Public functions #####################
|
|
|
|
dns_hostingde_add() {
|
|
fulldomain="${1}"
|
|
txtvalue="${2}"
|
|
_debug "Calling: _hostingde_addRecord() '${fulldomain}' '${txtvalue}'"
|
|
_hostingde_apiKey && _hostingde_getZoneConfig && _hostingde_addRecord
|
|
return $?
|
|
}
|
|
|
|
dns_hostingde_rm() {
|
|
fulldomain="${1}"
|
|
txtvalue="${2}"
|
|
_debug "Calling: _hostingde_removeRecord() '${fulldomain}' '${txtvalue}'"
|
|
_hostingde_apiKey && _hostingde_getZoneConfig && _hostingde_removeRecord
|
|
return $?
|
|
}
|
|
|
|
#################### own Private functions below ##################################
|
|
|
|
_hostingde_apiKey() {
|
|
HOSTINGDE_APIKEY="${HOSTINGDE_APIKEY:-$(_readaccountconf_mutable HOSTINGDE_APIKEY)}"
|
|
HOSTINGDE_ENDPOINT="${HOSTINGDE_ENDPOINT:-$(_readaccountconf_mutable HOSTINGDE_ENDPOINT)}"
|
|
if [ -z "$HOSTINGDE_APIKEY" ] || [ -z "$HOSTINGDE_ENDPOINT" ]; then
|
|
HOSTINGDE_APIKEY=""
|
|
HOSTINGDE_ENDPOINT=""
|
|
_err "You haven't specified hosting.de API key or endpoint yet."
|
|
_err "Please create your key and try again."
|
|
return 1
|
|
fi
|
|
|
|
_saveaccountconf_mutable HOSTINGDE_APIKEY "$HOSTINGDE_APIKEY"
|
|
_saveaccountconf_mutable HOSTINGDE_ENDPOINT "$HOSTINGDE_ENDPOINT"
|
|
}
|
|
|
|
_hostingde_parse() {
|
|
find="${1}"
|
|
if [ "${2}" ]; then
|
|
notfind="${2}"
|
|
fi
|
|
if [ "${notfind}" ]; then
|
|
_egrep_o \""${find}\":.*" | grep -v "${notfind}" | cut -d ':' -f 2 | cut -d ',' -f 1 | tr -d ' '
|
|
else
|
|
_egrep_o \""${find}\":.*" | cut -d ':' -f 2 | cut -d ',' -f 1 | tr -d ' '
|
|
fi
|
|
}
|
|
|
|
_hostingde_getZoneConfig() {
|
|
_info "Getting ZoneConfig"
|
|
curZone="${fulldomain#*.}"
|
|
returnCode=1
|
|
while _contains "${curZone}" "\\."; do
|
|
curData="{\"filter\":{\"field\":\"zoneName\",\"value\":\"${curZone}\"},\"limit\":1,\"authToken\":\"${HOSTINGDE_APIKEY}\"}"
|
|
curResult="$(_post "${curData}" "${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zoneConfigsFind")"
|
|
_debug "Calling zoneConfigsFind: '${curData}' '${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zoneConfigsFind'"
|
|
_debug "Result of zoneConfigsFind: '$curResult'"
|
|
if _contains "${curResult}" '"status": "error"'; then
|
|
if _contains "${curResult}" '"code": 10109'; then
|
|
_err "The API-Key is invalid or could not be found"
|
|
else
|
|
_err "UNKNOWN API ERROR"
|
|
fi
|
|
returnCode=1
|
|
break
|
|
fi
|
|
if _contains "${curResult}" '"totalEntries": 1'; then
|
|
_info "Retrieved zone data."
|
|
_debug "Zone data: '${curResult}'"
|
|
zoneConfigId=$(echo "${curResult}" | _hostingde_parse "id")
|
|
zoneConfigName=$(echo "${curResult}" | _hostingde_parse "name")
|
|
zoneConfigType=$(echo "${curResult}" | _hostingde_parse "type" "FindZoneConfigsResult")
|
|
zoneConfigExpire=$(echo "${curResult}" | _hostingde_parse "expire")
|
|
zoneConfigNegativeTtl=$(echo "${curResult}" | _hostingde_parse "negativeTtl")
|
|
zoneConfigRefresh=$(echo "${curResult}" | _hostingde_parse "refresh")
|
|
zoneConfigRetry=$(echo "${curResult}" | _hostingde_parse "retry")
|
|
zoneConfigTtl=$(echo "${curResult}" | _hostingde_parse "ttl")
|
|
zoneConfigDnsServerGroupId=$(echo "${curResult}" | _hostingde_parse "dnsServerGroupId")
|
|
zoneConfigEmailAddress=$(echo "${curResult}" | _hostingde_parse "emailAddress")
|
|
zoneConfigDnsSecMode=$(echo "${curResult}" | _hostingde_parse "dnsSecMode")
|
|
zoneConfigTemplateValues=$(echo "${curResult}" | _hostingde_parse "templateValues")
|
|
|
|
if [ "$zoneConfigTemplateValues" != "null" ]; then
|
|
_debug "Zone is tied to a template."
|
|
zoneConfigTemplateValuesTemplateId=$(echo "${curResult}" | _hostingde_parse "templateId")
|
|
zoneConfigTemplateValuesTemplateName=$(echo "${curResult}" | _hostingde_parse "templateName")
|
|
zoneConfigTemplateValuesTemplateReplacementsIPv4=$(echo "${curResult}" | _hostingde_parse "ipv4Replacement")
|
|
zoneConfigTemplateValuesTemplateReplacementsIPv6=$(echo "${curResult}" | _hostingde_parse "ipv6Replacement")
|
|
zoneConfigTemplateValuesTemplateReplacementsMailIPv4=$(echo "${curResult}" | _hostingde_parse "mailIpv4Replacement")
|
|
zoneConfigTemplateValuesTemplateReplacementsMailIPv6=$(echo "${curResult}" | _hostingde_parse "mailIpv6Replacement")
|
|
zoneConfigTemplateValuesTemplateTieToTemplate=$(echo "${curResult}" | _hostingde_parse "tieToTemplate")
|
|
|
|
zoneConfigTemplateValues="{\"templateId\":${zoneConfigTemplateValuesTemplateId},\"templateName\":${zoneConfigTemplateValuesTemplateName},\"templateReplacements\":{\"ipv4Replacement\":${zoneConfigTemplateValuesTemplateReplacementsIPv4},\"ipv6Replacement\":${zoneConfigTemplateValuesTemplateReplacementsIPv6},\"mailIpv4Replacement\":${zoneConfigTemplateValuesTemplateReplacementsMailIPv4},\"mailIpv6Replacement\":${zoneConfigTemplateValuesTemplateReplacementsMailIPv6}},\"tieToTemplate\":${zoneConfigTemplateValuesTemplateTieToTemplate}}"
|
|
_debug "Template values: '{$zoneConfigTemplateValues}'"
|
|
fi
|
|
|
|
if [ "${zoneConfigType}" != "\"NATIVE\"" ]; then
|
|
_err "Zone is not native"
|
|
returnCode=1
|
|
break
|
|
fi
|
|
_debug "zoneConfigId '${zoneConfigId}'"
|
|
returnCode=0
|
|
break
|
|
fi
|
|
curZone="${curZone#*.}"
|
|
done
|
|
if [ $returnCode -ne 0 ]; then
|
|
_info "ZoneEnd reached, Zone ${curZone} not found in hosting.de API"
|
|
fi
|
|
return $returnCode
|
|
}
|
|
|
|
_hostingde_getZoneStatus() {
|
|
_debug "Checking Zone status"
|
|
curData="{\"filter\":{\"field\":\"zoneConfigId\",\"value\":${zoneConfigId}},\"limit\":1,\"authToken\":\"${HOSTINGDE_APIKEY}\"}"
|
|
curResult="$(_post "${curData}" "${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zonesFind")"
|
|
_debug "Calling zonesFind '${curData}' '${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zonesFind'"
|
|
_debug "Result of zonesFind '$curResult'"
|
|
zoneStatus=$(echo "${curResult}" | _hostingde_parse "status" "success")
|
|
_debug "zoneStatus '${zoneStatus}'"
|
|
return 0
|
|
}
|
|
|
|
_hostingde_addRecord() {
|
|
_info "Adding record to zone"
|
|
_hostingde_getZoneStatus
|
|
_debug "Result of zoneStatus: '${zoneStatus}'"
|
|
while [ "${zoneStatus}" != "\"active\"" ]; do
|
|
_sleep 5
|
|
_hostingde_getZoneStatus
|
|
_debug "Result of zoneStatus: '${zoneStatus}'"
|
|
done
|
|
curData="{\"authToken\":\"${HOSTINGDE_APIKEY}\",\"zoneConfig\":{\"id\":${zoneConfigId},\"name\":${zoneConfigName},\"type\":${zoneConfigType},\"dnsServerGroupId\":${zoneConfigDnsServerGroupId},\"dnsSecMode\":${zoneConfigDnsSecMode},\"emailAddress\":${zoneConfigEmailAddress},\"soaValues\":{\"expire\":${zoneConfigExpire},\"negativeTtl\":${zoneConfigNegativeTtl},\"refresh\":${zoneConfigRefresh},\"retry\":${zoneConfigRetry},\"ttl\":${zoneConfigTtl}},\"templateValues\":${zoneConfigTemplateValues}},\"recordsToAdd\":[{\"name\":\"${fulldomain}\",\"type\":\"TXT\",\"content\":\"\\\"${txtvalue}\\\"\",\"ttl\":3600}]}"
|
|
curResult="$(_post "${curData}" "${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zoneUpdate")"
|
|
_debug "Calling zoneUpdate: '${curData}' '${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zoneUpdate'"
|
|
_debug "Result of zoneUpdate: '$curResult'"
|
|
if _contains "${curResult}" '"status": "error"'; then
|
|
if _contains "${curResult}" '"code": 10109'; then
|
|
_err "The API-Key is invalid or could not be found"
|
|
else
|
|
_err "UNKNOWN API ERROR"
|
|
fi
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
_hostingde_removeRecord() {
|
|
_info "Removing record from zone"
|
|
_hostingde_getZoneStatus
|
|
_debug "Result of zoneStatus: '$zoneStatus'"
|
|
while [ "$zoneStatus" != "\"active\"" ]; do
|
|
_sleep 5
|
|
_hostingde_getZoneStatus
|
|
_debug "Result of zoneStatus: '$zoneStatus'"
|
|
done
|
|
curData="{\"authToken\":\"${HOSTINGDE_APIKEY}\",\"zoneConfig\":{\"id\":${zoneConfigId},\"name\":${zoneConfigName},\"type\":${zoneConfigType},\"dnsServerGroupId\":${zoneConfigDnsServerGroupId},\"dnsSecMode\":${zoneConfigDnsSecMode},\"emailAddress\":${zoneConfigEmailAddress},\"soaValues\":{\"expire\":${zoneConfigExpire},\"negativeTtl\":${zoneConfigNegativeTtl},\"refresh\":${zoneConfigRefresh},\"retry\":${zoneConfigRetry},\"ttl\":${zoneConfigTtl}},\"templateValues\":${zoneConfigTemplateValues}},\"recordsToDelete\":[{\"name\":\"${fulldomain}\",\"type\":\"TXT\",\"content\":\"\\\"${txtvalue}\\\"\"}]}"
|
|
curResult="$(_post "${curData}" "${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zoneUpdate")"
|
|
_debug "Calling zoneUpdate: '${curData}' '${HOSTINGDE_ENDPOINT}/api/dns/v1/json/zoneUpdate'"
|
|
_debug "Result of zoneUpdate: '$curResult'"
|
|
if _contains "${curResult}" '"status": "error"'; then
|
|
if _contains "${curResult}" '"code": 10109'; then
|
|
_err "The API-Key is invalid or could not be found"
|
|
else
|
|
_err "UNKNOWN API ERROR"
|
|
fi
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|