Files
shankar0123 0509790325 asyncpoll: refactor Sectigo / Entrust / GlobalSign to bounded polling (Phase 2)
Phase 2 of the #5 acquisition-readiness fix from the 2026-05-01 issuer
coverage audit. Phase 1 (commit 711265b) shipped the shared asyncpoll
package and refactored DigiCert as the reference. This commit applies
the same pattern to the remaining three async-CA connectors and adds
the operator-facing docs.

Per-connector refactors:

- Sectigo (sectigo.go): GetOrderStatus now wraps pollEnrollmentOnce in
  asyncpoll.Poll. The collectNotReady sentinel (cert approved by SCM
  but not yet retrievable from the collect endpoint) maps to
  StillPending and rides the backoff schedule rather than the prior
  "return pending immediately" branch. Added isPermanentStatusError
  helper to distinguish transient HTTP errors (5xx / 429 / network)
  from permanent ones (4xx / parse failure) — the wrapped checkStatus
  errors get triaged at the poll closure boundary.

- Entrust (entrust.go): GetOrderStatus wraps pollEnrollmentOnce. The
  AWAITING_APPROVAL status maps to StillPending; operators using
  approval-pending workflows where humans approve enrollments should
  bump CERTCTL_ENTRUST_POLL_MAX_WAIT_SECONDS to 86400 (24h) so a
  single scheduler tick can wait through the approval window. The
  default 10-minute deadline matches the other three connectors.

- GlobalSign (globalsign.go): GetOrderStatus wraps pollCertificateOnce.
  GlobalSign tracks orders by serial number rather than order ID, but
  the polling shape is identical to the other three. Status-code
  triage matches DigiCert: 4xx (not 429) is permanent, 5xx / 429 /
  network is transient.

Per-connector Config field added:
- DigiCert.PollMaxWaitSeconds (env CERTCTL_DIGICERT_POLL_MAX_WAIT_SECONDS)
- Sectigo.PollMaxWaitSeconds (env CERTCTL_SECTIGO_POLL_MAX_WAIT_SECONDS)
- Entrust.PollMaxWaitSeconds (env CERTCTL_ENTRUST_POLL_MAX_WAIT_SECONDS)
- GlobalSign.PollMaxWaitSeconds (env CERTCTL_GLOBALSIGN_POLL_MAX_WAIT_SECONDS)

internal/config/config.go env-var loaders updated for all four. Default
is 600 seconds (10 minutes); zero falls back to the asyncpoll package
default.

Test-helper updates: every existing test that exercises the pending
branch (collectNotReady, AWAITING_APPROVAL, status="pending", etc.)
now sets PollMaxWaitSeconds=1 in its Config so the test doesn't block
on the production-default 10-minute deadline. Tests that exercise
permanent-error branches (404, 401, malformed JSON, etc.) continue
to return immediately.

Test sites updated:
- buildSectigoConnector helper + GetOrderStatus_CollectNotReady test
- buildEntrustConnector helper + GetOrderStatus_Pending test
- buildGlobalsignConnector helper + GetOrderStatus_Pending test +
  the GetHTTPClient_NoMTLSCertPaths test (network failure now rides
  the backoff schedule rather than returning immediately)

Documentation:
- docs/async-polling.md: new operator reference covering the backoff
  schedule, status-code triage, the four env vars, failure modes, and
  where the implementation lives. Audit blocker citation included.
- docs/connectors.md: per-issuer sections for DigiCert, Sectigo,
  Entrust, GlobalSign each gain the PollMaxWaitSeconds env var row
  and a cross-link to async-polling.md.

Lint cleanup: simplified the isPermanentStatusError branch to satisfy
staticcheck S1008 (single-line return for a final boolean check).

Verified locally:
- gofmt -l . clean
- go vet ./... clean
- staticcheck ./... clean
- golangci-lint run --timeout 5m ./... → 0 issues
- go test -short -count=1 across all 4 connector packages + config + asyncpoll: green

Audit reference: cowork/issuer-coverage-audit-2026-05-01/RESULTS.md
Top-10 fix #5 — Phase 2.
2026-05-02 02:41:36 +00:00

206 lines
8.3 KiB
Go

