style(fmt): Reformat shell script

This commit is contained in:
2026-07-19 23:33:56 -06:00
parent 3be6eaee0c
commit 71da487aa8
+420 -411
View File
@@ -9,248 +9,248 @@
### text formatting presets using tput ### text formatting presets using tput
if command -v tput >/dev/null; then if command -v tput >/dev/null; then
[ -z "$TERM" ] && export TERM=xterm [ -z "$TERM" ] && export TERM=xterm
bold=$(tput bold) bold=$(tput bold)
cyan=$(tput setaf 6) cyan=$(tput setaf 6)
err=$(tput bold)$(tput setaf 1) err=$(tput bold)$(tput setaf 1)
magenta=$(tput setaf 5) magenta=$(tput setaf 5)
norm=$(tput sgr0) norm=$(tput sgr0)
ok=$(tput setaf 2) ok=$(tput setaf 2)
warn=$(tput bold)$(tput setaf 3) warn=$(tput bold)$(tput setaf 3)
yellow=$(tput setaf 3) yellow=$(tput setaf 3)
width=$(tput cols) width=$(tput cols)
else else
bold="" bold=""
cyan="" cyan=""
err="" err=""
magenta="" magenta=""
norm="" norm=""
ok="" ok=""
warn="" warn=""
yellow="" yellow=""
width=80 width=80
fi fi
### functions ### functions
badParam() { badParam() {
if [ "$1" = "null" ]; then if [ "$1" = "null" ]; then
printf "\n%sERROR: '%s' cannot have a NULL (empty) value.\n" "$err" "$2" printf "\n%sERROR: '%s' cannot have a NULL (empty) value.\n" "$err" "$2"
printf "%sPlease use '--help' for assistance.%s\n\n" "$cyan" "$norm" printf "%sPlease use '--help' for assistance.%s\n\n" "$cyan" "$norm"
exit 1 exit 1
elif [ "$1" = "dne" ]; then elif [ "$1" = "dne" ]; then
printf "\n%sERROR: '%s %s'\n" "$err" "$2" "$3" printf "\n%sERROR: '%s %s'\n" "$err" "$2" "$3"
printf "file or directory does not exist or is empty.%s\n\n" "$norm" printf "file or directory does not exist or is empty.%s\n\n" "$norm"
exit 1 exit 1
elif [ "$1" = "errMsg" ]; then elif [ "$1" = "errMsg" ]; then
printf "\n%sERROR: %s%s\n\n" "$err" "$2" "$norm" printf "\n%sERROR: %s%s\n\n" "$err" "$2" "$norm"
exit 1 exit 1
fi fi
} }
exitError() { exitError() {
case "$1" in case "$1" in
3) 3)
errMsg="Unable to connect to Cloudflare servers. This is probably a temporary networking issue. Please try again later." errMsg="Unable to connect to Cloudflare servers. This is probably a temporary networking issue. Please try again later."
;; ;;
10) 10)
errMsg="Unable to auto-detect IP address. Try again later or supply the IP address to be used." errMsg="Unable to auto-detect IP address. Try again later or supply the IP address to be used."
;; ;;
20) 20)
errMsg="Cloudflare authorized email address (cfEmail) is either null or undefined. Please check your Cloudflare credentials file." errMsg="Cloudflare authorized email address (cfEmail) is either null or undefined. Please check your Cloudflare credentials file."
;; ;;
21) 21)
errMsg="Cloudflare authorized API key (cfKey) is either null or undefined. Please check your Cloudflare credentials file." errMsg="Cloudflare authorized API key (cfKey) is either null or undefined. Please check your Cloudflare credentials file."
;; ;;
22) 22)
errMsg="Cloudflare zone id (cfZoneId) is either null or undefined. Please check your Cloudflare credentials file." errMsg="Cloudflare zone id (cfZoneId) is either null or undefined. Please check your Cloudflare credentials file."
;; ;;
25) 25)
errMsg="Cloudflare API error. Please review any 'CF-ERR:' lines in this log for details." errMsg="Cloudflare API error. Please review any 'CF-ERR:' lines in this log for details."
;; ;;
26) 26)
errMsg="${failedHostCount} host update(s) failed. Any 'CF-ERR:' lines noted in this log may help determine what went wrong." errMsg="${failedHostCount} host update(s) failed. Any 'CF-ERR:' lines noted in this log may help determine what went wrong."
;; ;;
*) *)
writeLog error "An unspecified error occurred. (code: 99)" writeLog error "An unspecified error occurred. (code: 99)"
printf "%s[%s] -- Cloudflare DDNS update-script: completed with error(s) --%s\n" "$err" "$(stamp)" "$norm" >>"$logFile"
exit 99
;;
esac
writeLog error "$errMsg" "$1"
printf "%s[%s] -- Cloudflare DDNS update-script: completed with error(s) --%s\n" "$err" "$(stamp)" "$norm" >>"$logFile" printf "%s[%s] -- Cloudflare DDNS update-script: completed with error(s) --%s\n" "$err" "$(stamp)" "$norm" >>"$logFile"
exit "$1" exit 99
;;
esac
writeLog error "$errMsg" "$1"
printf "%s[%s] -- Cloudflare DDNS update-script: completed with error(s) --%s\n" "$err" "$(stamp)" "$norm" >>"$logFile"
exit "$1"
} }
exitOK() { exitOK() {
printf "%s[%s] -- Cloudflare DDNS update-script: completed successfully --%s\n" "$ok" "$(stamp)" "$norm" >>"$logFile" printf "%s[%s] -- Cloudflare DDNS update-script: completed successfully --%s\n" "$ok" "$(stamp)" "$norm" >>"$logFile"
exit 0 exit 0
} }
listCFErrors() { listCFErrors() {
# extract error codes and messages in separate variables, replace newlines with underscores # extract error codes and messages in separate variables, replace newlines with underscores
codes="$(printf "%s" "$1" | jq -r '.errors | .[] | .code' | tr '\n' '_')" codes="$(printf "%s" "$1" | jq -r '.errors | .[] | .code' | tr '\n' '_')"
messages="$(printf "%s" "$1" | jq -r '.errors | .[] | .message' | tr '\n' '_')" messages="$(printf "%s" "$1" | jq -r '.errors | .[] | .message' | tr '\n' '_')"
# iterate codes and messages and assemble into coherent messages in log # iterate codes and messages and assemble into coherent messages in log
while [ -n "$codes" ] && [ -n "$messages" ]; do while [ -n "$codes" ] && [ -n "$messages" ]; do
# get first code and message in respective sets # get first code and message in respective sets
code="${codes%%_*}" code="${codes%%_*}"
message="${messages%%_*}" message="${messages%%_*}"
# update codes and messages sets by removing first item in each set # update codes and messages sets by removing first item in each set
codes="${codes#*_}" codes="${codes#*_}"
messages="${messages#*_}" messages="${messages#*_}"
# output to log # output to log
writeLog cf "$message" "$code" writeLog cf "$message" "$code"
done done
} }
scriptExamples() { scriptExamples() {
newline newline
printf "Update Cloudflare DNS host A/AAAA records with current IP address.\n" printf "Update Cloudflare DNS host A/AAAA records with current IP address.\n"
printf "%sUsage: %s --records host.domain.tld[,host2.domain.tld,...] [parameters]%s\n\n" "$bold" "$scriptName" "$norm" printf "%sUsage: %s --records host.domain.tld[,host2.domain.tld,...] [parameters]%s\n\n" "$bold" "$scriptName" "$norm"
textBlock "${magenta}--- usage examples ---${norm}" textBlock "${magenta}--- usage examples ---${norm}"
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net" textBlockSwitches "${scriptName} -r myserver.mydomain.net"
textBlock "Update Cloudflare DNS records for myserver.mydomain.net with the auto-detected public IP4 address. Credentials will be expected in the default location and the log will be written in the default location also." textBlock "Update Cloudflare DNS records for myserver.mydomain.net with the auto-detected public IP4 address. Credentials will be expected in the default location and the log will be written in the default location also."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net -6" textBlockSwitches "${scriptName} -r myserver.mydomain.net -6"
textBlock "Same as above, but update AAAA host records with the auto-detected public IP6 address." textBlock "Same as above, but update AAAA host records with the auto-detected public IP6 address."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --nc" textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --nc"
textBlock "Update DNS entries for both listed hosts using auto-detected IP4 address. Write a non-coloured log to '/var/log/cfddns.log'." textBlock "Update DNS entries for both listed hosts using auto-detected IP4 address. Write a non-coloured log to '/var/log/cfddns.log'."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --ip6 --ip fd21:7a62:2737:9c3a::a151" textBlockSwitches "${scriptName} -r myserver.mydomain.net,myserver2.mydomain.net -l /var/log/cfddns.log --ip6 --ip fd21:7a62:2737:9c3a::a151"
textBlock "Update DNS AAAA entries for listed hosts using the *specified* IP address. Write a colourful log to the location specified." textBlock "Update DNS AAAA entries for listed hosts using the *specified* IP address. Write a colourful log to the location specified."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log --ip 1.2.3.4" textBlockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log --ip 1.2.3.4"
textBlock "Update DNS A entry for listed hostname with the provided IP address. Read cloudflare credentials file from specified location, save log in specified location." textBlock "Update DNS A entry for listed hostname with the provided IP address. Read cloudflare credentials file from specified location, save log in specified location."
newline newline
textBlockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log -6 -i fd21:7a62:2737:9c3a::a151" textBlockSwitches "${scriptName} -r myserver.mydomain.net -c /root/cloudflare.creds -l /var/log/cfddns.log -6 -i fd21:7a62:2737:9c3a::a151"
textBlock "Exact same as above, but change the AAAA record. This is how you run the script once for IP4 and again for IP6." textBlock "Exact same as above, but change the AAAA record. This is how you run the script once for IP4 and again for IP6."
exit 0 exit 0
} }
scriptHelp() { scriptHelp() {
newline newline
printf "Update Cloudflare DNS host A/AAAA records with current IP address.\n" printf "Update Cloudflare DNS host A/AAAA records with current IP address.\n"
printf "%sUsage: %s --records host.domain.tld[,host2.domain.tld,...] [parameters]%s\n\n" "$bold" "$scriptName" "$norm" printf "%sUsage: %s --records host.domain.tld[,host2.domain.tld,...] [parameters]%s\n\n" "$bold" "$scriptName" "$norm"
textBlock "The only required parameter is '--records' which is a comma-delimited list of hostnames to update. However, there are several other options which may be useful to implement." textBlock "The only required parameter is '--records' which is a comma-delimited list of hostnames to update. However, there are several other options which may be useful to implement."
textBlock "Parameters are listed below and followed by a description of their effect. If a default value exists, it will be listed on the following line in (parentheses)." textBlock "Parameters are listed below and followed by a description of their effect. If a default value exists, it will be listed on the following line in (parentheses)."
newline newline
textBlock "${magenta}--- script related parameters ---${norm}" textBlock "${magenta}--- script related parameters ---${norm}"
newline newline
textBlockSwitches "-c | --cred | --creds | --credentials | -f (deprecated, backward-compatibility)" textBlockSwitches "-c | --cred | --creds | --credentials | -f (deprecated, backward-compatibility)"
textBlock "Path to file containing your Cloudflare *token* credentials. Please refer to the repo README for more information on format, etc." textBlock "Path to file containing your Cloudflare *token* credentials. Please refer to the repo README for more information on format, etc."
textBlockDefaults "(${accountFile})" textBlockDefaults "(${accountFile})"
newline newline
textBlockSwitches "-l | --log" textBlockSwitches "-l | --log"
textBlock "Path where the log file should be written." textBlock "Path where the log file should be written."
textBlockDefaults "(${logFile})" textBlockDefaults "(${logFile})"
newline newline
textBlockSwitches "--nc | --no-color | --no-colour" textBlockSwitches "--nc | --no-color | --no-colour"
textBlock "Switch value. Disables ANSI colours in the log. Useful if you review the logs using a reader that does not parse ANSI colour codes." textBlock "Switch value. Disables ANSI colours in the log. Useful if you review the logs using a reader that does not parse ANSI colour codes."
textBlockDefaults "(disabled: print logs in colour)" textBlockDefaults "(disabled: print logs in colour)"
newline newline
textBlockSwitches "--log-console" textBlockSwitches "--log-console"
textBlock "Switch value. Output log to console (stdout) instead of a log file. Can be combined with --nc if desired." textBlock "Switch value. Output log to console (stdout) instead of a log file. Can be combined with --nc if desired."
textBlockDefaults "(disabled: output to log file)" textBlockDefaults "(disabled: output to log file)"
newline newline
textBlockSwitches "--log-journal" textBlockSwitches "--log-journal"
textBlock "Switch value. Output a structured log entry to your journaling system instead of a log file. Implies --nc." textBlock "Switch value. Output a structured log entry to your journaling system instead of a log file. Implies --nc."
textBlockDefaults "(disabled: output to log file)" textBlockDefaults "(disabled: output to log file)"
newline newline
textBlockSwitches "--no-log" textBlockSwitches "--no-log"
textBlock "Switch value. Do not create a log (i.e. no console, no file). You will not have *any* output from the script if you choose this option, so you will not know if updates succeeded or failed." textBlock "Switch value. Do not create a log (i.e. no console, no file). You will not have *any* output from the script if you choose this option, so you will not know if updates succeeded or failed."
textBlockDefaults "(disabled: output to log file)" textBlockDefaults "(disabled: output to log file)"
newline newline
textBlockSwitches "-h | --help | -?" textBlockSwitches "-h | --help | -?"
textBlock "Display this help screen." textBlock "Display this help screen."
newline newline
textBlockSwitches "--examples" textBlockSwitches "--examples"
textBlock "Show some usage examples." textBlock "Show some usage examples."
newline newline
textBlock "${magenta}--- DNS related parameters ---${norm}" textBlock "${magenta}--- DNS related parameters ---${norm}"
newline newline
textBlockSwitches "-r | --record | --records" textBlockSwitches "-r | --record | --records"
textBlock "Comma-delimited list of hostnames for which IP addresses should be updated in Cloudflare DNS. This parameter is REQUIRED. Note that this script will only *update* records, it will not create new ones. If you supply hostnames that are not already defined in DNS, the script will log a warning and will skip those hostnames." textBlock "Comma-delimited list of hostnames for which IP addresses should be updated in Cloudflare DNS. This parameter is REQUIRED. Note that this script will only *update* records, it will not create new ones. If you supply hostnames that are not already defined in DNS, the script will log a warning and will skip those hostnames."
newline newline
textBlockSwitches "-i | --ip | --ip-address | -a | --address" textBlockSwitches "-i | --ip | --ip-address | -a | --address"
textBlock "New IP address for DNS host records. If you omit this, the script will attempt to auto-detect your public IP address and use that." textBlock "New IP address for DNS host records. If you omit this, the script will attempt to auto-detect your public IP address and use that."
newline newline
textBlockSwitches "-4 | --ip4 | --ipv4" textBlockSwitches "-4 | --ip4 | --ipv4"
textBlock "Switch value. Update Host 'A' records (IP4) only. Note that this script can only update either A *or* AAAA records. If you need to update both, you'll have to run the script once in IP4 mode and again in IP6 mode. If you specify both this switch and the IP6 switch, the last one specified will take effect." textBlock "Switch value. Update Host 'A' records (IP4) only. Note that this script can only update either A *or* AAAA records. If you need to update both, you'll have to run the script once in IP4 mode and again in IP6 mode. If you specify both this switch and the IP6 switch, the last one specified will take effect."
textBlockDefaults "(enabled: update A records)" textBlockDefaults "(enabled: update A records)"
newline newline
textBlockSwitches "-6 | --ip6 | --ipv6" textBlockSwitches "-6 | --ip6 | --ipv6"
textBlock "Switch value. Update Host 'AAAA' records (IP6) only. Note that this script can only update either A *or* AAAA records. If you need to update both, you'll have to run the script once in IP4 mode and again in IP6 mode. If you specify both this switch and the IP4 switch, the last one specified will take effect." textBlock "Switch value. Update Host 'AAAA' records (IP6) only. Note that this script can only update either A *or* AAAA records. If you need to update both, you'll have to run the script once in IP4 mode and again in IP6 mode. If you specify both this switch and the IP4 switch, the last one specified will take effect."
textBlockDefaults "(disabled: update A records)" textBlockDefaults "(disabled: update A records)"
newline newline
textBlock "Please refer to the repo README for more detailed information regarding this script and how to automate and monitor it." textBlock "Please refer to the repo README for more detailed information regarding this script and how to automate and monitor it."
newline newline
exit 0 exit 0
} }
stamp() { stamp() {
(date +%F" "%T) (date +%F" "%T)
} }
newline() { newline() {
printf "\n" printf "\n"
} }
textBlock() { textBlock() {
printf "%s\n" "$1" | fold -w "$width" -s printf "%s\n" "$1" | fold -w "$width" -s
} }
textBlockDefaults() { textBlockDefaults() {
printf "%s%s%s\n" "$yellow" "$1" "$norm" printf "%s%s%s\n" "$yellow" "$1" "$norm"
} }
textBlockSwitches() { textBlockSwitches() {
printf "%s%s%s\n" "$cyan" "$1" "$norm" printf "%s%s%s\n" "$cyan" "$1" "$norm"
} }
writeLog() { writeLog() {
case "$1" in case "$1" in
cf) cf)
printf "[%s] CF-ERR: %s (code: %s)\n" "$(stamp)" "$2" "$3" >>"$logFile" printf "[%s] CF-ERR: %s (code: %s)\n" "$(stamp)" "$2" "$3" >>"$logFile"
;; ;;
err) err)
printf "%s[%s] ERR: %s%s\n" "$err" "$(stamp)" "$2" "$norm" >>"$logFile" printf "%s[%s] ERR: %s%s\n" "$err" "$(stamp)" "$2" "$norm" >>"$logFile"
;; ;;
error) error)
printf "%s[%s] ERROR: %s (code: %s)%s\n" "$err" "$(stamp)" "$2" "$3" "$norm" >>"$logFile" printf "%s[%s] ERROR: %s (code: %s)%s\n" "$err" "$(stamp)" "$2" "$3" "$norm" >>"$logFile"
;; ;;
process) process)
printf "%s[%s] %s... %s" "$cyan" "$(stamp)" "$2" "$norm" >>"$logFile" printf "%s[%s] %s... %s" "$cyan" "$(stamp)" "$2" "$norm" >>"$logFile"
;; ;;
process-done) process-done)
printf "%s%s%s\n" "$cyan" "$2" "$norm" >>"$logFile" printf "%s%s%s\n" "$cyan" "$2" "$norm" >>"$logFile"
;; ;;
process-error) process-error)
printf "%sERROR%s\n" "$err" "$norm" >>"$logFile" printf "%sERROR%s\n" "$err" "$norm" >>"$logFile"
;; ;;
process-warning) process-warning)
printf "%s%s%s\n" "$warn" "$2" "$norm" >>"$logFile" printf "%s%s%s\n" "$warn" "$2" "$norm" >>"$logFile"
;; ;;
stamped) stamped)
printf "[%s] %s\n" "$(stamp)" "$2" >>"$logFile" printf "[%s] %s\n" "$(stamp)" "$2" >>"$logFile"
;; ;;
success) success)
printf "%s[%s] SUCCESS: %s%s\n" "$ok" "$(stamp)" "$2" "$norm" >>"$logFile" printf "%s[%s] SUCCESS: %s%s\n" "$ok" "$(stamp)" "$2" "$norm" >>"$logFile"
;; ;;
warn) warn)
printf "%s[%s] WARN: %s%s\n" "$warn" "$(stamp)" "$2" "$norm" >>"$logFile" printf "%s[%s] WARN: %s%s\n" "$warn" "$(stamp)" "$2" "$norm" >>"$logFile"
;; ;;
warning) warning)
printf "%s[%s] WARNING: %s%s\n" "$warn" "$(stamp)" "$2" "$norm" >>"$logFile" printf "%s[%s] WARNING: %s%s\n" "$warn" "$(stamp)" "$2" "$norm" >>"$logFile"
;; ;;
*) *)
printf "%s\n" "$2" >>"$logFile" printf "%s\n" "$2" >>"$logFile"
;; ;;
esac esac
} }
### default variable values ### default variable values
@@ -272,284 +272,293 @@ failedHostCount=0
### process startup parameters ### process startup parameters
if [ -z "$1" ]; then if [ -z "$1" ]; then
scriptHelp scriptHelp
fi fi
while [ $# -gt 0 ]; do while [ $# -gt 0 ]; do
case "$1" in case "$1" in
-h | -\? | --help) -h | -\? | --help)
# display help # display help
scriptHelp scriptHelp
;; ;;
--examples) --examples)
# display sample commands # display sample commands
scriptExamples scriptExamples
;; ;;
-l | --log) -l | --log)
# set log file location # set log file location
if [ -n "$2" ]; then if [ -n "$2" ]; then
logFile="${2%/}" logFile="${2%/}"
shift shift
else else
badParam null "$@" badParam null "$@"
fi fi
;; ;;
--log-console) --log-console)
# log to the console instead of a file # log to the console instead of a file
logFile="/dev/stdout" logFile="/dev/stdout"
;; ;;
--log-journal) --log-journal)
# log to the journal system instead of a file # log to the journal system instead of a file
logToJournal=1 logToJournal=1
;; ;;
--no-log) --no-log)
# do not log anything # do not log anything
logFile="/dev/null" logFile="/dev/null"
;; ;;
--nc | --no-color | --no-colour) --nc | --no-color | --no-colour)
# do not colourize log file # do not colourize log file
colourizeLogFile=0 colourizeLogFile=0
;; ;;
-c | --cred* | -f) -c | --cred* | -f)
# path to Cloudflare credentials file # path to Cloudflare credentials file
if [ -n "$2" ]; then if [ -n "$2" ]; then
if [ -f "$2" ] && [ -s "$2" ]; then if [ -f "$2" ] && [ -s "$2" ]; then
accountFile="${2%/}" accountFile="${2%/}"
shift shift
else else
badParam dne "$@" badParam dne "$@"
fi fi
else else
badParam null "$@" badParam null "$@"
fi fi
;; ;;
-r | --record | --records) -r | --record | --records)
# DNS records to update # DNS records to update
if [ -n "$2" ]; then if [ -n "$2" ]; then
dnsRecords=$(printf "%s" "$2" | sed -e 's/ //g') dnsRecords=$(printf "%s" "$2" | sed -e 's/ //g')
shift shift
else else
badParam null "$@" badParam null "$@"
fi fi
;; ;;
-i | --ip | --ip-address | -a | --address) -i | --ip | --ip-address | -a | --address)
# IP address to use (not parsed for correctness) # IP address to use (not parsed for correctness)
if [ -n "$2" ]; then if [ -n "$2" ]; then
ipAddress="$2" ipAddress="$2"
shift shift
else else
badParam null "$@" badParam null "$@"
fi fi
;; ;;
-4 | --ip4 | --ipv4) -4 | --ip4 | --ipv4)
# operate in IP4 mode (default) # operate in IP4 mode (default)
ip4=1 ip4=1
ip6=0 ip6=0
;; ;;
-6 | --ip6 | --ipv6) -6 | --ip6 | --ipv6)
# operate in IP6 mode # operate in IP6 mode
ip6=1 ip6=1
ip4=0 ip4=0
;; ;;
*) *)
printf "\n%sUnknown option: %s\n" "$err" "$1" printf "\n%sUnknown option: %s\n" "$err" "$1"
printf "%sUse '--help' for valid options.%s\n\n" "$cyan" "$norm" printf "%sUse '--help' for valid options.%s\n\n" "$cyan" "$norm"
exit 1 exit 1
;; ;;
esac esac
shift shift
done done
### pre-flight checks ### pre-flight checks
if ! command -v curl >/dev/null; then if ! command -v curl >/dev/null; then
printf "\n%sThis script requires 'curl' be installed and accessible. Exiting.%s\n\n" "$err" "$norm" printf "\n%sThis script requires 'curl' be installed and accessible. Exiting.%s\n\n" "$err" "$norm"
exit 2 exit 2
fi fi
if ! command -v jq >/dev/null; then if ! command -v jq >/dev/null; then
printf "\n%sThis script requires 'jq' be installed and accessible. Exiting.%s\n\n" "$err" "$norm" printf "\n%sThis script requires 'jq' be installed and accessible. Exiting.%s\n\n" "$err" "$norm"
exit 2 exit 2
fi fi
[ -z "$dnsRecords" ] && badParam errMsg "You must specify at least one DNS record to update. Exiting." [ -z "$dnsRecords" ] && badParam errMsg "You must specify at least one DNS record to update. Exiting."
# verify credentials file exists and is not empty (default check) # verify credentials file exists and is not empty (default check)
if [ ! -f "$accountFile" ] || [ ! -s "$accountFile" ]; then if [ ! -f "$accountFile" ] || [ ! -s "$accountFile" ]; then
badParam errMsg "Cannot find Cloudflare credentials file (${accountFile}). Exiting." badParam errMsg "Cannot find Cloudflare credentials file (${accountFile}). Exiting."
fi fi
if ! command -v logger >/dev/null 2>&1; then if ! command -v logger >/dev/null 2>&1; then
printf "\n%sThis script requires 'logger' be installed to write entries to your journaling system. Exiting.%s\n\n" "$err" "$norm" printf "\n%sThis script requires 'logger' be installed to write entries to your journaling system. Exiting.%s\n\n" "$err" "$norm"
exit 2 exit 2
fi fi
# turn off log file colourization if parameter is set # turn off log file colourization if parameter is set
if [ "$colourizeLogFile" -eq 0 ]; then if [ "$colourizeLogFile" -eq 0 ]; then
bold="" bold=""
cyan="" cyan=""
err="" err=""
magenta="" magenta=""
norm="" norm=""
ok="" ok=""
warn="" warn=""
yellow="" yellow=""
fi fi
### initial log entries ### initial log entries
{ {
printf "%s[%s] -- Cloudflare DDNS update-script: starting --%s\n" "$ok" "$(stamp)" "$norm"
printf "Parameters:\n"
printf "script path: %s\n" "$scriptPath/$scriptName"
printf "credentials file: %s\n" "$accountFile"
printf "%s[%s] -- Cloudflare DDNS update-script: starting --%s\n" "$ok" "$(stamp)" "$norm"
printf "Parameters:\n"
printf "script path: %s\n" "$scriptPath/$scriptName"
printf "credentials file: %s\n" "$accountFile"
if [ "$ip4" -eq 1 ]; then
printf "mode: IP4\n"
elif [ "$ip6" -eq 1 ]; then
printf "mode: IP6\n"
fi
# detect and report IP address
if [ -z "$ipAddress" ]; then
# detect public ip address
if [ "$ip4" -eq 1 ]; then if [ "$ip4" -eq 1 ]; then
printf "mode: IP4\n" if ! ipAddress="$(curl -s $ip4DetectionSvc)"; then
elif [ "$ip6" -eq 1 ]; then printf "ddns ip address:%s ERROR%s\n" "$err" "$norm"
printf "mode: IP6\n" exitError 10
fi
fi fi
if [ "$ip6" -eq 1 ]; then
# detect and report IP address if ! ipAddress="$(curl -s $ip6DetectionSvc)"; then
if [ -z "$ipAddress" ]; then printf "ddns ip address:%s ERROR%s\n" "$err" "$norm"
# detect public ip address exitError 10
if [ "$ip4" -eq 1 ]; then fi
if ! ipAddress="$(curl -s $ip4DetectionSvc)"; then
printf "ddns ip address:%s ERROR%s\n" "$err" "$norm"
exitError 10
fi
fi
if [ "$ip6" -eq 1 ]; then
if ! ipAddress="$(curl -s $ip6DetectionSvc)"; then
printf "ddns ip address:%s ERROR%s\n" "$err" "$norm"
exitError 10
fi
fi
printf "ddns ip address (detected): %s\n" "$ipAddress"
else
printf "ddns ip address (supplied): %s\n" "$ipAddress"
fi fi
printf "ddns ip address (detected): %s\n" "$ipAddress"
else
printf "ddns ip address (supplied): %s\n" "$ipAddress"
fi
# iterate DNS records to update # iterate DNS records to update
dnsRecordsToUpdate="$(printf '%s' "${dnsRecords}" | sed "s/${dnsSeparator}*$//")$dnsSeparator" dnsRecordsToUpdate="$(printf '%s' "${dnsRecords}" | sed "s/${dnsSeparator}*$//")$dnsSeparator"
while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator" ]; do while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator" ]; do
record="${dnsRecordsToUpdate%%${dnsSeparator}*}" record="${dnsRecordsToUpdate%%${dnsSeparator}*}"
dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}" dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}"
if [ -z "$record" ]; then continue; fi if [ -z "$record" ]; then
printf "updating record: %s\n" "$record" continue
done fi
printf "updating record: %s\n" "$record"
done
printf "(end of parameter list)\n" printf "(end of parameter list)\n"
} >>"$logFile" } >>"$logFile"
### read Cloudflare credentials ### read Cloudflare credentials
writeLog process "Reading Cloudflare credentials" writeLog process "Reading Cloudflare credentials"
case "$accountFile" in case "$accountFile" in
/*) /*)
# absolute path, use as-is # absolute path, use as-is
# shellcheck source=./cloudflare.credentials # shellcheck source=./cloudflare.credentials
. "$accountFile" . "$accountFile"
;; ;;
*) *)
# relative path, rewrite # relative path, rewrite
# shellcheck source=./cloudflare.credentials # shellcheck source=./cloudflare.credentials
. "./$accountFile" . "./$accountFile"
;; ;;
esac esac
if [ -z "$cfKey" ]; then if [ -z "$cfKey" ]; then
writeLog process-error writeLog process-error
exitError 21 exitError 21
fi fi
if [ -z "$cfZoneId" ]; then if [ -z "$cfZoneId" ]; then
writeLog process-error writeLog process-error
exitError 22 exitError 22
fi fi
writeLog process-done "DONE" writeLog process-done "DONE"
### connect to Cloudflare and do what needs to be done! ### connect to Cloudflare and do what needs to be done!
dnsRecordsToUpdate="$dnsRecords$dnsSeparator" dnsRecordsToUpdate="$dnsRecords$dnsSeparator"
if [ "$ip4" -eq 1 ]; then if [ "$ip4" -eq 1 ]; then
recordType="A" recordType="A"
elif [ "$ip6" -eq 1 ]; then elif [ "$ip6" -eq 1 ]; then
recordType="AAAA" recordType="AAAA"
fi fi
# iterate hosts to update # iterate hosts to update
while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator" ]; do while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator" ]; do
record="${dnsRecordsToUpdate%%${dnsSeparator}*}" record="${dnsRecordsToUpdate%%${dnsSeparator}*}"
dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}" dnsRecordsToUpdate="${dnsRecordsToUpdate#*${dnsSeparator}}"
if [ -z "$record" ]; then continue; fi if [ -z "$record" ]; then
writeLog process "Processing ${record}" continue
fi
writeLog process "Processing ${record}"
# exit if curl/network error # exit if curl/network error
if ! cfLookup="$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records?name=${record}&type=${recordType}" \ if ! cfLookup="$(
-H "Authorization: Bearer ${cfKey}" \ curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records?name=${record}&type=${recordType}" \
-H "Content-Type: application/json")"; then -H "Authorization: Bearer ${cfKey}" \
writeLog process-error -H "Content-Type: application/json"
exitError 3 )"; then
fi writeLog process-error
exitError 3
fi
# exit if API error # exit if API error
# exit here since API errors on GET request probably indicates authentication error which would affect all remaining operations # exit here since API errors on GET request probably indicates authentication error which would affect all remaining operations
# no reason to continue processing other hosts and pile-up errors which might look like a DoS attempt # no reason to continue processing other hosts and pile-up errors which might look like a DoS attempt
cfSuccess="$(printf "%s" "$cfLookup" | jq -r '.success')" cfSuccess="$(printf "%s" "$cfLookup" | jq -r '.success')"
if [ "$cfSuccess" = "false" ]; then if [ "$cfSuccess" = "false" ]; then
writeLog process-error writeLog process-error
listCFErrors "$cfLookup" listCFErrors "$cfLookup"
exitError 25 exitError 25
fi fi
resultCount="$(printf "%s" "$cfLookup" | jq '.result_info.count')" resultCount="$(printf "%s" "$cfLookup" | jq '.result_info.count')"
# skip to next host if cannot find existing host record (this script *updates* only, does not create!) # skip to next host if cannot find existing host record (this script *updates* only, does not create!)
if [ "$resultCount" = "0" ]; then if [ "$resultCount" = "0" ]; then
# warn if record of host not found # warn if record of host not found
writeLog process-warning "NOT FOUND" writeLog process-warning "NOT FOUND"
writeLog warn "Cannot find existing record to update for DNS entry: ${record}" writeLog warn "Cannot find existing record to update for DNS entry: ${record}"
invalidDomainCount=$((invalidDomainCount + 1)) invalidDomainCount=$((invalidDomainCount + 1))
continue continue
fi fi
objectId=$(printf "%s" "$cfLookup" | jq -r '.result | .[] | .id') objectId=$(printf "%s" "$cfLookup" | jq -r '.result | .[] | .id')
currentIpAddr=$(printf "%s" "$cfLookup" | jq -r '.result | .[] | .content') currentIpAddr=$(printf "%s" "$cfLookup" | jq -r '.result | .[] | .content')
writeLog process-done "FOUND: IP = ${currentIpAddr}" writeLog process-done "FOUND: IP = ${currentIpAddr}"
# skip to next hostname if record already up-to-date # skip to next hostname if record already up-to-date
if [ "$currentIpAddr" = "$ipAddress" ]; then if [ "$currentIpAddr" = "$ipAddress" ]; then
writeLog stamped "IP address for ${record} is already up-to-date" writeLog stamped "IP address for ${record} is already up-to-date"
continue continue
fi fi
# update record # update record
writeLog process "Updating IP address for ${record}" writeLog process "Updating IP address for ${record}"
updateJSON="$(jq -n --arg key0 content --arg value0 "${ipAddress}" '{($key0):$value0}')" updateJSON="$(jq -n --arg key0 content --arg value0 "${ipAddress}" '{($key0):$value0}')"
# exit if curl/network error # exit if curl/network error
if ! cfResult="$(curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records/${objectId}" \ if ! cfResult="$(
-H "Authorization: Bearer ${cfKey}" \ curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records/${objectId}" \
-H "Content-Type: application/json" \ -H "Authorization: Bearer ${cfKey}" \
--data "${updateJSON}")"; then -H "Content-Type: application/json" \
writeLog process-error --data "${updateJSON}"
exitError 3 )"; then
fi writeLog process-error
exitError 3
fi
# note update success or failure # note update success or failure
cfSuccess="$(printf "%s" "$cfResult" | jq '.success')" cfSuccess="$(printf "%s" "$cfResult" | jq '.success')"
if [ "$cfSuccess" = "true" ]; then if [ "$cfSuccess" = "true" ]; then
writeLog process-done "DONE" writeLog process-done "DONE"
writeLog success "IP address for ${record} updated." writeLog success "IP address for ${record} updated."
else else
writeLog process-error writeLog process-error
listCFErrors "$cfResult" listCFErrors "$cfResult"
writeLog err "Unable to update IP address for ${record}" writeLog err "Unable to update IP address for ${record}"
# do not exit with error, API error here is probably an update issue specific to this host # do not exit with error, API error here is probably an update issue specific to this host
# increment counter and note it after all processing finished # increment counter and note it after all processing finished
failedHostCount=$((failedHostCount + 1)) failedHostCount=$((failedHostCount + 1))
fi fi
done done
# exit # exit
if [ "$invalidDomainCount" -ne 0 ]; then if [ "$invalidDomainCount" -ne 0 ]; then
writeLog warning "${invalidDomainCount} invalid host(s) supplied for updating." writeLog warning "${invalidDomainCount} invalid host(s) supplied for updating."
fi fi
if [ "$failedHostCount" -ne 0 ]; then if [ "$failedHostCount" -ne 0 ]; then
exitError 26 exitError 26
else else
exitOK exitOK
fi fi
### exit return codes ### exit return codes