/
akamai.go
281 lines (217 loc) · 7.77 KB
/
akamai.go
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
/*
Copyright 2020 The cert-manager Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Package akamai implements a DNS provider for solving the DNS-01
// challenge using Akamai Edge DNS.
// See https://developer.akamai.com/api/cloud_security/edge_dns_zone_management/v2.html
package akamai
import (
"fmt"
"strings"
dns "github.com/akamai/AkamaiOPEN-edgegrid-golang/configdns-v2"
"github.com/akamai/AkamaiOPEN-edgegrid-golang/edgegrid"
"github.com/go-logr/logr"
"github.com/pkg/errors"
"github.com/jetstack/cert-manager/pkg/issuer/acme/dns/util"
logf "github.com/jetstack/cert-manager/pkg/logs"
)
// Interface defined to enable mocking and required functions
type OpenEdgegridDNSService interface {
GetRecord(zone string, name string, record_type string) (*dns.RecordBody, error)
RecordSave(rec *dns.RecordBody, zone string) error
RecordUpdate(rec *dns.RecordBody, zone string) error
RecordDelete(rec *dns.RecordBody, zone string) error
}
type OpenDNSConfig struct {
config edgegrid.Config
}
// DNSProvider is an implementation of the acme.ChallengeProvider interface
type DNSProvider struct {
dns01Nameservers []string
serviceConsumerDomain string
dnsclient OpenEdgegridDNSService
TTL int
findHostedDomainByFqdn func(string, []string) (string, error)
isNotFound func(error) bool
log logr.Logger
}
// NewDNSProvider returns a DNSProvider instance configured for Akamai.
func NewDNSProvider(serviceConsumerDomain, clientToken, clientSecret, accessToken string, dns01Nameservers []string) (*DNSProvider, error) {
// required Aka OpenEdgegrid creds + non empty dnsservers list
if serviceConsumerDomain == "" || clientToken == "" || clientSecret == "" || accessToken == "" || len(dns01Nameservers) < 1 {
return nil, fmt.Errorf("edgedns: Provider creation failed. Missing required arguments.")
}
dnsp := &DNSProvider{
dns01Nameservers: dns01Nameservers,
serviceConsumerDomain: serviceConsumerDomain,
dnsclient: &OpenDNSConfig{},
findHostedDomainByFqdn: findHostedDomainByFqdn,
isNotFound: isNotFound,
log: logf.Log.WithName("akamai-dns"),
TTL: 300,
}
dnsp.dnsclient.(*OpenDNSConfig).config = edgegrid.Config{
Host: serviceConsumerDomain,
ClientToken: clientToken,
ClientSecret: clientSecret,
AccessToken: accessToken,
MaxBody: 131072,
}
dns.Init(dnsp.dnsclient.(*OpenDNSConfig).config)
return dnsp, nil
}
func findHostedDomainByFqdn(fqdn string, ns []string) (string, error) {
zone, err := util.FindZoneByFqdn(fqdn, ns)
if err != nil {
return "", err
}
return util.UnFqdn(zone), nil
}
// Present creates/updates a TXT record to fulfill the dns-01 challenge.
func (a *DNSProvider) Present(domain, fqdn, value string) error {
logf.V(logf.DebugLevel).Infof("entering Present. domain: %s, fqdn: %s, value: %s", domain, fqdn, value)
hostedDomain, err := a.findHostedDomainByFqdn(fqdn, a.dns01Nameservers)
if err != nil {
return errors.Wrapf(err, "edgedns: failed to determine hosted domain for %q", fqdn)
}
hostedDomain = util.UnFqdn(hostedDomain)
logf.V(logf.DebugLevel).Infof("hostedDomain: %s", hostedDomain)
recordName, err := makeTxtRecordName(fqdn, hostedDomain)
if err != nil {
return errors.Wrapf(err, "edgedns: failed to create TXT record name")
}
logf.V(logf.DebugLevel).Infof("recordName: %s", recordName)
record, err := a.dnsclient.GetRecord(hostedDomain, recordName, "TXT")
if err != nil && !a.isNotFound(err) {
return errors.Wrapf(err, "edgedns: failed to retrieve TXT record")
}
if err == nil && record == nil {
return fmt.Errorf("edgedns: unknown error")
}
if record != nil {
logf.V(logf.InfoLevel).Infof("edgedns: TXT record already exists. Updating target")
if containsValue(record.Target, value) {
// have a record and have entry already
return nil
}
record.Target = append(record.Target, `"`+value+`"`)
record.TTL = a.TTL
err = a.dnsclient.RecordUpdate(record, hostedDomain)
if err != nil {
return errors.Wrapf(err, "edgedns: failed to update TXT record")
}
return nil
}
record = &dns.RecordBody{
Name: recordName,
RecordType: "TXT",
TTL: a.TTL,
Target: []string{`"` + value + `"`},
}
err = a.dnsclient.RecordSave(record, hostedDomain)
if err != nil {
return errors.Wrapf(err, "edgedns: failed to create TXT record")
}
return nil
}
// CleanUp removes/updates the TXT record matching the specified parameters.
func (a *DNSProvider) CleanUp(domain, fqdn, value string) error {
logf.V(logf.DebugLevel).Infof("entering CleanUp. domain: %s, fqdn: %s, value: %s", domain, fqdn, value)
hostedDomain, err := a.findHostedDomainByFqdn(fqdn, a.dns01Nameservers)
if err != nil {
return errors.Wrapf(err, "edgedns: failed to determine hosted domain for %q", fqdn)
}
hostedDomain = util.UnFqdn(hostedDomain)
logf.V(logf.DebugLevel).Infof("hostedDomain: %s", hostedDomain)
recordName, err := makeTxtRecordName(fqdn, hostedDomain)
if err != nil {
return errors.Wrapf(err, "edgedns: failed to create TXT record name")
}
logf.V(logf.DebugLevel).Infof("recordName: %s", recordName)
existingRec, err := a.dnsclient.GetRecord(hostedDomain, recordName, "TXT")
if err != nil {
if a.isNotFound(err) {
return nil
}
return errors.Wrapf(err, "edgedns: failed to retrieve TXT record")
}
if existingRec == nil {
return fmt.Errorf("edgedns: unknown failure")
}
if len(existingRec.Target) == 0 {
return fmt.Errorf("edgedns: TXT record is invalid")
}
if !containsValue(existingRec.Target, value) {
return nil
}
var newRData []string
for _, val := range existingRec.Target {
tval := strings.Trim(val, `"`)
if tval == value {
continue
}
newRData = append(newRData, val)
}
if len(newRData) > 0 {
existingRec.Target = newRData
logf.V(logf.DebugLevel).Infof("updating Akamai TXT record: %s, data: %s", existingRec.Name, newRData)
err = a.dnsclient.RecordUpdate(existingRec, hostedDomain)
if err != nil {
return errors.Wrapf(err, "edgedns: TXT record update failed")
}
return nil
}
logf.V(logf.DebugLevel).Infof("deleting Akamai TXT record %s", existingRec.Name)
err = a.dnsclient.RecordDelete(existingRec, hostedDomain)
if err != nil {
return errors.Wrapf(err, "edgedns: TXT record delete failed")
}
return nil
}
func containsValue(values []string, value string) bool {
for _, val := range values {
if strings.Trim(val, `"`) == value {
return true
}
}
return false
}
func isNotFound(err error) bool {
if err == nil {
return false
}
_, ok := err.(*dns.RecordError)
if ok {
return true
}
return false
}
func makeTxtRecordName(fqdn, hostedDomain string) (string, error) {
recName := util.UnFqdn(fqdn)
if !strings.HasSuffix(recName, hostedDomain) {
return "", errors.Errorf("fqdn %q is not part of %q", fqdn, hostedDomain)
}
return recName, nil
}
func (o OpenDNSConfig) GetRecord(zone string, name string, record_type string) (*dns.RecordBody, error) {
dns.Config = o.config
return dns.GetRecord(zone, name, record_type)
}
func (o OpenDNSConfig) RecordSave(rec *dns.RecordBody, zone string) error {
return rec.Save(zone)
}
func (o OpenDNSConfig) RecordUpdate(rec *dns.RecordBody, zone string) error {
return rec.Update(zone)
}
func (o OpenDNSConfig) RecordDelete(rec *dns.RecordBody, zone string) error {
return rec.Delete(zone)
}