Merge b0792f1cff into ac2f74f980

README.md

@@ -6,6 +6,21 @@ This script is used to update Dynamic DNS (DDNS) service based on Cloudflare! Ac
 ## Support Me
 [![Donate Via Paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/Jasonkkf)
 
+## Table of Contents
+
+- [Cloudflare Dynamic DNS IP Updater](#cloudflare-dynamic-dns-ip-updater)
+  * [Support Me](#support-me)
+  * [Table of Contents](#table-of-contents)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    + [Local variables](#local-variables)
+    + [Configuration file](#configuration-file)
+    + [Pass](#pass)
+  * [Tested Environments:](#tested-environments)
+  * [Contributing](#contributing)
+  * [Reference](#reference)
+  * [License](#license)
+
 ## Installation
 
 ```bash
@@ -27,6 +42,68 @@ This script is used with crontab. Specify the frequency of execution through cro
 # * * * * * /bin/bash {Location of the script}
 ```
 
+### Local variables
+
+If you want to use your variables inside the script fill the script with them and execute it like the following example:
+
+```bash
+./cloudflare-template.sh local
+```
+
+### Configuration file
+
+If you want to use the configuration file to store your credentials execute the following commands:
+
+```bash
+mkdir -p ~/.cloudflare
+cp config.ini ~/.cloudflare/config.ini
+
+./cloudflare-template.sh file
+```
+
+### Pass
+
+If you want to use [Pass](https://www.passwordstore.org/) you can execute the following commands:
+
+```bash
+gpg --batch --passphrase '' --quick-gen-key USER_ID default default
+```
+
+Get key:
+
+```bash
+gpg2 --list-secret-keys --keyid-format LONG
+
+sec   4096R/AAAA2222CCCC4444 2021-03-18 [expires: 2023-03-18] uid         John Doe <jdoe@example.com>
+```
+
+Init pass:
+```bash
+pass init 'AAAA2222CCCC4444'
+```
+
+Execute:
+
+```bash
+pass insert -m credentials/cloudflare
+```
+
+Add your variables:
+
+```text
+auth_email=""                                       # The email used to login 'https://dash.cloudflare.com'
+auth_method=""                                      # Set to "global" for Global API Key or "token" for Scoped API Token
+auth_key=""                                         # Your API Token or Global API Key
+zone_identifier=""                                  # Can be found in the "Overview" tab of your domain
+record_name=""                                      # Which record you want to be synced
+ttl="3600"                                          # Set the DNS TTL (seconds)
+proxy="false"                                       # Set the proxy to true or false
+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"
+```
+
 ## Tested Environments:
 macOS Mojave version 10.14.6 (x86_64) <br />
 AlmaLinux 9.3 (Linux kernel: 5.14.0 | x86_64) <br />

cloudflare-template.sh

@@ -1,8 +1,21 @@
 #!/bin/bash
 ## change to "bin/sh" when necessary
 
+# display_help function: Displays the usage instructions for the script.
+display_help(){
+  logger "Usage: $0 [local|file|pass]"
+  logger "  local - Load variables from this script"
+  logger "  file  - Load variables from a file"
+  logger "  pass  - Load variables from pass"
+}
+
+# load_variables function: Loads the required variables based on the input option.
+load_variables(){
+  case "$1" in
+    "local")
+      # Load variables from this script
       auth_email=""                                       # The email used to login 'https://dash.cloudflare.com'
-auth_method="token"                                 # Set to "global" for Global API Key or "token" for Scoped API Token
+      auth_method=""                                      # Set to "global" for Global API Key or "token" for Scoped API Token
       auth_key=""                                         # Your API Token or Global API Key
       zone_identifier=""                                  # Can be found in the "Overview" tab of your domain
       record_name=""                                      # Which record you want to be synced
@@ -12,84 +25,107 @@ sitename=""                                         # Title of site "Example Sit
       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"
+      ;;
+    "file")
+      # Load variables from file
+      CONFIG_FILE="$HOME/.cloudflare/config4.ini"
 
+      # Check if the configuration file exists
+      if [ -f "$CONFIG_FILE" ]; then
+          # Load configuration from the file
+          source "$CONFIG_FILE"
+      else
+          logger "Error: Configuration file '$CONFIG_FILE' not found."
+          exit 1
+      fi
+      ;;
+    "pass")
+      # Load variables from pass
+      source <(pass credentials/cloudflare)
+      ;;
+    *)
+      logger "Invalid load_variables option"
+      exit 1
+      ;;
+  esac
+}
 
-###########################################
+# validate_variables function: Validates the required variables.
-## Check if we have a public IP
+validate_variables(){
-###########################################
+  # Validate required variables
+  if [[ -z $auth_email || -z $auth_key || -z $zone_identifier || -z $record_name ]]; then
+    logger "Missing required variables. Please provide values for 'auth_email', 'auth_key', 'zone_identifier', and 'record_name'."
+    exit 1
+  fi
+}
+
+# check_ipv4_is_available function: Checks if IPv4 is available and retrieves the IP address.
+check_ipv4_is_available(){
   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])'
-ip=$(curl -s -4 https://cloudflare.com/cdn-cgi/trace | grep -E '^ip'); ret=$?
+
-if [[ ! $ret == 0 ]]; then # In the case that cloudflare failed to return an ip.
+  ip=$(curl -s -4 https://cloudflare.com/cdn-cgi/trace | grep -E '^ip=' | cut -d '=' -f 2)
-    # Attempt to get the ip from other websites.
+
+  if [[ -z $ip ]]; then
+    # Cloudflare did not return an IP, try other sources.
     ip=$(curl -s https://api.ipify.org || curl -s https://ipv4.icanhazip.com)
   else
-    # Extract just the ip from the ip line from cloudflare.
-    ip=$(echo $ip | sed -E "s/^ip=($ipv4_regex)$/\1/")
-fi
-
     # Use regex to check for proper IPv4 format.
     if [[ ! $ip =~ ^$ipv4_regex$ ]]; then
-    logger -s "DDNS Updater: Failed to find a valid IP."
+      logger -s "DDNS Updater: Failed to find a valid IP from Cloudflare."
-    exit 2
+      exit 1
+    fi
   fi
+}
 
-###########################################
+# set_auth_headers function: Sets the authentication headers based on the authentication method.
-## Check and set the proper auth header
+set_auth_headers(){
-###########################################
   if [[ "${auth_method}" == "global" ]]; then
     auth_header="X-Auth-Key:"
   else
     auth_header="Authorization: Bearer"
   fi
+}
 
-###########################################
+# check_if_a_record_exists function: Checks if the DNS record exists in Cloudflare.
-## Seek for the A record
+check_if_a_record_exists(){
-###########################################
-
   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" \
                         -H "X-Auth-Email: $auth_email" \
                         -H "$auth_header $auth_key" \
                         -H "Content-Type: application/json")
 
-###########################################
-## Check if the domain has an A record
-###########################################
   if [[ $record == *"\"count\":0"* ]]; then
     logger -s "DDNS Updater: Record does not exist, perhaps create one first? (${ip} for ${record_name})"
     exit 1
   fi
+}
 
-###########################################
+# get_current_ip_from_cloudflare function: Retrieves the current IP address from Cloudflare.
-## Get existing IP
+get_current_ip_from_cloudflare(){
-###########################################
+  old_ip=$(logger "$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/')
   # Compare if they're the same
   if [[ $ip == $old_ip ]]; then
     logger "DDNS Updater: IP ($ip) for ${record_name} has not changed."
     exit 0
   fi
+}
 
-###########################################
+# update_ip_on_cloudflare function: Updates the IP address on Cloudflare.
-## Set the record identifier from result
+update_ip_on_cloudflare(){
-###########################################
+  record_identifier=$(logger "$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
-###########################################
   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 "$auth_header $auth_key" \
                       -H "Content-Type: application/json" \
                       --data "{\"type\":\"A\",\"name\":\"$record_name\",\"content\":\"$ip\",\"ttl\":\"$ttl\",\"proxied\":${proxy}}")
+}
 
-###########################################
+# send_webhooks function: Sends webhooks to Slack and Discord.
-## Report the status
+send_webhooks(){
-###########################################
   case "$update" in
   *"\"success\":false"*)
-  echo -e "DDNS Updater: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update" | logger -s 
+    logger -e "DDNS Updater: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update" | logger -s 
     if [[ $slackuri != "" ]]; then
       curl -L -X POST $slackuri \
       --data-raw '{
@@ -121,3 +157,27 @@ case "$update" in
     fi
     exit 0;;
   esac
+}
+
+# main function: Entry point of the script.
+main(){
+  validate_variables
+  check_ipv4_is_available
+  set_auth_headers
+  check_if_a_record_exists
+  get_current_ip_from_cloudflare
+  update_ip_on_cloudflare
+  send_webhooks
+}
+
+# switch for environment variables loading
+case "$1" in
+  "local"|"file"|"pass")
+    load_variables "$1"
+    main
+    ;;
+  *)
+    display_help
+    exit 1
+    ;;
+esac

cloudflare-templatev6.sh

@@ -1,6 +1,16 @@
 #!/bin/bash
 ## change to "bin/sh" when necessary
 
+display_help(){
+  logger "Usage: $0 [local|file|pass]"
+  logger "  local - Load variables from this script"
+  logger "  file  - Load variables from a file"
+  logger "  pass  - Load variables from pass"
+}
+
+load_variables(){
+  case "$1" in
+    "local")
         ##############  CLOUDFLARE CREDENTIALS  ##############
         # @auth_email           - The email used to login 'https://dash.cloudflare.com'
         # @auth_method          - Set to "global" for Global API Key or "token" for Scoped API Token
@@ -44,20 +54,46 @@ sitename=""
         slackchannel=""
         slackuri=""
         discorduri=""
+      ;;
+    "file")
+        # Load variables from file
+        CONFIG_FILE="$HOME/.cloudflare/config6.ini"
+
+        # Check if the configuration file exists
+        if [ -f "$CONFIG_FILE" ]; then
+            # Load configuration from the file
+            source "$CONFIG_FILE"
+        else
+            logger "Error: Configuration file '$CONFIG_FILE' not found."
+            exit 1
+        fi
+        ;;
+    "pass")
+        # Load variables from pass
+        source <(pass credentials/cloudflare)
+        ;;
+    *)
+        logger "Invalid load_variables option"
+        exit 1
+        ;;
+  esac
+}
 
+validate_variables(){
+  # Validate required variables
+  if [[ -z $auth_email || -z $auth_key || -z $zone_identifier || -z $record_name ]]; then
+    logger "Missing required variables. Please provide values for 'auth_email', 'auth_key', 'zone_identifier', and 'record_name'."
+    exit 1
+  fi
+}
 
 
-################################################
+check_ipv6_is_available(){
-## Make sure we have a valid IPv6 connection
-################################################
     if ! { curl -6 -s --head --fail https://ipv6.google.com >/dev/null; }; then
         logger -s "$log_header_name: Unable to establish a valid IPv6 connection to a known host."
         exit 1
     fi
 
-################################################
-## Finding our IPv6 address
-################################################
     # Regex credits to https://stackoverflow.com/a/17871737
     ipv6_regex="(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))"
 
@@ -87,36 +123,29 @@ if [[ ! $ip =~ ^$ipv6_regex$ ]]; then
         logger -s "$log_header_name: Failed to find a valid IPv6 address."
         exit 1
     fi
+}
 
-################################################
+set_auth_headers(){
-## Check and set the proper auth header
-################################################
     if [[ "${auth_method}" == "global" ]]; then
         auth_header="X-Auth-Key:"
     else
         auth_header="Authorization: Bearer"
     fi
+}
 
-################################################
+check_if_aaaa_record_exists(){
-## Seek for the AAAA record
-################################################
     logger "$log_header_name: Check Initiated"
     record=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records?type=AAAA&name=$record_name" \
         -H "X-Auth-Email: $auth_email" \
         -H "$auth_header $auth_key" \
         -H "Content-Type: application/json")
-
-################################################
-## Check if the domain has an AAAA record
-################################################
     if [[ $record == *"\"count\":0"* ]]; then
         logger -s "$log_header_name: Record does not exist, perhaps create one first? (${ip} for ${record_name})"
         exit 1
     fi
+}
 
-################################################
+get_current_ip_from_cloudflare(){
-## Get existing IP
-################################################
     old_ip=$(echo "$record" | sed -E 's/.*"content":"'${ipv6_regex}'".*/\1/')
 
     # Make sure the extracted IPv6 address is valid
@@ -130,24 +159,18 @@ if [[ $ip == $old_ip ]]; then
         logger "$log_header_name: IP ($ip) for ${record_name} has not changed."
         exit 0
     fi
+}
 
-################################################
+update_ip_on_cloudflare(){
-## Set the record identifier from result
-################################################
     record_identifier=$(echo "$record" | sed -E 's/.*"id":"([A-Za-z0-9_]+)".*/\1/')
-
-################################################
-## 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" \
         -H "X-Auth-Email: $auth_email" \
         -H "$auth_header $auth_key" \
         -H "Content-Type: application/json" \
         --data "{\"content\":\"$ip\",\"ttl\":\"$ttl\",\"proxied\":$proxy}")
+}
 
-################################################
+send_webhooks(){
-## Report the status
-################################################
     case "$update" in
     *"\"success\":false"*)
         echo -e "$log_header_name: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update" | logger -s
@@ -184,3 +207,26 @@ case "$update" in
         exit 0
         ;;
     esac
+}
+
+main(){
+    validate_variables
+    check_ipv6_is_available
+    set_auth_headers
+    check_if_aaaa_record_exists
+    get_current_ip_from_cloudflare
+    update_ip_on_cloudflare
+    send_webhooks
+}
+
+# switch for environment variables loading
+case "$1" in
+    "local"|"file"|"pass")
+        load_variables "$1"
+        main
+        ;;
+    *)
+        display_help
+        exit 1
+        ;;
+esac

