Plugins/Loopia.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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
function Get-CurrentPluginType { 'dns-01' }

function Add-DnsTxt {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$LoopiaUser,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=3)]
        [securestring]$LoopiaPass,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=3)]
        [string]$LoopiaPassInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # grab the plaintext password if the secure version was used
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $LoopiaPassInsecure = [pscredential]::new('a',$LoopiaPass).GetNetworkCredential().Password
    }
    $creds = @($LoopiaUser,$LoopiaPassInsecure)

    $zoneName = Find-LoopiaZone $RecordName $creds
    if (-not $zoneName) {
        throw "No matching domain found for $RecordName"
    }
    Write-Debug "Found zone $zoneName"

    # separate the portion of the name that doesn't contain the zone name
    $recShort = ($RecordName -ireplace [regex]::Escape($zoneName), [string]::Empty).TrimEnd('.')

    if (-not (Test-LoopiaSubdomainExists $recShort $zoneName $creds)) {
        # we need to add the "subdomain" object before we add records to it
        Add-LoopiaSubdomain $recShort $zoneName $creds
    }

    $recID,$recCount = Test-LoopiaTXTRecordExists $recShort $zoneName $TxtValue $creds

    if ($recID) {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
    } else {
        Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
        Add-LoopiaTXTRecord $recShort $zoneName $TxtValue $creds
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to LoopiaDNS
 
    .DESCRIPTION
        Add a DNS TXT record to LoopiaDNS
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER LoopiaUser
        The Loopia API username.
 
    .PARAMETER LoopiaPass
        The Loopia API password.
 
    .PARAMETER LoopiaPassInsecure
        (DEPRECATED) The Loopia API password.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
 
    .EXAMPLE
        $pass = Read-Host -Prompt "Loopia API password" -AsSecureString
        Add-DnsTxt '_acme-challenge.example.com' 'txt-value' 'user@loopiaapi' $pass
 
        Adds the specified TXT record with the specified value using a secure password.
    #>

}

function Remove-DnsTxt {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$LoopiaUser,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=3)]
        [securestring]$LoopiaPass,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=3)]
        [string]$LoopiaPassInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # grab the plaintext password if the secure version was used
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $LoopiaPassInsecure = [pscredential]::new('a',$LoopiaPass).GetNetworkCredential().Password
    }
    $creds = @($LoopiaUser,$LoopiaPassInsecure)

    $zoneName = Find-LoopiaZone $RecordName $creds
    if (-not $zoneName) {
        throw "No matching domain found for $RecordName"
    }
    Write-Debug "Found zone $zoneName"

    # separate the portion of the name that doesn't contain the zone name
    $recShort = ($RecordName -ireplace [regex]::Escape($zoneName), [string]::Empty).TrimEnd('.')

    if (-not (Test-LoopiaSubdomainExists $recShort $zoneName $creds)) {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
        return
    }

    $recID,$recCount = Test-LoopiaTXTRecordExists $recShort $zoneName $TxtValue $creds

    if ($recID) {
        Write-Verbose "Removing TXT record for $RecordName with value $TxtValue"
        if ($recCount -gt 1) {
            # just remove the record
            Remove-LoopiaTXTRecord $recShort $zoneName $creds -RecordID $recID
        } else {
            # remove the whole subdomain
            Remove-LoopiaTXTRecord $recShort $zoneName $creds
        }
    } else {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
    }


    <#
    .SYNOPSIS
        Remove a DNS TXT record from LoopiaDNS
 
    .DESCRIPTION
        Remove a DNS TXT record from LoopiaDNS
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER LoopiaUser
        The Loopia API username.
 
    .PARAMETER LoopiaPass
        The Loopia API password.
 
    .PARAMETER LoopiaPassInsecure
        (DEPRECATED) The Loopia API password.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
 
    .EXAMPLE
        $pass = Read-Host -Prompt "Loopia API password" -AsSecureString
        Remove-DnsTxt '_acme-challenge.example.com' 'txt-value' 'user@loopiaapi' $pass
 
        Removes the specified TXT record with the specified value using a secure password.
    #>

}

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.loopia.com/api/

