fix: wire security headers, graceful shutdown, and settings invalidation
Lifecycle (internal/app + main.go): - App.OnShutdown hooks run after the HTTP server drains, in registration order: Worker.Shutdown (background jobs now drain instead of dying on SIGTERM), DeviceAuthMiddleware.Stop (releases the rate-limiter ticker), Handler.CloseScanner (fsnotify watcher and scan log files) Security headers: - SecurityHeadersMiddleware (survivor of middleware/security.go, renamed security_headers.go) is now on the echo stack: nosniff, frame-deny, HSTS, CSP (unsafe-inline required by the sanctioned theme flash guard + Alpine), referrer and permissions policy Scanner settings cache: - settings saves (UpdateScanSettings + ApplySetting for the three scan keys) now invalidate MediaScanner's 30s settings cache via SystemSettingsHandler.SetScanSettingsChanged, so changes apply on the next poll instead of after the TTL - MediaScanner.Close closes the scan logger, fixing a file-descriptor leak on every per-item rescan (fresh scanners never closed logs) Client fix: - custom-section-builder's add/remove-selection buttons used inline onclick attributes referencing module-scoped functions, which are not global in a bundled ES module: the buttons threw ReferenceError. Functions restored and exposed on window via declare global Also fixes a pre-existing vet error (saveCoverImage copied echo.Context by value, mutex included) and drops the per-key SettingsCache.InvalidateKey variant left callerless by the full-flush invalidation wiring.
This commit is contained in:
1 parent
8631aa00bf
commit
a716b386a1
10 files changed
+98
-195
No files matched your search
@@ -21,6 +21,7 @@ type App struct {
|
||||
shutdownTimeout time.Duration
|
||||
shutdownMutex sync.Mutex
|
||||
shutdownDone chan struct{}
|
||||
shutdownHooks []func()
|
||||
}
|
||||
|
||||
// New creates a new App instance
|
||||
@@ -99,11 +100,24 @@ func (a *App) Shutdown() error {
|
||||
log.Printf("Error stopping HTTP server: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Run shutdown hooks: drain background workers, stop tickers, close files
|
||||
for _, hook := range a.shutdownHooks {
|
||||
hook()
|
||||
}
|
||||
|
||||
close(a.shutdownDone)
|
||||
log.Println("Graceful shutdown completed successfully")
|
||||
return nil
|
||||
}
|
||||
|
||||
// OnShutdown registers a hook to run during graceful shutdown, after the HTTP
|
||||
// server has drained. Hooks run in registration order; register background
|
||||
// workers, tickers, and file handles here.
|
||||
func (a *App) OnShutdown(fn func()) {
|
||||
a.shutdownHooks = append(a.shutdownHooks, fn)
|
||||
}
|
||||
|
||||
// SetShutdownTimeout sets the maximum time to wait for graceful shutdown
|
||||
func (a *App) SetShutdownTimeout(timeout time.Duration) {
|
||||
a.shutdownTimeout = timeout
|
||||
|
||||
@@ -54,6 +54,22 @@ func NewHandler(db *database.Queries, connManager *wsync.ConnectionManager, queu
|
||||
}
|
||||
}
|
||||
|
||||
// CloseScanner releases scanner resources (fsnotify watcher, scan log files).
|
||||
// Call once during graceful shutdown.
|
||||
func (h *Handler) CloseScanner() {
|
||||
if h.scanner != nil {
|
||||
_ = h.scanner.Close()
|
||||
}
|
||||
}
|
||||
|
||||
// InvalidateScannerSettingsCache drops the scanner's cached system settings so
|
||||
// saved scan settings take effect on the next poll instead of after the TTL.
|
||||
func (h *Handler) InvalidateScannerSettingsCache() {
|
||||
if h.scanner != nil {
|
||||
h.scanner.InvalidateSettingsCache()
|
||||
}
|
||||
}
|
||||
|
||||
// parseDate parses a date string in YYYY-MM-DD format
|
||||
func parseDate(dateStr string) time.Time {
|
||||
if dateStr == "" {
|
||||
|
||||
@@ -1550,7 +1550,7 @@ func (mh *MediaHandler) UpdateMediaItem(c *echo.Context) error {
|
||||
} else if req.CoverAction == "upload" {
|
||||
file, err := c.FormFile("cover_file")
|
||||
if err == nil {
|
||||
savedPath, err := mh.saveCoverImage(*c, mediaUUID, file)
|
||||
savedPath, err := mh.saveCoverImage(c, mediaUUID, file)
|
||||
if err != nil {
|
||||
return c.JSON(http.StatusInternalServerError, map[string]string{"error": "failed to save cover image"})
|
||||
}
|
||||
@@ -2876,7 +2876,7 @@ func jsonBytesToMap(b []byte) map[string]interface{} {
|
||||
return result
|
||||
}
|
||||
|
||||
func (mh *MediaHandler) saveCoverImage(c echo.Context, mediaUUID uuid.UUID, file *multipart.FileHeader) (string, error) {
|
||||
func (mh *MediaHandler) saveCoverImage(c *echo.Context, mediaUUID uuid.UUID, file *multipart.FileHeader) (string, error) {
|
||||
src, err := file.Open()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to open uploaded file: %w", err)
|
||||
@@ -3030,7 +3030,8 @@ func (mh *MediaHandler) GetAudioChapters(c *echo.Context) error {
|
||||
// SetAudioSpeed handles PUT /api/media-items/:id/audio-speed — the
|
||||
// per-user per-book playback speed upsert (plan §8). The client SPEEDS
|
||||
// list is the real gate; the server sanity-checks the range.
|
||||
func (mh *MediaHandler) SetAudioSpeed(c *echo.Context) error { mediaID := c.Param("id")
|
||||
func (mh *MediaHandler) SetAudioSpeed(c *echo.Context) error {
|
||||
mediaID := c.Param("id")
|
||||
mediaUUID, err := uuid.Parse(mediaID)
|
||||
if err != nil {
|
||||
return c.JSON(http.StatusBadRequest, map[string]string{"error": "invalid media item id"})
|
||||
|
||||
@@ -15,8 +15,9 @@ import (
|
||||
)
|
||||
|
||||
type SystemSettingsHandler struct {
|
||||
db *database.Queries
|
||||
settings *database.SettingsRegistry
|
||||
db *database.Queries
|
||||
settings *database.SettingsRegistry
|
||||
onScanSettingsChanged func()
|
||||
}
|
||||
|
||||
func NewSystemSettingsHandler(db *database.Queries) *SystemSettingsHandler {
|
||||
@@ -25,6 +26,19 @@ func NewSystemSettingsHandler(db *database.Queries) *SystemSettingsHandler {
|
||||
}
|
||||
}
|
||||
|
||||
// SetScanSettingsChanged registers a callback fired after scan settings are
|
||||
// successfully saved on any write path, so listeners (the scanner) can drop
|
||||
// their cached values immediately instead of waiting out the cache TTL.
|
||||
func (h *SystemSettingsHandler) SetScanSettingsChanged(fn func()) {
|
||||
h.onScanSettingsChanged = fn
|
||||
}
|
||||
|
||||
func (h *SystemSettingsHandler) notifyScanSettingsChanged() {
|
||||
if h.onScanSettingsChanged != nil {
|
||||
h.onScanSettingsChanged()
|
||||
}
|
||||
}
|
||||
|
||||
// SetSettings wires the tunable settings registry. Required for the unified
|
||||
// /api/system/settings endpoints and for cache invalidation after writes.
|
||||
func (h *SystemSettingsHandler) SetSettings(s *database.SettingsRegistry) {
|
||||
@@ -121,6 +135,12 @@ func (h *SystemSettingsHandler) ApplySetting(ctx context.Context, key, value str
|
||||
|
||||
h.settings.Reload(ctx)
|
||||
|
||||
// Scan keys are also cached inside MediaScanner (30s TTL); let it drop
|
||||
// its cache so the change takes effect on the next poll.
|
||||
if key == "scan_poll_interval_seconds" || key == "auto_scan_enabled" || key == "scan_extractor_version" {
|
||||
h.notifyScanSettingsChanged()
|
||||
}
|
||||
|
||||
resp := UpdateSettingResponse{ReloadRequired: def.RequiresRestart}
|
||||
for _, e := range h.settings.All() {
|
||||
if e.Key == key {
|
||||
@@ -218,6 +238,8 @@ func (h *SystemSettingsHandler) UpdateScanSettings(c *echo.Context) error {
|
||||
return c.JSON(http.StatusInternalServerError, map[string]string{"error": err.Error()})
|
||||
}
|
||||
|
||||
h.notifyScanSettingsChanged()
|
||||
|
||||
h.reload(c)
|
||||
|
||||
return c.JSON(http.StatusOK, ScanSettingsResponse{
|
||||
|
||||
@@ -197,61 +197,10 @@ func (m *DeviceAuthMiddleware) getRequestType(path string) string {
|
||||
return "sync"
|
||||
}
|
||||
|
||||
func (m *DeviceAuthMiddleware) RequirePermission(permission string) echo.MiddlewareFunc {
|
||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||
return func(c *echo.Context) error {
|
||||
device, ok := c.Get("device").(database.Devices)
|
||||
if !ok {
|
||||
return c.JSON(http.StatusUnauthorized, map[string]string{
|
||||
"error": "device not authenticated",
|
||||
})
|
||||
}
|
||||
|
||||
if !m.hasPermission(device.DeviceType, permission) {
|
||||
return c.JSON(http.StatusForbidden, map[string]string{
|
||||
"error": "insufficient permissions",
|
||||
})
|
||||
}
|
||||
|
||||
return next(c)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (m *DeviceAuthMiddleware) hasPermission(deviceType string, permission string) bool {
|
||||
permissions := map[string][]string{
|
||||
"koreader": {"sync:progress", "sync:annotations", "sync:metadata"},
|
||||
"kobo": {"sync:progress", "sync:annotations", "sync:metadata"},
|
||||
"web": {"sync:progress", "sync:annotations", "sync:metadata", "device:manage"},
|
||||
"mobile": {"sync:progress", "sync:annotations", "sync:metadata"},
|
||||
}
|
||||
|
||||
devicePerms, exists := permissions[deviceType]
|
||||
if !exists {
|
||||
return false
|
||||
}
|
||||
|
||||
for _, p := range devicePerms {
|
||||
if p == permission {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func (m *DeviceAuthMiddleware) UpdateLastSeen(next echo.HandlerFunc) echo.HandlerFunc {
|
||||
return func(c *echo.Context) error {
|
||||
err := next(c)
|
||||
|
||||
deviceIDBytes, ok := c.Get("device_id").([16]byte)
|
||||
if ok {
|
||||
pgDeviceID := pgtype.UUID{Bytes: deviceIDBytes, Valid: true}
|
||||
m.db.UpdateDeviceLastSeen(c.Request().Context(), pgDeviceID)
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
// Stop releases the device rate limiter's cleanup resources (its ticker
|
||||
// goroutine). Call once during graceful shutdown.
|
||||
func (m *DeviceAuthMiddleware) Stop() {
|
||||
m.rateLimiter.Stop()
|
||||
}
|
||||
|
||||
func (m *DeviceAuthMiddleware) ValidateDeviceToken(token string) (database.Devices, error) {
|
||||
|
||||
@@ -1,10 +1,6 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/labstack/echo/v5"
|
||||
)
|
||||
|
||||
@@ -25,126 +21,3 @@ func SecurityHeadersMiddleware() echo.MiddlewareFunc {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// HTTPSRedirectMiddleware redirects HTTP to HTTPS
|
||||
// NOTE: Disabled for Docker self-hosted deployments - SSL is handled by reverse proxy
|
||||
func HTTPSRedirectMiddleware(httpsPort string) echo.MiddlewareFunc {
|
||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||
return func(c *echo.Context) error {
|
||||
// SSL is handled by proxy - no redirect needed
|
||||
return next(c)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// isTestMode checks if the application is running in test mode
|
||||
func isTestMode(c *echo.Context) bool {
|
||||
// Check for test mode header or environment
|
||||
return c.Request().Header.Get("X-Test-Mode") == "true" ||
|
||||
c.Request().Header.Get("X-Forwarded-Proto") == "http"
|
||||
}
|
||||
|
||||
// SSLProxyMiddleware handles SSL termination proxy headers
|
||||
// NOTE: Essential for Docker deployments where SSL is handled by reverse proxy (nginx, traefik, etc.)
|
||||
// This middleware reads X-Forwarded-Proto and X-Forwarded-Host headers set by the proxy
|
||||
func SSLProxyMiddleware() echo.MiddlewareFunc {
|
||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||
return func(c *echo.Context) error {
|
||||
// Check for proxy headers
|
||||
if proto := c.Request().Header.Get("X-Forwarded-Proto"); proto == "https" {
|
||||
c.Request().URL.Scheme = "https"
|
||||
}
|
||||
|
||||
if host := c.Request().Header.Get("X-Forwarded-Host"); host != "" {
|
||||
c.Request().URL.Host = host
|
||||
}
|
||||
|
||||
return next(c)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// HTTPSProtectionMiddleware provides HTTPS protection for production
|
||||
func HTTPSProtectionMiddleware(enableRedirect bool, httpsPort string) []echo.MiddlewareFunc {
|
||||
return []echo.MiddlewareFunc{
|
||||
SSLProxyMiddleware(),
|
||||
SecurityHeadersMiddleware(),
|
||||
HTTPSRedirectMiddleware(httpsPort),
|
||||
}
|
||||
}
|
||||
|
||||
// CORSSecurityConfig configures CORS with security best practices
|
||||
type CORSSecurityConfig struct {
|
||||
AllowedOrigins []string
|
||||
AllowedMethods []string
|
||||
AllowedHeaders []string
|
||||
ExposedHeaders []string
|
||||
AllowCredentials bool
|
||||
MaxAge int
|
||||
}
|
||||
|
||||
// NewSecureCORSConfig creates production-ready CORS config
|
||||
func NewSecureCORSConfig() CORSSecurityConfig {
|
||||
return CORSSecurityConfig{
|
||||
AllowedOrigins: []string{
|
||||
"https://bookhoard.example.com",
|
||||
"https://*.bookhoard.example.com",
|
||||
},
|
||||
AllowedMethods: []string{"GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"},
|
||||
AllowedHeaders: []string{
|
||||
"Accept",
|
||||
"Authorization",
|
||||
"Content-Type",
|
||||
"X-Request-ID",
|
||||
"X-Timestamp",
|
||||
"X-Signature",
|
||||
"X-Device-ID",
|
||||
},
|
||||
ExposedHeaders: []string{
|
||||
"X-Request-ID",
|
||||
"X-Sync-Status",
|
||||
"X-Conflict-Detected",
|
||||
},
|
||||
AllowCredentials: true,
|
||||
MaxAge: 86400, // 24 hours
|
||||
}
|
||||
}
|
||||
|
||||
// SecureCORSMiddleware creates CORS middleware with security
|
||||
func SecureCORSMiddleware(config CORSSecurityConfig) echo.MiddlewareFunc {
|
||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||
return func(c *echo.Context) error {
|
||||
origin := c.Request().Header.Get("Origin")
|
||||
|
||||
// Check if origin is allowed
|
||||
allowed := false
|
||||
for _, allowedOrigin := range config.AllowedOrigins {
|
||||
if origin == allowedOrigin || allowedOrigin == "*" {
|
||||
allowed = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !allowed {
|
||||
return c.JSON(http.StatusForbidden, map[string]string{
|
||||
"error": "Origin not allowed",
|
||||
})
|
||||
}
|
||||
|
||||
// Set CORS headers
|
||||
c.Response().Header().Set("Access-Control-Allow-Origin", origin)
|
||||
c.Response().Header().Set("Access-Control-Allow-Methods", strings.Join(config.AllowedMethods, ", "))
|
||||
c.Response().Header().Set("Access-Control-Allow-Headers", strings.Join(config.AllowedHeaders, ", "))
|
||||
c.Response().Header().Set("Access-Control-Expose-Headers", strings.Join(config.ExposedHeaders, ", "))
|
||||
c.Response().Header().Set("Access-Control-Allow-Credentials", "true")
|
||||
c.Response().Header().Set("Access-Control-Max-Age", strconv.Itoa(config.MaxAge))
|
||||
|
||||
// Handle preflight
|
||||
if c.Request().Method == "OPTIONS" {
|
||||
return c.NoContent(http.StatusNoContent)
|
||||
}
|
||||
|
||||
return next(c)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -48,10 +48,3 @@ func (c *SettingsCache) Invalidate() {
|
||||
c.data = make(map[string]string)
|
||||
c.lastUpdate = time.Time{}
|
||||
}
|
||||
|
||||
func (c *SettingsCache) InvalidateKey(key string) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
delete(c.data, key)
|
||||
}
|
||||
@@ -343,6 +343,13 @@ func (s *MediaScanner) GetAutoScanEnabled() bool {
|
||||
return strings.ToLower(setting) == "true"
|
||||
}
|
||||
|
||||
// InvalidateSettingsCache drops all cached setting values so the next read
|
||||
// re-queries system_settings. Called when scan settings are saved; without it
|
||||
// saved values only take effect after the cache TTL (30s).
|
||||
func (s *MediaScanner) InvalidateSettingsCache() {
|
||||
s.settingsCache.Invalidate()
|
||||
}
|
||||
|
||||
// GetAutoPlaylistCollections mirrors GetAutoScanEnabled for the A2c
|
||||
// playlist-collection toggle. Defaults ON: the feature only creates
|
||||
// deletable curated collections from explicit "(Reading Order)" markers.
|
||||
@@ -4692,6 +4699,11 @@ func (s *MediaScanner) performInitialScan(ctx context.Context) {
|
||||
func (s *MediaScanner) Close() error {
|
||||
fmt.Printf("Cleaning up scanner resources...\n")
|
||||
|
||||
// Close scan log files (no-op-safe if already closed)
|
||||
if s.logger != nil {
|
||||
s.logger.Close()
|
||||
}
|
||||
|
||||
// Stop watching
|
||||
if s.watcher != nil {
|
||||
if err := s.watcher.Close(); err != nil {
|
||||
|
||||
Reference in new issue
Block a user