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>
292 lines
8.4 KiB
Bash
292 lines
8.4 KiB
Bash
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_jd_info='jdcloud.com
|
|
Site: jdcloud.com
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi2#dns_jd
|
|
Options:
|
|
JD_ACCESS_KEY_ID Access key ID
|
|
JD_ACCESS_KEY_SECRET Access key secret
|
|
JD_REGION Region. E.g. "cn-north-1"
|
|
Issues: github.com/acmesh-official/acme.sh/issues/2388
|
|
'
|
|
|
|
_JD_ACCOUNT="https://uc.jdcloud.com/account/accesskey"
|
|
|
|
_JD_PROD="clouddnsservice"
|
|
_JD_API="jdcloud-api.com"
|
|
|
|
_JD_API_VERSION="v1"
|
|
_JD_DEFAULT_REGION="cn-north-1"
|
|
|
|
_JD_HOST="$_JD_PROD.$_JD_API"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_myapi_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_jd_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
JD_ACCESS_KEY_ID="${JD_ACCESS_KEY_ID:-$(_readaccountconf_mutable JD_ACCESS_KEY_ID)}"
|
|
JD_ACCESS_KEY_SECRET="${JD_ACCESS_KEY_SECRET:-$(_readaccountconf_mutable JD_ACCESS_KEY_SECRET)}"
|
|
JD_REGION="${JD_REGION:-$(_readaccountconf_mutable JD_REGION)}"
|
|
|
|
if [ -z "$JD_ACCESS_KEY_ID" ] || [ -z "$JD_ACCESS_KEY_SECRET" ]; then
|
|
JD_ACCESS_KEY_ID=""
|
|
JD_ACCESS_KEY_SECRET=""
|
|
_err "You haven't specifed the jdcloud api key id or api key secret yet."
|
|
_err "Please create your key and try again. see $(__green $_JD_ACCOUNT)"
|
|
return 1
|
|
fi
|
|
|
|
_saveaccountconf_mutable JD_ACCESS_KEY_ID "$JD_ACCESS_KEY_ID"
|
|
_saveaccountconf_mutable JD_ACCESS_KEY_SECRET "$JD_ACCESS_KEY_SECRET"
|
|
if [ -z "$JD_REGION" ]; then
|
|
_debug "Using default region: $_JD_DEFAULT_REGION"
|
|
JD_REGION="$_JD_DEFAULT_REGION"
|
|
else
|
|
_saveaccountconf_mutable JD_REGION "$JD_REGION"
|
|
fi
|
|
_JD_BASE_URI="$_JD_API_VERSION/regions/$JD_REGION"
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _domain_id "$_domain_id"
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
#_debug "Getting getViewTree"
|
|
|
|
_debug "Adding records"
|
|
|
|
_addrr="{\"req\":{\"hostRecord\":\"$_sub_domain\",\"hostValue\":\"$txtvalue\",\"ttl\":300,\"type\":\"TXT\",\"viewValue\":-1},\"regionId\":\"$JD_REGION\",\"domainId\":\"$_domain_id\"}"
|
|
#_addrr='{"req":{"hostRecord":"xx","hostValue":"\"value4\"","jcloudRes":false,"mxPriority":null,"port":null,"ttl":300,"type":"TXT","weight":null,"viewValue":-1},"regionId":"cn-north-1","domainId":"8824"}'
|
|
if jd_rest POST "domain/$_domain_id/RRAdd" "" "$_addrr"; then
|
|
_rid="$(echo "$response" | tr '{},' '\n' | grep '"id":' | cut -d : -f 2)"
|
|
if [ -z "$_rid" ]; then
|
|
_err "Can not find record id from the result."
|
|
return 1
|
|
fi
|
|
_info "TXT record added successfully."
|
|
_srid="$(_readdomainconf "JD_CLOUD_RIDS")"
|
|
if [ "$_srid" ]; then
|
|
_rid="$_srid,$_rid"
|
|
fi
|
|
_savedomainconf "JD_CLOUD_RIDS" "$_rid"
|
|
return 0
|
|
fi
|
|
|
|
return 1
|
|
}
|
|
|
|
dns_jd_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
JD_ACCESS_KEY_ID="${JD_ACCESS_KEY_ID:-$(_readaccountconf_mutable JD_ACCESS_KEY_ID)}"
|
|
JD_ACCESS_KEY_SECRET="${JD_ACCESS_KEY_SECRET:-$(_readaccountconf_mutable JD_ACCESS_KEY_SECRET)}"
|
|
JD_REGION="${JD_REGION:-$(_readaccountconf_mutable JD_REGION)}"
|
|
|
|
if [ -z "$JD_REGION" ]; then
|
|
_debug "Using default region: $_JD_DEFAULT_REGION"
|
|
JD_REGION="$_JD_DEFAULT_REGION"
|
|
fi
|
|
|
|
_JD_BASE_URI="$_JD_API_VERSION/regions/$JD_REGION"
|
|
|
|
_info "Getting existing records for $fulldomain"
|
|
_srid="$(_readdomainconf "JD_CLOUD_RIDS")"
|
|
_debug _srid "$_srid"
|
|
|
|
if [ -z "$_srid" ]; then
|
|
_err "Not rid skip"
|
|
return 0
|
|
fi
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
return 1
|
|
fi
|
|
_debug _domain_id "$_domain_id"
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
_cleardomainconf JD_CLOUD_RIDS
|
|
|
|
_aws_tmpl_xml="{\"ids\":[$_srid],\"action\":\"del\",\"regionId\":\"$JD_REGION\",\"domainId\":\"$_domain_id\"}"
|
|
|
|
if jd_rest POST "domain/$_domain_id/RROperate" "" "$_aws_tmpl_xml" && _contains "$response" "\"code\":\"OK\""; then
|
|
_info "TXT record deleted successfully."
|
|
return 0
|
|
fi
|
|
return 1
|
|
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
_get_root() {
|
|
domain=$1
|
|
i=1
|
|
p=1
|
|
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
|
|
_debug2 "Checking domain: $h"
|
|
if ! jd_rest GET "domain"; then
|
|
_err "error get domain list"
|
|
return 1
|
|
fi
|
|
if [ -z "$h" ]; then
|
|
#not valid
|
|
_err "Invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "\"domainName\":\"$h\""; then
|
|
hostedzone="$(echo "$response" | tr '{}' '\n' | grep "\"domainName\":\"$h\"")"
|
|
_debug hostedzone "$hostedzone"
|
|
if [ "$hostedzone" ]; then
|
|
_domain_id="$(echo "$hostedzone" | tr ',' '\n' | grep "\"id\":" | cut -d : -f 2)"
|
|
if [ "$_domain_id" ]; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_domain=$h
|
|
return 0
|
|
fi
|
|
fi
|
|
_err "Can't find domain with id: $h"
|
|
return 1
|
|
fi
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
|
|
return 1
|
|
}
|
|
|
|
#method uri qstr data
|
|
jd_rest() {
|
|
mtd="$1"
|
|
ep="$2"
|
|
qsr="$3"
|
|
data="$4"
|
|
|
|
_debug mtd "$mtd"
|
|
_debug ep "$ep"
|
|
_debug qsr "$qsr"
|
|
_debug data "$data"
|
|
|
|
CanonicalURI="/$_JD_BASE_URI/$ep"
|
|
_debug2 CanonicalURI "$CanonicalURI"
|
|
|
|
CanonicalQueryString="$qsr"
|
|
_debug2 CanonicalQueryString "$CanonicalQueryString"
|
|
|
|
RequestDate="$(date -u +"%Y%m%dT%H%M%SZ")"
|
|
#RequestDate="20190713T082155Z" ######################################################
|
|
_debug2 RequestDate "$RequestDate"
|
|
export _H1="X-Jdcloud-Date: $RequestDate"
|
|
|
|
RequestNonce="2bd0852a-8bae-4087-b2d5-$(_time)"
|
|
#RequestNonce="894baff5-72d4-4244-883a-7b2eb51e7fbe" #################################
|
|
_debug2 RequestNonce "$RequestNonce"
|
|
export _H2="X-Jdcloud-Nonce: $RequestNonce"
|
|
|
|
if [ "$data" ]; then
|
|
CanonicalHeaders="content-type:application/json\n"
|
|
SignedHeaders="content-type;"
|
|
else
|
|
CanonicalHeaders=""
|
|
SignedHeaders=""
|
|
fi
|
|
CanonicalHeaders="${CanonicalHeaders}host:$_JD_HOST\nx-jdcloud-date:$RequestDate\nx-jdcloud-nonce:$RequestNonce\n"
|
|
SignedHeaders="${SignedHeaders}host;x-jdcloud-date;x-jdcloud-nonce"
|
|
|
|
_debug2 CanonicalHeaders "$CanonicalHeaders"
|
|
_debug2 SignedHeaders "$SignedHeaders"
|
|
|
|
Hash="sha256"
|
|
|
|
RequestPayload="$data"
|
|
_debug2 RequestPayload "$RequestPayload"
|
|
|
|
RequestPayloadHash="$(printf "%s" "$RequestPayload" | _digest "$Hash" hex | _lower_case)"
|
|
_debug2 RequestPayloadHash "$RequestPayloadHash"
|
|
|
|
CanonicalRequest="$mtd\n$CanonicalURI\n$CanonicalQueryString\n$CanonicalHeaders\n$SignedHeaders\n$RequestPayloadHash"
|
|
_debug2 CanonicalRequest "$CanonicalRequest"
|
|
|
|
HashedCanonicalRequest="$(printf "$CanonicalRequest%s" | _digest "$Hash" hex)"
|
|
_debug2 HashedCanonicalRequest "$HashedCanonicalRequest"
|
|
|
|
Algorithm="JDCLOUD2-HMAC-SHA256"
|
|
_debug2 Algorithm "$Algorithm"
|
|
|
|
RequestDateOnly="$(echo "$RequestDate" | cut -c 1-8)"
|
|
_debug2 RequestDateOnly "$RequestDateOnly"
|
|
|
|
Region="$JD_REGION"
|
|
Service="$_JD_PROD"
|
|
|
|
CredentialScope="$RequestDateOnly/$Region/$Service/jdcloud2_request"
|
|
_debug2 CredentialScope "$CredentialScope"
|
|
|
|
StringToSign="$Algorithm\n$RequestDate\n$CredentialScope\n$HashedCanonicalRequest"
|
|
|
|
_debug2 StringToSign "$StringToSign"
|
|
|
|
kSecret="JDCLOUD2$JD_ACCESS_KEY_SECRET"
|
|
|
|
_secure_debug2 kSecret "$kSecret"
|
|
|
|
kSecretH="$(printf "%s" "$kSecret" | _hex_dump | tr -d " ")"
|
|
_secure_debug2 kSecretH "$kSecretH"
|
|
|
|
kDateH="$(printf "$RequestDateOnly%s" | _hmac "$Hash" "$kSecretH" hex)"
|
|
_debug2 kDateH "$kDateH"
|
|
|
|
kRegionH="$(printf "$Region%s" | _hmac "$Hash" "$kDateH" hex)"
|
|
_debug2 kRegionH "$kRegionH"
|
|
|
|
kServiceH="$(printf "$Service%s" | _hmac "$Hash" "$kRegionH" hex)"
|
|
_debug2 kServiceH "$kServiceH"
|
|
|
|
kSigningH="$(printf "%s" "jdcloud2_request" | _hmac "$Hash" "$kServiceH" hex)"
|
|
_debug2 kSigningH "$kSigningH"
|
|
|
|
signature="$(printf "$StringToSign%s" | _hmac "$Hash" "$kSigningH" hex)"
|
|
_debug2 signature "$signature"
|
|
|
|
Authorization="$Algorithm Credential=$JD_ACCESS_KEY_ID/$CredentialScope, SignedHeaders=$SignedHeaders, Signature=$signature"
|
|
_debug2 Authorization "$Authorization"
|
|
|
|
_H3="Authorization: $Authorization"
|
|
_debug _H3 "$_H3"
|
|
|
|
url="https://$_JD_HOST$CanonicalURI"
|
|
if [ "$qsr" ]; then
|
|
url="https://$_JD_HOST$CanonicalURI?$qsr"
|
|
fi
|
|
|
|
if [ "$mtd" = "GET" ]; then
|
|
response="$(_get "$url")"
|
|
else
|
|
response="$(_post "$data" "$url" "" "$mtd" "application/json")"
|
|
fi
|
|
|
|
_ret="$?"
|
|
_debug2 response "$response"
|
|
if [ "$_ret" = "0" ]; then
|
|
if _contains "$response" "\"error\""; then
|
|
_err "Response error:$response"
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
return "$_ret"
|
|
}
|