Files
Jacky 69cfa82b1d feat: self-signed certificate support (#1655) (#1688)
* feat(cert): add self-signed certificate type and config to model

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): generate self-signed leaf certificates

Add GenerateSelfSigned / SelfSignedOptions plus five new error codes
(50032-50036) and a full TDD test suite covering valid cert output,
multiple key types, empty-SAN rejection, and invalid-IP rejection.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): regenerate self-signed certificates with key reuse

Add RegenerateSelfSigned, SelfSignedOptionsFromModel, deriveSelfSignedCommonName,
loadSelfSignedKey, and parsePrivateKeyPEM to support re-issuing self-signed
certificates for the auto-renewal job, reusing the on-disk private key when possible.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): add self-signed certificate renewal worker

Add auto-renewal worker for self-signed certificates that mirrors the
ACME renewal logic, using a dedicated shouldRenewSelfSignedCert threshold
function verified with TDD.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cron): schedule self-signed certificate renewal

Register setupSelfSignedCertRenewalJob as a periodic cron job (every
30 minutes) in InitCronJobs, mirroring the existing setupAutoCertJob
pattern.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(api): add self-signed certificate generation endpoints

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): add self-signed certificate frontend API

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): add shared self-signed certificate fields component

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): add self-signed certificate generation modal and list entry

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): support self-signed certificates in the editor

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(site): generate self-signed certificates from the site editor

Extract hasTLSListen/ensureDirective/ensureTLSDirectives into a shared
useTLSDirectives composable, refactor ObtainCert.vue to use it, and add
SelfSignedCert.vue to the site cert tab so users can generate and apply
a self-signed certificate directly from the site editor.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(cert): validate self-signed key type and name IP-only renewals

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(cert): apply code-review cleanup

- reuse certcrypto.ParsePEMPrivateKey instead of a hand-rolled PEM
  private-key parser
- stop exporting the unused ensureDirective from useTLSDirectives
- use the AutoCertState enum instead of integer literals in certColumns
- allocate the renewal Logger only when renewal is attempted, avoiding a
  per-tick goroutine and empty-log database write for non-due certificates

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(cert): address PR #1688 review feedback

- clean up the partial certificate directory when the initial write
  fails, not just the database row
- log a warning when the existing self-signed private key cannot be
  reused so operators notice the public-key fingerprint has changed
- defensively copy the model's Domains and IPAddresses slices in
  SelfSignedOptionsFromModel
- require an explicit "Save now" confirmation after generating from the
  site editor, and write the directives into the editor first so the
  user can review the diff before saving

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(cert): harden self-signed certificate lifecycle

Reuse private keys on manual self-signed edits, make certificate writes safer, clean managed self-signed files on delete, and guard renewal against missing config.

* fix(cert): harden self-signed frontend handling

Avoid undefined certificate redirects, rely on payload defaults for self-signed fields, and parse TLS listen directives precisely.

* fix(site): satisfy strict listen regex lint

Escape the IPv6 listen closing bracket explicitly so the strict regexp lint rule accepts TLS listen parsing.

* fix(cert): harden self-signed key handling

Co-authored-by: Jacky <me@jackyu.cn>

* docs(cert): design merging self-signed entry into issue dialog

Spec for collapsing the Certificate list header from three actions to
two by adding a Self-signed option inside the existing Issue Certificate
dialog.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(cert): plan merging self-signed into issue dialog

Step-by-step plan that turns the spec into two scoped commits:
extend DNSIssueCertificate with a self-signed type, then drop the
standalone header button from the certificate list view.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): add self-signed option in issue certificate dialog

Extend the Issue Certificate dialog's Certificate Type select with a
"Self-signed" option that swaps the form body to SelfSignedCertFields
and routes submission through cert.generate_self_signed(). ACME paths
(Wildcard / Custom Domains) are unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(cert): drop standalone self-signed button from list header

Certificate creation is now consolidated under the Issue Certificate
dialog (which exposes Self-signed as a Certificate Type option), so
the duplicate header entry, its ref, handler, and modal mount are
removed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(cert): design self-signed UX enhancements

Adds a reusable StringListInput, renewal-policy hint in the self-signed
form, and a required Name field (frontend + backend). Builds on the
prior merge spec.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(cert): plan self-signed UX enhancements

Six-task plan: extract StringListInput, require Name backend + test,
refactor SelfSignedCertFields with renewal hint, hide duplicate alert
in editor, seed/filter payloads with Name validation, and adopt
StringListInput in the ACME Custom Domains branch.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(ui): add StringListInput component

Reusable multi-row text input with Add/Remove buttons. Used in the
upcoming refactor of Custom Domains and self-signed Domains / IP
Addresses editors so all three share a single editor pattern.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(ui): simplify StringListInput model write and add a11y label

Replace the captured-index update closure with v-model:value on
items[index] so input events are guaranteed to write to the array
slot currently bound to the DOM input. Add an aria-label suffix
on the Remove button so screen readers can distinguish rows.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): require Name when generating self-signed certificates

Adds binding:"required" to SelfSignedCertRequest.Name so an empty name
is rejected at the request boundary, and covers the contract with a
new API-level test.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): unify self-signed editor and surface renewal hint

