DnsPlugins/DeSEC.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
function Add-DnsTxtDeSec {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=2)]
        [securestring]$DSToken,
        [Parameter(ParameterSetName='Insecure',Mandatory,Position=2)]
        [string]$DSTokenInsecure,
        [Parameter()]
        [int]$DSTTL = 300,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # convert the secure token to a normal string
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $DSTokenInsecure = (New-Object PSCredential ("user", $DSToken)).GetNetworkCredential().Password
    }

    try {
        $rrset, $recordUri, $domain, $subname = Find-DeSECRRset $RecordName $DSTokenInsecure

        $auth = Get-DeSECAuthHeader $DSTokenInsecure
        if ($rrset) {
            if ("`"$TxtValue`"" -in $rrset.records) {
                Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
                return
            }

            $rrset.records += "`"$TxtValue`""
            $data = @{
                records = $rrset.records
            } | ConvertTo-Json
            Write-Verbose "Adding record $RecordName with value $TxtValue to existing RRset."
            Invoke-RestMethod $recordUri -Method Patch -Headers $auth -Body $data `
                -ContentType 'application/json' @script:UseBasic | Out-Null
        } else {
            $data = @{
                subname = $subname
                "type" = "TXT"
                records = @("`"$TxtValue`"")
                ttl = $DSTTL
            } | ConvertTo-Json

            Write-Verbose "Creating new RRset for record $RecordName with value $TxtValue."
            Invoke-RestMethod "https://desec.io/api/v1/domains/$($domain)/rrsets/" -Method Post -Body $data `
                -Headers $auth -ContentType 'application/json' @script:UseBasic | Out-Null
        }
    } catch {
        throw
    }

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

    .DESCRIPTION
        Add a DNS TXT record to deSEC.

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

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER DSToken
        The deSEC API authentication token for your account.

    .PARAMETER DSTokenInsecure
        The deSEC API authentication token for your account.

    .PARAMETER DSTTL
        The TTL of new TXT record (default 300).

    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.

    .EXAMPLE
        $DSToken = ConvertTo-SecureString 'yourdesectoken' -AsPlainText -Force
        Add-DnsTxtDeSec '_acme-challenge.site1.example.com' 'asdfqwer12345678' $DSToken

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

}

function Remove-DnsTxtDeSec {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=2)]
        [securestring]$DSToken,
        [Parameter(ParameterSetName='Insecure',Mandatory,Position=2)]
        [string]$DSTokenInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # convert the secure token to a normal string
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $DSTokenInsecure = (New-Object PSCredential ("user", $DSToken)).GetNetworkCredential().Password
    }

    # get existing record
    try {
        $rrset, $recordUri, $domain, $subname = Find-DeSECRRset $RecordName $DSTokenInsecure
        if (!$rrset) {
            Write-Debug "Record $RecordName doesn't exist. Nothing to do."
            return
        }
    } catch {
        throw
    }

    if ("`"$TxtValue`"" -notin $rrset.records) {
        Write-Debug "Record $RecordName doesn't contain $TxtValue. Nothing to do."
        return
    }

    try {
        $auth = Get-DeSECAuthHeader $DSTokenInsecure

        $data = @{
            records = $rrset.records.where( { $_ -ne "`"$TxtValue`"" } )
        } | ConvertTo-Json
        Write-Verbose "Deleting record $RecordName with value $TxtValue."
        Invoke-RestMethod $recordUri -Method Patch -Headers $auth -Body $data `
            -ContentType 'application/json' @script:UseBasic | Out-Null
    } catch { throw }

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

    .DESCRIPTION
        Remove a DNS TXT record from deSEC.

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

    .PARAMETER TxtValue
        The value of the TXT record.

    .PARAMETER DSToken
        The deSEC API authentication token for your account.

    .PARAMETER DSTokenInsecure
        The deSEC API authentication token for your account.

    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.

    .EXAMPLE
        $DSToken = ConvertTo-SecureString 'yourdesectoken' -AsPlainText -Force
        Remove-DnsTxtDeSec '_acme-challenge.site1.example.com' 'asdfqwer12345678' $DSToken

        Removes a TXT record for the specified site with the specified value.
    #>

}

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

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

    Write-Verbose "Attempting to find hosted zone for $RecordName"
    if (!($domain = Find-DeSECZone $RecordName $DSTokenInsecure)) {
        throw "Unable to find deSEC hosted zone for $RecordName"
    }

    $subname = $RecordName -ireplace [regex]::Escape(".$domain"), [string]::Empty


    # .NET thinks all URLS are Windows filenames (no trailing dot)
    # replace trailing ... with escaped %2e%2e%2e
    # https://stackoverflow.com/questions/856885/httpwebrequest-to-url-with-dot-at-the-end
    $recordUri = "https://desec.io/api/v1/domains/$($domain)/rrsets/$($subname)%2e%2e%2e/TXT/"
    Write-Debug "$RecordName has URI: $recordUri"

    $auth = Get-DeSECAuthHeader $DSTokenInsecure

    # get existing record
    try {
        $rrset = Invoke-RestMethod $recordUri -Headers $auth `
            -ContentType 'application/json' @script:UseBasic
        return $rrset, $recordUri, $domain, $subname
    } catch {
        if ($_.Exception.Response.StatusCode.Value__ -eq 404) {
            return $null, $null, $domain, $subname
        }
        throw
    }
}

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

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

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

    # get the list of available zones
    try {
        $auth = Get-DeSECAuthHeader $DSTokenInsecure
        $zones = (Invoke-RestMethod "https://desec.io/api/v1/domains/" -Headers $auth @script:UseBasic).name
    } catch { throw }

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

        if ($zoneTest -in $zones) {
            $script:DSRecordZones.$RecordName = $zoneTest
            return $zoneTest
        }
    }

    return $null
}

function Get-DeSECAuthHeader {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$DSTokenInsecure
    )

    # now build the header hashtable
    $header = @{
       Authorization = "Token $($DSTokenInsecure)"
    }

    return $header
}