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

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.StorageKeys 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.StorageKeys

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:46e384045846d33d9550ad5c01e3ca7ef5bfb0fa931c1dea156bdd9b4374d328","contract":["certmagic.StorageKeys.Safe standardizes string components by lowercasing, replacing special characters like wildcards, colons, plus signs and spaces, and preventing path traversal","certmagic.StorageKeys.CertsPrefix generates deterministic certificate directory prefixes per issuer key","certmagic.StorageKeys.CertsSitePrefix constructs hierarchical storage prefixes combining issuer and sanitized domain names","certmagic.StorageKeys.SiteCert constructs storage paths for site certificate (.crt) files","certmagic.StorageKeys.SitePrivateKey constructs storage paths for site private key (.key) files","certmagic.StorageKeys.SiteMeta constructs storage paths for site metadata (.json) files","certmagic.StorageKeys.OCSPStaple generates deterministic OCSP cache keys based on certificate SANs and PEM bundle hashes"],"goal":"verify github.com/caddyserver/certmagic.StorageKeys 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.StorageKeys"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"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.StorageKeys"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.26.6

require github.com/caddyserver/certmagic v0.25.4

require (
	github.com/caddyserver/zerossl v0.1.5 // indirect
	github.com/klauspost/cpuid/v2 v2.3.0 // indirect
	github.com/libdns/libdns v1.1.1 // indirect
	github.com/mholt/acmez/v3 v3.1.6 // indirect
	github.com/miekg/dns v1.1.72 // indirect
	github.com/zeebo/blake3 v0.2.4 // indirect
	go.uber.org/multierr v1.11.0 // indirect
	go.uber.org/zap v1.27.1 // indirect
	go.uber.org/zap/exp v0.3.0 // indirect
	golang.org/x/crypto v0.50.0 // indirect
	golang.org/x/mod v0.35.0 // indirect
	golang.org/x/net v0.53.0 // indirect
	golang.org/x/sync v0.20.0 // indirect
	golang.org/x/sys v0.43.0 // indirect
	golang.org/x/text v0.36.0 // indirect
	golang.org/x/tools v0.44.0 // indirect
)

code.pfad.fr/check v1.1.0 h1:GWvjdzhSEgHvEHe2uJujDcpmZoySKuHQNrZMfzfO0bE=
code.pfad.fr/check v1.1.0/go.mod h1:NiUH13DtYsb7xp5wll0U4SXx7KhXQVCtRgdC96IPfoM=
github.com/caddyserver/certmagic v0.25.4 h1:8eIXh0HC3MsGnNo8One+BCxMGTbe5zb/oz+2KsxBFQg=
github.com/caddyserver/certmagic v0.25.4/go.mod h1:YVs43D5+H/Dckt4bTga1KSO/xYfFBfVZainGDywYPAA=
github.com/caddyserver/zerossl v0.1.5 h1:dkvOjBAEEtY6LIGAHei7sw2UgqSD6TrWweXpV7lvEvE=
github.com/caddyserver/zerossl v0.1.5/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/go-jose/go-jose/v4 v4.1.3 h1:CVLmWDhDVRa6Mi/IgCgaopNosCaHz7zrMeF9MlZRkrs=
github.com/go-jose/go-jose/v4 v4.1.3/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08=
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.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y=
github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0=
github.com/letsencrypt/challtestsrv v1.4.2 h1:0ON3ldMhZyWlfVNYYpFuWRTmZNnyfiL9Hh5YzC3JVwU=
github.com/letsencrypt/challtestsrv v1.4.2/go.mod h1:GhqMqcSoeGpYd5zX5TgwA6er/1MbWzx/o7yuuVya+Wk=
github.com/letsencrypt/pebble/v2 v2.10.0 h1:Wq6gYXlsY6ubqI3hhxsTzdyotvfdjFBxuwYqCLCnj/U=
github.com/letsencrypt/pebble/v2 v2.10.0/go.mod h1:Sk8cmUIPcIdv2nINo+9PB4L+ZBhzY+F9A1a/h/xmWiQ=
github.com/libdns/libdns v1.1.1 h1:wPrHrXILoSHKWJKGd0EiAVmiJbFShguILTg9leS/P/U=
github.com/libdns/libdns v1.1.1/go.mod h1:4Bj9+5CQiNMVGf87wjX4CY3HQJypUHRuLvlsfsZqLWQ=
github.com/mholt/acmez/v3 v3.1.6 h1:eGVQNObP0pBN4sxqrXeg7MYqTOWyoiYpQqITVWlrevk=
github.com/mholt/acmez/v3 v3.1.6/go.mod h1:5nTPosTGosLxF3+LU4ygbgMRFDhbAVpqMI4+a4aHLBY=
github.com/miekg/dns v1.1.72 h1:vhmr+TF2A3tuoGNkLDFK9zi36F2LS+hKTRW0Uf8kbzI=
github.com/miekg/dns v1.1.72/go.mod h1:+EuEPhdHOsfk6Wk5TT2CzssZdqkmFhf8r+aVyDEToIs=
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.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc=
go.uber.org/zap v1.27.1/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.50.0 h1:zO47/JPrL6vsNkINmLoo/PH1gcxpls50DNogFvB5ZGI=
golang.org/x/crypto v0.50.0/go.mod h1:3muZ7vA7PBCE6xgPX7nkzzjiUq87kRItoJQM1Yo8S+Q=
golang.org/x/mod v0.35.0 h1:Ww1D637e6Pg+Zb2KrWfHQUnH2dQRLBQyAtpr/haaJeM=
golang.org/x/mod v0.35.0/go.mod h1:+GwiRhIInF8wPm+4AoT6L0FA1QWAad3OMdTRx4tFYlU=
golang.org/x/net v0.53.0 h1:d+qAbo5L0orcWAr0a9JweQpjXF19LMXJE8Ey7hwOdUA=
golang.org/x/net v0.53.0/go.mod h1:JvMuJH7rrdiCfbeHoo3fCQU24Lf5JJwT9W3sJFulfgs=
golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4=
golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/text v0.36.0 h1:JfKh3XmcRPqZPKevfXVpI1wXPTqbkE5f7JA92a55Yxg=
golang.org/x/text v0.36.0/go.mod h1:NIdBknypM8iqVmPiuco0Dh6P5Jcdk8lJL0CUebqK164=
golang.org/x/tools v0.44.0 h1:UP4ajHPIcuMjT1GqzDWRlalUEoY+uzoZKnhOjbIPD2c=
golang.org/x/tools v0.44.0/go.mod h1:KA0AfVErSdxRZIsOVipbv3rQhVXTnlU6UhKxHd1seDI=
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 (
	"fmt"

	"github.com/caddyserver/certmagic"
)