Switch Domains and IP Addresses to the shared StringListInput so all
self-signed field editors match the Custom Domains pattern. Add an
auto-renewal hint (suppressible via hideRenewalNote) and mark Name as
required to match the new backend contract.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(cert): suppress duplicate renewal alert in cert editor

SelfSignedCertManagement already has its own renewal-status alert;
pass hide-renewal-note to SelfSignedCertFields to avoid showing two
adjacent alerts saying the same thing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(cert): seed and filter self-signed payloads, validate Name

StringListInput preserves empty placeholder rows for editing; seed
arrays with [''] in toSelfSignedPayload / emptySelfSignedPayload /
emptyForm so the editor always renders an empty row to type into.

Each submit/save path trims and filters the arrays before sending and
now rejects an empty Name client-side to match the new server contract.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(cert): make SelfSignedCertPayload.name required

Every factory already seeds name as ''; the optional marker forced
defensive (name ?? '').trim() at three call sites. Align the type
with reality.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(cert): use StringListInput for Custom Domains

Drop the inline multi-row template + add/remove helpers in favour of
the shared StringListInput component, matching the editor used by the
self-signed branch.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(ui): regenerate components.d.ts for StringListInput

Auto-generated by unplugin-vue-components after the new component
was added under app/src/components/StringListInput/.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(cert): render key_type for both legacy and canonical forms

The backend's helper.GetKeyType normalizes key_type to its canonical
form (EC256, RSA2048…) on every write — self-signed generation as well
as the ModifyCert BeforeExecuteHook. The frontend PrivateKeyTypeMask
was keyed only by the legacy form (P256, 2048…), so maskRender returned
"/" for every cert that took a write path through normalization.

