update_cloudflare_com_v4.sh (6891B)
1 #!/bin/sh 2 # 3 #.Distributed under the terms of the GNU General Public License (GPL) version 2.0 4 # 5 # script for sending updates to cloudflare.com 6 #.based on Ben Kulbertis cloudflare-update-record.sh found at http://gist.github.com/benkulbertis 7 #.and on George Johnson's cf-ddns.sh found at https://github.com/gstuartj/cf-ddns.sh 8 #.2016-2017 Christian Schoenebeck <christian dot schoenebeck at gmail dot com> 9 # CloudFlare API documentation at https://api.cloudflare.com/ 10 # 11 # This script is parsed by dynamic_dns_functions.sh inside send_update() function 12 # 13 # using following options from /etc/config/ddns 14 # option username - your cloudflare e-mail 15 # option password - cloudflare api key, you can get it from cloudflare.com/my-account/ 16 # option domain - "hostname@yourdomain.TLD" # syntax changed to remove split_FQDN() function and tld_names.dat.gz 17 # 18 # variable __IP already defined with the ip-address to use for update 19 # 20 21 # check parameters 22 [ -z "$CURL_SSL" ] && write_log 14 "Cloudflare communication require cURL with SSL support. Please install" 23 [ -z "$username" ] && write_log 14 "Service section not configured correctly! Missing key as 'username'" 24 [ -z "$password" ] && write_log 14 "Service section not configured correctly! Missing secret as 'password'" 25 [ $use_https -eq 0 ] && use_https=1 # force HTTPS 26 27 # used variables 28 local __HOST __DOMAIN __TYPE __URLBASE __PRGBASE __RUNPROG __DATA __IPV6 __ZONEID __RECID 29 local __URLBASE="https://api.cloudflare.com/client/v4" 30 31 # split __HOST __DOMAIN from $domain 32 # given data: 33 # @example.com for "domain record" 34 # host.sub@example.com for a "host record" 35 __HOST=$(printf %s "$domain" | cut -d@ -f1) 36 __DOMAIN=$(printf %s "$domain" | cut -d@ -f2) 37 38 # Cloudflare v4 needs: 39 # __DOMAIN = the base domain i.e. example.com 40 # __HOST = the FQDN of record to modify 41 # i.e. example.com for the "domain record" or host.sub.example.com for "host record" 42 43 # handling domain record then set __HOST = __DOMAIN 44 [ -z "$__HOST" ] && __HOST=$__DOMAIN 45 # handling host record then rebuild fqdn host@domain.tld => host.domain.tld 46 [ "$__HOST" != "$__DOMAIN" ] && __HOST="${__HOST}.${__DOMAIN}" 47 48 # set record type 49 [ $use_ipv6 -eq 0 ] && __TYPE="A" || __TYPE="AAAA" 50 51 # transfer function to use for godaddy 52 # all needed variables are set global here 53 # so we can use them directly 54 cloudflare_transfer() { 55 local __CNT=0 56 local __ERR 57 while : ; do 58 write_log 7 "#> $__RUNPROG" 59 eval "$__RUNPROG" 60 __ERR=$? # save communication error 61 [ $__ERR -eq 0 ] && break # no error break while 62 63 write_log 3 "cURL Error: '$__ERR'" 64 write_log 7 "$(cat $ERRFILE)" # report error 65 66 [ $VERBOSE_MODE -gt 1 ] && { 67 # VERBOSE_MODE > 1 then NO retry 68 write_log 4 "Transfer failed - Verbose Mode: $VERBOSE_MODE - NO retry on error" 69 break 70 } 71 72 __CNT=$(( $__CNT + 1 )) # increment error counter 73 # if error count > retry_count leave here 74 [ $retry_count -gt 0 -a $__CNT -gt $retry_count ] && \ 75 write_log 14 "Transfer failed after $retry_count retries" 76 77 write_log 4 "Transfer failed - retry $__CNT/$retry_count in $RETRY_SECONDS seconds" 78 sleep $RETRY_SECONDS & 79 PID_SLEEP=$! 80 wait $PID_SLEEP # enable trap-handler 81 PID_SLEEP=0 82 done 83 84 # check for error 85 grep -q '"success":true' $DATFILE || { 86 write_log 4 "CloudFlare reported an error:" 87 write_log 7 "$(cat $DATFILE)" # report error 88 return 1 # HTTP-Fehler 89 } 90 } 91 92 # Build base command to use 93 __PRGBASE="$CURL -RsS -o $DATFILE --stderr $ERRFILE" 94 # force network/interface-device to use for communication 95 if [ -n "$bind_network" ]; then 96 local __DEVICE 97 network_get_physdev __DEVICE $bind_network || \ 98 write_log 13 "Can not detect local device using 'network_get_physdev $bind_network' - Error: '$?'" 99 write_log 7 "Force communication via device '$__DEVICE'" 100 __PRGBASE="$__PRGBASE --interface $__DEVICE" 101 fi 102 # force ip version to use 103 if [ $force_ipversion -eq 1 ]; then 104 [ $use_ipv6 -eq 0 ] && __PRGBASE="$__PRGBASE -4" || __PRGBASE="$__PRGBASE -6" # force IPv4/IPv6 105 fi 106 # set certificate parameters 107 if [ "$cacert" = "IGNORE" ]; then # idea from Ticket #15327 to ignore server cert 108 __PRGBASE="$__PRGBASE --insecure" # but not empty better to use "IGNORE" 109 elif [ -f "$cacert" ]; then 110 __PRGBASE="$__PRGBASE --cacert $cacert" 111 elif [ -d "$cacert" ]; then 112 __PRGBASE="$__PRGBASE --capath $cacert" 113 elif [ -n "$cacert" ]; then # it's not a file and not a directory but given 114 write_log 14 "No valid certificate(s) found at '$cacert' for HTTPS communication" 115 fi 116 # disable proxy if not set (there might be .wgetrc or .curlrc or wrong environment set) 117 # or check if libcurl compiled with proxy support 118 if [ -z "$proxy" ]; then 119 __PRGBASE="$__PRGBASE --noproxy '*'" 120 elif [ -z "$CURL_PROXY" ]; then 121 # if libcurl has no proxy support and proxy should be used then force ERROR 122 write_log 13 "cURL: libcurl compiled without Proxy support" 123 fi 124 # set headers 125 __PRGBASE="$__PRGBASE --header 'X-Auth-Email: $username' " 126 __PRGBASE="$__PRGBASE --header 'X-Auth-Key: $password' " 127 __PRGBASE="$__PRGBASE --header 'Content-Type: application/json' " 128 # __PRGBASE="$__PRGBASE --header 'Accept: application/json' " 129 130 # read zone id for registered domain.TLD 131 __RUNPROG="$__PRGBASE --request GET '$__URLBASE/zones?name=$__DOMAIN'" 132 cloudflare_transfer || return 1 133 # extract zone id 134 __ZONEID=$(grep -o '"id":"[^"]*' $DATFILE | grep -o '[^"]*$' | head -1) 135 [ -z "$__ZONEID" ] && { 136 write_log 4 "Could not detect 'zone id' for domain.tld: '$__DOMAIN'" 137 return 127 138 } 139 140 # read record id for A or AAAA record of host.domain.TLD 141 __RUNPROG="$__PRGBASE --request GET '$__URLBASE/zones/$__ZONEID/dns_records?name=$__HOST&type=$__TYPE'" 142 cloudflare_transfer || return 1 143 # extract record id 144 __RECID=$(grep -o '"id":"[^"]*' $DATFILE | grep -o '[^"]*$' | head -1) 145 [ -z "$__RECID" ] && { 146 write_log 4 "Could not detect 'record id' for host.domain.tld: '$__HOST'" 147 return 127 148 } 149 150 # extract current stored IP 151 __DATA=$(grep -o '"content":"[^"]*' $DATFILE | grep -o '[^"]*$' | head -1) 152 153 # check data 154 [ $use_ipv6 -eq 0 ] \ 155 && __DATA=$(printf "%s" "$__DATA" | grep -m 1 -o "$IPV4_REGEX") \ 156 || __DATA=$(printf "%s" "$__DATA" | grep -m 1 -o "$IPV6_REGEX") 157 158 # we got data so verify 159 [ -n "$__DATA" ] && { 160 # expand IPv6 for compare 161 if [ $use_ipv6 -eq 1 ]; then 162 expand_ipv6 $__IP __IPV6 163 expand_ipv6 $__DATA __DATA 164 [ "$__DATA" = "$__IPV6" ] && { # IPv6 no update needed 165 write_log 7 "IPv6 at CloudFlare.com already up to date" 166 return 0 167 } 168 else 169 [ "$__DATA" = "$__IP" ] && { # IPv4 no update needed 170 write_log 7 "IPv4 at CloudFlare.com already up to date" 171 return 0 172 } 173 fi 174 } 175 176 # update is needed 177 # let's build data to send, 178 # use file to work around " needed for json 179 cat > $DATFILE << EOF 180 {"id":"$__ZONEID","type":"$__TYPE","name":"$__HOST","content":"$__IP"} 181 EOF 182 183 # let's complete transfer command 184 __RUNPROG="$__PRGBASE --request PUT --data @$DATFILE '$__URLBASE/zones/$__ZONEID/dns_records/$__RECID'" 185 cloudflare_transfer || return 1 186 187 return 0 188