func main() {
	issuerKey := "acme-v02.api.letsencrypt.org-directory"
	domain := "*.example.com"

	// 1. Sanitize storage keys
	safeName := certmagic.StorageKeys.Safe(domain)
	fmt.Printf("Sanitized domain key: %s\n", safeName)

	// 2. Derive storage path hierarchy
	certsPrefix := certmagic.StorageKeys.CertsPrefix(issuerKey)
	sitePrefix := certmagic.StorageKeys.CertsSitePrefix(issuerKey, domain)
	fmt.Printf("Issuer certs prefix: %s\n", certsPrefix)
	fmt.Printf("Site storage prefix: %s\n", sitePrefix)

	// 3. Derive file-level storage keys for cert, key, and metadata
	certPath := certmagic.StorageKeys.SiteCert(issuerKey, domain)
	keyPath := certmagic.StorageKeys.SitePrivateKey(issuerKey, domain)
	metaPath := certmagic.StorageKeys.SiteMeta(issuerKey, domain)
	fmt.Printf("Site certificate path: %s\n", certPath)
	fmt.Printf("Site private key path:  %s\n", keyPath)
	fmt.Printf("Site metadata path:     %s\n", metaPath)

	// 4. Derive OCSP staple storage key
	cert := &certmagic.Certificate{
		Names: []string{"example.com"},
	}
	ocspKey := certmagic.StorageKeys.OCSPStaple(cert, []byte("certificate-pem-data"))
	fmt.Printf("OCSP staple cache key:  %s\n", ocspKey)
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/caddyserver/certmagic.StorageKeys 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.StorageKeys"
  ]
}

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/caddyserver/certmagic"
)

