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>
381 lines
12 KiB
Bash
Executable File
381 lines
12 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
# shellcheck disable=SC2034
|
|
dns_aws_info='Amazon AWS Route53 domain API
|
|
Site: docs.aws.amazon.com/route53/
|
|
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_aws
|
|
Options:
|
|
AWS_ACCESS_KEY_ID API Key ID
|
|
AWS_SECRET_ACCESS_KEY API Secret
|
|
'
|
|
|
|
# All `_sleep` commands are included to avoid Route53 throttling, see
|
|
# https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-requests
|
|
|
|
AWS_HOST="route53.amazonaws.com"
|
|
AWS_URL="https://$AWS_HOST"
|
|
|
|
AWS_WIKI="https://github.com/acmesh-official/acme.sh/wiki/How-to-use-Amazon-Route53-API"
|
|
|
|
######## Public functions #####################
|
|
|
|
#Usage: dns_myapi_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
|
|
dns_aws_add() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID:-$(_readaccountconf_mutable AWS_ACCESS_KEY_ID)}"
|
|
AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY:-$(_readaccountconf_mutable AWS_SECRET_ACCESS_KEY)}"
|
|
AWS_DNS_SLOWRATE="${AWS_DNS_SLOWRATE:-$(_readaccountconf_mutable AWS_DNS_SLOWRATE)}"
|
|
|
|
if [ -z "$AWS_ACCESS_KEY_ID" ] || [ -z "$AWS_SECRET_ACCESS_KEY" ]; then
|
|
_use_container_role || _use_instance_role
|
|
fi
|
|
|
|
if [ -z "$AWS_ACCESS_KEY_ID" ] || [ -z "$AWS_SECRET_ACCESS_KEY" ]; then
|
|
AWS_ACCESS_KEY_ID=""
|
|
AWS_SECRET_ACCESS_KEY=""
|
|
_err "You haven't specified the aws route53 api key id and and api key secret yet."
|
|
_err "Please create your key and try again. see $(__green $AWS_WIKI)"
|
|
return 1
|
|
fi
|
|
|
|
#save for future use, unless using a role which will be fetched as needed
|
|
if [ -z "$_using_role" ]; then
|
|
_saveaccountconf_mutable AWS_ACCESS_KEY_ID "$AWS_ACCESS_KEY_ID"
|
|
_saveaccountconf_mutable AWS_SECRET_ACCESS_KEY "$AWS_SECRET_ACCESS_KEY"
|
|
_saveaccountconf_mutable AWS_DNS_SLOWRATE "$AWS_DNS_SLOWRATE"
|
|
fi
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
_sleep 1
|
|
return 1
|
|
fi
|
|
_debug _domain_id "$_domain_id"
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
_info "Getting existing records for $fulldomain"
|
|
if ! aws_rest GET "2013-04-01$_domain_id/rrset" "name=$fulldomain&type=TXT"; then
|
|
_sleep 1
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "<Name>$fulldomain.</Name>"; then
|
|
_resource_record="$(echo "$response" | sed 's/<ResourceRecordSet>/"/g' | tr '"' "\n" | grep "<Name>$fulldomain.</Name>" | _egrep_o "<ResourceRecords.*</ResourceRecords>" | sed "s/<ResourceRecords>//" | sed "s#</ResourceRecords>##")"
|
|
_debug "_resource_record" "$_resource_record"
|
|
else
|
|
_debug "single new add"
|
|
fi
|
|
|
|
if [ "$_resource_record" ] && _contains "$response" "$txtvalue"; then
|
|
_info "The TXT record already exists. Skipping."
|
|
_sleep 1
|
|
return 0
|
|
fi
|
|
|
|
_debug "Adding records"
|
|
|
|
_aws_tmpl_xml="<ChangeResourceRecordSetsRequest xmlns=\"https://route53.amazonaws.com/doc/2013-04-01/\"><ChangeBatch><Changes><Change><Action>UPSERT</Action><ResourceRecordSet><Name>$fulldomain</Name><Type>TXT</Type><TTL>300</TTL><ResourceRecords>$_resource_record<ResourceRecord><Value>\"$txtvalue\"</Value></ResourceRecord></ResourceRecords></ResourceRecordSet></Change></Changes></ChangeBatch></ChangeResourceRecordSetsRequest>"
|
|
|
|
if aws_rest POST "2013-04-01$_domain_id/rrset/" "" "$_aws_tmpl_xml" && _contains "$response" "ChangeResourceRecordSetsResponse"; then
|
|
_info "TXT record updated successfully."
|
|
if [ -n "$AWS_DNS_SLOWRATE" ]; then
|
|
_info "Slow rate activated: sleeping for $AWS_DNS_SLOWRATE seconds"
|
|
_sleep "$AWS_DNS_SLOWRATE"
|
|
else
|
|
_sleep 1
|
|
fi
|
|
|
|
return 0
|
|
fi
|
|
_sleep 1
|
|
return 1
|
|
}
|
|
|
|
#fulldomain txtvalue
|
|
dns_aws_rm() {
|
|
fulldomain=$1
|
|
txtvalue=$2
|
|
|
|
AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID:-$(_readaccountconf_mutable AWS_ACCESS_KEY_ID)}"
|
|
AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY:-$(_readaccountconf_mutable AWS_SECRET_ACCESS_KEY)}"
|
|
AWS_DNS_SLOWRATE="${AWS_DNS_SLOWRATE:-$(_readaccountconf_mutable AWS_DNS_SLOWRATE)}"
|
|
|
|
if [ -z "$AWS_ACCESS_KEY_ID" ] || [ -z "$AWS_SECRET_ACCESS_KEY" ]; then
|
|
_use_container_role || _use_instance_role
|
|
fi
|
|
|
|
_debug "First detect the root zone"
|
|
if ! _get_root "$fulldomain"; then
|
|
_err "invalid domain"
|
|
_sleep 1
|
|
return 1
|
|
fi
|
|
_debug _domain_id "$_domain_id"
|
|
_debug _sub_domain "$_sub_domain"
|
|
_debug _domain "$_domain"
|
|
|
|
_info "Getting existing records for $fulldomain"
|
|
if ! aws_rest GET "2013-04-01$_domain_id/rrset" "name=$fulldomain&type=TXT"; then
|
|
_sleep 1
|
|
return 1
|
|
fi
|
|
|
|
if _contains "$response" "<Name>$fulldomain.</Name>"; then
|
|
_resource_record="$(echo "$response" | sed 's/<ResourceRecordSet>/"/g' | tr '"' "\n" | grep "<Name>$fulldomain.</Name>" | _egrep_o "<ResourceRecords.*</ResourceRecords>" | sed "s/<ResourceRecords>//" | sed "s#</ResourceRecords>##")"
|
|
_debug "_resource_record" "$_resource_record"
|
|
else
|
|
_debug "no records exist, skip"
|
|
_sleep 1
|
|
return 0
|
|
fi
|
|
|
|
_aws_tmpl_xml="<ChangeResourceRecordSetsRequest xmlns=\"https://route53.amazonaws.com/doc/2013-04-01/\"><ChangeBatch><Changes><Change><Action>DELETE</Action><ResourceRecordSet><ResourceRecords>$_resource_record</ResourceRecords><Name>$fulldomain.</Name><Type>TXT</Type><TTL>300</TTL></ResourceRecordSet></Change></Changes></ChangeBatch></ChangeResourceRecordSetsRequest>"
|
|
|
|
if aws_rest POST "2013-04-01$_domain_id/rrset/" "" "$_aws_tmpl_xml" && _contains "$response" "ChangeResourceRecordSetsResponse"; then
|
|
_info "TXT record deleted successfully."
|
|
if [ -n "$AWS_DNS_SLOWRATE" ]; then
|
|
_info "Slow rate activated: sleeping for $AWS_DNS_SLOWRATE seconds"
|
|
_sleep "$AWS_DNS_SLOWRATE"
|
|
else
|
|
_sleep 1
|
|
fi
|
|
|
|
return 0
|
|
fi
|
|
_sleep 1
|
|
return 1
|
|
}
|
|
|
|
#################### Private functions below ##################################
|
|
|
|
_get_root() {
|
|
domain=$1
|
|
i=1
|
|
p=1
|
|
|
|
# iterate over names (a.b.c.d -> b.c.d -> c.d -> d)
|
|
while true; do
|
|
h=$(printf "%s" "$domain" | cut -d . -f $i-100 | sed 's/\./\\./g')
|
|
_debug "Checking domain: $h"
|
|
if [ -z "$h" ]; then
|
|
_error "invalid domain"
|
|
return 1
|
|
fi
|
|
|
|
# iterate over paginated result for list_hosted_zones
|
|
aws_rest GET "2013-04-01/hostedzone"
|
|
while true; do
|
|
if _contains "$response" "<Name>$h.</Name>"; then
|
|
hostedzone="$(echo "$response" | tr -d '\n' | sed 's/<HostedZone>/#&/g' | tr '#' '\n' | _egrep_o "<HostedZone><Id>[^<]*<.Id><Name>$h.<.Name>.*<PrivateZone>false<.PrivateZone>.*<.HostedZone>")"
|
|
_debug hostedzone "$hostedzone"
|
|
if [ "$hostedzone" ]; then
|
|
_domain_id=$(printf "%s\n" "$hostedzone" | _egrep_o "<Id>.*<.Id>" | head -n 1 | _egrep_o ">.*<" | tr -d "<>")
|
|
if [ "$_domain_id" ]; then
|
|
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
|
|
_domain=$h
|
|
return 0
|
|
fi
|
|
_err "Can't find domain with id: $h"
|
|
return 1
|
|
fi
|
|
fi
|
|
if _contains "$response" "<IsTruncated>true</IsTruncated>" && _contains "$response" "<NextMarker>"; then
|
|
_debug "IsTruncated"
|
|
_nextMarker="$(echo "$response" | _egrep_o "<NextMarker>.*</NextMarker>" | cut -d '>' -f 2 | cut -d '<' -f 1)"
|
|
_debug "NextMarker" "$_nextMarker"
|
|
else
|
|
break
|
|
fi
|
|
_debug "Checking domain: $h - Next Page "
|
|
aws_rest GET "2013-04-01/hostedzone" "marker=$_nextMarker"
|
|
done
|
|
p=$i
|
|
i=$(_math "$i" + 1)
|
|
done
|
|
return 1
|
|
}
|
|
|
|
_use_container_role() {
|
|
# automatically set if running inside ECS
|
|
if [ -z "$AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" ]; then
|
|
_debug "No ECS environment variable detected"
|
|
return 1
|
|
fi
|
|
_use_metadata "169.254.170.2$AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"
|
|
}
|
|
|
|
_use_instance_role() {
|
|
_instance_role_name_url="http://169.254.169.254/latest/meta-data/iam/security-credentials/"
|
|
|
|
if _get "$_instance_role_name_url" true 1 | _head_n 1 | grep -Fq 401; then
|
|
_debug "Using IMDSv2"
|
|
_token_url="http://169.254.169.254/latest/api/token"
|
|
export _H1="X-aws-ec2-metadata-token-ttl-seconds: 21600"
|
|
_token="$(_post "" "$_token_url" "" "PUT")"
|
|
_secure_debug3 "_token" "$_token"
|
|
if [ -z "$_token" ]; then
|
|
_debug "Unable to fetch IMDSv2 token from instance metadata"
|
|
return 1
|
|
fi
|
|
export _H1="X-aws-ec2-metadata-token: $_token"
|
|
fi
|
|
|
|
if ! _get "$_instance_role_name_url" true 1 | _head_n 1 | grep -Fq 200; then
|
|
_debug "Unable to fetch IAM role from instance metadata"
|
|
return 1
|
|
fi
|
|
|
|
_instance_role_name=$(_get "$_instance_role_name_url" "" 1)
|
|
_debug "_instance_role_name" "$_instance_role_name"
|
|
_use_metadata "$_instance_role_name_url$_instance_role_name" "$_token"
|
|
|
|
}
|
|
|
|
_use_metadata() {
|
|
export _H1="X-aws-ec2-metadata-token: $2"
|
|
_aws_creds="$(
|
|
_get "$1" "" 1 |
|
|
_normalizeJson |
|
|
tr '{,}' '\n' |
|
|
while read -r _line; do
|
|
_key="$(echo "${_line%%:*}" | tr -d '\"')"
|
|
_value="${_line#*:}"
|
|
_debug3 "_key" "$_key"
|
|
_secure_debug3 "_value" "$_value"
|
|
case "$_key" in
|
|
AccessKeyId) echo "AWS_ACCESS_KEY_ID=$_value" ;;
|
|
SecretAccessKey) echo "AWS_SECRET_ACCESS_KEY=$_value" ;;
|
|
Token) echo "AWS_SESSION_TOKEN=$_value" ;;
|
|
esac
|
|
done |
|
|
paste -sd' ' -
|
|
)"
|
|
_secure_debug "_aws_creds" "$_aws_creds"
|
|
|
|
if [ -z "$_aws_creds" ]; then
|
|
return 1
|
|
fi
|
|
|
|
eval "$_aws_creds"
|
|
_using_role=true
|
|
}
|
|
|
|
#method uri qstr data
|
|
aws_rest() {
|
|
mtd="$1"
|
|
ep="$2"
|
|
qsr="$3"
|
|
data="$4"
|
|
|
|
_debug mtd "$mtd"
|
|
_debug ep "$ep"
|
|
_debug qsr "$qsr"
|
|
_debug data "$data"
|
|
|
|
CanonicalURI="/$ep"
|
|
_debug2 CanonicalURI "$CanonicalURI"
|
|
|
|
CanonicalQueryString="$qsr"
|
|
_debug2 CanonicalQueryString "$CanonicalQueryString"
|
|
|
|
RequestDate="$(date -u +"%Y%m%dT%H%M%SZ")"
|
|
_debug2 RequestDate "$RequestDate"
|
|
|
|
#RequestDate="20161120T141056Z" ##############
|
|
|
|
export _H1="x-amz-date: $RequestDate"
|
|
|
|
aws_host="$AWS_HOST"
|
|
CanonicalHeaders="host:$aws_host\nx-amz-date:$RequestDate\n"
|
|
SignedHeaders="host;x-amz-date"
|
|
if [ -n "$AWS_SESSION_TOKEN" ]; then
|
|
export _H3="x-amz-security-token: $AWS_SESSION_TOKEN"
|
|
CanonicalHeaders="${CanonicalHeaders}x-amz-security-token:$AWS_SESSION_TOKEN\n"
|
|
SignedHeaders="${SignedHeaders};x-amz-security-token"
|
|
fi
|
|
_debug2 CanonicalHeaders "$CanonicalHeaders"
|
|
_debug2 SignedHeaders "$SignedHeaders"
|
|
|
|
RequestPayload="$data"
|
|
_debug2 RequestPayload "$RequestPayload"
|
|
|
|
Hash="sha256"
|
|
|
|
CanonicalRequest="$mtd\n$CanonicalURI\n$CanonicalQueryString\n$CanonicalHeaders\n$SignedHeaders\n$(printf "%s" "$RequestPayload" | _digest "$Hash" hex)"
|
|
_debug2 CanonicalRequest "$CanonicalRequest"
|
|
|
|
HashedCanonicalRequest="$(printf "$CanonicalRequest%s" | _digest "$Hash" hex)"
|
|
_debug2 HashedCanonicalRequest "$HashedCanonicalRequest"
|
|
|
|
Algorithm="AWS4-HMAC-SHA256"
|
|
_debug2 Algorithm "$Algorithm"
|
|
|
|
RequestDateOnly="$(echo "$RequestDate" | cut -c 1-8)"
|
|
_debug2 RequestDateOnly "$RequestDateOnly"
|
|
|
|
Region="us-east-1"
|
|
Service="route53"
|
|
|
|
CredentialScope="$RequestDateOnly/$Region/$Service/aws4_request"
|
|
_debug2 CredentialScope "$CredentialScope"
|
|
|
|
StringToSign="$Algorithm\n$RequestDate\n$CredentialScope\n$HashedCanonicalRequest"
|
|
|
|
_debug2 StringToSign "$StringToSign"
|
|
|
|
kSecret="AWS4$AWS_SECRET_ACCESS_KEY"
|
|
|
|
#kSecret="wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY" ############################
|
|
|
|
_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" "aws4_request" | _hmac "$Hash" "$kServiceH" hex)"
|
|
_debug2 kSigningH "$kSigningH"
|
|
|
|
signature="$(printf "$StringToSign%s" | _hmac "$Hash" "$kSigningH" hex)"
|
|
_debug2 signature "$signature"
|
|
|
|
Authorization="$Algorithm Credential=$AWS_ACCESS_KEY_ID/$CredentialScope, SignedHeaders=$SignedHeaders, Signature=$signature"
|
|
_debug2 Authorization "$Authorization"
|
|
|
|
_H2="Authorization: $Authorization"
|
|
_debug _H2 "$_H2"
|
|
|
|
url="$AWS_URL/$ep"
|
|
if [ "$qsr" ]; then
|
|
url="$AWS_URL/$ep?$qsr"
|
|
fi
|
|
|
|
if [ "$mtd" = "GET" ]; then
|
|
response="$(_get "$url")"
|
|
else
|
|
response="$(_post "$data" "$url")"
|
|
fi
|
|
|
|
_ret="$?"
|
|
_debug2 response "$response"
|
|
if [ "$_ret" = "0" ]; then
|
|
if _contains "$response" "<ErrorResponse"; then
|
|
_err "Response error:$response"
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
return "$_ret"
|
|
}
|