Repository navigation
Labels
enhancementNew feature or requestNew feature or requestinfrastructureIssues related to tooling or deploymentIssues related to tooling or deployment
Description
Parent PRD
What to build
Replace setup-ssl.sh with a TypeScript implementation that uses the selfsigned npm package (18M weekly downloads, MIT, WebCrypto-based) to generate self-signed SSL certificates. This eliminates the dependency on the system openssl package entirely, since Node.js bundles its own OpenSSL internally.
When HOST is set, generate:
- Root CA: self-signed RSA 2048, SHA-256, 356-day validity, subject
/CN=Graph Explorer/C=US/L=Seattle - Server key + cert: RSA 2048, signed by root CA, 365-day validity, SHA-256, with SAN
DNS.1 = $HOST:*and key usage extensions
SANs, key usage, and basic constraints are passed programmatically to selfsigned.generate(), eliminating the need for csr.conf and cert.conf template files.
When HOST is not set, validate that existing cert files exist at CERT_DIR and reuse them. Error clearly if certs are missing.
File changes
| Action | File | Notes |
|---|---|---|
| New | proxy-server/src/setup-ssl.ts |
Exports setupSsl(certDir, host?) function |
| New | proxy-server/src/setup-ssl-cli.ts |
CLI entry point reading CERT_DIR/HOST from env |
| Modify | proxy-server/package.json |
Add selfsigned dependency |
| Modify | docker-entrypoint.sh |
Call node dist/setup-ssl-cli.js instead of ./setup-ssl.sh |
| Modify | Dockerfile |
Remove openssl from yum install |
| Modify | proxy-server/src/server.test.ts |
Replace openssl CLI in createTempCerts() with selfsigned |
| Modify | docker-entrypoint.test.ts |
Update setup-ssl stub |
| Delete | setup-ssl.sh |
Replaced by TypeScript |
| Delete | cert-info/cert.conf, cert-info/csr.conf |
OpenSSL-specific, no longer needed |
Backward compatibility
- User-mounted certs: Still work. Validation checks for
rootCA.key,rootCA.crt,server.key,server.crt. Dropserver.csrfrom required list (never used by the server). - Environment variables:
HOST,CERT_DIR,PROXY_SERVER_HTTPS_CONNECTIONunchanged. - Output files: Same paths, same PEM format.
server.csrno longer generated (intermediate artifact the server never reads).
Risks to consider
- New dependency:
selfsignedpulls in@peculiar/x509andpkijs. All WebCrypto-based, no native code. Pin exact version. reflect-metadatapolyfill: May be needed by@peculiar/x509. Test whether Node 24 has native support. Only runs at startup, not in the main server process.- Async API:
selfsignedv5 is async-only. Fine for a standalone CLI script.
Suggested PR sequence
- Add
selfsigned+ createsetup-ssl.tswith tests (no behavior change) - Replace
opensslCLI usage inserver.test.ts - Switch
docker-entrypoint.shto Node.js script, deletesetup-ssl.sh - Remove
opensslfrom Dockerfile + clean up config files
Acceptance criteria
- Generates the same cert chain as
setup-ssl.shwhenHOSTis set - Reuses existing certs when
HOSTis not set and certs exist - Errors clearly when
HOSTis not set and certs are missing - Uses
selfsignednpm package — no systemopenssldependency -
csr.confandcert.conftemplate files are deleted -
opensslremoved from Dockerfileyum install - Generated certs work with
https.createServer - Generated server cert has correct SAN entries and is signed by root CA
- Unit tests cover cert generation, cert reuse, and missing cert error paths
- Docker image builds and runs successfully without system
openssl
Blocked by
None — can start immediately
User stories addressed
- User story 5
- User story 6
Related Issues
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestinfrastructureIssues related to tooling or deploymentIssues related to tooling or deployment
Activity
Document that HOST has no default for certificates (#2502)