mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 15:32:02 +00:00
52248be717
Breaking change release. Plaintext HTTP listener removed. The certctl control plane now terminates TLS 1.3 on :8443 via http.Server.ListenAndServeTLS. No CERTCTL_TLS_ENABLED=false escape hatch. No dual-listener mode. One-step cutover per docs/upgrade-to-tls.md. Server - cmd/server/tls.go: certHolder with SIGHUP hot-reload + atomic cert swap, buildServerTLSConfig (TLS 1.3 min, GetCertificate callback), preflightServerTLS validation - cmd/server/main.go: ListenAndServeTLS in place of ListenAndServe, watchSIGHUP wiring, cert/key path config threading - tls_test.go: 418-line regression coverage of reload, preflight, callback behavior, SAN validation Config - CERTCTL_TLS_CERT_PATH / CERTCTL_TLS_KEY_PATH (required) - Plaintext rejection: agents/CLI/MCP pre-flight-fail on http:// URLs with a pointer to docs/upgrade-to-tls.md Agents, CLI, MCP - All three pre-flight-reject http:// URLs with fail-loud diagnostic - CERTCTL_SERVER_CA_BUNDLE_PATH for private-CA trust - CERTCTL_SERVER_TLS_INSECURE_SKIP_VERIFY for dev-only bypass (loud warning on startup) - install-agent.sh emits both vars as commented template lines docker-compose - certctl-tls-init sidecar generates SAN-valid self-signed cert into deploy/test/certs/ on first boot - All demo-stack curls pin against ca.crt with --cacert Helm chart - Three TLS provisioning modes, exactly one required: - server.tls.existingSecret (operator-supplied) - server.tls.certManager.enabled (cert-manager integration) - server.tls.selfSigned.enabled (eval only — not for production) - server-certificate.yaml template for cert-manager mode - helm install without a TLS source fails at template render with a pointer to docs/tls.md CI - .github/workflows/ci.yml Helm Chart Validation step renders the chart in both existingSecret and cert-manager modes, plus an inverse guard-regression test that asserts helm template MUST refuse to render when no TLS source is configured. Previously the single `helm template` invocation hit the certctl.tls.required fail-loud guard and exit-1'd CI. Four invocations now: lint (existingSecret), template (existingSecret), template (cert-manager), template (no args — must fail). Integration tests - deploy/test/integration_test.go stands up the Compose stack over HTTPS, extracts the CA bundle, and exercises every certctl API over https://localhost:8443 - All 34 integration subtests green (per Phase 8 local CI-parity) Documentation - New: docs/tls.md (provisioning patterns, rotation, SIGHUP reload) - New: docs/upgrade-to-tls.md (one-step cutover, no-downgrade warnings, fleet-roll sequencing) - CHANGELOG.md: v2.2.0 "HTTPS Everywhere — The Irony" entry (file heading unchanged; release tag is v2.0.47) - All curls in docs/, examples/, deploy/helm/ guides use https://localhost:8443 --cacert Verification - grep -rn "ListenAndServe[^T]" cmd/ internal/ → 0 hits - grep -rn "\"http://" cmd/ internal/ → 2 benign hits (Caddy admin API default, SSRF doc comment) — zero certctl endpoints - Tasks #197–#206 (Phases 0–8) all closed in the tracker Files: 65 changed, 3489 insertions, 372 deletions (pre-CI-fix).
183 lines
5.5 KiB
YAML
183 lines
5.5 KiB
YAML
version: '3.8'
|
|
|
|
services:
|
|
# PostgreSQL database for certctl
|
|
postgres:
|
|
image: postgres:16-alpine
|
|
container_name: certctl-postgres-private-ca
|
|
environment:
|
|
POSTGRES_DB: certctl
|
|
POSTGRES_USER: certctl
|
|
POSTGRES_PASSWORD: ${DB_PASSWORD:-certctl-dev-password}
|
|
volumes:
|
|
- postgres_data:/var/lib/postgresql/data
|
|
healthcheck:
|
|
test: ['CMD-SHELL', 'pg_isready -U certctl -d certctl']
|
|
interval: 5s
|
|
timeout: 5s
|
|
retries: 5
|
|
networks:
|
|
- certctl-network
|
|
restart: unless-stopped
|
|
|
|
# certctl server (control plane) with Local CA in sub-CA mode
|
|
certctl-server:
|
|
image: ghcr.io/shankar0123/certctl-server:latest
|
|
container_name: certctl-server-private-ca
|
|
environment:
|
|
# Database
|
|
CERTCTL_DATABASE_URL: postgres://certctl:${DB_PASSWORD:-certctl-dev-password}@postgres:5432/certctl?sslmode=disable
|
|
|
|
# Server settings
|
|
CERTCTL_SERVER_PORT: 8443
|
|
CERTCTL_SERVER_HOST: 0.0.0.0
|
|
|
|
# Auth (disabled for demo; production should use API keys)
|
|
CERTCTL_AUTH_TYPE: none
|
|
|
|
# CORS (allow agent and Traefik communication)
|
|
CERTCTL_CORS_ORIGINS: '*'
|
|
|
|
# Key generation mode (agent-side in production, server-side for demo)
|
|
CERTCTL_KEYGEN_MODE: server
|
|
|
|
# Local CA configuration
|
|
# For self-signed CA (default, no paths set):
|
|
# - CA generates a self-signed root certificate
|
|
# - All issued certificates chain to this root
|
|
#
|
|
# For sub-CA mode (provide both paths):
|
|
# - Load pre-signed CA certificate and key from these paths
|
|
# - All issued certificates chain to your enterprise root CA
|
|
# - Requires: CA cert must have IsCA=true and KeyUsageCertSign
|
|
# - Supports: RSA, ECDSA, PKCS#8 key formats
|
|
#
|
|
# To use sub-CA mode:
|
|
# 1. Place your enterprise CA cert at ./ca-cert.pem
|
|
# 2. Place your enterprise CA key at ./ca-key.pem
|
|
# 3. Uncomment the two lines below
|
|
# 4. Restart the service
|
|
#
|
|
# CERTCTL_CA_CERT_PATH: /etc/certctl/ca-cert.pem
|
|
# CERTCTL_CA_KEY_PATH: /etc/certctl/ca-key.pem
|
|
|
|
# Logging
|
|
CERTCTL_LOG_LEVEL: info
|
|
ports:
|
|
- '${SERVER_PORT:-8443}:8443'
|
|
volumes:
|
|
# Mount directory for CA cert/key (for sub-CA mode)
|
|
# Copy your enterprise CA cert+key here:
|
|
# cp /path/to/your/ca.pem ./ca-cert.pem
|
|
# cp /path/to/your/ca-key.pem ./ca-key.pem
|
|
- ./ca-certs:/etc/certctl:ro
|
|
depends_on:
|
|
postgres:
|
|
condition: service_healthy
|
|
networks:
|
|
- certctl-network
|
|
healthcheck:
|
|
test: ['CMD-SHELL', 'curl -sfk https://localhost:8443/health || exit 1']
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 3
|
|
restart: unless-stopped
|
|
|
|
# certctl agent (deploys certs to Traefik)
|
|
certctl-agent:
|
|
image: ghcr.io/shankar0123/certctl-agent:latest
|
|
container_name: certctl-agent-private-ca
|
|
environment:
|
|
# Control plane connection
|
|
CERTCTL_SERVER_URL: http://certctl-server:8443
|
|
CERTCTL_API_KEY: ${AGENT_API_KEY:-agent-demo-key}
|
|
|
|
# Key generation (agent-side keys, never sent to server)
|
|
CERTCTL_KEYGEN_MODE: server
|
|
CERTCTL_KEY_DIR: /var/lib/certctl/keys
|
|
|
|
# Discovery (scan for existing certs in Traefik's directory)
|
|
CERTCTL_DISCOVERY_DIRS: /etc/traefik/certs
|
|
|
|
# Heartbeat interval
|
|
CERTCTL_HEARTBEAT_INTERVAL: 30s
|
|
|
|
# Agent metadata (self-reported)
|
|
CERTCTL_AGENT_NAME: traefik-agent-01
|
|
|
|
# Logging
|
|
CERTCTL_LOG_LEVEL: info
|
|
volumes:
|
|
# Mount Traefik cert directory for deployment
|
|
- traefik_certs:/etc/traefik/certs
|
|
# Agent key storage (persisted across restarts)
|
|
- agent_keys:/var/lib/certctl/keys
|
|
depends_on:
|
|
certctl-server:
|
|
condition: service_healthy
|
|
networks:
|
|
- certctl-network
|
|
restart: unless-stopped
|
|
|
|
# Traefik reverse proxy / edge router
|
|
# Certificates deployed by certctl-agent are automatically loaded from the certs directory
|
|
traefik:
|
|
image: traefik:v3.0
|
|
container_name: certctl-traefik-private-ca
|
|
command:
|
|
# Enable dashboard and API
|
|
- '--api.insecure=true'
|
|
- '--api.dashboard=true'
|
|
|
|
# File provider: watch the certs directory for dynamic config updates
|
|
- '--providers.file.directory=/etc/traefik/dynamic'
|
|
- '--providers.file.watch=true'
|
|
|
|
# Entry points (HTTP and HTTPS)
|
|
- '--entrypoints.web.address=:80'
|
|
- '--entrypoints.websecure.address=:443'
|
|
- '--entrypoints.websecure.http.tls=true'
|
|
|
|
# Global TLS settings
|
|
- '--entryPoints.websecure.http.tls.certResolver=internal'
|
|
|
|
# Logging
|
|
- '--log.level=info'
|
|
- '--accesslog=true'
|
|
ports:
|
|
# HTTP
|
|
- '80:80'
|
|
# HTTPS
|
|
- '443:443'
|
|
# Dashboard (http://localhost:8080)
|
|
- '8080:8080'
|
|
volumes:
|
|
# Mount Traefik config directory
|
|
- ./traefik-config:/etc/traefik/dynamic:ro
|
|
# Mount cert directory (where certctl deploys certs)
|
|
- traefik_certs:/etc/traefik/certs:ro
|
|
# Allow Traefik to read Docker socket (optional, for container labeling)
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
networks:
|
|
- certctl-network
|
|
depends_on:
|
|
- certctl-agent
|
|
healthcheck:
|
|
test: ['CMD-SHELL', 'curl -sf http://localhost:8080/ping || exit 1']
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 3
|
|
restart: unless-stopped
|
|
|
|
networks:
|
|
certctl-network:
|
|
driver: bridge
|
|
|
|
volumes:
|
|
postgres_data:
|
|
driver: local
|
|
traefik_certs:
|
|
driver: local
|
|
agent_keys:
|
|
driver: local
|