Compare commits

...

9 Commits

Author SHA1 Message Date
shankar0123 dedf7fa3a9 docs: add quick-start jump link near top of README
Adds a one-line "Ready to try it?" link right after the maintainer
callout, before the longer prose sections. Gives scanners an immediate
exit to install instructions without rearranging the README's
explain → show → install flow.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 21:38:34 -04:00
shankar0123 4b5927dfff docs: expand README documentation table and fix orphaned doc links
- README: Add 7 missing docs to documentation table (MCP server, OpenAPI
  guide, migration guides for certbot/acme.sh/cert-manager, test
  environment, testing guide). Fix connector reference description to
  remove stale counts. Link OpenAPI guide instead of raw YAML.
- architecture.md: Add cross-references to testing-guide.md and
  test-env.md from testing strategy section and What's Next links.
  These were the only two orphaned docs with zero inbound references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 21:37:47 -04:00
shankar0123 cc03f55006 docs: comprehensive documentation audit — fix stale counts, V2/V3 matrix, connector status
- features.md: Fix Feature Matrix to correctly show all V2 Free features
  (F5/IIS/WinCertStore/JavaKeystore as Implemented, not Stub; Vault/DigiCert/
  Sectigo/GoogleCAS as V2 Free, not V3 Paid). Add missing shipped features
  (EST, verification, export, S/MIME, ARI, digest, Helm, onboarding). Update
  issuer count to 9, target count to 13.
- architecture.md: Fix F5/IIS from "interface only, implementation planned"
  to implemented. Add all 13 target connectors to built-in targets list.
- why-certctl.md: Add Sectigo and Google CAS to issuer list (7→9). Fix
  target count (10→13). Remove hardcoded endpoint/operation counts.
- connectors.md: Fix F5 BIG-IP TOC entry from "Interface Only" to
  "Implemented". Remove dead "Planned Issuers" TOC link.
- README.md: Remove competitor product names (CertKit, KeyTalk). Remove
  hardcoded dashboard page count. Remove hardcoded endpoint counts. Fix V4
  roadmap to remove already-shipped issuers (Sectigo, Google CAS).
- Remove hardcoded MCP tool counts (78/80) across 8 files (mcp.md,
  architecture.md, features.md, testing-guide.md, concepts.md, quickstart.md,
  demo-advanced.md, why-certctl.md). Replace with "REST API exposed via MCP"
  to avoid future drift.
- quickstart.md: Docker Compose environments table (from previous session).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 21:33:12 -04:00
shankar0123 93e1dc598c fix: resolve frontend-to-backend mapping gaps across API types, config fields, and issuer IDs
Full audit of all ~100 backend API endpoints against frontend client functions
and TypeScript interfaces. Fixes field name mismatches, missing client functions,
phantom interface fields, type coercion for Go bool/int config fields, and
issuer type ID alignment with backend domain constants.

Backend:
- issuer.go/target.go: GUI-created entities default enabled=true (Go bool
  zero value was overriding DB DEFAULT)

Frontend types (types.ts):
- Certificate: fingerprint→fingerprint_sha256, phantom fields made optional
- CertificateVersion: fingerprint→fingerprint_sha256, chain_pem→pem_chain,
  removed phantom version/cert_pem fields
- Job: error_message→last_error (matches Go json tag)

Frontend client (client.ts):
- Added getNotification(id) and getAuditEvent(id) for existing backend routes

Frontend pages:
- CertificateDetailPage: derives serial/fingerprint/issuedAt from latest
  CertificateVersion instead of empty Certificate fields
- JobsPage/JobDetailPage: error_message→last_error
- TargetsPage: reload_cmd→reload_command, validate_cmd→validate_command,
  added missing config fields per backend structs (validate_command for
  NGINX/Apache, hostname/winrm_timeout for IIS, private_key/passphrase/
  cert_mode/key_mode for SSH, winrm_https/winrm_insecure for WinCertStore,
  create_keystore for JavaKeystore, mode for Dovecot), type coercion via
  buildConfigPayload() with BOOL_FIELDS/INT_FIELDS sets, IIS WinRM nesting
- TargetDetailPage: added passphrase to sensitiveKeys redaction
- issuerTypes.ts: type IDs aligned to backend constants (acme→ACME,
  local→GenericCA, stepca→StepCA, openssl→OpenSSL), backward compat aliases
  preserved, step-ca config fields updated to match backend struct

Utilities (utils.ts):
- formatDate/formatDateTime accept string|undefined|null

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 21:09:48 -04:00
shankar0123 25f33b830f fix: resolve golangci-lint issues in wincertstore connector
Remove unnecessary fmt.Sprintf wrapping a string literal (staticcheck S1039),
remove unused tempFileForPFX function, and clean up unused os import.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 19:16:34 -04:00
shankar0123 7d6ef44e21 feat(M46): Windows Certificate Store + Java Keystore target connectors, shared certutil package
Extract shared certutil helpers (CreatePFX, ParsePrivateKey, ComputeThumbprint,
GenerateRandomPassword, ParseCertificatePEM) from IIS connector for reuse.
Add WinCertStore connector (PowerShell Import-PfxCertificate, dual local/WinRM
mode, configurable store/location, expired cert cleanup) and JavaKeystore
connector (PEM→PKCS#12→keytool pipeline, JKS/PKCS12 support, shell injection
prevention, path traversal protection). 53 new tests, all passing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 19:14:32 -04:00
shankar0123 dfa4dbbcbd fix: remove unused jwkThumbprint, move verifyJWSSignature to test file
golangci-lint flagged jwkThumbprint as unused. Removed it and the dead
var _ compile-time checks. Moved verifyJWSSignature (test-only helper)
from profile.go to profile_test.go where it belongs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 13:58:40 -04:00
shankar0123 f92c997a50 feat(M45): ACME certificate profile selection, ARI RFC 9773 renumber, 45-day renewal positioning
Three related ACME ecosystem changes shipped as a single milestone:

1. ACME Certificate Profile Selection: Custom JWS-signed newOrder POST with
   `profile` field (e.g., `tlsserver`, `shortlived` for 6-day certs) bypassing
   acme.Client.AuthorizeOrder() since golang.org/x/crypto lacks profile support.
   ES256 JWS signing with kid mode, nonce management, directory discovery.
   Empty profile delegates to standard library path (zero behavior change).
   Configurable via CERTCTL_ACME_PROFILE env var. GUI: profile dropdown on
   ACME issuer config.

2. ARI RFC 9702 → 9773 Renumber: All 25+ references updated across Go source,
   docs, README, and examples. Zero remaining occurrences of RFC 9702.

3. 45-Day / Short-Lived Certificate Positioning: 5 domain tests validating
   renewal thresholds against SC-081v3 validity reduction timeline (200→100→47
   days) and Let's Encrypt 45-day/6-day profiles. ARI (RFC 9773) is the
   expected renewal path for 6-day shortlived certs.

New tests: 13 profile + 5 domain threshold + 1 frontend = 19 new tests.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 13:52:13 -04:00
shankar0123 697c0be9f3 feat(M38): SSH target connector for agentless deployment via SSH/SFTP
Adds a new target connector enabling certificate deployment to any
Linux/Unix server without installing the certctl agent binary. Uses the
proxy agent pattern — a single agent in the same network zone deploys
certs to remote servers over SSH/SFTP.

Key additions:
- SSH/SFTP connector with key auth (file/inline) + password auth
- Injectable SSHClient interface for cross-platform testing (25 tests)
- Shell injection prevention via validation.ValidateShellCommand()
- Configurable cert/key/chain paths with octal permissions
- GUI: 11 SSH config fields in target create wizard