package entrust
import (
"context"
"crypto/tls"
"encoding/json"
"log/slog"
"net/http"
"net/http/httptest"
"strings"
"testing"
)
// Bundle N.A/B-extended: entrust failure-mode round-out (70.8% → ≥85%).
// Targets uncovered branches in ValidateConfig / GetOrderStatus /
// loadMTLSConfig / parseCertMetadata / mapRevocationReason.
//
// In-package (white-box) tests so we can exercise unexported helpers
// directly.
func buildEntrustConnector(t *testing.T, baseURL string) *Connector {
t.Helper()
cfg := &Config{
APIUrl: baseURL,
CAId: "test-ca-id",
PollMaxWaitSeconds: 1, // keep async-pending tests fast
}
httpClient := &http.Client{Transport: &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}} //nolint:gosec
return NewWithHTTPClient(cfg, slog.Default(), httpClient)
}
// ─────────────────────────────────────────────────────────────────────────────
// mapRevocationReason: every RFC 5280 reason string + nil + default
// ─────────────────────────────────────────────────────────────────────────────
func TestEntrust_MapRevocationReason_AllArms(t *testing.T) {
cases := []struct {
reason *string
expected string
}{
{nil, "Unspecified"},
{strPtr(""), "Unspecified"},
{strPtr("unspecified"), "Unspecified"},
{strPtr("keyCompromise"), "KeyCompromise"},
{strPtr("caCompromise"), "CACompromise"},
{strPtr("affiliationChanged"), "AffiliationChanged"},
{strPtr("superseded"), "Superseded"},
{strPtr("cessationOfOperation"), "CessationOfOperation"},
{strPtr("certificateHold"), "CertificateHold"},
{strPtr("privilegeWithdrawn"), "PrivilegeWithdrawn"},
{strPtr("frobnicated"), "Unspecified"}, // unknown → default
}
for _, tc := range cases {
name := "nil"
if tc.reason != nil {
name = *tc.reason
if name == "" {
name = "empty"
}
}
t.Run(name, func(t *testing.T) {
got := mapRevocationReason(tc.reason)
if got != tc.expected {
t.Errorf("expected %q, got %q", tc.expected, got)
}
})
}
}
func strPtr(s string) *string { return &s }
// ─────────────────────────────────────────────────────────────────────────────
// parseCertMetadata: malformed-PEM + bad-DER branches
// ─────────────────────────────────────────────────────────────────────────────
func TestEntrust_ParseCertMetadata_NotPEM(t *testing.T) {
_, _, _, err := parseCertMetadata("not a pem block")
if err == nil || !strings.Contains(err.Error(), "decode") {
t.Errorf("expected decode error, got %v", err)
}
}
func TestEntrust_ParseCertMetadata_BadDER(t *testing.T) {
pemBlock := "-----BEGIN CERTIFICATE-----\nbm90LWEtZGVy\n-----END CERTIFICATE-----\n"
_, _, _, err := parseCertMetadata(pemBlock)
if err == nil || !strings.Contains(err.Error(), "parse") {
t.Errorf("expected parse error, got %v", err)
}
}
// ─────────────────────────────────────────────────────────────────────────────
// loadMTLSConfig: nonexistent file + nonexistent key
// ─────────────────────────────────────────────────────────────────────────────
func TestEntrust_LoadMTLSConfig_NonexistentFile(t *testing.T) {
_, err := loadMTLSConfig("/nonexistent/cert.pem", "/nonexistent/key.pem")
if err == nil || !strings.Contains(err.Error(), "load client certificate") {
t.Errorf("expected load error, got %v", err)
}
}
// ─────────────────────────────────────────────────────────────────────────────
// ValidateConfig: required-field misses + unreachable URL
// ─────────────────────────────────────────────────────────────────────────────
func TestEntrust_ValidateConfig_MissingFields(t *testing.T) {
cases := []struct {
name string
cfg Config
want string
}{
{"missing api_url", Config{ClientCertPath: "/c", ClientKeyPath: "/k", CAId: "ca"}, "api_url"},
{"missing client_cert_path", Config{APIUrl: "http://x", ClientKeyPath: "/k", CAId: "ca"}, "client_cert_path"},
{"missing client_key_path", Config{APIUrl: "http://x", ClientCertPath: "/c", CAId: "ca"}, "client_key_path"},
{"missing ca_id", Config{APIUrl: "http://x", ClientCertPath: "/c", ClientKeyPath: "/k"}, "ca_id"},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
c := New(nil, slog.Default())
raw, _ := json.Marshal(tc.cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil || !strings.Contains(err.Error(), tc.want) {
t.Errorf("expected error containing %q, got %v", tc.want, err)
}
})
}
}
func TestEntrust_ValidateConfig_BadCertPath(t *testing.T) {
c := New(nil, slog.Default())
cfg := Config{
APIUrl: "http://example.invalid",
ClientCertPath: "/nonexistent/cert.pem",
ClientKeyPath: "/nonexistent/key.pem",
CAId: "ca-1",
}
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil || !strings.Contains(err.Error(), "mTLS credentials") {
t.Errorf("expected mTLS credentials error, got %v", err)
}
}
// ─────────────────────────────────────────────────────────────────────────────
// GetOrderStatus: 403 / malformed JSON / unknown status / pending happy path
// ─────────────────────────────────────────────────────────────────────────────
func TestEntrust_GetOrderStatus_403(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusForbidden)
}))
defer srv.Close()
c := buildEntrustConnector(t, srv.URL)
_, err := c.GetOrderStatus(context.Background(), "tracking-id")
if err == nil || !strings.Contains(err.Error(), "403") {
t.Errorf("expected 403 error, got %v", err)
}
}
func TestEntrust_GetOrderStatus_MalformedJSON(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{not json`))
}))
defer srv.Close()
c := buildEntrustConnector(t, srv.URL)
_, err := c.GetOrderStatus(context.Background(), "tracking-id")
if err == nil || !strings.Contains(err.Error(), "parse") {
t.Errorf("expected parse error, got %v", err)
}
}
func TestEntrust_GetOrderStatus_StatusVariants(t *testing.T) {
cases := []struct {
statusVal string
want string
}{
{"PENDING", "pending"},
{"PROCESSING", "pending"},
{"REJECTED", "failed"},
{"DENIED", "failed"},
{"FAILED", "failed"},
{"WeirdStatus", "pending"}, // unknown → default pending
}
for _, tc := range cases {
t.Run(tc.statusVal, func(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
_ = json.NewEncoder(w).Encode(map[string]interface{}{
"status": tc.statusVal,
"trackingId": "tid-1",
})
}))
defer srv.Close()
c := buildEntrustConnector(t, srv.URL)
st, err := c.GetOrderStatus(context.Background(), "tid-1")
if err != nil {
t.Fatalf("GetOrderStatus: %v", err)
}
if st.Status != tc.want {
t.Errorf("expected status=%q for input=%q, got %q", tc.want, tc.statusVal, st.Status)
}
})
}
}