Plugins/Hetzner.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
function Get-CurrentPluginType { 'dns-01' }

Function Add-DnsTxt {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position = 0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position = 1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=2)]
        [securestring]$HetznerToken,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=2)]
        [string]$HetznerTokenInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $apiRoot = 'https://dns.hetzner.com/api/v1'

    # un-secure the password so we can add it to the auth header
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $HetznerTokenInsecure = [pscredential]::new('a',$HetznerToken).GetNetworkCredential().Password
    }
    $restParams = @{
        Headers = @{
            'Auth-API-Token' = $HetznerTokenInsecure
            Accept = 'application/json'
        }
        ContentType = 'application/json'
    }

    # find matching ZoneID to check, if the records exists already
    if (-not ($zone = Find-HetznerZone $RecordName $restParams)) {
        throw "Unable to find matching zone for $RecordName"
    }

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

    # Get a list of existing TXT records for this record name
    try {
        Write-Verbose "Searching for existing TXT record"
        $recs = Invoke-RestMethod "$apiRoot/records?zone_id=$($zone.id)" `
            @restParams @Script:UseBasic -EA Stop
    } catch { throw }

    # check for a matching record
    $rec = $recs.records | Where-Object {
        $_.type -eq 'TXT' -and
        $_.name -eq $recShort -and
        $_.value -eq $TxtValue
    }

    if ($rec) {
        Write-Debug "Record $RecordName already contains $TxtValue. Nothing to do."
    } else {
        # create request body schema
        $body = @{
            name = $recShort
            ttl = 600
            type = 'TXT'
            value = $TxtValue
            zone_id = $zone.id
        }
        $json = $body | ConvertTo-Json

        try {
            Write-Verbose "Add Record $RecordName with value $TxtValue."

            Invoke-RestMethod "$apiRoot/records" -Method Post -Body $json `
                @restParams @Script:UseBasic -EA Stop | Out-Null
        } catch { throw }
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to Hetzner.
    .DESCRIPTION
        Uses the Hetzner DNS API to add or update a DNS TXT record.
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
    .PARAMETER TxtValue
        The value of the TXT record.
    .PARAMETER HetznerToken
        The API token for your Hetzner account.
    .PARAMETER HetznerTokenInsecure
        (DEPRECATED) The API token for your Hetzner account.
    .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 'Token' -AsSecureString
        Add-DnsTxt '_acme-challenge.example.com' 'txt-value' -HetznerToken $token

        Adds or updates the specified TXT record with the specified value.
    #>

}

Function Remove-DnsTxt {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position = 0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position = 1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=2)]
        [securestring]$HetznerToken,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=2)]
        [string]$HetznerTokenInsecure,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    $apiRoot = 'https://dns.hetzner.com/api/v1'

    # un-secure the password so we can add it to the auth header
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $HetznerTokenInsecure = [pscredential]::new('a',$HetznerToken).GetNetworkCredential().Password
    }
    $restParams = @{
        Headers = @{
            'Auth-API-Token' = $HetznerTokenInsecure
            Accept = 'application/json'
        }
        ContentType = 'application/json'
    }

    # find matching ZoneID to check, if the records exists already
    if (-not ($zone = Find-HetznerZone $RecordName $restParams)) {
        throw "Unable to find matching zone for $RecordName"
    }

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

    # Get a list of existing TXT records for this record name
    try {
        Write-Verbose "Searching for existing TXT record"
        $recs = Invoke-RestMethod "$apiRoot/records?zone_id=$($zone.id)" `
            @restParams @Script:UseBasic -EA Stop
    } catch { throw }

    # check for a matching record
    $rec = $recs.records | Where-Object {
        $_.type -eq 'TXT' -and
        $_.name -eq $recShort -and
        $_.value -eq $TxtValue
    }

    if ($rec) {
        try {
            Write-Verbose "Remove Record $RecordName ($($rec.Id)) with value $TxtValue."
            Invoke-RestMethod "$apiRoot/records/$($rec.Id)" -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."
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from Hetzner.
    .DESCRIPTION
        Uses the Hetzner DNS API to remove DNS TXT record.
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
    .PARAMETER TxtValue
        The value of the TXT record.
    .PARAMETER HetznerToken
        The API token for your Hetzner account.
    .PARAMETER HetznerTokenInsecure
        (DEPRECATED) The API token for your Hetzner account.
    .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 'Token' -AsSecureString
        Remove-DnsTxt '_acme-challenge.example.com' 'txt-value' -HetznerToken $token

        Removes the specified TXT record 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
############################

# API Docs: https://dns.hetzner.com/api-docs/

Function Find-HetznerZone {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory, Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory, Position=1)]
        [hashtable]$RestParameters
    )

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

    # check for the record in the cache
    if ($script:HetznerRecordZones.ContainsKey($RecordName)) {
        Write-Debug "Result from Cache $($script:HetznerRecordZones.$RecordName.Name)"
        return $script:HetznerRecordZones.$RecordName
    }

    # first, get all Zones, Zone to get is identified by 'ZoneID'.
    try {
        $response = Invoke-RestMethod -Uri "https://dns.hetzner.com/api/v1/zones" `
            @RestParameters @Script:UseBasic -EA Stop
    } catch { throw }

    # 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=0; $i -lt ($pieces.Count-1); $i++) {
        $zoneTest = $pieces[$i..($pieces.Count-1)] -join '.'
        Write-Debug "Checking $zoneTest"

        $zone = $response.zones | Select-Object id,name |
            Where-Object { $_.name -eq $zoneTest }

        if ($zone) {
            Write-Debug "Zone $zoneTest found."
            $script:HetznerRecordZones.$RecordName = $zone
            return $zone
        } else {
            Write-Debug "Zone $zoneTest does not exist ..."
        }
    }

    return $null
}