Plugins/UKFast.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
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
    }

    try {
        Write-Debug "GET $ApiRoot/zones"
        $zones = (Invoke-RestMethod "$ApiRoot/zones" @RestParams @script:UseBasic).Data
    } catch { throw }

    # 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 ($i=0; $i -lt ($pieces.Count-1); $i++) {
        $zoneTest = $pieces[$i..($pieces.Count-1)] -join '.'
        Write-Debug "Checking $zoneTest"
        if ($zoneTest -in $zones.name) {
            $script:UKFastRecordZones.$RecordName = $zoneTest
            return $zoneTest
        }
    }

    return $null
}