package acme import ( "context" "crypto/tls" "crypto/x509" "errors" "fmt" "net/url" "reflect" "sort" "strings" "sync" "time" "github.com/go-acme/lego/v4/certificate" "github.com/go-acme/lego/v4/challenge" "github.com/go-acme/lego/v4/challenge/dns01" "github.com/go-acme/lego/v4/lego" "github.com/go-acme/lego/v4/providers/dns" "github.com/go-acme/lego/v4/registration" "github.com/rs/zerolog/log" ptypes "github.com/traefik/paerser/types" "github.com/traefik/traefik/v3/pkg/config/dynamic" "github.com/traefik/traefik/v3/pkg/logs" httpmuxer "github.com/traefik/traefik/v3/pkg/muxer/http" tcpmuxer "github.com/traefik/traefik/v3/pkg/muxer/tcp" "github.com/traefik/traefik/v3/pkg/safe" traefiktls "github.com/traefik/traefik/v3/pkg/tls" "github.com/traefik/traefik/v3/pkg/types" "github.com/traefik/traefik/v3/pkg/version" ) // ocspMustStaple enables OCSP stapling as from https://github.com/go-acme/lego/issues/270. var ocspMustStaple = false // Configuration holds ACME configuration provided by users. type Configuration struct { Email string `description:"Email address used for registration." json:"email,omitempty" toml:"email,omitempty" yaml:"email,omitempty"` CAServer string `description:"CA server to use." json:"caServer,omitempty" toml:"caServer,omitempty" yaml:"caServer,omitempty"` PreferredChain string `description:"Preferred chain to use." json:"preferredChain,omitempty" toml:"preferredChain,omitempty" yaml:"preferredChain,omitempty" export:"true"` Storage string `description:"Storage to use." json:"storage,omitempty" toml:"storage,omitempty" yaml:"storage,omitempty" export:"true"` KeyType string `description:"KeyType used for generating certificate private key. Allow value 'EC256', 'EC384', 'RSA2048', 'RSA4096', 'RSA8192'." json:"keyType,omitempty" toml:"keyType,omitempty" yaml:"keyType,omitempty" export:"true"` EAB *EAB `description:"External Account Binding to use." json:"eab,omitempty" toml:"eab,omitempty" yaml:"eab,omitempty"` CertificatesDuration int `description:"Certificates' duration in hours." json:"certificatesDuration,omitempty" toml:"certificatesDuration,omitempty" yaml:"certificatesDuration,omitempty" export:"true"` DNSChallenge *DNSChallenge `description:"Activate DNS-01 Challenge." json:"dnsChallenge,omitempty" toml:"dnsChallenge,omitempty" yaml:"dnsChallenge,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true"` HTTPChallenge *HTTPChallenge `description:"Activate HTTP-01 Challenge." json:"httpChallenge,omitempty" toml:"httpChallenge,omitempty" yaml:"httpChallenge,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true"` TLSChallenge *TLSChallenge `description:"Activate TLS-ALPN-01 Challenge." json:"tlsChallenge,omitempty" toml:"tlsChallenge,omitempty" yaml:"tlsChallenge,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true"` } // SetDefaults sets the default values. func (a *Configuration) SetDefaults() { a.CAServer = lego.LEDirectoryProduction a.Storage = "acme.json" a.KeyType = "RSA4096" a.CertificatesDuration = 3 * 30 * 24 // 90 Days } // CertAndStore allows mapping a TLS certificate to a TLS store. type CertAndStore struct { Certificate Store string } // Certificate is a struct which contains all data needed from an ACME certificate. type Certificate struct { Domain types.Domain `json:"domain,omitempty" toml:"domain,omitempty" yaml:"domain,omitempty"` Certificate []byte `json:"certificate,omitempty" toml:"certificate,omitempty" yaml:"certificate,omitempty"` Key []byte `json:"key,omitempty" toml:"key,omitempty" yaml:"key,omitempty"` } // EAB contains External Account Binding configuration. type EAB struct { Kid string `description:"Key identifier from External CA." json:"kid,omitempty" toml:"kid,omitempty" yaml:"kid,omitempty" loggable:"false"` HmacEncoded string `description:"Base64 encoded HMAC key from External CA." json:"hmacEncoded,omitempty" toml:"hmacEncoded,omitempty" yaml:"hmacEncoded,omitempty" loggable:"false"` } // DNSChallenge contains DNS challenge configuration. type DNSChallenge struct { Provider string `description:"Use a DNS-01 based challenge provider rather than HTTPS." json:"provider,omitempty" toml:"provider,omitempty" yaml:"provider,omitempty" export:"true"` DelayBeforeCheck ptypes.Duration `description:"Assume DNS propagates after a delay in seconds rather than finding and querying nameservers." json:"delayBeforeCheck,omitempty" toml:"delayBeforeCheck,omitempty" yaml:"delayBeforeCheck,omitempty" export:"true"` Resolvers []string `description:"Use following DNS servers to resolve the FQDN authority." json:"resolvers,omitempty" toml:"resolvers,omitempty" yaml:"resolvers,omitempty"` DisablePropagationCheck bool `description:"Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready. [not recommended]" json:"disablePropagationCheck,omitempty" toml:"disablePropagationCheck,omitempty" yaml:"disablePropagationCheck,omitempty" export:"true"` } // HTTPChallenge contains HTTP challenge configuration. type HTTPChallenge struct { EntryPoint string `description:"HTTP challenge EntryPoint" json:"entryPoint,omitempty" toml:"entryPoint,omitempty" yaml:"entryPoint,omitempty" export:"true"` } // TLSChallenge contains TLS challenge configuration. type TLSChallenge struct{} // Provider holds configurations of the provider. type Provider struct { *Configuration ResolverName string Store Store `json:"store,omitempty" toml:"store,omitempty" yaml:"store,omitempty"` TLSChallengeProvider challenge.Provider HTTPChallengeProvider challenge.Provider certificates []*CertAndStore certificatesMu sync.RWMutex account *Account client *lego.Client configurationChan chan<- dynamic.Message tlsManager *traefiktls.Manager clientMutex sync.Mutex configFromListenerChan chan dynamic.Configuration pool *safe.Pool resolvingDomains map[string]struct{} resolvingDomainsMutex sync.RWMutex } // SetTLSManager sets the tls manager to use. func (p *Provider) SetTLSManager(tlsManager *traefiktls.Manager) { p.tlsManager = tlsManager } // SetConfigListenerChan initializes the configFromListenerChan. func (p *Provider) SetConfigListenerChan(configFromListenerChan chan dynamic.Configuration) { p.configFromListenerChan = configFromListenerChan } // ListenConfiguration sets a new Configuration into the configFromListenerChan. func (p *Provider) ListenConfiguration(config dynamic.Configuration) { p.configFromListenerChan <- config } // Init for compatibility reason the BaseProvider implements an empty Init. func (p *Provider) Init() error { logger := log.With().Str(logs.ProviderName, p.ResolverName+".acme").Logger() if len(p.Configuration.Storage) == 0 { return errors.New("unable to initialize ACME provider with no storage location for the certificates") } if p.CertificatesDuration < 1 { return errors.New("cannot manage certificates with duration lower than 1 hour") } var err error p.account, err = p.Store.GetAccount(p.ResolverName) if err != nil { return fmt.Errorf("unable to get ACME account: %w", err) } // Reset Account if caServer changed, thus registration URI can be updated if p.account != nil && p.account.Registration != nil && !isAccountMatchingCaServer(logger.WithContext(context.Background()), p.account.Registration.URI, p.CAServer) { logger.Info().Msg("Account URI does not match the current CAServer. The account will be reset.") p.account = nil } p.certificatesMu.Lock() p.certificates, err = p.Store.GetCertificates(p.ResolverName) p.certificatesMu.Unlock() if err != nil { return fmt.Errorf("unable to get ACME certificates : %w", err) } // Init the currently resolved domain map p.resolvingDomains = make(map[string]struct{}) return nil } func isAccountMatchingCaServer(ctx context.Context, accountURI, serverURI string) bool { logger := log.Ctx(ctx) aru, err := url.Parse(accountURI) if err != nil { logger.Info().Err(err).Str("registrationURL", accountURI).Msg("Unable to parse account.Registration URL") return false } cau, err := url.Parse(serverURI) if err != nil { logger.Info().Err(err).Str("caServerURL", serverURI).Msg("Unable to parse CAServer URL") return false } return cau.Hostname() == aru.Hostname() } // ThrottleDuration returns the throttle duration. func (p *Provider) ThrottleDuration() time.Duration { return 0 } // Provide allows the file provider to provide configurations to traefik // using the given Configuration channel. func (p *Provider) Provide(configurationChan chan<- dynamic.Message, pool *safe.Pool) error { logger := log.With().Str(logs.ProviderName, p.ResolverName+".acme").Str("acmeCA", p.Configuration.CAServer). Logger() ctx := logger.WithContext(context.Background()) p.pool = pool p.watchNewDomains(ctx) p.configurationChan = configurationChan p.certificatesMu.RLock() msg := p.buildMessage() p.certificatesMu.RUnlock() p.configurationChan <- msg renewPeriod, renewInterval := getCertificateRenewDurations(p.CertificatesDuration) logger.Debug().Msgf("Attempt to renew certificates %q before expiry and check every %q", renewPeriod, renewInterval) p.renewCertificates(ctx, renewPeriod) ticker := time.NewTicker(renewInterval) pool.GoCtx(func(ctxPool context.Context) { for { select { case <-ticker.C: p.renewCertificates(ctx, renewPeriod) case <-ctxPool.Done(): ticker.Stop() return } } }) return nil } func (p *Provider) getClient() (*lego.Client, error) { p.clientMutex.Lock() defer p.clientMutex.Unlock() logger := log.With().Str(logs.ProviderName, p.ResolverName+".acme").Logger() ctx := logger.WithContext(context.Background()) if p.client != nil { return p.client, nil } account, err := p.initAccount(ctx) if err != nil { return nil, err } logger.Debug().Msg("Building ACME client...") caServer := lego.LEDirectoryProduction if len(p.CAServer) > 0 { caServer = p.CAServer } logger.Debug().Msg(caServer) config := lego.NewConfig(account) config.CADirURL = caServer config.Certificate.KeyType = GetKeyType(ctx, p.KeyType) config.UserAgent = fmt.Sprintf("containous-traefik/%s", version.Version) client, err := lego.NewClient(config) if err != nil { return nil, err } // New users will need to register; be sure to save it if account.GetRegistration() == nil { reg, errR := p.register(ctx, client) if errR != nil { return nil, errR } account.Registration = reg } // Save the account once before all the certificates generation/storing // No certificate can be generated if account is not initialized err = p.Store.SaveAccount(p.ResolverName, account) if err != nil { return nil, err } if (p.DNSChallenge == nil || len(p.DNSChallenge.Provider) == 0) && (p.HTTPChallenge == nil || len(p.HTTPChallenge.EntryPoint) == 0) && p.TLSChallenge == nil { return nil, errors.New("ACME challenge not specified, please select TLS or HTTP or DNS Challenge") } if p.DNSChallenge != nil && len(p.DNSChallenge.Provider) > 0 { logger.Debug().Msgf("Using DNS Challenge provider: %s", p.DNSChallenge.Provider) var provider challenge.Provider provider, err = dns.NewDNSChallengeProviderByName(p.DNSChallenge.Provider) if err != nil { return nil, err } err = client.Challenge.SetDNS01Provider(provider, dns01.CondOption(len(p.DNSChallenge.Resolvers) > 0, dns01.AddRecursiveNameservers(p.DNSChallenge.Resolvers)), dns01.WrapPreCheck(func(domain, fqdn, value string, check dns01.PreCheckFunc) (bool, error) { if p.DNSChallenge.DelayBeforeCheck > 0 { logger.Debug().Msgf("Delaying %d rather than validating DNS propagation now.", p.DNSChallenge.DelayBeforeCheck) time.Sleep(time.Duration(p.DNSChallenge.DelayBeforeCheck)) } if p.DNSChallenge.DisablePropagationCheck { return true, nil } return check(fqdn, value) }), ) if err != nil { return nil, err } } if p.HTTPChallenge != nil && len(p.HTTPChallenge.EntryPoint) > 0 { logger.Debug().Msg("Using HTTP Challenge provider.") err = client.Challenge.SetHTTP01Provider(p.HTTPChallengeProvider) if err != nil { return nil, err } } if p.TLSChallenge != nil { logger.Debug().Msg("Using TLS Challenge provider.") err = client.Challenge.SetTLSALPN01Provider(p.TLSChallengeProvider) if err != nil { return nil, err } } p.client = client return p.client, nil } func (p *Provider) initAccount(ctx context.Context) (*Account, error) { if p.account == nil || len(p.account.Email) == 0 { var err error p.account, err = NewAccount(ctx, p.Email, p.KeyType) if err != nil { return nil, err } } // Set the KeyType if not already defined in the account if len(p.account.KeyType) == 0 { p.account.KeyType = GetKeyType(ctx, p.KeyType) } return p.account, nil } func (p *Provider) register(ctx context.Context, client *lego.Client) (*registration.Resource, error) { logger := log.Ctx(ctx) if p.EAB != nil { logger.Info().Msg("Register with external account binding...") eabOptions := registration.RegisterEABOptions{TermsOfServiceAgreed: true, Kid: p.EAB.Kid, HmacEncoded: p.EAB.HmacEncoded} return client.Registration.RegisterWithExternalAccountBinding(eabOptions) } logger.Info().Msg("Register...") return client.Registration.Register(registration.RegisterOptions{TermsOfServiceAgreed: true}) } func (p *Provider) resolveDomains(ctx context.Context, domains []string, tlsStore string) { logger := log.Ctx(ctx) if len(domains) == 0 { logger.Debug().Msg("No domain parsed in provider ACME") return } logger.Debug().Msgf("Trying to challenge certificate for domain %v found in HostSNI rule", domains) var domain types.Domain if len(domains) > 0 { domain = types.Domain{Main: domains[0]} if len(domains) > 1 { domain.SANs = domains[1:] } safe.Go(func() { dom, cert, err := p.resolveCertificate(ctx, domain, tlsStore) if err != nil { logger.Error().Err(err).Strs("domains", domains).Msg("Unable to obtain ACME certificate for domains") return } err = p.addCertificateForDomain(dom, cert, tlsStore) if err != nil { logger.Error().Err(err).Strs("domains", dom.ToStrArray()).Msg("Error adding certificate for domains") } }) } } func (p *Provider) watchNewDomains(ctx context.Context) { rootLogger := log.Ctx(ctx).With().Str(logs.ProviderName, p.ResolverName+".acme").Logger() ctx = rootLogger.WithContext(ctx) p.pool.GoCtx(func(ctxPool context.Context) { for { select { case config := <-p.configFromListenerChan: if config.TCP != nil { for routerName, route := range config.TCP.Routers { if route.TLS == nil || route.TLS.CertResolver != p.ResolverName { continue } logger := rootLogger.With().Str(logs.RouterName, routerName).Str(logs.Rule, route.Rule).Logger() ctxRouter := logger.WithContext(ctx) if len(route.TLS.Domains) > 0 { domains := deleteUnnecessaryDomains(ctxRouter, route.TLS.Domains) for i := 0; i < len(domains); i++ { domain := domains[i] safe.Go(func() { dom, cert, err := p.resolveCertificate(ctx, domain, traefiktls.DefaultTLSStoreName) if err != nil { logger.Error().Err(err).Strs("domains", domain.ToStrArray()).Msg("Unable to obtain ACME certificate for domains") return } err = p.addCertificateForDomain(dom, cert, traefiktls.DefaultTLSStoreName) if err != nil { logger.Error().Err(err).Strs("domains", dom.ToStrArray()).Msg("Error adding certificate for domains") } }) } } else { domains, err := tcpmuxer.ParseHostSNI(route.Rule) if err != nil { logger.Error().Err(err).Msg("Error parsing domains in provider ACME") continue } p.resolveDomains(ctxRouter, domains, traefiktls.DefaultTLSStoreName) } } } if config.HTTP != nil { for routerName, route := range config.HTTP.Routers { if route.TLS == nil || route.TLS.CertResolver != p.ResolverName { continue } logger := rootLogger.With().Str(logs.RouterName, routerName).Str(logs.Rule, route.Rule).Logger() ctxRouter := logger.WithContext(ctx) if len(route.TLS.Domains) > 0 { domains := deleteUnnecessaryDomains(ctxRouter, route.TLS.Domains) for i := 0; i < len(domains); i++ { domain := domains[i] safe.Go(func() { dom, cert, err := p.resolveCertificate(ctx, domain, traefiktls.DefaultTLSStoreName) if err != nil { logger.Error().Err(err).Strs("domains", domain.ToStrArray()).Msg("Unable to obtain ACME certificate for domains") return } err = p.addCertificateForDomain(dom, cert, traefiktls.DefaultTLSStoreName) if err != nil { logger.Error().Err(err).Strs("domains", dom.ToStrArray()).Msg("Error adding certificate for domain") } }) } } else { domains, err := httpmuxer.ParseDomains(route.Rule) if err != nil { logger.Error().Err(err).Msg("Error parsing domains in provider ACME") continue } p.resolveDomains(ctxRouter, domains, traefiktls.DefaultTLSStoreName) } } } if config.TLS == nil { continue } for tlsStoreName, tlsStore := range config.TLS.Stores { logger := rootLogger.With().Str(logs.TLSStoreName, tlsStoreName).Logger() if tlsStore.DefaultCertificate != nil && tlsStore.DefaultGeneratedCert != nil { logger.Warn().Msg("defaultCertificate and defaultGeneratedCert cannot be defined at the same time.") } // Gives precedence to the user defined default certificate. if tlsStore.DefaultCertificate != nil || tlsStore.DefaultGeneratedCert == nil { continue } if tlsStore.DefaultGeneratedCert.Domain == nil || tlsStore.DefaultGeneratedCert.Resolver == "" { logger.Warn().Msg("default generated certificate domain or resolver is missing.") continue } if tlsStore.DefaultGeneratedCert.Resolver != p.ResolverName { continue } validDomains, err := p.sanitizeDomains(ctx, *tlsStore.DefaultGeneratedCert.Domain) if err != nil { logger.Error().Err(err).Strs("domains", tlsStore.DefaultGeneratedCert.Domain.ToStrArray()).Msg("domains validation") } if p.certExists(validDomains) { logger.Debug().Msg("Default ACME certificate generation is not required.") continue } safe.Go(func() { cert, err := p.resolveDefaultCertificate(ctx, validDomains) if err != nil { logger.Error().Err(err).Strs("domains", validDomains).Msgf("Unable to obtain ACME certificate for domain") return } domain := types.Domain{ Main: validDomains[0], } if len(validDomains) > 0 { domain.SANs = validDomains[1:] } err = p.addCertificateForDomain(domain, cert, traefiktls.DefaultTLSStoreName) if err != nil { logger.Error().Err(err).Msg("Error adding certificate for domain") } }) } case <-ctxPool.Done(): return } } }) } func (p *Provider) resolveDefaultCertificate(ctx context.Context, domains []string) (*certificate.Resource, error) { logger := log.Ctx(ctx) p.resolvingDomainsMutex.Lock() sort.Strings(domains) domainKey := strings.Join(domains, ",") if _, ok := p.resolvingDomains[domainKey]; ok { p.resolvingDomainsMutex.Unlock() return nil, nil } p.resolvingDomains[domainKey] = struct{}{} for _, certDomain := range domains { p.resolvingDomains[certDomain] = struct{}{} } p.resolvingDomainsMutex.Unlock() defer p.removeResolvingDomains(append(domains, domainKey)) logger.Debug().Msgf("Loading ACME certificates %+v...", domains) client, err := p.getClient() if err != nil { return nil, fmt.Errorf("cannot get ACME client %w", err) } request := certificate.ObtainRequest{ Domains: domains, Bundle: true, MustStaple: ocspMustStaple, PreferredChain: p.PreferredChain, } cert, err := client.Certificate.Obtain(request) if err != nil { return nil, fmt.Errorf("unable to generate a certificate for the domains %v: %w", domains, err) } if cert == nil { return nil, fmt.Errorf("unable to generate a certificate for the domains %v", domains) } if len(cert.Certificate) == 0 || len(cert.PrivateKey) == 0 { return nil, fmt.Errorf("certificate for domains %v is empty: %v", domains, cert) } logger.Debug().Msgf("Default certificate obtained for domains %+v", domains) return cert, nil } func (p *Provider) resolveCertificate(ctx context.Context, domain types.Domain, tlsStore string) (types.Domain, *certificate.Resource, error) { domains, err := p.sanitizeDomains(ctx, domain) if err != nil { return types.Domain{}, nil, err } // Check if provided certificates are not already in progress and lock them if needed uncheckedDomains := p.getUncheckedDomains(ctx, domains, tlsStore) if len(uncheckedDomains) == 0 { return types.Domain{}, nil, nil } defer p.removeResolvingDomains(uncheckedDomains) logger := log.Ctx(ctx) logger.Debug().Msgf("Loading ACME certificates %+v...", uncheckedDomains) client, err := p.getClient() if err != nil { return types.Domain{}, nil, fmt.Errorf("cannot get ACME client %w", err) } request := certificate.ObtainRequest{ Domains: domains, Bundle: true, MustStaple: ocspMustStaple, PreferredChain: p.PreferredChain, } cert, err := client.Certificate.Obtain(request) if err != nil { return types.Domain{}, nil, fmt.Errorf("unable to generate a certificate for the domains %v: %w", uncheckedDomains, err) } if cert == nil { return types.Domain{}, nil, fmt.Errorf("unable to generate a certificate for the domains %v", uncheckedDomains) } if len(cert.Certificate) == 0 || len(cert.PrivateKey) == 0 { return types.Domain{}, nil, fmt.Errorf("certificate for domains %v is empty: %v", uncheckedDomains, cert) } logger.Debug().Msgf("Certificates obtained for domains %+v", uncheckedDomains) domain = types.Domain{Main: uncheckedDomains[0]} if len(uncheckedDomains) > 1 { domain.SANs = uncheckedDomains[1:] } return domain, cert, nil } func (p *Provider) removeResolvingDomains(resolvingDomains []string) { p.resolvingDomainsMutex.Lock() defer p.resolvingDomainsMutex.Unlock() for _, domain := range resolvingDomains { delete(p.resolvingDomains, domain) } } func (p *Provider) addCertificateForDomain(domain types.Domain, crt *certificate.Resource, tlsStore string) error { if crt == nil { return nil } p.certificatesMu.Lock() defer p.certificatesMu.Unlock() cert := Certificate{Certificate: crt.Certificate, Key: crt.PrivateKey, Domain: domain} certUpdated := false for _, domainsCertificate := range p.certificates { if reflect.DeepEqual(domain, domainsCertificate.Certificate.Domain) { domainsCertificate.Certificate = cert certUpdated = true break } } if !certUpdated { p.certificates = append(p.certificates, &CertAndStore{Certificate: cert, Store: tlsStore}) } p.configurationChan <- p.buildMessage() return p.Store.SaveCertificates(p.ResolverName, p.certificates) } // getCertificateRenewDurations returns renew durations calculated from the given certificatesDuration in hours. // The first (RenewPeriod) is the period before the end of the certificate duration, during which the certificate should be renewed. // The second (RenewInterval) is the interval between renew attempts. func getCertificateRenewDurations(certificatesDuration int) (time.Duration, time.Duration) { switch { case certificatesDuration >= 365*24: // >= 1 year return 4 * 30 * 24 * time.Hour, 7 * 24 * time.Hour // 4 month, 1 week case certificatesDuration >= 3*30*24: // >= 90 days return 30 * 24 * time.Hour, 24 * time.Hour // 30 days, 1 day case certificatesDuration >= 7*24: // >= 7 days return 24 * time.Hour, time.Hour // 1 days, 1 hour case certificatesDuration >= 24: // >= 1 days return 6 * time.Hour, 10 * time.Minute // 6 hours, 10 minutes default: return 20 * time.Minute, time.Minute } } // deleteUnnecessaryDomains deletes from the configuration : // - Duplicated domains // - Domains which are checked by wildcard domain. func deleteUnnecessaryDomains(ctx context.Context, domains []types.Domain) []types.Domain { var newDomains []types.Domain logger := log.Ctx(ctx) for idxDomainToCheck, domainToCheck := range domains { keepDomain := true for idxDomain, domain := range domains { if idxDomainToCheck == idxDomain { continue } if reflect.DeepEqual(domain, domainToCheck) { if idxDomainToCheck > idxDomain { logger.Warn().Msgf("The domain %v is duplicated in the configuration but will be process by ACME provider only once.", domainToCheck) keepDomain = false } break } // Check if CN or SANS to check already exists // or can not be checked by a wildcard var newDomainsToCheck []string for _, domainProcessed := range domainToCheck.ToStrArray() { if idxDomain < idxDomainToCheck && isDomainAlreadyChecked(domainProcessed, domain.ToStrArray()) { // The domain is duplicated in a CN logger.Warn().Msgf("Domain %q is duplicated in the configuration or validated by the domain %v. It will be processed once.", domainProcessed, domain) continue } else if domain.Main != domainProcessed && strings.HasPrefix(domain.Main, "*") && isDomainAlreadyChecked(domainProcessed, []string{domain.Main}) { // Check if a wildcard can validate the domain logger.Warn().Msgf("Domain %q will not be processed by ACME provider because it is validated by the wildcard %q", domainProcessed, domain.Main) continue } newDomainsToCheck = append(newDomainsToCheck, domainProcessed) } // Delete the domain if both Main and SANs can be validated by the wildcard domain // otherwise keep the unchecked values if newDomainsToCheck == nil { keepDomain = false break } domainToCheck.Set(newDomainsToCheck) } if keepDomain { newDomains = append(newDomains, domainToCheck) } } return newDomains } func (p *Provider) buildMessage() dynamic.Message { conf := dynamic.Message{ ProviderName: p.ResolverName + ".acme", Configuration: &dynamic.Configuration{ HTTP: &dynamic.HTTPConfiguration{ Routers: map[string]*dynamic.Router{}, Middlewares: map[string]*dynamic.Middleware{}, Services: map[string]*dynamic.Service{}, }, TLS: &dynamic.TLSConfiguration{}, }, } for _, cert := range p.certificates { certConf := &traefiktls.CertAndStores{ Certificate: traefiktls.Certificate{ CertFile: traefiktls.FileOrContent(cert.Certificate.Certificate), KeyFile: traefiktls.FileOrContent(cert.Key), }, Stores: []string{cert.Store}, } conf.Configuration.TLS.Certificates = append(conf.Configuration.TLS.Certificates, certConf) } return conf } func (p *Provider) renewCertificates(ctx context.Context, renewPeriod time.Duration) { logger := log.Ctx(ctx) logger.Info().Msg("Testing certificate renew...") p.certificatesMu.RLock() var certificates []*CertAndStore for _, cert := range p.certificates { crt, err := getX509Certificate(ctx, &cert.Certificate) // If there's an error, we assume the cert is broken, and needs update if err != nil || crt == nil || crt.NotAfter.Before(time.Now().Add(renewPeriod)) { certificates = append(certificates, cert) } } p.certificatesMu.RUnlock() for _, cert := range certificates { client, err := p.getClient() if err != nil { logger.Info().Err(err).Msgf("Error renewing certificate from LE : %+v", cert.Domain) continue } logger.Info().Msgf("Renewing certificate from LE : %+v", cert.Domain) renewedCert, err := client.Certificate.Renew(certificate.Resource{ Domain: cert.Domain.Main, PrivateKey: cert.Key, Certificate: cert.Certificate.Certificate, }, true, ocspMustStaple, p.PreferredChain) if err != nil { logger.Error().Err(err).Msgf("Error renewing certificate from LE: %v", cert.Domain) continue } if len(renewedCert.Certificate) == 0 || len(renewedCert.PrivateKey) == 0 { logger.Error().Msgf("domains %v renew certificate with no value: %v", cert.Domain.ToStrArray(), cert) continue } err = p.addCertificateForDomain(cert.Domain, renewedCert, cert.Store) if err != nil { logger.Error().Err(err).Msg("Error adding certificate for domain") } } } // Get provided certificate which check a domains list (Main and SANs) // from static and dynamic provided certificates. func (p *Provider) getUncheckedDomains(ctx context.Context, domainsToCheck []string, tlsStore string) []string { log.Ctx(ctx).Debug().Msgf("Looking for provided certificate(s) to validate %q...", domainsToCheck) var allDomains []string store := p.tlsManager.GetStore(tlsStore) if store != nil { allDomains = append(allDomains, store.GetAllDomains()...) } // Get ACME certificates p.certificatesMu.RLock() for _, cert := range p.certificates { allDomains = append(allDomains, strings.Join(cert.Domain.ToStrArray(), ",")) } p.certificatesMu.RUnlock() p.resolvingDomainsMutex.Lock() defer p.resolvingDomainsMutex.Unlock() // Get currently resolved domains for domain := range p.resolvingDomains { allDomains = append(allDomains, domain) } uncheckedDomains := searchUncheckedDomains(ctx, domainsToCheck, allDomains) // Lock domains that will be resolved by this routine for _, domain := range uncheckedDomains { p.resolvingDomains[domain] = struct{}{} } return uncheckedDomains } func searchUncheckedDomains(ctx context.Context, domainsToCheck, existentDomains []string) []string { var uncheckedDomains []string for _, domainToCheck := range domainsToCheck { if !isDomainAlreadyChecked(domainToCheck, existentDomains) { uncheckedDomains = append(uncheckedDomains, domainToCheck) } } logger := log.Ctx(ctx) if len(uncheckedDomains) == 0 { logger.Debug().Strs("domains", domainsToCheck).Msg("No ACME certificate generation required for domains") } else { logger.Debug().Strs("domains", domainsToCheck).Msgf("Domains need ACME certificates generation for domains %q.", strings.Join(uncheckedDomains, ",")) } return uncheckedDomains } func getX509Certificate(ctx context.Context, cert *Certificate) (*x509.Certificate, error) { logger := log.Ctx(ctx) tlsCert, err := tls.X509KeyPair(cert.Certificate, cert.Key) if err != nil { logger.Error().Err(err). Str("domain", cert.Domain.Main). Strs("SANs", cert.Domain.SANs). Msg("Failed to load TLS key pair from ACME certificate for domain, certificate will be renewed") return nil, err } crt := tlsCert.Leaf if crt == nil { crt, err = x509.ParseCertificate(tlsCert.Certificate[0]) if err != nil { logger.Error().Err(err). Str("domain", cert.Domain.Main). Strs("SANs", cert.Domain.SANs). Msg("Failed to parse TLS key pair from ACME certificate for domain, certificate will be renewed") } } return crt, err } // sanitizeDomains checks if given domain is allowed to generate a ACME certificate and return it. func (p *Provider) sanitizeDomains(ctx context.Context, domain types.Domain) ([]string, error) { domains := domain.ToStrArray() if len(domains) == 0 { return nil, errors.New("no domain was given") } var cleanDomains []string for _, dom := range domains { if strings.HasPrefix(dom, "*") { if p.DNSChallenge == nil { return nil, fmt.Errorf("unable to generate a wildcard certificate in ACME provider for domain %q : ACME needs a DNSChallenge", strings.Join(domains, ",")) } if strings.HasPrefix(dom, "*.*") { return nil, fmt.Errorf("unable to generate a wildcard certificate in ACME provider for domain %q : ACME does not allow '*.*' wildcard domain", strings.Join(domains, ",")) } } canonicalDomain := types.CanonicalDomain(dom) cleanDomain := dns01.UnFqdn(canonicalDomain) if canonicalDomain != cleanDomain { log.Ctx(ctx).Warn().Msgf("FQDN detected, please remove the trailing dot: %s", canonicalDomain) } cleanDomains = append(cleanDomains, cleanDomain) } return cleanDomains, nil } // certExists returns whether a certificate already exists for given domains. func (p *Provider) certExists(validDomains []string) bool { p.certificatesMu.RLock() defer p.certificatesMu.RUnlock() sort.Strings(validDomains) for _, cert := range p.certificates { domains := cert.Certificate.Domain.ToStrArray() sort.Strings(domains) if reflect.DeepEqual(domains, validDomains) { return true } } return false } func isDomainAlreadyChecked(domainToCheck string, existentDomains []string) bool { for _, certDomains := range existentDomains { for _, certDomain := range strings.Split(certDomains, ",") { if types.MatchDomain(domainToCheck, certDomain) { return true } } } return false }