Plugins/DNSPod.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
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(ParameterSetName='Secure',Mandatory)]
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory)]
        [string]$DNSPodKeyId,
        [Parameter(ParameterSetName='Secure',Mandatory)]
        [securestring]$DNSPodKeyToken,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory)]
        [string]$DNSPodKeyTokenInsecure,
        [Parameter(ParameterSetName='Secure')]
        [Parameter(ParameterSetName='DeprecatedInsecure')]
        [string]$DNSPodApiRoot='https://api.dnspod.com',
        [Parameter(ParameterSetName='Obsolete_DO_NOT_USE',Mandatory)]
        [pscredential]$DNSPodCredential,
        [Parameter(ParameterSetName='Obsolete_DO_NOT_USE',Mandatory)]
        [string]$DNSPodUsername,
        [Parameter(ParameterSetName='Obsolete_DO_NOT_USE',Mandatory)]
        [string]$DNSPodPwdInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    if ('Obsolete_DO_NOT_USE' -eq $PSCmdlet.ParameterSetName) {
        throw "DNSPod requires updated API Key/Token values. See user guide for details."
    }

    # build the login_token value
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $DNSPodKeyTokenInsecure = [pscredential]::new('a',$DNSPodKeyToken).GetNetworkCredential().Password
    }
    $authToken = "$DNSPodKeyId%2C$DNSPodKeyTokenInsecure"

    try {
        Write-Verbose "Searching for existing TXT record"
        $zone, $rec = Get-DNSPodTxtRecord $RecordName $TxtValue $authToken $DNSPodApiRoot
    }
    catch { throw }

    if ($rec) {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
    }
    else {
        # add a new record
        try {
            Write-Verbose "Adding $RecordName with value $TxtValue"

            $recShort = ($RecordName -ireplace [regex]::Escape($zone.name), [string]::Empty).TrimEnd('.')
            $addQuery = @{
                Uri = "$DNSPodApiRoot/Record.Create"
                Method = 'POST'
                Body = "domain_id=$($zone.id)&sub_domain=$recShort&record_type=TXT&value=$TxtValue&record_line=%E9%BB%98%E8%AE%A4&login_token=$authToken&format=json&lang=en"
                UserAgent = $script:USER_AGENT
                ErrorAction = 'Stop'
            }
            #Write-Verbose ($addQuery.Body)
            $response = Invoke-RestMethod @addQuery @script:UseBasic

            if ($response.status.code -ne 1 -and $response.status.code -ne 31) {
                Write-Verbose ($response | ConvertTo-Json -dep 10)
                throw $response.status.message
            }
        }
        catch { throw }
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to DNSPod.

    .DESCRIPTION
        Uses the DNSPod DNS API to add a DNS TXT record.

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

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER DNSPodKeyId
        The API Key ID value.

    .PARAMETER DNSPodKeyToken
        The API Key Token value as a SecureString value.

    .PARAMETER DNSPodKeyTokenInsecure
        (DEPRECATED) The API Key Token value as a standard String value.

    .PARAMETER DNSPodApiRoot
        The root URL for the DNSPod API you are using. Default to "https://api.dnspod.com" but may also be set to "https://dnsapi.cn".

    .PARAMETER DNSPodCredential
        Obsolete parameter that no longer works with DNSPod API. Do not use.

    .PARAMETER DNSPodUsername
        Obsolete parameter that no longer works with DNSPod API. Do not use.

    .PARAMETER DNSPodPwdInsecure
        Obsolete parameter that no longer works with DNSPod API. Do not use.

    .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' -DNSPodKeyId '1' -DnsPodKeyToken (Read-Host -AsSecureString)

        Adds a TXT record for the specified site with the specified value using a secure token value.
    #>

}

