ipn/ipnlocal, feature/acme: move most remaining cert code into feature/acme
f5eac39ea ("feature/acme, ipn/ipnlocal: start moving ACME/cert state
into an extension") started to move the cert code into feature/acme
but was meant as a baby step.
This goes further, moving almost everything, leaving only some hooks
in ipnlocal.
When we later move "serve" support out to feature/serve, this will
look a bit different in that the hooks currently in ipnlocal will move
to feature/serve (cert support already depends on serve).
As part of this, cert-related tests move to feaure/acme too, which
means some test infra from ipnlocal now moves to shared ipnlocaltest.
(it's not big at the moment, but I imagine it growing)
Updates #12614
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
Change-Id: I9ea89aa9754f12d54b81751b6bd830f2664241ff
This commit is contained in:
committed by
Brad Fitzpatrick
parent
825b7c479f
commit
1c77079fd7
@@ -0,0 +1,154 @@
|
||||
// Copyright (c) Tailscale Inc & contributors
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
package acme
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net"
|
||||
"time"
|
||||
|
||||
"tailscale.com/envknob"
|
||||
"tailscale.com/ipn"
|
||||
"tailscale.com/ipn/ipnlocal"
|
||||
"tailscale.com/util/set"
|
||||
)
|
||||
|
||||
// certRefreshInterval is how often the background loop iterates the set
|
||||
// of applicable cert domains and pokes the renewal machinery. The loop
|
||||
// is only started while there's at least one HTTPS Web entry in the
|
||||
// ServeConfig, so this cadence doesn't tick on idle/mobile nodes.
|
||||
const certRefreshInterval = time.Hour
|
||||
|
||||
// updateCertRefreshLoop starts or stops the background TLS cert refresh
|
||||
// loop based on whether the backend currently has any HTTPS-serving
|
||||
// hostname whose cert should be kept fresh. The loop runs only while:
|
||||
//
|
||||
// - the node is in [ipn.Running], and
|
||||
// - the current [ipn.ServeConfig] has at least one HTTPS-serving entry.
|
||||
//
|
||||
// We deliberately don't keep an idle timer around on hosts that have no
|
||||
// certs to maintain (e.g. mobile devices that never run Serve), so this
|
||||
// is called whenever any of those inputs change: state transitions and
|
||||
// ServeConfig reloads. The caller (in [ipn/ipnlocal]) holds b.mu when
|
||||
// invoking this; we use our own e.mu for the refresh-loop bookkeeping.
|
||||
func (e *extension) updateCertRefreshLoop(b *ipnlocal.LocalBackend, state ipn.State, sc ipn.ServeConfigView) {
|
||||
shouldRun := state == ipn.Running && serveConfigUsesACMECerts(sc)
|
||||
|
||||
e.mu.Lock()
|
||||
defer e.mu.Unlock()
|
||||
switch {
|
||||
case shouldRun && e.certRefreshCancel == nil:
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
e.certRefreshCancel = cancel
|
||||
e.Go(func() { e.certRefreshLoop(ctx, b) })
|
||||
case !shouldRun && e.certRefreshCancel != nil:
|
||||
e.certRefreshCancel()
|
||||
e.certRefreshCancel = nil
|
||||
}
|
||||
}
|
||||
|
||||
// certRefreshLoop periodically iterates the domains configured for
|
||||
// Serve or Funnel HTTPS and calls GetCertPEM on each. The existing
|
||||
// renewal machinery in getCertPEM decides whether anything needs to
|
||||
// happen (ARI check or expiry-based fallback); the loop just ensures
|
||||
// it runs even on nodes that see no inbound TLS traffic.
|
||||
//
|
||||
// The first iteration runs immediately so that a node coming back
|
||||
// online with stale or absent certs starts ACME within seconds rather
|
||||
// than waiting a full interval.
|
||||
func (e *extension) certRefreshLoop(ctx context.Context, b *ipnlocal.LocalBackend) {
|
||||
if envknob.IsCertShareReadOnlyMode() {
|
||||
b.Logger()("cert refresh loop: cert-share read-only mode; loop is a no-op")
|
||||
return
|
||||
}
|
||||
|
||||
ticker, tickerCh := b.Clock().NewTicker(certRefreshInterval)
|
||||
defer ticker.Stop()
|
||||
for {
|
||||
e.refreshApplicableCerts(ctx, b)
|
||||
select {
|
||||
case <-tickerCh:
|
||||
case <-ctx.Done():
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// refreshApplicableCerts is one iteration of the cert refresh loop.
|
||||
//
|
||||
// It enumerates the Serve/Funnel-configured HTTPS hostnames, keeps
|
||||
// those that resolveCertDomain accepts (CertDomain, wildcard, or BYO
|
||||
// Funnel domain), and calls [LocalBackend.GetCertPEM] for each. The
|
||||
// renewal decision is delegated to the existing logic in getCertPEM.
|
||||
func (e *extension) refreshApplicableCerts(ctx context.Context, b *ipnlocal.LocalBackend) {
|
||||
sc := b.ServeConfig()
|
||||
if !sc.Valid() {
|
||||
return
|
||||
}
|
||||
|
||||
want := set.Set[string]{}
|
||||
consider := func(host string) {
|
||||
if host == "" {
|
||||
return
|
||||
}
|
||||
if _, err := e.resolveCertDomain(b, host); err != nil {
|
||||
return
|
||||
}
|
||||
want.Add(host)
|
||||
}
|
||||
for hp := range sc.Webs() {
|
||||
host, _, err := net.SplitHostPort(string(hp))
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
consider(host)
|
||||
}
|
||||
for _, tcp := range sc.TCPs() {
|
||||
consider(tcp.TerminateTLS())
|
||||
}
|
||||
for _, svc := range sc.Services().All() {
|
||||
for _, tcp := range svc.TCP().All() {
|
||||
consider(tcp.TerminateTLS())
|
||||
}
|
||||
}
|
||||
if want.Len() == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
for d := range want {
|
||||
e.Go(func() {
|
||||
ctx, cancel := context.WithTimeout(ctx, 2*time.Minute)
|
||||
defer cancel()
|
||||
if _, err := e.getCertPEMWithValidity(ctx, b, d, 0); err != nil {
|
||||
b.Logger()("cert refresh: %s: %v", d, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// serveConfigUsesACMECerts reports whether sc has any entry that
|
||||
// causes tailscaled to obtain ACME-managed TLS certs: an HTTPS Web
|
||||
// entry (background, foreground, or service) or a TCP handler with
|
||||
// TerminateTLS set (`tailscale serve --tls-terminated-tcp`).
|
||||
func serveConfigUsesACMECerts(sc ipn.ServeConfigView) bool {
|
||||
if !sc.Valid() {
|
||||
return false
|
||||
}
|
||||
for range sc.Webs() {
|
||||
return true
|
||||
}
|
||||
for _, tcp := range sc.TCPs() {
|
||||
if tcp.TerminateTLS() != "" {
|
||||
return true
|
||||
}
|
||||
}
|
||||
for _, svc := range sc.Services().All() {
|
||||
for _, tcp := range svc.TCP().All() {
|
||||
if tcp.TerminateTLS() != "" {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
Reference in New Issue
Block a user