DnsPlugins/NameCom.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
function Add-DnsTxtNameCom {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$NameComUsername,
        [Parameter(Mandatory,Position=3)]
        [string]$NameComToken,
        [switch]$NameComUseTestEnv,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $apiRoot = 'https://api.name.com/v4'
    if ($NameComUseTestEnv) { $apiRoot = 'https://api.dev.name.com/v4' }

    $restParams = Get-RestHeaders $NameComUsername $NameComToken

    # check for an existing record
    $domainName,$rec = Get-NameComTxtRecord $RecordName $TxtValue $restParams $apiRoot

    if ($rec) {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
        return
    } else {
        # build the body
        $hostShort = $RecordName -ireplace [regex]::Escape(".$domainName"), [string]::Empty
        $bodyJson = @{host=$hostShort; type='TXT'; answer=$TxtValue; ttl=300} | ConvertTo-Json -Compress
        Write-Debug "Add JSON: $bodyJson"

        # add the new record
        try {
            Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
            $url = "$apiRoot/domains/$($domainName)/records"
            Invoke-RestMethod $url -Method Post -Body $bodyJson @restParams @script:UseBasic -EA Stop | Out-Null
        } catch { throw }
    }




    <#
    .SYNOPSIS
        Add a DNS TXT record to Name.com DNS.
 
    .DESCRIPTION
        Add a DNS TXT record to Name.com DNS.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER NameComUsername
        The account API username.
 
    .PARAMETER NameComToken
        The account API token.
 
    .PARAMETER NameComUseTestEnv
        If specified, use the name.com testing environment.
 
    .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-DnsTxtNameCom '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'username' 'xxxxxxxxxxxx'
 
        Adds a TXT record for the specified site with the specified value.
    #>

}

function Remove-DnsTxtNameCom {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$NameComUsername,
        [Parameter(Mandatory,Position=3)]
        [string]$NameComToken,
        [switch]$NameComUseTestEnv,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $apiRoot = 'https://api.name.com/v4'
    if ($NameComUseTestEnv) { $apiRoot = 'https://api.dev.name.com/v4' }

    $restParams = Get-RestHeaders $NameComUsername $NameComToken

    # check for an existing record
    $domainName,$rec = Get-NameComTxtRecord $RecordName $TxtValue $restParams $apiRoot

    if ($rec) {
        # remove the record
        try {
            Write-Verbose "Removing TXT record for $RecordName with value $TxtValue"
            $url = "$apiRoot/domains/$($domainName)/records/$($rec.id)"
            Invoke-RestMethod $url -Method Delete @restParams @script:UseBasic -EA Stop | Out-Null
        } catch { throw }
    } else {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
        return
    }




    <#
    .SYNOPSIS
        Remove a DNS TXT record from Name.com DNS.
 
    .DESCRIPTION
        Remove a DNS TXT record from Name.com DNS.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER NameComUsername
        The account API username.
 
    .PARAMETER NameComToken
        The account API token.
 
    .PARAMETER NameComUseTestEnv
        If specified, use the name.com testing environment.
 
    .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-DnsTxtNameCom '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'username' 'xxxxxxxxxxxx'
 
        Remove a TXT record for the specified site with the specified value.
    #>

}

function Save-DnsTxtNameCom {
    [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.name.com/api-docs/DNS

function Find-NameComZone {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [hashtable]$RestParams,
        [Parameter(Mandatory,Position=2)]
        [string]$ApiRoot
    )

    # This provider doesn't appear to host sub-zones. But their API is nice enough to return the apex
    # domain automatically when using their GetDomain method even if you pass it a record within that
    # domain.
    # https://www.name.com/api-docs/Domains#GetDomain

    # So we just have to call it once and assuming they have a domain for that record, it'll return
    # the apex that we care about for later calls.
    try {
        $url = "$ApiRoot/domains/$RecordName"
        $domain = Invoke-RestMethod $url @RestParams @script:UseBasic -EA Stop

        if ($domain -and $domain.domainName) {
            return $domain.domainName
        }
    } catch {
        # if domain doesn't exist in their account, they throw a 404 which we'll catch
        # here and just ignore.
    }

    return $null
}

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

    # Find the zone apex based on the record name
    $zoneName = Find-NameComZone $RecordName $RestParams $ApiRoot
    if (-not $zoneName) {
        throw "Domain not found for $RecordName"
    }

    # Unfortunately, there's no way to get a specific record without knowing it's ID. So we have to list (and
    # potentially page through) all of them and filter the results on our side.
    # https://www.name.com/api-docs/DNS#ListRecords

    $recs = @()
    $nextPage = ''
    do {
        $url = "$ApiRoot/domains/$zoneName/records$nextPage"
        Write-Debug "Fetching records page"
        $response = Invoke-RestMethod $url @RestParams @script:UseBasic -EA Stop
        if ($response.records) {
            $recs += $response.records
        }

        # check for paging
        if ([String]::IsNullOrWhiteSpace($response.nextPage)) { break }
        $nextPage = "?page=$($response.nextPage)"
    } while ($true)

    # Return the zone in case the record doesn't exist and the record that matches the specified $RecordName
    $rec = ($recs | Where-Object { $_.fqdn -eq "$RecordName." -and $_.answer -eq $TxtValue -and $_.type -eq 'TXT' })
    return $zoneName,$rec
}

function Get-RestHeaders {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$NameComUsername,
        [Parameter(Mandatory,Position=1)]
        [string]$NameComUserToken
    )

    $restParams = @{
        Headers = @{
            Accept='application/json'
            Authorization = "Basic {0}" -f [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $NameComUserName,$NameComToken)))
        }
        ContentType = 'application/json'
    }

    return $restParams
}