完善证书申请续期与安装初始化流程

This commit is contained in:
xuans committed 2026-08-27 00:31:40 +08:00
1 parent fd8d8608f5
commit 07636abe44
66 files changed
+9470 -165

No files matched your search

+351 -13
View File
@@ -1,22 +1,30 @@
package cli
import (
"bufio"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"os"
"os/signal"
"path/filepath"
"strconv"
"strings"
"syscall"
"time"
"github.com/spf13/cobra"
"git.pcux.cn/xuans/Scert/backend/internal/app"
"git.pcux.cn/xuans/Scert/backend/internal/buildinfo"
"git.pcux.cn/xuans/Scert/backend/internal/certificate"
"git.pcux.cn/xuans/Scert/backend/internal/config"
"git.pcux.cn/xuans/Scert/backend/internal/domain"
"git.pcux.cn/xuans/Scert/backend/internal/firewall"
"git.pcux.cn/xuans/Scert/backend/internal/setup"
)
const version = buildinfo.Version
@@ -98,7 +106,18 @@ func localizeHelpFlags(command *cobra.Command) {
}
func newInitCommand() *cobra.Command {
return &cobra.Command{Use: "init", Short: "生成初始配置", RunE: func(cmd *cobra.Command, args []string) error {
return newInitCommandWithFirewall(firewall.NewManager())
}
func newInitCommandWithFirewall(firewallManager firewall.Manager) *cobra.Command {
var (
adminUsername, adminPassword, emailProvider, emailEndpoint string
recipients, dnsProvider, dnsCredentialRef, certificateRoot string
webHostname, webPublicIP, httpsMode string
serverPort, resetServicePort int
dnsVerified, webEnabled bool
)
command := &cobra.Command{Use: "init", Short: "交互式初始化配置", RunE: func(cmd *cobra.Command, args []string) error {
path := resolveConfigPath()
if _, err := os.Stat(path); err == nil {
return fmt.Errorf("配置文件已存在:%s", path)
@@ -106,13 +125,195 @@ func newInitCommand() *cobra.Command {
return err
}
cfg := config.Default(baseDir)
if err := cfg.Save(path); err != nil {
input := setup.Input{
AdminUsername: adminUsername, AdminPassword: adminPassword, ServerPort: serverPort,
ResetServicePort: resetServicePort, EmailProvider: emailProvider, EmailEndpoint: emailEndpoint,
EmailRecipients: splitValues(recipients), DNSProvider: dnsProvider, DNSCredentialRef: dnsCredentialRef,
DNSVerified: dnsVerified, CertificateRoot: certificateRoot, WebHostname: webHostname,
WebPublicIP: webPublicIP, WebEnabled: webEnabled, HTTPSMode: httpsMode,
}
if !cmd.Flags().Changed("admin-username") {
if err := readInteractiveInit(cmd.InOrStdin(), cmd.OutOrStdout(), &input, cfg); err != nil {
return err
}
}
if err := setup.Apply(&cfg, input); err != nil {
return err
}
fmt.Printf("初始配置已生成:%s\n", path)
fmt.Println("当前默认使用 ACME Staging 环境,完成 DNS 配置后再切换 Production。")
firewallResult, err := saveSetupWithFirewall(cmd.Context(), cfg, path, firewallManager)
if err != nil {
return err
}
fmt.Fprintf(cmd.OutOrStdout(), "初始化配置已保存:%s\n", path)
fmt.Fprintf(cmd.OutOrStdout(), "DNS API 已标记为验证通过;真实 provider 连通性测试和 Web 证书申请将在后续任务接入。\n")
fmt.Fprintf(cmd.OutOrStdout(), "本机防火墙:%s\n", firewallResult.Message)
fmt.Fprintf(cmd.OutOrStdout(), "请确认云安全组已放行主服务端口 %d;密码重置服务仅监听本机 %s:%d,不创建对外入站规则。\n", cfg.Server.Port, cfg.Admin.ResetServiceHost, cfg.Admin.ResetServicePort)
return nil
}}
command.Flags().StringVar(&adminUsername, "admin-username", "", "超级管理员用户名")
command.Flags().StringVar(&adminPassword, "admin-password", "", "超级管理员密码(仅建议临时使用参数,优先交互输入)")
command.Flags().IntVar(&serverPort, "server-port", 8080, "Scert 主服务端口")
command.Flags().IntVar(&resetServicePort, "reset-service-port", 8091, "Scert-admin 密码重置端口")
command.Flags().StringVar(&emailProvider, "email-provider", "", "第三方邮箱服务标识")
command.Flags().StringVar(&emailEndpoint, "email-endpoint", "", "第三方邮箱 API 地址")
command.Flags().StringVar(&recipients, "recipients", "", "通知收件人,多个地址用逗号分隔")
command.Flags().StringVar(&dnsProvider, "dns-provider", "", "DNS API 服务商标识")
command.Flags().StringVar(&dnsCredentialRef, "dns-credential-ref", "", "DNS 凭据引用,不保存明文密钥")
command.Flags().BoolVar(&dnsVerified, "dns-verified", false, "DNS API 是否已通过外部验证测试")
command.Flags().StringVar(&certificateRoot, "certificate-root", "", "证书部署根目录,默认使用系统目录")
command.Flags().StringVar(&webHostname, "web-hostname", "", "Web 管理页面域名")
command.Flags().StringVar(&webPublicIP, "web-public-ip", "", "没有域名时使用的公网 IP")
command.Flags().BoolVar(&webEnabled, "web-enabled", true, "是否开启 Web 管理页面")
command.Flags().StringVar(&httpsMode, "https-mode", "direct", "HTTPS 模式:direct、proxy")
return command
}
func saveSetupWithFirewall(ctx context.Context, cfg config.Config, path string, firewallManager firewall.Manager) (firewall.Result, error) {
result := firewall.Result{
Backend: firewall.BackendNone, Port: cfg.Server.Port,
Message: "未配置防火墙管理器,已跳过本机规则创建",
}
if firewallManager != nil {
firewallContext, cancel := context.WithTimeout(ctx, 30*time.Second)
var err error
result, err = firewallManager.OpenTCP(firewallContext, cfg.Server.Port)
cancel()
if err != nil {
return firewall.Result{}, fmt.Errorf("自动配置本机防火墙失败,请使用管理员权限重新运行初始化程序:%w", err)
}
}
if err := cfg.Save(path); err != nil {
if result.Created && firewallManager != nil {
rollbackContext, cancel := context.WithTimeout(context.Background(), 30*time.Second)
rollbackErr := firewallManager.Rollback(rollbackContext, result)
cancel()
if rollbackErr != nil {
return firewall.Result{}, fmt.Errorf("保存初始化配置失败,且自动创建的防火墙规则回滚失败,请手动检查本机防火墙:保存错误:%v;回滚错误:%w", err, rollbackErr)
}
}
return firewall.Result{}, err
}
return result, nil
}
func readInteractiveInit(input io.Reader, output io.Writer, value *setup.Input, cfg config.Config) error {
reader := bufio.NewReader(input)
fmt.Fprintln(output, "开始初始化 Scert。带 * 的项目为必填项。")
var err error
value.AdminUsername, err = ask(reader, output, "超级管理员用户名 *", "admin")
if err != nil {
return err
}
value.AdminPassword, err = ask(reader, output, "超级管理员密码 *", "")
if err != nil {
return err
}
port, err := askInt(reader, output, "Scert 主服务端口 *", cfg.Server.Port)
if err != nil {
return err
}
value.ServerPort = port
port, err = askInt(reader, output, "Scert-admin 密码重置端口 *", cfg.Admin.ResetServicePort)
if err != nil {
return err
}
value.ResetServicePort = port
value.EmailProvider, err = ask(reader, output, "第三方邮箱服务标识", "")
if err != nil {
return err
}
value.EmailEndpoint, err = ask(reader, output, "第三方邮箱 API 地址", "")
if err != nil {
return err
}
receiver, err := ask(reader, output, "通知收件人(逗号分隔)", "")
if err != nil {
return err
}
value.EmailRecipients = splitValues(receiver)
value.DNSProvider, err = ask(reader, output, "DNS API 服务商 *", "")
if err != nil {
return err
}
value.DNSCredentialRef, err = ask(reader, output, "DNS 凭据引用 *(不要输入明文密钥)", "")
if err != nil {
return err
}
value.DNSVerified, err = askYesNo(reader, output, "DNS API 是否已经完成验证测试?", false)
if err != nil {
return err
}
value.CertificateRoot, err = ask(reader, output, "证书部署根目录", cfg.Paths.Certificate)
if err != nil {
return err
}
value.WebHostname, err = ask(reader, output, "Web 管理页面域名(无域名可留空)", "")
if err != nil {
return err
}
if value.WebHostname == "" {
value.WebPublicIP, err = ask(reader, output, "Web 管理页面公网 IP", "")
if err != nil {
return err
}
}
value.WebEnabled, err = askYesNo(reader, output, "是否开启 Web 管理页面?", true)
return err
}
func ask(reader *bufio.Reader, output io.Writer, label, defaultValue string) (string, error) {
if defaultValue != "" {
fmt.Fprintf(output, "%s [%s]:", label, defaultValue)
} else {
fmt.Fprintf(output, "%s:", label)
}
line, err := reader.ReadString('\n')
if err != nil && !errors.Is(err, io.EOF) {
return "", err
}
line = strings.TrimSpace(line)
if line == "" {
line = defaultValue
}
return line, nil
}
func askInt(reader *bufio.Reader, output io.Writer, label string, defaultValue int) (int, error) {
value, err := ask(reader, output, label, strconv.Itoa(defaultValue))
if err != nil {
return 0, err
}
parsed, err := strconv.Atoi(value)
if err != nil {
return 0, fmt.Errorf("%s 必须是数字", label)
}
return parsed, nil
}
func askYesNo(reader *bufio.Reader, output io.Writer, label string, defaultValue bool) (bool, error) {
defaultText := "否"
if defaultValue {
defaultText = "是"
}
value, err := ask(reader, output, label+"(是/否)", defaultText)
if err != nil {
return false, err
}
switch strings.ToLower(value) {
case "是", "y", "yes":
return true, nil
case "否", "n", "no":
return false, nil
default:
return false, fmt.Errorf("%s 请输入是或否", label)
}
}
func splitValues(value string) []string {
if strings.TrimSpace(value) == "" {
return nil
}
return strings.Split(value, ",")
}
func newStatusCommand() *cobra.Command {
@@ -126,7 +327,7 @@ func newStatusCommand() *cobra.Command {
}
func commandStatus(cfg config.Config) map[string]any {
return map[string]any{"service": "scert", "version": buildinfo.Version, "config_version": cfg.Version, "setup_ready": cfg.SetupReady, "https_mode": cfg.Server.HTTPSMode, "database_driver": cfg.Database.Driver}
return map[string]any{"service": "scert", "version": buildinfo.Version, "config_version": cfg.Version, "setup_ready": cfg.SetupReady, "https_mode": cfg.Server.HTTPSMode, "database_driver": cfg.Database.Driver, "server_port": cfg.Server.Port, "reset_service_port": cfg.Admin.ResetServicePort, "web_enabled": cfg.Web.Enabled, "web_hostname": cfg.Web.Hostname, "web_public_ip": cfg.Web.PublicIP, "dns_verification_state": cfg.DNS.VerificationState}
}
func newServeCommand() *cobra.Command {
@@ -135,13 +336,23 @@ func newServeCommand() *cobra.Command {
if err != nil {
return err
}
service, err := app.New(cmd.Context(), cfg)
if !cfg.SetupReady {
cfg.Server.Host = "127.0.0.1"
fmt.Fprintln(cmd.OutOrStdout(), "系统尚未初始化,临时服务仅监听本机;请完成初始化后重启服务。")
}
if cfg.SetupReady && !cfg.Web.Enabled {
return fmt.Errorf("Web 管理页面已关闭")
}
service, err := app.NewWithConfigPath(cmd.Context(), cfg, resolveConfigPath())
if err != nil {
return err
}
defer service.Close()
ctx, stop := signal.NotifyContext(cmd.Context(), os.Interrupt, syscall.SIGTERM)
defer stop()
if service.Renewal != nil && cfg.SetupReady {
service.Renewal.Start(ctx)
}
errCh := make(chan error, 1)
go func() { errCh <- service.HTTP.ListenAndServe() }()
select {
@@ -158,7 +369,66 @@ func newServeCommand() *cobra.Command {
func newDomainCommand() *cobra.Command {
command := &cobra.Command{Use: "domain", Short: "管理托管域名"}
command.AddCommand(newDomainListCommand(), newDomainAddCommand())
command.AddCommand(newDomainListCommand(), newDomainAddCommand(), newDomainEditCommand(), newDomainDeleteCommand(), newDomainIssueCommand(), newDomainImportCommand())
return command
}
func newDomainIssueCommand() *cobra.Command {
var id string
command := &cobra.Command{Use: "issue", Short: "申请或续期域名证书", RunE: func(cmd *cobra.Command, args []string) error {
cfg, err := loadConfig()
if err != nil {
return err
}
service, err := app.New(cmd.Context(), cfg)
if err != nil {
return err
}
defer service.Close()
if service.Certificates == nil {
return fmt.Errorf("证书申请服务未初始化")
}
result, err := service.Certificates.Issue(cmd.Context(), id)
if err != nil {
return err
}
return printJSON(cmd, result)
}}
command.Flags().StringVar(&id, "id", "", "域名 ID")
_ = command.MarkFlagRequired("id")
return command
}
func newDomainImportCommand() *cobra.Command {
var id, certificatePath, privateKeyPath, issuerPath string
command := &cobra.Command{Use: "import", Short: "导入自有证书", RunE: func(cmd *cobra.Command, args []string) error {
cfg, err := loadConfig()
if err != nil {
return err
}
service, err := app.New(cmd.Context(), cfg)
if err != nil {
return err
}
defer service.Close()
if service.Certificates == nil {
return fmt.Errorf("证书导入服务未初始化")
}
result, err := service.Certificates.Import(cmd.Context(), certificate.ImportRequest{
DomainID: id, Certificate: certificatePath, PrivateKey: privateKeyPath, IssuerBundle: issuerPath,
})
if err != nil {
return err
}
return printJSON(cmd, result)
}}
command.Flags().StringVar(&id, "id", "", "域名 ID")
command.Flags().StringVar(&certificatePath, "certificate", "", "证书 PEM 文件路径")
command.Flags().StringVar(&privateKeyPath, "private-key", "", "私钥 PEM 文件路径")
command.Flags().StringVar(&issuerPath, "issuer", "", "签发者证书 PEM 文件路径,可选")
_ = command.MarkFlagRequired("id")
_ = command.MarkFlagRequired("certificate")
_ = command.MarkFlagRequired("private-key")
return command
}
@@ -182,8 +452,9 @@ func newDomainListCommand() *cobra.Command {
}
func newDomainAddCommand() *cobra.Command {
var name, certificateType string
var name, certificateType, acmeEnvironment, dnsProvider string
var sans []string
var autoRenew bool
command := &cobra.Command{Use: "add", Short: "添加托管域名", RunE: func(cmd *cobra.Command, args []string) error {
cfg, err := loadConfig()
if err != nil {
@@ -194,7 +465,7 @@ func newDomainAddCommand() *cobra.Command {
return err
}
defer service.Close()
item, err := domain.NewDomain(name, domain.CertificateType(certificateType), sans)
item, err := domain.NewDomainWithOptions(name, domain.CertificateType(certificateType), sans, autoRenew, acmeEnvironment, dnsProvider)
if err != nil {
return err
}
@@ -207,10 +478,80 @@ func newDomainAddCommand() *cobra.Command {
command.Flags().StringVar(&name, "name", "", "域名")
command.Flags().StringVar(&certificateType, "type", string(domain.CertificateSingle), "证书类型:single、wildcard、san")
command.Flags().StringSliceVar(&sans, "sans", nil, "SAN 域名列表")
command.Flags().BoolVar(&autoRenew, "auto-renew", true, "是否启用自动续期")
command.Flags().StringVar(&acmeEnvironment, "acme-environment", domain.ACMEEnvironmentStaging, "ACME 环境:staging、production")
command.Flags().StringVar(&dnsProvider, "dns-provider", "", "DNS 验证服务商标识")
_ = command.MarkFlagRequired("name")
return command
}
func newDomainEditCommand() *cobra.Command {
var id, name, certificateType, acmeEnvironment, dnsProvider string
var sans []string
var autoRenew bool
command := &cobra.Command{Use: "edit", Short: "编辑托管域名", RunE: func(cmd *cobra.Command, args []string) error {
cfg, err := loadConfig()
if err != nil {
return err
}
service, err := app.New(cmd.Context(), cfg)
if err != nil {
return err
}
defer service.Close()
existing, err := service.Repository.GetByID(cmd.Context(), id)
if err != nil {
return err
}
item, err := domain.NewDomainWithOptions(name, domain.CertificateType(certificateType), sans, autoRenew, acmeEnvironment, dnsProvider)
if err != nil {
return err
}
item.ID = existing.ID
item.CreatedAt = existing.CreatedAt
item.Status = "pending"
item.ExpiresAt = nil
if err := service.Repository.Update(cmd.Context(), item); err != nil {
return err
}
fmt.Printf("域名已更新:%s\n", item.Name)
return nil
}}
command.Flags().StringVar(&id, "id", "", "域名 ID")
command.Flags().StringVar(&name, "name", "", "域名")
command.Flags().StringVar(&certificateType, "type", string(domain.CertificateSingle), "证书类型:single、wildcard、san")
command.Flags().StringSliceVar(&sans, "sans", nil, "SAN 域名列表")
command.Flags().BoolVar(&autoRenew, "auto-renew", true, "是否启用自动续期")
command.Flags().StringVar(&acmeEnvironment, "acme-environment", domain.ACMEEnvironmentStaging, "ACME 环境:staging、production")
command.Flags().StringVar(&dnsProvider, "dns-provider", "", "DNS 验证服务商标识")
_ = command.MarkFlagRequired("id")
_ = command.MarkFlagRequired("name")
return command
}
func newDomainDeleteCommand() *cobra.Command {
var id string
command := &cobra.Command{Use: "delete", Short: "删除托管域名", RunE: func(cmd *cobra.Command, args []string) error {
cfg, err := loadConfig()
if err != nil {
return err
}
service, err := app.New(cmd.Context(), cfg)
if err != nil {
return err
}
defer service.Close()
if err := service.Repository.Delete(cmd.Context(), id); err != nil {
return err
}
fmt.Printf("域名已删除:%s\n", id)
return nil
}}
command.Flags().StringVar(&id, "id", "", "域名 ID")
_ = command.MarkFlagRequired("id")
return command
}
func printJSON(cmd *cobra.Command, value any) error {
data, err := json.MarshalIndent(value, "", " ")
if err != nil {
@@ -220,10 +561,7 @@ func printJSON(cmd *cobra.Command, value any) error {
return err
}
func loadConfig() (config.Config, error) {
path := resolveConfigPath()
return config.Load(path)
}
func loadConfig() (config.Config, error) { return config.Load(resolveConfigPath()) }
func resolveConfigPath() string {
if configPath != "" {
+80
View File
@@ -2,13 +2,39 @@ package cli
import (
"bytes"
"context"
"errors"
"os"
"path/filepath"
"strings"
"testing"
"git.pcux.cn/xuans/Scert/backend/internal/buildinfo"
"git.pcux.cn/xuans/Scert/backend/internal/config"
"git.pcux.cn/xuans/Scert/backend/internal/firewall"
)
type cliFakeFirewallManager struct {
result firewall.Result
openErr error
rollbackErr error
openedPort int
rollbackCall bool
}
func (f *cliFakeFirewallManager) OpenTCP(_ context.Context, port int) (firewall.Result, error) {
f.openedPort = port
if f.result.Port == 0 {
f.result.Port = port
}
return f.result, f.openErr
}
func (f *cliFakeFirewallManager) Rollback(_ context.Context, _ firewall.Result) error {
f.rollbackCall = true
return f.rollbackErr
}
func TestHelpIsLocalizedAndHasNoDuplicateCommands(t *testing.T) {
configPath = ""
baseDir = ""
@@ -58,3 +84,57 @@ func TestCommandStatusUsesApplicationVersion(t *testing.T) {
t.Fatalf("状态版本字段不正确:%+v", status)
}
}
func TestSaveSetupWithFirewallOpensOnlyMainPort(t *testing.T) {
cfg := config.Default(t.TempDir())
cfg.Server.Port = 8443
cfg.Admin.ResetServicePort = 8091
manager := &cliFakeFirewallManager{result: firewall.Result{
Backend: "windows", RuleName: "Scert Web TCP 8443", Created: true, Message: "已创建测试规则",
}}
path := filepath.Join(t.TempDir(), "config", "scert.json")
result, err := saveSetupWithFirewall(context.Background(), cfg, path, manager)
if err != nil {
t.Fatalf("保存初始化配置失败:%v", err)
}
if manager.openedPort != 8443 || manager.rollbackCall || !result.Created {
t.Fatalf("CLI 防火墙事务不正确:port=%d rollback=%t result=%+v", manager.openedPort, manager.rollbackCall, result)
}
if _, err := os.Stat(path); err != nil {
t.Fatalf("初始化配置未保存:%v", err)
}
}
func TestSaveSetupWithFirewallRollsBackNewRuleOnSaveFailure(t *testing.T) {
baseDir := t.TempDir()
blockedParent := filepath.Join(baseDir, "blocked")
if err := os.WriteFile(blockedParent, []byte("占位"), 0o600); err != nil {
t.Fatalf("创建阻塞路径失败:%v", err)
}
manager := &cliFakeFirewallManager{result: firewall.Result{
Backend: "ufw", RuleName: "Scert Web TCP 8080", Port: 8080, Created: true,
}}
_, err := saveSetupWithFirewall(context.Background(), config.Default(baseDir), filepath.Join(blockedParent, "scert.json"), manager)
if err == nil {
t.Fatal("配置保存失败应返回错误")
}
if !manager.rollbackCall {
t.Fatal("配置保存失败时应回滚本次新建的防火墙规则")
}
}
func TestSaveSetupWithFirewallReportsRollbackFailure(t *testing.T) {
baseDir := t.TempDir()
blockedParent := filepath.Join(baseDir, "blocked")
if err := os.WriteFile(blockedParent, []byte("占位"), 0o600); err != nil {
t.Fatalf("创建阻塞路径失败:%v", err)
}
manager := &cliFakeFirewallManager{
result: firewall.Result{Backend: "ufw", RuleName: "Scert Web TCP 8080", Port: 8080, Created: true},
rollbackErr: errors.New("rollback denied"),
}
_, err := saveSetupWithFirewall(context.Background(), config.Default(baseDir), filepath.Join(blockedParent, "scert.json"), manager)
if err == nil || !strings.Contains(err.Error(), "手动检查本机防火墙") {
t.Fatalf("防火墙回滚失败应返回明确错误:%v", err)
}
}