继续初始化测试前保存启动链路与页面迁移检查点
This commit is contained in:
1 parent
34d1fb88e5
commit
199d727ecc
20 files changed
+891
-67
No files matched your search
@@ -9,6 +9,7 @@ import (
|
||||
"mime"
|
||||
"net/http"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/dnsprovider"
|
||||
@@ -37,10 +38,12 @@ type bootstrapCompleter interface {
|
||||
|
||||
// Router 只承载首次初始化接口,不注册正式管理接口。
|
||||
type Router struct {
|
||||
sessions *SessionManager
|
||||
database bootstrapDatabaseVerifier
|
||||
dns bootstrapDNSVerifier
|
||||
completer bootstrapCompleter
|
||||
sessions *SessionManager
|
||||
database bootstrapDatabaseVerifier
|
||||
dns bootstrapDNSVerifier
|
||||
completer bootstrapCompleter
|
||||
completed chan struct{}
|
||||
completeOnce sync.Once
|
||||
}
|
||||
|
||||
type bootstrapSessionRequest struct {
|
||||
@@ -55,9 +58,12 @@ type bootstrapDNSTestRequest struct {
|
||||
|
||||
// NewRouter 创建与正式管理服务完全分离的首次初始化路由。
|
||||
func NewRouter(sessions *SessionManager, database bootstrapDatabaseVerifier, dns bootstrapDNSVerifier, completer bootstrapCompleter) *Router {
|
||||
return &Router{sessions: sessions, database: database, dns: dns, completer: completer}
|
||||
return &Router{sessions: sessions, database: database, dns: dns, completer: completer, completed: make(chan struct{})}
|
||||
}
|
||||
|
||||
// Completed 在成功响应写入后通知临时服务开始优雅关闭。
|
||||
func (router *Router) Completed() <-chan struct{} { return router.completed }
|
||||
|
||||
func (router *Router) ServeHTTP(writer http.ResponseWriter, request *http.Request) {
|
||||
setBootstrapSecurityHeaders(writer)
|
||||
if request == nil {
|
||||
@@ -254,6 +260,7 @@ func (router *Router) complete(writer http.ResponseWriter, request *http.Request
|
||||
router.sessions.RevokeAll()
|
||||
http.SetCookie(writer, ClearBootstrapSessionCookie())
|
||||
writeBootstrapJSON(writer, http.StatusOK, result)
|
||||
router.completeOnce.Do(func() { close(router.completed) })
|
||||
}
|
||||
|
||||
func writeBootstrapCompletionError(writer http.ResponseWriter, err error) {
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
package bootstrap
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/fs"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/certificate"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/config"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/dnsprovider"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/firewall"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/secretstore"
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/setup"
|
||||
)
|
||||
|
||||
type ServerOptions struct {
|
||||
Config config.Config
|
||||
ConfigPath string
|
||||
PublicIP string
|
||||
URLPath string
|
||||
Output io.Writer
|
||||
}
|
||||
|
||||
// Run 只创建初始化所需组件;正式数据库、业务路由和后台任务由切换后的应用创建。
|
||||
func Run(ctx context.Context, options ServerOptions) (bool, error) {
|
||||
if options.Config.SetupReady {
|
||||
return false, errors.New("已经初始化,不能启动临时初始化服务")
|
||||
}
|
||||
material, err := NewTemporaryTLSMaterial(options.PublicIP)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
sessions, token, err := NewSessionManager()
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
defer sessions.RevokeAll()
|
||||
ip, err := advertisedBootstrapIP(options.PublicIP, material.IPAddresses)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
address, err := bootstrapURL(ip, options.Config.Server.Port, token)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
store, err := secretstore.Open(options.Config.Paths.Config)
|
||||
if err != nil {
|
||||
return false, fmt.Errorf("打开初始化敏感信息存储失败:%w", err)
|
||||
}
|
||||
databases := NewDatabaseVerificationManager(options.Config, store)
|
||||
dns := setup.NewDNSVerificationManager(dnsprovider.NewTester(dnsprovider.NewLegoFactory()), store)
|
||||
// 服务完全停止后再清理未领取的凭据,避免在途验证重新留下临时凭据。
|
||||
defer databases.DiscardAllExcept()
|
||||
defer dns.DiscardAll()
|
||||
issuer := certificate.NewService(options.Config, nil, store, dnsprovider.NewLegoFactory(), certificate.NewAccountRepository(store))
|
||||
issuer.SetDNSAuthorizationChecker(dnsprovider.NewAliyunAuthorizationChecker())
|
||||
completer := NewCompleter(CompleteDependencies{
|
||||
BaseConfig: options.Config, ConfigPath: options.ConfigPath, BootstrapURLPath: options.URLPath,
|
||||
DatabaseSessions: databases, DNSSessions: dns, Credentials: store, Sessions: sessions,
|
||||
Firewall: firewall.NewManager(), Certificate: issuer,
|
||||
Warn: func(message string) {
|
||||
if options.Output != nil {
|
||||
fmt.Fprintln(options.Output, message)
|
||||
}
|
||||
},
|
||||
})
|
||||
router := NewRouter(sessions, databases, dns, completer)
|
||||
handler, closeFiles := bootstrapHandler(router, options.Config)
|
||||
defer closeFiles()
|
||||
listener, err := net.Listen("tcp", net.JoinHostPort(options.Config.Server.Host, strconv.Itoa(options.Config.Server.Port)))
|
||||
if err != nil {
|
||||
return false, fmt.Errorf("监听初始化端口失败:%w", err)
|
||||
}
|
||||
defer listener.Close()
|
||||
if err := WriteBootstrapURL(options.URLPath, address); err != nil {
|
||||
return false, err
|
||||
}
|
||||
defer func() {
|
||||
if err := os.Remove(options.URLPath); err != nil && !errors.Is(err, os.ErrNotExist) && options.Output != nil {
|
||||
fmt.Fprintln(options.Output, "初始化地址文件清理失败,请检查运行目录权限。")
|
||||
}
|
||||
}()
|
||||
if options.Output != nil {
|
||||
// 一次性令牌只能写入受保护文件,不进入终端日志或 systemd journal。
|
||||
fmt.Fprintf(options.Output, "首次初始化 HTTPS 服务已启动,端口 %d。请读取 %s 获取一次性访问地址;临时自签名证书需人工核对。\n", options.Config.Server.Port, options.URLPath)
|
||||
}
|
||||
return serveTemporaryHTTPS(ctx, listener, material, handler, router.Completed())
|
||||
}
|
||||
|
||||
func serveTemporaryHTTPS(ctx context.Context, listener net.Listener, material TLSMaterial, handler http.Handler, completed <-chan struct{}) (bool, error) {
|
||||
requestContext, cancelRequests := context.WithCancel(context.Background())
|
||||
defer cancelRequests()
|
||||
var active sync.WaitGroup
|
||||
server := &http.Server{
|
||||
Handler: http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
|
||||
active.Add(1)
|
||||
defer active.Done()
|
||||
handler.ServeHTTP(writer, request)
|
||||
}),
|
||||
ReadHeaderTimeout: 5 * time.Second, ReadTimeout: 15 * time.Second, IdleTimeout: 30 * time.Second, MaxHeaderBytes: 16 * 1024,
|
||||
TLSConfig: &tls.Config{MinVersion: tls.VersionTLS12, Certificates: []tls.Certificate{material.Certificate}},
|
||||
BaseContext: func(net.Listener) context.Context { return requestContext },
|
||||
}
|
||||
errorsChannel := make(chan error, 1)
|
||||
go func() { errorsChannel <- server.ServeTLS(listener, "", "") }()
|
||||
success := false
|
||||
var serveErr error
|
||||
select {
|
||||
case <-completed:
|
||||
success = true
|
||||
case <-ctx.Done():
|
||||
cancelRequests()
|
||||
case serveErr = <-errorsChannel:
|
||||
cancelRequests()
|
||||
}
|
||||
shutdownContext, cancelShutdown := context.WithTimeout(context.Background(), 15*time.Second)
|
||||
defer cancelShutdown()
|
||||
shutdownErr := server.Shutdown(shutdownContext)
|
||||
if shutdownErr != nil {
|
||||
cancelRequests()
|
||||
_ = server.Close()
|
||||
}
|
||||
// Shutdown 已停止接收新请求;等待在途处理完成后才能清理其凭据。
|
||||
active.Wait()
|
||||
if serveErr != nil && !errors.Is(serveErr, http.ErrServerClosed) {
|
||||
return false, serveErr
|
||||
}
|
||||
if shutdownErr != nil {
|
||||
return false, fmt.Errorf("关闭初始化服务失败:%w", shutdownErr)
|
||||
}
|
||||
return success, nil
|
||||
}
|
||||
|
||||
func bootstrapHandler(router *Router, cfg config.Config) (http.Handler, func()) {
|
||||
root, _ := os.OpenRoot(filepath.Join(cfg.Paths.Install, "web"))
|
||||
closeFiles := func() {
|
||||
if root != nil {
|
||||
_ = root.Close()
|
||||
}
|
||||
}
|
||||
return http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
|
||||
setBootstrapSecurityHeaders(writer)
|
||||
if request.URL.Path == "/api/v1/bootstrap/settings" {
|
||||
if !requireBootstrapMethod(writer, request, http.MethodGet) || !router.authenticate(writer, request) {
|
||||
return
|
||||
}
|
||||
writeBootstrapJSON(writer, http.StatusOK, map[string]any{
|
||||
"mode": "bootstrap", "initialized": false, "server_port": cfg.Server.Port,
|
||||
"web_enabled": true, "web_hostname": cfg.Web.Hostname, "web_public_ip": cfg.Web.PublicIP,
|
||||
"https_mode": cfg.Server.HTTPSMode, "certificate_root": cfg.Paths.Certificate,
|
||||
"dns_provider": dnsprovider.Aliyun, "acme_environment": cfg.ACME.Environment,
|
||||
"propagation_timeout_secs": cfg.ACME.PropagationTimeoutSecs,
|
||||
"propagation_polling_interval_secs": cfg.ACME.PropagationPollingIntervalSecs,
|
||||
})
|
||||
return
|
||||
}
|
||||
path := request.URL.Path
|
||||
if strings.HasPrefix(path, "/api/") {
|
||||
router.ServeHTTP(writer, request)
|
||||
return
|
||||
}
|
||||
if request.Method != http.MethodGet && request.Method != http.MethodHead {
|
||||
http.NotFound(writer, request)
|
||||
return
|
||||
}
|
||||
name := strings.TrimPrefix(path, "/")
|
||||
if path == "/" {
|
||||
name = "index.html"
|
||||
} else if path != "/Scert.png" && path != "/favicon.ico" && !strings.HasPrefix(path, "/assets/") {
|
||||
http.NotFound(writer, request)
|
||||
return
|
||||
}
|
||||
if !fs.ValidPath(name) {
|
||||
writeBootstrapError(writer, http.StatusBadRequest, "资源路径无效")
|
||||
return
|
||||
}
|
||||
if root == nil {
|
||||
http.Error(writer, "初始化页面资源尚未安装,请检查 web 目录。", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
// os.Root 限制符号链接逃逸,不暴露配置目录或任意业务文件。
|
||||
file, err := root.Open(name)
|
||||
if err != nil {
|
||||
writeBootstrapError(writer, http.StatusNotFound, "资源不存在")
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
info, err := file.Stat()
|
||||
if err != nil || !info.Mode().IsRegular() {
|
||||
writeBootstrapError(writer, http.StatusNotFound, "资源不存在")
|
||||
return
|
||||
}
|
||||
http.ServeContent(writer, request, info.Name(), info.ModTime(), file)
|
||||
}), closeFiles
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
package bootstrap
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.pcux.cn/xuans/Scert/backend/internal/config"
|
||||
)
|
||||
|
||||
func TestTemporaryHTTPSDrainsCompletionResponse(t *testing.T) {
|
||||
material, err := NewTemporaryTLSMaterial("127.0.0.1")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
completed := make(chan struct{})
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
defer cancel()
|
||||
result := make(chan error, 1)
|
||||
body := strings.Repeat("response-data", 10000)
|
||||
go func() {
|
||||
ok, err := serveTemporaryHTTPS(ctx, listener, material, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
close(completed)
|
||||
time.Sleep(30 * time.Millisecond)
|
||||
_, _ = io.WriteString(w, body)
|
||||
}), completed)
|
||||
if !ok && err == nil {
|
||||
err = context.Canceled
|
||||
}
|
||||
result <- err
|
||||
}()
|
||||
roots := x509.NewCertPool()
|
||||
roots.AddCert(material.Leaf)
|
||||
transport := &http.Transport{TLSClientConfig: &tls.Config{RootCAs: roots, MinVersion: tls.VersionTLS12}}
|
||||
defer transport.CloseIdleConnections()
|
||||
client := &http.Client{Transport: transport, Timeout: 5 * time.Second}
|
||||
response, err := client.Get("https://" + listener.Addr().String() + "/")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
data, err := io.ReadAll(response.Body)
|
||||
response.Body.Close()
|
||||
if err != nil || string(data) != body {
|
||||
t.Fatalf("成功响应被关闭截断:%v,长度 %d", err, len(data))
|
||||
}
|
||||
select {
|
||||
case err := <-result:
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("临时服务没有关闭")
|
||||
}
|
||||
if conn, err := net.DialTimeout("tcp", listener.Addr().String(), 100*time.Millisecond); err == nil {
|
||||
conn.Close()
|
||||
t.Fatal("关闭后仍可连接")
|
||||
}
|
||||
}
|
||||
|
||||
func TestBootstrapHandlerIsolatesBusinessRoutesAndSettings(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
if err := os.MkdirAll(filepath.Join(root, "web"), 0o700); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(root, "web", "index.html"), []byte("bootstrap-page"), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
cfg := config.Default(root)
|
||||
cfg.Paths.Install = root
|
||||
sessions, token, err := NewSessionManager()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
router := NewRouter(sessions, nil, nil, nil)
|
||||
handler, closeFiles := bootstrapHandler(router, cfg)
|
||||
defer closeFiles()
|
||||
for path, status := range map[string]int{
|
||||
"/": 200, "/api/v1/bootstrap/status": 200, "/api/v1/bootstrap/settings": 401,
|
||||
"/api/v1/setup": 404, "/api/v1/domains": 404, "/reset": 404, "/scert.json": 404,
|
||||
"/assets/../../config.json": 400,
|
||||
} {
|
||||
response := httptest.NewRecorder()
|
||||
handler.ServeHTTP(response, httptest.NewRequest(http.MethodGet, path, nil))
|
||||
if response.Code != status {
|
||||
t.Fatalf("%s 状态码 %d,期望 %d", path, response.Code, status)
|
||||
}
|
||||
if response.Header().Get("Cache-Control") != "no-store" {
|
||||
t.Fatal("临时页面允许缓存")
|
||||
}
|
||||
}
|
||||
session, err := sessions.Exchange(token, "127.0.0.1")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
request := httptest.NewRequest(http.MethodGet, "/api/v1/bootstrap/settings", nil)
|
||||
request.AddCookie(BootstrapSessionCookie(session.Token, session.ExpiresAt))
|
||||
response := httptest.NewRecorder()
|
||||
handler.ServeHTTP(response, request)
|
||||
if response.Code != 200 || !strings.Contains(response.Body.String(), `"mode":"bootstrap"`) {
|
||||
t.Fatal("认证后无法读取初始化设置")
|
||||
}
|
||||
}
|
||||
@@ -186,9 +186,15 @@ func WriteBootstrapURL(path, value string) error {
|
||||
return errors.New("Bootstrap 地址不能为空")
|
||||
}
|
||||
directory := filepath.Dir(path)
|
||||
if directory == filepath.VolumeName(directory)+string(filepath.Separator) {
|
||||
return errors.New("Bootstrap 地址文件不能直接放在文件系统根目录")
|
||||
}
|
||||
if err := os.MkdirAll(directory, 0o700); err != nil {
|
||||
return fmt.Errorf("创建 Bootstrap 运行目录失败:%w", err)
|
||||
}
|
||||
if info, err := os.Lstat(directory); err != nil || !info.IsDir() || info.Mode()&os.ModeSymlink != 0 {
|
||||
return errors.New("Bootstrap 运行目录必须是普通目录")
|
||||
}
|
||||
if err := os.Chmod(directory, 0o700); err != nil {
|
||||
return fmt.Errorf("设置 Bootstrap 运行目录权限失败:%w", err)
|
||||
}
|
||||
@@ -197,24 +203,24 @@ func WriteBootstrapURL(path, value string) error {
|
||||
} else if err != nil && !errors.Is(err, os.ErrNotExist) {
|
||||
return fmt.Errorf("检查 Bootstrap 地址文件失败:%w", err)
|
||||
}
|
||||
temporaryPath := path + ".tmp"
|
||||
if info, err := os.Lstat(temporaryPath); err == nil && info.Mode()&os.ModeSymlink != 0 {
|
||||
return errors.New("Bootstrap 临时地址文件不能是符号链接")
|
||||
} else if err != nil && !errors.Is(err, os.ErrNotExist) {
|
||||
return fmt.Errorf("检查 Bootstrap 临时地址文件失败:%w", err)
|
||||
}
|
||||
if err := os.WriteFile(temporaryPath, []byte(value+"\n"), 0o600); err != nil {
|
||||
temporary, err := os.CreateTemp(directory, ".bootstrap-url-")
|
||||
if err != nil { return fmt.Errorf("创建 Bootstrap 临时地址文件失败:%w", err) }
|
||||
temporaryPath := temporary.Name()
|
||||
defer os.Remove(temporaryPath)
|
||||
defer temporary.Close()
|
||||
if _, err := temporary.WriteString(value+"\n"); err != nil {
|
||||
return fmt.Errorf("写入 Bootstrap 临时地址文件失败:%w", err)
|
||||
}
|
||||
if err := os.Chmod(temporaryPath, 0o600); err != nil {
|
||||
_ = os.Remove(temporaryPath)
|
||||
if err := temporary.Chmod(0o600); err != nil {
|
||||
return fmt.Errorf("设置 Bootstrap 临时地址文件权限失败:%w", err)
|
||||
}
|
||||
if err := temporary.Sync(); err != nil { return fmt.Errorf("同步 Bootstrap 地址文件失败:%w", err) }
|
||||
if err := temporary.Close(); err != nil { return fmt.Errorf("关闭 Bootstrap 地址文件失败:%w", err) }
|
||||
if err := os.Rename(temporaryPath, path); err != nil {
|
||||
_ = os.Remove(temporaryPath)
|
||||
return fmt.Errorf("替换 Bootstrap 地址文件失败:%w", err)
|
||||
}
|
||||
return os.Chmod(path, 0o600)
|
||||
return nil
|
||||
}
|
||||
|
||||
func cloneIPs(values []net.IP) []net.IP {
|
||||
|
||||
Reference in new issue
Block a user