42 Commits

Author SHA1 Message Date
asif 1732de343d refactor(func): Remove unused functions
Remvoe the logging functions replaced by the new structured implementation.
2026-07-23 23:22:17 -06:00
asif 51b2b455a2 feat(log): Use plain-text logging for all messages
Convert all logging output to plain-text structured messages using new function.
2026-07-23 23:16:12 -06:00
asif f8f3bf1539 refactor(func): Change default err code to 0 2026-07-23 22:17:15 -06:00
asif f8908d7830 feat(func): Write modified syslog fmt msg
Take input parameters and generate a modified syslog-style log entry.
2026-07-23 21:59:58 -06:00
asif 8a5a72e15a feat(func): Convert to uniform log levels
Take input text with various references to log levels and return a standardized uppercase log level name.
2026-07-23 21:57:30 -06:00
asif 1da49b06db feat(func): Convert text ucase, lcase 2026-07-23 21:56:19 -06:00
asif 1336c8e63b feat(func): Retrieve machine host name 2026-07-23 21:55:56 -06:00
asif 450733a8d5 feat(func): Generate ISO-8601 timestamp 2026-07-23 21:55:25 -06:00
asif 92e69d1b85 fix(logger): Fix JournalD log levels
Log levels were reversed in the translation function.
2026-07-23 00:20:30 -06:00
asif 00ea88780d feat(logger): Echo vs return values from Translate func 2026-07-23 00:18:03 -06:00
asif d9aa8973a3 fix(logger): Perform cmd subst outside heredoc
Perform function and command value substitution outside the heredoc forwarded to logger for JournalD entries.
2026-07-23 00:17:42 -06:00
asif ec75cffbf1 fix(logger): Ensure log levels are lcase before standardization 2026-07-23 00:16:19 -06:00
asif b8fb744623 fix(logger): Fix error in json logger
Assignment to 'pid' argument was incorrect.
2026-07-22 23:50:33 -06:00
asif d0b2c781bf feat(logger): Update test cases
Update JSON and JOURNALD tests to match text tests and use new functions.
2026-07-22 23:48:16 -06:00
asif c4d28d1f8c fix(logger): Fix default subst
Default parameter substitution in all functions was incorrect.
2026-07-22 23:44:08 -06:00
asif f085838781 feat(logger): Add test with operation, error code 2026-07-22 23:42:52 -06:00
asif 4a6c339a07 fix(logger): Fix default subst
Default variable substitution in plain-text function was incorrect.
2026-07-22 23:42:33 -06:00
asif c94f12e976 fix(logger): Fix error in uppercase func
'upper' and 'lower' translate strings were not supplied separately.
2026-07-22 23:38:45 -06:00
asif 5443612381 feat(logger): Add plain-text test output 2026-07-22 23:35:08 -06:00
asif df144a5211 fix(logger): Remove errant 'fi' statements
Remove 'fi' statements left over from previous logic checks.
2026-07-22 23:33:49 -06:00
asif 04811805c3 feat(logger): Remove unused global vars 2026-07-22 23:25:28 -06:00
asif aa446c00e6 feat(logger): Update journal logging function
Use new standardized format fields.
2026-07-22 23:24:52 -06:00
asif 56a5ad59fe refactor(logger): Rename writeJournalLog function
Rename from 'writeJournalLog' to 'writeJournalDLog' for specificity.
2026-07-22 23:19:51 -06:00
asif ce1ab86d22 fix(logger): Fix JSON logger
Level and status were swapped. JSON output was missing new prefix information (timestamp, hostname, etc.)
2026-07-22 23:18:36 -06:00
asif cae57ccf6b feat(logger): Use standardized log levels for JSON 2026-07-22 23:15:44 -06:00
asif 0fcd0d9c13 refactor(logger): Use standardized log levels for plain-text 2026-07-22 23:15:11 -06:00
asif e411a35b93 feat(logger): Add log level translator functions 2026-07-22 23:13:58 -06:00
asif 0e787be456 feat(logger): Add lowercase function 2026-07-22 23:06:34 -06:00
asif 17c33d237f fix(logger): Ensure plain-text status is uppercase 2026-07-22 22:54:25 -06:00
asif 5b55ac95a3 feat(logger): Update JSON logger
Require message, level, and status. Reorganize JSON output to mirror modified syslog-style structure.
2026-07-22 22:53:38 -06:00
asif f4dc8f44b1 feat(logger): Handle plain-text insufficient information
Return without logging if message, level and/or status is not supplied.
2026-07-22 22:49:13 -06:00
asif 3792881529 feature(logger): Add plain-text logger function 2026-07-22 22:42:49 -06:00
asif c1f54a619c refactor(logger): Use ISO8601 timestamp 2026-07-22 21:52:53 -06:00
asif 4c997a6b7d feature [logger] add status logging param 2026-07-22 18:34:14 -06:00
asif 1824d9f139 feat(logger): Framework test file 2026-07-22 17:33:46 -06:00
asif 50b4cf105f chore(ide): Update IDE settings 2026-07-22 17:33:36 -06:00
asif 1e3b545a23 chore(ide): JetBrains IDE configuration files 2026-07-19 23:37:13 -06:00
asif 380509c966 chore(git): Update git control files 2026-07-19 23:36:58 -06:00
asif 71da487aa8 style(fmt): Reformat shell script 2026-07-19 23:33:56 -06:00
asif 3be6eaee0c [preflight] Add check for logger dependency
'logger' is required to facilitate logging to the journaling system.
2026-07-19 18:52:34 -06:00
asif 5c6c8ec4ea [params] Create journal logging switch
Create boolean variable to store journal logging preference.
Set to 'false' by default. Add parameter to activate this preference.
Update help to include this new parameter.
2026-07-19 18:49:34 -06:00
asif c7297a512c [version] Update version, modified date 2026-07-19 15:44:40 -06:00
10 changed files with 686 additions and 434 deletions
+19
View File
@@ -55,6 +55,23 @@
*.bat text eol=crlf *.bat text eol=crlf
*.cmd text eol=crlf *.cmd text eol=crlf
# web frontend stack -- force LF so SRI hashes are always correct
*.html text eol=lf
*.htm text eol=lf
*.css text eol=lf
*.min.css text eol=lf
*.js text eol=lf
*.min.js text eol=lf
*.php text eol=lf
# Visual Studio projects (Rider also)
*.cs diff=csharp
*.sln merge=union
*.csproj merge=union
*.vbproj merge=union
*.fsproj merge=union
*.dbproj merge=union
# Serialisation # Serialisation
*.json text *.json text
*.toml text *.toml text
@@ -79,3 +96,5 @@
.gitattributes export-ignore .gitattributes export-ignore
.gitignore export-ignore .gitignore export-ignore
.gitkeep export-ignore .gitkeep export-ignore
.idea export-ignore
.vscode export-ignore
+34
View File
@@ -1 +1,35 @@
#
# JetBrains exclusions
#
riderModule.iml
/_ReSharper.Caches/
# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf
# Generated files
.idea/**/contentModel.xml
.idea/**/GitCommitMessageStorage.xml
# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
# modules
.idea_modules/
# Editor-based Rest Client
.idea/httpRequests
# project-specific exclusions
*.log *.log
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="DeveloperToolsToolWindowSettingsV1" lastSelectedContentNodeId="base64-encoder-decoder" pluginVersion="9.0.0">
<developerToolsConfigurations />
</component>
</project>
+15
View File
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="GitToolBoxProjectSettings">
<option name="commitMessageIssueKeyValidationOverride">
<BoolValueOverride>
<option name="enabled" value="true" />
</BoolValueOverride>
</option>
<option name="commitMessageValidationEnabledOverride">
<BoolValueOverride>
<option name="enabled" value="true" />
</BoolValueOverride>
</option>
</component>
</project>
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="UserContentModel">
<attachedFolders />
<explicitIncludes />
<explicitExcludes />
</component>
</project>
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="com.itcodebox.notebooks.projectservice.ProjectUIState">
<option name="selectedNotebookId" value="1" />
<option name="selectedChapterId" value="1" />
<option name="selectedNoteId" value="1" />
</component>
</project>
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="RiderProjectSettingsUpdater">
<option name="singleClickDiffPreview" value="1" />
<option name="unhandledExceptionsIgnoreList" value="1" />
<option name="vcsConfiguration" value="3" />
</component>
</project>
Generated
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="" vcs="Git" />
</component>
</project>
+136 -149
View File
@@ -3,8 +3,8 @@
# #
# update Cloudflare DNS records with current (dynamic) IP address # update Cloudflare DNS records with current (dynamic) IP address
# Script by Asif Bacchus <asif@bacchus.cloud> # Script by Asif Bacchus <asif@bacchus.cloud>
# Last modified: May 10, 2021 # Last modified: July 19, 2026
# Version 2.2 # Version 3.0
# #
### text formatting presets using tput ### text formatting presets using tput
@@ -31,7 +31,6 @@ else
width=80 width=80
fi fi
### 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"
@@ -47,65 +46,80 @@ badParam() {
fi fi
} }
exitError() { getHostname() {
case "$1" in (hostname -s)
3)
errMsg="Unable to connect to Cloudflare servers. This is probably a temporary networking issue. Please try again later."
;;
10)
errMsg="Unable to auto-detect IP address. Try again later or supply the IP address to be used."
;;
20)
errMsg="Cloudflare authorized email address (cfEmail) is either null or undefined. Please check your Cloudflare credentials file."
;;
21)
errMsg="Cloudflare authorized API key (cfKey) is either null or undefined. Please check your Cloudflare credentials file."
;;
22)
errMsg="Cloudflare zone id (cfZoneId) is either null or undefined. Please check your Cloudflare credentials file."
;;
25)
errMsg="Cloudflare API error. Please review any 'CF-ERR:' lines in this log for details."
;;
26)
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)"
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"
exit "$1"
} }
exitOK() { getTimeStamp() {
printf "%s[%s] -- Cloudflare DDNS update-script: completed successfully --%s\n" "$ok" "$(stamp)" "$norm" >>"$logFile" (date -u +"%Y-%m-%dT%H:%M:%SZ")
exit 0
} }
lowercase() {
echo "$1" | tr '[:upper:]' '[:lower:]'
}
uppercase() {
echo "$1" | tr '[:lower:]' '[:upper:]'
}
# 1: cloudflare error object, 2: operation identifier
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, assemble into a coherent log message
while [ -n "$codes" ] && [ -n "$messages" ]; do while [ -n "$codes" ] && [ -n "$messages" ]; do
# get first code and message in respective sets # get the 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 sets of codes and messages by removing the first item (above) in each set
codes="${codes#*_}" codes="${codes#*_}"
messages="${messages#*_}" messages="${messages#*_}"
# output to log # output to log
writeLog cf "$message" "$code" writePlainTextLog "${message}" "err" "fail" "$2" "$code"
done done
} }
standardizeLogLevels() {
LEVEL_TO_STANDARDIZE="$(lowercase "$1")"
case "$LEVEL_TO_STANDARDIZE" in
"critical" | "crit" | "fatal")
echo "CRIT"
;;
"error" | "err")
echo "ERR"
;;
"warning" | "warn")
echo "WARN"
;;
"information" | "info")
echo "INFO"
;;
"debug" | "verbose")
echo "DEBUG"
;;
*)
echo "INFO"
;;
esac
}
# modified syslog fmt: <ISO-8601 timestamp> <hostname> <tag>[pid]: [LEVEL:$2] [STATUS:$3] <MESSAGE:$1> (<OPERATION:$4>:<CODE:$5>)
writePlainTextLog() {
# not enough information to generate a meaningful log message
if [ -z "$1" ] || [ $# -lt 3 ]; then
return
fi
printf "%s %s %s[%s]: [%s] [%s] %s (%s:%s)\n" \
"$(getTimeStamp)" "$(getHostname)" "$LOG_PROGRAM_NAME" "$$" \
"$(standardizeLogLevels "$2")" "$(uppercase "$3")" "$1" "${4:-UNSPECIFIED}" "${5:-0}" \
>>"$logFile"
}
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"
@@ -157,6 +171,10 @@ scriptHelp() {
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"
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)"
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)"
@@ -188,10 +206,6 @@ scriptHelp() {
exit 0 exit 0
} }
stamp() {
(date +%F" "%T)
}
newline() { newline() {
printf "\n" printf "\n"
} }
@@ -208,51 +222,11 @@ textBlockSwitches() {
printf "%s%s%s\n" "$cyan" "$1" "$norm" printf "%s%s%s\n" "$cyan" "$1" "$norm"
} }
writeLog() {
case "$1" in
cf)
printf "[%s] CF-ERR: %s (code: %s)\n" "$(stamp)" "$2" "$3" >>"$logFile"
;;
err)
printf "%s[%s] ERR: %s%s\n" "$err" "$(stamp)" "$2" "$norm" >>"$logFile"
;;
error)
printf "%s[%s] ERROR: %s (code: %s)%s\n" "$err" "$(stamp)" "$2" "$3" "$norm" >>"$logFile"
;;
process)
printf "%s[%s] %s... %s" "$cyan" "$(stamp)" "$2" "$norm" >>"$logFile"
;;
process-done)
printf "%s%s%s\n" "$cyan" "$2" "$norm" >>"$logFile"
;;
process-error)
printf "%sERROR%s\n" "$err" "$norm" >>"$logFile"
;;
process-warning)
printf "%s%s%s\n" "$warn" "$2" "$norm" >>"$logFile"
;;
stamped)
printf "[%s] %s\n" "$(stamp)" "$2" >>"$logFile"
;;
success)
printf "%s[%s] SUCCESS: %s%s\n" "$ok" "$(stamp)" "$2" "$norm" >>"$logFile"
;;
warn)
printf "%s[%s] WARN: %s%s\n" "$warn" "$(stamp)" "$2" "$norm" >>"$logFile"
;;
warning)
printf "%s[%s] WARNING: %s%s\n" "$warn" "$(stamp)" "$2" "$norm" >>"$logFile"
;;
*)
printf "%s\n" "$2" >>"$logFile"
;;
esac
}
### default variable values ### default variable values
scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)" scriptPath="$(CDPATH='' \cd -- "$(dirname -- "$0")" && pwd -P)"
scriptName="$(basename "$0")" scriptName="$(basename "$0")"
logFile="$scriptPath/${scriptName%.*}.log" logFile="$scriptPath/${scriptName%.*}.log"
logToJournal=0
accountFile="$scriptPath/cloudflare.credentials" accountFile="$scriptPath/cloudflare.credentials"
colourizeLogFile=1 colourizeLogFile=1
dnsRecords="" dnsRecords=""
@@ -292,6 +266,10 @@ while [ $# -gt 0 ]; do
# 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 to the journal system instead of a file
logToJournal=1
;;
--no-log) --no-log)
# do not log anything # do not log anything
logFile="/dev/null" logFile="/dev/null"
@@ -353,16 +331,26 @@ 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"
writePlainTextLog "'curl' must be installed and accessible" "fatal" "fail" "preexec" 2
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"
writePlainTextLog "'jq' must be installed and accessible" "fatal" "fail" "preexec" 2
exit 2 exit 2
fi fi
[ -z "$dnsRecords" ] && badParam errMsg "You must specify at least one DNS record to update. Exiting." if [ -z "$dnsRecords" ]; then
# verify credentials file exists and is not empty (default check) badParam errMsg "You must specify at least one DNS record to update. Exiting."
writePlainTextLog "At least one DNS record to update must be specified" "fatal" "fail" "params" 1
fi
# verify the 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 the Cloudflare credentials file (${accountFile}). Exiting."
writePlainTextLog "Cannot find the specified Cloudflare credentials file (${accountFile})" "fatal" "fail" "params" 1
fi
if [ "$logToJournal" -eq 1 ] && ! 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"
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
@@ -377,16 +365,14 @@ if [ "$colourizeLogFile" -eq 0 ]; then
fi fi
### initial log entries ### initial log entries
{ writePlainTextLog "starting '${scriptName}'" "info" "ok" "script"
printf "%s[%s] -- Cloudflare DDNS update-script: starting --%s\n" "$ok" "$(stamp)" "$norm" writePlainTextLog "script path: ${scriptPath}/${scriptName}" "debug" "ok" "startup"
printf "Parameters:\n" writePlainTextLog "credentials file: ${accountFile}" "debug" "ok" "startup"
printf "script path: %s\n" "$scriptPath/$scriptName"
printf "credentials file: %s\n" "$accountFile"
if [ "$ip4" -eq 1 ]; then if [ "$ip4" -eq 1 ]; then
printf "mode: IP4\n" writePlainTextLog "mode: IPv4" "debug" "ok" "startup"
elif [ "$ip6" -eq 1 ]; then elif [ "$ip6" -eq 1 ]; then
printf "mode: IP6\n" writePlainTextLog "mode: IPv6" "debug" "ok" "startup"
fi fi
# detect and report IP address # detect and report IP address
@@ -394,19 +380,21 @@ fi
# detect public ip address # detect public ip address
if [ "$ip4" -eq 1 ]; then if [ "$ip4" -eq 1 ]; then
if ! ipAddress="$(curl -s $ip4DetectionSvc)"; then if ! ipAddress="$(curl -s $ip4DetectionSvc)"; then
printf "ddns ip address:%s ERROR%s\n" "$err" "$norm" writePlainTextLog \
exitError 10 "Unable to auto-detect this machine's public IP address; try again later or supply the IP address to be used" "err" "fail" "detectip" 10
exit 10
fi fi
fi fi
if [ "$ip6" -eq 1 ]; then if [ "$ip6" -eq 1 ]; then
if ! ipAddress="$(curl -s $ip6DetectionSvc)"; then if ! ipAddress="$(curl -s $ip6DetectionSvc)"; then
printf "ddns ip address:%s ERROR%s\n" "$err" "$norm" writePlainTextLog \
exitError 10 "Unable to auto-detect this machine's public IP address; try again later or supply the IP address to be used" "err" "fail" "detectip" 10
exit 10
fi fi
fi fi
printf "ddns ip address (detected): %s\n" "$ipAddress" writePlainTextLog "DDNS IP address (detected): $ipAddress" "info" "ok" "startup"
else else
printf "ddns ip address (supplied): %s\n" "$ipAddress" writePlainTextLog "DDNS IP address (supplied): $ipAddress" "info" "ok" "startup"
fi fi
# iterate DNS records to update # iterate DNS records to update
@@ -415,15 +403,13 @@ fi
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
fi
writePlainTextLog "DNS host record '${record}' queued for update" "info" "ok" "startup"
done done
printf "(end of parameter list)\n"
} >>"$logFile"
### read Cloudflare credentials ### read Cloudflare credentials
writeLog process "Reading Cloudflare credentials"
case "$accountFile" in case "$accountFile" in
/*) /*)
# absolute path, use as-is # absolute path, use as-is
@@ -437,14 +423,14 @@ case "$accountFile" in
;; ;;
esac esac
if [ -z "$cfKey" ]; then if [ -z "$cfKey" ]; then
writeLog process-error writePlainTextLog "Cloudflare authorized API key (cfKey) is either null or undefined; please check your Cloudflare credentials file" "err" "fail" "creds" 21
exitError 21 exit 21
fi fi
if [ -z "$cfZoneId" ]; then if [ -z "$cfZoneId" ]; then
writeLog process-error writePlainTextLog "Cloudflare zone id (cfZoneId) is either null or undefined; please check your Cloudflare credentials file" "err" "fail" "creds" 22
exitError 22 exit 22
fi fi
writeLog process-done "DONE" writePlainTextLog "Cloudflare credentials file read successfully" "debug" "ok" "creds"
### 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"
@@ -459,70 +445,69 @@ while [ -n "$dnsRecordsToUpdate" ] && [ "$dnsRecordsToUpdate" != "$dnsSeparator"
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
# 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}" \
-H "Authorization: Bearer ${cfKey}" \
-H "Content-Type: application/json")"; then
writeLog process-error
exitError 3
fi fi
# exit if API error # exit if curl/network error
# exit here since API errors on GET request probably indicates authentication error which would affect all remaining operations if ! cfLookup="$(
# no reason to continue processing other hosts and pile-up errors which might look like a DoS attempt curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records?name=${record}&type=${recordType}" \
-H "Authorization: Bearer ${cfKey}" \
-H "Content-Type: application/json"
)"; then
writePlainTextLog "Unable to connect to Cloudflare servers; please try again later." "err" "fail" "cflogin" 3
exit 3
fi
# an API error on this GET request likely indicates an authentication error that would affect all remaining operations
# no reason to continue processing other dns records 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 listCFErrors "$cfLookup" "cflogin"
listCFErrors "$cfLookup" writePlainTextLog "Cloudflare API error; review any previously logged 'CF-ERR:' lines for details." "err" "fail" "cflogin" 25
exitError 25 exit 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 the next host if an existing host record cannot be found (this script *updates* only, does not create!)
if [ "$resultCount" = "0" ]; then if [ "$resultCount" = "0" ]; then
# warn if record of host not found writePlainTextLog "Cannot find an existing record matching '${record}' to update" "warn" "warn" "ddns"
writeLog process-warning "NOT FOUND"
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}" writePlainTextLog "The current IP address for '${record}' is ${currentIpAddr}" "debug" "ok" "ddns"
# 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" writePlainTextLog "The IP address for '${record}' is already up to date" "info" "ok" "ddns"
continue continue
fi fi
# update record # update 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="$(
curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/${cfZoneId}/dns_records/${objectId}" \
-H "Authorization: Bearer ${cfKey}" \ -H "Authorization: Bearer ${cfKey}" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
--data "${updateJSON}")"; then --data "${updateJSON}"
writeLog process-error )"; then
exitError 3 writePlainTextLog "Unable to connect to Cloudflare servers; please try again later." "err" "fail" "ddns" 3
exit 3
fi 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" writePlainTextLog "The IP address for '${record}' successfully updated" "info" "ok" "ddns"
writeLog success "IP address for ${record} updated."
else else
writeLog process-error listCFErrors "$cfResult" "ddns"
listCFErrors "$cfResult" writePlainTextLog "Unable to update the IP address for '${record}'" "err" "fail" "ddns"
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))
@@ -531,12 +516,14 @@ done
# exit # exit
if [ "$invalidDomainCount" -ne 0 ]; then if [ "$invalidDomainCount" -ne 0 ]; then
writeLog warning "${invalidDomainCount} invalid host(s) supplied for updating." writePlainTextLog "${invalidDomainCount} invalid host(s) were supplied for updating" "warn" "warn" "ddns"
fi fi
if [ "$failedHostCount" -ne 0 ]; then if [ "$failedHostCount" -ne 0 ]; then
exitError 26 writePlainTextLog \
"${failedHostCount} host update(s) failed; review 'CF-ERR:' lines in this log to help determine what may have gone wrong" "err" "fail" "ddns" 26
exit 26
else else
exitOK writePlainTextLog "${scriptName} completed successfully" "info" "ok" "script"
fi fi
### exit return codes ### exit return codes
+161
View File
@@ -0,0 +1,161 @@
#!/bin/sh
getTimeStamp() {
(date -u +"%Y-%m-%dT%H:%M:%SZ")
}
getHostname() {
(hostname -s)
}
lowercase() {
echo "$1" | tr '[:upper:]' '[:lower:]'
}
uppercase() {
echo "$1" | tr '[:lower:]' '[:upper:]'
}
standardizeLogLevels() {
LEVEL_TO_STANDARDIZE="$(lowercase "$1")"
case "$LEVEL_TO_STANDARDIZE" in
"critical" | "crit" | "fatal")
echo "CRIT"
;;
"error" | "err")
echo "ERR"
;;
"warning" | "warn")
echo "WARN"
;;
"information" | "info")
echo "INFO"
;;
"debug" | "verbose")
echo "DEBUG"
;;
*)
echo "INFO"
;;
esac
}
translateLogLevelsToJournalD() {
LEVEL_TO_TRANSLATE="$(standardizeLogLevels "$1")"
case "$LEVEL_TO_TRANSLATE" in
"CRIT")
echo 2
;;
"ERR")
echo 3
;;
"WARN")
echo 4
;;
"INFO")
echo 6
;;
"DEBUG")
echo 7
;;
*)
echo 6
esac
}
# modified syslog fmt: <ISO-8601 timestamp> <hostname> <tag>[pid]: [LEVEL:$2] [STATUS:$3] <MESSAGE:$1> (<OPERATION:$4>:<CODE:$5>)
writePlainTextLog() {
# not enough information to generate a meaningful log message
if [ -z "$1" ] || [ $# -lt 3 ]; then
return
fi
printf "%s %s %s[%s]: [%s] [%s] %s (%s:%s)\n" \
"$(getTimeStamp)" "$(getHostname)" "$LOG_PROGRAM_NAME" "$$" \
"$(standardizeLogLevels "$2")" "$(uppercase "$3")" "$1" "${4:-UNSPECIFIED}" "${5:-999}"
}
# $1: message, $2: level, $3: status, [$4: operation], [$5: code]
writeJsonLog() {
# not enough information to generate a meaningful log message
if [ -z "$1" ] || [ $# -lt 3 ]; then
return
fi
PROPS="$(
jq --null-input \
--arg timestamp "$(getTimeStamp)" \
--arg hostname "$(getHostname)" \
--arg pName "$LOG_PROGRAM_NAME" \
--arg pid "$$" \
--arg level "$(standardizeLogLevels "$2")" \
--arg status "$(uppercase "$3")" \
--arg message "$1" \
--arg operation "${4:-UNSPECIFIED}" \
--arg code "${5:-999}" \
'{"timestamp":$timestamp, "hostname":$hostname, "programName":$pName, "pid":$pid, "level":$level, "status":$status, "message":$message, "operation":$operation, "code":$code}' \
)"
echo "$PROPS" | jq "."
return
}
# $1: message, $2: level, $3: status, $4: operation, $5: code
writeJournalDLog() {
# not enough information to generate a meaningful log message
if [ -z "$1" ] || [ $# -lt 3 ]; then
return
fi
J_TIMESTAMP="$(getTimeStamp)"
J_PID="$$"
J_PRIO="$(translateLogLevelsToJournalD "$2")"
J_STAT="$(uppercase "$3")"
logger --journald <<end
SYSLOG_TIMESTAMP=${J_TIMESTAMP}
SYSLOG_FACILITY=3
SYSLOG_IDENTIFIER=${LOG_PROGRAM_NAME}
SYSLOG_PID=${J_PID}
PRIORITY=${J_PRIO}
STATUS=${J_STAT}
MESSAGE=$1
OPERATION=${4:-UNSPECIFIED}
ERRNO=${5:-999}
end
return
}
LOG_PROGRAM_NAME="cfddns"
if [ "$1" = "text" ]; then
writePlainTextLog # this will do nothing
writePlainTextLog "Testing plain-text logging output" # this will also do nothing
writePlainTextLog "Informational plain-text log message" "information" "ok" # info message
writePlainTextLog "Plain-text message forced to info level" "whoops" "ok" # level translated to default
writePlainTextLog "Warning! This is plain-text." "warning" "flagged" # warning level with 'flagged' status
writePlainTextLog "Error sample! This is plain-text." "err" "error" # error level message
writePlainTextLog "Unable to continue, critical failure. (This is plain-text)" "fatal" "exit" "startup" "2" # critical level error with operation and error code
elif [ "$1" = "json" ]; then
writeJsonLog # this will do nothing
writeJsonLog "This is a test message" # this will also do nothing
writeJsonLog "Informational JSON log message" "information" "ok" # info message
writeJsonLog "JSON message forced to info level" "whoops" "ok" # level translated to default
writeJsonLog "Warning! This is JSON." "warning" "flagged" # warning level with 'flagged' status
writeJsonLog "Error sample! This is JSON." "err" "error" # error level message
writeJsonLog "Unable to continue, critical failure. (This is JSON)" "fatal" "exit" "startup" "2" # critical level error with operation and error code
elif [ "$1" = "journal" ]; then
writeJournalDLog # this will do nothing
writeJournalDLog "This is a test message" # this will also do nothing
writeJournalDLog "Informational JOURNALD log message" "information" "ok" # info message
writeJournalDLog "JOURNALD message forced to info level" "whoops" "ok" # level translated to default
writeJournalDLog "Warning! This is a JOURNALD message." "warning" "flagged" # warning level with 'flagged' status
writeJournalDLog "Error sample! This is a JOURNALD." "err" "error" # error level message
writeJournalDLog "Unable to continue, critical failure. (This is JOURNALD message)" "fatal" "exit" "startup" "2" # critical level error with operation and error code
else
printf "\nPlease specify either 'text', 'json', or 'journal' after the script name. Exiting.\n\n"
exit 1
fi
exit 0