Plugins/UKFast.ps1
|
function Get-CurrentPluginType { 'dns-01' } function Add-DnsTxt { [CmdletBinding()] param( [Parameter(Mandatory,Position=0)] [string]$RecordName, [Parameter(Mandatory,Position=1)] [string]$TxtValue, [Parameter(Mandatory,Position=2)] [securestring]$UKFastApiKey, [Parameter(ValueFromRemainingArguments)] $ExtraParams ) $ApiKeyClearText = [pscredential]::new('a',$UKFastApiKey).GetNetworkCredential().Password $apiRoot = "https://api.ukfast.io/safedns/v1" $restParams = @{ Headers = @{ Accept = 'application/json' Authorization = $ApiKeyClearText } ContentType = 'application/json' Verbose = $false } # find the closest zone for our record Write-Verbose "Attempting to find hosted zone for $RecordName" $zoneName = Find-UKFastZone $RecordName $apiRoot $restParams if (!$zoneName) { throw "Unable to find UKFast SafeDNS zone for $RecordName" } $recRoot = "$apiRoot/zones/$zoneName/records" try { Write-Debug "GET $recRoot" $rec = (Invoke-RestMethod $recRoot @restParams @script:UseBasic).Data | Where-Object { $_.type -eq 'TXT' -and $_.name -eq $RecordName -and $_.content -eq "`"$TxtValue`"" } } catch { throw } if (!$rec) { #create new $recBody = @{ type = 'TXT' name = $RecordName content = "`"$TxtValue`"" ttl = 60 } | ConvertTo-Json Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue" Write-Debug "POST $recRoot`n$recBody" Invoke-RestMethod $recRoot -Method Post @restParams -Body $recBody @script:UseBasic | Out-Null } else { Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do." } <# .SYNOPSIS Add a DNS TXT record to UKFast SafeDNS .DESCRIPTION Add a DNS TXT record to UKFast SafeDNS .PARAMETER RecordName The fully qualified name of the TXT record. .PARAMETER TxtValue The value of the TXT record. .PARAMETER UKFastApiKey An API Application Key generated on the UKFast website with Read/Write access. .PARAMETER ExtraParams This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports. .EXAMPLE $key = Read-Host -AsSecureString Add-DnsTxt '_acme-challenge.example.com' 'txt-value' -UKFastApiKey $key Adds a TXT record for the specified site with the specified value. Key passed in as securestring. #> } function Remove-DnsTxt { [CmdletBinding()] param( [Parameter(Mandatory,Position=0)] [string]$RecordName, [Parameter(Mandatory,Position=1)] [string]$TxtValue, [Parameter(Mandatory,Position=2)] [securestring]$UKFastApiKey, [Parameter(ValueFromRemainingArguments)] $ExtraParams ) $ApiKeyClearText = [pscredential]::new('a',$UKFastApiKey).GetNetworkCredential().Password $apiRoot = "https://api.ukfast.io/safedns/v1" $restParams = @{ Headers = @{ Accept = 'application/json' Authorization = $ApiKeyClearText } ContentType = 'application/json' Verbose = $false } # find the closest zone for our record Write-Verbose "Attempting to find hosted zone for $RecordName" $zoneName = Find-UKFastZone $RecordName $apiRoot $restParams if (!$zoneName) { throw "Unable to find UKFast SafeDNS zone for $RecordName" } $recRoot = "$apiRoot/zones/$zoneName/records" try { Write-Debug "GET $recRoot" $rec = (Invoke-RestMethod $recRoot @restParams @script:UseBasic).Data | Where-Object { $_.type -eq 'TXT' -and $_.name -eq $RecordName -and $_.content -eq "`"$TxtValue`"" } } catch { throw } if ($rec) { #if record exists, delete it Write-Verbose "Deleting $RecordName with value $TxtValue" Write-Debug "DELETE $recRoot/$($rec.id)" Invoke-RestMethod "$recRoot/$($rec.id)" -Method Delete @restParams @script:UseBasic | Out-Null } else { Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do." } <# .SYNOPSIS Remove a DNS TXT record from UKFast SafeDNS .DESCRIPTION Remove a DNS TXT record from UKFast SafeDNS .PARAMETER RecordName The fully qualified name of the TXT record. .PARAMETER TxtValue The value of the TXT record. .PARAMETER UKFastApiKey An API Application Key generated on the UKFast website with Read/Write access. .PARAMETER ExtraParams This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports. .EXAMPLE $key = Read-Host -AsSecureString Remove-DnsTxt '_acme-challenge.example.com' 'txt-value' -UKFastApiKey $key Removes a TXT record for the specified site with the specified value. Key passed in as securestring. #> } function Save-DnsTxt { [CmdletBinding()] param( [Parameter(ValueFromRemainingArguments)] $ExtraParams ) <# .SYNOPSIS Not required. .DESCRIPTION This provider does not require calling this function to commit changes to DNS records. .PARAMETER ExtraParams This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports. #> } ############################ # Helper Functions ############################ # API Docs # https://developers.ukfast.io/documentation/safedns function Find-UKFastZone { [CmdletBinding()] param( [Parameter(Mandatory,Position=0)] [string]$RecordName, [Parameter(Mandatory,Position=1)] [string]$ApiRoot, [Parameter(Mandatory,Position=2)] [hashtable]$RestParams ) # setup a module variable to cache the record to zone mapping # so it's quicker to find later if (!$script:UKFastRecordZones) { $script:UKFastRecordZones = @{} } # check for the record in the cache if ($script:UKFastRecordZones.ContainsKey($RecordName)) { return $script:UKFastRecordZones.$RecordName } $pages = 1 for ($i=0; $i -lt $pages; $i++) { $page = $i+1 try { Write-Debug "GET $ApiRoot/zones" $response = (Invoke-RestMethod "$ApiRoot/zones?page=$page" @RestParams @script:UseBasic) } catch { throw } $zones = $response.data $pages = $response.meta.pagination.total_pages # Since UKFast could be hosting both apex and sub-zones, we need to find the closest/deepest # sub-zone that would hold the record rather than just adding it to the apex. So for something # like _acme-challenge.site1.sub1.sub2.example.com, we'd look for zone matches in the following # order: # - site1.sub1.sub2.example.com # - sub1.sub2.example.com # - sub2.example.com # - example.com $pieces = $RecordName.Split('.') for ($x=0; $x -lt ($pieces.Count-1); $x++) { $zoneTest = $pieces[$x..($pieces.Count-1)] -join '.' Write-Debug "Checking $zoneTest" if ($zoneTest -in $zones.name) { $script:UKFastRecordZones.$RecordName = $zoneTest return $zoneTest } } } return $null } |