-
Notifications
You must be signed in to change notification settings - Fork 2k
/
dns.go
499 lines (429 loc) · 18.4 KB
/
dns.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
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/*
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 dns
import (
"context"
"encoding/json"
"fmt"
"strings"
"time"
"github.com/pkg/errors"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
corev1listers "k8s.io/client-go/listers/core/v1"
"github.com/cert-manager/cert-manager/pkg/acme/webhook"
whapi "github.com/cert-manager/cert-manager/pkg/acme/webhook/apis/acme/v1alpha1"
cmacme "github.com/cert-manager/cert-manager/pkg/apis/acme/v1"
v1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1"
"github.com/cert-manager/cert-manager/pkg/controller"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/acmedns"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/akamai"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/azuredns"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/clouddns"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/cloudflare"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/digitalocean"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/rfc2136"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/route53"
"github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/util"
webhookslv "github.com/cert-manager/cert-manager/pkg/issuer/acme/dns/webhook"
logf "github.com/cert-manager/cert-manager/pkg/logs"
)
// solver is the old solver type interface.
// All new solvers should be implemented using the new webhook.Solver interface.
type solver interface {
Present(domain, fqdn, value string) error
CleanUp(domain, fqdn, value string) error
}
// dnsProviderConstructors defines how each provider may be constructed.
// It is useful for mocking out a given provider since an alternate set of
// constructors may be set.
type dnsProviderConstructors struct {
cloudDNS func(project string, serviceAccount []byte, dns01Nameservers []string, ambient bool, hostedZoneName string) (*clouddns.DNSProvider, error)
cloudFlare func(email, apikey, apiToken string, dns01Nameservers []string, userAgent string) (*cloudflare.DNSProvider, error)
route53 func(accessKey, secretKey, hostedZoneID, region, role string, ambient bool, dns01Nameservers []string, userAgent string) (*route53.DNSProvider, error)
azureDNS func(environment, clientID, clientSecret, subscriptionID, tenantID, resourceGroupName, hostedZoneName string, dns01Nameservers []string, ambient bool, managedIdentity *cmacme.AzureManagedIdentity) (*azuredns.DNSProvider, error)
acmeDNS func(host string, accountJson []byte, dns01Nameservers []string) (*acmedns.DNSProvider, error)
digitalOcean func(token string, dns01Nameservers []string) (*digitalocean.DNSProvider, error)
}
// Solver is a solver for the acme dns01 challenge.
// Given a Certificate object, it determines the correct DNS provider based on
// the certificate, and configures it based on the referenced issuer.
type Solver struct {
*controller.Context
secretLister corev1listers.SecretLister
dnsProviderConstructors dnsProviderConstructors
webhookSolvers map[string]webhook.Solver
}
// Present performs the work to configure DNS to resolve a DNS01 challenge.
func (s *Solver) Present(ctx context.Context, issuer v1.GenericIssuer, ch *cmacme.Challenge) error {
log := logf.WithResource(logf.FromContext(ctx, "Present"), ch).WithValues("domain", ch.Spec.DNSName)
ctx = logf.NewContext(ctx, log)
webhookSolver, req, err := s.prepareChallengeRequest(issuer, ch)
if err != nil && err != errNotFound {
return err
}
if err == nil {
log.V(logf.InfoLevel).Info("presenting DNS01 challenge for domain")
return webhookSolver.Present(req)
}
slv, providerConfig, err := s.solverForChallenge(ctx, issuer, ch)
if err != nil {
return err
}
fqdn, err := util.DNS01LookupFQDN(ch.Spec.DNSName, followCNAME(providerConfig.CNAMEStrategy), s.DNS01Nameservers...)
if err != nil {
return err
}
log.V(logf.DebugLevel).Info("presenting DNS01 challenge for domain")
return slv.Present(ch.Spec.DNSName, fqdn, ch.Spec.Key)
}
// Check verifies that the DNS records for the ACME challenge have propagated.
func (s *Solver) Check(ctx context.Context, issuer v1.GenericIssuer, ch *cmacme.Challenge) error {
log := logf.WithResource(logf.FromContext(ctx, "Check"), ch).WithValues("domain", ch.Spec.DNSName)
fqdn, err := util.DNS01LookupFQDN(ch.Spec.DNSName, false, s.DNS01Nameservers...)
if err != nil {
return err
}
log.V(logf.DebugLevel).Info("checking DNS propagation", "nameservers", s.Context.DNS01Nameservers)
ok, err := util.PreCheckDNS(fqdn, ch.Spec.Key, s.Context.DNS01Nameservers,
s.Context.DNS01CheckAuthoritative, s.Context.ACMEDNS01CheckMethod)
if err != nil {
return err
}
if !ok {
return fmt.Errorf("DNS record for %q not yet propagated", ch.Spec.DNSName)
}
ttl := 60
log.V(logf.DebugLevel).Info("waiting DNS record TTL to allow the DNS01 record to propagate for domain", "ttl", ttl, "fqdn", fqdn)
time.Sleep(time.Second * time.Duration(ttl))
log.V(logf.DebugLevel).Info("ACME DNS01 validation record propagated", "fqdn", fqdn)
return nil
}
// CleanUp removes DNS records which are no longer needed after
// certificate issuance.
func (s *Solver) CleanUp(ctx context.Context, issuer v1.GenericIssuer, ch *cmacme.Challenge) error {
log := logf.WithResource(logf.FromContext(ctx, "CleanUp"), ch).WithValues("domain", ch.Spec.DNSName)
ctx = logf.NewContext(ctx, log)
webhookSolver, req, err := s.prepareChallengeRequest(issuer, ch)
if err != nil && err != errNotFound {
return err
}
if err == nil {
log.V(logf.DebugLevel).Info("cleaning up DNS01 challenge")
return webhookSolver.CleanUp(req)
}
slv, providerConfig, err := s.solverForChallenge(ctx, issuer, ch)
if err != nil {
return err
}
fqdn, err := util.DNS01LookupFQDN(ch.Spec.DNSName, followCNAME(providerConfig.CNAMEStrategy), s.DNS01Nameservers...)
if err != nil {
return err
}
return slv.CleanUp(ch.Spec.DNSName, fqdn, ch.Spec.Key)
}
func followCNAME(strategy cmacme.CNAMEStrategy) bool {
return strategy == cmacme.FollowStrategy
}
func extractChallengeSolverConfig(ch *cmacme.Challenge) (*cmacme.ACMEChallengeSolverDNS01, error) {
if ch.Spec.Solver.DNS01 == nil {
return nil, fmt.Errorf("no dns01 challenge solver configuration found")
}
return ch.Spec.Solver.DNS01, nil
}
// solverForChallenge returns a Solver for the given providerName.
// The providerName is the name of an ACME DNS-01 challenge provider as
// specified on the Issuer resource for the Solver.
func (s *Solver) solverForChallenge(ctx context.Context, issuer v1.GenericIssuer, ch *cmacme.Challenge) (solver, *cmacme.ACMEChallengeSolverDNS01, error) {
log := logf.FromContext(ctx, "solverForChallenge")
dbg := log.V(logf.DebugLevel)
resourceNamespace := s.ResourceNamespace(issuer)
canUseAmbientCredentials := s.CanUseAmbientCredentials(issuer)
providerConfig, err := extractChallengeSolverConfig(ch)
if err != nil {
return nil, nil, err
}
var impl solver
switch {
case providerConfig.Akamai != nil:
dbg.Info("preparing to create Akamai provider")
clientToken, err := s.loadSecretData(&providerConfig.Akamai.ClientToken, resourceNamespace)
if err != nil {
return nil, nil, errors.Wrap(err, "error getting akamai client token")
}
clientSecret, err := s.loadSecretData(&providerConfig.Akamai.ClientSecret, resourceNamespace)
if err != nil {
return nil, nil, errors.Wrap(err, "error getting akamai client secret")
}
accessToken, err := s.loadSecretData(&providerConfig.Akamai.AccessToken, resourceNamespace)
if err != nil {
return nil, nil, errors.Wrap(err, "error getting akamai access token")
}
impl, err = akamai.NewDNSProvider(
providerConfig.Akamai.ServiceConsumerDomain,
string(clientToken),
string(clientSecret),
string(accessToken),
s.DNS01Nameservers)
if err != nil {
return nil, nil, errors.Wrap(err, "error instantiating akamai challenge solver")
}
case providerConfig.CloudDNS != nil:
dbg.Info("preparing to create CloudDNS provider")
var keyData []byte
// if the serviceAccount field isn't nil we will load credentials from
// that secret. If it is nil we will attempt to instantiate the
// provider using ambient credentials (if enabled).
if providerConfig.CloudDNS.ServiceAccount != nil {
saSecret, err := s.secretLister.Secrets(resourceNamespace).Get(providerConfig.CloudDNS.ServiceAccount.Name)
if err != nil {
return nil, nil, fmt.Errorf("error getting clouddns service account: %s", err)
}
saKey := providerConfig.CloudDNS.ServiceAccount.Key
keyData = saSecret.Data[saKey]
if len(keyData) == 0 {
return nil, nil, fmt.Errorf("specified key %q not found in secret %s/%s", saKey, saSecret.Namespace, saSecret.Name)
}
}
// attempt to construct the cloud dns provider
impl, err = s.dnsProviderConstructors.cloudDNS(providerConfig.CloudDNS.Project, keyData, s.DNS01Nameservers, s.CanUseAmbientCredentials(issuer), providerConfig.CloudDNS.HostedZoneName)
if err != nil {
return nil, nil, fmt.Errorf("error instantiating google clouddns challenge solver: %s", err)
}
case providerConfig.Cloudflare != nil:
dbg.Info("preparing to create Cloudflare provider")
if providerConfig.Cloudflare.APIKey != nil && providerConfig.Cloudflare.APIToken != nil {
return nil, nil, fmt.Errorf("API key and API token secret references are both present")
}
var saSecretName, saSecretKey string
if providerConfig.Cloudflare.APIKey != nil {
saSecretName = providerConfig.Cloudflare.APIKey.Name
saSecretKey = providerConfig.Cloudflare.APIKey.Key
} else {
saSecretName = providerConfig.Cloudflare.APIToken.Name
saSecretKey = providerConfig.Cloudflare.APIToken.Key
}
saSecret, err := s.secretLister.Secrets(resourceNamespace).Get(saSecretName)
if err != nil {
return nil, nil, fmt.Errorf("error getting cloudflare secret: %s", err)
}
keyData, ok := saSecret.Data[saSecretKey]
if !ok {
return nil, nil, fmt.Errorf("specified key %q not found in secret %s/%s", saSecretKey, saSecret.Namespace, saSecret.Name)
}
var apiKey, apiToken string
if providerConfig.Cloudflare.APIKey != nil {
apiKey = string(keyData)
} else {
apiToken = string(keyData)
}
email := providerConfig.Cloudflare.Email
impl, err = s.dnsProviderConstructors.cloudFlare(email, apiKey, apiToken, s.DNS01Nameservers, s.RESTConfig.UserAgent)
if err != nil {
return nil, nil, fmt.Errorf("error instantiating cloudflare challenge solver: %s", err)
}
case providerConfig.DigitalOcean != nil:
dbg.Info("preparing to create DigitalOcean provider")
apiTokenSecret, err := s.secretLister.Secrets(resourceNamespace).Get(providerConfig.DigitalOcean.Token.Name)
if err != nil {
return nil, nil, fmt.Errorf("error getting digitalocean token: %s", err)
}
apiToken := string(apiTokenSecret.Data[providerConfig.DigitalOcean.Token.Key])
impl, err = s.dnsProviderConstructors.digitalOcean(strings.TrimSpace(apiToken), s.DNS01Nameservers)
if err != nil {
return nil, nil, fmt.Errorf("error instantiating digitalocean challenge solver: %s", err.Error())
}
case providerConfig.Route53 != nil:
dbg.Info("preparing to create Route53 provider")
secretAccessKey := ""
if providerConfig.Route53.SecretAccessKey.Name != "" {
secretAccessKeySecret, err := s.secretLister.Secrets(resourceNamespace).Get(providerConfig.Route53.SecretAccessKey.Name)
if err != nil {
return nil, nil, fmt.Errorf("error getting route53 secret access key: %s", err)
}
secretAccessKeyBytes, ok := secretAccessKeySecret.Data[providerConfig.Route53.SecretAccessKey.Key]
if !ok {
return nil, nil, fmt.Errorf("error getting route53 secret access key: key '%s' not found in secret", providerConfig.Route53.SecretAccessKey.Key)
}
secretAccessKey = string(secretAccessKeyBytes)
}
impl, err = s.dnsProviderConstructors.route53(
strings.TrimSpace(providerConfig.Route53.AccessKeyID),
strings.TrimSpace(secretAccessKey),
providerConfig.Route53.HostedZoneID,
providerConfig.Route53.Region,
providerConfig.Route53.Role,
canUseAmbientCredentials,
s.DNS01Nameservers,
s.RESTConfig.UserAgent,
)
if err != nil {
return nil, nil, fmt.Errorf("error instantiating route53 challenge solver: %s", err)
}
case providerConfig.AzureDNS != nil:
dbg.Info("preparing to create AzureDNS provider")
secret := ""
// if ClientID is empty, then we try to use MSI (azure metadata API for credentials)
// if ClientID is empty we don't even try to get the ClientSecret because it would not be used
if providerConfig.AzureDNS.ClientID != "" {
clientSecret, err := s.secretLister.Secrets(resourceNamespace).Get(providerConfig.AzureDNS.ClientSecret.Name)
if err != nil {
return nil, nil, fmt.Errorf("error getting azuredns client secret: %s", err)
}
clientSecretBytes, ok := clientSecret.Data[providerConfig.AzureDNS.ClientSecret.Key]
if !ok {
return nil, nil, fmt.Errorf("error getting azure dns client secret: key '%s' not found in secret", providerConfig.AzureDNS.ClientSecret.Key)
}
secret = string(clientSecretBytes)
}
impl, err = s.dnsProviderConstructors.azureDNS(
string(providerConfig.AzureDNS.Environment),
providerConfig.AzureDNS.ClientID,
secret,
providerConfig.AzureDNS.SubscriptionID,
providerConfig.AzureDNS.TenantID,
providerConfig.AzureDNS.ResourceGroupName,
providerConfig.AzureDNS.HostedZoneName,
s.DNS01Nameservers,
canUseAmbientCredentials,
providerConfig.AzureDNS.ManagedIdentity,
)
if err != nil {
return nil, nil, fmt.Errorf("error instantiating azuredns challenge solver: %s", err)
}
case providerConfig.AcmeDNS != nil:
dbg.Info("preparing to create ACMEDNS provider")
accountSecret, err := s.secretLister.Secrets(resourceNamespace).Get(providerConfig.AcmeDNS.AccountSecret.Name)
if err != nil {
return nil, nil, fmt.Errorf("error getting acmedns accounts secret: %s", err)
}
accountSecretBytes, ok := accountSecret.Data[providerConfig.AcmeDNS.AccountSecret.Key]
if !ok {
return nil, nil, fmt.Errorf("error getting acmedns accounts secret: key '%s' not found in secret", providerConfig.AcmeDNS.AccountSecret.Key)
}
impl, err = s.dnsProviderConstructors.acmeDNS(
providerConfig.AcmeDNS.Host,
accountSecretBytes,
s.DNS01Nameservers,
)
if err != nil {
return nil, providerConfig, fmt.Errorf("error instantiating acmedns challenge solver: %s", err)
}
default:
return nil, providerConfig, fmt.Errorf("no dns provider config specified for challenge")
}
return impl, providerConfig, nil
}
func (s *Solver) prepareChallengeRequest(issuer v1.GenericIssuer, ch *cmacme.Challenge) (webhook.Solver, *whapi.ChallengeRequest, error) {
dns01Config, err := extractChallengeSolverConfig(ch)
if err != nil {
return nil, nil, err
}
webhookSolver, cfg, err := s.dns01SolverForConfig(dns01Config)
if err != nil {
return nil, nil, err
}
fqdn, err := util.DNS01LookupFQDN(ch.Spec.DNSName, followCNAME(dns01Config.CNAMEStrategy), s.DNS01Nameservers...)
if err != nil {
return nil, nil, err
}
zone, err := util.FindZoneByFqdn(fqdn, s.DNS01Nameservers)
if err != nil {
return nil, nil, err
}
resourceNamespace := s.ResourceNamespace(issuer)
canUseAmbientCredentials := s.CanUseAmbientCredentials(issuer)
// construct a ChallengeRequest which can be passed to DNS solvers.
// The provided config will be encoded to JSON in order to avoid a coupling
// between cert-manager and any particular DNS provider implementation.
b, err := json.Marshal(cfg)
if err != nil {
return nil, nil, err
}
req := &whapi.ChallengeRequest{
Type: "dns-01",
ResolvedFQDN: fqdn,
ResolvedZone: zone,
AllowAmbientCredentials: canUseAmbientCredentials,
ResourceNamespace: resourceNamespace,
Key: ch.Spec.Key,
DNSName: ch.Spec.DNSName,
Config: &apiextensionsv1.JSON{Raw: b},
}
return webhookSolver, req, nil
}
var errNotFound = fmt.Errorf("failed to determine DNS01 solver type")
func (s *Solver) dns01SolverForConfig(config *cmacme.ACMEChallengeSolverDNS01) (webhook.Solver, interface{}, error) {
solverName := ""
var c interface{}
switch {
case config.Webhook != nil:
solverName = "webhook"
c = config.Webhook
case config.RFC2136 != nil:
solverName = "rfc2136"
c = config.RFC2136
}
if solverName == "" {
return nil, nil, errNotFound
}
p := s.webhookSolvers[solverName]
if p == nil {
return nil, c, fmt.Errorf("no solver provider configured for %q", solverName)
}
return p, c, nil
}
// NewSolver creates a Solver which can instantiate the appropriate DNS
// provider.
func NewSolver(ctx *controller.Context) (*Solver, error) {
webhookSolvers := []webhook.Solver{
&webhookslv.Webhook{},
rfc2136.New(rfc2136.WithNamespace(ctx.Namespace)),
}
initialized := make(map[string]webhook.Solver)
// the RESTConfig may be nil if we are running in a unit test environment,
// so don't initialize the webhook based solvers in this case.
if ctx.RESTConfig != nil {
// initialize all DNS providers
for _, s := range webhookSolvers {
err := s.Initialize(ctx.RESTConfig, ctx.StopCh)
if err != nil {
return nil, fmt.Errorf("error initializing DNS provider %q: %v", s.Name(), err)
}
initialized[s.Name()] = s
}
}
return &Solver{
Context: ctx,
secretLister: ctx.KubeSharedInformerFactory.Core().V1().Secrets().Lister(),
dnsProviderConstructors: dnsProviderConstructors{
clouddns.NewDNSProvider,
cloudflare.NewDNSProviderCredentials,
route53.NewDNSProvider,
azuredns.NewDNSProviderCredentials,
acmedns.NewDNSProviderHostBytes,
digitalocean.NewDNSProviderCredentials,
},
webhookSolvers: initialized,
}, nil
}
func (s *Solver) loadSecretData(selector *cmmeta.SecretKeySelector, ns string) ([]byte, error) {
secret, err := s.secretLister.Secrets(ns).Get(selector.Name)
if err != nil {
return nil, errors.Wrapf(err, "failed to load secret %q", ns+"/"+selector.Name)
}
if data, ok := secret.Data[selector.Key]; ok {
return data, nil
}
return nil, errors.Errorf("no key %q in secret %q", selector.Key, ns+"/"+selector.Name)
}