# Loopia has this really weird concept of how DNS works. It calls all labels within a zone
# "subdomains". Records are one or more values within each subdomain. So two A records
# for www.example.com is basically two records within the www subdomain of the example.com
# domain. The web GUI for this is also pretty cuckoo pants.

function Format-LoopiaXmlBody {
    [CmdletBinding(DefaultParameterSetName='AddTxt')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$MethodName,
        [Parameter(Mandatory,Position=1)]
        [AllowEmptyString()]
        [string[]]$StringParams,
        [Parameter(ParameterSetName='AddTxt',Position=2)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='RemoveTxt',Position=2)]
        [int]$RecordID
    )

    # Loopia uses XMLRPC, but we're going to try and avoid using a full
    # fledged XMLRPC library for our simplistic needs. All calls we're using
    # only take a bunch of string parameters except for when we're adding a
    # TXT record which then needs a struct of the record details. So if the
    # $TxtValue is specified, we'll just assume we're adding it.

    # start the xml and method name
    $xml = "<?xml version=`"1.0`" encoding=`"UTF-8`"?><methodCall><methodName>$MethodName</methodName><params>"

    # add XML-escaped string params
    $StringParams | ForEach-Object {
        $xml += "<param><value><string>$([Security.SecurityElement]::Escape($_))</string></value></param>"
    }

    # add the record object if necessary
    if ($TxtValue) {
        $xml += "<param><struct><member><name>type</name><value><string>TXT</string></value></member><member><name>priority</name><value><int>0</int></value></member><member><name>ttl</name><value><int>300</int></value></member><member><name>rdata</name><value><string>$TxtValue</string></value></member></struct></param>"
    } elseif ($RecordID) {
        $xml += "<param><value><int>$RecordID</int></value></param>"
    }

    # close it up
    $xml += '</params></methodCall>'

    return $xml
}

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

    $apiBase = 'https://api.loopia.se/RPCSERV'

    if (!$script:LoopiaZones) { $script:LoopiaZones = @{} }

    if ($script:LoopiaZones.ContainsKey($RecordName)) {
        return $script:LoopiaZones.$RecordName
    }

    $body = Format-LoopiaXmlBody getDomains $UserPass
    try {
        $response = Invoke-RestMethod $apiBase -Method Post -Body $body @script:UseBasic -EA Stop -Verbose:$false
    } catch { throw }

    # the response should contain at least one member node unless there was an
    # error or this account has no domains
    $domains = $response.SelectNodes("//member[name='domain']/value/string").'#text'
    if (-not $domains) {
        # check for an error which is just in a returned parameter string
        $errText = $response.SelectNodes('//string').'#text'
        if (-not $errText) {
            return $null
        } else {
            throw "Error querying domain list: $errText"
        }
    }

    $pieces = $RecordName.Split('.')
    for ($i=0; $i -lt ($pieces.Count-1); $i++) {
        $zone = $pieces[$i..($pieces.Count-1)] -join '.'
        Write-Debug "Checking $zone"

        if ($zone -in $domains) {
            $script:LoopiaZones.$RecordName = $zone
            return $zone
        }
    }

    return $null

}

function Test-LoopiaSubdomainExists {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$Subdomain,
        [Parameter(Mandatory,Position=1)]
        [string]$Domain,
        [Parameter(Mandatory,Position=2)]
        [string[]]$UserPass
    )

    $apiBase = 'https://api.loopia.se/RPCSERV'

    $body = Format-LoopiaXmlBody getSubdomains ($UserPass + @($Domain))
    try {
        Write-Debug "Checking for $Subdomain subdomain"
        $response = Invoke-RestMethod $apiBase -Method Post -Body $body @script:UseBasic -EA Stop -Verbose:$false
    } catch { throw }

    # The response here is just an array of string parameters which makes it
    # impossible to differentiate from an error response. So we'll just assume
    # people aren't creating sub-domains like 'AUTH_ERROR' or 'UNKNOWN_ERROR'
    $subdomains = $response.SelectNodes('//string').'#text'
    Write-Debug "Found subdomains: $($subdomains -join ', ')"

    if ($Subdomain -in $subdomains) {
        return $true
    } else {
        return $false
    }
}

