DnsPlugins/SimpleDNSPlus.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
function Add-DnsTxtSimpleDNSPlus {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword','')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory)]
        [string]$SdnsApiRoot,
        [Parameter(ParameterSetName='Secure')]
        [pscredential]$SdnsCred,
        [Parameter(ParameterSetName='Insecure',Mandatory)]
        [string]$SdnsUser,
        [Parameter(ParameterSetName='Insecure',Mandatory)]
        [string]$SdnsPassword,
        [switch]$SdnsIgnoreCert,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $apiRoot = "$($SdnsApiRoot)/zones"

    # create a pscredential from insecure args if necessary
    if ('Insecure' -eq $PSCmdlet.ParameterSetName) {
        $secpass = ConvertTo-SecureString $SdnsPassword -AsPlainText -Force
        $SdnsCred = New-Object PSCredential ($SdnsUser,$secpass)
    }
    $credSplat = @{}
    if ($SdnsCred) { $credSplat.Credential = $SdnsCred }

    try {
        # ignore cert validation for the duration of the call
        if ($SdnsIgnoreCert) { Set-SdnsCertIgnoreOn }

        $zone = Find-SimpleDNSPlusZone -RecordName $RecordName -SdnsApiRoot $SdnsApiRoot -CredSplat $credSplat

        # Get a list of existing TXT records for this record name
        try {
            $recs = (Invoke-RestMethod "$apiRoot/$zone/records" @credSplat @script:UseBasic -EA Stop ) |
                Where-Object {$_.Type -eq "TXT" -And $_.Name -eq $RecordName}
        } catch { throw }

        if (-not $recs -or "`"$TxtValue`"" -notin $recs.data) {
            $bodyJson = ConvertTo-Json @(@{Name=$RecordName;Type='TXT';TTL=600;'Data'=$TxtValue}) -Compress

            try {
                Write-Debug "Sending $bodyJson"
                Invoke-RestMethod "$apiRoot/$zone/records" `
                    -Method Patch @credSplat -Body $bodyJson `
                    -ContentType 'application/json' @script:UseBasic -EA Stop | Out-Null
            } catch { throw }

        } else {
            Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
        }

    } finally {
        # return cert validation back to normal
        if ($SdnsIgnoreCert) { Set-SdnsCertIgnoreOff }
    }


    <#
    .SYNOPSIS
        Add a DNS TXT record to Simple DNS Plus Server.

    .DESCRIPTION
        Add a DNS TXT record to Simple DNS Plus Server.

    .PARAMETER RecordName
        The fully qualified name of the TXT record.

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER SdnsApiRoot
        The root URL of the Simple DNS Plus Server API. For example, http://dns.example.com:8053 or http://dns.example.com:8053/v2

    .PARAMETER SdnsCred
        The HTTP API credentials required to authenticate.

    .PARAMETER SdnsUser
        The HTTP API Username.

    .PARAMETER SdnsSecret
        The HTTP API Password.

    .PARAMETER SdnsIgnoreCert
        Use this switch to prevent certificate errors when your Simple DNS Plus server is using a self-signed or other untrusted SSL certificate. When passing parameters via hashtable, set it as a boolean such as @{SdnsIgnoreCert=$true}.

    .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-DnsTxtSimpleDNSPlus '_acme-challenge.example.com' 'txtvalue' -SdnsApiRoot http://dns.example.com:8053

        Adds a TXT record using anonymous authentication.

    .EXAMPLE
        $pArgs = @{ SdnsApiRoot = 'http://dns.example.com:8053'; SdnsCred = (Get-Credential); SdnsIgnoreCert = $true }
        PS C:\>Add-DnsTxtSimpleDNSPlus '_acme-challenge.site1.example.com' 'txtvalue' @pArgs

        Adds a TXT record using credentials and ignores certificate validation.

    .EXAMPLE
        $pArgs = @{ SdnsApiRoot = 'http://dns.example.com:8053'; SdnsUser = 'admin'; SdnsPassword = 'xxxxxxxx' }
        PS C:\>Add-DnsTxtSimpleDNSPlus '_acme-challenge.site1.example.com' 'txtvalue' @pArgs

        Adds a TXT record using plain text credentials.
    #>

}

function Remove-DnsTxtSimpleDNSPlus {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword','')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory)]
        [string]$SdnsApiRoot,
        [Parameter(ParameterSetName='Secure')]
        [pscredential]$SdnsCred,
        [Parameter(ParameterSetName='Insecure',Mandatory)]
        [string]$SdnsUser,
        [Parameter(ParameterSetName='Insecure',Mandatory)]
        [string]$SdnsPassword,
        [switch]$SdnsIgnoreCert,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $apiRoot = "$($SdnsApiRoot)/zones"

    # create a pscredential from insecure args if necessary
    if ('Insecure' -eq $PSCmdlet.ParameterSetName) {
        $secpass = ConvertTo-SecureString $SdnsPassword -AsPlainText -Force
        $SdnsCred = New-Object PSCredential ($SdnsUser,$secpass)
    }
    $credSplat = @{}
    if ($SdnsCred) { $credSplat.Credential = $SdnsCred }

    try {
        # ignore cert validation for the duration of the call
        if ($SdnsIgnoreCert) { Set-SdnsCertIgnoreOn }

        $zone = Find-SimpleDNSPlusZone -RecordName $RecordName -SdnsApiRoot $SdnsApiRoot -CredSplat $credSplat

        # Get a list of existing Challenge TXT records for this record name,
        # Simple DNS Plus API returns full fqdns as each record, so no need to parse/shorten it.
        try {
            $recs = (Invoke-RestMethod "$apiRoot/$zone/records" @credSplat @script:UseBasic -EA Stop) |
                Select-Object -Property * -ExcludeProperty TTL |
                Where-Object { $_.Type -eq "TXT" -And $_.Name -eq $RecordName }
        } catch { throw }

        if (-not $recs -or "`"$TxtValue`"" -notin $recs.Data) {
            Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
        } else {
            # Txt record values in simple dns plus contains double quotes encasing the string.
            # So for it to JSON properly, we must remove those double quotes from the string.
            $recs | ForEach-Object { $_.Data = $_.Data -replace '"','' }

            $recToDelete = $recs | Where-Object {$_.Data -eq $TxtValue}
            $recToDelete | Add-Member -NotePropertyName Remove -NotePropertyValue $true
            $bodyJson = ConvertTo-Json @($recToDelete) -Compress

            try {
                Write-Debug "Sending $bodyJson"
                Invoke-RestMethod "$apiRoot/$zone/records" `
                    -Method Patch @credSplat -Body $bodyJson `
                    -ContentType 'application/json' @script:UseBasic -EA Stop | Out-Null
            } catch { throw }

        }

    } finally {
        # return cert validation back to normal
        if ($SdnsIgnoreCert) { Set-SdnsCertIgnoreOff }
    }


    <#
    .SYNOPSIS
        Remove a DNS TXT record from Simple DNS Plus Server.

    .DESCRIPTION
        Remove a DNS TXT record from Simple DNS Plus Server.

    .PARAMETER RecordName
        The fully qualified name of the TXT record.

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER SdnsApiRoot
        The root URL of the Simple DNS Plus Server API. For example, http://dns.example.com:8053 or http://dns.example.com:8053/v2

    .PARAMETER SdnsCred
        The HTTP API credentials required to authenticate.

    .PARAMETER SdnsUser
        The HTTP API Username.

    .PARAMETER SdnsSecret
        The HTTP API Password.

    .PARAMETER SdnsIgnoreCert
        Use this switch to prevent certificate errors when your Simple DNS Plus server is using a self-signed or other untrusted SSL certificate. When passing parameters via hashtable, set it as a boolean such as @{SdnsIgnoreCert=$true}.

    .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-DnsTxtSimpleDNSPlus '_acme-challenge.example.com' 'txtvalue' -SdnsApiRoot http://dns.example.com:8053

        Removes a TXT record using anonymous authentication.

    .EXAMPLE
        $pArgs = @{ SdnsApiRoot = 'http://dns.example.com:8053'; SdnsCred = (Get-Credential); SdnsIgnoreCert = $true }
        PS C:\>Remove-DnsTxtSimpleDNSPlus '_acme-challenge.site1.example.com' 'txtvalue' @pArgs

        Removes a TXT record using credentials and ignores certificate validation.

    .EXAMPLE
        $pArgs = @{ SdnsApiRoot = 'http://dns.example.com:8053'; SdnsUser = 'admin'; SdnsPassword = 'xxxxxxxx' }
        PS C:\>Remove-DnsTxtSimpleDNSPlus '_acme-challenge.site1.example.com' 'txtvalue' @pArgs

        Removes a TXT record using plain text credentials.
    #>

}

