Skip to content

Added support for Cloudflare API Tokens #14

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

Open
commitconfirm wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added support for Cloudflare API Tokens #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab00845
Updated CloudFlareDynDns.psm1 to use tokens
commitconfirm Feb 12, 2020
f6ec4ee
Cleaned up documentation errors.
commitconfirm Feb 12, 2020
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
91 changes: 69 additions & 22 deletions CloudFlareDynDns/CloudFlareDynDns.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Function Update-CloudFlareDynamicDns
<#
.SYNOPSIS
Updates specified CloudFlare DNS hostname to the current connection's external IP address using CloudFlare API v4
https://api.cloudflare.com/
https://api.cloudflare.com/

.DESCRIPTION
This module is useful for homelabs. Remember how DynDns used to dynamically update your IP address for free? The functionality provided by this module is similar but updates CloudFlare hosted domains. CloudFlare is free and awesome, and I recommend it, if even for its simplified DNS management and free HTTPS.
Expand All @@ -15,7 +15,12 @@ Function Update-CloudFlareDynamicDns
.PARAMETER Token
CloudFlare API Token.

As of 22 Dec 2015, you can find your API key at: https://www.cloudflare.com/a/account/my-account -> API Key
As of 11 Feb 2020, you can create API tokens at: https://dash.cloudflare.com/profile/api-tokens-> API Tokens

.PARAMETER Key
CloudFlare API Key.

As of 11 Feb 2020, you can find your API key at: https://dash.cloudflare.com/profile/api-tokens -> API Keys

.PARAMETER Email
The email address associated with your CloudFlare account
Expand All @@ -26,31 +31,52 @@ Function Update-CloudFlareDynamicDns
.PARAMETER Record
This is the record you'd like to update or add. For example, homelab.

Using -Zone netnerds.net and -Record homelab would update homelab.netnerds.net
Using -Zone netnerds.net and -Record homelab would update homelab.netnerds.net

.PARAMETER UseDns
.PARAMETER UseDns
Resolves hostname using DNS instead of checking CloudFlare. The intention is to reduce the number of calls to CloudFlare (they allow 200 reqs/minute, which is usually plenty), but the downside is that if the IP changes, it won't be updated until the hostname expires from cache.

.EXAMPLE
Update-CloudFlareDynamicDns -Token 1234567893feefc5f0q5000bfo0c38d90bbeb -Email example@example.com -Zone example.com
Update-CloudFlareDynamicDns -Token 1234567893feefc5f0q5000bfo0c38d90bbeb -Zone example.com

Checks ipinfo.io for current external IP address. Checks CloudFlare's API for current IP of example.com. (Root Domain)
Checks ipinfo.io for current external IP address. Checks CloudFlare's API for current IP of example.com. (Root Domain)

If record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.
Using an API token, if record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.

.EXAMPLE
Update-CloudFlareDynamicDns -Token 1234567893feefc5f0q5000bfo0c38d90bbeb -Email example@example.com -Zone example.com -Record homelab
Update-CloudFlareDynamicDns -Token 1234567893feefc5f0q5000bfo0c38d90bbeb -Zone example.com -Record homelab

Checks ipinfo.io for current external IP address. Checks CloudFlare's API for current IP of homelab.example.com.
Checks ipinfo.io for current external IP address. Checks CloudFlare's API for current IP of homelab.example.com.

If record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.
Using an API token, if record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.

.EXAMPLE
Update-CloudFlareDynamicDns -Token 1234567893feefc5f0q5000bfo0c38d90bbeb -Email example@example.com -Zone example.com -Record homelab -UseDns
Update-CloudFlareDynamicDns -Token 1234567893feefc5f0q5000bfo0c38d90bbeb -Zone example.com -Record homelab -UseDns

Checks ipinfo.io for current external IP address. Checks DNS for current IP of homelab.example.com. Beware of cached entries.

Using an API token, if record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.

.EXAMPLE
Update-CloudFlareDynamicDns -Key 1234567893feefc5f0q5000bfo0c38d90bbeb -Email example@example.com -Zone example.com

Checks ipinfo.io for current external IP address. Checks DNS for current IP of homelab.example.com. Beware of cached entries.
Checks ipinfo.io for current external IP address. Checks CloudFlare's API for current IP of example.com. (Root Domain)

If record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.
Using the API key, if record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.

.EXAMPLE
Update-CloudFlareDynamicDns -Key 1234567893feefc5f0q5000bfo0c38d90bbeb -Email example@example.com -Zone example.com -Record homelab

Checks ipinfo.io for current external IP address. Checks CloudFlare's API for current IP of homelab.example.com.

Using the API key, if record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.

.EXAMPLE
Update-CloudFlareDynamicDns -Key 1234567893feefc5f0q5000bfo0c38d90bbeb -Email example@example.com -Zone example.com -Record homelab -UseDns

Checks ipinfo.io for current external IP address. Checks DNS for current IP of homelab.example.com. Beware of cached entries.

Using the API key, if record doesn't exist within CloudFlare, it will be created. If record exists, but does not match to current external IP, the record will be updated. If the external IP and the CloudFlare IP match, no changes will be made.

.NOTES
Author: Chrissy LeMaire (@cl), netnerds.net
Expand All @@ -63,10 +89,23 @@ Function Update-CloudFlareDynamicDns
[cmdletbinding()]
param
(
[Parameter(mandatory = $true)]
[Parameter(
ParameterSetName='token',
mandatory = $true
)
]
[string]$Token,

[Parameter(mandatory = $true)]

[Parameter(
ParameterSetName='key',
mandatory = $true
)]
[string]$Key,

[Parameter(
ParameterSetName='key',
mandatory = $true
)]
[ValidatePattern("[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?")]
[string]$Email,

Expand All @@ -79,15 +118,23 @@ Function Update-CloudFlareDynamicDns
[Parameter(mandatory = $false)]
[switch]$UseDns
)

if ($record) {
$hostname = "$record.$zone"
} else {
$hostname = "$zone"
}
$headers = @{
'X-Auth-Key' = $token
'X-Auth-Email' = $email
}
}

if ($Token){
$headers = @{
'Authorization' = "Bearer $Token"
}
} else {
$headers = @{
'X-Auth-Key' = $key
'X-Auth-Email' = $email
}
}

Write-Output "Resolving external IP"
try { $ipaddr = Invoke-RestMethod http://ipinfo.io/json | Select-Object -ExpandProperty ip }
Expand All @@ -98,7 +145,7 @@ Function Update-CloudFlareDynamicDns

Write-Output "Getting Zone information from CloudFlare"
$baseurl = "https://api.cloudflare.com/client/v4/zones"
$zoneurl = "$baseurl/?name=$zone"
$zoneurl = "$($baseurl)?name=$zone"

try { $cfzone = Invoke-RestMethod -Uri $zoneurl -Method Get -Headers $headers }
catch { throw $_.Exception }
Expand Down