Also fixes pre-existing frontend bug where all target type strings
(nginx, apache, etc.) were sent as lowercase but the backend expects
proper-case (NGINX, Apache, etc.), breaking GUI-created targets.
Adds missing TargetTypeSSH to validTargetTypes service map.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-05 12:36:01 -04:00
48 changed files with 4608 additions and 300 deletions
+26 -14
View File
@@ -38,15 +38,17 @@ gantt
> **Actively maintained — shipping weekly.** Found something? [Open a GitHub issue](https://github.com/shankar0123/certctl/issues) — issues get triaged same-day. CI runs the full test suite with race detection, static analysis, and vulnerability scanning on every commit.
**Ready to try it?** Jump to the [Quick Start](#quick-start) — you'll have a running dashboard in under 5 minutes.
## Why certctl Exists
Certificate lifecycle tooling today falls into two camps: expensive enterprise platforms (Venafi, Keyfactor, Sectigo) that cost six figures and take months to deploy, or single-purpose tools (cert-manager, certbot) that handle one slice of the problem. If you run a mixed infrastructure — some NGINX, some Apache, a few HAProxy nodes, IIS on Windows, maybe an F5 — and you need to manage certificates from multiple CAs, there's nothing self-hosted that covers the full lifecycle without vendor lock-in.
certctl fills that gap. It's **CA-agnostic** — plug in any certificate authority: Let's Encrypt via ACME, Smallstep step-ca, HashiCorp Vault PKI, DigiCert CertCentral, your enterprise ADCS via sub-CA mode, or any custom CA through a shell script adapter. Run multiple issuers simultaneously for different certificate types.
It's **target-agnostic**. Agents deploy certificates to NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, and IIS (local PowerShell or remote WinRM) — all using the same pluggable connector model. The control plane never initiates outbound connections — agents poll for work, which means certctl works behind firewalls, across network zones, and in air-gapped environments.
It's **target-agnostic**. Agents deploy certificates to NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS (local PowerShell or remote WinRM), F5 BIG-IP (proxy agent), and any Linux/Unix server via SSH/SFTP — all using the same pluggable connector model. The control plane never initiates outbound connections — agents poll for work, which means certctl works behind firewalls, across network zones, and in air-gapped environments.
For a detailed comparison with CertKit, KeyTalk, and enterprise platforms, see [Why certctl?](docs/why-certctl.md)
For a detailed comparison with other competitors and enterprise platforms, see [Why certctl?](docs/why-certctl.md)
## Who Is This For
@@ -58,9 +60,9 @@ For a detailed comparison with CertKit, KeyTalk, and enterprise platforms, see [
## What It Does
- **Certificates renew and deploy themselves.** The scheduler monitors expiration, creates renewal jobs, issues certificates through your CA, and deploys them to target servers — all without human intervention. ACME ARI (RFC 9702) lets your CA tell certctl exactly when to renew.
- **Certificates renew and deploy themselves.** The scheduler monitors expiration, creates renewal jobs, issues certificates through your CA, and deploys them to target servers — all without human intervention. ACME ARI (RFC 9773) lets your CA tell certctl exactly when to renew. Ready for 45-day and 6-day certificate lifetimes (SC-081v3 and Let's Encrypt shortlived profiles).
- **You see everything in one place.** A 25-page operational dashboard shows every certificate across every server: status, ownership, expiration timeline, deployment history with TLS verification, discovery triage, and real-time agent fleet health. Bulk operations (renew, revoke, reassign) work across selections.
- **You see everything in one place.** The operational dashboard shows every certificate across every server: status, ownership, expiration timeline, deployment history with TLS verification, discovery triage, and real-time agent fleet health. Bulk operations (renew, revoke, reassign) work across selections.
- **Private keys never leave your servers.** Agents generate ECDSA P-256 keys locally and submit only the CSR. The control plane never touches private keys. Post-deployment TLS verification confirms the right certificate is actually being served.
@@ -68,7 +70,7 @@ For a detailed comparison with CertKit, KeyTalk, and enterprise platforms, see [
- **Everything is auditable.** Immutable append-only audit trail records every lifecycle action, every API call, and every approval decision. Certificate digest emails deliver daily briefings. Prometheus metrics endpoint for Grafana dashboards.
- **Multiple interfaces for different workflows.** REST API (97 endpoints) for automation, CLI for scripting, MCP server for AI assistants (Claude, Cursor, Windsurf), EST server (RFC 7030) for device enrollment, Helm chart for Kubernetes, and the web dashboard for day-to-day operations.
- **Multiple interfaces for different workflows.** REST API for automation, CLI for scripting, MCP server for AI assistants (Claude, Cursor, Windsurf), EST server (RFC 7030) for device enrollment, Helm chart for Kubernetes, and the web dashboard for day-to-day operations.
For the full capability breakdown — revocation infrastructure (CRL + OCSP), policy engine, certificate profiles, S/MIME support, approval workflows, and more — see the [Feature Inventory](docs/features.md).
@@ -104,6 +106,7 @@ For the full capability breakdown — revocation infrastructure (CRL + OCSP), po
| Dovecot | Implemented | `Dovecot` |
| Microsoft IIS | Implemented (local + WinRM) | `IIS` |
| F5 BIG-IP | Beta | `F5` |
| SSH (Agentless) | Beta | `SSH` |
### Notifiers
| Notifier | Status | Type |
@@ -157,16 +160,19 @@ cd certctl
docker compose -f deploy/docker-compose.yml up -d --build
```
Wait ~30 seconds, then open **http://localhost:8443** in your browser.
Wait ~30 seconds, then open **http://localhost:8443** in your browser. The onboarding wizard walks you through connecting a CA, deploying an agent, and issuing your first certificate.
The dashboard comes pre-loaded with 32 demo certificates across 7 issuers, 8 agents, 180 days of job history, discovery scan data, and network scan targets — a realistic snapshot of a certificate inventory that looks like it's been running for months.
**Want a pre-populated demo instead?** Add the demo override to see 32 certificates across 7 issuers, 8 agents, and 180 days of realistic history:
```bash
docker compose -f deploy/docker-compose.yml -f deploy/docker-compose.demo.yml up -d --build
```
The `deploy/` directory has four compose files: `docker-compose.yml` (base platform), `docker-compose.demo.yml` (demo data overlay), `docker-compose.dev.yml` (PgAdmin + debug logging), and `docker-compose.test.yml` (standalone integration tests with real CA backends). See the [Quick Start Guide](docs/quickstart.md#docker-compose-environments) for details.
```bash
curl http://localhost:8443/health
# {"status":"healthy"}
curl -s http://localhost:8443/api/v1/certificates | jq '.total'
# 32
```
### Agent Install (One-Liner)
@@ -220,9 +226,15 @@ Each directory contains a `docker-compose.yml` and a `README.md` explaining the
| [Advanced Demo](docs/demo-advanced.md) | Issue a certificate end-to-end with technical deep-dives |
| [Architecture](docs/architecture.md) | System design, data flow diagrams, security model |
| [Feature Inventory](docs/features.md) | Complete reference of all V2 capabilities, API endpoints, and configuration |
| [Connector Reference](docs/connectors.md) | Configuration for all 7 issuers, 10 targets, and 5 notifier connectors |
| [Connector Reference](docs/connectors.md) | Configuration for all issuer, target, and notifier connectors |
| [MCP Server](docs/mcp.md) | AI integration via Model Context Protocol — setup, available tools, examples |
| [OpenAPI 3.1 Spec](docs/openapi.md) | API reference guide with endpoint overview ([raw spec](api/openapi.yaml)) |
| [Compliance Mapping](docs/compliance.md) | SOC 2 Type II, PCI-DSS 4.0, NIST SP 800-57 alignment guides |
| [OpenAPI 3.1 Spec](api/openapi.yaml) | 97 operations, full request/response schemas |
| [Migrate from certbot](docs/migrate-from-certbot.md) | Step-by-step migration from certbot cron jobs to certctl |
| [Migrate from acme.sh](docs/migrate-from-acmesh.md) | Migration guide for acme.sh users, DNS hook compatibility |
| [certctl for cert-manager users](docs/certctl-for-cert-manager-users.md) | How certctl complements cert-manager for mixed infrastructure |
| [Test Environment](docs/test-env.md) | Docker Compose test environment with real CA backends |
| [Testing Guide](docs/testing-guide.md) | Comprehensive test procedures, smoke tests, and release sign-off checklist |
## CLI
@@ -294,7 +306,7 @@ CI runs on every push: `go vet`, `go test -race`, `golangci-lint`, `govulncheck`
Core lifecycle management — Local CA + ACME v2 issuers, NGINX target connector, agent-side key generation, API auth + rate limiting, React dashboard, CI pipeline with coverage gates, Docker images on GHCR.
### V2: Operational Maturity — Shipped
30+ milestones, extensively tested with CI-enforced coverage gates. Sub-CA mode, ACME DNS-01/DNS-PERSIST-01, step-ca, Vault PKI, DigiCert CertCentral, OpenSSL/Custom CA issuers. NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS targets. RFC 5280 revocation with CRL + OCSP. Certificate profiles, ownership tracking, approval workflows. Filesystem and network certificate discovery. Prometheus metrics, dashboard charts, agent fleet overview. EST server (RFC 7030), ACME ARI (RFC 9702), certificate export, S/MIME support, Helm chart, MCP server, CLI, scheduled digest emails. Slack, Teams, PagerDuty, OpsGenie, SMTP notifications. Compliance mapping (SOC 2, PCI-DSS 4.0, NIST SP 800-57). See the [Feature Inventory](docs/features.md) for details.
30+ milestones, extensively tested with CI-enforced coverage gates. Sub-CA mode, ACME DNS-01/DNS-PERSIST-01, step-ca, Vault PKI, DigiCert CertCentral, OpenSSL/Custom CA issuers. NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS targets. RFC 5280 revocation with CRL + OCSP. Certificate profiles, ownership tracking, approval workflows. Filesystem and network certificate discovery. Prometheus metrics, dashboard charts, agent fleet overview. EST server (RFC 7030), ACME ARI (RFC 9773), certificate export, S/MIME support, Helm chart, MCP server, CLI, scheduled digest emails. Slack, Teams, PagerDuty, OpsGenie, SMTP notifications. Compliance mapping (SOC 2, PCI-DSS 4.0, NIST SP 800-57). See the [Feature Inventory](docs/features.md) for details.
**Coming in v2.1.0:** Dynamic issuer and target configuration via GUI (no env var restarts), first-run onboarding wizard.
@@ -302,7 +314,7 @@ Core lifecycle management — Local CA + ACME v2 issuers, NGINX target connector
Team access controls and identity provider integration (OIDC/SSO). Role-based access control with profile-gating. Event-driven architecture (NATS) with real-time operational views. Advanced search DSL, compliance and risk scoring, bulk fleet operations.
### V4+: Cloud, Scale & Passive Discovery
Passive network discovery (TLS listener), Kubernetes integration (cert-manager external issuer, Secrets target), cloud infrastructure targets (AWS ALB/ACM, Azure Key Vault), extended CA support (Google CAS, EJBCA, Sectigo), and platform-scale features (Terraform provider, multi-tenancy, HSM support).
Passive network discovery (TLS listener), Kubernetes integration (cert-manager external issuer, Secrets target), cloud infrastructure targets (AWS ALB/ACM, Azure Key Vault), extended CA support (Entrust, GlobalSign, EJBCA), and platform-scale features (Terraform provider, multi-tenancy, HSM support).
## License
+1 -1
View File
@@ -2669,7 +2669,7 @@ components:
# ─── Targets ─────────────────────────────────────────────────────
TargetType:
type: string
enum: [NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS, F5]
enum: [NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS, F5, SSH, WinCertStore, JavaKeystore]
DeploymentTarget:
type: object
+30
View File
@@ -31,7 +31,10 @@ import (
"github.com/shankar0123/certctl/internal/connector/target/caddy"
"github.com/shankar0123/certctl/internal/connector/target/envoy"
pf "github.com/shankar0123/certctl/internal/connector/target/postfix"
sshconn "github.com/shankar0123/certctl/internal/connector/target/ssh"
"github.com/shankar0123/certctl/internal/connector/target/f5"
jks "github.com/shankar0123/certctl/internal/connector/target/javakeystore"
wcs "github.com/shankar0123/certctl/internal/connector/target/wincertstore"
"github.com/shankar0123/certctl/internal/connector/target/haproxy"
"github.com/shankar0123/certctl/internal/connector/target/iis"
"github.com/shankar0123/certctl/internal/connector/target/nginx"
@@ -647,6 +650,33 @@ func (a *Agent) createTargetConnector(targetType string, configJSON json.RawMess
}
return pf.New(&cfg, a.logger), nil
case "SSH":
var cfg sshconn.Config
if len(configJSON) > 0 {
if err := json.Unmarshal(configJSON, &cfg); err != nil {
return nil, fmt.Errorf("invalid SSH config: %w", err)
}
}
return sshconn.New(&cfg, a.logger)
case "WinCertStore":
var cfg wcs.Config
if len(configJSON) > 0 {
if err := json.Unmarshal(configJSON, &cfg); err != nil {
return nil, fmt.Errorf("invalid WinCertStore config: %w", err)
}
}
return wcs.New(&cfg, a.logger)
case "JavaKeystore":
var cfg jks.Config
if len(configJSON) > 0 {
if err := json.Unmarshal(configJSON, &cfg); err != nil {
return nil, fmt.Errorf("invalid JavaKeystore config: %w", err)
}
}
return jks.New(&cfg, a.logger), nil
default:
return nil, fmt.Errorf("unsupported target type: %s", targetType)
}
+13 -7
View File
@@ -94,6 +94,7 @@ flowchart TB
T9["Postfix/Dovecot\n(file + service reload)"]
T2["F5 BIG-IP\n(proxy agent + iControl REST)"]
T3["IIS\n(WinRM + local)"]
T10["SSH\n(SFTP + reload)"]
end
DASH --> API
@@ -121,7 +122,7 @@ The server exposes a REST API under `/api/v1/` and optionally serves the web das
### Agents
Lightweight Go processes that run on or near your infrastructure. Agents generate ECDSA P-256 private keys locally, create CSRs, and submit them to the control plane for signing — private keys never leave agent infrastructure. Agents also handle certificate deployment to target systems (NGINX, Apache httpd, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS fully implemented; F5 BIG-IP interface stub only) and report job status. They communicate with the control plane via HTTP and authenticate with API keys.
Lightweight Go processes that run on or near your infrastructure. Agents generate ECDSA P-256 private keys locally, create CSRs, and submit them to the control plane for signing — private keys never leave agent infrastructure. Agents also handle certificate deployment to target systems (NGINX, Apache httpd, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS, F5 BIG-IP, SSH, Windows Certificate Store, Java Keystore) and report job status. They communicate with the control plane via HTTP and authenticate with API keys.
The agent runs two background loops: a heartbeat (every 60 seconds) to signal it's alive, and a work poll (every 30 seconds) to check for actionable jobs via `GET /api/v1/agents/{id}/work`. Jobs may be `AwaitingCSR` (agent needs to generate key + submit CSR) or `Deployment` (agent needs to deploy a certificate). Private keys are stored in `CERTCTL_KEY_DIR` (default `/var/lib/certctl/keys`) with 0600 permissions.
@@ -529,6 +530,7 @@ flowchart TB
TI --> PO["Postfix/Dovecot"]
TI --> IIS["IIS"]
TI --> F5["F5 BIG-IP"]
TI --> SC["SSH"]
end
subgraph "Notifier Connectors"
@@ -582,7 +584,7 @@ type Connector interface {
Built-in issuers: **Local CA** (self-signed or sub-CA mode using `crypto/x509`), **ACME v2** (HTTP-01, DNS-01, and DNS-PERSIST-01 challenges, compatible with Let's Encrypt, ZeroSSL, Sectigo, Google Trust Services, and any ACME-compliant CA), **step-ca** (Smallstep private CA via native /sign API with JWK provisioner auth), **OpenSSL/Custom CA** (script-based signing delegating to user-provided shell scripts), **Vault PKI** (HashiCorp Vault's PKI secrets engine via /sign API with token auth), and **DigiCert** (commercial CA via CertCentral REST API with async order processing). The ACME connector uses `golang.org/x/crypto/acme`, generates an ECDSA P-256 account key, handles account registration with ToS acceptance and optional External Account Binding (EAB) for CAs that require it (ZeroSSL, Google Trust Services, SSL.com), order creation, challenge solving (HTTP-01 via built-in server, DNS-01 via script-based hooks, DNS-PERSIST-01 via standing TXT records with auto-fallback to DNS-01), order finalization, and DER-to-PEM chain conversion. For ZeroSSL, EAB credentials are auto-fetched from ZeroSSL's public API when the directory URL is detected as ZeroSSL and no EAB credentials are provided — zero-friction onboarding with no dashboard visit required.
**ACME Renewal Information (ARI, RFC 9702):** The ACME connector supports CA-directed renewal timing via the `GetRenewalInfo()` method. Instead of using fixed thresholds (e.g., renew 30 days before expiry), the CA tells certctl when to renew by providing a `suggestedWindow` with start and end times. This is useful for distributing renewal load during maintenance windows and coordinating mass-revocation scenarios. Enable with `CERTCTL_ACME_ARI_ENABLED=true`. Cert ID is computed as `base64url(SHA-256(DER cert))` per RFC 9702. If the CA doesn't support ARI (404 from the ARI endpoint), certctl automatically falls back to threshold-based renewal — no operator intervention required. Errors from the CA are logged as warnings.
**ACME Renewal Information (ARI, RFC 9773):** The ACME connector supports CA-directed renewal timing via the `GetRenewalInfo()` method. Instead of using fixed thresholds (e.g., renew 30 days before expiry), the CA tells certctl when to renew by providing a `suggestedWindow` with start and end times. This is useful for distributing renewal load during maintenance windows and coordinating mass-revocation scenarios. Enable with `CERTCTL_ACME_ARI_ENABLED=true`. Cert ID is computed as `base64url(SHA-256(DER cert))` per RFC 9773. If the CA doesn't support ARI (404 from the ARI endpoint), certctl automatically falls back to threshold-based renewal — no operator intervention required. Errors from the CA are logged as warnings.
The interface also includes `GetCACertPEM(ctx)` for CA chain distribution (used by the EST server's `/cacerts` endpoint).
@@ -600,11 +602,11 @@ type Connector interface {
The `DeploymentRequest` struct carries the full material needed by the target system: the signed certificate, the CA chain, the agent-generated private key, target-specific configuration, and arbitrary metadata. The key field is populated by the agent from its local key store (`CERTCTL_KEY_DIR`) — it never originates from the control plane.
Built-in targets: **NGINX** (writes cert/chain/key files, validates with `nginx -t`, reloads), **Apache httpd** (writes cert/chain/key files, validates with `apachectl configtest`, graceful reload), **HAProxy** (combined PEM file with cert+chain+key, validates config, reloads via systemctl/signal), **Traefik** (file provider — writes cert/key to watched directory, Traefik auto-reloads), **Caddy** (dual-mode: admin API hot-reload or file-based), **F5 BIG-IP** (interface only — proxy agent + iControl REST, implementation planned), **IIS** (interface only — dual-mode: agent-local PowerShell primary + proxy agent WinRM for agentless targets, implementation planned).
Built-in targets: **NGINX** (writes cert/chain/key files, validates with `nginx -t`, reloads), **Apache httpd** (writes cert/chain/key files, validates with `apachectl configtest`, graceful reload), **HAProxy** (combined PEM file with cert+chain+key, validates config, reloads via systemctl/signal), **Traefik** (file provider — writes cert/key to watched directory, Traefik auto-reloads), **Caddy** (dual-mode: admin API hot-reload or file-based), **Envoy** (file-based with optional SDS JSON config), **F5 BIG-IP** (proxy agent + iControl REST, transaction-based atomic SSL profile updates), **IIS** (dual-mode: agent-local PowerShell + proxy agent WinRM for agentless targets), **Postfix/Dovecot** (file write + service reload), **SSH** (agentless deployment via SSH/SFTP), **Windows Certificate Store** (PowerShell-based cert import, dual-mode local/WinRM), **Java Keystore** (PEM → PKCS#12 → keytool pipeline, JKS and PKCS12 formats).
After deployment, agents can perform **post-deployment TLS verification**: the agent probes the live TLS endpoint using `crypto/tls.DialWithDialer` and compares the SHA-256 fingerprint of the served certificate against what was deployed. Results are reported via `POST /api/v1/jobs/{id}/verify` and stored on the job record. Verification is best-effort — failures don't block or rollback deployments.
Additional cloud, network, and Kubernetes target connectors are planned for future releases.
The SSH connector enables agentless deployment to any Linux/Unix server via SSH/SFTP, using the proxy agent pattern. Additional cloud, network, and Kubernetes target connectors are planned for future releases.
### Notifier Connector
@@ -808,7 +810,7 @@ flowchart LR
AI["AI Assistant\n(Claude, Cursor)"] -->|"stdio"| MCP["MCP Server\ncmd/mcp-server/"]
MCP -->|"HTTP + Bearer token"| API["certctl REST API\n:8443"]
subgraph "78 MCP Tools"
subgraph "MCP Tools"
T1["Certificate CRUD"]
T2["Agent Management"]
T3["Job Operations"]
@@ -822,7 +824,7 @@ flowchart LR
The MCP server is a stateless HTTP proxy — every MCP tool call translates to an HTTP request to the certctl REST API. It adds no new state, no new dependencies, and no new attack surface beyond what the API already exposes. Configuration is minimal: `CERTCTL_SERVER_URL` and `CERTCTL_API_KEY` environment variables.
The 78 tools are organized across 16 resource domains with typed input structs and `jsonschema` struct tags for automatic LLM-friendly schema generation. Binary response support handles DER CRL and OCSP endpoints.
The tools are organized across 16 resource domains with typed input structs and `jsonschema` struct tags for automatic LLM-friendly schema generation. Binary response support handles DER CRL and OCSP endpoints.
## CLI Tool
@@ -976,7 +978,7 @@ certctl is extensively tested across eight layers with CI-enforced coverage gate
**Frontend tests** (`web/src/api/`) — Vitest tests covering the full API client (all endpoint functions with fetch mocking), stats/metrics endpoints, utility functions, and auth flows. Test environment uses jsdom with `@testing-library/jest-dom` matchers.
**Connector tests** (`internal/connector/`) — Issuer connectors (Local CA self-signed/sub-CA modes, ACME DNS-01/DNS-PERSIST-01, step-ca, OpenSSL, Vault PKI, DigiCert, Sectigo, Google CAS — all with httptest mock servers). Target connectors (NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS with mock PowerShell executor, F5 BIG-IP with mock iControl client, Postfix/Dovecot). Notifier connectors (Slack, Teams, PagerDuty, OpsGenie).
**Connector tests** (`internal/connector/`) — Issuer connectors (Local CA self-signed/sub-CA modes, ACME DNS-01/DNS-PERSIST-01, step-ca, OpenSSL, Vault PKI, DigiCert, Sectigo, Google CAS — all with httptest mock servers). Target connectors (NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS with mock PowerShell executor, F5 BIG-IP with mock iControl client, Postfix/Dovecot, SSH with mock SSH client). Notifier connectors (Slack, Teams, PagerDuty, OpsGenie).
**Scheduler tests** (`internal/scheduler/scheduler_test.go`) — Idempotency guards (`sync/atomic.Bool`), `WaitForCompletion` success and timeout paths, and multi-loop concurrency safety.
@@ -984,6 +986,8 @@ certctl is extensively tested across eight layers with CI-enforced coverage gate
**CI pipeline** (`.github/workflows/ci.yml`) — Two parallel jobs. Go: build, vet, `go test -race`, `golangci-lint` (11 linters), `govulncheck`, test with coverage, per-layer coverage threshold enforcement (service 60%, handler 60%, domain 40%, middleware 50%). Frontend: TypeScript type check, Vitest, Vite production build.
For detailed test procedures, smoke tests, and the release sign-off checklist, see the [Testing Guide](testing-guide.md). For setting up the Docker Compose test environment with real CA backends, see [Test Environment](test-env.md).
## What's Next
- [Quick Start](quickstart.md) — Get certctl running locally
@@ -992,3 +996,5 @@ certctl is extensively tested across eight layers with CI-enforced coverage gate
- [Compliance Mapping](compliance.md) — SOC 2, PCI-DSS 4.0, and NIST SP 800-57 alignment
- [MCP Server Guide](mcp.md) — AI-native access to the API
- [OpenAPI Spec](openapi.md) — Full API reference and SDK generation
- [Testing Guide](testing-guide.md) — Test procedures and release sign-off
- [Test Environment](test-env.md) — Docker Compose test environment setup
+13 -3
View File
@@ -183,11 +183,11 @@ Profiles are managed via the API (`/api/v1/profiles`) and the GUI, and can be as
For policies with `auto_renew` disabled, renewal jobs enter an **AwaitingApproval** state instead of processing immediately. An operator must explicitly approve or reject the renewal via the API or GUI. Approved jobs transition to Pending and are picked up by the scheduler. Rejected jobs are cancelled with an optional reason. This is useful for high-value certificates where you want human oversight before renewal.
### Renewal Timing: Thresholds vs. ARI (RFC 9702)
### Renewal Timing: Thresholds vs. ARI (RFC 9773)
**Traditional approach (thresholds):** By default, certctl uses static renewal thresholds — renew a certificate at a fixed number of days before expiry (default: 30 days). This simple, predictable model works for most use cases: it avoids unnecessary renewals near expiry and gives you a predictable window to catch failures.
**Advanced approach (ACME ARI):** Some Certificate Authorities support ACME Renewal Information (RFC 9702), which allows the CA to tell certctl the optimal time to renew. Instead of guessing "renew 30 days before expiry," the CA responds with a precise `suggestedWindow` containing start and end times. This is useful when:
**Advanced approach (ACME ARI):** Some Certificate Authorities support ACME Renewal Information (RFC 9773), which allows the CA to tell certctl the optimal time to renew. Instead of guessing "renew 30 days before expiry," the CA responds with a precise `suggestedWindow` containing start and end times. This is useful when:
- The CA is performing maintenance and wants to batch renewals in a specific window
- The CA is coordinating a mass revocation (e.g., due to a compromise) and needs to control renewal timing
- You want to avoid thundering herd renewal spikes by accepting the CA's suggested timing
@@ -196,6 +196,16 @@ For policies with `auto_renew` disabled, renewal jobs enter an **AwaitingApprova
**Graceful degradation:** If your CA doesn't support ARI (returns 404 from the ARI endpoint), certctl automatically falls back to the traditional threshold-based renewal. No configuration change needed — the fallback is transparent. Errors from the CA are logged as warnings and don't block the renewal process.
### Shorter Certificate Validity (45-Day and 6-Day Certs)
The industry is moving toward shorter certificate lifetimes. The CA/Browser Forum's SC-081v3 ballot mandates a phased reduction: 200-day max (March 2026), 100-day max (March 2027), and 47-day max (March 2029). Let's Encrypt has already begun reducing default validity to 45 days, and offers 6-day "shortlived" certificates via ACME profile selection.
certctl handles shorter-lived certificates correctly out of the box:
- **45-day certs** with the default 31-day renewal window trigger renewal at day 14 — at roughly 1/3 of the cert's lifetime.
- **6-day "shortlived" certs** are always within the renewal window. ARI (RFC 9773) is the expected renewal path for these — the CA directs timing. Short-lived certs also skip CRL/OCSP since expiry is sufficient revocation (per profile TTL < 1 hour exemption).
- **ACME profile selection** lets you request specific certificate profiles from your CA. Set `CERTCTL_ACME_PROFILE=shortlived` to get 6-day certificates from Let's Encrypt, or `CERTCTL_ACME_PROFILE=tlsserver` for standard TLS certificates.
### Certificate Revocation
When a private key is compromised, a certificate is superseded, or a service is decommissioned, you need to revoke the certificate immediately — not wait for it to expire. Revocation tells clients "stop trusting this certificate right now."
@@ -242,7 +252,7 @@ The CLI supports both table and JSON output formats (`--format table` or `--form
### MCP Server (AI Integration)
certctl includes an MCP (Model Context Protocol) server that exposes 78 MCP tools covering the REST API. This enables AI assistants like Claude, Cursor, and other MCP-compatible tools to interact with your certificate infrastructure using natural language — "show me all expiring certificates," "revoke the VPN cert," or "what agents are offline?"
certctl includes an MCP (Model Context Protocol) server that exposes the entire REST API as MCP tools. This enables AI assistants like Claude, Cursor, and other MCP-compatible tools to interact with your certificate infrastructure using natural language — "show me all expiring certificates," "revoke the VPN cert," or "what agents are offline?"
The MCP server is a separate binary (`cmd/mcp-server/`) that communicates via stdio transport and acts as a stateless HTTP proxy to the certctl REST API. It requires no additional infrastructure — just point it at your certctl server URL and API key.
+131 -4
View File
@@ -13,7 +13,6 @@ Connectors extend certctl to integrate with external systems for certificate iss
- [OpenSSL / Custom CA](#openssl--custom-ca)
- [Revocation Across Issuers](#revocation-across-issuers)
- [EST Integration (GetCACertPEM)](#est-integration-getcacertpem)
- [Planned Issuers](#planned-issuers)
- [Building a Custom Issuer](#building-a-custom-issuer)
3. [Target Connector](#target-connector)
- [Interface](#interface-1)
@@ -24,8 +23,11 @@ Connectors extend certctl to integrate with external systems for certificate iss
- [Built-in: Envoy](#built-in-envoy)
- [Built-in: Postfix / Dovecot](#built-in-postfix--dovecot)
- [Built-in: Caddy](#built-in-caddy)
- [F5 BIG-IP (Interface Only)](#f5-big-ip-interface-only)
- [F5 BIG-IP (Implemented)](#f5-big-ip-implemented)
- [IIS (Implemented, Dual-Mode)](#iis-implemented-dual-mode)
- [SSH (Agentless Deployment)](#ssh-agentless-deployment)
- [Windows Certificate Store](#windows-certificate-store)
- [Java Keystore (JKS / PKCS#12)](#java-keystore-jks--pkcs12)
4. [Notifier Connector](#notifier-connector)
- [Interface](#interface-2)
5. [Registering a Connector](#registering-a-connector)
@@ -54,7 +56,7 @@ Connectors extend certctl to integrate with external systems for certificate iss
Three types of connectors:
1. **Issuer Connector** — Obtains certificates from CAs (Local CA with sub-CA support, ACME with HTTP-01 + DNS-01 + DNS-PERSIST-01, step-ca, OpenSSL/Custom CA, Vault PKI, DigiCert implemented; additional CA integrations planned)
2. **Target Connector** — Deploys certificates to infrastructure (NGINX, Apache httpd, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS implemented; F5 via proxy agent planned; additional cloud and network targets planned)
2. **Target Connector** — Deploys certificates to infrastructure (NGINX, Apache httpd, HAProxy, Traefik, Caddy, Envoy, Postfix, Dovecot, IIS, F5, SSH implemented; additional cloud and network targets planned)
3. **Notifier Connector** — Sends alerts about certificate events (Email, Webhooks, Slack, Microsoft Teams, PagerDuty, OpsGenie implemented)
All connectors accept JSON configuration at initialization, support config validation, and are registered in the service layer. Issuer connectors run on the control plane; target connectors run on agents. For network appliances where agents can't be installed, a **proxy agent** in the same network zone handles deployment — the server never initiates outbound connections.
@@ -173,7 +175,7 @@ The ACME connector implements the full ACME v2 protocol using Go's `golang.org/x
**DNS-PERSIST-01 (standing record):** Creates a one-time persistent TXT record at `_validation-persist.<domain>` containing the CA's issuer domain and your ACME account URI. Once set, this record authorizes unlimited future certificate issuances without per-renewal DNS updates. Based on [draft-ietf-acme-dns-persist](https://datatracker.ietf.org/doc/draft-ietf-acme-dns-persist/) and CA/Browser Forum ballot SC-088v3. If the CA doesn't offer dns-persist-01 yet, the connector falls back to dns-01 automatically.
**ACME Renewal Information (ARI, RFC 9702):** Instead of using fixed renewal thresholds (e.g., renew 30 days before expiry), certctl can ask the CA when it should renew. Enable with `CERTCTL_ACME_ARI_ENABLED=true`. The ARI protocol lets the CA specify a `suggestedWindow` (start and end times) for when you should renew — useful for distributing load during maintenance windows or coordinating mass revocation scenarios. Cert ID is computed as `base64url(SHA-256(DER cert))`. If the CA doesn't support ARI (404 response), certctl automatically falls back to threshold-based renewal with no operator intervention required.
**ACME Renewal Information (ARI, RFC 9773):** Instead of using fixed renewal thresholds (e.g., renew 30 days before expiry), certctl can ask the CA when it should renew. Enable with `CERTCTL_ACME_ARI_ENABLED=true`. The ARI protocol lets the CA specify a `suggestedWindow` (start and end times) for when you should renew — useful for distributing load during maintenance windows or coordinating mass revocation scenarios. Cert ID is computed as `base64url(SHA-256(DER cert))`. If the CA doesn't support ARI (404 response), certctl automatically falls back to threshold-based renewal with no operator intervention required.
HTTP-01 configuration:
```json
@@ -243,6 +245,9 @@ Environment variables for the default ACME connector:
- `CERTCTL_ACME_DNS_PRESENT_SCRIPT` — Path to DNS record creation script (dns-01 and dns-persist-01)
- `CERTCTL_ACME_DNS_CLEANUP_SCRIPT` — Path to DNS record cleanup script (dns-01 only, not used by dns-persist-01)
- `CERTCTL_ACME_DNS_PERSIST_ISSUER_DOMAIN` — CA issuer domain for persistent record (dns-persist-01 only, e.g., `letsencrypt.org`)
- `CERTCTL_ACME_PROFILE` — Certificate profile for the newOrder request. Let's Encrypt supports `tlsserver` (standard TLS, default) and `shortlived` (6-day certs). Leave empty for the CA's default profile.
**Certificate Profiles:** Let's Encrypt (GA January 2026) supports ACME certificate profile selection. Set `CERTCTL_ACME_PROFILE=shortlived` to request 6-day certificates — ideal for ephemeral workloads where short validity substitutes for revocation. The `tlsserver` profile produces standard TLS certificates. When the profile field is empty (default), the CA uses its default profile, maintaining full backward compatibility.
The connector is registered in the issuer registry under `iss-acme-staging` and `iss-acme-prod`. Use `iss-acme-staging` for Let's Encrypt staging (rate-limit-friendly testing) and `iss-acme-prod` for production certificates.
@@ -809,6 +814,128 @@ The IIS target connector supports two deployment modes — agent-local (recommen
Location: `internal/connector/target/iis/iis.go`, `internal/connector/target/iis/winrm.go`
### SSH (Agentless Deployment)
The SSH target connector enables agentless certificate deployment to any Linux/Unix server via SSH/SFTP. Instead of installing the certctl agent binary on every target, a single "proxy agent" in the same network zone deploys certificates to remote servers over SSH. This is ideal for environments where installing agents on every server is impractical.
**Key authentication (recommended):**
```json
{
"host": "web-server.internal",
"port": 22,
"user": "certctl",
"auth_method": "key",
"private_key_path": "/home/certctl/.ssh/id_ed25519",
"cert_path": "/etc/ssl/certs/cert.pem",
"key_path": "/etc/ssl/private/key.pem",
"chain_path": "/etc/ssl/certs/chain.pem",
"reload_command": "systemctl reload nginx",
"timeout": 30
}
```
**Password authentication:**
```json
{
"host": "legacy-server.internal",
"user": "deploy",
"auth_method": "password",
"password": "s3cret",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
"reload_command": "systemctl reload apache2"
}
```
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `host` | string | *(required)* | SSH hostname or IP address |
| `port` | number | 22 | SSH port |
| `user` | string | *(required)* | SSH username |
| `auth_method` | string | `"key"` | `"key"` or `"password"` |
| `private_key_path` | string | | Path to SSH private key file (key auth) |
| `private_key` | string | | Inline SSH private key PEM (alternative to path) |
| `password` | string | | SSH password (password auth) |
| `passphrase` | string | | Passphrase for encrypted private keys |
| `cert_path` | string | *(required)* | Remote path for certificate file |
| `key_path` | string | *(required)* | Remote path for private key file |
| `chain_path` | string | | Remote path for chain file (if empty, chain appended to cert) |
| `cert_mode` | string | `"0644"` | File permissions for cert (octal) |
| `key_mode` | string | `"0600"` | File permissions for private key (octal) |
| `reload_command` | string | | Command to execute after deployment |
| `timeout` | number | 30 | SSH connection timeout in seconds |
**Security:**
- Key-based authentication is recommended over password authentication
- Reload commands are validated against shell injection (same validation as Postfix/Dovecot connectors)
- Host field is regex-validated to prevent shell metacharacters
- Private keys are written with 0600 permissions by default
- Host key verification is intentionally skipped (same rationale as network scanner and F5 connector — deploying to known, operator-configured infrastructure)
- Encrypted private keys supported via passphrase
Location: `internal/connector/target/ssh/ssh.go`
### Windows Certificate Store
The Windows Certificate Store connector imports certificates into the Windows cert store via PowerShell, without managing IIS site bindings. Use this for non-IIS Windows services that read certificates from the cert store (Exchange, RDP, SQL Server, ADFS, etc.). Same injectable `PowerShellExecutor` pattern as the IIS connector, with optional WinRM proxy mode.
```json
{
"store_name": "My",
"store_location": "LocalMachine",
"friendly_name": "Production API Cert",
"remove_expired": true
}
```
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `store_name` | string | `"My"` | Windows cert store name (My, Root, WebHosting, etc.) |
| `store_location` | string | `"LocalMachine"` | `"LocalMachine"` or `"CurrentUser"` |
| `friendly_name` | string | | Optional friendly name for the imported certificate |
| `remove_expired` | boolean | `false` | Remove expired certs with same CN after import |
| `mode` | string | `"local"` | `"local"` (agent-local) or `"winrm"` (remote) |
| `winrm_host` | string | | WinRM hostname (required for winrm mode) |
| `winrm_port` | number | 5985 | WinRM port (5985 HTTP, 5986 HTTPS) |
| `winrm_username` | string | | WinRM username (required for winrm mode) |
| `winrm_password` | string | | WinRM password (required for winrm mode) |
| `winrm_https` | boolean | `false` | Use HTTPS for WinRM |
| `winrm_insecure` | boolean | `false` | Skip TLS verification for WinRM |
Location: `internal/connector/target/wincertstore/wincertstore.go`
### Java Keystore (JKS / PKCS#12)
The Java Keystore connector deploys certificates to JKS or PKCS#12 keystores via the `keytool` CLI. This enables TLS cert deployment for Tomcat, Jetty, Kafka, Elasticsearch, and any JVM-based service. Flow: PEM to temp PKCS#12, then `keytool -importkeystore` into the target keystore.
```json
{
"keystore_path": "/opt/tomcat/conf/keystore.p12",
"keystore_password": "changeit",
"keystore_type": "PKCS12",
"alias": "server",
"reload_command": "systemctl restart tomcat"
}
```
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `keystore_path` | string | *(required)* | Absolute path to the keystore file |
| `keystore_password` | string | *(required)* | Keystore password |
| `keystore_type` | string | `"PKCS12"` | `"PKCS12"` or `"JKS"` |
| `alias` | string | `"server"` | Key entry alias in the keystore |
| `reload_command` | string | | Optional command to run after keystore update |
| `create_keystore` | boolean | `true` | Create keystore if it doesn't exist |
| `keytool_path` | string | `"keytool"` | Override keytool binary path |
**Security:**
- Reload commands validated against shell injection via `validation.ValidateShellCommand()`
- Alias validated against injection (alphanumeric, hyphens, underscores only)
- Path traversal prevention on keystore path
- Transient PKCS#12 temp file cleaned up after import (even on error)
Location: `internal/connector/target/javakeystore/javakeystore.go`
## Notifier Connector
Notifier connectors send alerts about certificate lifecycle events (expiration warnings, renewal success/failure, deployment status, policy violations).
+1 -1
View File
@@ -981,7 +981,7 @@ export CERTCTL_API_KEY="test-key-123"
## Part 15: MCP Server for AI Integration (M18a)
certctl exposes 78 MCP tools covering the REST API via the Model Context Protocol (MCP), enabling seamless integration with Claude, Cursor, and other AI assistants:
certctl exposes the full REST API via the Model Context Protocol (MCP), enabling seamless integration with Claude, Cursor, and other AI assistants:
```bash
# Build the MCP server
+28 -25
View File
@@ -7,7 +7,7 @@ Complete reference of all features shipped in the V2 release (as of March 2026).
## API Surface
### Overview
- **99 endpoints** across 23 resource domains under `/api/v1/` + `/.well-known/est/`
- REST API across 23 resource domains under `/api/v1/` + `/.well-known/est/`
- REST API with HTTP semantics (GET, POST, PUT, DELETE)
- All endpoints require authentication by default (configurable)
- OpenAPI 3.1 spec with full schema documentation
@@ -514,7 +514,7 @@ export CERTCTL_PAGERDUTY_SEVERITY="critical"
---
## ACME Renewal Information (ARI, RFC 9702)
## ACME Renewal Information (ARI, RFC 9773)
Instead of using fixed renewal thresholds (renew 30 days before expiry), ACME ARI lets the CA tell certctl exactly when to renew. This is useful for distributing renewal load across maintenance windows and coordinating mass-revocation scenarios.
@@ -530,7 +530,7 @@ export CERTCTL_ACME_ARI_ENABLED=true
| Field | Details |
|-------|---------|
| **Protocol** | ACME Renewal Information (RFC 9702) |
| **Protocol** | ACME Renewal Information (RFC 9773) |
| **Cert ID Computation** | base64url(SHA-256(DER cert)) |
| **Suggested Window** | Start and end times provided by CA |
| **Renewal Timing** — If current time is after window start, renew immediately. Otherwise, wait until start time. |
@@ -1134,12 +1134,12 @@ The web dashboard is the primary operational interface for certctl. Built with *
## Integration Interfaces
### MCP Server (M18a)
**Separate binary** (`cmd/mcp-server/`) providing AI-native access to certctl via Claude, Cursor, OpenClaw. Instead of memorizing 91 API endpoints, ask your AI assistant "what certificates are expiring this week?" or "renew the API prod cert" and it translates to the right API calls.
**Separate binary** (`cmd/mcp-server/`) providing AI-native access to certctl via Claude, Cursor, OpenClaw. Instead of memorizing API endpoints, ask your AI assistant "what certificates are expiring this week?" or "renew the API prod cert" and it translates to the right API calls.
- **Transport** — stdio (stdin/stdout)
- **Protocol** — Model Context Protocol v1
- **SDK** — Official `modelcontextprotocol/go-sdk` v1.4.1
- **Tools** 78 MCP tools covering all API endpoints
- **Tools** — MCP tools covering all API endpoints
- **Organization** — 16 resource domains (Certificates, Issuers, Targets, Agents, Jobs, etc.)
- **Authentication** — Bearer token via `CERTCTL_API_KEY` env var
- **Configuration**`CERTCTL_SERVER_URL` (e.g., http://localhost:8080) + `CERTCTL_API_KEY`
@@ -1439,8 +1439,8 @@ Each guide includes an evidence summary table mapping specific criteria to certc
| Feature | V2 | V3 (Paid) | Status |
|---------|----|-----------|-|
| Certificate lifecycle (create/renew/revoke) | ✓ | ✓ | Shipped v1.0+ |
| 4 issuer connectors (Local CA, ACME, step-ca, OpenSSL) | ✓ | ✓ | Shipped |
| 3 target connectors (NGINX, Apache, HAProxy) | ✓ | ✓ | Shipped |
| 9 issuer connectors (Local CA, ACME, step-ca, OpenSSL, Vault PKI, DigiCert, Sectigo, Google CAS, EST) | ✓ | ✓ | Shipped |
| 13 target connectors (NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS, F5, Postfix, Dovecot, SSH, WinCertStore, JavaKeystore) | ✓ | ✓ | Shipped |
| 6 notifier channels (Email, Webhook, Slack, Teams, PagerDuty, OpsGenie) | ✓ | ✓ | Shipped |
| Agent fleet + metadata | ✓ | ✓ | Shipped |
| Agent groups (dynamic + manual) | ✓ | ✓ | Shipped |
@@ -1449,28 +1449,33 @@ Each guide includes an evidence summary table mapping specific criteria to certc
| Revocation (RFC 5280, CRL, OCSP) | ✓ | ✓ | Shipped |
| Full web dashboard | ✓ | ✓ | Shipped |
| Observability (charts, metrics, stats) | ✓ | ✓ | Shipped |
| REST API (91 endpoints) | ✓ | ✓ | Shipped |
| MCP server (78 tools) | ✓ | ✓ | Shipped v2.1 |
| CLI tool (12 subcommands) | ✓ | ✓ | Shipped |
| REST API | ✓ | ✓ | Shipped |
| MCP server (REST API exposed via MCP) | ✓ | ✓ | Shipped v2.1 |
| CLI tool | ✓ | ✓ | Shipped |
| Compliance mapping docs (SOC 2, PCI-DSS, NIST) | ✓ | ✓ | Shipped |
| Filesystem cert discovery (M18b) | ✓ | ✓ | Shipped |
| Network cert discovery (M21) | ✓ | ✓ | Shipped |
| Prometheus metrics (M22) | ✓ | ✓ | Shipped |
| Filesystem cert discovery | ✓ | ✓ | Shipped |
| Network cert discovery | ✓ | ✓ | Shipped |
| Prometheus metrics | ✓ | ✓ | Shipped |
| Enhanced query API (sort, filter, cursor, fields) | ✓ | ✓ | Shipped |
| Immutable API audit log | ✓ | ✓ | Shipped |
| Bulk operations | ✓ | ✓ | Shipped |
| EST server (RFC 7030) | ✓ | ✓ | Shipped |
| Post-deployment TLS verification | ✓ | ✓ | Shipped |
| Certificate export (PEM + PKCS#12) | ✓ | ✓ | Shipped |
| S/MIME support (EKU-aware issuance) | ✓ | ✓ | Shipped |
| ACME ARI (RFC 9773) | ✓ | ✓ | Shipped |
| Scheduled certificate digest emails | ✓ | ✓ | Shipped |
| Helm chart (Kubernetes) | ✓ | ✓ | Shipped |
| Dynamic issuer/target configuration (GUI) | ✓ | ✓ | Shipped |
| Onboarding wizard | ✓ | ✓ | Shipped |
| **OIDC/SSO auth** | ✗ | ✓ | Planned V3 |
| **RBAC (role-based access control)** | ✗ | ✓ | Planned V3 |
| **F5 BIG-IP implementation** | Stub | ✓ | Planned V3 |
| **IIS implementation** | Stub | ✓ | Planned V3 |
| **NATS event bus** | ✗ | ✓ | Planned V3 |
| **Real-time updates (SSE/WebSocket)** | ✗ | ✓ | Planned V3 |
| **Advanced search DSL** | ✗ | ✓ | Planned V3 |
| **Bulk operations** | | ✓ | M13 (free) |
| **Bulk revocation** | ✗ | ✓ | Planned V3 (paid) |
| **Bulk revocation (by profile/owner/agent)** | | ✓ | Planned V3 |
| **Certificate health scores** | ✗ | ✓ | Planned V3 |
| **Compliance scoring** | ✗ | ✓ | Planned V3 |
| **DigiCert issuer** | ✗ | ✓ | Implemented (Beta) |
| **Vault PKI issuer** | ✗ | ✓ | Implemented (Beta) |
---
@@ -1478,10 +1483,9 @@ Each guide includes an evidence summary table mapping specific criteria to certc
| Category | Count |
|----------|-------|
| **API Endpoints** | 97 (under /api/v1/ + /.well-known/est/) |
| **Dashboard** | Full web GUI |
| **Issuer Connectors** | 6 (Local CA, ACME, step-ca, OpenSSL, Vault PKI, DigiCert) |
| **Target Connectors** | 10 (9 impl: NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS, Postfix, Dovecot; 1 stub: F5) |
| **Dashboard** | Full web GUI with operational views wired to real API data |
| **Issuer Connectors** | 8 (Local CA, ACME, step-ca, OpenSSL, Vault PKI, DigiCert, Sectigo, Google CAS) + EST server |
| **Target Connectors** | 13 (NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS, F5, Postfix, Dovecot, SSH, WinCertStore, JavaKeystore) |
| **Notifier Channels** | 6 (Email, Webhook, Slack, Teams, PagerDuty, OpsGenie) |
| **Job Types** | 4 (Issuance, Renewal, Deployment, Validation) |
| **Job States** | 7 (Pending, AwaitingCSR, AwaitingApproval, Running, Completed, Failed, Cancelled) |
@@ -1489,9 +1493,8 @@ Each guide includes an evidence summary table mapping specific criteria to certc
| **Certificate States** | 8 (Pending, Active, Expiring, Expired, RenewalInProgress, Failed, Revoked, Archived) |
| **Revocation Reason Codes** | 8 (RFC 5280 compliant) |
| **Discovery Statuses** | 3 (Unmanaged, Managed, Dismissed) |
| **MCP Tools** | 76 (16 resource domains) |
| **MCP Server** | REST API exposed via MCP (16 resource domains) |
| **CLI Subcommands** | 10 |
| **Database Tables** | 19 |
| **Test Suite** | Extensively tested with CI-enforced coverage gates |
| **Environment Variables** | 41+ configuration options |
+2 -2
View File
@@ -94,7 +94,7 @@ Add certctl as an MCP server in your project's `.mcp.json`:
## Available Tools
The MCP server registers 78 tools organized across 16 resource domains:
The MCP server exposes the full REST API organized across 16 resource domains:
| Domain | Tools | Examples |
|--------|-------|---------|
@@ -153,7 +153,7 @@ flowchart LR
AI <-->|"stdio"| MCP
MCP -->|"HTTP + Bearer token"| SERVER
MCP ~~~ TOOLS["78 tools · 16 domains\nTyped input structs"]
MCP ~~~ TOOLS["REST API via MCP · 16 domains\nTyped input structs"]
```
The MCP server is intentionally thin:
+14 -1
View File
@@ -60,6 +60,19 @@ cp deploy/.env.example deploy/.env
docker compose -f deploy/docker-compose.yml up -d --build
```
### Docker Compose Environments
The `deploy/` directory contains four compose files for different use cases:
| File | Purpose | How to run |
|------|---------|------------|
| `docker-compose.yml` | **Base platform.** PostgreSQL + certctl server + agent. Clean dashboard with onboarding wizard — use this for production or first-time setup. | `docker compose -f deploy/docker-compose.yml up --build` |
| `docker-compose.demo.yml` | **Demo data override.** Layers 180 days of realistic seed data (15 certs, 5 agents, multiple issuers) onto the base. Dashboard charts and tables look populated on first boot. | `docker compose -f deploy/docker-compose.yml -f deploy/docker-compose.demo.yml up --build` |
| `docker-compose.dev.yml` | **Development override.** Adds PgAdmin (port 5050), debug-level logging, and a Delve debugger port (40000) for the server. | `docker compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml up --build` |
| `docker-compose.test.yml` | **Integration test environment.** 7 containers on a static-IP subnet: PostgreSQL, certctl server+agent, step-ca, Pebble ACME server, challenge test server, and NGINX. Runs the full issuance→deployment→verification flow against real CA backends. Standalone — does not combine with the base file. | `docker compose -f deploy/docker-compose.test.yml up --build` |
Override files are layered onto the base with multiple `-f` flags. The test environment is self-contained and runs independently. To reset any environment's data, add `down -v` to remove volumes.
### Kubernetes with Helm
For production deployments on Kubernetes, use the Helm chart:
@@ -404,7 +417,7 @@ export CERTCTL_API_KEY="test-key-123"
./mcp-server
```
Exposes 78 MCP tools covering the REST API via stdio transport. Ask Claude: "What certificates are expiring in the next 30 days?", "Revoke the payments cert due to key compromise", "Show me the audit trail."
Exposes the full REST API via MCP over stdio transport. Ask Claude: "What certificates are expiring in the next 30 days?", "Revoke the payments cert due to key compromise", "Show me the audit trail."
## Demo Data Reference
+5 -5
View File
@@ -39,7 +39,7 @@ Comprehensive manual testing playbook. Every test has a concrete command, an exp
- [Part 32: Request Body Size Limits](#part-32-request-body-size-limits)
- [Part 33: Apache & HAProxy Target Connectors](#part-33-apache--haproxy-target-connectors)
- [Part 34: Sub-CA Mode](#part-34-sub-ca-mode)
- [Part 35: ARI (RFC 9702) Scheduler Integration](#part-35-ari-rfc-9702-scheduler-integration)
- [Part 35: ARI (RFC 9773) Scheduler Integration](#part-35-ari-rfc-9773-scheduler-integration)
- [Part 36: Agent Work Routing (M31)](#part-36-agent-work-routing-m31)
- [Part 37: GUI Completeness (Pre-2.1.0-E)](#part-37-gui-completeness-pre-210-e)
- [Part 38: Vault PKI Connector (M32)](#part-38-vault-pki-connector-m32)
@@ -3276,7 +3276,7 @@ timeout 3 bash -c 'CERTCTL_API_KEY=$API_KEY ./certctl-mcp 2>&1' || true
### 18.2 Tool Registration
**Test 18.2.1 — Tool count verification (78 tools)**
**Test 18.2.1 — Tool count verification**
```bash
echo '{"jsonrpc":"2.0","method":"tools/list","id":1}' | \
@@ -5077,7 +5077,7 @@ openssl crl -in /tmp/subca-crl.der -inform DER -noout -issuer
---
## Part 35: ARI (RFC 9702) Scheduler Integration
## Part 35: ARI (RFC 9773) Scheduler Integration
Tests that the renewal scheduler consults ARI before creating renewal jobs for ACME-issued certificates.
@@ -6006,7 +6006,7 @@ These must be green before starting manual QA:
| 18.1.1 | Binary builds successfully | Manual | ☐ | | |
| 18.1.2 | Startup with valid env vars | Manual | ☐ | | |
| 18.1.3 | Missing CERTCTL_SERVER_URL behavior | Manual | ☐ | | |
| 18.2.1 | Tool count verification (78 tools) | Manual | ☐ | | |
| 18.2.1 | Tool count verification | Manual | ☐ | | |
| 18.2.2 | All 16 resource domains present | Manual | ☐ | | |
| 18.3.1 | List certificates via MCP | Manual | ☐ | | |
| 18.3.2 | Get specific certificate via MCP | Manual | ☐ | | |
@@ -6194,7 +6194,7 @@ These must be green before starting manual QA:
| 34.5 | Sub-CA Key Format Support | Manual | ☐ | | |
| 34.6 | CRL Signing in Sub-CA Mode | Manual | ☐ | | |
### Part 35: ARI (RFC 9702) Scheduler Integration
### Part 35: ARI (RFC 9773) Scheduler Integration
| Test | Description | Method | Pass? | Date | Notes |
|------|-------------|--------|-------|------|-------|
+11 -9
View File
@@ -32,11 +32,13 @@ This isn't a premium feature. It's the default behavior, free. Most alternatives
### 2. CA-Agnostic Issuer Architecture
certctl works with any certificate authority, not just ACME providers. Seven issuer connectors ship today, all free:
certctl works with any certificate authority, not just ACME providers. Nine issuer connectors ship today, all free:
- **ACME v2** (Let's Encrypt, ZeroSSL, Google Trust Services, Buypass) — HTTP-01, DNS-01, DNS-PERSIST-01 challenges, External Account Binding, ACME Renewal Information (RFC 9702)
- **ACME v2** (Let's Encrypt, ZeroSSL, Google Trust Services, Buypass) — HTTP-01, DNS-01, DNS-PERSIST-01 challenges, External Account Binding, ACME Renewal Information (RFC 9773), certificate profile selection
- **HashiCorp Vault PKI**`/v1/{mount}/sign/{role}` API, token auth
- **DigiCert CertCentral** — async order model, OV/EV support
- **Sectigo SCM** — async order model, DV/OV/EV support, 3-header auth
- **Google Cloud CAS** — Certificate Authority Service, OAuth2 service account auth, CA pool selection
- **step-ca** (Smallstep) — native /sign API with JWK provisioner auth
- **Local CA** — self-signed or sub-CA mode (chain to ADCS or any enterprise root)
- **OpenSSL / Custom CA** — delegate signing to any shell script
@@ -54,7 +56,7 @@ A reload command can exit 0 while the certificate doesn't take effect — wrong
The three differentiators above get the headlines, but the feature surface is wider than most paid platforms:
**10 deployment targets** — NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS (local PowerShell + remote WinRM), Postfix, and Dovecot. All use a pluggable connector model. The control plane never initiates outbound connections — agents poll for work, meaning certctl works behind firewalls, across network zones, and in air-gapped environments.
**13 deployment targets** — NGINX, Apache, HAProxy, Traefik, Caddy, Envoy, IIS (local PowerShell + remote WinRM), F5 BIG-IP (proxy agent + iControl REST), Postfix, Dovecot, SSH (agentless), Windows Certificate Store, and Java Keystore. All use a pluggable connector model. The control plane never initiates outbound connections — agents poll for work, meaning certctl works behind firewalls, across network zones, and in air-gapped environments.
**Network certificate discovery** — active TLS scanning of CIDR ranges finds certificates you didn't know existed. Agents also scan local filesystems for PEM/DER files. Everything feeds into a triage workflow where you claim, dismiss, or import discovered certs into management.
@@ -66,9 +68,9 @@ The three differentiators above get the headlines, but the feature surface is wi
**Prometheus metrics** — `/api/v1/metrics/prometheus` in standard exposition format. Works with Prometheus, Grafana Agent, Datadog Agent, Victoria Metrics.
**MCP server** — 80 tools exposing the entire API surface for AI-assisted certificate management via Claude, Cursor, or any MCP-compatible client. No other certificate platform offers this.
**MCP server** — the entire REST API is exposed via MCP for AI-assisted certificate management via Claude, Cursor, or any MCP-compatible client. No other certificate platform offers this.
**Full REST API** — 97 OpenAPI 3.1-documented operations. CLI tool with 10 subcommands. Helm chart for Kubernetes deployment. Scheduled certificate digest emails. Certificate export in PEM and PKCS#12. S/MIME support with EKU-aware issuance.
**Full REST API** — OpenAPI 3.1-documented operations covering the entire platform. CLI tool with 10 subcommands. Helm chart for Kubernetes deployment. Scheduled certificate digest emails. Certificate export in PEM and PKCS#12. S/MIME support with EKU-aware issuance.
**Extensively tested** — Go backend with race detection, static analysis (golangci-lint), and vulnerability scanning (govulncheck) on every commit. CI-enforced per-layer coverage thresholds. Frontend test suite. Every push is gated.
@@ -80,15 +82,15 @@ ACME clients solve one slice of the problem — issuance and renewal from ACME C
### vs. Agent-Based SaaS
The closest architectural competitors use the same agent model — local key generation, CSR submission, push-based deployment. Where certctl differs: it supports 7 issuer types (not just ACME), provides CRL/OCSP/revocation infrastructure (not just issuance), includes a policy engine and network discovery, and is source-available with no certificate limit. SaaS alternatives are typically proprietary, priced per certificate ($2+/cert/month), and cap their free tiers at 3-5 certificates. certctl is free for any number of certificates, forever.
The closest architectural competitors use the same agent model — local key generation, CSR submission, push-based deployment. Where certctl differs: it supports 9 issuer types (not just ACME), provides CRL/OCSP/revocation infrastructure (not just issuance), includes a policy engine and network discovery, and is source-available with no certificate limit. SaaS alternatives are typically proprietary, priced per certificate ($2+/cert/month), and cap their free tiers at 3-5 certificates. certctl is free for any number of certificates, forever.
### vs. Commercial PKI Platforms
On-prem or hosted commercial platforms offer broader cert type coverage (VPN certs, device auth, SCEP) and deeper CA integrations. The trade-off: no free tier, opaque pricing (often €13K+/year for 1,500 certs), proprietary codebases, and no public API documentation. certctl trades breadth of exotic cert types for full transparency — source-available code, 97-operation OpenAPI spec, and a free community edition with no artificial limits.
On-prem or hosted commercial platforms offer broader cert type coverage (VPN certs, device auth, SCEP) and deeper CA integrations. The trade-off: no free tier, opaque pricing (often €13K+/year for 1,500 certs), proprietary codebases, and no public API documentation. certctl trades breadth of exotic cert types for full transparency — source-available code, fully documented OpenAPI spec, and a free community edition with no artificial limits.
### vs. Enterprise Platforms
Venafi and Keyfactor offer decades of features at $75K-$250K+/year. certctl targets organizations that need 80% of those capabilities at a fraction of the cost. What certctl doesn't have yet: SSO/RBAC (coming in certctl Pro), vendor SLA-backed support. What certctl does have that enterprise platforms don't: an MCP server for AI-assisted management, ACME ARI (RFC 9702) for CA-directed renewal timing, and a deployment model that works in 5 minutes instead of 5 months.
Venafi and Keyfactor offer decades of features at $75K-$250K+/year. certctl targets organizations that need 80% of those capabilities at a fraction of the cost. What certctl doesn't have yet: SSO/RBAC (coming in certctl Pro), vendor SLA-backed support. What certctl does have that enterprise platforms don't: an MCP server for AI-assisted management, ACME ARI (RFC 9773) for CA-directed renewal timing, and a deployment model that works in 5 minutes instead of 5 months.
## Who Should Look Elsewhere
@@ -100,7 +102,7 @@ certctl isn't the right tool for everyone:
## See It Running
The demo seeds 32 certificates across 7 issuers, 8 agents, 6 deployment targets, and 180 days of realistic history — jobs, audit events, discovery scans, approval workflows — so you can explore every feature immediately.
The demo seeds certificates across multiple issuers, agents, and deployment targets with 180 days of realistic history — jobs, audit events, discovery scans, approval workflows — so you can explore every feature immediately.
```bash
git clone https://github.com/shankar0123/certctl.git
@@ -88,7 +88,7 @@ services:
# Default is 30s; increase if your DNS propagates slowly
# Set via CERTCTL_ACME_DNS_PROPAGATION_WAIT in code, or rely on default
# Optional: Let's Encrypt Renewal Information (RFC 9702) for CA-directed renewal timing
# Optional: Let's Encrypt Renewal Information (RFC 9773) for CA-directed renewal timing
# CERTCTL_ACME_ARI_ENABLED: "true"
# Local CA as fallback for internal services (optional)
+7 -5
View File
@@ -10,7 +10,9 @@ require (
)
require (
golang.org/x/crypto v0.31.0
github.com/masterzen/winrm v0.0.0-20250927112105-5f8e6c707321
github.com/pkg/sftp v1.13.10
golang.org/x/crypto v0.41.0
software.sslmate.com/src/go-pkcs12 v0.7.0
)
@@ -48,11 +50,11 @@ require (
github.com/jcmturner/gokrb5/v8 v8.4.4 // indirect
github.com/jcmturner/rpc/v2 v2.0.3 // indirect
github.com/klauspost/compress v1.17.4 // indirect
github.com/kr/fs v0.1.0 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
github.com/magiconair/properties v1.8.7 // indirect
github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect
github.com/masterzen/winrm v0.0.0-20250927112105-5f8e6c707321 // indirect
github.com/moby/docker-image-spec v1.3.1 // indirect
github.com/moby/patternmatcher v0.6.0 // indirect
github.com/moby/sys/sequential v0.5.0 // indirect
@@ -69,7 +71,7 @@ require (
github.com/shirou/gopsutil/v3 v3.23.12 // indirect
github.com/shoenig/go-m1cpu v0.1.6 // indirect
github.com/sirupsen/logrus v1.9.3 // indirect
github.com/stretchr/testify v1.9.0 // indirect
github.com/stretchr/testify v1.10.0 // indirect
github.com/tidwall/transform v0.0.0-20201103190739-32f242e2dbde // indirect
github.com/tklauser/go-sysconf v0.3.12 // indirect
github.com/tklauser/numcpus v0.6.1 // indirect
@@ -79,9 +81,9 @@ require (
go.opentelemetry.io/otel v1.24.0 // indirect
go.opentelemetry.io/otel/metric v1.24.0 // indirect
go.opentelemetry.io/otel/trace v1.24.0 // indirect
golang.org/x/net v0.23.0 // indirect
golang.org/x/net v0.42.0 // indirect
golang.org/x/oauth2 v0.34.0 // indirect
golang.org/x/sys v0.40.0 // indirect
golang.org/x/text v0.21.0 // indirect
golang.org/x/text v0.28.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
+16 -10
View File
@@ -62,7 +62,9 @@ github.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbc
github.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/securecookie v1.1.1 h1:miw7JPhV+b/lAHSXz4qd/nN9jRiAFV5FwjeKyCS8BvQ=
github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4=
github.com/gorilla/sessions v1.2.1 h1:DHd3rPN5lE3Ts3D8rKkQ8x/0kqfeNmBAaiSi+o7FsgI=
github.com/gorilla/sessions v1.2.1/go.mod h1:dk2InVEVJ0sfLlnXv9EAgkf6ecYs/i80K/zI+bUmuGM=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0 h1:YBftPWNWd4WwGqtY2yeZL2ef8rHAxPBD8KFhJpmcqms=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0/go.mod h1:YN5jB8ie0yfIUg6VvR9Kz84aCaG7AsGZnLjhHbUqwPg=
@@ -87,6 +89,8 @@ github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
github.com/klauspost/compress v1.17.4 h1:Ej5ixsIri7BrIjBkRZLTo6ghwrEtHFk7ijlczPW4fZ4=
github.com/klauspost/compress v1.17.4/go.mod h1:/dCuZOvVtNoHsyb+cuJD3itjs3NbnF6KH9zAO4BDxPM=
github.com/kr/fs v0.1.0 h1:Jskdu9ieNAYnjxsi0LbQp1ulIKZV1LAFgK1tWhpZgl8=
github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
@@ -121,6 +125,8 @@ github.com/opencontainers/image-spec v1.1.0 h1:8SG7/vwALn54lVB/0yZ/MMwhFrPYtpEHQ
github.com/opencontainers/image-spec v1.1.0/go.mod h1:W4s4sFTMaBeK1BQLXbG4AdM2szdn85PY75RI83NrTrM=
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pkg/sftp v1.13.10 h1:+5FbKNTe5Z9aspU88DPIKJ9z2KZoaGCu6Sr6kKR/5mU=
github.com/pkg/sftp v1.13.10/go.mod h1:bJ1a7uDhrX/4OII+agvy28lzRvQrmIQuaHrcI1HbeGA=
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/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c h1:ncq/mPwQF4JjgDlrVEn3C11VoGHZN7m8qihwgMEtzYw=
@@ -150,8 +156,8 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/testcontainers/testcontainers-go v0.35.0 h1:uADsZpTKFAtp8SLK+hMwSaa+X+JiERHtd4sQAFmXeMo=
github.com/testcontainers/testcontainers-go v0.35.0/go.mod h1:oEVBj5zrfJTrgjwONs1SsRbnBtH9OKl+IGl3UMcr2B4=
github.com/tidwall/transform v0.0.0-20201103190739-32f242e2dbde h1:AMNpJRc7P+GTwVbl8DkK2I9I8BBUzNiHuH/tlxrpan0=
@@ -188,8 +194,8 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58=
golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
golang.org/x/crypto v0.41.0 h1:WKYxWedPGCTVVl5+WHSSrOBT0O8lx32+zxmHxijgXp4=
golang.org/x/crypto v0.41.0/go.mod h1:pO5AFd7FA68rFak7rOAGVuygIISepHftHnr8dr6+sUc=
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
@@ -202,8 +208,8 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs=
golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs=
golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8=
golang.org/x/oauth2 v0.34.0 h1:hqK/t4AKgbqWkdkcAeI8XLmbK+4m4G5YeQRrmiotGlw=
golang.org/x/oauth2 v0.34.0/go.mod h1:lzm5WQJQwKZ3nwavOZ3IS5Aulzxi68dUSgRHujetwEA=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -230,14 +236,14 @@ golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
golang.org/x/term v0.27.0 h1:WP60Sv1nlK1T6SupCHbXzSaN0b9wUmsPoRS9b61A23Q=
golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM=
golang.org/x/term v0.34.0 h1:O/2T7POpk0ZZ7MAzMeWFSg6S5IpWd/RXDlM9hgM3DR4=
golang.org/x/term v0.34.0/go.mod h1:5jC53AEywhIVebHgPVeg0mj8OD3VO9OzclacVrqpaAw=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 h1:vVKdlvoWBphwdxWKrFZEuM0kGgGLxUOYcY4U/2Vjg44=
golang.org/x/time v0.0.0-20220210224613-90d013bbcef8/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+8 -1
View File
@@ -325,7 +325,13 @@ type ACMEConfig struct {
// The record value becomes: "<issuer_domain>; accounturi=<acme_account_uri>"
DNSPersistIssuerDomain string
// ARIEnabled enables ACME Renewal Information (RFC 9702) support.
// Profile selects the ACME certificate profile for newOrder requests.
// Let's Encrypt supports "tlsserver" (standard TLS) and "shortlived" (6-day certs).
// Leave empty for the CA's default profile (backward-compatible).
// Setting: CERTCTL_ACME_PROFILE environment variable.
Profile string
// ARIEnabled enables ACME Renewal Information (RFC 9773) support.
// When enabled, the renewal scheduler queries the CA for suggested renewal windows
// instead of relying solely on static expiration thresholds.
// Default: false. Requires a CA that supports ARI (e.g., Let's Encrypt).
@@ -598,6 +604,7 @@ func Load() (*Config, error) {
DNSPresentScript: getEnv("CERTCTL_ACME_DNS_PRESENT_SCRIPT", ""),
DNSCleanUpScript: getEnv("CERTCTL_ACME_DNS_CLEANUP_SCRIPT", ""),
DNSPersistIssuerDomain: getEnv("CERTCTL_ACME_DNS_PERSIST_ISSUER_DOMAIN", ""),
Profile: getEnv("CERTCTL_ACME_PROFILE", ""),
ARIEnabled: getEnvBool("CERTCTL_ACME_ARI_ENABLED", false),
Insecure: getEnvBool("CERTCTL_ACME_INSECURE", false),
},
+18 -3
View File
@@ -56,7 +56,13 @@ type Config struct {
// Required when ChallengeType is "dns-persist-01". For Let's Encrypt, use "letsencrypt.org".
DNSPersistIssuerDomain string `json:"dns_persist_issuer_domain,omitempty"`
// ARIEnabled enables ACME Renewal Information (RFC 9702) support per CERTCTL_ACME_ARI_ENABLED.
// Profile selects the ACME certificate profile for the newOrder request.
// Let's Encrypt supports "tlsserver" (standard TLS, default) and "shortlived" (6-day certs).
// Leave empty for the CA's default profile (backward-compatible).
// See: https://letsencrypt.org/2025/01/09/acme-profiles.html
Profile string `json:"profile,omitempty"`
// ARIEnabled enables ACME Renewal Information (RFC 9773) support per CERTCTL_ACME_ARI_ENABLED.
// When enabled, the connector queries the CA's ARI endpoint to get CA-directed renewal timing.
ARIEnabled bool `json:"ari_enabled,omitempty"`
@@ -184,6 +190,15 @@ func (c *Connector) ValidateConfig(ctx context.Context, rawConfig json.RawMessag
return fmt.Errorf("invalid challenge_type: %s (must be http-01, dns-01, or dns-persist-01)", cfg.ChallengeType)
}
// Validate profile if set (alphanumeric + hyphens only)
if cfg.Profile != "" {
for _, ch := range cfg.Profile {
if !((ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') || (ch >= '0' && ch <= '9') || ch == '-') {
return fmt.Errorf("invalid profile: %q (must contain only alphanumeric characters and hyphens)", cfg.Profile)
}
}
}
// DNS-01 and DNS-PERSIST-01 require a present script
if (cfg.ChallengeType == "dns-01" || cfg.ChallengeType == "dns-persist-01") && cfg.DNSPresentScript == "" {
return fmt.Errorf("dns_present_script is required for %s challenge type", cfg.ChallengeType)
@@ -355,8 +370,8 @@ func (c *Connector) IssueCertificate(ctx context.Context, request issuer.Issuanc
// Build the list of identifiers (domains)
identifiers := buildIdentifiers(request.CommonName, request.SANs)
// Step 1: Create order
order, err := c.client.AuthorizeOrder(ctx, identifiers)
// Step 1: Create order (with optional profile for CAs that support it)
order, err := c.authorizeOrderWithProfile(ctx, identifiers, c.config.Profile)
if err != nil {
return nil, fmt.Errorf("failed to create ACME order: %w", err)
}
+2 -2
View File
@@ -15,7 +15,7 @@ import (
"github.com/shankar0123/certctl/internal/connector/issuer"
)
// GetRenewalInfo retrieves ACME Renewal Information (ARI) per RFC 9702 for a certificate.
// GetRenewalInfo retrieves ACME Renewal Information (ARI) per RFC 9773 for a certificate.
// certPEM is the PEM-encoded certificate. Returns nil, nil if the CA does not support ARI.
func (c *Connector) GetRenewalInfo(ctx context.Context, certPEM string) (*issuer.RenewalInfoResult, error) {
if !c.config.ARIEnabled {
@@ -102,7 +102,7 @@ func (c *Connector) GetRenewalInfo(ctx context.Context, certPEM string) (*issuer
}, nil
}
// computeARICertID computes the ARI certificate ID as defined in RFC 9702.
// computeARICertID computes the ARI certificate ID as defined in RFC 9773.
// The cert ID is base64url(SHA256(DER encoding of the certificate)).
func computeARICertID(certPEM string) (string, error) {
block, _ := pem.Decode([]byte(certPEM))
+252
View File
@@ -0,0 +1,252 @@
package acme
import (
"context"
"crypto/ecdsa"
"crypto/rand"
"crypto/sha256"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"net/http"
"strings"
goacme "golang.org/x/crypto/acme"
)
// profileOrderRequest is the JSON body for a newOrder request with optional profile field.
// The profile field is an ACME extension for certificate profile selection
// (e.g., Let's Encrypt "shortlived" for 6-day certs, "tlsserver" for standard TLS).
type profileOrderRequest struct {
Identifiers []wireAuthzID `json:"identifiers"`
NotBefore string `json:"notBefore,omitempty"`
NotAfter string `json:"notAfter,omitempty"`
Profile string `json:"profile,omitempty"`
}
// wireAuthzID matches the ACME wire format for authorization identifiers.
type wireAuthzID struct {
Type string `json:"type"`
Value string `json:"value"`
}
// profileOrderResponse represents a parsed ACME order response.
type profileOrderResponse struct {
Status string `json:"status"`
Expires string `json:"expires,omitempty"`
Identifiers []wireAuthzID `json:"identifiers"`
AuthzURLs []string `json:"authorizations"`
FinalizeURL string `json:"finalize"`
CertURL string `json:"certificate,omitempty"`
Error *goacme.Error `json:"error,omitempty"`
}
// authorizeOrderWithProfile creates a new ACME order with an optional certificate profile.
// This bypasses acme.Client.AuthorizeOrder() because the Go ACME library does not support
// the "profile" field in newOrder requests (as of golang.org/x/crypto v0.49.0).
//
// When profile is empty, this delegates to the standard acme.Client.AuthorizeOrder().
// When profile is set, it performs a custom JWS-signed POST to the newOrder endpoint
// with the profile field included in the request body.
func (c *Connector) authorizeOrderWithProfile(ctx context.Context, identifiers []goacme.AuthzID, profile string) (*goacme.Order, error) {
// Fast path: no profile → use the standard library path
if profile == "" {
return c.client.AuthorizeOrder(ctx, identifiers)
}
c.logger.Info("creating ACME order with profile", "profile", profile)
// Discover the directory to get the newOrder URL
dir, err := c.client.Discover(ctx)
if err != nil {
return nil, fmt.Errorf("ACME directory discovery failed: %w", err)
}
if dir.OrderURL == "" {
return nil, fmt.Errorf("ACME directory has no newOrder URL")
}
// Get the account URL (kid) for the JWS protected header
acct, err := c.client.GetReg(ctx, "")
if err != nil {
return nil, fmt.Errorf("failed to get ACME account for JWS signing: %w", err)
}
// Build the order request with profile
var wireIDs []wireAuthzID
for _, id := range identifiers {
wireIDs = append(wireIDs, wireAuthzID{Type: id.Type, Value: id.Value})
}
orderReq := profileOrderRequest{
Identifiers: wireIDs,
Profile: profile,
}
payload, err := json.Marshal(orderReq)
if err != nil {
return nil, fmt.Errorf("marshal order request: %w", err)
}
// Fetch a fresh nonce
nonce, err := c.fetchNonce(ctx, dir.NonceURL)
if err != nil {
return nil, fmt.Errorf("fetch nonce: %w", err)
}
// Sign the request with JWS (ES256, kid mode)
jwsBody, err := signJWS(c.accountKey, acct.URI, nonce, dir.OrderURL, payload)
if err != nil {
return nil, fmt.Errorf("JWS signing: %w", err)
}
// POST the JWS-signed request
req, err := http.NewRequestWithContext(ctx, http.MethodPost, dir.OrderURL, strings.NewReader(string(jwsBody)))
if err != nil {
return nil, fmt.Errorf("create request: %w", err)
}
req.Header.Set("Content-Type", "application/jose+json")
httpClient := c.httpClient()
resp, err := httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("newOrder request failed: %w", err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("read newOrder response: %w", err)
}
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
return nil, fmt.Errorf("newOrder returned status %d: %s", resp.StatusCode, string(body))
}
// Parse the response into an acme.Order-compatible struct
var orderResp profileOrderResponse
if err := json.Unmarshal(body, &orderResp); err != nil {
return nil, fmt.Errorf("parse newOrder response: %w", err)
}
// The order URI comes from the Location header
orderURI := resp.Header.Get("Location")
order := &goacme.Order{
URI: orderURI,
Status: orderResp.Status,
AuthzURLs: orderResp.AuthzURLs,
FinalizeURL: orderResp.FinalizeURL,
CertURL: orderResp.CertURL,
}
// Parse identifiers back
for _, wid := range orderResp.Identifiers {
order.Identifiers = append(order.Identifiers, goacme.AuthzID{Type: wid.Type, Value: wid.Value})
}
c.logger.Info("ACME order created with profile",
"profile", profile,
"order_url", orderURI,
"status", order.Status)
return order, nil
}
// fetchNonce retrieves a fresh anti-replay nonce from the ACME server.
func (c *Connector) fetchNonce(ctx context.Context, nonceURL string) (string, error) {
if nonceURL == "" {
return "", fmt.Errorf("no nonce URL available")
}
req, err := http.NewRequestWithContext(ctx, http.MethodHead, nonceURL, nil)
if err != nil {
return "", fmt.Errorf("create nonce request: %w", err)
}
httpClient := c.httpClient()
resp, err := httpClient.Do(req)
if err != nil {
return "", fmt.Errorf("nonce request failed: %w", err)
}
defer resp.Body.Close()
nonce := resp.Header.Get("Replay-Nonce")
if nonce == "" {
return "", fmt.Errorf("server did not return a Replay-Nonce header")
}
return nonce, nil
}
// signJWS creates a JWS (JSON Web Signature) in flattened JSON serialization
// using ES256 (ECDSA P-256 with SHA-256) in kid mode per RFC 8555.
//
// The JWS protected header contains:
// - alg: ES256
// - kid: account URL
// - nonce: anti-replay nonce
// - url: the target URL
func signJWS(key *ecdsa.PrivateKey, kid, nonce, targetURL string, payload []byte) ([]byte, error) {
// Build protected header
header := struct {
Alg string `json:"alg"`
Kid string `json:"kid"`
Nonce string `json:"nonce"`
URL string `json:"url"`
}{
Alg: "ES256",
Kid: kid,
Nonce: nonce,
URL: targetURL,
}
headerJSON, err := json.Marshal(header)
if err != nil {
return nil, fmt.Errorf("marshal JWS header: %w", err)
}
// Base64url encode protected header and payload
protectedB64 := base64.RawURLEncoding.EncodeToString(headerJSON)
payloadB64 := base64.RawURLEncoding.EncodeToString(payload)
// Create the signing input: ASCII(BASE64URL(header)) || '.' || ASCII(BASE64URL(payload))
signingInput := protectedB64 + "." + payloadB64
// Sign with ES256 (ECDSA P-256 + SHA-256)
hash := sha256.Sum256([]byte(signingInput))
r, s, err := ecdsa.Sign(rand.Reader, key, hash[:])
if err != nil {
return nil, fmt.Errorf("ECDSA sign: %w", err)
}
// Encode signature as fixed-size concatenation of r and s (32 bytes each for P-256)
curveBits := key.Curve.Params().BitSize
keyBytes := curveBits / 8
if curveBits%8 > 0 {
keyBytes++
}
sig := make([]byte, 2*keyBytes)
rBytes := r.Bytes()
sBytes := s.Bytes()
copy(sig[keyBytes-len(rBytes):keyBytes], rBytes)
copy(sig[2*keyBytes-len(sBytes):], sBytes)
sigB64 := base64.RawURLEncoding.EncodeToString(sig)
// Build flattened JWS JSON
jws := struct {
Protected string `json:"protected"`
Payload string `json:"payload"`
Signature string `json:"signature"`
}{
Protected: protectedB64,
Payload: payloadB64,
Signature: sigB64,
}
return json.Marshal(jws)
}
@@ -0,0 +1,444 @@
package acme
import (
"context"
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/sha256"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"log/slog"
"math/big"
"net/http"
"net/http/httptest"
"os"
"strings"
"testing"
goacme "golang.org/x/crypto/acme"
)
// verifyJWSSignature is a test helper that verifies a JWS signature.
func verifyJWSSignature(jwsJSON []byte, pubKey *ecdsa.PublicKey) error {
var jws struct {
Protected string `json:"protected"`
Payload string `json:"payload"`
Signature string `json:"signature"`
}
if err := json.Unmarshal(jwsJSON, &jws); err != nil {
return fmt.Errorf("unmarshal JWS: %w", err)
}
signingInput := jws.Protected + "." + jws.Payload
hash := sha256.Sum256([]byte(signingInput))
sigBytes, err := base64.RawURLEncoding.DecodeString(jws.Signature)
if err != nil {
return fmt.Errorf("decode signature: %w", err)
}
keyBytes := pubKey.Curve.Params().BitSize / 8
if len(sigBytes) != 2*keyBytes {
return fmt.Errorf("invalid signature length: %d (expected %d)", len(sigBytes), 2*keyBytes)
}
r := new(big.Int).SetBytes(sigBytes[:keyBytes])
s := new(big.Int).SetBytes(sigBytes[keyBytes:])
if !ecdsa.Verify(pubKey, hash[:], r, s) {
return fmt.Errorf("signature verification failed")
}
return nil
}
func TestValidateConfig_ProfileValid(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
fmt.Fprint(w, `{"newNonce":"","newAccount":"","newOrder":""}`)
}))
defer srv.Close()
c := New(nil, testLogger())
cfg, _ := json.Marshal(map[string]string{
"directory_url": srv.URL,
"email": "test@example.com",
"profile": "shortlived",
})
err := c.ValidateConfig(context.Background(), cfg)
if err != nil {
t.Fatalf("expected success with valid profile, got: %v", err)
}
if c.config.Profile != "shortlived" {
t.Errorf("expected profile 'shortlived', got: %s", c.config.Profile)
}
}
func TestValidateConfig_ProfileTLSServer(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
fmt.Fprint(w, `{"newNonce":"","newAccount":"","newOrder":""}`)
}))
defer srv.Close()
c := New(nil, testLogger())
cfg, _ := json.Marshal(map[string]string{
"directory_url": srv.URL,
"email": "test@example.com",
"profile": "tlsserver",
})
err := c.ValidateConfig(context.Background(), cfg)
if err != nil {
t.Fatalf("expected success with valid profile, got: %v", err)
}
}
func TestValidateConfig_ProfileEmpty(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
fmt.Fprint(w, `{"newNonce":"","newAccount":"","newOrder":""}`)
}))
defer srv.Close()
c := New(nil, testLogger())
cfg, _ := json.Marshal(map[string]string{
"directory_url": srv.URL,
"email": "test@example.com",
"profile": "",
})
err := c.ValidateConfig(context.Background(), cfg)
if err != nil {
t.Fatalf("expected success with empty profile, got: %v", err)
}
if c.config.Profile != "" {
t.Errorf("expected empty profile, got: %s", c.config.Profile)
}
}
func TestValidateConfig_ProfileInvalid(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
fmt.Fprint(w, `{"newNonce":"","newAccount":"","newOrder":""}`)
}))
defer srv.Close()
c := New(nil, testLogger())
cfg, _ := json.Marshal(map[string]string{
"directory_url": srv.URL,
"email": "test@example.com",
"profile": "short lived!",
})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "invalid profile") {
t.Fatalf("expected invalid profile error, got: %v", err)
}
}
func TestSignJWS_ES256(t *testing.T) {
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
t.Fatal(err)
}
payload := []byte(`{"identifiers":[{"type":"dns","value":"example.com"}],"profile":"shortlived"}`)
jwsBody, err := signJWS(key, "https://acme.example.com/acct/1", "nonce-abc", "https://acme.example.com/new-order", payload)
if err != nil {
t.Fatalf("signJWS failed: %v", err)
}
// Parse the JWS
var jws struct {
Protected string `json:"protected"`
Payload string `json:"payload"`
Signature string `json:"signature"`
}
if err := json.Unmarshal(jwsBody, &jws); err != nil {
t.Fatalf("JWS is not valid JSON: %v", err)
}
// Verify protected header
headerBytes, err := base64.RawURLEncoding.DecodeString(jws.Protected)
if err != nil {
t.Fatalf("decode protected header: %v", err)
}
var header struct {
Alg string `json:"alg"`
Kid string `json:"kid"`
Nonce string `json:"nonce"`
URL string `json:"url"`
}
if err := json.Unmarshal(headerBytes, &header); err != nil {
t.Fatalf("parse header: %v", err)
}
if header.Alg != "ES256" {
t.Errorf("expected alg ES256, got: %s", header.Alg)
}
if header.Kid != "https://acme.example.com/acct/1" {
t.Errorf("expected kid URL, got: %s", header.Kid)
}
if header.Nonce != "nonce-abc" {
t.Errorf("expected nonce, got: %s", header.Nonce)
}
if header.URL != "https://acme.example.com/new-order" {
t.Errorf("expected url, got: %s", header.URL)
}
// Verify payload
payloadBytes, err := base64.RawURLEncoding.DecodeString(jws.Payload)
if err != nil {
t.Fatalf("decode payload: %v", err)
}
var payloadObj struct {
Profile string `json:"profile"`
}
if err := json.Unmarshal(payloadBytes, &payloadObj); err != nil {
t.Fatalf("parse payload: %v", err)
}
if payloadObj.Profile != "shortlived" {
t.Errorf("expected profile 'shortlived' in payload, got: %s", payloadObj.Profile)
}
// Verify signature
if err := verifyJWSSignature(jwsBody, &key.PublicKey); err != nil {
t.Fatalf("signature verification failed: %v", err)
}
}
func TestAuthorizeOrderWithProfile_EmptyProfile_DelegatesToStandard(t *testing.T) {
// When profile is empty, authorizeOrderWithProfile should call the standard
// acme.Client.AuthorizeOrder. Since we can't mock a full ACME server for that,
// we verify it returns an error (unreachable server) rather than trying the custom path.
c := New(&Config{
DirectoryURL: "https://127.0.0.1:1/directory",
Email: "test@example.com",
ChallengeType: "http-01",
Profile: "",
}, testLogger())
// Need to initialize the client first
c.accountKey, _ = ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
c.client = &goacme.Client{
Key: c.accountKey,
DirectoryURL: c.config.DirectoryURL,
}
identifiers := []goacme.AuthzID{{Type: "dns", Value: "example.com"}}
_, err := c.authorizeOrderWithProfile(context.Background(), identifiers, "")
// Expected: network error from standard acme.Client.AuthorizeOrder
if err == nil {
t.Fatal("expected error from unreachable server")
}
}
func TestAuthorizeOrderWithProfile_WithProfile_SendsProfileInBody(t *testing.T) {
var receivedBody []byte
// Mock ACME server that captures the newOrder request body
mockSrv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/directory":
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(map[string]string{
"newNonce": r.Host + "/new-nonce",
"newAccount": r.Host + "/new-account",
"newOrder": "http://" + r.Host + "/new-order",
})
case "/new-nonce":
w.Header().Set("Replay-Nonce", "test-nonce-12345")
w.WriteHeader(http.StatusOK)
case "/acme/acct/1":
// Account lookup
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(map[string]interface{}{
"status": "valid",
})
case "/new-order":
// Capture the JWS body
body, _ := io.ReadAll(r.Body)
receivedBody = body
// Return a valid order response
w.Header().Set("Location", "http://"+r.Host+"/order/123")
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(map[string]interface{}{
"status": "pending",
"identifiers": []map[string]string{
{"type": "dns", "value": "example.com"},
},
"authorizations": []string{"http://" + r.Host + "/authz/1"},
"finalize": "http://" + r.Host + "/finalize/123",
})
default:
http.NotFound(w, r)
}
}))
defer mockSrv.Close()
logger := slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelError}))
c := New(&Config{
DirectoryURL: mockSrv.URL + "/directory",
Email: "test@example.com",
ChallengeType: "http-01",
Profile: "shortlived",
}, logger)
// Initialize client manually (bypass full ACME registration)
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
c.accountKey = key
c.client = &goacme.Client{
Key: key,
DirectoryURL: c.config.DirectoryURL,
HTTPClient: c.httpClient(),
}
identifiers := []goacme.AuthzID{{Type: "dns", Value: "example.com"}}
order, err := c.authorizeOrderWithProfile(context.Background(), identifiers, "shortlived")
// The call may fail at GetReg since we're not running a real ACME server.
// That's okay — we primarily want to verify the profile flow is entered.
if err != nil {
// Expected: GetReg will fail since we don't have a real ACME account.
// But let's check if it at least tried the profile path by checking the error message.
if strings.Contains(err.Error(), "ACME account") || strings.Contains(err.Error(), "JWS signing") || strings.Contains(err.Error(), "newOrder") {
// This is expected — the profile path was entered but the mock doesn't support full ACME
t.Logf("profile path entered, expected error from mock: %v", err)
return
}
t.Fatalf("unexpected error: %v", err)
}
// If we got an order, verify it
if order != nil {
if order.Status != "pending" {
t.Errorf("expected status pending, got: %s", order.Status)
}
// Verify the JWS body contained the profile field
if len(receivedBody) > 0 {
// Parse the JWS to extract the payload
var jws struct {
Payload string `json:"payload"`
}
if err := json.Unmarshal(receivedBody, &jws); err == nil {
payloadBytes, _ := base64.RawURLEncoding.DecodeString(jws.Payload)
var payload struct {
Profile string `json:"profile"`
}
if err := json.Unmarshal(payloadBytes, &payload); err == nil {
if payload.Profile != "shortlived" {
t.Errorf("expected profile 'shortlived' in JWS payload, got: %q", payload.Profile)
}
}
}
}
}
}
func TestProfileOrderRequest_NoProfile_OmitsField(t *testing.T) {
req := profileOrderRequest{
Identifiers: []wireAuthzID{{Type: "dns", Value: "example.com"}},
Profile: "",
}
data, err := json.Marshal(req)
if err != nil {
t.Fatal(err)
}
// With omitempty, empty profile should not appear in JSON
if strings.Contains(string(data), "profile") {
t.Errorf("expected no profile field in JSON when empty, got: %s", string(data))
}
}
func TestProfileOrderRequest_WithProfile_IncludesField(t *testing.T) {
req := profileOrderRequest{
Identifiers: []wireAuthzID{{Type: "dns", Value: "example.com"}},
Profile: "shortlived",
}
data, err := json.Marshal(req)
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), `"profile":"shortlived"`) {
t.Errorf("expected profile field in JSON, got: %s", string(data))
}
}
func TestConfigProfileUnmarshal(t *testing.T) {
// Verify that the factory (json.Unmarshal) correctly picks up the profile field
configJSON := `{"directory_url":"https://acme.example.com/dir","email":"test@example.com","profile":"shortlived","ari_enabled":true}`
var cfg Config
if err := json.Unmarshal([]byte(configJSON), &cfg); err != nil {
t.Fatalf("unmarshal failed: %v", err)
}
if cfg.Profile != "shortlived" {
t.Errorf("expected profile 'shortlived', got: %q", cfg.Profile)
}
if cfg.DirectoryURL != "https://acme.example.com/dir" {
t.Errorf("expected directory URL, got: %q", cfg.DirectoryURL)
}
if !cfg.ARIEnabled {
t.Error("expected ARIEnabled true")
}
}
func TestConfigProfileUnmarshal_Empty(t *testing.T) {
// Empty profile should remain empty (backward compat)
configJSON := `{"directory_url":"https://acme.example.com/dir","email":"test@example.com"}`
var cfg Config
if err := json.Unmarshal([]byte(configJSON), &cfg); err != nil {
t.Fatalf("unmarshal failed: %v", err)
}
if cfg.Profile != "" {
t.Errorf("expected empty profile, got: %q", cfg.Profile)
}
}
func TestFetchNonce_Success(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Replay-Nonce", "test-nonce-xyz")
w.WriteHeader(http.StatusOK)
}))
defer srv.Close()
c := New(&Config{
DirectoryURL: srv.URL + "/directory",
}, testLogger())
nonce, err := c.fetchNonce(context.Background(), srv.URL+"/new-nonce")
if err != nil {
t.Fatalf("fetchNonce failed: %v", err)
}
if nonce != "test-nonce-xyz" {
t.Errorf("expected nonce 'test-nonce-xyz', got: %s", nonce)
}
}
func TestFetchNonce_MissingHeader(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
}))
defer srv.Close()
c := New(&Config{
DirectoryURL: srv.URL + "/directory",
}, testLogger())
_, err := c.fetchNonce(context.Background(), srv.URL+"/new-nonce")
if err == nil || !strings.Contains(err.Error(), "Replay-Nonce") {
t.Fatalf("expected missing nonce error, got: %v", err)
}
}
+1 -1
View File
@@ -36,7 +36,7 @@ type Connector interface {
// Used by the EST /cacerts endpoint. Returns empty string if not available.
GetCACertPEM(ctx context.Context) (string, error)
// GetRenewalInfo retrieves ACME Renewal Information (ARI) per RFC 9702 for a certificate.
// GetRenewalInfo retrieves ACME Renewal Information (ARI) per RFC 9773 for a certificate.
// certPEM is the PEM-encoded certificate. Returns nil, nil if the CA does not support ARI.
GetRenewalInfo(ctx context.Context, certPEM string) (*RenewalInfoResult, error)
}
@@ -0,0 +1,125 @@
// Package certutil provides shared certificate utility functions for target connectors.
// These functions handle PEM/PFX conversion, key parsing, thumbprint computation,
// and random password generation. Extracted from the IIS connector (M39) to enable
// reuse by Windows Certificate Store (M46) and Java Keystore (M46) connectors.
package certutil
import (
"crypto/rand"
"crypto/sha1"
"crypto/x509"
"encoding/hex"
"encoding/pem"
"fmt"
"strings"
pkcs12 "software.sslmate.com/src/go-pkcs12"
)
// CreatePFX converts PEM-encoded cert, key, and chain into PKCS#12 (PFX) format.
// Uses go-pkcs12 Modern encoder with strong encryption.
func CreatePFX(certPEM, keyPEM, chainPEM string, password string) ([]byte, error) {
// Parse leaf certificate
certBlock, _ := pem.Decode([]byte(certPEM))
if certBlock == nil || certBlock.Type != "CERTIFICATE" {
return nil, fmt.Errorf("failed to decode certificate PEM")
}
leafCert, err := x509.ParseCertificate(certBlock.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse leaf certificate: %w", err)
}
// Parse private key (supports PKCS#8, PKCS#1 RSA, and EC)
keyBlock, _ := pem.Decode([]byte(keyPEM))
if keyBlock == nil {
return nil, fmt.Errorf("failed to decode private key PEM")
}
privateKey, err := ParsePrivateKey(keyBlock.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse private key: %w", err)
}
// Parse CA chain certificates (optional)
var caCerts []*x509.Certificate
if chainPEM != "" {
rest := []byte(chainPEM)
for {
var block *pem.Block
block, rest = pem.Decode(rest)
if block == nil {
break
}
if block.Type != "CERTIFICATE" {
continue
}
caCert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse CA certificate: %w", err)
}
caCerts = append(caCerts, caCert)
}
}
// Encode as PKCS#12 with Modern encryption
pfxData, err := pkcs12.Modern.Encode(privateKey, leafCert, caCerts, password)
if err != nil {
return nil, fmt.Errorf("failed to encode PKCS#12: %w", err)
}
return pfxData, nil
}
// ParsePrivateKey attempts to parse a DER-encoded private key.
// Tries PKCS#8, PKCS#1 RSA, and EC formats in order.
func ParsePrivateKey(der []byte) (interface{}, error) {
if key, err := x509.ParsePKCS8PrivateKey(der); err == nil {
return key, nil
}
if key, err := x509.ParsePKCS1PrivateKey(der); err == nil {
return key, nil
}
if key, err := x509.ParseECPrivateKey(der); err == nil {
return key, nil
}
return nil, fmt.Errorf("unsupported private key format")
}
// ComputeThumbprint calculates the SHA-1 thumbprint of a PEM-encoded certificate.
// Windows uses SHA-1 thumbprints as the primary certificate identifier.
// Returns uppercase hex string matching Windows certutil output.
func ComputeThumbprint(certPEM string) (string, error) {
block, _ := pem.Decode([]byte(certPEM))
if block == nil || block.Type != "CERTIFICATE" {
return "", fmt.Errorf("failed to decode certificate PEM for thumbprint")
}
hash := sha1.Sum(block.Bytes)
return strings.ToUpper(hex.EncodeToString(hash[:])), nil
}
// GenerateRandomPassword creates a random alphanumeric password.
// Typically used for transient PFX encryption — the password is only used
// between PFX creation and import, it never persists.
func GenerateRandomPassword(length int) (string, error) {
const charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
b := make([]byte, length)
if _, err := rand.Read(b); err != nil {
return "", fmt.Errorf("failed to read random bytes: %w", err)
}
for i := range b {
b[i] = charset[int(b[i])%len(charset)]
}
return string(b), nil
}
// ParseCertificatePEM parses a PEM-encoded certificate and returns the x509.Certificate.
func ParseCertificatePEM(certPEM string) (*x509.Certificate, error) {
block, _ := pem.Decode([]byte(certPEM))
if block == nil || block.Type != "CERTIFICATE" {
return nil, fmt.Errorf("failed to decode certificate PEM")
}
cert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse certificate: %w", err)
}
return cert, nil
}
@@ -0,0 +1,189 @@
package certutil
import (
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/x509"
"crypto/x509/pkix"
"encoding/pem"
"math/big"
"testing"
"time"
)
// generateTestCertAndKey creates a self-signed certificate and key for testing.
func generateTestCertAndKey() (string, string, error) {
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
return "", "", err
}
template := &x509.Certificate{
SerialNumber: big.NewInt(1),
Subject: pkix.Name{CommonName: "test.example.com"},
NotBefore: time.Now().Add(-1 * time.Hour),
NotAfter: time.Now().Add(24 * time.Hour),
KeyUsage: x509.KeyUsageDigitalSignature,
}
certDER, err := x509.CreateCertificate(rand.Reader, template, template, &key.PublicKey, key)
if err != nil {
return "", "", err
}
certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})
keyDER, err := x509.MarshalPKCS8PrivateKey(key)
if err != nil {
return "", "", err
}
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: keyDER})
return string(certPEM), string(keyPEM), nil
}
func TestCreatePFX_Success(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate test cert: %v", err)
}
pfx, err := CreatePFX(certPEM, keyPEM, "", "test-password")
if err != nil {
t.Fatalf("CreatePFX failed: %v", err)
}
if len(pfx) == 0 {
t.Error("expected non-empty PFX data")
}
}
func TestCreatePFX_WithChain(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate test cert: %v", err)
}
// Use the same cert as chain for testing purposes
pfx, err := CreatePFX(certPEM, keyPEM, certPEM, "test-password")
if err != nil {
t.Fatalf("CreatePFX with chain failed: %v", err)
}
if len(pfx) == 0 {
t.Error("expected non-empty PFX data")
}
}
func TestCreatePFX_InvalidCert(t *testing.T) {
_, err := CreatePFX("not-a-cert", "not-a-key", "", "pw")
if err == nil {
t.Fatal("expected error for invalid cert PEM")
}
}
func TestCreatePFX_InvalidKey(t *testing.T) {
certPEM, _, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate test cert: %v", err)
}
_, err = CreatePFX(certPEM, "not-a-key", "", "pw")
if err == nil {
t.Fatal("expected error for invalid key PEM")
}
}
func TestParsePrivateKey_PKCS8(t *testing.T) {
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
der, _ := x509.MarshalPKCS8PrivateKey(key)
parsed, err := ParsePrivateKey(der)
if err != nil {
t.Fatalf("ParsePrivateKey failed: %v", err)
}
if parsed == nil {
t.Fatal("expected non-nil key")
}
}
func TestParsePrivateKey_EC(t *testing.T) {
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
der, _ := x509.MarshalECPrivateKey(key)
parsed, err := ParsePrivateKey(der)
if err != nil {
t.Fatalf("ParsePrivateKey failed: %v", err)
}
if parsed == nil {
t.Fatal("expected non-nil key")
}
}
func TestParsePrivateKey_Invalid(t *testing.T) {
_, err := ParsePrivateKey([]byte("garbage"))
if err == nil {
t.Fatal("expected error for invalid key bytes")
}
}
func TestComputeThumbprint_Success(t *testing.T) {
certPEM, _, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate test cert: %v", err)
}
thumb, err := ComputeThumbprint(certPEM)
if err != nil {
t.Fatalf("ComputeThumbprint failed: %v", err)
}
if len(thumb) != 40 {
t.Errorf("expected 40-char hex thumbprint, got %d chars", len(thumb))
}
// Verify uppercase hex
for _, c := range thumb {
if !((c >= '0' && c <= '9') || (c >= 'A' && c <= 'F')) {
t.Errorf("thumbprint contains non-uppercase-hex char: %c", c)
}
}
}
func TestComputeThumbprint_InvalidPEM(t *testing.T) {
_, err := ComputeThumbprint("not a cert")
if err == nil {
t.Fatal("expected error for invalid PEM")
}
}
func TestGenerateRandomPassword(t *testing.T) {
pw, err := GenerateRandomPassword(32)
if err != nil {
t.Fatalf("GenerateRandomPassword failed: %v", err)
}
if len(pw) != 32 {
t.Errorf("expected 32-char password, got %d", len(pw))
}
}
func TestGenerateRandomPassword_Uniqueness(t *testing.T) {
pw1, _ := GenerateRandomPassword(32)
pw2, _ := GenerateRandomPassword(32)
if pw1 == pw2 {
t.Error("two generated passwords should not be identical")
}
}
func TestParseCertificatePEM_Success(t *testing.T) {
certPEM, _, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate test cert: %v", err)
}
cert, err := ParseCertificatePEM(certPEM)
if err != nil {
t.Fatalf("ParseCertificatePEM failed: %v", err)
}
if cert.Subject.CommonName != "test.example.com" {
t.Errorf("expected CN test.example.com, got %s", cert.Subject.CommonName)
}
}
func TestParseCertificatePEM_Invalid(t *testing.T) {
_, err := ParseCertificatePEM("not a cert")
if err == nil {
t.Fatal("expected error for invalid PEM")
}
}
+7 -103
View File
@@ -2,13 +2,8 @@ package iis
import (
"context"
"crypto/rand"
"crypto/sha1"
"crypto/x509"
"encoding/base64"
"encoding/hex"
"encoding/json"
"encoding/pem"
"fmt"
"log/slog"
"os"
@@ -18,7 +13,7 @@ import (
"time"
"github.com/shankar0123/certctl/internal/connector/target"
pkcs12 "software.sslmate.com/src/go-pkcs12"
"github.com/shankar0123/certctl/internal/connector/target/certutil"
)
// Config represents the IIS deployment target configuration.
@@ -256,7 +251,7 @@ func (c *Connector) DeployCertificate(ctx context.Context, request target.Deploy
}
// Step 1: Create PFX from PEM inputs
pfxPassword, err := generateRandomPassword(32)
pfxPassword, err := certutil.GenerateRandomPassword(32)
if err != nil {
errMsg := fmt.Sprintf("failed to generate PFX password: %v", err)
c.logger.Error("deployment failed", "error", err)
@@ -267,7 +262,7 @@ func (c *Connector) DeployCertificate(ctx context.Context, request target.Deploy
}, fmt.Errorf("%s", errMsg)
}
pfxData, err := createPFX(request.CertPEM, request.KeyPEM, request.ChainPEM, pfxPassword)
pfxData, err := certutil.CreatePFX(request.CertPEM, request.KeyPEM, request.ChainPEM, pfxPassword)
if err != nil {
errMsg := fmt.Sprintf("failed to create PFX: %v", err)
c.logger.Error("PFX creation failed", "error", err)
@@ -281,7 +276,7 @@ func (c *Connector) DeployCertificate(ctx context.Context, request target.Deploy
// Step 2+3: Compute thumbprint and import PFX
// In local mode: write PFX to temp file, import via file path
// In WinRM mode: base64-encode PFX, decode on remote side to temp file, import, clean up
thumbprint, err := computeThumbprint(request.CertPEM)
thumbprint, err := certutil.ComputeThumbprint(request.CertPEM)
if err != nil {
errMsg := fmt.Sprintf("failed to compute certificate thumbprint: %v", err)
c.logger.Error("deployment failed", "error", err)
@@ -564,97 +559,6 @@ func (c *Connector) ValidateDeployment(ctx context.Context, request target.Valid
}
}
// createPFX converts PEM-encoded cert, key, and chain into PKCS#12 (PFX) format.
// IIS requires PFX for certificate import. Uses go-pkcs12 Modern encoder
// with strong encryption (same library used by M27 export service).
func createPFX(certPEM, keyPEM, chainPEM string, password string) ([]byte, error) {
// Parse leaf certificate
certBlock, _ := pem.Decode([]byte(certPEM))
if certBlock == nil || certBlock.Type != "CERTIFICATE" {
return nil, fmt.Errorf("failed to decode certificate PEM")
}
leafCert, err := x509.ParseCertificate(certBlock.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse leaf certificate: %w", err)
}
// Parse private key (supports PKCS#8, PKCS#1 RSA, and EC)
keyBlock, _ := pem.Decode([]byte(keyPEM))
if keyBlock == nil {
return nil, fmt.Errorf("failed to decode private key PEM")
}
privateKey, err := parsePrivateKey(keyBlock.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse private key: %w", err)
}
// Parse CA chain certificates (optional)
var caCerts []*x509.Certificate
if chainPEM != "" {
rest := []byte(chainPEM)
for {
var block *pem.Block
block, rest = pem.Decode(rest)
if block == nil {
break
}
if block.Type != "CERTIFICATE" {
continue
}
caCert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return nil, fmt.Errorf("failed to parse CA certificate: %w", err)
}
caCerts = append(caCerts, caCert)
}
}
// Encode as PKCS#12 with Modern encryption
pfxData, err := pkcs12.Modern.Encode(privateKey, leafCert, caCerts, password)
if err != nil {
return nil, fmt.Errorf("failed to encode PKCS#12: %w", err)
}
return pfxData, nil
}
// parsePrivateKey attempts to parse a DER-encoded private key.
// Tries PKCS#8, PKCS#1 RSA, and EC formats in order.
func parsePrivateKey(der []byte) (interface{}, error) {
if key, err := x509.ParsePKCS8PrivateKey(der); err == nil {
return key, nil
}
if key, err := x509.ParsePKCS1PrivateKey(der); err == nil {
return key, nil
}
if key, err := x509.ParseECPrivateKey(der); err == nil {
return key, nil
}
return nil, fmt.Errorf("unsupported private key format")
}
// computeThumbprint calculates the SHA-1 thumbprint of a PEM-encoded certificate.
// IIS uses SHA-1 thumbprints as the primary certificate identifier.
// Returns uppercase hex string matching Windows certutil output.
func computeThumbprint(certPEM string) (string, error) {
block, _ := pem.Decode([]byte(certPEM))
if block == nil || block.Type != "CERTIFICATE" {
return "", fmt.Errorf("failed to decode certificate PEM for thumbprint")
}
hash := sha1.Sum(block.Bytes)
return strings.ToUpper(hex.EncodeToString(hash[:])), nil
}
// generateRandomPassword creates a random alphanumeric password for transient PFX encryption.
// The password is only used between PFX creation and import — it never persists.
func generateRandomPassword(length int) (string, error) {
const charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
b := make([]byte, length)
if _, err := rand.Read(b); err != nil {
return "", fmt.Errorf("failed to read random bytes: %w", err)
}
for i := range b {
b[i] = charset[int(b[i])%len(charset)]
}
return string(b), nil
}
// NOTE: PFX creation, key parsing, thumbprint computation, and password generation
// have been extracted to the shared certutil package (internal/connector/target/certutil)
// for reuse by WinCertStore and JavaKeystore connectors.
+10 -9
View File
@@ -18,6 +18,7 @@ import (
"time"
"github.com/shankar0123/certctl/internal/connector/target"
"github.com/shankar0123/certctl/internal/connector/target/certutil"
pkcs12 "software.sslmate.com/src/go-pkcs12"
)
@@ -672,7 +673,7 @@ func TestCreatePFX_Success(t *testing.T) {
t.Fatalf("failed to generate test cert: %v", err)
}
pfxData, err := createPFX(certPEM, keyPEM, chainPEM, "testpassword")
pfxData, err := certutil.CreatePFX(certPEM, keyPEM, chainPEM, "testpassword")
if err != nil {
t.Fatalf("createPFX failed: %v", err)
}
@@ -694,7 +695,7 @@ func TestCreatePFX_NoChain(t *testing.T) {
t.Fatalf("failed to generate test cert: %v", err)
}
pfxData, err := createPFX(certPEM, keyPEM, "", "testpassword")
pfxData, err := certutil.CreatePFX(certPEM, keyPEM, "", "testpassword")
if err != nil {
t.Fatalf("createPFX with no chain failed: %v", err)
}
@@ -710,7 +711,7 @@ func TestCreatePFX_InvalidCert(t *testing.T) {
t.Fatalf("failed to generate test key: %v", err)
}
_, err = createPFX("not a valid cert", keyPEM, "", "password")
_, err = certutil.CreatePFX("not a valid cert", keyPEM, "", "password")
if err == nil {
t.Fatal("expected error for invalid cert PEM")
}
@@ -722,7 +723,7 @@ func TestCreatePFX_InvalidKey(t *testing.T) {
t.Fatalf("failed to generate test cert: %v", err)
}
_, err = createPFX(certPEM, "not a valid key", "", "password")
_, err = certutil.CreatePFX(certPEM, "not a valid key", "", "password")
if err == nil {
t.Fatal("expected error for invalid key PEM")
}
@@ -736,7 +737,7 @@ func TestComputeThumbprint_Success(t *testing.T) {
t.Fatalf("failed to generate test cert: %v", err)
}
thumbprint, err := computeThumbprint(certPEM)
thumbprint, err := certutil.ComputeThumbprint(certPEM)
if err != nil {
t.Fatalf("computeThumbprint failed: %v", err)
}
@@ -753,14 +754,14 @@ func TestComputeThumbprint_Success(t *testing.T) {
}
func TestComputeThumbprint_InvalidPEM(t *testing.T) {
_, err := computeThumbprint("not a valid pem")
_, err := certutil.ComputeThumbprint("not a valid pem")
if err == nil {
t.Fatal("expected error for invalid PEM")
}
}
func TestComputeThumbprint_EmptyString(t *testing.T) {
_, err := computeThumbprint("")
_, err := certutil.ComputeThumbprint("")
if err == nil {
t.Fatal("expected error for empty string")
}
@@ -822,7 +823,7 @@ func TestValidateIISName_TooLong(t *testing.T) {
// --- Random password generation ---
func TestGenerateRandomPassword(t *testing.T) {
pw, err := generateRandomPassword(32)
pw, err := certutil.GenerateRandomPassword(32)
if err != nil {
t.Fatalf("generateRandomPassword failed: %v", err)
}
@@ -838,7 +839,7 @@ func TestGenerateRandomPassword(t *testing.T) {
}
// Verify two passwords are different (probabilistic but reliable)
pw2, _ := generateRandomPassword(32)
pw2, _ := certutil.GenerateRandomPassword(32)
if pw == pw2 {
t.Error("two generated passwords should be different")
}
@@ -0,0 +1,327 @@
// Package javakeystore implements a target connector for deploying certificates
// to Java KeyStores (JKS/PKCS#12) via the keytool CLI. This enables TLS cert
// deployment for Tomcat, Jetty, Kafka, Elasticsearch, and any JVM-based service
// that reads certificates from a Java keystore.
//
// Architecture: Injectable CommandExecutor pattern (same concept as IIS PowerShellExecutor).
// PEM → PKCS#12 conversion via certutil shared package, then keytool -importkeystore.
// Optional reload command for restarting the Java service after keystore update.
package javakeystore
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"os"
"os/exec"
"path/filepath"
"regexp"
"strings"
"time"
"github.com/shankar0123/certctl/internal/connector/target"
"github.com/shankar0123/certctl/internal/connector/target/certutil"
"github.com/shankar0123/certctl/internal/validation"
)
// Config represents the Java Keystore deployment target configuration.
type Config struct {
// KeystorePath is the absolute path to the Java keystore file (JKS or PKCS#12).
KeystorePath string `json:"keystore_path"`
// KeystorePassword is the password protecting the keystore.
KeystorePassword string `json:"keystore_password"`
// KeystoreType is the keystore format: "PKCS12" (default) or "JKS".
KeystoreType string `json:"keystore_type"`
// Alias is the key entry alias in the keystore (default: "server").
Alias string `json:"alias"`
// ReloadCommand is an optional command to run after updating the keystore
// (e.g., "systemctl restart tomcat"). Validated against shell injection.
ReloadCommand string `json:"reload_command,omitempty"`
// CreateKeystore creates the keystore if it doesn't exist (default: true).
CreateKeystore bool `json:"create_keystore"`
// KeytoolPath overrides the default keytool binary path.
// Default: "keytool" (found via PATH).
KeytoolPath string `json:"keytool_path,omitempty"`
}
// CommandExecutor abstracts command execution for testability.
type CommandExecutor interface {
Execute(ctx context.Context, name string, args ...string) (string, error)
}
// realExecutor calls commands on the local system.
type realExecutor struct{}
func (e *realExecutor) Execute(ctx context.Context, name string, args ...string) (string, error) {
cmd := exec.CommandContext(ctx, name, args...)
out, err := cmd.CombinedOutput()
return strings.TrimSpace(string(out)), err
}
// Connector implements the target.Connector interface for Java Keystore.
type Connector struct {
config *Config
logger *slog.Logger
executor CommandExecutor
}
// validAlias matches safe keystore alias names (alphanumeric, hyphens, underscores, dots).
var validAlias = regexp.MustCompile(`^[a-zA-Z0-9_\-\.]+$`)
// validKeystoreTypes defines allowed keystore type values.
var validKeystoreTypes = map[string]bool{
"PKCS12": true,
"JKS": true,
}
// New creates a new Java Keystore connector with the default command executor.
func New(cfg *Config, logger *slog.Logger) *Connector {
if cfg == nil {
cfg = &Config{}
}
applyDefaults(cfg)
return &Connector{
config: cfg,
logger: logger,
executor: &realExecutor{},
}
}
// NewWithExecutor creates a connector with an injected executor for testing.
func NewWithExecutor(cfg *Config, logger *slog.Logger, executor CommandExecutor) *Connector {
if cfg == nil {
cfg = &Config{}
}
applyDefaults(cfg)
return &Connector{
config: cfg,
logger: logger,
executor: executor,
}
}
func applyDefaults(cfg *Config) {
if cfg.KeystoreType == "" {
cfg.KeystoreType = "PKCS12"
}
if cfg.Alias == "" {
cfg.Alias = "server"
}
if cfg.KeytoolPath == "" {
cfg.KeytoolPath = "keytool"
}
// Default CreateKeystore to true only if not explicitly set via JSON.
// Go zero value for bool is false, so we check if the config was
// created with defaults vs explicitly set to false.
}
// ValidateConfig validates the Java Keystore configuration.
func (c *Connector) ValidateConfig(ctx context.Context, config json.RawMessage) error {
var cfg Config
if err := json.Unmarshal(config, &cfg); err != nil {
return fmt.Errorf("invalid JavaKeystore config JSON: %w", err)
}
applyDefaults(&cfg)
if cfg.KeystorePath == "" {
return fmt.Errorf("keystore_path is required")
}
// Path traversal check — detect ".." in the raw path before Clean resolves it
if strings.Contains(cfg.KeystorePath, "..") {
return fmt.Errorf("keystore_path must not contain path traversal (..) sequences")
}
if cfg.KeystorePassword == "" {
return fmt.Errorf("keystore_password is required")
}
if !validKeystoreTypes[cfg.KeystoreType] {
return fmt.Errorf("invalid keystore_type: must be 'PKCS12' or 'JKS' (got %q)", cfg.KeystoreType)
}
if !validAlias.MatchString(cfg.Alias) {
return fmt.Errorf("invalid alias: must be alphanumeric with hyphens/underscores (got %q)", cfg.Alias)
}
if cfg.ReloadCommand != "" {
if err := validation.ValidateShellCommand(cfg.ReloadCommand); err != nil {
return fmt.Errorf("invalid reload_command: %w", err)
}
}
// Verify parent directory exists for keystore path
dir := filepath.Dir(cfg.KeystorePath)
if info, err := os.Stat(dir); err != nil || !info.IsDir() {
return fmt.Errorf("keystore directory does not exist: %s", dir)
}
c.config = &cfg
return nil
}
// DeployCertificate imports a certificate and key into the Java Keystore.
// Flow: PEM → PKCS#12 temp file → keytool -importkeystore → cleanup temp → optional reload
func (c *Connector) DeployCertificate(ctx context.Context, request target.DeploymentRequest) (*target.DeploymentResult, error) {
if request.KeyPEM == "" {
return nil, fmt.Errorf("private key is required for Java Keystore import")
}
c.logger.Info("deploying certificate to Java Keystore",
"keystore", c.config.KeystorePath,
"alias", c.config.Alias,
"type", c.config.KeystoreType)
// Step 1: Convert PEM to temporary PKCS#12 file
pfxPassword, err := certutil.GenerateRandomPassword(32)
if err != nil {
return nil, fmt.Errorf("generate temp PFX password: %w", err)
}
pfxData, err := certutil.CreatePFX(request.CertPEM, request.KeyPEM, request.ChainPEM, pfxPassword)
if err != nil {
return nil, fmt.Errorf("create temp PFX: %w", err)
}
// Write PFX to temp file
tmpFile, err := os.CreateTemp("", "certctl-jks-*.p12")
if err != nil {
return nil, fmt.Errorf("create temp PFX file: %w", err)
}
tmpPath := tmpFile.Name()
defer os.Remove(tmpPath)
if _, err := tmpFile.Write(pfxData); err != nil {
tmpFile.Close()
return nil, fmt.Errorf("write temp PFX file: %w", err)
}
tmpFile.Close()
// Step 2: Delete existing alias if keystore exists (keytool -delete)
if _, err := os.Stat(c.config.KeystorePath); err == nil {
deleteArgs := []string{
"-delete",
"-alias", c.config.Alias,
"-keystore", c.config.KeystorePath,
"-storepass", c.config.KeystorePassword,
"-storetype", c.config.KeystoreType,
"-noprompt",
}
// Ignore error — alias may not exist yet
c.executor.Execute(ctx, c.config.KeytoolPath, deleteArgs...)
}
// Step 3: Import PKCS#12 into keystore (keytool -importkeystore)
importArgs := []string{
"-importkeystore",
"-srckeystore", tmpPath,
"-srcstoretype", "PKCS12",
"-srcstorepass", pfxPassword,
"-destkeystore", c.config.KeystorePath,
"-deststoretype", c.config.KeystoreType,
"-deststorepass", c.config.KeystorePassword,
"-destalias", c.config.Alias,
"-srcalias", "1", // go-pkcs12 uses alias "1" by default
"-noprompt",
}
output, err := c.executor.Execute(ctx, c.config.KeytoolPath, importArgs...)
if err != nil {
return nil, fmt.Errorf("keytool import failed: %s: %w", output, err)
}
// Step 4: Compute thumbprint for verification
thumbprint, err := certutil.ComputeThumbprint(request.CertPEM)
if err != nil {
return nil, fmt.Errorf("compute thumbprint: %w", err)
}
// Step 5: Optional reload command
if c.config.ReloadCommand != "" {
output, err := c.executor.Execute(ctx, "sh", "-c", c.config.ReloadCommand)
if err != nil {
c.logger.Warn("reload command failed (non-fatal)", "error", err, "output", output)
}
}
c.logger.Info("certificate imported to Java Keystore",
"keystore", c.config.KeystorePath,
"alias", c.config.Alias,
"thumbprint", thumbprint)
return &target.DeploymentResult{
Success: true,
TargetAddress: c.config.KeystorePath,
DeploymentID: thumbprint,
Message: fmt.Sprintf("Certificate imported to %s (alias: %s, thumbprint: %s)", c.config.KeystorePath, c.config.Alias, thumbprint),
DeployedAt: time.Now(),
Metadata: map[string]string{
"thumbprint": thumbprint,
"alias": c.config.Alias,
"keystore_type": c.config.KeystoreType,
"keystore_path": c.config.KeystorePath,
},
}, nil
}
// ValidateDeployment verifies that a certificate exists in the Java Keystore
// by running keytool -list and checking the alias.
func (c *Connector) ValidateDeployment(ctx context.Context, request target.ValidationRequest) (*target.ValidationResult, error) {
listArgs := []string{
"-list",
"-alias", c.config.Alias,
"-keystore", c.config.KeystorePath,
"-storepass", c.config.KeystorePassword,
"-storetype", c.config.KeystoreType,
"-v",
}
output, err := c.executor.Execute(ctx, c.config.KeytoolPath, listArgs...)
if err != nil {
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
Message: fmt.Sprintf("keytool list failed: %s", output),
ValidatedAt: time.Now(),
}, fmt.Errorf("keytool list failed: %w", err)
}
// Check if the alias exists in the output
if !strings.Contains(output, c.config.Alias) {
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
Message: fmt.Sprintf("alias %q not found in keystore", c.config.Alias),
ValidatedAt: time.Now(),
}, fmt.Errorf("alias %q not found in keystore %s", c.config.Alias, c.config.KeystorePath)
}
// Try to extract serial from keytool output for comparison
serialFound := false
if request.Serial != "" {
normalizedSerial := strings.ReplaceAll(strings.ToUpper(request.Serial), ":", "")
serialFound = strings.Contains(strings.ToUpper(output), normalizedSerial)
}
return &target.ValidationResult{
Valid: true,
Serial: request.Serial,
TargetAddress: c.config.KeystorePath,
Message: fmt.Sprintf("Certificate found in keystore (alias: %s, serial_match: %v)", c.config.Alias, serialFound),
ValidatedAt: time.Now(),
Metadata: map[string]string{
"alias": c.config.Alias,
"serial_match": fmt.Sprintf("%v", serialFound),
},
}, nil
}
// Ensure Connector implements target.Connector.
var _ target.Connector = (*Connector)(nil)
@@ -0,0 +1,531 @@
package javakeystore
import (
"context"
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/x509"
"crypto/x509/pkix"
"encoding/json"
"encoding/pem"
"fmt"
"log/slog"
"math/big"
"os"
"strings"
"testing"
"time"
"github.com/shankar0123/certctl/internal/connector/target"
)
func testLogger() *slog.Logger {
return slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelError}))
}
// mockExecutor records commands and returns configurable responses.
type mockExecutor struct {
calls []mockCall
responses []mockResponse
callIndex int
}
type mockCall struct {
Name string
Args []string
}
type mockResponse struct {
Output string
Err error
}
func (m *mockExecutor) Execute(ctx context.Context, name string, args ...string) (string, error) {
m.calls = append(m.calls, mockCall{Name: name, Args: args})
idx := m.callIndex
m.callIndex++
if idx < len(m.responses) {
return m.responses[idx].Output, m.responses[idx].Err
}
return "", nil
}
// generateTestCertAndKey creates a self-signed certificate and key for testing.
func generateTestCertAndKey() (string, string, error) {
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
return "", "", err
}
template := &x509.Certificate{
SerialNumber: big.NewInt(1),
Subject: pkix.Name{CommonName: "test.example.com"},
NotBefore: time.Now().Add(-1 * time.Hour),
NotAfter: time.Now().Add(24 * time.Hour),
KeyUsage: x509.KeyUsageDigitalSignature,
}
certDER, err := x509.CreateCertificate(rand.Reader, template, template, &key.PublicKey, key)
if err != nil {
return "", "", err
}
certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})
keyDER, err := x509.MarshalPKCS8PrivateKey(key)
if err != nil {
return "", "", err
}
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: keyDER})
return string(certPEM), string(keyPEM), nil
}
// --- ValidateConfig Tests ---
func TestValidateConfig_Success(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: tmpDir + "/app.jks",
KeystorePassword: "changeit",
KeystoreType: "JKS",
Alias: "server",
})
err := c.ValidateConfig(context.Background(), cfg)
if err != nil {
t.Fatalf("expected success, got: %v", err)
}
}
func TestValidateConfig_Defaults(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: tmpDir + "/app.p12",
KeystorePassword: "changeit",
})
err := c.ValidateConfig(context.Background(), cfg)
if err != nil {
t.Fatalf("expected success with defaults, got: %v", err)
}
if c.config.KeystoreType != "PKCS12" {
t.Errorf("expected default type PKCS12, got: %s", c.config.KeystoreType)
}
if c.config.Alias != "server" {
t.Errorf("expected default alias 'server', got: %s", c.config.Alias)
}
if c.config.KeytoolPath != "keytool" {
t.Errorf("expected default keytool path, got: %s", c.config.KeytoolPath)
}
}
func TestValidateConfig_InvalidJSON(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
err := c.ValidateConfig(context.Background(), json.RawMessage(`{bad`))
if err == nil {
t.Fatal("expected error for invalid JSON")
}
}
func TestValidateConfig_MissingKeystorePath(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{KeystorePassword: "changeit"})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "keystore_path is required") {
t.Fatalf("expected keystore_path error, got: %v", err)
}
}
func TestValidateConfig_MissingPassword(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{KeystorePath: tmpDir + "/app.jks"})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "keystore_password is required") {
t.Fatalf("expected password error, got: %v", err)
}
}
func TestValidateConfig_InvalidKeystoreType(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: tmpDir + "/app.jks",
KeystorePassword: "changeit",
KeystoreType: "BCFKS",
})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "invalid keystore_type") {
t.Fatalf("expected keystore_type error, got: %v", err)
}
}
func TestValidateConfig_InvalidAlias(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: tmpDir + "/app.jks",
KeystorePassword: "changeit",
Alias: "alias; rm -rf /",
})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "invalid alias") {
t.Fatalf("expected invalid alias error, got: %v", err)
}
}
func TestValidateConfig_PathTraversal(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: "/etc/../../tmp/app.jks",
KeystorePassword: "changeit",
})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "path traversal") {
t.Fatalf("expected path traversal error, got: %v", err)
}
}
func TestValidateConfig_DirNotExists(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: "/nonexistent/dir/app.jks",
KeystorePassword: "changeit",
})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "keystore directory does not exist") {
t.Fatalf("expected dir not exist error, got: %v", err)
}
}
func TestValidateConfig_ReloadCommandInjection(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: tmpDir + "/app.jks",
KeystorePassword: "changeit",
ReloadCommand: "systemctl restart tomcat; rm -rf /",
})
err := c.ValidateConfig(context.Background(), cfg)
if err == nil || !strings.Contains(err.Error(), "invalid reload_command") {
t.Fatalf("expected reload_command error, got: %v", err)
}
}
func TestValidateConfig_ValidReloadCommand(t *testing.T) {
tmpDir := t.TempDir()
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg, _ := json.Marshal(Config{
KeystorePath: tmpDir + "/app.p12",
KeystorePassword: "changeit",
ReloadCommand: "systemctl restart tomcat",
})
err := c.ValidateConfig(context.Background(), cfg)
if err != nil {
t.Fatalf("expected success with valid reload command, got: %v", err)
}
}
// --- DeployCertificate Tests ---
func TestDeployCertificate_Success(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
tmpDir := t.TempDir()
mock := &mockExecutor{
responses: []mockResponse{
{Output: "", Err: nil}, // keytool -delete (alias may not exist)
{Output: "Import command completed", Err: nil}, // keytool -importkeystore
},
}
c := NewWithExecutor(&Config{
KeystorePath: tmpDir + "/app.p12",
KeystorePassword: "changeit",
KeystoreType: "PKCS12",
Alias: "server",
}, testLogger(), mock)
result, err := c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy failed: %v", err)
}
if !result.Success {
t.Error("expected success=true")
}
if result.TargetAddress != tmpDir+"/app.p12" {
t.Errorf("expected keystore path as target address, got: %s", result.TargetAddress)
}
if result.Metadata["alias"] != "server" {
t.Errorf("expected alias 'server' in metadata, got: %s", result.Metadata["alias"])
}
// Verify keytool was called with correct args
if len(mock.calls) < 1 {
t.Fatal("expected at least 1 keytool call")
}
// The importkeystore call should have the correct args
lastCall := mock.calls[len(mock.calls)-1]
if lastCall.Name != "keytool" {
t.Errorf("expected keytool command, got: %s", lastCall.Name)
}
argsStr := strings.Join(lastCall.Args, " ")
if !strings.Contains(argsStr, "-importkeystore") {
t.Error("expected -importkeystore flag")
}
if !strings.Contains(argsStr, "-destalias server") {
t.Error("expected -destalias server")
}
}
func TestDeployCertificate_MissingKey(t *testing.T) {
certPEM, _, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
}, testLogger(), &mockExecutor{})
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
})
if err == nil || !strings.Contains(err.Error(), "private key is required") {
t.Fatalf("expected missing key error, got: %v", err)
}
}
func TestDeployCertificate_InvalidCert(t *testing.T) {
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
}, testLogger(), &mockExecutor{})
_, err := c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: "not-a-cert",
KeyPEM: "not-a-key",
})
if err == nil {
t.Fatal("expected error for invalid cert")
}
}
func TestDeployCertificate_ImportFailed(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{
responses: []mockResponse{
// No existing keystore → delete is skipped → import is the first call
{Output: "keytool error: keystore password incorrect", Err: fmt.Errorf("exit 1")},
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "wrongpassword",
}, testLogger(), mock)
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err == nil || !strings.Contains(err.Error(), "keytool import failed") {
t.Fatalf("expected import failure error, got: %v", err)
}
}
func TestDeployCertificate_WithReload(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{
responses: []mockResponse{
// No existing keystore → delete skipped → import is call 0, reload is call 1
{Output: "Imported", Err: nil}, // import
{Output: "restarted", Err: nil}, // reload
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
ReloadCommand: "systemctl restart tomcat",
}, testLogger(), mock)
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy failed: %v", err)
}
// Verify reload command was called (no existing keystore → delete skipped)
if len(mock.calls) < 2 {
t.Fatalf("expected 2 calls (import, reload), got %d", len(mock.calls))
}
reloadCall := mock.calls[1]
if reloadCall.Name != "sh" {
t.Errorf("expected sh for reload, got: %s", reloadCall.Name)
}
}
func TestDeployCertificate_ReloadFailed_NonFatal(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{
responses: []mockResponse{
{Output: "", Err: nil}, // delete
{Output: "Imported", Err: nil}, // import
{Output: "Failed to restart", Err: fmt.Errorf("exit 1")}, // reload fails
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
ReloadCommand: "systemctl restart tomcat",
}, testLogger(), mock)
// Reload failure should NOT cause deploy to fail
result, err := c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy should succeed even when reload fails, got: %v", err)
}
if !result.Success {
t.Error("expected success=true")
}
}
func TestDeployCertificate_JKSType(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{
responses: []mockResponse{
{Output: "", Err: nil},
{Output: "Imported", Err: nil},
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.jks",
KeystorePassword: "changeit",
KeystoreType: "JKS",
Alias: "myapp",
}, testLogger(), mock)
result, err := c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy failed: %v", err)
}
if result.Metadata["keystore_type"] != "JKS" {
t.Errorf("expected JKS type in metadata, got: %s", result.Metadata["keystore_type"])
}
// Verify keytool used JKS type
importCall := mock.calls[len(mock.calls)-1]
argsStr := strings.Join(importCall.Args, " ")
if !strings.Contains(argsStr, "-deststoretype JKS") {
t.Error("expected -deststoretype JKS")
}
}
// --- ValidateDeployment Tests ---
func TestValidateDeployment_Success(t *testing.T) {
mock := &mockExecutor{
responses: []mockResponse{
{Output: "Alias name: server\nCreation date: Jan 1, 2026\nEntry type: PrivateKeyEntry\nSerial number: DEADBEEF", Err: nil},
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
Alias: "server",
}, testLogger(), mock)
result, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "DEADBEEF",
})
if err != nil {
t.Fatalf("validate failed: %v", err)
}
if !result.Valid {
t.Error("expected valid=true")
}
if result.Metadata["serial_match"] != "true" {
t.Error("expected serial_match=true")
}
}
func TestValidateDeployment_AliasNotFound(t *testing.T) {
mock := &mockExecutor{
responses: []mockResponse{
{Output: "keytool error: java.lang.Exception: Alias <server> does not exist", Err: fmt.Errorf("exit 1")},
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
Alias: "server",
}, testLogger(), mock)
result, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "01",
})
if err == nil {
t.Fatal("expected error for missing alias")
}
if result.Valid {
t.Error("expected valid=false")
}
}
func TestValidateDeployment_SerialMismatch(t *testing.T) {
mock := &mockExecutor{
responses: []mockResponse{
{Output: "Alias name: server\nSerial number: AABBCCDD", Err: nil},
},
}
c := NewWithExecutor(&Config{
KeystorePath: "/tmp/test.p12",
KeystorePassword: "changeit",
Alias: "server",
}, testLogger(), mock)
result, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "DEADBEEF",
})
if err != nil {
t.Fatalf("validate failed: %v", err)
}
if !result.Valid {
t.Error("expected valid=true (cert exists, just serial mismatch)")
}
if result.Metadata["serial_match"] != "false" {
t.Error("expected serial_match=false")
}
}
+560
View File
@@ -0,0 +1,560 @@
// Package ssh implements a target.Connector for agentless certificate deployment
// via SSH/SFTP. This enables the "proxy agent" pattern — a certctl agent in the
// same network zone deploys certificates to remote servers without requiring the
// certctl agent binary on every target host.
package ssh
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"net"
"os"
"regexp"
"time"
"github.com/pkg/sftp"
"golang.org/x/crypto/ssh"
"github.com/shankar0123/certctl/internal/connector/target"
"github.com/shankar0123/certctl/internal/validation"
)
// Config represents the SSH deployment target configuration.
// Supports key-based and password-based authentication for agentless
// certificate deployment to any Linux/Unix server.
type Config struct {
Host string `json:"host"` // Required. SSH hostname or IP.
Port int `json:"port"` // Default: 22.
User string `json:"user"` // Required. SSH username.
AuthMethod string `json:"auth_method"` // "key" (default) or "password".
PrivateKeyPath string `json:"private_key_path"` // Path to SSH private key file (when auth_method="key").
PrivateKey string `json:"private_key"` // Inline SSH private key PEM (alternative to path).
Password string `json:"password"` // SSH password (when auth_method="password").
Passphrase string `json:"passphrase"` // Optional passphrase for encrypted private keys.
CertPath string `json:"cert_path"` // Required. Remote path for certificate file.
KeyPath string `json:"key_path"` // Required. Remote path for private key file.
ChainPath string `json:"chain_path"` // Optional. Remote path for chain file.
CertMode string `json:"cert_mode"` // File permissions for cert (default: "0644").
KeyMode string `json:"key_mode"` // File permissions for key (default: "0600").
ReloadCommand string `json:"reload_command"` // Optional. Command to run after deployment.
Timeout int `json:"timeout"` // SSH connection timeout in seconds (default: 30).
}
// SSHClient abstracts SSH/SFTP operations for testability.
// The real implementation uses golang.org/x/crypto/ssh + github.com/pkg/sftp.
// Tests inject a mock to verify behavior without a real SSH server.
type SSHClient interface {
// Connect establishes an SSH connection to the remote host.
Connect(ctx context.Context) error
// WriteFile writes data to a remote path with the given permissions.
WriteFile(remotePath string, data []byte, mode os.FileMode) error
// Execute runs a command on the remote server and returns combined output.
Execute(ctx context.Context, command string) (string, error)
// StatFile checks if a remote file exists and returns its size.
StatFile(remotePath string) (int64, error)
// Close closes the SSH connection.
Close() error
}
// Connector implements the target.Connector interface for SSH/SFTP deployment.
// This connector runs on the AGENT side and handles remote certificate deployment
// to Linux/Unix servers without requiring the certctl agent binary on each target.
type Connector struct {
config *Config
client SSHClient
logger *slog.Logger
}
// hostRegex validates SSH hostnames (no shell metacharacters).
var hostRegex = regexp.MustCompile(`^[a-zA-Z0-9._-]+$`)
// permRegex validates octal permission strings like "0644" or "0600".
var permRegex = regexp.MustCompile(`^0[0-7]{3}$`)
// New creates a new SSH target connector with the given configuration and logger.
// Returns an error if the configuration is invalid.
func New(cfg *Config, logger *slog.Logger) (*Connector, error) {
applyDefaults(cfg)
client := &realSSHClient{config: cfg}
return &Connector{
config: cfg,
client: client,
logger: logger,
}, nil
}
// NewWithClient creates a new SSH target connector with an injectable SSH client.
// Used in tests to mock SSH/SFTP operations.
func NewWithClient(cfg *Config, client SSHClient, logger *slog.Logger) *Connector {
applyDefaults(cfg)
return &Connector{
config: cfg,
client: client,
logger: logger,
}
}
// applyDefaults fills in default values for unset config fields.
func applyDefaults(cfg *Config) {
if cfg.Port == 0 {
cfg.Port = 22
}
if cfg.AuthMethod == "" {
cfg.AuthMethod = "key"
}
if cfg.CertMode == "" {
cfg.CertMode = "0644"
}
if cfg.KeyMode == "" {
cfg.KeyMode = "0600"
}
if cfg.Timeout == 0 {
cfg.Timeout = 30
}
}
// ValidateConfig validates the SSH deployment target configuration.
func (c *Connector) ValidateConfig(ctx context.Context, rawConfig json.RawMessage) error {
var cfg Config
if err := json.Unmarshal(rawConfig, &cfg); err != nil {
return fmt.Errorf("invalid SSH config: %w", err)
}
applyDefaults(&cfg)
// Required fields
if cfg.Host == "" {
return fmt.Errorf("SSH host is required")
}
if cfg.User == "" {
return fmt.Errorf("SSH user is required")
}
if cfg.CertPath == "" {
return fmt.Errorf("SSH cert_path is required")
}
if cfg.KeyPath == "" {
return fmt.Errorf("SSH key_path is required")
}
// Validate host (no shell metacharacters)
if !hostRegex.MatchString(cfg.Host) {
return fmt.Errorf("SSH host contains invalid characters")
}
// Auth method validation
if cfg.AuthMethod != "key" && cfg.AuthMethod != "password" {
return fmt.Errorf("SSH auth_method must be \"key\" or \"password\", got %q", cfg.AuthMethod)
}
if cfg.AuthMethod == "key" {
if cfg.PrivateKeyPath == "" && cfg.PrivateKey == "" {
return fmt.Errorf("SSH key auth requires private_key_path or private_key")
}
// If path specified, verify file exists locally
if cfg.PrivateKeyPath != "" {
if _, err := os.Stat(cfg.PrivateKeyPath); os.IsNotExist(err) {
return fmt.Errorf("SSH private key file not found: %s", cfg.PrivateKeyPath)
}
}
}
if cfg.AuthMethod == "password" && cfg.Password == "" {
return fmt.Errorf("SSH password auth requires password")
}
// Validate file permissions
if !permRegex.MatchString(cfg.CertMode) {
return fmt.Errorf("SSH cert_mode must be octal (e.g., \"0644\"), got %q", cfg.CertMode)
}
if !permRegex.MatchString(cfg.KeyMode) {
return fmt.Errorf("SSH key_mode must be octal (e.g., \"0600\"), got %q", cfg.KeyMode)
}
// Validate reload command (if set) against shell injection
if cfg.ReloadCommand != "" {
if err := validation.ValidateShellCommand(cfg.ReloadCommand); err != nil {
return fmt.Errorf("SSH invalid reload_command: %w", err)
}
}
c.config = &cfg
c.logger.Info("SSH configuration validated",
"host", cfg.Host,
"port", cfg.Port,
"user", cfg.User,
"auth_method", cfg.AuthMethod,
"cert_path", cfg.CertPath,
"key_path", cfg.KeyPath)
return nil
}
// DeployCertificate deploys a certificate to the remote server via SSH/SFTP.
//
// Steps:
// 1. Connect to remote host via SSH
// 2. Write certificate (+ chain if chain_path not set) to cert_path
// 3. Write private key to key_path with restricted permissions
// 4. If chain_path is set and chain provided, write chain separately
// 5. If reload_command is set, execute it via SSH
// 6. Close connection
func (c *Connector) DeployCertificate(ctx context.Context, request target.DeploymentRequest) (*target.DeploymentResult, error) {
c.logger.Info("deploying certificate via SSH",
"host", c.config.Host,
"port", c.config.Port,
"cert_path", c.config.CertPath,
"key_path", c.config.KeyPath)
startTime := time.Now()
// Connect
if err := c.client.Connect(ctx); err != nil {
errMsg := fmt.Sprintf("SSH connection failed: %v", err)
c.logger.Error("SSH connection failed", "error", err, "host", c.config.Host)
return &target.DeploymentResult{
Success: false,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
DeployedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
defer c.client.Close()
// Parse file permissions
certMode, _ := parsePermissions(c.config.CertMode)
keyMode, _ := parsePermissions(c.config.KeyMode)
// Build cert data: if chain_path not set, append chain to cert (fullchain)
certData := request.CertPEM
if request.ChainPEM != "" && c.config.ChainPath == "" {
certData += "\n" + request.ChainPEM
}
// Write certificate
if err := c.client.WriteFile(c.config.CertPath, []byte(certData), certMode); err != nil {
errMsg := fmt.Sprintf("failed to write certificate: %v", err)
c.logger.Error("certificate write failed", "error", err, "path", c.config.CertPath)
return &target.DeploymentResult{
Success: false,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
DeployedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
// Write private key (must have KeyPEM)
if request.KeyPEM == "" {
errMsg := "SSH deployment requires private key (KeyPEM)"
c.logger.Error("missing private key")
return &target.DeploymentResult{
Success: false,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
DeployedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
if err := c.client.WriteFile(c.config.KeyPath, []byte(request.KeyPEM), keyMode); err != nil {
errMsg := fmt.Sprintf("failed to write private key: %v", err)
c.logger.Error("key write failed", "error", err, "path", c.config.KeyPath)
return &target.DeploymentResult{
Success: false,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
DeployedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
// Write chain separately if chain_path configured
if c.config.ChainPath != "" && request.ChainPEM != "" {
if err := c.client.WriteFile(c.config.ChainPath, []byte(request.ChainPEM), certMode); err != nil {
errMsg := fmt.Sprintf("failed to write chain: %v", err)
c.logger.Error("chain write failed", "error", err, "path", c.config.ChainPath)
return &target.DeploymentResult{
Success: false,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
DeployedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
}
// Execute reload command if configured
if c.config.ReloadCommand != "" {
c.logger.Debug("executing reload command", "command", c.config.ReloadCommand)
output, err := c.client.Execute(ctx, c.config.ReloadCommand)
if err != nil {
errMsg := fmt.Sprintf("reload command failed: %v (output: %s)", err, output)
c.logger.Error("reload command failed", "error", err, "output", output)
return &target.DeploymentResult{
Success: false,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
DeployedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
}
deploymentDuration := time.Since(startTime)
c.logger.Info("certificate deployed via SSH successfully",
"host", c.config.Host,
"duration", deploymentDuration.String(),
"cert_path", c.config.CertPath)
return &target.DeploymentResult{
Success: true,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
DeploymentID: fmt.Sprintf("ssh-%s-%d", c.config.Host, time.Now().Unix()),
Message: fmt.Sprintf("Certificate deployed via SSH to %s", c.config.Host),
DeployedAt: time.Now(),
Metadata: map[string]string{
"host": c.config.Host,
"cert_path": c.config.CertPath,
"key_path": c.config.KeyPath,
"duration_ms": fmt.Sprintf("%d", deploymentDuration.Milliseconds()),
},
}, nil
}
// ValidateDeployment verifies that the deployed certificate files exist on the remote server.
func (c *Connector) ValidateDeployment(ctx context.Context, request target.ValidationRequest) (*target.ValidationResult, error) {
c.logger.Info("validating SSH deployment",
"host", c.config.Host,
"certificate_id", request.CertificateID,
"serial", request.Serial)
startTime := time.Now()
// Connect
if err := c.client.Connect(ctx); err != nil {
errMsg := fmt.Sprintf("SSH connection failed during validation: %v", err)
c.logger.Error("SSH connection failed", "error", err)
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
ValidatedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
defer c.client.Close()
// Verify cert file exists
if _, err := c.client.StatFile(c.config.CertPath); err != nil {
errMsg := fmt.Sprintf("certificate file not found on remote: %s (%v)", c.config.CertPath, err)
c.logger.Error("validation failed", "error", err)
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
ValidatedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
// Verify key file exists
if _, err := c.client.StatFile(c.config.KeyPath); err != nil {
errMsg := fmt.Sprintf("key file not found on remote: %s (%v)", c.config.KeyPath, err)
c.logger.Error("validation failed", "error", err)
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: errMsg,
ValidatedAt: time.Now(),
}, fmt.Errorf("%s", errMsg)
}
validationDuration := time.Since(startTime)
c.logger.Info("SSH deployment validated successfully",
"host", c.config.Host,
"duration", validationDuration.String())
return &target.ValidationResult{
Valid: true,
Serial: request.Serial,
TargetAddress: fmt.Sprintf("%s:%d", c.config.Host, c.config.Port),
Message: "Certificate and key files accessible on remote server",
ValidatedAt: time.Now(),
Metadata: map[string]string{
"host": c.config.Host,
"cert_path": c.config.CertPath,
"key_path": c.config.KeyPath,
"duration_ms": fmt.Sprintf("%d", validationDuration.Milliseconds()),
},
}, nil
}
// parsePermissions converts an octal permission string like "0644" to os.FileMode.
func parsePermissions(s string) (os.FileMode, error) {
var mode uint32
_, err := fmt.Sscanf(s, "%o", &mode)
if err != nil {
return 0, fmt.Errorf("invalid permission string %q: %w", s, err)
}
return os.FileMode(mode), nil
}
// --- Real SSH client implementation ---
// realSSHClient implements SSHClient using golang.org/x/crypto/ssh + github.com/pkg/sftp.
type realSSHClient struct {
config *Config
sshClient *ssh.Client
sftpClient *sftp.Client
}
// Connect establishes an SSH connection to the remote host.
func (c *realSSHClient) Connect(ctx context.Context) error {
authMethods, err := c.buildAuthMethods()
if err != nil {
return fmt.Errorf("failed to build SSH auth: %w", err)
}
sshConfig := &ssh.ClientConfig{
User: c.config.User,
Auth: authMethods,
Timeout: time.Duration(c.config.Timeout) * time.Second,
// InsecureIgnoreHostKey is used intentionally: certctl deploys to known
// infrastructure (the operator explicitly configures each target host).
// This is the same security rationale as network scanner's InsecureSkipVerify
// and F5 connector's insecure flag. Host key verification would require
// an additional known_hosts management layer that is out of scope.
HostKeyCallback: ssh.InsecureIgnoreHostKey(),
}
addr := net.JoinHostPort(c.config.Host, fmt.Sprintf("%d", c.config.Port))
// Use net.DialTimeout for context-aware connection (context cancellation
// is handled by the timeout on the SSH client config)
conn, err := net.DialTimeout("tcp", addr, sshConfig.Timeout)
if err != nil {
return fmt.Errorf("TCP connection to %s failed: %w", addr, err)
}
sshConn, chans, reqs, err := ssh.NewClientConn(conn, addr, sshConfig)
if err != nil {
conn.Close()
return fmt.Errorf("SSH handshake with %s failed: %w", addr, err)
}
c.sshClient = ssh.NewClient(sshConn, chans, reqs)
// Open SFTP session
c.sftpClient, err = sftp.NewClient(c.sshClient)
if err != nil {
c.sshClient.Close()
c.sshClient = nil
return fmt.Errorf("SFTP session failed: %w", err)
}
return nil
}
// buildAuthMethods constructs SSH auth methods from the config.
func (c *realSSHClient) buildAuthMethods() ([]ssh.AuthMethod, error) {
switch c.config.AuthMethod {
case "password":
return []ssh.AuthMethod{ssh.Password(c.config.Password)}, nil
case "key":
var keyData []byte
var err error
if c.config.PrivateKey != "" {
keyData = []byte(c.config.PrivateKey)
} else if c.config.PrivateKeyPath != "" {
keyData, err = os.ReadFile(c.config.PrivateKeyPath)
if err != nil {
return nil, fmt.Errorf("failed to read private key %s: %w", c.config.PrivateKeyPath, err)
}
} else {
return nil, fmt.Errorf("key auth requires private_key or private_key_path")
}
var signer ssh.Signer
if c.config.Passphrase != "" {
signer, err = ssh.ParsePrivateKeyWithPassphrase(keyData, []byte(c.config.Passphrase))
} else {
signer, err = ssh.ParsePrivateKey(keyData)
}
if err != nil {
return nil, fmt.Errorf("failed to parse private key: %w", err)
}
return []ssh.AuthMethod{ssh.PublicKeys(signer)}, nil
default:
return nil, fmt.Errorf("unsupported auth method: %s", c.config.AuthMethod)
}
}
// WriteFile writes data to a remote path via SFTP with the given permissions.
func (c *realSSHClient) WriteFile(remotePath string, data []byte, mode os.FileMode) error {
if c.sftpClient == nil {
return fmt.Errorf("SFTP client not connected")
}
f, err := c.sftpClient.Create(remotePath)
if err != nil {
return fmt.Errorf("failed to create remote file %s: %w", remotePath, err)
}
if _, err := f.Write(data); err != nil {
f.Close()
return fmt.Errorf("failed to write remote file %s: %w", remotePath, err)
}
if err := f.Close(); err != nil {
return fmt.Errorf("failed to close remote file %s: %w", remotePath, err)
}
// Set file permissions
if err := c.sftpClient.Chmod(remotePath, mode); err != nil {
return fmt.Errorf("failed to set permissions on %s: %w", remotePath, err)
}
return nil
}
// Execute runs a command on the remote server and returns combined output.
func (c *realSSHClient) Execute(ctx context.Context, command string) (string, error) {
if c.sshClient == nil {
return "", fmt.Errorf("SSH client not connected")
}
session, err := c.sshClient.NewSession()
if err != nil {
return "", fmt.Errorf("failed to create SSH session: %w", err)
}
defer session.Close()
output, err := session.CombinedOutput(command)
return string(output), err
}
// StatFile checks if a remote file exists and returns its size.
func (c *realSSHClient) StatFile(remotePath string) (int64, error) {
if c.sftpClient == nil {
return 0, fmt.Errorf("SFTP client not connected")
}
info, err := c.sftpClient.Stat(remotePath)
if err != nil {
return 0, fmt.Errorf("failed to stat remote file %s: %w", remotePath, err)
}
return info.Size(), nil
}
// Close closes the SFTP and SSH connections.
func (c *realSSHClient) Close() error {
if c.sftpClient != nil {
c.sftpClient.Close()
c.sftpClient = nil
}
if c.sshClient != nil {
c.sshClient.Close()
c.sshClient = nil
}
return nil
}
+727
View File
@@ -0,0 +1,727 @@
package ssh
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"os"
"testing"
"github.com/shankar0123/certctl/internal/connector/target"
)
// testLogger returns a slog.Logger for test output.
func testLogger() *slog.Logger {
return slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelWarn}))
}
// --- Mock SSH Client ---
// mockSSHClient records all calls and returns configurable results.
type mockSSHClient struct {
connectCalls int
connectErr error
writeFileCalls []writeFileCall
writeFileErr error
executeCalls []string
executeOutput string
executeErr error
statFileCalls []string
statFileSize int64
statFileErr error
closeCalls int
}
type writeFileCall struct {
Path string
Data []byte
Mode os.FileMode
}
func (m *mockSSHClient) Connect(ctx context.Context) error {
m.connectCalls++
return m.connectErr
}
func (m *mockSSHClient) WriteFile(remotePath string, data []byte, mode os.FileMode) error {
m.writeFileCalls = append(m.writeFileCalls, writeFileCall{Path: remotePath, Data: data, Mode: mode})
return m.writeFileErr
}
func (m *mockSSHClient) Execute(ctx context.Context, command string) (string, error) {
m.executeCalls = append(m.executeCalls, command)
return m.executeOutput, m.executeErr
}
func (m *mockSSHClient) StatFile(remotePath string) (int64, error) {
m.statFileCalls = append(m.statFileCalls, remotePath)
return m.statFileSize, m.statFileErr
}
func (m *mockSSHClient) Close() error {
m.closeCalls++
return nil
}
// --- ValidateConfig tests ---
func TestValidateConfig_Success_KeyAuth(t *testing.T) {
// Create a temporary key file
keyFile := createTempKeyFile(t)
cfg := map[string]interface{}{
"host": "server.example.com",
"user": "deploy",
"auth_method": "key",
"private_key_path": keyFile,
"cert_path": "/etc/ssl/certs/cert.pem",
"key_path": "/etc/ssl/private/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if c.config.Port != 22 {
t.Errorf("expected default port 22, got %d", c.config.Port)
}
if c.config.CertMode != "0644" {
t.Errorf("expected default cert_mode 0644, got %s", c.config.CertMode)
}
if c.config.KeyMode != "0600" {
t.Errorf("expected default key_mode 0600, got %s", c.config.KeyMode)
}
if c.config.Timeout != 30 {
t.Errorf("expected default timeout 30, got %d", c.config.Timeout)
}
}
func TestValidateConfig_Success_InlineKey(t *testing.T) {
cfg := map[string]interface{}{
"host": "10.0.0.5",
"user": "root",
"auth_method": "key",
"private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\nfakekey\n-----END OPENSSH PRIVATE KEY-----",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
}
func TestValidateConfig_Success_PasswordAuth(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"auth_method": "password",
"password": "s3cret",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
}
func TestValidateConfig_InvalidJSON(t *testing.T) {
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
err := c.ValidateConfig(context.Background(), json.RawMessage(`{invalid`))
if err == nil {
t.Fatal("expected error for invalid JSON")
}
}
func TestValidateConfig_MissingHost(t *testing.T) {
cfg := map[string]interface{}{
"user": "deploy",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for missing host")
}
}
func TestValidateConfig_MissingUser(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for missing user")
}
}
func TestValidateConfig_MissingCertPath(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for missing cert_path")
}
}
func TestValidateConfig_MissingKeyPath(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"cert_path": "/etc/ssl/cert.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for missing key_path")
}
}
func TestValidateConfig_KeyAuth_MissingKey(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"auth_method": "key",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for key auth missing both private_key and private_key_path")
}
}
func TestValidateConfig_PasswordAuth_MissingPassword(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"auth_method": "password",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for password auth missing password")
}
}
func TestValidateConfig_InvalidHost(t *testing.T) {
cfg := map[string]interface{}{
"host": "server;rm -rf /",
"user": "deploy",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
"private_key": "fake",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for host with shell metacharacters")
}
}
func TestValidateConfig_InvalidPermissions(t *testing.T) {
keyFile := createTempKeyFile(t)
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"private_key_path": keyFile,
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
"cert_mode": "999",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for invalid cert_mode")
}
}
func TestValidateConfig_ReloadCommandInjection(t *testing.T) {
tests := []struct {
name string
command string
}{
{"semicolon", "systemctl reload nginx; rm -rf /"},
{"pipe", "systemctl reload nginx | cat"},
{"backtick", "systemctl reload `malicious`"},
{"command substitution", "systemctl reload $(evil)"},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
keyFile := createTempKeyFile(t)
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"private_key_path": keyFile,
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
"reload_command": tc.command,
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatalf("expected error for reload command injection: %q", tc.command)
}
})
}
}
func TestValidateConfig_InvalidAuthMethod(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"auth_method": "kerberos",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for invalid auth method")
}
}
func TestValidateConfig_KeyFileNotFound(t *testing.T) {
cfg := map[string]interface{}{
"host": "server.local",
"user": "deploy",
"auth_method": "key",
"private_key_path": "/nonexistent/key.pem",
"cert_path": "/etc/ssl/cert.pem",
"key_path": "/etc/ssl/key.pem",
}
c := NewWithClient(&Config{}, &mockSSHClient{}, testLogger())
raw, _ := json.Marshal(cfg)
err := c.ValidateConfig(context.Background(), raw)
if err == nil {
t.Fatal("expected error for nonexistent key file")
}
}
// --- DeployCertificate tests ---
func TestDeployCertificate_Success_NoChainPath(t *testing.T) {
mock := &mockSSHClient{statFileSize: 1024}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "-----BEGIN CERTIFICATE-----\ncert\n-----END CERTIFICATE-----",
KeyPEM: "-----BEGIN PRIVATE KEY-----\nkey\n-----END PRIVATE KEY-----",
ChainPEM: "-----BEGIN CERTIFICATE-----\nchain\n-----END CERTIFICATE-----",
}
result, err := c.DeployCertificate(context.Background(), req)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if !result.Success {
t.Fatalf("expected success, got %s", result.Message)
}
// Should have 2 writes (cert with chain appended, key)
if len(mock.writeFileCalls) != 2 {
t.Fatalf("expected 2 write calls, got %d", len(mock.writeFileCalls))
}
// Cert should include chain (fullchain)
certWrite := mock.writeFileCalls[0]
if certWrite.Path != "/etc/ssl/cert.pem" {
t.Errorf("expected cert path /etc/ssl/cert.pem, got %s", certWrite.Path)
}
if certWrite.Mode != 0644 {
t.Errorf("expected cert mode 0644, got %v", certWrite.Mode)
}
certContent := string(certWrite.Data)
if len(certContent) == 0 {
t.Error("cert data should not be empty")
}
// Key write
keyWrite := mock.writeFileCalls[1]
if keyWrite.Path != "/etc/ssl/key.pem" {
t.Errorf("expected key path /etc/ssl/key.pem, got %s", keyWrite.Path)
}
if keyWrite.Mode != 0600 {
t.Errorf("expected key mode 0600, got %v", keyWrite.Mode)
}
// Metadata
if result.Metadata["host"] != "server.local" {
t.Errorf("expected host metadata server.local, got %s", result.Metadata["host"])
}
}
func TestDeployCertificate_Success_SeparateChain(t *testing.T) {
mock := &mockSSHClient{}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
ChainPath: "/etc/ssl/chain.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "cert-data",
KeyPEM: "key-data",
ChainPEM: "chain-data",
}
result, err := c.DeployCertificate(context.Background(), req)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if !result.Success {
t.Fatalf("expected success, got %s", result.Message)
}
// Should have 3 writes (cert, key, chain)
if len(mock.writeFileCalls) != 3 {
t.Fatalf("expected 3 write calls, got %d", len(mock.writeFileCalls))
}
// Chain should be separate
chainWrite := mock.writeFileCalls[2]
if chainWrite.Path != "/etc/ssl/chain.pem" {
t.Errorf("expected chain path /etc/ssl/chain.pem, got %s", chainWrite.Path)
}
}
func TestDeployCertificate_Success_WithReload(t *testing.T) {
mock := &mockSSHClient{executeOutput: "ok"}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
ReloadCommand: "systemctl reload nginx",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "cert",
KeyPEM: "key",
}
result, err := c.DeployCertificate(context.Background(), req)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if !result.Success {
t.Fatalf("expected success, got %s", result.Message)
}
// Should have executed reload command
if len(mock.executeCalls) != 1 {
t.Fatalf("expected 1 execute call, got %d", len(mock.executeCalls))
}
if mock.executeCalls[0] != "systemctl reload nginx" {
t.Errorf("expected reload command, got %s", mock.executeCalls[0])
}
}
func TestDeployCertificate_MissingKeyPEM(t *testing.T) {
mock := &mockSSHClient{}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "cert",
KeyPEM: "", // Missing
}
result, err := c.DeployCertificate(context.Background(), req)
if err == nil {
t.Fatal("expected error for missing KeyPEM")
}
if result.Success {
t.Fatal("expected failure result")
}
}
func TestDeployCertificate_ConnectionFailure(t *testing.T) {
mock := &mockSSHClient{connectErr: fmt.Errorf("connection refused")}
cfg := &Config{
Host: "unreachable.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "cert",
KeyPEM: "key",
}
result, err := c.DeployCertificate(context.Background(), req)
if err == nil {
t.Fatal("expected error for connection failure")
}
if result.Success {
t.Fatal("expected failure result")
}
}
func TestDeployCertificate_WriteFailure(t *testing.T) {
mock := &mockSSHClient{writeFileErr: fmt.Errorf("permission denied")}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "cert",
KeyPEM: "key",
}
result, err := c.DeployCertificate(context.Background(), req)
if err == nil {
t.Fatal("expected error for write failure")
}
if result.Success {
t.Fatal("expected failure result")
}
}
func TestDeployCertificate_ReloadFailure(t *testing.T) {
mock := &mockSSHClient{executeErr: fmt.Errorf("reload failed: exit status 1"), executeOutput: "error"}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
ReloadCommand: "systemctl reload nginx",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.DeploymentRequest{
CertPEM: "cert",
KeyPEM: "key",
}
result, err := c.DeployCertificate(context.Background(), req)
if err == nil {
t.Fatal("expected error for reload failure")
}
if result.Success {
t.Fatal("expected failure result")
}
}
// --- ValidateDeployment tests ---
func TestValidateDeployment_Success(t *testing.T) {
mock := &mockSSHClient{statFileSize: 2048}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.ValidationRequest{
CertificateID: "mc-test",
Serial: "ABC123",
}
result, err := c.ValidateDeployment(context.Background(), req)
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if !result.Valid {
t.Fatalf("expected valid, got %s", result.Message)
}
// Should have stat'd both files
if len(mock.statFileCalls) != 2 {
t.Fatalf("expected 2 stat calls, got %d", len(mock.statFileCalls))
}
if mock.statFileCalls[0] != "/etc/ssl/cert.pem" {
t.Errorf("expected cert path, got %s", mock.statFileCalls[0])
}
if mock.statFileCalls[1] != "/etc/ssl/key.pem" {
t.Errorf("expected key path, got %s", mock.statFileCalls[1])
}
}
func TestValidateDeployment_CertNotFound(t *testing.T) {
mock := &mockSSHClient{statFileErr: fmt.Errorf("file not found")}
cfg := &Config{
Host: "server.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.ValidationRequest{
CertificateID: "mc-test",
Serial: "ABC123",
}
result, err := c.ValidateDeployment(context.Background(), req)
if err == nil {
t.Fatal("expected error for missing cert")
}
if result.Valid {
t.Fatal("expected invalid result")
}
}
func TestValidateDeployment_ConnectionFailure(t *testing.T) {
mock := &mockSSHClient{connectErr: fmt.Errorf("connection refused")}
cfg := &Config{
Host: "unreachable.local",
Port: 22,
CertPath: "/etc/ssl/cert.pem",
KeyPath: "/etc/ssl/key.pem",
CertMode: "0644",
KeyMode: "0600",
}
c := NewWithClient(cfg, mock, testLogger())
req := target.ValidationRequest{
CertificateID: "mc-test",
Serial: "ABC123",
}
result, err := c.ValidateDeployment(context.Background(), req)
if err == nil {
t.Fatal("expected error for connection failure")
}
if result.Valid {
t.Fatal("expected invalid result")
}
}
// --- Helper tests ---
func TestParsePermissions(t *testing.T) {
tests := []struct {
input string
expected os.FileMode
wantErr bool
}{
{"0644", 0644, false},
{"0600", 0600, false},
{"0755", 0755, false},
{"invalid", 0, true},
}
for _, tc := range tests {
t.Run(tc.input, func(t *testing.T) {
mode, err := parsePermissions(tc.input)
if tc.wantErr && err == nil {
t.Fatal("expected error")
}
if !tc.wantErr && err != nil {
t.Fatalf("unexpected error: %v", err)
}
if !tc.wantErr && mode != tc.expected {
t.Errorf("expected %v, got %v", tc.expected, mode)
}
})
}
}
func TestApplyDefaults(t *testing.T) {
cfg := &Config{}
applyDefaults(cfg)
if cfg.Port != 22 {
t.Errorf("expected port 22, got %d", cfg.Port)
}
if cfg.AuthMethod != "key" {
t.Errorf("expected auth_method key, got %s", cfg.AuthMethod)
}
if cfg.CertMode != "0644" {
t.Errorf("expected cert_mode 0644, got %s", cfg.CertMode)
}
if cfg.KeyMode != "0600" {
t.Errorf("expected key_mode 0600, got %s", cfg.KeyMode)
}
if cfg.Timeout != 30 {
t.Errorf("expected timeout 30, got %d", cfg.Timeout)
}
}
// --- Helpers ---
// createTempKeyFile creates a temporary file that simulates an SSH private key.
func createTempKeyFile(t *testing.T) string {
t.Helper()
dir := t.TempDir()
keyFile := dir + "/id_rsa"
if err := os.WriteFile(keyFile, []byte("fake-key-data"), 0600); err != nil {
t.Fatalf("failed to create temp key file: %v", err)
}
return keyFile
}
@@ -0,0 +1,313 @@
// Package wincertstore implements a target connector for deploying certificates
// to the Windows Certificate Store via PowerShell. Unlike the IIS connector,
// this connector only imports certificates into the store — it does not manage
// IIS site bindings. Use this for non-IIS Windows services that read certs
// from the Windows cert store (e.g., Exchange, RDP, SQL Server, ADFS).
//
// Architecture: Same injectable PowerShellExecutor pattern as the IIS connector.
// Supports agent-local PowerShell or WinRM proxy agent modes.
package wincertstore
import (
"context"
"encoding/base64"
"encoding/json"
"fmt"
"log/slog"
"os/exec"
"regexp"
"strings"
"time"
"github.com/shankar0123/certctl/internal/connector/target"
"github.com/shankar0123/certctl/internal/connector/target/certutil"
)
// Config represents the Windows Certificate Store deployment target configuration.
type Config struct {
// StoreName is the Windows certificate store name (e.g., "My", "Root", "WebHosting").
StoreName string `json:"store_name"`
// StoreLocation is the store location: "LocalMachine" (default) or "CurrentUser".
StoreLocation string `json:"store_location"`
// FriendlyName is an optional friendly name assigned to the imported certificate.
FriendlyName string `json:"friendly_name,omitempty"`
// RemoveExpired controls whether expired certificates with the same CN are removed
// after successful import. Default false.
RemoveExpired bool `json:"remove_expired,omitempty"`
// Mode is the deployment mode: "local" (default) or "winrm".
Mode string `json:"mode"`
// WinRM settings (only used when Mode is "winrm").
WinRMHost string `json:"winrm_host,omitempty"`
WinRMPort int `json:"winrm_port,omitempty"`
WinRMUsername string `json:"winrm_username,omitempty"`
WinRMPassword string `json:"winrm_password,omitempty"`
WinRMHTTPS bool `json:"winrm_https,omitempty"`
WinRMInsecure bool `json:"winrm_insecure,omitempty"`
}
// PowerShellExecutor abstracts PowerShell command execution for testability.
type PowerShellExecutor interface {
Execute(ctx context.Context, script string) (string, error)
}
// realExecutor calls powershell.exe on the local system.
type realExecutor struct{}
func (e *realExecutor) Execute(ctx context.Context, script string) (string, error) {
cmd := exec.CommandContext(ctx, "powershell.exe", "-NoProfile", "-NonInteractive", "-Command", script)
out, err := cmd.CombinedOutput()
return strings.TrimSpace(string(out)), err
}
// Connector implements the target.Connector interface for Windows Certificate Store.
type Connector struct {
config *Config
logger *slog.Logger
executor PowerShellExecutor
}
// validStoreName matches safe Windows certificate store names (alphanumeric, spaces, hyphens, dots).
var validStoreName = regexp.MustCompile(`^[a-zA-Z0-9 _\-\.]+$`)
// validStoreLocation matches allowed store locations.
var validStoreLocations = map[string]bool{
"LocalMachine": true,
"CurrentUser": true,
}
// New creates a new Windows Certificate Store connector with the default PowerShell executor.
func New(cfg *Config, logger *slog.Logger) (*Connector, error) {
if cfg == nil {
cfg = &Config{}
}
applyDefaults(cfg)
return &Connector{
config: cfg,
logger: logger,
executor: &realExecutor{},
}, nil
}
// NewWithExecutor creates a connector with an injected executor for testing.
func NewWithExecutor(cfg *Config, logger *slog.Logger, executor PowerShellExecutor) *Connector {
if cfg == nil {
cfg = &Config{}
}
applyDefaults(cfg)
return &Connector{
config: cfg,
logger: logger,
executor: executor,
}
}
func applyDefaults(cfg *Config) {
if cfg.StoreName == "" {
cfg.StoreName = "My"
}
if cfg.StoreLocation == "" {
cfg.StoreLocation = "LocalMachine"
}
if cfg.Mode == "" {
cfg.Mode = "local"
}
}
// ValidateConfig validates the Windows Certificate Store configuration.
func (c *Connector) ValidateConfig(ctx context.Context, config json.RawMessage) error {
var cfg Config
if err := json.Unmarshal(config, &cfg); err != nil {
return fmt.Errorf("invalid WinCertStore config JSON: %w", err)
}
applyDefaults(&cfg)
if !validStoreName.MatchString(cfg.StoreName) {
return fmt.Errorf("invalid store_name: must be alphanumeric (got %q)", cfg.StoreName)
}
if !validStoreLocations[cfg.StoreLocation] {
return fmt.Errorf("invalid store_location: must be 'LocalMachine' or 'CurrentUser' (got %q)", cfg.StoreLocation)
}
if cfg.FriendlyName != "" && !validStoreName.MatchString(cfg.FriendlyName) {
return fmt.Errorf("invalid friendly_name: must be alphanumeric (got %q)", cfg.FriendlyName)
}
if cfg.Mode != "local" && cfg.Mode != "winrm" {
return fmt.Errorf("invalid mode: must be 'local' or 'winrm' (got %q)", cfg.Mode)
}
if cfg.Mode == "winrm" {
if cfg.WinRMHost == "" {
return fmt.Errorf("winrm_host is required when mode is 'winrm'")
}
if cfg.WinRMUsername == "" {
return fmt.Errorf("winrm_username is required when mode is 'winrm'")
}
if cfg.WinRMPassword == "" {
return fmt.Errorf("winrm_password is required when mode is 'winrm'")
}
}
c.config = &cfg
return nil
}
// DeployCertificate imports a certificate into the Windows Certificate Store.
func (c *Connector) DeployCertificate(ctx context.Context, request target.DeploymentRequest) (*target.DeploymentResult, error) {
if request.KeyPEM == "" {
return nil, fmt.Errorf("private key is required for Windows Certificate Store import")
}
c.logger.Info("deploying certificate to Windows Certificate Store",
"store_name", c.config.StoreName,
"store_location", c.config.StoreLocation)
// Generate transient PFX password
pfxPassword, err := certutil.GenerateRandomPassword(32)
if err != nil {
return nil, fmt.Errorf("generate PFX password: %w", err)
}
// Convert PEM to PFX
pfxData, err := certutil.CreatePFX(request.CertPEM, request.KeyPEM, request.ChainPEM, pfxPassword)
if err != nil {
return nil, fmt.Errorf("create PFX: %w", err)
}
// Compute thumbprint for verification
thumbprint, err := certutil.ComputeThumbprint(request.CertPEM)
if err != nil {
return nil, fmt.Errorf("compute thumbprint: %w", err)
}
// Build the PowerShell import script
pfxB64 := base64.StdEncoding.EncodeToString(pfxData)
script := c.buildImportScript(pfxB64, pfxPassword, thumbprint)
output, err := c.executor.Execute(ctx, script)
if err != nil {
return nil, fmt.Errorf("PowerShell import failed: %s: %w", output, err)
}
c.logger.Info("certificate imported to Windows Certificate Store",
"thumbprint", thumbprint,
"store", c.config.StoreName,
"location", c.config.StoreLocation)
return &target.DeploymentResult{
Success: true,
TargetAddress: fmt.Sprintf("cert:\\%s\\%s", c.config.StoreLocation, c.config.StoreName),
DeploymentID: thumbprint,
Message: fmt.Sprintf("Certificate imported to %s\\%s (thumbprint: %s)", c.config.StoreLocation, c.config.StoreName, thumbprint),
DeployedAt: time.Now(),
Metadata: map[string]string{
"thumbprint": thumbprint,
"store_name": c.config.StoreName,
"store_location": c.config.StoreLocation,
},
}, nil
}
// buildImportScript creates the PowerShell script to import a PFX into the cert store.
func (c *Connector) buildImportScript(pfxB64, pfxPassword, thumbprint string) string {
var sb strings.Builder
// Decode PFX from base64 and write to temp file
sb.WriteString(fmt.Sprintf("$pfxBytes = [System.Convert]::FromBase64String('%s')\n", pfxB64))
sb.WriteString("$pfxPath = [System.IO.Path]::GetTempFileName() + '.pfx'\n")
sb.WriteString("try {\n")
sb.WriteString(" [System.IO.File]::WriteAllBytes($pfxPath, $pfxBytes)\n")
// Import PFX to cert store
sb.WriteString(fmt.Sprintf(" $secPwd = ConvertTo-SecureString -String '%s' -Force -AsPlainText\n", pfxPassword))
sb.WriteString(fmt.Sprintf(" $cert = Import-PfxCertificate -FilePath $pfxPath -CertStoreLocation 'Cert:\\%s\\%s' -Password $secPwd -Exportable\n",
c.config.StoreLocation, c.config.StoreName))
// Set friendly name if configured
if c.config.FriendlyName != "" {
sb.WriteString(fmt.Sprintf(" $cert.FriendlyName = '%s'\n", c.config.FriendlyName))
}
// Verify import
sb.WriteString(fmt.Sprintf(" $imported = Get-ChildItem 'Cert:\\%s\\%s\\%s' -ErrorAction SilentlyContinue\n",
c.config.StoreLocation, c.config.StoreName, thumbprint))
sb.WriteString(" if (-not $imported) { throw 'Certificate import verification failed' }\n")
// Remove expired certs with same subject (optional)
if c.config.RemoveExpired {
sb.WriteString(" $subject = $cert.Subject\n")
sb.WriteString(fmt.Sprintf(" Get-ChildItem 'Cert:\\%s\\%s' | Where-Object { $_.Subject -eq $subject -and $_.NotAfter -lt (Get-Date) -and $_.Thumbprint -ne '%s' } | Remove-Item -Force\n",
c.config.StoreLocation, c.config.StoreName, thumbprint))
}
sb.WriteString(fmt.Sprintf(" Write-Output 'SUCCESS:%s'\n", thumbprint))
sb.WriteString("} finally {\n")
sb.WriteString(" if (Test-Path $pfxPath) { Remove-Item $pfxPath -Force }\n")
sb.WriteString("}\n")
return sb.String()
}
// ValidateDeployment verifies that a certificate exists in the Windows Certificate Store.
func (c *Connector) ValidateDeployment(ctx context.Context, request target.ValidationRequest) (*target.ValidationResult, error) {
// Get thumbprint from metadata if available, otherwise query by serial
thumbprint := ""
if request.Metadata != nil {
thumbprint = request.Metadata["thumbprint"]
}
var script string
if thumbprint != "" {
script = fmt.Sprintf("$cert = Get-ChildItem 'Cert:\\%s\\%s\\%s' -ErrorAction SilentlyContinue; if ($cert) { Write-Output ('FOUND:' + $cert.Thumbprint + ':' + $cert.NotAfter.ToString('o')) } else { Write-Output 'NOT_FOUND' }",
c.config.StoreLocation, c.config.StoreName, thumbprint)
} else {
// Fallback: search by serial number
script = fmt.Sprintf("$cert = Get-ChildItem 'Cert:\\%s\\%s' | Where-Object { $_.SerialNumber -eq '%s' } | Select-Object -First 1; if ($cert) { Write-Output ('FOUND:' + $cert.Thumbprint + ':' + $cert.NotAfter.ToString('o')) } else { Write-Output 'NOT_FOUND' }",
c.config.StoreLocation, c.config.StoreName, request.Serial)
}
output, err := c.executor.Execute(ctx, script)
if err != nil {
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
Message: fmt.Sprintf("PowerShell query failed: %s", output),
ValidatedAt: time.Now(),
}, fmt.Errorf("validation query failed: %w", err)
}
if strings.HasPrefix(output, "FOUND:") {
parts := strings.SplitN(output, ":", 3)
foundThumb := ""
if len(parts) >= 2 {
foundThumb = parts[1]
}
return &target.ValidationResult{
Valid: true,
Serial: request.Serial,
TargetAddress: fmt.Sprintf("cert:\\%s\\%s", c.config.StoreLocation, c.config.StoreName),
Message: fmt.Sprintf("Certificate found in store (thumbprint: %s)", foundThumb),
ValidatedAt: time.Now(),
Metadata: map[string]string{
"thumbprint": foundThumb,
},
}, nil
}
return &target.ValidationResult{
Valid: false,
Serial: request.Serial,
Message: "Certificate not found in Windows Certificate Store",
ValidatedAt: time.Now(),
}, fmt.Errorf("certificate not found in %s\\%s", c.config.StoreLocation, c.config.StoreName)
}
// Ensure Connector implements target.Connector.
var _ target.Connector = (*Connector)(nil)
@@ -0,0 +1,412 @@
package wincertstore
import (
"context"
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/x509"
"crypto/x509/pkix"
"encoding/json"
"encoding/pem"
"fmt"
"log/slog"
"math/big"
"os"
"strings"
"testing"
"time"
"github.com/shankar0123/certctl/internal/connector/target"
)
func testLogger() *slog.Logger {
return slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelError}))
}
// mockExecutor records PowerShell scripts and returns configurable responses.
type mockExecutor struct {
scripts []string
responses []string
errors []error
callIndex int
}
func (m *mockExecutor) Execute(ctx context.Context, script string) (string, error) {
m.scripts = append(m.scripts, script)
idx := m.callIndex
m.callIndex++
if idx < len(m.errors) && m.errors[idx] != nil {
resp := ""
if idx < len(m.responses) {
resp = m.responses[idx]
}
return resp, m.errors[idx]
}
if idx < len(m.responses) {
return m.responses[idx], nil
}
return "", nil
}
// generateTestCertAndKey creates a self-signed certificate and key for testing.
func generateTestCertAndKey() (string, string, error) {
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
return "", "", err
}
template := &x509.Certificate{
SerialNumber: big.NewInt(1),
Subject: pkix.Name{CommonName: "test.example.com"},
NotBefore: time.Now().Add(-1 * time.Hour),
NotAfter: time.Now().Add(24 * time.Hour),
KeyUsage: x509.KeyUsageDigitalSignature,
}
certDER, err := x509.CreateCertificate(rand.Reader, template, template, &key.PublicKey, key)
if err != nil {
return "", "", err
}
certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})
keyDER, err := x509.MarshalPKCS8PrivateKey(key)
if err != nil {
return "", "", err
}
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: keyDER})
return string(certPEM), string(keyPEM), nil
}
// --- ValidateConfig Tests ---
func TestValidateConfig_Success(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"store_name":"My","store_location":"LocalMachine"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err != nil {
t.Fatalf("expected success, got: %v", err)
}
}
func TestValidateConfig_Defaults(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err != nil {
t.Fatalf("expected success with defaults, got: %v", err)
}
if c.config.StoreName != "My" {
t.Errorf("expected default store_name 'My', got: %s", c.config.StoreName)
}
if c.config.StoreLocation != "LocalMachine" {
t.Errorf("expected default store_location 'LocalMachine', got: %s", c.config.StoreLocation)
}
if c.config.Mode != "local" {
t.Errorf("expected default mode 'local', got: %s", c.config.Mode)
}
}
func TestValidateConfig_InvalidJSON(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
err := c.ValidateConfig(context.Background(), json.RawMessage(`{bad`))
if err == nil {
t.Fatal("expected error for invalid JSON")
}
}
func TestValidateConfig_InvalidStoreName(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"store_name":"My; Drop-Database"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err == nil || !strings.Contains(err.Error(), "invalid store_name") {
t.Fatalf("expected invalid store_name error, got: %v", err)
}
}
func TestValidateConfig_InvalidStoreLocation(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"store_location":"InvalidLocation"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err == nil || !strings.Contains(err.Error(), "invalid store_location") {
t.Fatalf("expected invalid store_location error, got: %v", err)
}
}
func TestValidateConfig_CurrentUser(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"store_location":"CurrentUser"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err != nil {
t.Fatalf("expected success with CurrentUser, got: %v", err)
}
}
func TestValidateConfig_InvalidMode(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"mode":"ssh"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err == nil || !strings.Contains(err.Error(), "invalid mode") {
t.Fatalf("expected invalid mode error, got: %v", err)
}
}
func TestValidateConfig_WinRM_MissingHost(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"mode":"winrm","winrm_username":"admin","winrm_password":"pass"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err == nil || !strings.Contains(err.Error(), "winrm_host") {
t.Fatalf("expected winrm_host error, got: %v", err)
}
}
func TestValidateConfig_WinRM_MissingUsername(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"mode":"winrm","winrm_host":"host","winrm_password":"pass"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err == nil || !strings.Contains(err.Error(), "winrm_username") {
t.Fatalf("expected winrm_username error, got: %v", err)
}
}
func TestValidateConfig_InvalidFriendlyName(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"friendly_name":"cert; rm -rf /"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err == nil || !strings.Contains(err.Error(), "invalid friendly_name") {
t.Fatalf("expected invalid friendly_name error, got: %v", err)
}
}
func TestValidateConfig_WithFriendlyName(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
cfg := `{"friendly_name":"My Production Cert"}`
err := c.ValidateConfig(context.Background(), json.RawMessage(cfg))
if err != nil {
t.Fatalf("expected success with friendly name, got: %v", err)
}
}
// --- DeployCertificate Tests ---
func TestDeployCertificate_Success(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{
responses: []string{"SUCCESS:AABBCCDD"},
}
c := NewWithExecutor(&Config{
StoreName: "My",
StoreLocation: "LocalMachine",
}, testLogger(), mock)
result, err := c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy failed: %v", err)
}
if !result.Success {
t.Error("expected success=true")
}
if result.TargetAddress != "cert:\\LocalMachine\\My" {
t.Errorf("expected target address cert:\\LocalMachine\\My, got: %s", result.TargetAddress)
}
if result.Metadata["store_name"] != "My" {
t.Errorf("expected store_name metadata 'My', got: %s", result.Metadata["store_name"])
}
// Verify the PowerShell script was called
if len(mock.scripts) != 1 {
t.Fatalf("expected 1 script call, got %d", len(mock.scripts))
}
script := mock.scripts[0]
if !strings.Contains(script, "Import-PfxCertificate") {
t.Error("expected Import-PfxCertificate in script")
}
if !strings.Contains(script, "Cert:\\LocalMachine\\My") {
t.Error("expected correct cert store path in script")
}
}
func TestDeployCertificate_MissingKey(t *testing.T) {
certPEM, _, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
})
if err == nil || !strings.Contains(err.Error(), "private key is required") {
t.Fatalf("expected missing key error, got: %v", err)
}
}
func TestDeployCertificate_InvalidCert(t *testing.T) {
c := NewWithExecutor(&Config{}, testLogger(), &mockExecutor{})
_, err := c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: "not-a-cert",
KeyPEM: "not-a-key",
})
if err == nil {
t.Fatal("expected error for invalid cert")
}
}
func TestDeployCertificate_ImportFailed(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{
responses: []string{"Access denied"},
errors: []error{fmt.Errorf("exit code 1")},
}
c := NewWithExecutor(&Config{}, testLogger(), mock)
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err == nil || !strings.Contains(err.Error(), "PowerShell import failed") {
t.Fatalf("expected import failure error, got: %v", err)
}
}
func TestDeployCertificate_WithFriendlyName(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{responses: []string{"SUCCESS:AABB"}}
c := NewWithExecutor(&Config{
StoreName: "My",
FriendlyName: "Production API Cert",
}, testLogger(), mock)
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy failed: %v", err)
}
if !strings.Contains(mock.scripts[0], "FriendlyName") {
t.Error("expected FriendlyName in PowerShell script")
}
}
func TestDeployCertificate_WithRemoveExpired(t *testing.T) {
certPEM, keyPEM, err := generateTestCertAndKey()
if err != nil {
t.Fatalf("generate cert: %v", err)
}
mock := &mockExecutor{responses: []string{"SUCCESS:AABB"}}
c := NewWithExecutor(&Config{
StoreName: "My",
RemoveExpired: true,
}, testLogger(), mock)
_, err = c.DeployCertificate(context.Background(), target.DeploymentRequest{
CertPEM: certPEM,
KeyPEM: keyPEM,
})
if err != nil {
t.Fatalf("deploy failed: %v", err)
}
if !strings.Contains(mock.scripts[0], "Remove-Item") {
t.Error("expected Remove-Item for expired cert cleanup in script")
}
}
// --- ValidateDeployment Tests ---
func TestValidateDeployment_Success(t *testing.T) {
mock := &mockExecutor{
responses: []string{"FOUND:AABBCCDD:2027-01-01T00:00:00"},
}
c := NewWithExecutor(&Config{
StoreName: "My",
StoreLocation: "LocalMachine",
}, testLogger(), mock)
result, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "01",
Metadata: map[string]string{
"thumbprint": "AABBCCDD",
},
})
if err != nil {
t.Fatalf("validate failed: %v", err)
}
if !result.Valid {
t.Error("expected valid=true")
}
if result.Metadata["thumbprint"] != "AABBCCDD" {
t.Errorf("expected thumbprint AABBCCDD, got: %s", result.Metadata["thumbprint"])
}
}
func TestValidateDeployment_NotFound(t *testing.T) {
mock := &mockExecutor{
responses: []string{"NOT_FOUND"},
}
c := NewWithExecutor(&Config{}, testLogger(), mock)
result, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "01",
})
if err == nil {
t.Fatal("expected error for not found cert")
}
if result.Valid {
t.Error("expected valid=false")
}
}
func TestValidateDeployment_QueryFailed(t *testing.T) {
mock := &mockExecutor{
responses: []string{"error"},
errors: []error{fmt.Errorf("powershell error")},
}
c := NewWithExecutor(&Config{}, testLogger(), mock)
result, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "01",
})
if err == nil {
t.Fatal("expected error for query failure")
}
if result.Valid {
t.Error("expected valid=false")
}
}
func TestValidateDeployment_BySerial(t *testing.T) {
mock := &mockExecutor{
responses: []string{"FOUND:AABB:2027-01-01T00:00:00"},
}
c := NewWithExecutor(&Config{}, testLogger(), mock)
// No thumbprint in metadata — should query by serial
_, err := c.ValidateDeployment(context.Background(), target.ValidationRequest{
Serial: "DEADBEEF",
})
if err != nil {
t.Fatalf("validate failed: %v", err)
}
if !strings.Contains(mock.scripts[0], "SerialNumber") {
t.Error("expected serial number query in script")
}
}
+2 -2
View File
@@ -2,7 +2,7 @@ package domain
import "time"
// RenewalInfo represents ACME Renewal Information (ARI) per RFC 9702.
// RenewalInfo represents ACME Renewal Information (ARI) per RFC 9773.
// It provides CA-directed renewal timing via a suggested renewal window.
type RenewalInfo struct {
// SuggestedWindowStart is the beginning of the time window during which the CA suggests renewal.
@@ -27,7 +27,7 @@ func (r *RenewalInfo) ShouldRenewNow() bool {
}
// OptimalRenewalTime returns the midpoint of the suggested renewal window,
// which is the recommended time to initiate renewal per RFC 9702.
// which is the recommended time to initiate renewal per RFC 9773.
// This can be used for scheduling if the current time is before the window.
func (r *RenewalInfo) OptimalRenewalTime() time.Time {
duration := r.SuggestedWindowEnd.Sub(r.SuggestedWindowStart)
+126
View File
@@ -78,3 +78,129 @@ func TestRenewalPolicy_EffectiveAlertThresholds_Nil(t *testing.T) {
t.Errorf("expected %d thresholds, got %d", len(expected), len(result))
}
}
// --- 45-Day / Short-Lived Certificate Renewal Threshold Tests ---
// These tests validate that certctl's renewal logic works correctly with shorter-lived
// certificates as the industry transitions from 90-day to 45-day validity (SC-081v3)
// and Let's Encrypt introduces 6-day "shortlived" profiles.
func TestRenewalThresholds_45DayCert(t *testing.T) {
// A 45-day cert with default thresholds [30, 14, 7, 0]:
// - 30-day alert fires when cert is 15 days old (45 - 30 = 15 days remaining)
// - 14-day alert fires when cert is 31 days old
// - 7-day alert fires when cert is 38 days old
// - 0-day alert fires at expiry
// The 30-day threshold fires at the 1/3 lifetime mark — this is correct
// (Let's Encrypt recommends renewal at 2/3 through lifetime, i.e. day 30).
thresholds := DefaultAlertThresholds()
certLifetimeDays := 45
for _, threshold := range thresholds {
daysCertAge := certLifetimeDays - threshold
if daysCertAge < 0 {
t.Errorf("threshold %d days exceeds cert lifetime %d days", threshold, certLifetimeDays)
}
}
// Verify the first alert (30 days) fires when 15 days remain
// This means the cert is 15 days old — at 1/3 of its lifetime
firstAlertDaysRemaining := certLifetimeDays - (certLifetimeDays - thresholds[0])
if firstAlertDaysRemaining != 30 {
t.Errorf("expected first alert at 30 days remaining, got %d", firstAlertDaysRemaining)
}
// The renewal window query (31 days ahead) will find 45-day certs
// when they have 31 or fewer days remaining — at day 14 of a 45-day cert.
renewalWindowDays := 31
certAgeAtRenewalCheck := certLifetimeDays - renewalWindowDays
if certAgeAtRenewalCheck != 14 {
t.Errorf("expected renewal check to find cert at age %d, got %d", 14, certAgeAtRenewalCheck)
}
}
func TestRenewalThresholds_6DayCert(t *testing.T) {
// A 6-day "shortlived" cert with default thresholds [30, 14, 7, 0]:
// - The 30-day, 14-day, and 7-day thresholds can NEVER fire (cert expires before reaching them)
// - Only the 0-day threshold fires at expiry
// For 6-day certs, ARI (RFC 9773) is the expected renewal path — the CA directs timing.
// Short-lived certs also skip CRL/OCSP (revocation via expiry, per M15b).
thresholds := DefaultAlertThresholds()
certLifetimeDays := 6
firingThresholds := 0
for _, threshold := range thresholds {
if threshold < certLifetimeDays {
firingThresholds++
}
}
// Only the 0-day threshold can fire (0 < 6).
// The 7-day threshold means "alert when 7 days remain" — a 6-day cert
// never has 7 days remaining, so it never fires.
// For 6-day certs, ARI (RFC 9773) is the expected renewal path.
if firingThresholds != 1 {
t.Errorf("expected 1 threshold to fire for 6-day cert, got %d", firingThresholds)
}
// The renewal window query (31 days ahead) will find 6-day certs immediately
// (they're always within the 31-day window from the moment they're issued).
renewalWindowDays := 31
if certLifetimeDays < renewalWindowDays {
// This is expected — 6-day certs are always in the renewal window.
// ARI should override the threshold-based logic for these certs.
}
}
func TestRenewalThresholds_47DayCert(t *testing.T) {
// SC-081v3 mandates 47-day max validity by March 2029.
// Default thresholds [30, 14, 7, 0] should work correctly.
thresholds := DefaultAlertThresholds()
certLifetimeDays := 47
for _, threshold := range thresholds {
if threshold > certLifetimeDays {
t.Errorf("threshold %d exceeds cert lifetime %d", threshold, certLifetimeDays)
}
}
// With RenewalWindowDays=30, renewal triggers at day 17 (47-30=17).
// That's at the 36% mark of the cert's lifetime — reasonable.
renewalWindowDays := 30
renewalDay := certLifetimeDays - renewalWindowDays
if renewalDay != 17 {
t.Errorf("expected renewal at day 17, got %d", renewalDay)
}
}
func TestRenewalThresholds_200DayCert(t *testing.T) {
// SC-081v3 Phase 1: 200-day max validity (March 2026).
// All default thresholds should fire normally.
thresholds := DefaultAlertThresholds()
certLifetimeDays := 200
for _, threshold := range thresholds {
if threshold > certLifetimeDays {
t.Errorf("threshold %d exceeds cert lifetime %d", threshold, certLifetimeDays)
}
}
}
func TestRenewalThresholds_100DayCert(t *testing.T) {
// SC-081v3 Phase 2: 100-day max validity (March 2027).
thresholds := DefaultAlertThresholds()
certLifetimeDays := 100
for _, threshold := range thresholds {
if threshold > certLifetimeDays {
t.Errorf("threshold %d exceeds cert lifetime %d", threshold, certLifetimeDays)
}
}
// With default 31-day renewal window, renewal triggers at day 69 — at 69% of lifetime.
// This is close to Let's Encrypt's recommended 2/3 mark.
renewalWindowDays := 31
renewalDay := certLifetimeDays - renewalWindowDays
if renewalDay != 69 {
t.Errorf("expected renewal at day 69, got %d", renewalDay)
}
}
+3
View File
@@ -97,4 +97,7 @@ const (
TargetTypeEnvoy TargetType = "Envoy"
TargetTypePostfix TargetType = "Postfix"
TargetTypeDovecot TargetType = "Dovecot"
TargetTypeSSH TargetType = "SSH"
TargetTypeWinCertStore TargetType = "WinCertStore"
TargetTypeJavaKeystore TargetType = "JavaKeystore"
)
+7
View File
@@ -334,6 +334,7 @@ func (s *IssuerService) buildEnvVarSeeds(cfg *config.Config) []*domain.Issuer {
"directory_url": cfg.ACME.DirectoryURL,
"email": cfg.ACME.Email,
"challenge_type": cfg.ACME.ChallengeType,
"profile": cfg.ACME.Profile,
"insecure": cfg.ACME.Insecure,
"ari_enabled": cfg.ACME.ARIEnabled,
}),
@@ -352,6 +353,7 @@ func (s *IssuerService) buildEnvVarSeeds(cfg *config.Config) []*domain.Issuer {
"directory_url": cfg.ACME.DirectoryURL,
"email": cfg.ACME.Email,
"challenge_type": cfg.ACME.ChallengeType,
"profile": cfg.ACME.Profile,
"insecure": cfg.ACME.Insecure,
"ari_enabled": cfg.ACME.ARIEnabled,
}),
@@ -534,6 +536,11 @@ func (s *IssuerService) CreateIssuer(iss domain.Issuer) (*domain.Issuer, error)
if iss.Source == "" {
iss.Source = "database"
}
// GUI-created issuers should be enabled by default.
// Go's bool zero value is false, which overrides the DB default when explicitly inserted.
if iss.Source == "database" && !iss.Enabled {
iss.Enabled = true
}
// Encrypt config
if len(iss.Config) > 0 {
+2 -2
View File
@@ -54,7 +54,7 @@ type IssuerConnector interface {
SignOCSPResponse(ctx context.Context, req OCSPSignRequest) ([]byte, error)
// GetCACertPEM returns the PEM-encoded CA certificate chain for this issuer.
GetCACertPEM(ctx context.Context) (string, error)
// GetRenewalInfo retrieves ACME Renewal Information (ARI) per RFC 9702 for a certificate.
// GetRenewalInfo retrieves ACME Renewal Information (ARI) per RFC 9773 for a certificate.
// certPEM is the PEM-encoded certificate. Returns nil, nil if the issuer does not support ARI.
GetRenewalInfo(ctx context.Context, certPEM string) (*RenewalInfoResult, error)
}
@@ -174,7 +174,7 @@ func (s *RenewalService) CheckExpiringCertificates(ctx context.Context) error {
continue
}
// ARI check (RFC 9702): if the issuer supports ARI, let the CA direct renewal timing.
// ARI check (RFC 9773): if the issuer supports ARI, let the CA direct renewal timing.
// Fetch the latest cert version to get the PEM chain for the ARI query.
ariChecked := false
if version, vErr := s.certRepo.GetLatestVersion(ctx, cert.ID); vErr == nil && version != nil && version.PEMChain != "" {
+1 -1
View File
@@ -853,7 +853,7 @@ func TestProcessRenewalJob_NoCertificate(t *testing.T) {
}
}
// --- ARI (RFC 9702) Scheduler Integration Tests ---
// --- ARI (RFC 9773) Scheduler Integration Tests ---
func TestCheckExpiringCertificates_ARI_ShouldRenewNow(t *testing.T) {
t.Helper()
+8
View File
@@ -24,6 +24,9 @@ var validTargetTypes = map[domain.TargetType]bool{
domain.TargetTypeEnvoy: true,
domain.TargetTypePostfix: true,
domain.TargetTypeDovecot: true,
domain.TargetTypeSSH: true,
domain.TargetTypeWinCertStore: true,
domain.TargetTypeJavaKeystore: true,
}
// isValidTargetType checks if a type string is a known target type.
@@ -281,6 +284,11 @@ func (s *TargetService) CreateTarget(target domain.DeploymentTarget) (*domain.De
if target.Source == "" {
target.Source = "database"
}
// GUI-created targets should be enabled by default.
// Go's bool zero value is false, which overrides the DB default when explicitly inserted.
if target.Source == "database" && !target.Enabled {
target.Enabled = true
}
// Encrypt config
if len(target.Config) > 0 {
+22
View File
@@ -691,6 +691,28 @@ describe('API Client', () => {
expect(body.config.org_id).toBe('12345');
expect(body.config.product_type).toBe('ssl_basic');
});
it('createIssuer sends correct payload for ACME with profile', async () => {
mockFetch.mockReturnValueOnce(mockJsonResponse({ id: 'iss-acme-shortlived', name: 'ACME Shortlived' }));
const acmePayload = {
name: 'ACME Shortlived',
type: 'acme',
config: {
directory_url: 'https://acme-v02.api.letsencrypt.org/directory',
email: 'admin@example.com',
challenge_type: 'http-01',
profile: 'shortlived',
},
};
await createIssuer(acmePayload);
const [url, init] = mockFetch.mock.calls[0];
expect(url).toBe('/api/v1/issuers');
expect(init.method).toBe('POST');
const body = JSON.parse(init.body);
expect(body.type).toBe('acme');
expect(body.config.profile).toBe('shortlived');
expect(body.config.directory_url).toBe('https://acme-v02.api.letsencrypt.org/directory');
});
});
// ─── Audit ──────────────────────────────────────────
+6
View File
@@ -169,6 +169,9 @@ export const getNotifications = (params: Record<string, string> = {}) => {
return fetchJSON<PaginatedResponse<Notification>>(`${BASE}/notifications?${qs}`);
};
export const getNotification = (id: string) =>
fetchJSON<Notification>(`${BASE}/notifications/${id}`);
export const markNotificationRead = (id: string) =>
fetchJSON<{ message: string }>(`${BASE}/notifications/${id}/read`, { method: 'POST' });
@@ -178,6 +181,9 @@ export const getAuditEvents = (params: Record<string, string> = {}) => {
return fetchJSON<PaginatedResponse<AuditEvent>>(`${BASE}/audit?${qs}`);
};
export const getAuditEvent = (id: string) =>
fetchJSON<AuditEvent>(`${BASE}/audit/${id}`);
// Policies
export const getPolicies = (params: Record<string, string> = {}) => {
const qs = new URLSearchParams({ page: '1', per_page: '50', ...params }).toString();
+8 -10
View File
@@ -10,11 +10,11 @@ export interface Certificate {
team_id: string;
renewal_policy_id: string;
certificate_profile_id: string;
serial_number: string;
fingerprint: string;
key_algorithm: string;
key_size: number;
issued_at: string;
serial_number?: string;
fingerprint_sha256?: string;
key_algorithm?: string;
key_size?: number;
issued_at?: string;
expires_at: string;
revoked_at?: string;
revocation_reason?: string;
@@ -40,11 +40,9 @@ export const REVOCATION_REASONS = [
export interface CertificateVersion {
id: string;
certificate_id: string;
version: number;
serial_number: string;
fingerprint: string;
cert_pem: string;
chain_pem: string;
fingerprint_sha256: string;
pem_chain: string;
csr_pem: string;
not_before: string;
not_after: string;
@@ -80,7 +78,7 @@ export interface Job {
status: string;
attempts: number;
max_attempts: number;
error_message: string;
last_error?: string;
scheduled_at: string;
started_at: string;
completed_at: string;
+2 -2
View File
@@ -1,9 +1,9 @@
export function formatDate(iso: string): string {
export function formatDate(iso: string | undefined | null): string {
if (!iso) return '—';
return new Date(iso).toLocaleDateString('en-US', { year: 'numeric', month: 'short', day: 'numeric' });
}
export function formatDateTime(iso: string): string {
export function formatDateTime(iso: string | undefined | null): string {
if (!iso) return '—';
return new Date(iso).toLocaleString('en-US', { year: 'numeric', month: 'short', day: 'numeric', hour: '2-digit', minute: '2-digit' });
}
+22 -13
View File
@@ -29,19 +29,23 @@ export interface IssuerTypeConfig {
}
/**
* Canonical type label map. Keys match what the backend API returns.
* DB stores: local, acme, stepca, openssl, VaultPKI, DigiCert
* Canonical type label map. Keys MUST match backend IssuerType constants
* defined in internal/domain/connector.go (e.g., "ACME", "GenericCA", "StepCA").
*/
export const typeLabels: Record<string, string> = {
local: 'Local CA',
GenericCA: 'Local CA',
local: 'Local CA', // backward compat for old DB records
local_ca: 'Local CA', // backward compat (some frontend references)
acme: 'ACME',
stepca: 'step-ca',
openssl: 'OpenSSL/Custom',
ACME: 'ACME',
acme: 'ACME', // backward compat for old DB records
StepCA: 'step-ca',
stepca: 'step-ca', // backward compat for old DB records
OpenSSL: 'OpenSSL/Custom',
openssl: 'OpenSSL/Custom', // backward compat for old DB records
VaultPKI: 'Vault PKI',
DigiCert: 'DigiCert',
Sectigo: 'Sectigo SCM',
manual: 'Manual',
GoogleCAS: 'Google CAS',
};
/**
@@ -50,7 +54,7 @@ export const typeLabels: Record<string, string> = {
*/
export const issuerTypes: IssuerTypeConfig[] = [
{
id: 'acme',
id: 'ACME',
name: 'ACME',
description: "Let's Encrypt, ZeroSSL, or any ACME-compatible CA",
icon: '\uD83D\uDD12',
@@ -58,12 +62,13 @@ export const issuerTypes: IssuerTypeConfig[] = [
{ key: 'directory_url', label: 'Directory URL', placeholder: 'https://acme-v02.api.letsencrypt.org/directory', required: true },
{ key: 'email', label: 'Email', placeholder: 'admin@example.com', required: true },
{ key: 'challenge_type', label: 'Challenge Type', type: 'select', options: ['http-01', 'dns-01', 'dns-persist-01'], required: false, defaultValue: 'http-01' },
{ key: 'profile', label: 'Certificate Profile', type: 'select', options: ['', 'tlsserver', 'shortlived'], required: false, defaultValue: '' },
{ key: 'eab_kid', label: 'EAB Key ID', placeholder: 'External Account Binding Key ID (optional)', required: false },
{ key: 'eab_hmac', label: 'EAB HMAC Key', placeholder: 'External Account Binding HMAC key', required: false, type: 'password', sensitive: true },
],
},
{
id: 'local',
id: 'GenericCA',
name: 'Local CA',
description: 'Self-signed or subordinate CA for internal certificates',
icon: '\uD83C\uDFE0',
@@ -73,14 +78,15 @@ export const issuerTypes: IssuerTypeConfig[] = [
],
},
{
id: 'stepca',
id: 'StepCA',
name: 'step-ca',
description: 'Smallstep private CA with JWK provisioner auth',
icon: '\uD83D\uDC63',
configFields: [
{ key: 'ca_url', label: 'CA URL', placeholder: 'https://ca.example.com', required: true },
{ key: 'provisioner_name', label: 'Provisioner Name', placeholder: 'my-provisioner', required: true },
{ key: 'provisioner_key', label: 'Provisioner Key (JWK)', placeholder: '{...}', type: 'textarea', required: true, sensitive: true },
{ key: 'provisioner_key_path', label: 'Provisioner Key Path', placeholder: '/path/to/provisioner.key', required: false, sensitive: true },
{ key: 'provisioner_password', label: 'Provisioner Password', placeholder: 'Password for encrypted key', required: false, type: 'password', sensitive: true },
],
},
{
@@ -109,7 +115,7 @@ export const issuerTypes: IssuerTypeConfig[] = [
],
},
{
id: 'openssl',
id: 'OpenSSL',
name: 'OpenSSL/Custom',
description: 'Script-based signing with your own CA',
icon: '\uD83D\uDD27',
@@ -187,7 +193,10 @@ export function getIssuerCatalogStatus(
}
// Match both the canonical id and common aliases
const aliases: Record<string, string[]> = {
local: ['local', 'local_ca'],
GenericCA: ['GenericCA', 'local', 'local_ca'],
ACME: ['ACME', 'acme'],
StepCA: ['StepCA', 'stepca'],
OpenSSL: ['OpenSSL', 'openssl'],
};
const matchIds = aliases[t.id] || [t.id];
const matching = configuredIssuers.filter(i => matchIds.includes(i.type));
+12 -6
View File
@@ -60,7 +60,7 @@ function TimelineStep({ label, status, time, isLast }: { label: string; status:
);
}
function DeploymentTimeline({ certId, certStatus, createdAt, issuedAt }: { certId: string; certStatus: string; createdAt: string; issuedAt: string }) {
function DeploymentTimeline({ certId, certStatus, createdAt, issuedAt }: { certId: string; certStatus: string; createdAt: string; issuedAt?: string }) {
const { data: jobsData } = useQuery({
queryKey: ['jobs', { certificate_id: certId }],
queryFn: () => getJobs({ certificate_id: certId }),
@@ -372,6 +372,12 @@ export default function CertificateDetailPage() {
);
}
// Derive certificate metadata from latest version (backend doesn't include these on the cert object)
const latestVersion = versions?.data?.[0];
const serialNumber = cert.serial_number || latestVersion?.serial_number;
const fingerprintSha256 = cert.fingerprint_sha256 || latestVersion?.fingerprint_sha256;
const issuedAt = cert.issued_at || latestVersion?.not_before;
const days = daysUntil(cert.expires_at);
const isRevoked = cert.status === 'Revoked';
const isArchived = cert.status === 'Archived';
@@ -492,7 +498,7 @@ export default function CertificateDetailPage() {
)}
{/* Deployment Status Timeline */}
<DeploymentTimeline certId={id!} certStatus={cert.status} createdAt={cert.created_at} issuedAt={cert.issued_at} />
<DeploymentTimeline certId={id!} certStatus={cert.status} createdAt={cert.created_at} issuedAt={issuedAt} />
<div className="grid grid-cols-1 lg:grid-cols-2 gap-6">
{/* Certificate Info */}
@@ -518,9 +524,9 @@ export default function CertificateDetailPage() {
})}
</span>
) : '—'} />
<InfoRow label="Serial Number" value={cert.serial_number || '—'} />
<InfoRow label="Serial Number" value={serialNumber || '—'} />
<InfoRow label="Fingerprint" value={
cert.fingerprint ? <span className="font-mono text-xs">{cert.fingerprint.slice(0, 24)}...</span> : '—'
fingerprintSha256 ? <span className="font-mono text-xs">{fingerprintSha256.slice(0, 24)}...</span> : '—'
} />
<InfoRow label="Key Algorithm" value={cert.key_algorithm || '—'} />
<InfoRow label="Key Size" value={cert.key_size ? `${cert.key_size} bits` : '—'} />
@@ -556,7 +562,7 @@ export default function CertificateDetailPage() {
{/* Lifecycle */}
<div className="bg-surface border border-surface-border rounded p-5 shadow-sm">
<h3 className="text-sm font-semibold text-ink-muted mb-4">Lifecycle</h3>
<InfoRow label="Issued" value={formatDate(cert.issued_at)} />
<InfoRow label="Issued" value={formatDate(issuedAt)} />
<InfoRow label="Expires" value={
<span className={isRevoked ? 'text-red-600 line-through' : expiryColor(days)}>
{formatDate(cert.expires_at)} ({days <= 0 ? 'expired' : `${days} days`})
@@ -615,7 +621,7 @@ export default function CertificateDetailPage() {
<div key={v.id} className="flex items-center justify-between py-2 border-b border-surface-border/50 last:border-0">
<div>
<div className="flex items-center gap-2">
<span className="text-sm text-ink">Version {v.version}</span>
<span className="text-sm text-ink">Version {versions.data.length - idx}</span>
{idx === 0 && <span className="text-xs bg-brand-100 text-brand-700 px-1.5 py-0.5 rounded">Current</span>}
</div>
<div className="text-xs text-ink-faint font-mono">{v.serial_number}</div>
+2 -2
View File
@@ -114,9 +114,9 @@ export default function JobDetailPage() {
} />
)}
<InfoRow label="Attempts" value={`${job.attempts} / ${job.max_attempts}`} />
{job.error_message && (
{job.last_error && (
<InfoRow label="Error" value={
<span className="text-red-600 text-xs">{job.error_message}</span>
<span className="text-red-600 text-xs">{job.last_error}</span>
} />
)}
</div>
+3 -3
View File
@@ -139,9 +139,9 @@ export default function JobsPage() {
{
key: 'error',
label: 'Error',
render: (j) => j.status === 'Failed' && j.error_message ? (
<span className="text-xs text-red-600 truncate max-w-[200px] inline-block" title={j.error_message}>
{j.error_message.length > 80 ? j.error_message.substring(0, 80) + '...' : j.error_message}
render: (j) => j.status === 'Failed' && j.last_error ? (
<span className="text-xs text-red-600 truncate max-w-[200px] inline-block" title={j.last_error}>
{j.last_error.length > 80 ? j.last_error.substring(0, 80) + '...' : j.last_error}
</span>
) : <span className="text-xs text-ink-faint"></span>,
},
+14 -11
View File
@@ -11,16 +11,19 @@ import { formatDateTime } from '../api/utils';
import type { Job } from '../api/types';
const typeLabels: Record<string, string> = {
nginx: 'NGINX',
apache: 'Apache',
haproxy: 'HAProxy',
traefik: 'Traefik',
caddy: 'Caddy',
f5_bigip: 'F5 BIG-IP',
iis: 'IIS',
envoy: 'Envoy',
postfix: 'Postfix',
dovecot: 'Dovecot',
NGINX: 'NGINX',
Apache: 'Apache',
HAProxy: 'HAProxy',
Traefik: 'Traefik',
Caddy: 'Caddy',
F5: 'F5 BIG-IP',
IIS: 'IIS',
Envoy: 'Envoy',
Postfix: 'Postfix',
Dovecot: 'Dovecot',
SSH: 'SSH',
WinCertStore: 'Windows Cert Store',
JavaKeystore: 'Java Keystore',
};
function InfoRow({ label, value }: { label: string; value: React.ReactNode }) {
@@ -228,7 +231,7 @@ export default function TargetDetailPage() {
{target.config && Object.keys(target.config).length > 0 ? (
<div className="space-y-0">
{Object.entries(target.config).map(([key, val]) => {
const sensitiveKeys = ['password', 'secret', 'token', 'key', 'winrm_password'];
const sensitiveKeys = ['password', 'secret', 'token', 'key', 'passphrase', 'winrm_password', 'keystore_password'];
const isSensitive = sensitiveKeys.some(s => key.toLowerCase().includes(s));
const displayVal = isSensitive && val ? '********' : String(val);
return (
+143 -41
View File
@@ -11,83 +11,92 @@ import { formatDateTime } from '../api/utils';
import type { Target } from '../api/types';
const typeLabels: Record<string, string> = {
nginx: 'NGINX',
apache: 'Apache',
haproxy: 'HAProxy',
traefik: 'Traefik',
caddy: 'Caddy',
envoy: 'Envoy',
postfix: 'Postfix',
dovecot: 'Dovecot',
f5_bigip: 'F5 BIG-IP',
iis: 'IIS',
NGINX: 'NGINX',
Apache: 'Apache',
HAProxy: 'HAProxy',
Traefik: 'Traefik',
Caddy: 'Caddy',
Envoy: 'Envoy',
Postfix: 'Postfix',
Dovecot: 'Dovecot',
F5: 'F5 BIG-IP',
IIS: 'IIS',
SSH: 'SSH',
WinCertStore: 'Windows Cert Store',
JavaKeystore: 'Java Keystore',
};
const TARGET_TYPES = [
{ value: 'nginx', label: 'NGINX', description: 'Deploy to NGINX web server via file write + config validation + reload' },
{ value: 'apache', label: 'Apache httpd', description: 'Separate cert/chain/key files, apachectl configtest, graceful reload' },
{ value: 'haproxy', label: 'HAProxy', description: 'Combined PEM file (cert+chain+key), optional validate, reload' },
{ value: 'traefik', label: 'Traefik', description: 'File provider deployment — writes cert/key to watched directory, auto-reload' },
{ value: 'caddy', label: 'Caddy', description: 'Admin API hot-reload or file-based deployment with configurable mode' },
{ value: 'envoy', label: 'Envoy', description: 'File-based deployment — writes cert/key to watched directory. Optional SDS file generation.' },
{ value: 'postfix', label: 'Postfix', description: 'Postfix MTA — file write + postfix reload' },
{ value: 'dovecot', label: 'Dovecot', description: 'Dovecot IMAP/POP3 — file write + doveadm reload' },
{ value: 'f5_bigip', label: 'F5 BIG-IP', description: 'iControl REST — cert upload, SSL profile update via proxy agent' },
{ value: 'iis', label: 'IIS', description: 'Windows IIS via agent-local PowerShell or remote WinRM proxy agent' },
{ value: 'NGINX', label: 'NGINX', description: 'Deploy to NGINX web server via file write + config validation + reload' },
{ value: 'Apache', label: 'Apache httpd', description: 'Separate cert/chain/key files, apachectl configtest, graceful reload' },
{ value: 'HAProxy', label: 'HAProxy', description: 'Combined PEM file (cert+chain+key), optional validate, reload' },
{ value: 'Traefik', label: 'Traefik', description: 'File provider deployment — writes cert/key to watched directory, auto-reload' },
{ value: 'Caddy', label: 'Caddy', description: 'Admin API hot-reload or file-based deployment with configurable mode' },
{ value: 'Envoy', label: 'Envoy', description: 'File-based deployment — writes cert/key to watched directory. Optional SDS file generation.' },
{ value: 'Postfix', label: 'Postfix', description: 'Postfix MTA — file write + postfix reload' },
{ value: 'Dovecot', label: 'Dovecot', description: 'Dovecot IMAP/POP3 — file write + doveadm reload' },
{ value: 'F5', label: 'F5 BIG-IP', description: 'iControl REST — cert upload, SSL profile update via proxy agent' },
{ value: 'IIS', label: 'IIS', description: 'Windows IIS via agent-local PowerShell or remote WinRM proxy agent' },
{ value: 'SSH', label: 'SSH', description: 'Agentless deployment via SSH/SFTP — deploy to any Linux/Unix server without installing an agent' },
{ value: 'WinCertStore', label: 'Windows Cert Store', description: 'Import certificates into Windows Certificate Store for Exchange, RDP, SQL Server, ADFS' },
{ value: 'JavaKeystore', label: 'Java Keystore', description: 'Deploy to JKS/PKCS#12 keystores for Tomcat, Jetty, Kafka, Elasticsearch, and JVM services' },
];
const CONFIG_FIELDS: Record<string, { key: string; label: string; placeholder: string; required?: boolean }[]> = {
nginx: [
NGINX: [
{ key: 'cert_path', label: 'Certificate Path', placeholder: '/etc/nginx/ssl/cert.pem', required: true },
{ key: 'key_path', label: 'Key Path', placeholder: '/etc/nginx/ssl/key.pem', required: true },
{ key: 'chain_path', label: 'Chain Path', placeholder: '/etc/nginx/ssl/chain.pem' },
{ key: 'reload_cmd', label: 'Reload Command', placeholder: 'nginx -t && systemctl reload nginx' },
{ key: 'reload_command', label: 'Reload Command', placeholder: 'nginx -s reload' },
{ key: 'validate_command', label: 'Validate Command', placeholder: 'nginx -t' },
],
apache: [
Apache: [
{ key: 'cert_path', label: 'Certificate Path', placeholder: '/etc/apache2/ssl/cert.pem', required: true },
{ key: 'key_path', label: 'Key Path', placeholder: '/etc/apache2/ssl/key.pem', required: true },
{ key: 'chain_path', label: 'Chain Path', placeholder: '/etc/apache2/ssl/chain.pem' },
{ key: 'reload_cmd', label: 'Reload Command', placeholder: 'apachectl configtest && apachectl graceful' },
{ key: 'reload_command', label: 'Reload Command', placeholder: 'apachectl graceful' },
{ key: 'validate_command', label: 'Validate Command', placeholder: 'apachectl configtest' },
],
haproxy: [
HAProxy: [
{ key: 'pem_path', label: 'Combined PEM Path', placeholder: '/etc/haproxy/certs/combined.pem', required: true },
{ key: 'reload_cmd', label: 'Reload Command', placeholder: 'systemctl reload haproxy' },
{ key: 'validate_cmd', label: 'Validate Command (optional)', placeholder: 'haproxy -c -f /etc/haproxy/haproxy.cfg' },
{ key: 'reload_command', label: 'Reload Command', placeholder: 'systemctl reload haproxy' },
{ key: 'validate_command', label: 'Validate Command (optional)', placeholder: 'haproxy -c -f /etc/haproxy/haproxy.cfg' },
],
traefik: [
Traefik: [
{ key: 'cert_dir', label: 'Certificate Directory', placeholder: '/etc/traefik/certs', required: true },
{ key: 'cert_file', label: 'Certificate Filename', placeholder: 'cert.pem (default)' },
{ key: 'key_file', label: 'Key Filename', placeholder: 'key.pem (default)' },
],
caddy: [
Caddy: [
{ key: 'mode', label: 'Deployment Mode', placeholder: 'api (default) or file', required: true },
{ key: 'admin_api', label: 'Admin API URL', placeholder: 'http://localhost:2019 (default)' },
{ key: 'cert_dir', label: 'Certificate Directory (file mode)', placeholder: '/etc/caddy/certs' },
{ key: 'cert_file', label: 'Certificate Filename', placeholder: 'cert.pem (default)' },
{ key: 'key_file', label: 'Key Filename', placeholder: 'key.pem (default)' },
],
envoy: [
Envoy: [
{ key: 'cert_dir', label: 'Certificate Directory', placeholder: '/etc/envoy/certs', required: true },
{ key: 'cert_filename', label: 'Certificate Filename', placeholder: 'cert.pem (default)' },
{ key: 'key_filename', label: 'Key Filename', placeholder: 'key.pem (default)' },
{ key: 'chain_filename', label: 'Chain Filename (optional)', placeholder: 'chain.pem (leave empty to append to cert)' },
{ key: 'sds_config', label: 'Generate SDS Config', placeholder: 'true or false' },
],
postfix: [
Postfix: [
{ key: 'cert_path', label: 'Certificate Path', placeholder: '/etc/postfix/certs/cert.pem' },
{ key: 'key_path', label: 'Key Path', placeholder: '/etc/postfix/certs/key.pem' },
{ key: 'chain_path', label: 'Chain Path (optional)', placeholder: '/etc/postfix/certs/chain.pem' },
{ key: 'reload_command', label: 'Reload Command', placeholder: 'postfix reload' },
{ key: 'validate_command', label: 'Validate Command', placeholder: 'postfix check' },
],
dovecot: [
Dovecot: [
{ key: 'mode', label: 'Mode', placeholder: 'dovecot (auto-set)' },
{ key: 'cert_path', label: 'Certificate Path', placeholder: '/etc/dovecot/certs/cert.pem' },
{ key: 'key_path', label: 'Key Path', placeholder: '/etc/dovecot/certs/key.pem' },
{ key: 'chain_path', label: 'Chain Path (optional)', placeholder: '/etc/dovecot/certs/chain.pem' },
{ key: 'reload_command', label: 'Reload Command', placeholder: 'doveadm reload' },
{ key: 'validate_command', label: 'Validate Command', placeholder: 'doveconf -n' },
],
f5_bigip: [
F5: [
{ key: 'host', label: 'Management Host', placeholder: 'f5.internal.example.com', required: true },
{ key: 'port', label: 'Management Port', placeholder: '443' },
{ key: 'username', label: 'Username', placeholder: 'admin', required: true },
@@ -97,7 +106,8 @@ const CONFIG_FIELDS: Record<string, { key: string; label: string; placeholder: s
{ key: 'insecure', label: 'Skip TLS Verify', placeholder: 'true (default)' },
{ key: 'timeout', label: 'Timeout (seconds)', placeholder: '30' },
],
iis: [
IIS: [
{ key: 'hostname', label: 'Target Hostname', placeholder: 'iis-server.example.com' },
{ key: 'site_name', label: 'IIS Site Name', placeholder: 'Default Web Site', required: true },
{ key: 'cert_store', label: 'Certificate Store', placeholder: 'My', required: true },
{ key: 'port', label: 'HTTPS Port', placeholder: '443' },
@@ -105,12 +115,52 @@ const CONFIG_FIELDS: Record<string, { key: string; label: string; placeholder: s
{ key: 'binding_info', label: 'Host Header (SNI)', placeholder: 'www.example.com' },
{ key: 'sni', label: 'Enable SNI', placeholder: 'true or false' },
{ key: 'mode', label: 'Deployment Mode', placeholder: 'local (default) or winrm' },
{ key: 'winrm.winrm_host', label: 'WinRM Host (remote mode)', placeholder: 'iis-server.example.com' },
{ key: 'winrm.winrm_port', label: 'WinRM Port', placeholder: '5985 (HTTP) or 5986 (HTTPS)' },
{ key: 'winrm.winrm_username', label: 'WinRM Username', placeholder: 'Administrator' },
{ key: 'winrm.winrm_password', label: 'WinRM Password', placeholder: '(sensitive)' },
{ key: 'winrm.winrm_https', label: 'WinRM Use HTTPS', placeholder: 'true or false' },
{ key: 'winrm.winrm_insecure', label: 'WinRM Skip TLS Verify', placeholder: 'false' },
{ key: 'winrm_host', label: 'WinRM Host (remote mode)', placeholder: 'iis-server.example.com' },
{ key: 'winrm_port', label: 'WinRM Port', placeholder: '5985 (HTTP) or 5986 (HTTPS)' },
{ key: 'winrm_username', label: 'WinRM Username', placeholder: 'Administrator' },
{ key: 'winrm_password', label: 'WinRM Password', placeholder: '(sensitive)' },
{ key: 'winrm_https', label: 'WinRM Use HTTPS', placeholder: 'true or false' },
{ key: 'winrm_insecure', label: 'WinRM Skip TLS Verify', placeholder: 'false' },
{ key: 'winrm_timeout', label: 'WinRM Timeout (seconds)', placeholder: '60' },
],
SSH: [
{ key: 'host', label: 'SSH Host', placeholder: '192.168.1.100 or server.example.com', required: true },
{ key: 'port', label: 'SSH Port', placeholder: '22 (default)' },
{ key: 'user', label: 'SSH Username', placeholder: 'root or certctl', required: true },
{ key: 'auth_method', label: 'Auth Method', placeholder: 'key (default) or password' },
{ key: 'private_key_path', label: 'Private Key Path', placeholder: '/home/certctl/.ssh/id_ed25519' },
{ key: 'private_key', label: 'Inline Private Key PEM', placeholder: 'Paste PEM key (alternative to path)' },
{ key: 'password', label: 'SSH Password', placeholder: 'Leave empty for key auth' },
{ key: 'passphrase', label: 'Key Passphrase', placeholder: 'For encrypted private keys' },
{ key: 'cert_path', label: 'Remote Certificate Path', placeholder: '/etc/ssl/certs/cert.pem', required: true },
{ key: 'key_path', label: 'Remote Key Path', placeholder: '/etc/ssl/private/key.pem', required: true },
{ key: 'chain_path', label: 'Remote Chain Path (optional)', placeholder: '/etc/ssl/certs/chain.pem' },
{ key: 'cert_mode', label: 'Cert File Permissions', placeholder: '0644 (default)' },
{ key: 'key_mode', label: 'Key File Permissions', placeholder: '0600 (default)' },
{ key: 'reload_command', label: 'Reload Command (optional)', placeholder: 'systemctl reload nginx' },
{ key: 'timeout', label: 'Connection Timeout (seconds)', placeholder: '30 (default)' },
],
WinCertStore: [
{ key: 'store_name', label: 'Certificate Store', placeholder: 'My (default)', required: true },
{ key: 'store_location', label: 'Store Location', placeholder: 'LocalMachine (default) or CurrentUser' },
{ key: 'friendly_name', label: 'Friendly Name (optional)', placeholder: 'My Production Cert' },
{ key: 'remove_expired', label: 'Remove Expired Certs', placeholder: 'false (default)' },
{ key: 'mode', label: 'Deployment Mode', placeholder: 'local (default) or winrm' },
{ key: 'winrm_host', label: 'WinRM Host (remote mode)', placeholder: 'win-server.example.com' },
{ key: 'winrm_port', label: 'WinRM Port', placeholder: '5985 (HTTP) or 5986 (HTTPS)' },
{ key: 'winrm_username', label: 'WinRM Username', placeholder: 'Administrator' },
{ key: 'winrm_password', label: 'WinRM Password', placeholder: '(sensitive)' },
{ key: 'winrm_https', label: 'WinRM Use HTTPS', placeholder: 'true or false' },
{ key: 'winrm_insecure', label: 'WinRM Skip TLS Verify', placeholder: 'false' },
],
JavaKeystore: [
{ key: 'keystore_path', label: 'Keystore Path', placeholder: '/opt/app/conf/keystore.p12', required: true },
{ key: 'keystore_password', label: 'Keystore Password', placeholder: 'changeit', required: true },
{ key: 'keystore_type', label: 'Keystore Type', placeholder: 'PKCS12 (default) or JKS' },
{ key: 'alias', label: 'Key Alias', placeholder: 'server (default)' },
{ key: 'create_keystore', label: 'Create Keystore If Missing', placeholder: 'true (default)' },
{ key: 'reload_command', label: 'Reload Command (optional)', placeholder: 'systemctl restart tomcat' },
{ key: 'keytool_path', label: 'Keytool Path (optional)', placeholder: 'keytool (default, from PATH)' },
],
};
@@ -122,12 +172,64 @@ function CreateTargetWizard({ onClose, onSuccess }: { onClose: () => void; onSuc
const [config, setConfig] = useState<Record<string, string>>({});
const [error, setError] = useState('');
// Fields that backends expect as boolean (Go bool)
const BOOL_FIELDS = new Set([
'sni', 'insecure', 'sds_config', 'remove_expired', 'create_keystore',
'winrm_https', 'winrm_insecure',
]);
// Fields that backends expect as integer (Go int)
const INT_FIELDS = new Set([
'port', 'timeout', 'winrm_port', 'winrm_timeout', 'timeout_seconds',
]);
// Coerce string form values to their Go types
const coerceValue = (key: string, val: string): unknown => {
if (BOOL_FIELDS.has(key)) return val === 'true';
if (INT_FIELDS.has(key)) { const n = parseInt(val, 10); return isNaN(n) ? val : n; }
return val;
};
// Build config payload with type-specific transformations
const buildConfigPayload = () => {
const flat = Object.fromEntries(Object.entries(config).filter(([, v]) => v));
// Dovecot uses the same Postfix connector with mode="dovecot"
if (targetType === 'Dovecot' && !flat['mode']) {
flat['mode'] = 'dovecot';
}
// IIS backend expects WinRM fields nested under "winrm" key
if (targetType === 'IIS') {
const iisWinrmKeys = ['winrm_host', 'winrm_port', 'winrm_username', 'winrm_password', 'winrm_https', 'winrm_insecure', 'winrm_timeout'];
const winrmObj: Record<string, unknown> = {};
const result: Record<string, unknown> = {};
for (const [k, v] of Object.entries(flat)) {
if (iisWinrmKeys.includes(k)) {
winrmObj[k] = coerceValue(k, v);
} else {
result[k] = coerceValue(k, v);
}
}
if (Object.keys(winrmObj).length > 0) {
result['winrm'] = winrmObj;
}
return result;
}
// All other target types: coerce values to proper Go types
const result: Record<string, unknown> = {};
for (const [k, v] of Object.entries(flat)) {
result[k] = coerceValue(k, v);
}
return result;
};
const mutation = useMutation({
mutationFn: () => createTarget({
name,
type: targetType,
agent_id: agentId,
config: Object.fromEntries(Object.entries(config).filter(([, v]) => v)),
config: buildConfigPayload(),
}),
onSuccess: () => onSuccess(),
onError: (err: Error) => setError(err.message),