mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-11 18:59:08 +00:00
336a745f41
Phase 2 of the #6 acquisition-readiness fix from the 2026-05-01 issuer
coverage audit. Phase 1 (commit 520cda3) shipped the secret.Ref opaque
credential type with PBKDF2-derived key, ChaCha20-Poly1305 envelope,
String/MarshalJSON redaction to "[redacted]", and the Use callback
that zero-fills the per-call buffer after the consumer returns.
This commit applies the type to the three connectors flagged by the
audit and adds the JSON-roundtrip glue that the production factory
path needs.
Shared (internal/secret/):
- Add UnmarshalJSON on *Ref so json.Unmarshal of a stored config
blob (issuerfactory.NewFromConfig) parses the bytes-as-string into
NewRefFromString without callers having to know the field type
changed. Null and missing keys leave the receiver nil; non-string
payloads (numbers, bools) are rejected with a typed error. Pinned
by TestRef_UnmarshalJSON: string_value, null, missing_key,
number_rejected, roundtrip_marshal_then_unmarshal (the round-trip
goes through "[redacted]" intentionally — JSON-marshal-then-
unmarshal of a Config with secrets is NOT a supported test pattern;
callers that construct a rawConfig must use a JSON literal with
the real values).
Per-connector migration:
- EJBCA (ejbca.go): Config.Token: string → *secret.Ref. ValidateConfig
empty-check uses Token.IsEmpty() (nil-safe). setAuthHeaders rewritten
to call Token.Use; the Bearer header string is built inside the
callback and the buffer is zeroed on return. mTLS path is
unaffected.
- GlobalSign (globalsign.go): Config.APIKey + Config.APISecret: string
→ *secret.Ref. Both ValidateConfig empty-checks use IsEmpty().
Extracted setAuthHeaders helper consolidates the four duplicated
triple-Set sites (ValidateConfig probe, IssueCertificate,
RevokeCertificate, pollCertificateOnce) so any future header-shape
change applies once. ValidateConfig now pulls from the local cfg
(post-Unmarshal) so the helper takes a *Config rather than the
receiver — needed because ValidateConfig writes the validated cfg
onto c.config only AFTER the probe succeeds.
- Sectigo (sectigo.go): Config.Login + Config.Password: string →
*secret.Ref. CustomerURI stays plain string (org identifier, not
a credential). setAuthHeaders rewritten to call Login.Use +
Password.Use; ValidateConfig's inline header writes use the same
pattern (the ValidateConfig probe writes to a local cfg, not
c.config, so it can't share setAuthHeaders without rewiring — the
inline form is fine, kept consistent in shape).
Test migration:
- ejbca_test.go, ejbca_failure_test.go, ejbca_stubs_test.go: bulk
Token: "X" → Token: secret.NewRefFromString("X") via sed; secret
import added.
- globalsign_test.go, globalsign_failure_test.go: same pattern for
APIKey + APISecret.
- sectigo_test.go, sectigo_failure_test.go: same pattern for Login +
Password.
Two tests (TestGlobalSign_ServerTLSConfig/PinnedCA_TrustsExpectedServer
and TestSectigoConnector/ValidateConfig_Success) used to construct
rawConfig via json.Marshal(config) → ValidateConfig(rawConfig). After
the migration, json.Marshal redacts *secret.Ref to "[redacted]" by
design, so the roundtripped rawConfig wrote "[redacted]" as the
actual header value and the mock server's auth-header check 403'd.
Both tests now build rawConfig as a JSON literal (the production-
shape input — the factory path always feeds rawConfig from the DB
or env, never from json.Marshal of an in-memory Config). The new
tests have a comment explaining the trap so the next person who
adds a similar test sees the pattern.
Out of scope (intentional):
- The `internal/config/config.SectigoConfig` / `GlobalSignConfig` /
`EJBCAConfig` env-var-loader structs are still plain strings —
those types are the env-load shape, not the steady-state runtime
shape. The seed path in service/issuer.go json-marshals them into
a map[string]interface{} which the factory then UnmarshalJSON's
into the connector Config; the new UnmarshalJSON on *Ref handles
the conversion at the boundary.
- DigiCert.APIKey + Vault.Token are still plain strings; Phase 3
will pick them up. The audit explicitly named EJBCA / GlobalSign /
Sectigo as the Phase 2 scope (RESULTS.md L633).
Verified locally:
- gofmt -l . clean
- go vet ./... clean
- staticcheck across all four packages clean
- go test -short -count=1 across secret, ejbca, globalsign, sectigo,
issuerfactory, service, api/handler: green
Audit reference: cowork/issuer-coverage-audit-2026-05-01/RESULTS.md
Top-10 fix #6 — Phase 2.
207 lines
7.3 KiB
Go
207 lines
7.3 KiB
Go
package ejbca_test
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/shankar0123/certctl/internal/connector/issuer"
|
|
"github.com/shankar0123/certctl/internal/connector/issuer/ejbca"
|
|
"github.com/shankar0123/certctl/internal/secret"
|
|
)
|
|
|
|
// Bundle N.A/B-extended: ejbca failure-mode round-out (76.5% → ≥85%).
|
|
// Targets uncovered branches in IssueCertificate / RevokeCertificate /
|
|
// GetOrderStatus.
|
|
|
|
func buildEJBCAConnector(t *testing.T, baseURL string) *ejbca.Connector {
|
|
t.Helper()
|
|
cfg := &ejbca.Config{
|
|
APIUrl: baseURL,
|
|
AuthMode: "oauth2",
|
|
Token: secret.NewRefFromString("tok"),
|
|
CAName: "TestCA",
|
|
CertProfile: "TestProfile",
|
|
EEProfile: "TestEEProfile",
|
|
}
|
|
httpClient := &http.Client{Transport: &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}} //nolint:gosec
|
|
return ejbca.NewWithHTTPClient(cfg, slog.Default(), httpClient)
|
|
}
|
|
|
|
func TestEJBCA_IssueCertificate_403_ReturnsError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusForbidden)
|
|
_, _ = w.Write([]byte(`{"error_code":"forbidden"}`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.IssueCertificate(context.Background(), issuer.IssuanceRequest{
|
|
CommonName: "x.example.com",
|
|
CSRPEM: "-----BEGIN CERTIFICATE REQUEST-----\nfake\n-----END CERTIFICATE REQUEST-----",
|
|
})
|
|
if err == nil || !strings.Contains(err.Error(), "403") {
|
|
t.Errorf("expected 403 error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_IssueCertificate_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 := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.IssueCertificate(context.Background(), issuer.IssuanceRequest{
|
|
CommonName: "x.example.com",
|
|
CSRPEM: "-----BEGIN CERTIFICATE REQUEST-----\nfake\n-----END CERTIFICATE REQUEST-----",
|
|
})
|
|
if err == nil || !strings.Contains(err.Error(), "parse") {
|
|
t.Errorf("expected parse error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_IssueCertificate_BadCertBase64(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"certificate":"NOT VALID BASE64@@@","certificate_chain":[],"serial_number":"01"}`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.IssueCertificate(context.Background(), issuer.IssuanceRequest{
|
|
CommonName: "x.example.com",
|
|
CSRPEM: "-----BEGIN CERTIFICATE REQUEST-----\nfake\n-----END CERTIFICATE REQUEST-----",
|
|
})
|
|
if err == nil || !strings.Contains(err.Error(), "decode") {
|
|
t.Errorf("expected decode error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_RevokeCertificate_403_ReturnsError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusForbidden)
|
|
_, _ = w.Write([]byte(`{}`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
reason := "keyCompromise"
|
|
err := c.RevokeCertificate(context.Background(), issuer.RevocationRequest{
|
|
Serial: "AB:CD:EF",
|
|
Reason: &reason,
|
|
})
|
|
if err == nil || !strings.Contains(err.Error(), "403") {
|
|
t.Errorf("expected 403 error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_GetOrderStatus_MalformedOrderID(t *testing.T) {
|
|
c := buildEJBCAConnector(t, "http://example.invalid")
|
|
st, err := c.GetOrderStatus(context.Background(), "no-double-colons-here")
|
|
if err != nil {
|
|
t.Fatalf("GetOrderStatus: %v", err)
|
|
}
|
|
if st.Status != "failed" {
|
|
t.Errorf("expected failed status for malformed order ID, got %q", st.Status)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_GetOrderStatus_404_TreatedAsPending(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusNotFound)
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
st, err := c.GetOrderStatus(context.Background(), "CN=Issuer::AB:CD")
|
|
if err != nil {
|
|
t.Fatalf("GetOrderStatus: %v", err)
|
|
}
|
|
if st.Status != "pending" {
|
|
t.Errorf("expected pending for 404 (cert not yet issued), got %q", st.Status)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_GetOrderStatus_HappyPath(t *testing.T) {
|
|
// Build a tiny self-signed DER cert for the round-trip
|
|
derBytes := []byte{
|
|
0x30, 0x82, 0x00, 0x10, // junk DER prefix to pass base64 decode
|
|
}
|
|
_ = derBytes
|
|
// Simpler: just confirm 200 with valid base64 attempts to parse and fails cleanly
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"certificate":"` + base64.StdEncoding.EncodeToString([]byte("fake")) + `","certificate_chain":[],"serial_number":"AB:CD"}`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "CN=Issuer::AB:CD")
|
|
if err == nil || !strings.Contains(err.Error(), "parse certificate") {
|
|
t.Errorf("expected x509 parse error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_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 := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "CN=Issuer::AB:CD")
|
|
if err == nil || !strings.Contains(err.Error(), "parse") {
|
|
t.Errorf("expected parse error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_RevokeCertificate_NilReason_Defaults(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"revocation_status":"revoked"}`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
// Reason=nil exercises the default-reason branch.
|
|
err := c.RevokeCertificate(context.Background(), issuer.RevocationRequest{
|
|
Serial: "AB:CD:EF",
|
|
})
|
|
if err != nil {
|
|
t.Errorf("expected nil-reason revoke to succeed, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_IssueCertificate_500_PropagatesError(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusInternalServerError)
|
|
_, _ = w.Write([]byte(`internal error`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.IssueCertificate(context.Background(), issuer.IssuanceRequest{
|
|
CommonName: "x.example.com",
|
|
CSRPEM: "-----BEGIN CERTIFICATE REQUEST-----\nfake\n-----END CERTIFICATE REQUEST-----",
|
|
})
|
|
if err == nil || !strings.Contains(err.Error(), "500") {
|
|
t.Errorf("expected 500 error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestEJBCA_GetOrderStatus_BadCertBase64(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"certificate":"NOT VALID BASE64@@@","certificate_chain":[]}`))
|
|
}))
|
|
defer srv.Close()
|
|
c := buildEJBCAConnector(t, srv.URL)
|
|
_, err := c.GetOrderStatus(context.Background(), "CN=Issuer::AB:CD")
|
|
if err == nil {
|
|
t.Errorf("expected error from bad base64")
|
|
}
|
|
// json package's strict typing — this might not even reach base64 decoding
|
|
// if certificate field has invalid base64. Either way, error is fine.
|
|
_ = json.Marshal
|
|
}
|