Plugins/Simply.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
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]$SimplyAccount,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=3)]
        [securestring]$SimplyAPIKey,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=3)]
        [string]$SimplyAPIKeyInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $SimplyAPIKeyInsecure = [pscredential]::new('a',$SimplyAPIKey).GetNetworkCredential().Password
    }
    $apiRoot = "https://api.simply.com/1/$SimplyAccount/$SimplyAPIKeyInsecure/my/products"

    $zoneID,$rec = Get-SimplyTXTRecord $RecordName $TxtValue $apiRoot

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

        # build the new record object
        $body = @{
            name = $RecordName # Simply allows FQDNs here even though they return short names
            type = 'TXT'
            data = $TxtValue
            ttl = 60
        } | ConvertTo-Json

        Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
        try {
            $postParams = @{
                Uri = "$apiRoot/$zoneID/dns/records"
                Method = 'POST'
                Body = $body
                ContentType = 'application/json'
                ErrorAction = 'Stop'
                Verbose = $false
            }
            Write-Debug "POST $(SimplyRedactKey $postParams.Uri)`n$body"
            Invoke-RestMethod @postParams @script:UseBasic | Out-Null
        }
        catch {
            Write-Debug $_
            throw
        }

    }


    <#
    .SYNOPSIS
        Add a DNS TXT record to Simply.
    .DESCRIPTION
        Use Simply api to add a TXT record to a Simply DNS zone.
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
    .PARAMETER TxtValue
        The value of the TXT record.
    .PARAMETER SimplyAccount
        The account name of the account used to connect to Simply API (e.g. S123456)
    .PARAMETER SimplyAPIKey
        The API Key associated with the account as a SecureString value.
    .PARAMETER SimplyAPIKeyInsecure
        (DEPRECATED) The API Key associated with the account as a standard string 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
        $key = Read-Host 'API Key' -AsSecureString
        Add-DnsTxt '_acme-challenge.example.com' 'txt-value' 'S123456' $key

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

}

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

    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $SimplyAPIKeyInsecure = [pscredential]::new('a',$SimplyAPIKey).GetNetworkCredential().Password
    }
    $apiRoot = "https://api.simply.com/1/$SimplyAccount/$SimplyAPIKeyInsecure/my/products"

    $zoneID,$rec = Get-SimplyTXTRecord $RecordName $TxtValue $apiRoot

    if ($rec) {

        Write-Verbose "Removing TXT record for $RecordName with value $TxtValue"
        try {
            $delParams = @{
                Uri = "$apiRoot/$zoneID/dns/records/$($rec.record_id)"
                Method = 'DELETE'
                ErrorAction = 'Stop'
                Verbose = $false
            }
            Write-Debug "DELETE $(SimplyRedactKey $delParams.Uri)"
            Invoke-RestMethod @delParams @script:UseBasic | Out-Null
        }
        catch {
            Write-Debug $_
            throw
        }

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

    <#
    .SYNOPSIS
        Removes a DNS TXT record from Simply.
    .DESCRIPTION
        Use Simply API to remove a TXT record from a Simply DNS zone.
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
    .PARAMETER TxtValue
        The value of the TXT record.
    .PARAMETER SimplyAccount
        The account name of the account used to connect to Simply API (e.g. S123456)
    .PARAMETER SimplyAPIKey
        The API Key associated with the account as a SecureString value.
    .PARAMETER SimplyAPIKeyInsecure
        (DEPRECATED) The API Key associated with the account as a standard string 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
        $key = Read-Host 'API Key' -AsSecureString
        Remove-DnsTxt '_acme-challenge.example.com' 'txt-value' 'S123456' $key

        Removes a TXT record from 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.simply.com/en/docs/api/

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

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

    # check for the record in the cache
    #$zone,$zoneID = $script:SimplyRecordZones.$RecordName
    $zoneID,$recShort = $script:SimplyRecordZones.$RecordName

    if (-not $zoneID) {

        # query all of the domains on the account
        try {
            $getParams = @{
                Uri = $ApiRoot
                ErrorAction = 'Stop'
                Verbose = $false
            }
            Write-Debug "GET $(SimplyRedactKey $getParams.Uri)"
            $products = (Invoke-RestMethod @getParams @script:UseBasic).products
        } catch { throw }

        # find the zone for the closest/deepest sub-zone that would contain 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"

            $match = $products | Where-Object { $zoneTest -eq $_.domain.name_idn }
            if ($match) {
                # To query the records, we need the "object" id of the zone which is currently
                # the non-punycode version of the domain name. But that's not guaranteed to always
                # be the case. So just treat it like an arbitrary ID value.
                $zoneID = $match.object

                # derive the short record name
                if ($RecordName -eq $match.domain.name_idn) {
                    $recShort = '@'
                } else {
                    $recShort = ($RecordName -ireplace [regex]::Escape($match.domain.name_idn), [string]::Empty).TrimEnd('.')
                }

                $script:SimplyRecordZones.$RecordName = $zoneID,$recShort
                break
            }
        }
    }

    # query the zone records and check for the one we care about
    try {
        $getParams = @{
            Uri = "$ApiRoot/$zoneID/dns/records"
            ErrorAction = 'Stop'
            Verbose = $false
        }
        Write-Debug "GET $(SimplyRedactKey $getParams.Uri)"
        $response = Invoke-RestMethod @getParams @script:UseBasic
    }
    catch {
        Write-Debug "$_"
        throw
    }

    if ($response.status -eq 200) {

        $rec = $response.records | Where-Object {
            $_.type -eq 'TXT' -and
            $_.name -eq $recShort -and
            $_.data -eq $TxtValue
        }

        # return the zone name and the record
        return $zoneID,$rec

    } else {
        Write-Debug "Simply Response: `n$($response | ConvertTo-Json)"
        throw "Unexpected response from Simply: $($response.message)."
    }

}

function SimplyRedactKey {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$Uri
    )

    # Simply's API auth puts the API secret right in the URL which makes logging what we're
    # doing unintentionally expose that secret in the logs. We're going to try and redact
    # the value before we log it.
    # https://api.simply.com/1/S012345/ABCDEFGHIJKLMNOP/my/products"
    # [ 5th index ]
    $pieces = $Uri.Split('/')
    $pieces[5] = 'XXXXXXXX'
    return ($pieces -join '/')
}