Files
probo/pkg/certmanager/provisioner.go
Sacha Al Himdani 4c57d201a4 Make license declarations consistently MIT
The source headers, LICENSE files, and license metadata had drifted
apart. Align the entire project to MIT:

- Convert every source-file header to the MIT text across all comment
  styles (Go, TS, TSX, JS, MJS, SQL, CSS, GraphQL, shell), including
  SPDX-License-Identifier tags
- Set the root and cookie-banner LICENSE files to the MIT text with a
  "MIT License" title line
- Switch the package.json license fields, Docker image label, and
  cookie-banner README to MIT
- Update docs and the genmodels header generator accordingly
- Normalize copyright lines to a single format
  (Copyright (c) <year(s)> Probo Inc <hello@probo.com>.): unify the
  hello@getprobo.com and hello@probo.inc emails to hello@probo.com and
  the comma-separated years to a hyphenated range

Genuine third-party references are intentionally left untouched: the
Lucide icon attributions (Lucide is ISC) and the trivy dependency
license allowlist.

Signed-off-by: Sacha Al Himdani <sacha@probo.com>
2026-07-13 16:21:14 +02:00

521 lines
14 KiB
Go

// Copyright (c) 2025-2026 Probo Inc <hello@probo.com>.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package certmanager
import (
"context"
"errors"
"fmt"
"strings"
"time"
"codeberg.org/miekg/dns"
"go.gearno.de/kit/log"
"go.gearno.de/kit/pg"
"go.probo.inc/probo/pkg/coredata"
"go.probo.inc/probo/pkg/crypto/cipher"
"go.probo.inc/probo/pkg/gid"
)
type (
Provisioner struct {
pg *pg.Client
acmeService *ACMEService
encryptionKey cipher.EncryptionKey
cnameTarget string
caaIssuerDomain string
interval time.Duration
resolverAddr string
logger *log.Logger
}
)
const (
maxRetries = 3
)
func NewProvisioner(
pg *pg.Client,
acmeService *ACMEService,
encryptionKey cipher.EncryptionKey,
cnameTarget string,
caaIssuerDomain string,
interval time.Duration,
resolverAddr string,
logger *log.Logger,
) *Provisioner {
return &Provisioner{
pg: pg,
acmeService: acmeService,
encryptionKey: encryptionKey,
cnameTarget: cnameTarget,
caaIssuerDomain: caaIssuerDomain,
interval: interval,
resolverAddr: resolverAddr,
logger: logger.Named("certmanager.provisioner"),
}
}
func (p *Provisioner) Run(ctx context.Context) error {
p.logger.InfoCtx(ctx, "certificate provisioner starting", log.Duration("interval", p.interval))
if err := p.checkPendingDomains(ctx); err != nil {
p.logger.ErrorCtx(ctx, "initial check failed", log.Error(err))
}
ticker := time.NewTicker(p.interval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
p.logger.InfoCtx(ctx, "certificate provisioner shutting down")
return ctx.Err()
case <-ticker.C:
if err := p.checkPendingDomains(ctx); err != nil {
p.logger.ErrorCtx(ctx, "periodic check failed", log.Error(err))
}
}
}
}
func (p *Provisioner) checkDNSConfiguration(domain string) error {
customerFQDN := domain
if !strings.HasSuffix(customerFQDN, ".") {
customerFQDN = customerFQDN + "."
}
expectedFQDN := p.cnameTarget
if !strings.HasSuffix(expectedFQDN, ".") {
expectedFQDN = expectedFQDN + "."
}
msg := &dns.Msg{MsgHeader: dns.MsgHeader{ID: dns.ID(), RecursionDesired: true}}
msg.Question = []dns.RR{&dns.CNAME{Hdr: dns.Header{Name: customerFQDN, Class: dns.ClassINET}}}
client := dns.NewClient()
resp, _, err := client.Exchange(context.Background(), msg, "udp", p.resolverAddr)
if err != nil {
return fmt.Errorf("cannot exchange dns message: %w", err)
}
if len(resp.Answer) == 0 {
return fmt.Errorf("no cname records found for domain %q", domain)
}
if len(resp.Answer) > 1 {
return fmt.Errorf("multiple cname records found for domain %q", domain)
}
resolvedRecord, ok := resp.Answer[0].(*dns.CNAME)
if !ok {
return fmt.Errorf("first answer is not a cname record for domain %q", domain)
}
if !strings.EqualFold(expectedFQDN, resolvedRecord.Target) {
return fmt.Errorf(
"cname target mismatch: domain %q resolves to %q, expected %q",
domain,
resolvedRecord.Target,
expectedFQDN,
)
}
return nil
}
func (p *Provisioner) checkCAARecords(domain string) error {
fqdn := domain
if !strings.HasSuffix(fqdn, ".") {
fqdn = fqdn + "."
}
msg := &dns.Msg{MsgHeader: dns.MsgHeader{ID: dns.ID(), RecursionDesired: true}}
msg.Question = []dns.RR{&dns.CAA{Hdr: dns.Header{Name: fqdn, Class: dns.ClassINET}}}
client := dns.NewClient()
resp, _, err := client.Exchange(
context.Background(),
msg,
"udp",
p.resolverAddr,
)
if err != nil {
return fmt.Errorf("cannot exchange dns message for caa records: %w", err)
}
var caaRecords []*dns.CAA
for _, rr := range resp.Answer {
if caa, ok := rr.(*dns.CAA); ok {
caaRecords = append(caaRecords, caa)
}
}
if len(caaRecords) == 0 {
return nil
}
for _, caa := range caaRecords {
if caa.Tag == "issue" {
issuer, _, _ := strings.Cut(caa.Value, ";")
if strings.EqualFold(strings.TrimSpace(issuer), p.caaIssuerDomain) {
return nil
}
}
}
return fmt.Errorf(
"caa records for domain %q do not permit issuance by %q",
domain,
p.caaIssuerDomain,
)
}
func (p *Provisioner) checkPendingDomains(ctx context.Context) error {
err := p.pg.WithTx(
ctx,
func(ctx context.Context, tx pg.Tx) error {
if err := p.handleStaleProvisioningAttempts(ctx, tx); err != nil {
return fmt.Errorf("cannot handle stale provisioning attempts: %w", err)
}
return nil
},
)
if err != nil {
return fmt.Errorf("cannot handle stale provisioning attempts: %w", err)
}
err = p.pg.WithTx(
ctx,
func(ctx context.Context, tx pg.Tx) error {
var domains coredata.CustomDomains
if err := domains.ListDomainsWithPendingHTTPChallenges(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot load domains with pending challenges: %w", err)
}
if len(domains) == 0 {
return nil
}
p.logger.InfoCtx(ctx, "found domains needing SSL provisioning", log.Int("count", len(domains)))
for _, domain := range domains {
select {
case <-ctx.Done():
return ctx.Err()
default:
}
if err := p.provisionDomainCertificate(ctx, tx, domain.ID); err != nil {
p.logger.ErrorCtx(
ctx,
"cannot provision certificate",
log.String("domain", domain.Domain),
log.Error(err),
)
}
}
return nil
},
)
if err != nil {
return fmt.Errorf("cannot provision domains: %w", err)
}
return nil
}
func (p *Provisioner) handleStaleProvisioningAttempts(ctx context.Context, tx pg.Tx) error {
var domains coredata.CustomDomains
if err := domains.ListStaleProvisioningDomains(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot load stale provisioning domains: %w", err)
}
if len(domains) == 0 {
return nil
}
p.logger.InfoCtx(ctx, "found stale provisioning attempts to reset", log.Int("count", len(domains)))
for _, domain := range domains {
if err := p.resetStaleDomain(ctx, tx, domain); err != nil {
p.logger.ErrorCtx(
ctx,
"cannot reset stale domain",
log.String("domain", domain.Domain),
log.Error(err),
)
}
}
return nil
}
func (p *Provisioner) resetStaleDomain(
ctx context.Context,
tx pg.Tx,
domain *coredata.CustomDomain,
) error {
fullDomain := &coredata.CustomDomain{}
if err := fullDomain.LoadByIDForUpdateSkipLocked(ctx, tx, coredata.NewNoScope(), domain.ID); err != nil {
if errors.Is(err, coredata.ErrResourceNotFound) {
return nil
}
return fmt.Errorf("cannot load stale domain for update: %w", err)
}
staleDuration := time.Since(fullDomain.UpdatedAt)
p.logger.InfoCtx(
ctx,
"resetting stale domain",
log.String("domain", fullDomain.Domain),
log.String("status", string(fullDomain.SSLStatus)),
log.Duration("stale_duration", staleDuration),
log.Int("retry_count", fullDomain.SSLRetryCount),
)
fullDomain.HTTPChallengeToken = nil
fullDomain.HTTPChallengeKeyAuth = nil
fullDomain.HTTPChallengeURL = nil
fullDomain.HTTPOrderURL = nil
fullDomain.ProvisioningError = nil
fullDomain.SSLStatus = coredata.CustomDomainSSLStatusPending
if fullDomain.SSLLastAttemptAt != nil && time.Since(*fullDomain.SSLLastAttemptAt) > 24*time.Hour {
p.logger.InfoCtx(
ctx,
"resetting retry count due to old last attempt",
log.String("domain", fullDomain.Domain),
log.Time("last_attempt", *fullDomain.SSLLastAttemptAt),
)
fullDomain.SSLRetryCount = 0
fullDomain.SSLLastAttemptAt = nil
}
if err := fullDomain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot update stale domain: %w", err)
}
return nil
}
func (p *Provisioner) provisionDomainCertificate(
ctx context.Context,
tx pg.Tx,
domainID gid.GID,
) error {
domain := &coredata.CustomDomain{}
if err := domain.LoadByIDForUpdateSkipLocked(ctx, tx, coredata.NewNoScope(), domainID); err != nil {
if errors.Is(err, coredata.ErrResourceNotFound) {
return nil
}
return fmt.Errorf("cannot load by id for update %q custom domain: %w", domainID, err)
}
if domain.SSLStatus == coredata.CustomDomainSSLStatusPending || domain.SSLStatus == coredata.CustomDomainSSLStatusRenewing {
if err := p.checkDNSConfiguration(domain.Domain); err != nil {
p.logger.WarnCtx(
ctx,
"dns configuration check failed",
log.String("domain", domain.Domain),
log.Error(err),
)
errMsg := err.Error()
domain.ProvisioningError = &errMsg
if err := domain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot update domain with provisioning error: %w", err)
}
return nil
}
if err := p.checkCAARecords(domain.Domain); err != nil {
p.logger.WarnCtx(
ctx,
"caa record check failed",
log.String("domain", domain.Domain),
log.Error(err),
)
errMsg := err.Error()
domain.ProvisioningError = &errMsg
if err := domain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot update domain with provisioning error: %w", err)
}
return nil
}
domain.ProvisioningError = nil
if err := domain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot clear provisioning error: %w", err)
}
p.logger.InfoCtx(ctx, "DNS configuration verified, initiating HTTP challenge for domain", log.String("domain", domain.Domain))
challenge, err := p.acmeService.GetHTTPChallenge(ctx, domain.Domain)
if err != nil {
p.logger.ErrorCtx(
ctx,
"cannot get HTTP challenge",
log.String("domain", domain.Domain),
log.Error(err),
)
return err
}
domain.HTTPChallengeToken = &challenge.Token
domain.HTTPChallengeKeyAuth = &challenge.KeyAuth
domain.HTTPChallengeURL = &challenge.URL
domain.HTTPOrderURL = &challenge.OrderURL
domain.SSLStatus = coredata.CustomDomainSSLStatusProvisioning
if err := domain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot update domain with challenge: %w", err)
}
p.logger.InfoCtx(
ctx,
"HTTP challenge initiated, will complete in next cycle",
log.String("domain", domain.Domain),
log.String("token", challenge.Token),
)
return nil
}
challenge := &HTTPChallenge{
Domain: domain.Domain,
Token: *domain.HTTPChallengeToken,
KeyAuth: *domain.HTTPChallengeKeyAuth,
URL: *domain.HTTPChallengeURL,
OrderURL: *domain.HTTPOrderURL,
}
cert, err := p.acmeService.CompleteHTTPChallenge(ctx, challenge)
if err != nil {
p.logger.WarnCtx(
ctx,
"cannot complete HTTP challenge",
log.String("domain", domain.Domain),
log.Int("retry_count", domain.SSLRetryCount),
log.Error(err),
)
errMsg := err.Error()
domain.ProvisioningError = &errMsg
domain.SSLRetryCount = domain.SSLRetryCount + 1
domain.SSLLastAttemptAt = new(time.Now())
// Clear challenge data and reset to pending so the next attempt
// creates a fresh ACME order. Once a challenge fails validation,
// Let's Encrypt marks it as invalid and retrying the same
// challenge always fails with "authorization must be pending".
domain.HTTPChallengeToken = nil
domain.HTTPChallengeKeyAuth = nil
domain.HTTPChallengeURL = nil
domain.HTTPOrderURL = nil
if domain.SSLRetryCount >= maxRetries {
p.logger.ErrorCtx(
ctx,
"domain has exceeded max retry attempts, marking as failed",
log.String("domain", domain.Domain),
log.Int("retry_count", domain.SSLRetryCount),
)
domain.SSLStatus = coredata.CustomDomainSSLStatusFailed
} else {
domain.SSLStatus = coredata.CustomDomainSSLStatusPending
}
if err := domain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot update domain: %w", err)
}
return nil
}
p.logger.InfoCtx(
ctx,
"certificate obtained successfully",
log.String("domain", domain.Domain),
log.Time("expires_at", cert.ExpiresAt),
)
domain.ProvisioningError = nil
domain.SSLCertificatePEM = cert.CertPEM
if err := domain.EncryptPrivateKey(cert.KeyPEM, p.encryptionKey); err != nil {
return fmt.Errorf("cannot encrypt private key: %w", err)
}
chainStr := string(cert.ChainPEM)
domain.SSLCertificateChain = &chainStr
domain.SSLExpiresAt = &cert.ExpiresAt
domain.SSLStatus = coredata.CustomDomainSSLStatusActive
domain.SSLRetryCount = 0
domain.SSLLastAttemptAt = nil
domain.HTTPChallengeToken = nil
domain.HTTPChallengeKeyAuth = nil
domain.HTTPChallengeURL = nil
domain.HTTPOrderURL = nil
if err := domain.Update(ctx, tx, coredata.NewNoScope()); err != nil {
return fmt.Errorf("cannot update domain: %w", err)
}
cache := &coredata.CachedCertificate{
Domain: domain.Domain,
CertificatePEM: string(cert.CertPEM),
PrivateKeyPEM: string(cert.KeyPEM),
CertificateChain: &chainStr,
ExpiresAt: cert.ExpiresAt,
CachedAt: time.Now(),
CustomDomainID: domain.ID,
}
if err := cache.Upsert(ctx, tx); err != nil {
p.logger.ErrorCtx(
ctx,
"cannot update certificate cache",
log.String("domain", domain.Domain),
log.Error(err),
)
}
return nil
}