function Save-DnsTxtSimpleDNSPlus {
    [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
############################

# https://simpledns.com/help/how-to-use-the-http-api

function Find-SimpleDNSPlusZone {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory, Position = 0)]
        [string]$RecordName,
        [Parameter(Mandatory, Position = 1)]
        [string]$SdnsApiRoot,
        [Parameter(Position = 2)]
        [hashtable]$CredSplat
    )

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

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

    $apiRoot = "$($SdnsApiRoot)/zones"

    # get the list of available zones
    try {
        $zones = (Invoke-RestMethod $apiRoot @credSplat @script:UseBasic -EA Stop) `
            | Where-Object {$_.Type -eq "primary"} `
            | Select-Object -ExpandProperty Name
    } catch { throw }

    # 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 = 1; $i -lt ($pieces.Count - 1); $i++) {
        $zoneTest = "$( $pieces[$i..($pieces.Count-1)] -join '.' )"
        Write-Debug "Checking $zoneTest"

        if ($zoneTest -in $zones) {
            $zoneName = $zones | Where-Object { $_ -eq $zoneTest }
            $script:SdnsRecordZones.$RecordName = $zoneName
            return $zoneName
        }
    }

    return $null
}

# These cert ignore helpers rely on some TLS initialization code that runs during the
# module import. So if you're dot sourcing the plugin file to test, you need to account
# for that.
function Set-SdnsCertIgnoreOn {
    [CmdletBinding()]
    param()

    if ($script:SkipCertSupported) {
        # Core edition
        if (-not $script:UseBasic.SkipCertificateCheck) {
            # temporarily set skip to true
            $script:UseBasic.SkipCertificateCheck = $true
            # remember that we did
            $script:SdnsUnsetIgnoreAfter = $true
        }
    } else {
        # Desktop edition
        Write-Debug "Ignoring certs"
        [CertValidation]::Ignore()
    }
}

function Set-SdnsCertIgnoreOff {
    [CmdletBinding()]
    param()

    if ($script:SkipCertSupported) {
        # Core edition
        if ($script:SdnsUnsetIgnoreAfter) {
            $script:UseBasic.SkipCertificateCheck = $false
            Remove-Variable SdnsUnsetIgnoreAfter -Scope Script
        }
    } else {
        # Desktop edition
        Write-Debug "Un-Ignoring certs"
        [CertValidation]::Restore()
    }
}