mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 16:41:36 +00:00
ec88a61274
First slice of the RFC 8555 ACME server endpoint (master plan at cowork/acme-server-endpoint-prompt.md, per-phase prompts at cowork/acme-server-prompts/). This commit lands the smallest viable end-to-end deployable slice: an ACME client running curl -sk https://certctl/acme/profile/<id>/directory curl -sk -I https://certctl/acme/profile/<id>/new-nonce successfully fetches the directory document and a Replay-Nonce. Account creation, JWS verification, orders, challenges, and revocation are all out of scope for this phase and arrive in Phases 1b–4. Closes the Rank 1 LHF from the 2026-05-03 Infisical deep-research (cowork/infisical-deep-research-results.md). Pre-fix, certctl was an ACME consumer only — no /acme/directory endpoint, no JWS verifier, no challenge validators. K8s customers running cert-manager could not point at certctl as an ACME issuer; they had to deploy a certctl agent on every node. What ships: - internal/api/acme/{directory,nonce,errors}.go (+ tests). - internal/api/handler/acme.go + acme_handler_test.go. - internal/repository/postgres/acme.go (nonce ops only — Phase 1b extends with account CRUD; Phases 2-4 extend with order / authz / challenge CRUD). - internal/service/acme.go (BuildDirectory + IssueNonce stubs; Phase 1b adds VerifyJWS / NewAccount / etc.). - migrations/000025_acme_server.{up,down}.sql ships the full 5-table ACME schema (acme_accounts / acme_orders / acme_authorizations / acme_challenges / acme_nonces) PLUS the per-profile certificate_profiles.acme_auth_mode column. Phase 1a actively uses only acme_nonces; remaining tables are empty until Phases 1b-4 plug in. - internal/config/config.go: ACMEServerConfig struct + ACMEServer field on Config. Env vars use CERTCTL_ACME_SERVER_* prefix to avoid colliding with the existing consumer-side ACMEConfig at config.go:1746 (CERTCTL_ACME_DIRECTORY_URL / PROFILE / CHALLENGE_TYPE etc.). Phase 1a wires Enabled + DefaultAuthMode + DefaultProfileID + NonceTTL + DirectoryMeta; Order/Authz TTLs + per-challenge-type concurrency caps + DNS01 resolver are reserved fields parsed in 1a so operators can set them ahead of Phases 2/3. - cmd/server/main.go: wire ACMEHandler into the HandlerRegistry literal alongside the existing certificate / EST / SCEP / etc. handlers. - internal/api/router/router.go: HandlerRegistry.ACME field + 6 Register calls (3 per-profile + 3 shorthand). - internal/api/router/openapi_parity_test.go: 6 new entries in SpecParityExceptions. ACME is a wire-protocol surface (JWS-signed JSON over HTTPS per RFC 7515) whose semantics are dictated by RFC 8555 + RFC 9773 rather than by an OpenAPI document, same precedent as SCEP/EST. The canonical reference is docs/acme-server.md. - docs/acme-server.md: Phase-1a-shaped reference. Configuration table for every CERTCTL_ACME_SERVER_* env var. Per-profile auth-mode decision tree skeleton. TLS trust bootstrap section flagging cert-manager's ClusterIssuer.spec.acme.caBundle requirement (the single biggest first-time-deploy footgun; the full cert-manager walkthrough lands in Phase 6 but the requirement is documented up front). Architecture decisions baked in: - URL family is /acme/profile/<id>/* (per-profile, canonical) with /acme/* shorthand active when CERTCTL_ACME_SERVER_DEFAULT_PROFILE_ID is set. Path matches existing per-profile precedent in EST + SCEP. - Auth mode is per-profile (acme_auth_mode column on certificate_profiles), NOT server-wide. One certctl-server can serve trust_authenticated for an internal-PKI profile and challenge for a public-trust-style profile simultaneously. The column is read at request time, not cached at server start — operators flipping a profile's mode via SQL take effect on the next order without restart. - Nonces are DB-backed (acme_nonces table). Survive server restart. The RFC 8555 §6.5 replay defense requires the store to outlast the client's nonce caching window; an in-memory-only nonce store would lose every in-flight order on restart. - Per-op atomic counters on service.ACMEService.Metrics() — certctl_acme_directory_total, certctl_acme_directory_failures_total, certctl_acme_new_nonce_total, certctl_acme_new_nonce_failures_total. Naming follows certctl frozen decision 0.10 cardinality discipline. Phase 1b will extend with new_account counters; Phase 2 with order / finalize / cert; Phase 3 with per-challenge-type counters. Audit fixes #11 + #12 (cowork/acme-server-prompts/audit-additions.md) applied: - #11: CERTCTL_ACME_SERVER_* prefix avoids the consumer-side CERTCTL_ACME_* namespace collision. - #12: prior-attempt WIP from two failed Phase-1 dispatches was discarded at phase start; this commit starts from a clean tree. Tests: - 14 unit tests in internal/api/acme/ (directory, nonce, errors). - 7 handler-level tests via httptest.NewServer + mockACMEService (mirrors the mockSCEPService pattern at scep_handler_test.go). - 7 service-layer tests with mocked repo + injected profileLookup. - All pass under -race -count=1 -short. Deferred to Phase 1b: - JWS verification (go-jose v4 — see master-prompt §8a for the API surface and audit doc for the speculation pitfalls). - new-account / account/<id> endpoints + AccountService. - Nonce *consumption* path (issue path is in this commit; consume is only invoked by JWS-verified POSTs which Phase 1b adds). Engineering history: cowork/WORKSPACE-CHANGELOG.md "ACME-Server-1a". Per-phase implementation plan: cowork/acme-server-prompts/. Master plan + audit fixes: cowork/acme-server-endpoint-prompt.md + cowork/acme-server-prompt-audit.md + cowork/acme-server-prompts/audit-additions.md.
114 lines
3.8 KiB
Go
114 lines
3.8 KiB
Go
// Copyright (c) certctl
|
|
// SPDX-License-Identifier: BSL-1.1
|
|
|
|
package acme
|
|
|
|
import (
|
|
"encoding/json"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
func TestBuildDirectory_FullMeta(t *testing.T) {
|
|
d := BuildDirectory(
|
|
"https://server/acme/profile/prof-corp",
|
|
"https://example.com/tos",
|
|
"https://example.com",
|
|
[]string{"example.com"},
|
|
true,
|
|
false,
|
|
)
|
|
if got, want := d.NewNonce, "https://server/acme/profile/prof-corp/new-nonce"; got != want {
|
|
t.Errorf("NewNonce = %q, want %q", got, want)
|
|
}
|
|
if got, want := d.NewAccount, "https://server/acme/profile/prof-corp/new-account"; got != want {
|
|
t.Errorf("NewAccount = %q, want %q", got, want)
|
|
}
|
|
if got, want := d.NewOrder, "https://server/acme/profile/prof-corp/new-order"; got != want {
|
|
t.Errorf("NewOrder = %q, want %q", got, want)
|
|
}
|
|
if got, want := d.RevokeCert, "https://server/acme/profile/prof-corp/revoke-cert"; got != want {
|
|
t.Errorf("RevokeCert = %q, want %q", got, want)
|
|
}
|
|
if got, want := d.KeyChange, "https://server/acme/profile/prof-corp/key-change"; got != want {
|
|
t.Errorf("KeyChange = %q, want %q", got, want)
|
|
}
|
|
if d.RenewalInfo != "" {
|
|
t.Errorf("RenewalInfo should be empty when ariEnabled=false; got %q", d.RenewalInfo)
|
|
}
|
|
if d.Meta == nil {
|
|
t.Fatal("Meta should be populated when any meta field is set")
|
|
}
|
|
if d.Meta.TermsOfService != "https://example.com/tos" {
|
|
t.Errorf("TermsOfService = %q", d.Meta.TermsOfService)
|
|
}
|
|
if d.Meta.Website != "https://example.com" {
|
|
t.Errorf("Website = %q", d.Meta.Website)
|
|
}
|
|
if !d.Meta.ExternalAccountRequired {
|
|
t.Error("ExternalAccountRequired should be true")
|
|
}
|
|
if len(d.Meta.CAAIdentities) != 1 || d.Meta.CAAIdentities[0] != "example.com" {
|
|
t.Errorf("CAAIdentities = %v", d.Meta.CAAIdentities)
|
|
}
|
|
}
|
|
|
|
func TestBuildDirectory_NoMeta(t *testing.T) {
|
|
d := BuildDirectory("https://server/acme/profile/prof-corp", "", "", nil, false, false)
|
|
if d.Meta != nil {
|
|
t.Errorf("Meta should be nil when all meta fields zero; got %+v", d.Meta)
|
|
}
|
|
}
|
|
|
|
func TestBuildDirectory_EABRequiredOnly(t *testing.T) {
|
|
d := BuildDirectory("https://server/acme/profile/prof-corp", "", "", nil, true, false)
|
|
if d.Meta == nil {
|
|
t.Fatal("Meta should be populated when EAB is required")
|
|
}
|
|
if !d.Meta.ExternalAccountRequired {
|
|
t.Error("ExternalAccountRequired should be true")
|
|
}
|
|
if d.Meta.TermsOfService != "" || d.Meta.Website != "" || len(d.Meta.CAAIdentities) != 0 {
|
|
t.Errorf("only EAB should be set; meta = %+v", d.Meta)
|
|
}
|
|
}
|
|
|
|
func TestBuildDirectory_ARIEnabled(t *testing.T) {
|
|
d := BuildDirectory("https://server/acme/profile/prof-corp", "", "", nil, false, true)
|
|
if d.RenewalInfo == "" {
|
|
t.Fatal("RenewalInfo should be populated when ariEnabled=true")
|
|
}
|
|
if !strings.HasSuffix(d.RenewalInfo, "/renewal-info") {
|
|
t.Errorf("RenewalInfo = %q; expected suffix /renewal-info", d.RenewalInfo)
|
|
}
|
|
}
|
|
|
|
func TestBuildDirectory_JSONShape(t *testing.T) {
|
|
// RFC 8555 §7.1.1 dictates the JSON field names. A regression here
|
|
// would break every ACME client.
|
|
d := BuildDirectory("https://server/acme/profile/prof-corp", "", "", nil, false, false)
|
|
b, err := json.Marshal(d)
|
|
if err != nil {
|
|
t.Fatalf("Marshal: %v", err)
|
|
}
|
|
got := string(b)
|
|
for _, want := range []string{
|
|
`"newNonce":"https://server/acme/profile/prof-corp/new-nonce"`,
|
|
`"newAccount":"https://server/acme/profile/prof-corp/new-account"`,
|
|
`"newOrder":"https://server/acme/profile/prof-corp/new-order"`,
|
|
`"revokeCert":"https://server/acme/profile/prof-corp/revoke-cert"`,
|
|
`"keyChange":"https://server/acme/profile/prof-corp/key-change"`,
|
|
} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("JSON missing %q\nGot: %s", want, got)
|
|
}
|
|
}
|
|
// renewalInfo + meta should be omitted.
|
|
if strings.Contains(got, "renewalInfo") {
|
|
t.Errorf("renewalInfo should be omitted when ARI disabled; got %s", got)
|
|
}
|
|
if strings.Contains(got, `"meta"`) {
|
|
t.Errorf("meta should be omitted when no fields set; got %s", got)
|
|
}
|
|
}
|