Two reported symptoms with the same root cause:
- New self-signed cert always shows "/" in the Key Type column
- Editing any ACME cert (issue #1697) flips its column to "/" after save

Add formatPrivateKeyType / normalizePrivateKeyType helpers that map both
forms to the frontend's legacy key. Use them in the list column renderer
and when loading certs into the self-signed and ACME editor forms so the
ASelect highlights the correct option.

Fixes #1697.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* style(cert): cap self-signed fields width at 600px

The fields stretched full-width inside the certificate editor page; cap
the form at 600px to match AutoCertManagement and keep the editing area
readable. Modal consumers were already bounded by their own width, so
the change is invisible there.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore: update translations

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Hintay <hintay@me.com>
2026-05-24 09:22:21 +08:00

209 lines
6.1 KiB
Go

package cert
import (
"crypto/x509"
"encoding/pem"
"net"
"os"
"path/filepath"
"testing"
"github.com/0xJacky/Nginx-UI/model"
"github.com/go-acme/lego/v5/certcrypto"
)
func parseTestCert(t *testing.T, certPEM []byte) *x509.Certificate {
t.Helper()
block, _ := pem.Decode(certPEM)
if block == nil {
t.Fatalf("failed to decode certificate PEM")
}
parsed, err := x509.ParseCertificate(block.Bytes)
if err != nil {
t.Fatalf("failed to parse certificate: %v", err)
}
return parsed
}
func TestGenerateSelfSignedProducesValidCertificate(t *testing.T) {
certPEM, keyPEM, err := GenerateSelfSigned(SelfSignedOptions{
CommonName: "example.com",
DNSNames: []string{"example.com", "www.example.com"},
IPAddresses: []string{"192.168.1.10"},
KeyType: certcrypto.EC256,
ValidityDays: 30,
})
if err != nil {
t.Fatalf("GenerateSelfSigned returned error: %v", err)
}
parsed := parseTestCert(t, certPEM)
if parsed.Issuer.CommonName != parsed.Subject.CommonName {
t.Fatalf("expected self-signed cert, issuer %q != subject %q",
parsed.Issuer.CommonName, parsed.Subject.CommonName)
}
if parsed.Subject.CommonName != "example.com" {
t.Fatalf("unexpected common name: %s", parsed.Subject.CommonName)
}
if len(parsed.DNSNames) != 2 || parsed.DNSNames[0] != "example.com" {
t.Fatalf("unexpected DNS names: %v", parsed.DNSNames)
}
if len(parsed.IPAddresses) != 1 || !parsed.IPAddresses[0].Equal(net.ParseIP("192.168.1.10")) {
t.Fatalf("unexpected IP addresses: %v", parsed.IPAddresses)
}
gotDays := int(parsed.NotAfter.Sub(parsed.NotBefore).Hours() / 24)
if gotDays < 29 || gotDays > 31 {
t.Fatalf("unexpected validity window: %d days", gotDays)
}
if parsed.IsCA {
t.Fatalf("leaf certificate must not be a CA")
}
if err := parsed.CheckSignature(parsed.SignatureAlgorithm,
parsed.RawTBSCertificate, parsed.Signature); err != nil {
t.Fatalf("self-signature verification failed: %v", err)
}
if !IsPrivateKey(string(keyPEM)) {
t.Fatalf("generated key is not a valid private key")
}
}
func TestGenerateSelfSignedSupportsKeyTypes(t *testing.T) {
// RSA8192 and RSA3072 are omitted: key generation is too slow under -race.
keyTypes := []certcrypto.KeyType{
certcrypto.RSA2048, certcrypto.RSA4096, certcrypto.EC256, certcrypto.EC384,
}
for _, kt := range keyTypes {
t.Run(string(kt), func(t *testing.T) {
certPEM, _, err := GenerateSelfSigned(SelfSignedOptions{
CommonName: "test.local",
DNSNames: []string{"test.local"},
KeyType: kt,
ValidityDays: 365,
})
if err != nil {
t.Fatalf("GenerateSelfSigned(%s) error: %v", kt, err)
}
parseTestCert(t, certPEM)
})
}
}
func TestGenerateSelfSignedRejectsEmptySAN(t *testing.T) {
_, _, err := GenerateSelfSigned(SelfSignedOptions{
CommonName: "example.com",
KeyType: certcrypto.EC256,
ValidityDays: 365,
})
if err == nil {
t.Fatalf("expected an error when no DNS names or IP addresses are given")
}
}
func TestGenerateSelfSignedRejectsInvalidIP(t *testing.T) {
_, _, err := GenerateSelfSigned(SelfSignedOptions{
CommonName: "example.com",
IPAddresses: []string{"not-an-ip"},
KeyType: certcrypto.EC256,
ValidityDays: 365,
})
if err == nil {
t.Fatalf("expected an error for an invalid IP address")
}
}
func TestRegenerateSelfSignedReusesKey(t *testing.T) {
_, keyPEM, err := GenerateSelfSigned(SelfSignedOptions{
CommonName: "reuse.local",
DNSNames: []string{"reuse.local"},
KeyType: certcrypto.EC256,
ValidityDays: 365,
})
if err != nil {
t.Fatalf("GenerateSelfSigned error: %v", err)
}
keyPath := filepath.Join(t.TempDir(), "private.key")
if err := os.WriteFile(keyPath, keyPEM, 0600); err != nil {
t.Fatalf("write key: %v", err)
}
certModel := &model.Cert{
Domains: []string{"reuse.local"},
KeyType: certcrypto.EC256,
SSLCertificateKeyPath: keyPath,
SelfSignedConfig: &model.SelfSignedCertConfig{ValidityDays: 365},
}
newCertPEM, newKeyPEM, err := RegenerateSelfSigned(certModel)
if err != nil {
t.Fatalf("RegenerateSelfSigned error: %v", err)
}
if string(newKeyPEM) != string(keyPEM) {
t.Fatalf("expected the private key to be reused unchanged")
}
parseTestCert(t, newCertPEM)
}
func TestRegenerateSelfSignedWithOptionsReusesKey(t *testing.T) {
_, keyPEM, err := GenerateSelfSigned(SelfSignedOptions{
CommonName: "old.local",
DNSNames: []string{"old.local"},
KeyType: certcrypto.EC256,
ValidityDays: 365,
})
if err != nil {
t.Fatalf("GenerateSelfSigned error: %v", err)
}
keyPath := filepath.Join(t.TempDir(), "private.key")
if err := os.WriteFile(keyPath, keyPEM, 0600); err != nil {
t.Fatalf("write key: %v", err)
}
certModel := &model.Cert{SSLCertificateKeyPath: keyPath}
newCertPEM, newKeyPEM, err := RegenerateSelfSignedWithOptions(certModel, SelfSignedOptions{
CommonName: "new.local",
DNSNames: []string{"new.local"},
KeyType: certcrypto.EC256,
ValidityDays: 90,
})
if err != nil {
t.Fatalf("RegenerateSelfSignedWithOptions error: %v", err)
}
if string(newKeyPEM) != string(keyPEM) {
t.Fatalf("expected the private key to be reused unchanged")
}
parsed := parseTestCert(t, newCertPEM)
if parsed.Subject.CommonName != "new.local" {
t.Fatalf("CommonName = %q, want %q", parsed.Subject.CommonName, "new.local")
}
}
func TestRegenerateSelfSignedFallsBackToFreshKey(t *testing.T) {
certModel := &model.Cert{
Domains: []string{"fresh.local"},
KeyType: certcrypto.EC256,
SSLCertificateKeyPath: filepath.Join(t.TempDir(), "missing.key"),
SelfSignedConfig: &model.SelfSignedCertConfig{ValidityDays: 365},
}
certPEM, keyPEM, err := RegenerateSelfSigned(certModel)
if err != nil {
t.Fatalf("RegenerateSelfSigned error: %v", err)
}
parseTestCert(t, certPEM)
if !IsPrivateKey(string(keyPEM)) {
t.Fatalf("fallback key is not a valid private key")
}
}
func TestDeriveSelfSignedCommonName(t *testing.T) {
if got := deriveSelfSignedCommonName([]string{"a.com", "b.com"}, nil); got != "a.com" {
t.Fatalf("expected first DNS name, got %q", got)
}
if got := deriveSelfSignedCommonName(nil, []string{"10.0.0.1"}); got != "10.0.0.1" {
t.Fatalf("expected first IP, got %q", got)
}
}