github.com/caddyserver/certmagic v0.23.0: CacheOptions

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify github.com/caddyserver/certmagic.CacheOptions in pkg:golang/github.com/caddyserver/certmagic@v0.23.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/caddyserver/certmagic@v0.23.0
Demonstrate these symbols/APIs:
  - github.com/caddyserver/certmagic.CacheOptions

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:c4ea2e1eecaee46261f5169a559984b81559a01c929f940fe2846a3a3ae9502e","contract":["certmagic.NewCache panics when CacheOptions.GetConfigForCert is not provided.","certmagic.NewCache initializes an active Cache given valid CacheOptions including GetConfigForCert, Capacity, and check intervals.","Cache.SetOptions dynamically updates CacheOptions on an existing cache instance.","Cache created with CacheOptions stores and retrieves certificates via Config and Cache.AllMatchingCertificates.","CacheOptions.Capacity restricts the maximum number of cached certificates stored in memory."],"goal":"verify github.com/caddyserver/certmagic.CacheOptions in pkg:golang/github.com/caddyserver/certmagic@v0.23.0","kind":"HOW","packages":["pkg:golang/github.com/caddyserver/certmagic@v0.23.0"],"schemaVersion":1,"symbols":["github.com/caddyserver/certmagic.CacheOptions"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","executionContext":"go","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","runtime":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/caddyserver/certmagic@v0.23.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/caddyserver/certmagic@v0.23.0","symbols":["github.com/caddyserver/certmagic.CacheOptions"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.23.0

require (
	github.com/caddyserver/certmagic v0.23.0
	go.uber.org/zap v1.27.0
)

require (
	github.com/caddyserver/zerossl v0.1.3 // indirect
	github.com/klauspost/cpuid/v2 v2.2.10 // indirect
	github.com/libdns/libdns v1.0.0-beta.1 // indirect
	github.com/mholt/acmez/v3 v3.1.2 // indirect
	github.com/miekg/dns v1.1.63 // indirect
	github.com/zeebo/blake3 v0.2.4 // indirect
	go.uber.org/multierr v1.11.0 // indirect
	go.uber.org/zap/exp v0.3.0 // indirect
	golang.org/x/crypto v0.36.0 // indirect
	golang.org/x/mod v0.24.0 // indirect
	golang.org/x/net v0.37.0 // indirect
	golang.org/x/sync v0.12.0 // indirect
	golang.org/x/sys v0.31.0 // indirect
	golang.org/x/text v0.23.0 // indirect
	golang.org/x/tools v0.31.0 // indirect
)

