Update cloudflare-template.sh

Made several changes in the script to make it looks better.
The log messages and header name are adjusted to reflect IPv4 addressing.
pull/78/head
Justin He 1 year ago committed by GitHub
parent ac2f74f980
commit 8383de8a9d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 160
      cloudflare-template.sh

@ -1,123 +1,155 @@
#!/bin/bash #!/bin/bash
## change to "bin/sh" when necessary ## change to "bin/sh" when necessary
auth_email="" # The email used to login 'https://dash.cloudflare.com' ############## CLOUDFLARE CREDENTIALS ##############
auth_method="token" # Set to "global" for Global API Key or "token" for Scoped API Token # @auth_email - The email used to login 'https://dash.cloudflare.com'
auth_key="" # Your API Token or Global API Key # @auth_method - Set to "global" for Global API Key or "token" for Scoped API Token
zone_identifier="" # Can be found in the "Overview" tab of your domain # @auth_key - Your API Token or Global API Key
record_name="" # Which record you want to be synced # @zone_identifier - Can be found in the "Overview" tab of your domain
ttl="3600" # Set the DNS TTL (seconds) # -------------------------------------------------- #
proxy="false" # Set the proxy to true or false auth_email=""
sitename="" # Title of site "Example Site" auth_method="token"
slackchannel="" # Slack Channel #example auth_key=""
slackuri="" # URI for Slack WebHook "https://hooks.slack.com/services/xxxxx" zone_identifier=""
discorduri="" # URI for Discord WebHook "https://discordapp.com/api/webhooks/xxxxx"
############# DNS RECORD CONFIGURATION #############
# @record_name - Which record you want to be synced
########################################### # @ttl - DNS TTL (seconds), can be set between (30 if enterprise) 60 and 86400 seconds, or 1 for Automatic
## Check if we have a public IP # @proxy - Set the proxy to true or false
########################################### # -------------------------------------------------- #
ipv4_regex='([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])' record_name=""
ip=$(curl -s -4 https://cloudflare.com/cdn-cgi/trace | grep -E '^ip'); ret=$? ttl="3600"
if [[ ! $ret == 0 ]]; then # In the case that cloudflare failed to return an ip. proxy="false"
# Attempt to get the ip from other websites.
ip=$(curl -s https://api.ipify.org || curl -s https://ipv4.icanhazip.com) ############### SCRIPT CONFIGURATION ###############
else # @log_header_name - Header name used for logs
# Extract just the ip from the ip line from cloudflare. # -------------------------------------------------- #
ip=$(echo $ip | sed -E "s/^ip=($ipv4_regex)$/\1/") log_header_name="DDNS Updater"
############# WEBHOOKS CONFIGURATION ###############
# @sitename - Title of site "Example Site"
# @slackchannel - Slack Channel #example
# @slackuri - URI for Slack WebHook "https://hooks.slack.com/services/xxxxx"
# @discorduri - URI for Discord WebHook "https://discordapp.com/api/webhooks/xxxxx"
# -------------------------------------------------- #
sitename=""
slackchannel=""
slackuri=""
discorduri=""
################################################
## Make sure we have a valid IPv4 connection
################################################
if ! { curl -4 -s --head --fail https://ipv4.google.com >/dev/null; }; then
logger -s "$log_header_name: Unable to establish a valid IPv4 connection to a known host."
exit 1
fi fi
# Use regex to check for proper IPv4 format. ################################################
## Finding our IPv4 address
################################################
ip=$(curl -s -4 https://api.ipify.org || curl -s -4 https://ipv4.icanhazip.com)
# Check point: Make sure the collected IPv4 address is valid
ipv4_regex='([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])'
if [[ ! $ip =~ ^$ipv4_regex$ ]]; then if [[ ! $ip =~ ^$ipv4_regex$ ]]; then
logger -s "DDNS Updater: Failed to find a valid IP." logger -s "$log_header_name: Failed to find a valid IPv4 address."
exit 2 exit 1
fi fi
########################################### ################################################
## Check and set the proper auth header ## Check and set the proper auth header
########################################### ################################################
if [[ "${auth_method}" == "global" ]]; then if [[ "${auth_method}" == "global" ]]; then
auth_header="X-Auth-Key:" auth_header="X-Auth-Key:"
else else
auth_header="Authorization: Bearer" auth_header="Authorization: Bearer"
fi fi
########################################### ################################################
## Seek for the A record ## Seek for the A record
########################################### ################################################
logger "$log_header_name: Check Initiated"
logger "DDNS Updater: Check Initiated"
record=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records?type=A&name=$record_name" \ record=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records?type=A&name=$record_name" \
-H "X-Auth-Email: $auth_email" \ -H "X-Auth-Email: $auth_email" \
-H "$auth_header $auth_key" \ -H "$auth_header $auth_key" \
-H "Content-Type: application/json") -H "Content-Type: application/json")
########################################### ################################################
## Check if the domain has an A record ## Check if the domain has an A record
########################################### ################################################
if [[ $record == *"\"count\":0"* ]]; then if [[ $record == *"\"count\":0"* ]]; then
logger -s "DDNS Updater: Record does not exist, perhaps create one first? (${ip} for ${record_name})" logger -s "$log_header_name: Record does not exist, perhaps create one first? (${ip} for ${record_name})"
exit 1 exit 1
fi fi
########################################### ################################################
## Get existing IP ## Get existing IP
########################################### ################################################
old_ip=$(echo "$record" | sed -E 's/.*"content":"(([0-9]{1,3}\.){3}[0-9]{1,3})".*/\1/') old_ip=$(echo "$record" | sed -E 's/.*"content":"(([0-9]{1,3}\.){3}[0-9]{1,3})".*/\1/')
# Make sure the extracted IPv4 address is valid
if [[ ! $old_ip =~ ^$ipv4_regex$ ]]; then
logger -s "$log_header_name: Unable to extract existing IPv4 address from DNS record."
exit 1
fi
# Compare if they're the same # Compare if they're the same
if [[ $ip == $old_ip ]]; then if [[ $ip == $old_ip ]]; then
logger "DDNS Updater: IP ($ip) for ${record_name} has not changed." logger "$log_header_name: IP ($ip) for ${record_name} has not changed."
exit 0 exit 0
fi fi
########################################### ################################################
## Set the record identifier from result ## Set the record identifier from result
########################################### ################################################
record_identifier=$(echo "$record" | sed -E 's/.*"id":"([A-Za-z0-9_]+)".*/\1/') record_identifier=$(echo "$record" | sed -E 's/.*"id":"([A-Za-z0-9_]+)".*/\1/')
########################################### ################################################
## Change the IP@Cloudflare using the API ## Change the IP@Cloudflare using the API
########################################### ################################################
update=$(curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records/$record_identifier" \ update=$(curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records/$record_identifier" \
-H "X-Auth-Email: $auth_email" \ -H "X-Auth-Email: $auth_email" \
-H "$auth_header $auth_key" \ -H "$auth_header $auth_key" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
--data "{\"type\":\"A\",\"name\":\"$record_name\",\"content\":\"$ip\",\"ttl\":\"$ttl\",\"proxied\":${proxy}}") --data "{\"content\":\"$ip\",\"ttl\":\"$ttl\",\"proxied\":$proxy}")
########################################### ################################################
## Report the status ## Report the status
########################################### ################################################
case "$update" in case "$update" in
*"\"success\":false"*) *"\"success\":false"*)
echo -e "DDNS Updater: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update" | logger -s echo -e "$log_header_name: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update" | logger -s
if [[ $slackuri != "" ]]; then if [[ $slackuri != "" ]]; then
curl -L -X POST $slackuri \ curl -L -X POST $slackuri \
--data-raw '{ --data-raw "{
"channel": "'$slackchannel'", \"channel\": \"$slackchannel\",
"text" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')." \"text\": \"$sitename DDNS Update Failed: $record_name: $record_identifier ($ip).\"
}' }"
fi fi
if [[ $discorduri != "" ]]; then if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \ curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{ --data-raw "{
"content" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')." \"content\": \"$sitename DDNS Update Failed: $record_name: $record_identifier ($ip).\"
}' $discorduri }" $discorduri
fi fi
exit 1;; exit 1
;;
*) *)
logger "DDNS Updater: $ip $record_name DDNS updated." logger "$log_header_name: $ip $record_name DDNS updated."
if [[ $slackuri != "" ]]; then if [[ $slackuri != "" ]]; then
curl -L -X POST $slackuri \ curl -L -X POST $slackuri \
--data-raw '{ --data-raw "{
"channel": "'$slackchannel'", \"channel\": \"$slackchannel\",
"text" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'" \"text\": \"$sitename Updated: $record_name's new IPv4 Address is $ip\"
}' }"
fi fi
if [[ $discorduri != "" ]]; then if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \ curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{ --data-raw "{
"content" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'" \"content\": \"$sitename Updated: $record_name's new IPv4 Address is $ip\"
}' $discorduri }" $discorduri
fi fi
exit 0;; exit 0
;;
esac esac

Loading…
Cancel
Save