function Add-LoopiaSubdomain {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$Subdomain,
        [Parameter(Mandatory,Position=1)]
        [string]$Domain,
        [Parameter(Mandatory,Position=2)]
        [string[]]$UserPass
    )

    $apiBase = 'https://api.loopia.se/RPCSERV'

    $body = Format-LoopiaXmlBody addSubdomain ($UserPass + @($Domain,$Subdomain))
    try {
        Write-Debug "Adding $Subdomain subdomain"
        $response = Invoke-RestMethod $apiBase -Method Post -Body $body @script:UseBasic -EA Stop -Verbose:$false
    } catch { throw }

    $status = $response.SelectNodes('//string').'#text'
    if ('OK' -ne $status) {
        throw "Error adding Loopia subdomain $Subdomain to $($Domain): $status"
    }
}

function Test-LoopiaTXTRecordExists {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$Subdomain,
        [Parameter(Mandatory,Position=1)]
        [string]$Domain,
        [Parameter(Mandatory,Position=2)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=3)]
        [string[]]$UserPass
    )

    $apiBase = 'https://api.loopia.se/RPCSERV'

    $body = Format-LoopiaXmlBody getZoneRecords ($UserPass + @($Domain,$Subdomain))
    try {
        Write-Debug "Checking for TXT record with value $TxtValue"
        $response = Invoke-RestMethod $apiBase -Method Post -Body $body @script:UseBasic -EA Stop -Verbose:$false
    } catch { throw }

    $rec = $response.SelectSingleNode("//struct[member/value='$TxtValue' and member/value='TXT']")
    if ($rec) {
        # return the record_id value
        $recID = $rec.SelectSingleNode("//member[name='record_id']/value/int").'#text'
        $totalRecs = $rec.SelectNodes("//struct").Count
        return $recID,$totalRecs
    } else {
        # trying to determine the difference between an actual error and just no matches
        # or no records at all would be difficult. So we're just going to hope it doesn't
        # matter for the time being.
        return $null,0
    }
}

function Add-LoopiaTXTRecord {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$Subdomain,
        [Parameter(Mandatory,Position=1)]
        [string]$Domain,
        [Parameter(Mandatory,Position=2)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=3)]
        [string[]]$UserPass
    )

    $apiBase = 'https://api.loopia.se/RPCSERV'

    $body = Format-LoopiaXmlBody addZoneRecord ($UserPass + @($Domain,$Subdomain)) $TxtValue
    try {
        Write-Debug "Adding TXT record for $Subdomain with value $TxtValue"
        $response = Invoke-RestMethod $apiBase -Method Post -Body $body @script:UseBasic -EA Stop -Verbose:$false
    } catch { throw }

    $status = $response.SelectNodes('//string').'#text'
    if ('OK' -ne $status) {
        throw "Error adding Loopia TXT record: $status"
    }
}

function Remove-LoopiaTXTRecord {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$Subdomain,
        [Parameter(Mandatory,Position=1)]
        [string]$Domain,
        [Parameter(Mandatory,Position=2)]
        [string[]]$UserPass,
        [Parameter(Position=3)]
        [int]$RecordID
    )

    $apiBase = 'https://api.loopia.se/RPCSERV'

    # If no RecordID was passed in, that means we're supposed to delete the
    # whole Subdomain presumably because it's empty or we'd be removing the
    # last record.

    if (-not $RecordID) {
        $body = Format-LoopiaXmlBody removeSubdomain ($UserPass + @($Domain,$Subdomain))
        Write-Debug "Removing $Subdomain from $Domain"
    } else {
        $body = Format-LoopiaXmlBody removeZoneRecord ($UserPass + @($Domain,$Subdomain)) -RecordID $RecordID
        Write-Debug "Removing record $RecordID from $Subdomain"
    }

    try {
        $response = Invoke-RestMethod $apiBase -Method Post -Body $body @script:UseBasic -EA Stop -Verbose:$false
    } catch { throw }

    $status = $response.SelectNodes('//string').'#text'
    if ('OK' -ne $status) {
        if (-not $RecordID) {
            throw "Error removing subdomain: $status"
        } else {
            throw "Error removing TXT record: $status"
        }
    }
}