github.com/caddyserver/certmagic v0.23.0 h1:CfpZ/50jMfG4+1J/u2LV6piJq4HOfO6ppOnOf7DkFEU=
github.com/caddyserver/certmagic v0.23.0/go.mod h1:9mEZIWqqWoI+Gf+4Trh04MOVPD0tGSxtqsxg87hAIH4=
github.com/caddyserver/zerossl v0.1.3 h1:onS+pxp3M8HnHpN5MMbOMyNjmTheJyWRaZYwn+YTAyA=
github.com/caddyserver/zerossl v0.1.3/go.mod h1:CxA0acn7oEGO6//4rtrRjYgEoa4MFw/XofZnrYwGqG4=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/klauspost/cpuid/v2 v2.2.10 h1:tBs3QSyvjDyFTq3uoc/9xFpCuOsJQFNPiAhYdw2skhE=
github.com/klauspost/cpuid/v2 v2.2.10/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0=
github.com/libdns/libdns v1.0.0-beta.1 h1:KIf4wLfsrEpXpZ3vmc/poM8zCATXT2klbdPe6hyOBjQ=
github.com/libdns/libdns v1.0.0-beta.1/go.mod h1:4Bj9+5CQiNMVGf87wjX4CY3HQJypUHRuLvlsfsZqLWQ=
github.com/mholt/acmez/v3 v3.1.2 h1:auob8J/0FhmdClQicvJvuDavgd5ezwLBfKuYmynhYzc=
github.com/mholt/acmez/v3 v3.1.2/go.mod h1:L1wOU06KKvq7tswuMDwKdcHeKpFFgkppZy/y0DFxagQ=
github.com/miekg/dns v1.1.63 h1:8M5aAw6OMZfFXTT7K5V0Eu5YiiL8l7nUAkyN6C9YwaY=
github.com/miekg/dns v1.1.63/go.mod h1:6NGHfjhpmr5lt3XPLuyfDJi5AXbNIPM9PY6H6sF1Nfs=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/zeebo/assert v1.1.0 h1:hU1L1vLTHsnO8x8c9KAR5GmM5QscxHg5RNU5z5qbUWY=
github.com/zeebo/assert v1.1.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0=
github.com/zeebo/blake3 v0.2.4 h1:KYQPkhpRtcqh0ssGYcKLG1JYvddkEA8QwCM/yBqhaZI=
github.com/zeebo/blake3 v0.2.4/go.mod h1:7eeQ6d2iXWRGF6npfaxl2CU+xy2Fjo2gxeyZGCRUjcE=
github.com/zeebo/pcg v1.0.1 h1:lyqfGeWiv4ahac6ttHs+I5hwtH/+1mrhlCtVNQM2kHo=
github.com/zeebo/pcg v1.0.1/go.mod h1:09F0S9iiKrwn9rlI5yjLkmrug154/YRW6KnnXVDM/l4=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
go.uber.org/zap/exp v0.3.0 h1:6JYzdifzYkGmTdRR59oYH+Ng7k49H9qVpWwNSsGJj3U=
go.uber.org/zap/exp v0.3.0/go.mod h1:5I384qq7XGxYyByIhHm6jg5CHkGY0nsTfbDLgDDlgJQ=
golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34=
golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc=
golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
golang.org/x/net v0.37.0 h1:1zLorHbz+LYj7MQlSf1+2tPIIgibq2eL5xkrGk6f+2c=
golang.org/x/net v0.37.0/go.mod h1:ivrbrMbzFq5J41QOQh0siUuly180yBYtLp+CKbEaFx8=
golang.org/x/sync v0.12.0 h1:MHc5BpPuC30uJk597Ri8TV3CNZcTLu6B6z4lJy+g6Jw=
golang.org/x/sync v0.12.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
golang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY=
golang.org/x/text v0.23.0/go.mod h1:/BLNzu4aZCJ1+kcD0DNRotWKage4q2rGVAg4o22unh4=
golang.org/x/tools v0.31.0 h1:0EedkvKDbh+qistFTd0Bcwe/YLh4vHwWEkiI0toFIBU=
golang.org/x/tools v0.31.0/go.mod h1:naFTU+Cev749tSJRXJlna0T3WxKvb1kWEx15xA4SdmQ=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package main

import (
	"context"
	"crypto/ecdsa"
	"crypto/elliptic"
	"crypto/rand"
	"crypto/x509"
	"crypto/x509/pkix"
	"encoding/pem"
	"fmt"
	"math/big"
	"os"
	"path/filepath"
	"time"

	"github.com/caddyserver/certmagic"
	"go.uber.org/zap"
)

func generateSelfSignedCert(domain string) ([]byte, []byte, error) {
	priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
	if err != nil {
		return nil, nil, err
	}

	template := x509.Certificate{
		SerialNumber: big.NewInt(1),
		Subject: pkix.Name{
			CommonName: domain,
		},
		DNSNames:  []string{domain},
		NotBefore: time.Now().Add(-1 * time.Hour),
		NotAfter:  time.Now().Add(24 * time.Hour),
		KeyUsage:  x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,
	}

	derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, &priv.PublicKey, priv)
	if err != nil {
		return nil, nil, err
	}

	certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: derBytes})
	privBytes, err := x509.MarshalECPrivateKey(priv)
	if err != nil {
		return nil, nil, err
	}
	keyPEM := pem.EncodeToMemory(&pem.Block{Type: "EC PRIVATE KEY", Bytes: privBytes})

	return certPEM, keyPEM, nil
}

