Plugins/ISPConfig.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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
function Get-CurrentPluginType { 'dns-01' }

function Add-DnsTxt {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory)]
        [pscredential]$ISPConfigCredential,
        [Parameter(Mandatory)]
        [string]$ISPConfigEndpoint,
        [switch]$ISPConfigIgnoreCert,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $restSplat = @{
        Credential = $ISPConfigCredential
        Endpoint = $ISPConfigEndpoint
    }

    try {
        # ignore cert validation for the duration of the call
        if ($ISPConfigIgnoreCert) { Set-ISPConfigCertIgnoreOn }

        # find the zone/server details
        $zoneID,$zoneName,$serverID = Find-ISPConfigZone $RecordName @restSplat
        if ($zoneID) {
            Write-Debug "id: $zoneID, name: $zoneName, server ID: $serverID"
        } else {
            throw "Zone not found for record $RecordName"
        }

        # separate the portion of the name that doesn't contain the zone name
        $recShort = ("$RecordName." -ireplace [regex]::Escape($zoneName), [string]::Empty).TrimEnd('.')
        if ($recShort -eq '') { $recShort = "$RecordName." }

        # check for an existing record
        $rec = Get-ISPConfigZoneTxtRecord $recShort $TxtValue $zoneID @restSplat

        if ($rec) {
            Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
        } else {
            try {
                $queryParams = @{
                    Function = 'dns_txt_add'
                    BodyParams = @{
                        client_id = $null
                        update_serial = $true
                        params = @{
                            server_id = $serverID
                            zone = $zoneID
                            name = $recShort
                            type = 'TXT'
                            data = $TxtValue
                            active = 'Y'
                            ttl = 60
                        }

                    }
                }
                Write-Verbose "Adding record '$recShort' with value '$TxtValue'"
                Invoke-ISPConfigRest @queryParams @restSplat | Out-Null
            }
            catch { throw }
        }

    } finally {
        # return cert validation back to normal
        if ($ISPConfigIgnoreCert) { Set-ISPConfigCertIgnoreOff }
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to ISPConfig
 
    .DESCRIPTION
        Add a DNS TXT record to ISPConfig
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER ISPConfigCredential
        Username and password the has access to create the necessary TXT records in ISPConfig.
 
    .PARAMETER ISPConfigEndpoint
        URL for the ISPConfig instance's remote API (e.g. https://example.com/remote/json.php)
 
    .PARAMETER ISPConfigIgnoreCert
        Use this switch to prevent certificate errors when your ISPConfig server is using a self-signed or other untrusted SSL certificate.
 
    .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-DnsTxt '_acme-challenge.example.com' 'txt-value' -ISPConfigCredential (Get-Credential) -ISPConfigEndpoint https://example.com/remote/json.php
 
        Adds a TXT record for the specified site with the specified value.
    #>

}

