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

    # grab the cleartext key if the secure version was used
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $NS1KeyInsecure = (New-Object PSCredential "user",$NS1Key).GetNetworkCredential().Password
    }

    $apiRoot = 'https://api.nsone.net/v1'
    $restParams = @{
        Headers = @{
            Accept = 'application/json'
            'X-NSONE-Key'=$NS1KeyInsecure
        }
        ContentType = 'application/json'
    }

    # get the zone name for our record
    $zoneName = Find-NS1Zone $RecordName $restParams
    Write-Debug "Found zone $zoneName"

    # Search for the record we care about, but ignore errors
    # because the record not existing generates an exception
    # and that's ok
    try {
        $rec = Invoke-RestMethod "$apiRoot/zones/$zoneName/$RecordName/TXT" @restParams @script:UseBasic
    } catch {}

    if (-not $rec) {
        # add new record
        Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
        $bodyJson = @{zone=$zoneName;type='TXT';domain=$RecordName;ttl=10;answers=@(@{answer=@($TxtValue)})} |
            ConvertTo-Json -Compress -Depth 5
        Invoke-RestMethod "$apiRoot/zones/$zoneName/$RecordName/TXT" -Method Put -Body $bodyJson `
            @restParams @script:UseBasic | Out-Null
    } else {
        if ($TxtValue -in $rec.answers.answer) {
            Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
        } else {
            # add a new answer
            $rec.answers += @{answer=@($TxtValue)}
            $bodyJson = @{answers=$rec.answers} | ConvertTo-Json -Compress -Depth 5
            Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
            Invoke-RestMethod "$apiRoot/zones/$zoneName/$RecordName/TXT" -Method Post -Body $bodyJson `
                @restParams @script:UseBasic | Out-Null
        }
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to NS1.
 
    .DESCRIPTION
        Add a DNS TXT record to NS1.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER NS1Key
        The API key with DNS permissions on your NS1 account. This SecureString version should only be used on Windows.
 
    .PARAMETER NS1KeyInsecure
        The API key with DNS permissions on your NS1 account. This standard String version 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 -Prompt "NS1 Key" -AsSecureString
        PS C:\>Add-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' $key
 
        Adds a TXT record for the specified site with the specified value from Windows.
 
    .EXAMPLE
        Add-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'xxxxxxxxxxxx'
 
        Adds a TXT record for the specified site with the specified value from non-Windows.
    #>

}

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

    # grab the cleartext key if the secure version was used
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $NS1KeyInsecure = (New-Object PSCredential "user",$NS1Key).GetNetworkCredential().Password
    }

    $apiRoot = 'https://api.nsone.net/v1'
    $restParams = @{
        Headers = @{
            Accept = 'application/json'
            'X-NSONE-Key'=$NS1KeyInsecure
        }
        ContentType = 'application/json'
    }

    # get the zone name for our record
    $zoneName = Find-NS1Zone $RecordName $restParams
    Write-Debug "Found zone $zoneName"

    # Search for the record we care about, but ignore errors
    # because the record not existing generates an exception
    # and that's ok
    try {
        $rec = Invoke-RestMethod "$apiRoot/zones/$zoneName/$RecordName/TXT" @restParams @script:UseBasic
    } catch {}

    if (-not $rec) {
        Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
    } else {
        if ($TxtValue -in $rec.answers.answer) {
            if ($rec.answers.Count -eq 1) {
                # last answer, so delete the record
                Write-Verbose "Deleting TXT record for $RecordName"
                Invoke-RestMethod "$apiRoot/zones/$zoneName/$RecordName/TXT" -Method Delete `
                    @restParams @script:UseBasic | Out-Null
            } else {
                # just remove the answer from the list
                $rec.answers = @($rec.answers | Where-Object { $TxtValue -notin $_.answer })
                $bodyJson = @{answers=$rec.answers} | ConvertTo-Json -Compress -Depth 5
                Write-Verbose "Removing a TXT record for $RecordName with value $TxtValue"
                Invoke-RestMethod "$apiRoot/zones/$zoneName/$RecordName/TXT" -Method Post -Body $bodyJson `
                    @restParams @script:UseBasic | Out-Null
            }
        } else {
            Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
        }
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from NS1.
 
    .DESCRIPTION
        Remove a DNS TXT record from NS1.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER NS1Key
        The API key with DNS permissions on your NS1 account. This SecureString version should only be used on Windows.
 
    .PARAMETER NS1KeyInsecure
        The API key with DNS permissions on your NS1 account. This standard String version 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 "NS1 Key" -AsSecureString
        PS C:\>Remove-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' $key
 
        Removes a TXT record for the specified site with the specified value from Windows.
 
    .EXAMPLE
        Remove-DnsTxtNS1 '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'xxxxxxxxxxxx'
 
        Remove a TXT record for the specified site with the specified value from non-Windows.
    #>

}

function Save-DnsTxtNS1 {
    [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://ns1.com/api

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

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

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

    $apiRoot = 'https://api.nsone.net/v1'

    # 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

    # get the list of zones
    try {
        $zones = Invoke-RestMethod "$apiRoot/zones" @RestParams @script:UseBasic
    } catch { throw }

    $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.zone) {
            $zoneName = ($zones | Where-Object { $_.zone -eq $zoneTest }).zone
            $script:NS1RecordZones.$RecordName = $zoneName
            return $zoneName
        }
    }

    return $null

}