mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-12 18:18:51 +00:00
ece15cb457
Closes Top-10 fix #2 of the 2026-05-03 issuer-coverage audit (see cowork/issuer-coverage-audit-2026-05-03/RESULTS.md). Pre-fix, vault.Config.Token and digicert.Config.APIKey were plain string fields. Practical impact: 1. GET /api/v1/issuers responses marshalled the credential into the JSON body. An acquirer's procurement engineer running 'curl /api/v1/issuers | jq' saw the token / API key in plain text on screen. 2. DEBUG-level HTTP request logging printed the credential header verbatim. 3. A heap dump of the running server contained the credential as readable bytes for the lifetime of the process. Bundle I from the 2026-05-01 audit closed this for AWSACMPCA, EJBCA, GlobalSign, Sectigo (Phase 1+2). Vault and DigiCert were left out. This commit ports the same migration onto them. Mechanics: - Config.Token / Config.APIKey type changed from 'string' to '*secret.Ref'. UnmarshalJSON of a JSON string populates the Ref via NewRefFromString — operator config files are unchanged. - Every header-write call site routed through Ref.Use, with the byte buffer zeroed after the callback returns. Vault: 3 sites (IssueCertificate, RevokeCertificate, GetCACertPEM). DigiCert: 5 sites (ValidateConfig, IssueCertificate, RevokeCertificate, pollOrderOnce, downloadCertificate). - ValidateConfig nil-checks switch from 'cfg.Token == ""' to 'cfg.Token.IsEmpty()' (mirrors Sectigo's existing pattern). - Tests migrated: every Config{Token:"..."} → Config{Token: secret.NewRefFromString("...")}. The 'json.Marshal(config) → ValidateConfig(rawConfig)' round-trip pattern in DigiCert's ValidateConfig_Success test is now broken by the redact-on-marshal contract — switched that one to construct the rawConfig as a JSON literal (mirrors Sectigo's existing test pattern). - Two new tests pin the redact-on-marshal contract: - TestVault_Config_TokenMarshalsAsRedacted (vault_redact_test.go) - TestDigiCert_Config_APIKeyMarshalsAsRedacted (digicert_redact_test.go) Both assert the marshaled JSON contains '"[redacted]"' and does NOT contain the plaintext bytes. Operator-visible: GET /api/v1/issuers responses for type=vault and type=digicert now show the credential as '[redacted]'. Existing config files keep working — the Ref unmarshal accepts strings. CHANGELOG note: certctl/CHANGELOG.md is intentionally not hand-edited; release notes are auto-generated from commit messages between consecutive tags. This commit's message body is the release-note artifact. Verified locally: - gofmt clean across the repo. - go vet ./... clean across the repo. - go test -race -count=1 -short ./internal/connector/issuer/vault/... ./internal/connector/issuer/digicert/... ./internal/secret/... green. Audit reference: cowork/issuer-coverage-audit-2026-05-03/ RESULTS.md Top-10 fix #2.
174 lines
5.7 KiB
Go
174 lines
5.7 KiB
Go
package digicert_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/shankar0123/certctl/internal/connector/issuer/digicert"
|
|
"github.com/shankar0123/certctl/internal/secret"
|
|
)
|
|
|
|
// Bundle N.A/B-extended: digicert failure-mode round-out (81.0% → ≥85%).
|
|
// Targets GetOrderStatus / downloadCertificate / parsePEMBundle uncovered
|
|
// branches.
|
|
|
|
func buildDigicertConnector(t *testing.T, baseURL string) *digicert.Connector {
|
|
t.Helper()
|
|
c := digicert.New(nil, slog.Default())
|
|
// PollMaxWaitSeconds=1 keeps async-pending tests fast — pending
|
|
// status returns within ~1s instead of the 10-minute production
|
|
// default. Tests that exercise issued/failed/parse-error paths
|
|
// don't block on the wait.
|
|
cfg := digicert.Config{APIKey: secret.NewRefFromString("k"), OrgID: "1", ProductType: "ssl_basic", BaseURL: baseURL, PollMaxWaitSeconds: 1}
|
|
raw, _ := json.Marshal(cfg)
|
|
if err := c.ValidateConfig(context.Background(), raw); err != nil {
|
|
t.Fatalf("ValidateConfig: %v", err)
|
|
}
|
|
return c
|
|
}
|
|
|
|
func TestDigicert_GetOrderStatus_404_ReturnsError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
switch r.URL.Path {
|
|
case "/user/me":
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id":1}`))
|
|
default:
|
|
w.WriteHeader(http.StatusNotFound)
|
|
_, _ = w.Write([]byte(`{"errors":[{"code":"order_not_found"}]}`))
|
|
}
|
|
}))
|
|
defer srv.Close()
|
|
c := buildDigicertConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "missing-order")
|
|
if err == nil || !strings.Contains(err.Error(), "404") {
|
|
t.Errorf("expected 404 error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestDigicert_GetOrderStatus_MalformedJSON_ReturnsError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
switch r.URL.Path {
|
|
case "/user/me":
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id":1}`))
|
|
default:
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{not valid json`))
|
|
}
|
|
}))
|
|
defer srv.Close()
|
|
c := buildDigicertConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "bad-order")
|
|
if err == nil || !strings.Contains(err.Error(), "parse") {
|
|
t.Errorf("expected parse error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestDigicert_GetOrderStatus_IssuedButCertIDMissing(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
switch r.URL.Path {
|
|
case "/user/me":
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id":1}`))
|
|
default:
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"status":"issued","certificate":{"id":0}}`))
|
|
}
|
|
}))
|
|
defer srv.Close()
|
|
c := buildDigicertConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "issued-no-cert-id")
|
|
if err == nil || !strings.Contains(err.Error(), "certificate_id is missing") {
|
|
t.Errorf("expected 'certificate_id is missing' error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestDigicert_GetOrderStatus_PendingProcessingDeniedUnknown(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
status string
|
|
wantStatus string
|
|
}{
|
|
{"pending", "pending", "pending"},
|
|
{"processing", "processing", "pending"},
|
|
{"rejected", "rejected", "failed"},
|
|
{"denied", "denied", "failed"},
|
|
{"unknown", "frobnicating", "pending"},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
switch r.URL.Path {
|
|
case "/user/me":
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id":1}`))
|
|
default:
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"status":"` + tc.status + `"}`))
|
|
}
|
|
}))
|
|
defer srv.Close()
|
|
c := buildDigicertConnector(t, srv.URL)
|
|
st, err := c.GetOrderStatus(context.Background(), "order-x")
|
|
if err != nil {
|
|
t.Fatalf("GetOrderStatus: %v", err)
|
|
}
|
|
if st.Status != tc.wantStatus {
|
|
t.Errorf("expected status=%q for input=%q, got %q", tc.wantStatus, tc.status, st.Status)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestDigicert_DownloadCertificate_Non200_ReturnsError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
switch {
|
|
case r.URL.Path == "/user/me":
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id":1}`))
|
|
case strings.Contains(r.URL.Path, "/certificate/"):
|
|
w.WriteHeader(http.StatusForbidden)
|
|
_, _ = w.Write([]byte(`{"errors":[{"code":"forbidden"}]}`))
|
|
default:
|
|
// /order/certificate/<id> returns issued with cert_id 7
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"status":"issued","certificate":{"id":7}}`))
|
|
}
|
|
}))
|
|
defer srv.Close()
|
|
c := buildDigicertConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "order-y")
|
|
if err == nil || !strings.Contains(err.Error(), "403") {
|
|
t.Errorf("expected 403 download error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestDigicert_DownloadCertificate_MalformedPEM_ReturnsError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
switch {
|
|
case r.URL.Path == "/user/me":
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id":1}`))
|
|
case strings.Contains(r.URL.Path, "/certificate/") && strings.Contains(r.URL.Path, "/download/"):
|
|
// Returns junk that won't decode as PEM
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte("not a pem bundle"))
|
|
default:
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"status":"issued","certificate":{"id":42}}`))
|
|
}
|
|
}))
|
|
defer srv.Close()
|
|
c := buildDigicertConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "order-z")
|
|
if err == nil {
|
|
t.Errorf("expected error from malformed PEM bundle, got nil")
|
|
}
|
|
}
|