function Remove-DnsTxt {
    [CmdletBinding(DefaultParameterSetName = 'Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory)]
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory)]
        [string]$DNSPodKeyId,
        [Parameter(ParameterSetName='Secure',Mandatory)]
        [securestring]$DNSPodKeyToken,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory)]
        [string]$DNSPodKeyTokenInsecure,
        [Parameter(ParameterSetName='Secure')]
        [Parameter(ParameterSetName='DeprecatedInsecure')]
        [string]$DNSPodApiRoot='https://api.dnspod.com',
        [Parameter(ParameterSetName='Obsolete_DO_NOT_USE',Mandatory)]
        [pscredential]$DNSPodCredential,
        [Parameter(ParameterSetName='Obsolete_DO_NOT_USE',Mandatory)]
        [string]$DNSPodUsername,
        [Parameter(ParameterSetName='Obsolete_DO_NOT_USE',Mandatory)]
        [string]$DNSPodPwdInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    if ('Obsolete_DO_NOT_USE' -eq $PSCmdlet.ParameterSetName) {
        throw "DNSPod requires updated API Key/Token values. See user guide for details."
    }

    # build the login_token value
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $DNSPodKeyTokenInsecure = [pscredential]::new('a',$DNSPodKeyToken).GetNetworkCredential().Password
    }
    $authToken = "$DNSPodKeyId%2C$DNSPodKeyTokenInsecure"

    try {
        Write-Verbose "Searching for existing TXT record"
        $zone, $rec = Get-DNSPodTxtRecord $RecordName $TxtValue $authToken $DNSPodApiRoot
    }
    catch { throw }

    if ($rec) {
        # delete the record
        try {
            Write-Verbose "Removing $RecordName with value $TxtValue"

            $delQuery = @{
                Uri = "$DNSPodApiRoot/Record.Remove"
                Method = 'POST'
                Body = "domain_id=$($zone.id)&record_id=$($rec.id)&login_token=$authToken&format=json&lang=en"
                UserAgent = $script:USER_AGENT
                ErrorAction = 'Stop'
            }
            $response = Invoke-RestMethod @delQuery @script:UseBasic

            if ($response.status.code -ne 1 -and $response.status.code -ne 8) {
                throw $response.status.message
            }
        }
        catch { throw }
    }
    else {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from DNSPod.

    .DESCRIPTION
        Uses the DNSPod DNS API to remove a DNS TXT record.

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

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER DNSPodKeyId
        The API Key ID value.

    .PARAMETER DNSPodKeyToken
        The API Key Token value as a SecureString value.

    .PARAMETER DNSPodKeyTokenInsecure
        (DEPRECATED) The API Key Token value as a standard String value.

    .PARAMETER DNSPodApiRoot
        The root URL for the DNSPod API you are using. Default to "https://api.dnspod.com" but may also be set to "https://dnsapi.cn".

    .PARAMETER DNSPodCredential
        Obsolete parameter that no longer works with DNSPod API. Do not use.

    .PARAMETER DNSPodUsername
        Obsolete parameter that no longer works with DNSPod API. Do not use.

    .PARAMETER DNSPodPwdInsecure
        Obsolete parameter that no longer works with DNSPod API. Do not use.

    .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' -DNSPodKeyId '1' -DnsPodKeyToken (Read-Host -AsSecureString)

        Removes a TXT record for the specified site with the specified value using a secure token 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://docs.dnspod.cn/api

function Get-DNSPodTxtRecord {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$LoginToken,
        [Parameter(Mandatory,Position=3)]
        [string]$ApiRoot
    )

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

    # check for the record in the cache
    if ($script:DNSPodRecordZones.ContainsKey($RecordName)) {
        $zone = $script:DNSPodRecordZones.$RecordName
    }

    if (-not $zone) {

        try {
            # get zone
            $zoneQuery = @{
                Uri = "$ApiRoot/Domain.List"
                Method = 'POST'
                Body = "login_token=$LoginToken&format=json&lang=en"
                UserAgent = $script:USER_AGENT
                ErrorAction = 'Stop'
            }
            $response = Invoke-RestMethod @zoneQuery @script:UseBasic

            if ($response.status.code -ne 1) {
                throw $response.status.message
            }
            else {
                [array]$hostedZones = $response.domains
            }

            $zone = $hostedZones | Where-Object { $RecordName -match $_.name }

            # save zone to cache
            $script:DNSPodRecordZones.$RecordName = $zone
        }
        catch { throw }

        if (-not $zone) {
            throw "Failed to find hosted zone for $RecordName"
        }

    }

    try {

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

        # get record
        $recQuery = @{
            Uri = "$ApiRoot/Record.List"
            Method = 'POST'
            Body = "login_token=$LoginToken&format=json&lang=en&domain_id=$($zone.id)"
            UserAgent = $script:USER_AGENT
            ErrorAction = 'Stop'
        }
        $response = Invoke-RestMethod @recQuery @script:UseBasic

        if ($response.status.code -ne 1) {
            throw $response.status.message
        }
        else {
            $rec = $response.records | Where-Object {
                $_.name -eq $recShort -and
                $_.type -eq 'TXT' -and
                $_.value -eq $TxtValue
            }
        }
    }
    catch { throw }

    return @($zone, $rec)
}