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

    # un-secure the password so we can add it to the auth header
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $GandiTokenInsecure = (New-Object PSCredential "user",$GandiToken).GetNetworkCredential().Password
    }
    $restParams = @{
        Headers = @{
            'X-Api-Key' = $GandiTokenInsecure
            Accept = 'application/json'
        }
        ContentType = 'application/json'
    }

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

    # find the matching TXT record if it exists
    $recShort = $RecordName -ireplace [regex]::Escape(".$zoneName"), [string]::Empty
    $recUrl = "https://dns.api.gandi.net/api/v5/domains/$zoneName/records/$recShort/TXT"
    try {
        $rec = Invoke-RestMethod $recUrl @restParams @script:UseBasic
    } catch {}

    if ($rec -and $TxtValue -in $rec.rrset_values) {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
    } else {
        if (-not $rec) {
            # add new record
            try {
                Write-Verbose "Adding a TXT record for $RecordName with value $TxtValue"
                $bodyJson = @{rrset_values=@($TxtValue)} | ConvertTo-Json -Compress
                Invoke-RestMethod $recUrl -Method Post -Body $bodyJson `
                    @restParams @script:UseBasic -EA Stop | Out-Null
            } catch { throw }
        } else {
            # update the existing record
            try {
                Write-Verbose "Updating a TXT record for $RecordName with value $TxtValue"
                $bodyJson = @{rrset_values=(@($rec.rrset_values.Trim('"')) + @($TxtValue))} | ConvertTo-Json -Compress
                Invoke-RestMethod $recUrl -Method Put -Body $bodyJson `
                    @restParams @script:UseBasic -EA Stop | Out-Null
            } catch { throw }
        }
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to Gandi.
 
    .DESCRIPTION
        Add a DNS TXT record to Gandi.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER GandiToken
        The API token for your Gandi account. This SecureString version should only be used on Windows.
 
    .PARAMETER GandiTokenInsecure
        The API token for your Gandi 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
        $token = Read-Host "Gandi Token" -AsSecureString
        PS C:\>Add-DnsTxtGandi '_acme-challenge.site1.example.com' 'asdfqwer12345678' $token
 
        Adds a TXT record using a securestring object for GandiToken. (Only works on Windows)
 
    .EXAMPLE
        Add-DnsTxtGandi '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'xxxxxxxx'
 
        Adds a TXT record using a standard string object for GandiTokenInsecure. (Use this on non-Windows)
    #>

}

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

    # un-secure the password so we can add it to the auth header
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $GandiTokenInsecure = (New-Object PSCredential "user",$GandiToken).GetNetworkCredential().Password
    }
    $restParams = @{
        Headers = @{
            'X-Api-Key' = $GandiTokenInsecure
            Accept = 'application/json'
        }
        ContentType = 'application/json'
    }

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

    # find the matching TXT record if it exists
    $recShort = $RecordName -ireplace [regex]::Escape(".$zoneName"), [string]::Empty
    $recUrl = "https://dns.api.gandi.net/api/v5/domains/$zoneName/records/$recShort/TXT"
    try {
        $rec = Invoke-RestMethod $recUrl @restParams @script:UseBasic
    } catch {}

    if ($rec -and "`"$TxtValue`"" -in $rec.rrset_values) {
        if ($rec.rrset_values.Count -gt 1) {
            # remove just the value we care about
            try {
                Write-Verbose "Removing $TxtValue from TXT record for $RecordName"
                $otherVals = $rec.rrset_values.Trim('"') | Where-Object { $_ -ne $TxtValue }
                $bodyJson = @{rrset_values=@($otherVals)} | ConvertTo-Json -Compress
                Invoke-RestMethod $recUrl -Method Put -Body $bodyJson `
                    @restParams @script:UseBasic -EA Stop | Out-Null
            } catch { throw }
        } else {
            # delete the whole record because this value is the last one
            try {
                Write-Verbose "Removing TXT record for $RecordName"
                Invoke-RestMethod $recUrl -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."
        Write-Debug ($rec.rrset_values -join "`r`n")
    }


    <#
    .SYNOPSIS
        Remove a DNS TXT record from Gandi.
 
    .DESCRIPTION
        Remove a DNS TXT record from Gandi.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER GandiToken
        The API token for your Gandi account. This SecureString version should only be used on Windows.
 
    .PARAMETER GandiTokenInsecure
        The API token for your Gandi 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
        $token = Read-Host "Gandi Token" -AsSecureString
        PS C:\>Remove-DnsTxtGandi '_acme-challenge.site1.example.com' 'asdfqwer12345678' $token
 
        Removes a TXT record using a securestring object for GandiToken. (Only works on Windows)
 
    .EXAMPLE
        Remove-DnsTxtGandi '_acme-challenge.site1.example.com' 'asdfqwer12345678' 'xxxxxxxx'
 
        Removes a TXT record using a standard string object for GandiTokenInsecure. (Use this on non-Windows)
    #>

}

function Save-DnsTxtGandi {
    [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://doc.livedns.gandi.net

function Find-GandiZone {
    [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:GandiRecordZones) { $script:GandiRecordZones = @{} }

    # check for the record in the cache
    if ($script:GandiRecordZones.ContainsKey($RecordName)) {
        return $script:GandiRecordZones.$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

    $pieces = $RecordName.Split('.')
    for ($i=1; $i -lt ($pieces.Count-1); $i++) {
        $zoneTest = "$( $pieces[$i..($pieces.Count-1)] -join '.' )"
        Write-Debug "Checking $zoneTest"
        try {
            Invoke-RestMethod "https://dns.api.gandi.net/api/v5/domains/$zoneTest" `
                @RestParams @script:UseBasic | Out-Null
            $script:GandiRecordZones.$RecordName = $zoneTest
            return $zoneTest
        } catch {}
    }

    return $null

}