Plugins/HostingDe.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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
function Get-CurrentPluginType { 'dns-01' }

function Add-DnsTxt {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory)]
        [securestring]$HDEToken,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # convert the token to plain text
    $HDETokenInsecure = [pscredential]::new('a',$HDEToken).GetNetworkCredential().Password

    # find the zone for the record
    $zoneConfig = Find-HDEZoneConfig $RecordName $HDETokenInsecure

    # get the record if it exists
    $rec = Get-HDETxtRecord $RecordName $TxtValue $zoneConfig.id $HDETokenInsecure

    if ($rec) {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
        return
    } else {

        # build the body to create the record
        $body = @{
            authToken = $HDETokenInsecure
            zoneConfig = $zoneConfig
            recordsToAdd = @(
                @{
                    name = $RecordName
                    type = 'TXT'
                    content = "`"$TxtValue`""
                    ttl = 60
                }
            )
        }

        Invoke-HDEZoneUpdate $body

    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to Hosting.de
 
    .DESCRIPTION
        Description for Hosting.de
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER HDEToken
        Your Hosting.de API token as a SecureString value.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
 
    .EXAMPLE
        Add-DnsTxt '_acme-challenge.example.com' 'txt-value' -HDEToken (Read-Host -AsSecureString)
 
        Adds a TXT record for the specified site with the specified value.
    #>

}

function Remove-DnsTxt {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory)]
        [securestring]$HDEToken,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # convert the token to plain text
    $HDETokenInsecure = [pscredential]::new('a',$HDEToken).GetNetworkCredential().Password

    # find the zone for the record
    $zoneConfig = Find-HDEZoneConfig $RecordName $HDETokenInsecure

    # get the record if it exists
    $rec = Get-HDETxtRecord $RecordName $TxtValue $zoneConfig.id $HDETokenInsecure

    if ($rec) {

        # build the body to remove the record
        $body = @{
            authToken = $HDETokenInsecure
            zoneConfig = $zoneConfig
            recordsToDelete = @(
                @{
                    id = $rec.id
                }
            )
        }

        Invoke-HDEZoneUpdate $body

    } else {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
        return
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from Hosting.de
 
    .DESCRIPTION
        Description for Hosting.de
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER HDEToken
        Your Hosting.de API token as a SecureString value.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
 
    .EXAMPLE
        Remove-DnsTxt '_acme-challenge.example.com' 'txt-value' -HDEToken (Read-Host -AsSecureString)
 
        Removes a TXT record for the specified site with the specified value.
    #>

}

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://www.hosting.de/api

function Find-HDEZoneConfig {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$HDETokenInsecure
    )

    # setup a module variable to cache the record to zone mapping
    # so it's quicker to find later
    if (!$script:HDERecordZones) { $script:HDERecordZones = @{} }

    # check for the record in the cache
    if ($script:HDERecordZones.ContainsKey($RecordName)) {
        return $script:HDERecordZones.$RecordName
    }

    # create the base body with our auth token
    $body = @{authToken = $HDETokenInsecure}

    # Find the closest/deepest sub-zone that would hold the record.
    $pieces = $RecordName.Split('.')
    for ($i=0; $i -lt ($pieces.Count-1); $i++) {
        $zoneTest = $pieces[$i..($pieces.Count-1)] -join '.'
        Write-Debug "Checking $zoneTest"

        $body.filter = @{field='ZoneName';value=$zoneTest}
        $bodyJson = $body | ConvertTo-Json -Depth 10
        $bodySanitized = $bodyJson.Replace($body.authToken,'XXXXXXXX')

        $queryParams = @{
            Uri = 'https://secure.hosting.de/api/dns/v1/json/zoneConfigsFind'
            Method = 'POST'
            ContentType = 'application/json'
            Body = $bodyJson
            ErrorAction = 'Stop'
            Verbose = $false
        }

        try {
            Write-Debug "POST $($queryParams.Uri)`n$bodySanitized"
            $response = Invoke-RestMethod @queryParams @script:UseBasic
        } catch { throw }

        if ($response.response -and $response.response.data.Count -gt 0) {
            $script:HDERecordZones.$RecordName = $response.response.data[0]
            return $script:HDERecordZones.$RecordName
        }
    }

    return $null

}

function Get-HDETxtRecord {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$ZoneID,
        [Parameter(Mandatory,Position=3)]
        [string]$HDETokenInsecure
    )

    # create the search body
    $body = @{
        authToken = $HDETokenInsecure
        filter = @{
            subFilterConnective = 'AND'
            subFilter = @(
                @{ field = 'ZoneConfigId'; value = $ZoneID }
                @{ field = 'RecordName'; value = $RecordName }
                @{ field = 'RecordType'; value = 'TXT' }
                @{ field = 'RecordContent'; value = "`"$TxtValue`"" }
            )
        }
    }
    $bodyJson = $body | ConvertTo-Json -Depth 10
    $bodySanitized = $bodyJson.Replace($body.authToken,'XXXXXXXX')

    # create the query params
    $queryParams = @{
        Uri = 'https://secure.hosting.de/api/dns/v1/json/recordsFind'
        Method = 'POST'
        ContentType = 'application/json'
        Body = $bodyJson
        ErrorAction = 'Stop'
        Verbose = $false
    }

    try {
        Write-Debug "POST $($queryParams.Uri)`n$bodySanitized"
        $response = Invoke-RestMethod @queryParams @script:UseBasic
    } catch { throw }

    if ($response.response -and $response.response.data.Count -gt 0) {
        return $response.response.data[0]
    }

}

function Invoke-HDEZoneUpdate {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [hashtable]$UpdateBody
    )

    $bodyJson = $UpdateBody | ConvertTo-Json -Depth 10
    $bodySanitized = $bodyJson.Replace($UpdateBody.authToken, 'XXXXXXXX')

    $queryParams = @{
        Uri = 'https://secure.hosting.de/api/dns/v1/json/zoneUpdate'
        Method = 'POST'
        ContentType = 'application/json'
        Body = $bodyJson
        ErrorAction = 'Stop'
        Verbose = $false
    }

    # zone modifications are technically asynchronus and additional edits are "blocked"
    # until the previous one is complete. So we'll setup a retry loop while we wait to
    # be unblocked.
    $response = $null
    $tries = 0

    for ($tries = 0; $tries -lt 13; $tries++) {
        try {
            Write-Debug "POST $($queryParams.Uri)`n$bodySanitized"
            $response = Invoke-RestMethod @queryParams @script:UseBasic
        } catch { throw }

        if ($response.status -eq 'error' -and $response.errors[0].value -eq 'blocked') {
            Write-Verbose "Zone update blocked by another update. Sleeping for 5 seconds and retrying."
            Start-Sleep -Seconds 5
        } else {
            break
        }
    }

    # report on final errors if there were any
    if ($response.errors.Count -gt 0) {
        Write-Verbose "Last error:`n$($response.errors | ConvertTo-Json -Dep 10)"
        throw "Failed to update zone. See verbose output for details."
    }

}