function Remove-DnsTxt {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory)]
        [pscredential]$ISPConfigCredential,
        [Parameter(Mandatory)]
        [string]$ISPConfigEndpoint,
        [switch]$ISPConfigIgnoreCert,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $restSplat = @{
        Credential = $ISPConfigCredential
        Endpoint = $ISPConfigEndpoint
    }

    try {
        # ignore cert validation for the duration of the call
        if ($ISPConfigIgnoreCert) { Set-ISPConfigCertIgnoreOn }

        # find the zone/server details
        $zoneID,$zoneName,$serverID = Find-ISPConfigZone $RecordName @restSplat
        if ($zoneID) {
            Write-Debug "id: $zoneID, name: $zoneName, server ID: $serverID"
        } else {
            throw "Zone not found for record $RecordName"
        }

        # separate the portion of the name that doesn't contain the zone name
        $recShort = ("$RecordName." -ireplace [regex]::Escape($zoneName), [string]::Empty).TrimEnd('.')
        if ($recShort -eq '') { $recShort = "$RecordName." }

        # check for an existing record
        $rec = Get-ISPConfigZoneTxtRecord $recShort $TxtValue $zoneID @restSplat

        if ($rec) {
            try {
                $queryParams = @{
                    Function = 'dns_txt_delete'
                    BodyParams = @{
                        primary_id = $rec.id
                        update_serial = $true
                    }
                }
                Write-Verbose "Deleting record id $($rec.id), '$($rec.name)' with value '$($rec.data)'"
                Invoke-ISPConfigRest @queryParams @restSplat | Out-Null
            }
            catch { throw }
        } else {
            Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
        }

    } finally {
        # return cert validation back to normal
        if ($ISPConfigIgnoreCert) { Set-ISPConfigCertIgnoreOff }
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from ISPConfig.
 
    .DESCRIPTION
        Remove a DNS TXT record from ISPConfig.
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER ISPConfigCredential
        Username and password the has access to create the necessary TXT records in ISPConfig.
 
    .PARAMETER ISPConfigEndpoint
        URL for the ISPConfig instance's remote API (e.g. https://example.com/remote/json.php)
 
    .PARAMETER ISPConfigIgnoreCert
        Use this switch to prevent certificate errors when your ISPConfig server is using a self-signed or other untrusted SSL certificate.
 
    .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-DnsTxt '_acme-challenge.example.com' 'txt-value' -ISPConfigCredential (Get-Credential) -ISPConfigEndpoint https://example.com/remote/json.php
 
        Removes a TXT record for 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
############################

# https://git.ispconfig.org/ispconfig/ispconfig3/-/tree/develop/remoting_client/API-docs
# https://github.com/m42e/certbot-dns-ispconfig/blob/master/certbot_dns_ispconfig/dns_ispconfig.py

function Invoke-ISPConfigRest {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [pscredential]$Credential,
        [Parameter(Mandatory,Position=1)]
        [string]$Endpoint,
        [Parameter(Mandatory)]
        [string]$Function,
        [hashtable]$BodyParams
    )

    if ($Function -eq 'login') {
        # build login params
        $uri = "{0}?login" -f $Endpoint
        $pass = $ISPConfigCredential.GetNetworkCredential().Password
        $body = @{
            username = $ISPConfigCredential.UserName
            password = $pass
        } | ConvertTo-Json
        $bodySanitized = $body.Replace($pass,'XXXXXXXX')
    }
    else {
        if (-not $script:ISPConfigSessionID) {
            # recurse and login first
            try {
                Write-Debug "recursing to login"
                $script:ISPConfigSessionID = Invoke-ISPConfigRest $Credential $Endpoint -Function 'login'
            } catch { Write-Debug "login recurse failed"; throw }
            if (-not $script:ISPConfigSessionID) {
                throw "no session ID found after logging in"
            }
        }

        # build function params with the session ID
        $uri = "{0}?{1}" -f $Endpoint,$Function
        $BodyParams.session_id = $script:ISPConfigSessionID
        $body = $BodyParams | ConvertTo-Json -Depth 5
        $bodySanitized = $body
    }

    # build rest splat
    $restParams = @{
        Uri = $uri
        Method = 'POST'
        Body = $body
        Verbose = $false
    }
    try {
        Write-Debug "POST $uri`n$bodySanitized"
        $response = Invoke-RestMethod @restParams @script:UseBasic
    } catch { throw }

    if ($response.code -eq 'ok') {
        return $response.response
    }
    elseif ($response.code -eq 'remote_fault') {
        # re-try if session expired "The Session is expired or does not exist."
        if ($response.message -like '*expired*') {
            Write-Debug "session expired, retrying with fresh login"
            $script:ISPConfigSessionID = $null
            try {
                return Invoke-ISPConfigRest @PSBoundParameters
            } catch { throw }
        } else {
            throw "ISPConfig Error: $($response.message)"
        }
    }
    else {
        throw "Unexpected error with ISPConfig:`n$($response | ConvertTo-Json)"
    }
}

function Find-ISPConfigZone {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [pscredential]$Credential,
        [Parameter(Mandatory,Position=2)]
        [string]$Endpoint
    )

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

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

    # Find the closest/deepest sub-zone that would hold 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"

        try {
            $queryParams = @{
                Function = 'dns_zone_get'
                BodyParams = @{
                    primary_id = @{
                        origin = "$zoneTest."
                    }
                }
                Credential = $Credential
                Endpoint = $Endpoint
            }

            $response = Invoke-ISPConfigRest @queryParams
        } catch { throw }

        if ($response) {
            $script:ISPConfigRecordZones.$RecordName = $response.id,$response.origin,$response.server_id
            return $response.id,$response.origin,$response.server_id
        }
    }

    return $null
}

function Get-ISPConfigZoneTxtRecord {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordShort,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(Mandatory,Position=2)]
        [string]$ZoneID,
        [Parameter(Mandatory,Position=3)]
        [pscredential]$Credential,
        [Parameter(Mandatory,Position=4)]
        [string]$Endpoint
    )

    try {
        $queryParams = @{
            Function = 'dns_rr_get_all_by_zone'
            BodyParams = @{
                zone_id = $ZoneID
            }
            Credential = $Credential
            Endpoint = $Endpoint
        }

        Invoke-ISPConfigRest @queryParams | Where-Object {
            $_.name -eq $RecordShort -and
            $_.type -eq 'TXT' -and
            $_.data -eq $TxtValue
        } | Select-Object id,name,type,'data'
    }
    catch { throw }
}

function Set-ISPConfigCertIgnoreOn {
    [CmdletBinding()]
    param()

    if ($script:SkipCertSupported) {
        # Core edition
        if (-not $script:UseBasic.SkipCertificateCheck) {
            # temporarily set skip to true
            $script:UseBasic.SkipCertificateCheck = $true
            # remember that we did
            $script:ISPConfigUnsetIgnoreAfter = $true
        }

    } else {
        # Desktop edition
        [CertValidation]::Ignore()
    }
}

function Set-ISPConfigCertIgnoreOff {
    [CmdletBinding()]
    param()

    if ($script:SkipCertSupported) {
        # Core edition
        if ($script:ISPConfigUnsetIgnoreAfter) {
            $script:UseBasic.SkipCertificateCheck = $false
            Remove-Variable ISPConfigUnsetIgnoreAfter -Scope Script
        }

    } else {
        # Desktop edition
        [CertValidation]::Restore()
    }
}