func main() {
	// 1. certmagic.StorageKeys.Safe standardizes string components by lowercasing, replacing special characters like wildcards, colons, plus signs and spaces, and preventing path traversal
	cases := []struct {
		input    string
		expected string
	}{
		{"example.com", "example.com"},
		{"EXAMPLE.COM", "example.com"},
		{"*.example.com", "wildcard_.example.com"},
		{"ca:prod+1", "ca-prod_plus_1"},
		{"hello world", "hello_world"},
		{"a/../../../foo", "afoo"},
		{"b\\..\\..\\..\\foo", "bfoo"},
		{"c/foo", "cfoo"},
		{"user@example.com", "user@example.com"},
	}
	for _, tc := range cases {
		actual := certmagic.StorageKeys.Safe(tc.input)
		if actual != tc.expected {
			fmt.Fprintf(os.Stderr, "StorageKeys.Safe(%q) = %q, expected %q\n", tc.input, actual, tc.expected)
			os.Exit(1)
		}
	}

	// 2. certmagic.StorageKeys.CertsPrefix generates deterministic certificate directory prefixes per issuer key
	issuer := "acme-v02.api.letsencrypt.org-directory"
	certsPrefix := certmagic.StorageKeys.CertsPrefix(issuer)
	if certsPrefix != "certificates/acme-v02.api.letsencrypt.org-directory" {
		fmt.Fprintf(os.Stderr, "StorageKeys.CertsPrefix unexpected output: %s\n", certsPrefix)
		os.Exit(1)
	}

	// 3. certmagic.StorageKeys.CertsSitePrefix constructs hierarchical storage prefixes combining issuer and sanitized domain names
	sitePrefix := certmagic.StorageKeys.CertsSitePrefix(issuer, "*.example.com")
	if sitePrefix != "certificates/acme-v02.api.letsencrypt.org-directory/wildcard_.example.com" {
		fmt.Fprintf(os.Stderr, "StorageKeys.CertsSitePrefix unexpected output: %s\n", sitePrefix)
		os.Exit(1)
	}

	// 4. certmagic.StorageKeys.SiteCert constructs storage paths for site certificate (.crt) files
	siteCert := certmagic.StorageKeys.SiteCert(issuer, "example.com")
	if siteCert != "certificates/acme-v02.api.letsencrypt.org-directory/example.com/example.com.crt" {
		fmt.Fprintf(os.Stderr, "StorageKeys.SiteCert unexpected output: %s\n", siteCert)
		os.Exit(1)
	}

	wildcardCert := certmagic.StorageKeys.SiteCert(issuer, "*.example.com")
	if wildcardCert != "certificates/acme-v02.api.letsencrypt.org-directory/wildcard_.example.com/wildcard_.example.com.crt" {
		fmt.Fprintf(os.Stderr, "StorageKeys.SiteCert (wildcard) unexpected output: %s\n", wildcardCert)
		os.Exit(1)
	}

	// 5. certmagic.StorageKeys.SitePrivateKey constructs storage paths for site private key (.key) files
	siteKey := certmagic.StorageKeys.SitePrivateKey(issuer, "example.com")
	if siteKey != "certificates/acme-v02.api.letsencrypt.org-directory/example.com/example.com.key" {
		fmt.Fprintf(os.Stderr, "StorageKeys.SitePrivateKey unexpected output: %s\n", siteKey)
		os.Exit(1)
	}

	// 6. certmagic.StorageKeys.SiteMeta constructs storage paths for site metadata (.json) files
	siteMeta := certmagic.StorageKeys.SiteMeta(issuer, "example.com")
	if siteMeta != "certificates/acme-v02.api.letsencrypt.org-directory/example.com/example.com.json" {
		fmt.Fprintf(os.Stderr, "StorageKeys.SiteMeta unexpected output: %s\n", siteMeta)
		os.Exit(1)
	}

	// 7. certmagic.StorageKeys.OCSPStaple generates deterministic OCSP cache keys based on certificate SANs and PEM bundle hashes
	certWithNames := &certmagic.Certificate{
		Names: []string{"example.com", "www.example.com"},
	}
	rawPEM := []byte("dummy-pem-bundle-content")
	ocspKey := certmagic.StorageKeys.OCSPStaple(certWithNames, rawPEM)
	if !strings.HasPrefix(ocspKey, "ocsp/example.com-") {
		fmt.Fprintf(os.Stderr, "StorageKeys.OCSPStaple with names unexpected prefix: %s\n", ocspKey)
		os.Exit(1)
	}

	certWithoutNames := &certmagic.Certificate{
		Names: []string{},
	}
	ocspKeyNoName := certmagic.StorageKeys.OCSPStaple(certWithoutNames, rawPEM)
	if !strings.HasPrefix(ocspKeyNoName, "ocsp/") || strings.Contains(ocspKeyNoName, "-") {
		fmt.Fprintf(os.Stderr, "StorageKeys.OCSPStaple without names unexpected format: %s\n", ocspKeyNoName)
		os.Exit(1)
	}

	fmt.Println("All certmagic.StorageKeys contract assertions passed.")
}