DnsPlugins/Rackspace.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
function Add-DnsTxtRackspace {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$RSUsername,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=3)]
        [securestring]$RSApiKey,
        [Parameter(ParameterSetName='Insecure',Mandatory,Position=3)]
        [string]$RSApiKeyInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    Connect-RackspaceDns @PSBoundParameters

    # get the zone name for our record
    $zoneID,$zoneName = Find-RSZone $RecordName
    Write-Debug "Found zone $zoneID for $zoneName"

    $zoneRoot = "$($script:RSAuth.dnsBase)/domains/$zoneID"
    $restParams = @{
        Headers = @{'X-Auth-Token'=$script:RSAuth.token}
        ContentType = 'application/json'
    }

    # attempt to find the existing record(s)
    try {
        $response = Invoke-RestMethod "$zoneRoot/records?type=TXT&name=$RecordName" `
             @restParams @script:UseBasic
        $recs = $response.records
    } catch { throw }

    if (-not $recs -or $TxtValue -notin $recs.data) {
        # add new record
        try {
            Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
            $bodyJson = @{records = @( @{
                name=$RecordName
                type='TXT'
                data=$TxtValue
                ttl=300
            })} | ConvertTo-Json -Compress
            Invoke-RestMethod "$zoneRoot/records" -Method Post -Body $bodyJson `
                @restParams @script:UseBasic | Out-Null
        } catch { throw }
    } else {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
    }


    <#
    .SYNOPSIS
        Add a DNS TXT record to Rackspace Cloud DNS
 
    .DESCRIPTION
        Add a DNS TXT record to Rackspace Cloud DNS
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER RSUsername
        The username of your Rackspace Cloud account.
 
    .PARAMETER RSApiKey
        The API Key associated with your Rackspace Cloud account. This SecureString version of the API Key should only be used on Windows.
 
    .PARAMETER RSApiKeyInsecure
        The API Key associated with your Rackspace Cloud account. This standard String version of the API Key should be used on non-Windows OSes.
 
    .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 "Rackspace API Key" -AsSecureString
        PS C:\>Add-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'myusername' $key
 
        Adds a TXT record using a securestring object for RSApiKey. (Only works on Windows)
 
    .EXAMPLE
        Add-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'myusername' 'xxxxxxxx'
 
        Adds a TXT record using a standard string object for RSApiKeyInsecure. (Use this on non-Windows)
    #>

}

function Remove-DnsTxtRackspace {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$RSUsername,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=3)]
        [securestring]$RSApiKey,
        [Parameter(ParameterSetName='Insecure',Mandatory,Position=3)]
        [string]$RSApiKeyInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    Connect-RackspaceDns @PSBoundParameters

    # get the zone name for our record
    $zoneID,$zoneName = Find-RSZone $RecordName
    Write-Debug "Found zone $zoneID for $zoneName"

    $zoneRoot = "$($script:RSAuth.dnsBase)/domains/$zoneID"
    $restParams = @{
        Headers = @{'X-Auth-Token'=$script:RSAuth.token}
        ContentType = 'application/json'
    }

    # attempt to find the existing record(s)
    try {
        $response = Invoke-RestMethod "$zoneRoot/records?type=TXT&name=$RecordName" `
             @restParams @script:UseBasic
        $recs = $response.records
    } catch { throw }

    if (-not $recs -or $TxtValue -notin $recs.data) {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
    } else {
        # delete record
        try {
            Write-Verbose "Removing TXT record for $RecordName with value $TxtValue"
            $recID = ($recs | Where-Object { $_.data -eq $TxtValue }).id
            Invoke-RestMethod "$zoneRoot/records/$recID" -Method Delete `
                @restParams @script:UseBasic | Out-Null
        } catch { throw }
    }


    <#
    .SYNOPSIS
        Remove a DNS TXT record from Rackspace Cloud DNS
 
    .DESCRIPTION
        Remove a DNS TXT record from Rackspace Cloud DNS
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER RSUsername
        The username of your Rackspace Cloud account.
 
    .PARAMETER RSApiKey
        The API Key associated with your Rackspace Cloud account. This SecureString version of the API Key should only be used on Windows.
 
    .PARAMETER RSApiKeyInsecure
        The API Key associated with your Rackspace Cloud account. This standard String version of the API Key should be used on non-Windows OSes.
 
    .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 "Rackspace API Key" -AsSecureString
        PS C:\>Remove-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'myusername' $key
 
        Removes a TXT record using a securestring object for RSApiKey. (Only works on Windows)
 
    .EXAMPLE
        Remove-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'myusername' 'xxxxxxxx'
 
        Removes a TXT record using a standard string object for RSApiKeyInsecure. (Use this on non-Windows)
    #>

}

function Save-DnsTxtRackspace {
    [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 Connect-RackspaceDns {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RSUsername,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=1)]
        [securestring]$RSApiKey,
        [Parameter(ParameterSetName='Insecure',Mandatory,Position=1)]
        [string]$RSApiKeyInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraConnectParams
    )

    # return if we already have a valid Bearer token
    if ($script:RSAuth -and (Get-DateTimeOffsetNow) -lt $script:RSAuth.expires) { return }

    # decrypt the secure password so we can put it in the auth header
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $RSApiKeyInsecure = (New-Object PSCredential "user",$RSApiKey).GetNetworkCredential().Password
    }

    # create the authentication object we need to send
    # https://developer.rackspace.com/docs/cloud-dns/quickstart/
    $rsAuthBody = @{
        auth = @{
            'RAX-KSKEY:apiKeyCredentials' = @{
                username = $RSUsername
                apiKey = $RSApiKeyInsecure
            }
        }
    } | ConvertTo-Json -Compress

    # authenticate
    try {
        $response = Invoke-RestMethod 'https://identity.api.rackspacecloud.com/v2.0/tokens' `
            -Method Post -ContentType 'application/json' -Body $rsAuthBody @script:UseBasic
        Write-Debug "Response $($response | ConvertTo-Json)"
    } catch { throw }

    # save what we care about to a script variable
    if ($response.access) {
        $response.access.token.expires = Repair-ISODate $response.access.token.expires
        $script:RSAuth = @{
            token = $response.access.token.id
            dnsBase = ($response.access.serviceCatalog | ?{ $_.name -eq 'cloudDNS' })[0].endpoints.publicURL
            expires = [DateTimeOffset]::Parse($response.access.token.expires).AddMinutes(-5)
        }
    } else {
        throw "Unexpected authentication response from Rackspace API. Enable debug output for details."
    }

}

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

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

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

    # 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
    $apiRoot = $script:RSAuth.dnsBase

    $pieces = $RecordName.Split('.')
    for ($i=1; $i -lt ($pieces.Count-1); $i++) {
        $zoneTest = "$( $pieces[$i..($pieces.Count-1)] -join '.' )"
        Write-Debug "Checking $zoneTest"
        try {
            $response = Invoke-RestMethod "$apiRoot/domains?name=$zoneTest" @script:UseBasic `
                -Headers @{'X-Auth-Token'=$script:RSAuth.token} -ContentType 'application/json'
            if ($response.totalEntries -gt 0) {
                $z = $response.domains[0]
                $script:RSRecordZones.$RecordName = $z.id,$z.name
                return $z.id,$z.name
            }
        } catch { throw }
    }

    return $null
}