func main() {
	var cache *certmagic.Cache
	var cfg *certmagic.Config

	tempDir, err := os.MkdirTemp("", "certmagic-sample-*")
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to create temp dir: %v\n", err)
		os.Exit(1)
	}
	defer os.RemoveAll(tempDir)

	// Configure CacheOptions
	opts := certmagic.CacheOptions{
		GetConfigForCert: func(cert certmagic.Certificate) (*certmagic.Config, error) {
			return cfg, nil
		},
		OCSPCheckInterval:  30 * time.Minute,
		RenewCheckInterval: 1 * time.Hour,
		Capacity:           50,
		Logger:             zap.NewNop(),
	}

	cache = certmagic.NewCache(opts)
	defer cache.Stop()

	cfg = certmagic.New(cache, certmagic.Config{
		Storage: &certmagic.FileStorage{Path: filepath.Join(tempDir, "storage")},
		Logger:  zap.NewNop(),
	})

	certPEM, keyPEM, err := generateSelfSignedCert("example.com")
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to generate cert: %v\n", err)
		os.Exit(1)
	}

	ctx := context.Background()
	hash, err := cfg.CacheUnmanagedCertificatePEMBytes(ctx, certPEM, keyPEM, []string{"example.com"})
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to cache cert: %v\n", err)
		os.Exit(1)
	}

	certs := cache.AllMatchingCertificates("example.com")
	fmt.Printf("Successfully cached cert (hash=%s), matching count=%d\n", hash, len(certs))
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/caddyserver/certmagic.CacheOptions in pkg:golang/github.com/caddyserver/certmagic@v0.23.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/caddyserver/certmagic@v0.23.0"
  ],
  "symbols": [
    "github.com/caddyserver/certmagic.CacheOptions"
  ]
}

package test

import (
	"context"
	"crypto/ecdsa"
	"crypto/elliptic"
	"crypto/rand"
	"crypto/x509"
	"crypto/x509/pkix"
	"encoding/pem"
	"fmt"
	"math/big"
	"path/filepath"
	"testing"
	"time"

	"github.com/caddyserver/certmagic"
	"go.uber.org/zap"
)

func generateTestCertPEM(domain string) ([]byte, []byte, error) {
	priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
	if err != nil {
		return nil, nil, err
	}

	template := x509.Certificate{
		SerialNumber: big.NewInt(1),
		Subject: pkix.Name{
			CommonName: domain,
		},
		DNSNames:  []string{domain},
		NotBefore: time.Now().Add(-1 * time.Hour),
		NotAfter:  time.Now().Add(24 * time.Hour),
		KeyUsage:  x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,
	}

	derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, &priv.PublicKey, priv)
	if err != nil {
		return nil, nil, err
	}

	certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: derBytes})
	privBytes, err := x509.MarshalECPrivateKey(priv)
	if err != nil {
		return nil, nil, err
	}
	keyPEM := pem.EncodeToMemory(&pem.Block{Type: "EC PRIVATE KEY", Bytes: privBytes})

	return certPEM, keyPEM, nil
}

func TestNewCachePanicsWithoutGetConfigForCert(t *testing.T) {
	// Assertion 1: certmagic.NewCache panics if CacheOptions.GetConfigForCert is nil.
	defer func() {
		r := recover()
		if r == nil {
			t.Fatal("expected NewCache to panic when GetConfigForCert is nil, but it did not")
		}
	}()

	emptyOpts := certmagic.CacheOptions{
		GetConfigForCert: nil,
	}
	_ = certmagic.NewCache(emptyOpts)
}

func TestNewCacheAndSetOptions(t *testing.T) {
	// Assertion 2: certmagic.NewCache initializes an active Cache when valid CacheOptions (GetConfigForCert, Capacity, intervals) are provided.
	var cfg *certmagic.Config

	opts := certmagic.CacheOptions{
		GetConfigForCert: func(cert certmagic.Certificate) (*certmagic.Config, error) {
			return cfg, nil
		},
		OCSPCheckInterval:  15 * time.Minute,
		RenewCheckInterval: 30 * time.Minute,
		Capacity:           10,
		Logger:             zap.NewNop(),
	}

	cache := certmagic.NewCache(opts)
	if cache == nil {
		t.Fatal("expected NewCache to return a non-nil Cache")
	}
	defer cache.Stop()

	// Assertion 3: Cache.SetOptions dynamically updates CacheOptions on an existing cache.
	newOpts := certmagic.CacheOptions{
		GetConfigForCert: func(cert certmagic.Certificate) (*certmagic.Config, error) {
			return cfg, nil
		},
		OCSPCheckInterval:  45 * time.Minute,
		RenewCheckInterval: 90 * time.Minute,
		Capacity:           25,
		Logger:             zap.NewNop(),
	}
	cache.SetOptions(newOpts)
}

