Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow user to load variables from multiple locations #77

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Allow user to load variables from multiple locations #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
703cac8
Use functions
user-cube Jan 29, 2024
5d171e4
Add config.ini
user-cube Jan 29, 2024
a23f341
Update README.md
user-cube Jan 29, 2024
0ae79d1
Allow user to load variables from different places
user-cube Jan 29, 2024
4f6d41e
Docs
user-cube Jan 29, 2024
9bbfed0
Update README.md
user-cube Jan 29, 2024
7973582
Config templates
user-cube Jan 29, 2024
0bf2c0a
Update ipv4 parse
user-cube Jan 29, 2024
e62fbd5
Remove config.ini
user-cube Jan 29, 2024
c726506
Allow user to load variables from different places
user-cube Jan 29, 2024
234b8e9
Update README.md
user-cube Jan 30, 2024
b0792f1
Update README.md
user-cube Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <[email protected]>
```

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 />
Expand Down
290 changes: 175 additions & 115 deletions cloudflare-template.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,183 @@
#!/bin/bash
## change to "bin/sh" when necessary

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_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"


###########################################
## Check if we have a public IP
###########################################
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.
# Attempt to get the ip from other websites.
# 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="" # 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"
;;
"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.
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=' | cut -d '=' -f 2)

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."
exit 2
fi

###########################################
## Check and set the proper auth header
###########################################
if [[ "${auth_method}" == "global" ]]; then
auth_header="X-Auth-Key:"
else
auth_header="Authorization: Bearer"
fi

###########################################
## Seek for the A record
###########################################

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 existing IP
###########################################
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

###########################################
## 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 "{\"type\":\"A\",\"name\":\"$record_name\",\"content\":\"$ip\",\"ttl\":\"$ttl\",\"proxied\":${proxy}}")

###########################################
## Report the status
###########################################
case "$update" in
*"\"success\":false"*)
echo -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 '{
"channel": "'$slackchannel'",
"text" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')."
}'
else
# Use regex to check for proper IPv4 format.
if [[ ! $ip =~ ^$ipv4_regex$ ]]; then
logger -s "DDNS Updater: Failed to find a valid IP from Cloudflare."
exit 1
fi
fi
if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{
"content" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')."
}' $discorduri
}

# set_auth_headers function: Sets the authentication headers based on the authentication method.
set_auth_headers(){
if [[ "${auth_method}" == "global" ]]; then
auth_header="X-Auth-Key:"
else
auth_header="Authorization: Bearer"
fi
exit 1;;
*)
logger "DDNS Updater: $ip $record_name DDNS updated."
if [[ $slackuri != "" ]]; then
curl -L -X POST $slackuri \
--data-raw '{
"channel": "'$slackchannel'",
"text" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'"
}'
}

# check_if_a_record_exists function: Checks if the DNS record exists in Cloudflare.
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")

if [[ $record == *"\"count\":0"* ]]; then
logger -s "DDNS Updater: Record does not exist, perhaps create one first? (${ip} for ${record_name})"
exit 1
fi
if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{
"content" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'"
}' $discorduri
}

# get_current_ip_from_cloudflare function: Retrieves the current IP address from Cloudflare.
get_current_ip_from_cloudflare(){
old_ip=$(logger "$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
exit 0;;
esac
}

# update_ip_on_cloudflare function: Updates the IP address on Cloudflare.
update_ip_on_cloudflare(){
record_identifier=$(logger "$record" | sed -E 's/.*"id":"([A-Za-z0-9_]+)".*/\1/')

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.
send_webhooks(){
case "$update" in
*"\"success\":false"*)
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 '{
"channel": "'$slackchannel'",
"text" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')."
}'
fi
if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{
"content" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')."
}' $discorduri
fi
exit 1;;
*)
logger "DDNS Updater: $ip $record_name DDNS updated."
if [[ $slackuri != "" ]]; then
curl -L -X POST $slackuri \
--data-raw '{
"channel": "'$slackchannel'",
"text" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'"
}'
fi
if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{
"content" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'"
}' $discorduri
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
Loading