config4.ini

@@ -0,0 +1,11 @@
+auth_email=""                                       # The email used to login 'https://dash.cloudflare.com'
+auth_method=""                                      # Set to "global" for Global API Key or "token" for Scoped API Token
+auth_key=""                                         # Your API Token or Global API Key
+zone_identifier=""                                  # Can be found in the "Overview" tab of your domain
+record_name=""                                      # Which record you want to be synced
+ttl="3600"                                          # Set the DNS TTL (seconds)
+proxy="false"                                       # Set the proxy to true or false
+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"

config6.ini

@@ -0,0 +1,43 @@
+##############  CLOUDFLARE CREDENTIALS  ##############
+# @auth_email           - The email used to login 'https://dash.cloudflare.com'
+# @auth_method          - Set to "global" for Global API Key or "token" for Scoped API Token
+# @auth_key             - Your API Token or Global API Key
+# @zone_identifier      - Can be found in the "Overview" tab of your domain
+# -------------------------------------------------- #
+auth_email=""
+auth_method="token"
+auth_key=""
+zone_identifier=""
+
+#############  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
+# @proxy                - Set the proxy to true or false
+# -------------------------------------------------- #
+record_name=""
+ttl="3600"
+proxy="false"
+
+###############  SCRIPT CONFIGURATION  ###############
+# @static_IPv6_mode     - Useful if you are using EUI-64 IPv6 address with SLAAC IPv6 suffix token. (Privacy Extensions)
+#                       + Or some kind of static IPv6 assignment from DHCP server configuration, etc
+#                       + If set to false, the IPv6 address will be acquired from external services
+# @last_notable_hexes   - Used with `static_IPv6_mode`. Configure this to target what specific IPv6 address to search for
+#                       + E.g. Your global primary IPv6 address is 2404:6800:4001:80e::59ec:ab12:34cd, then
+#                       + You can put values (i.e. static suffixes) such as "34cd", "ab12:34cd" and etc
+# @log_header_name      - Header name used for logs
+# -------------------------------------------------- #
+static_IPv6_mode="false"
+last_notable_hexes="ffff:ffff"
+log_header_name="DDNS Updater_v6"
+
+#############  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=""