func TestCacheIntegrationWithConfig(t *testing.T) {
	// Assertion 4: Cache created with CacheOptions stores certificates via Config and retrieves them via Cache.AllMatchingCertificates.
	var cache *certmagic.Cache
	var cfg *certmagic.Config

	opts := certmagic.CacheOptions{
		GetConfigForCert: func(cert certmagic.Certificate) (*certmagic.Config, error) {
			return cfg, nil
		},
		OCSPCheckInterval:  1 * time.Hour,
		RenewCheckInterval: 2 * time.Hour,
		Capacity:           5,
		Logger:             zap.NewNop(),
	}

	cache = certmagic.NewCache(opts)
	defer cache.Stop()

	storageDir := t.TempDir()
	cfg = certmagic.New(cache, certmagic.Config{
		Storage: &certmagic.FileStorage{Path: filepath.Join(storageDir, "storage")},
		Logger:  zap.NewNop(),
	})

	domain := "example.com"
	certPEM, keyPEM, err := generateTestCertPEM(domain)
	if err != nil {
		t.Fatalf("failed to generate test cert: %v", err)
	}

	ctx := context.Background()
	hash, err := cfg.CacheUnmanagedCertificatePEMBytes(ctx, certPEM, keyPEM, []string{domain})
	if err != nil {
		t.Fatalf("CacheUnmanagedCertificatePEMBytes failed: %v", err)
	}
	if hash == "" {
		t.Fatal("expected non-empty certificate hash")
	}

	matched := cache.AllMatchingCertificates(domain)
	if len(matched) != 1 {
		t.Fatalf("expected 1 matching certificate for %s, got %d", domain, len(matched))
	}
	if len(matched[0].Names) == 0 || matched[0].Names[0] != domain {
		t.Errorf("expected certificate domain %s, got %v", domain, matched[0].Names)
	}

	// Remove certificate from cache
	cache.Remove([]string{hash})
	matchedAfterRemove := cache.AllMatchingCertificates(domain)
	if len(matchedAfterRemove) != 0 {
		t.Errorf("expected 0 matching certificates after Remove, got %d", len(matchedAfterRemove))
	}
}

func TestCacheCapacityLimiting(t *testing.T) {
	// Assertion 5: CacheOptions.Capacity restricts the maximum number of cached certificates.
	var cache *certmagic.Cache
	var cfg *certmagic.Config

	capacity := 3
	opts := certmagic.CacheOptions{
		GetConfigForCert: func(cert certmagic.Certificate) (*certmagic.Config, error) {
			return cfg, nil
		},
		Capacity: capacity,
		Logger:   zap.NewNop(),
	}

	cache = certmagic.NewCache(opts)
	defer cache.Stop()

	storageDir := t.TempDir()
	cfg = certmagic.New(cache, certmagic.Config{
		Storage: &certmagic.FileStorage{Path: filepath.Join(storageDir, "storage")},
		Logger:  zap.NewNop(),
	})

	ctx := context.Background()
	for i := 1; i <= 5; i++ {
		domain := fmt.Sprintf("sub%d.example.com", i)
		certPEM, keyPEM, err := generateTestCertPEM(domain)
		if err != nil {
			t.Fatalf("failed to generate test cert: %v", err)
		}
		_, err = cfg.CacheUnmanagedCertificatePEMBytes(ctx, certPEM, keyPEM, []string{domain})
		if err != nil {
			t.Fatalf("failed to cache cert for %s: %v", domain, err)
		}
	}

	// Verify total count across all domains does not exceed capacity
	totalCached := 0
	for i := 1; i <= 5; i++ {
		domain := fmt.Sprintf("sub%d.example.com", i)
		totalCached += len(cache.AllMatchingCertificates(domain))
	}
	if totalCached > capacity {
		t.Errorf("cached certs count %d exceeded capacity %d", totalCached, capacity)
	}
}