mirror of
https://git.sr.ht/~joren/streamrip-go
synced 2026-10-16 22:07:30 +02:00
fix: resource leaks, cancellation, races and path traversal
Six correctness bugs that the existing tests could not see. The suite passed and `go test -race` was clean throughout, because nothing exercised concurrent token refresh, shared-folder artwork, or hostile metadata. main(): extract run() int main() was a single 1196-line function that registered 20 `defer mainApp.Close()` handlers and then called os.Exit 150 times, so none of them ever ran. Close() is what closes the SQLite handle, flushes the progress bars and removes the artwork temp dirs, so every failed rip leaked temp directories. main() is now a wrapper around run() int and the command bodies return exit codes. Ctrl-C now stops a rip ctx was threaded everywhere but never checked: zero ctx.Err()/ctx.Done() in internal/app and internal/download. Cancellation left Rip() iterating the whole remaining queue, and the retry ladder retried on a dead context, so one Ctrl-C cost three doomed attempts per remaining track. Adds checks to the dispatch loops, the worker-spawn loops and the retry ladder, and routes the MarkFailed/MarkDownloaded bookkeeping through a detached context so the records survive cancellation. Convert and TagFLAC now take a ctx and use exec.CommandContext, so a stalled ffmpeg/ffprobe no longer outlives Ctrl-C. Config race Provider token refresh mutated the shared *config.Config and called SaveFile() from inside download workers with no lock, racing the struct fields and issuing concurrent os.WriteFile against one path. Adds a mutex to config.Config plus UpdateTokens(), and routes all five refresh sites through it. Each provider client gets an authMu guarding loggedIn and its login/refresh path; beatport needed it most, since ensureToken is reached from apiRequest. Artwork cover race artwork.Prepare was check-then-write on a path shared by every worker in a playlist rip. Two workers both saw a missing cover.jpg, both created it, and the loser's cleanup deleted the winner's finished file. Adds a per-folder lock and downloads via a unique temp file + rename. The regression test fails against the old code with 15 of 16 workers getting no cover. Path traversal from remote metadata naming.CleanName stripped <>:"/\|?* and control chars but not "." , so a title of ".." survived into filepath.Join and escaped the download root. SoundCloud and Tidal playlist names are user-generated. Now rejects "." and "..", trims trailing dots, handles Windows device names, adds DEL to the invalid set and caps components at 255 bytes without splitting a rune. app.go gains safeJoin as a second line of defence. Credentials no longer world-readable The config holds plaintext provider passwords, Deezer ARL cookies and OAuth tokens and was written 0o644. Now 0o600, with 0o700 directories, and an existing 0o644 file is tightened on write. Also: deletes the 9 duplicated *-rip-smoke dev commands (~300 lines fully subsumed by `rip id`) and the unreachable second dev-help arm; registers image/png so PNG covers are downscaled instead of being silently saved as cover.jpg containing PNG bytes; adds the missing .gitignore, which was keeping a 21MB build artifact one `git add -A` away from the repo. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
19 files changed
+915
-562
No files matched your search
@@ -5,6 +5,8 @@ import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"github.com/pelletier/go-toml/v2"
|
||||
)
|
||||
@@ -13,8 +15,17 @@ const CurrentConfigVersion = "2.2.0"
|
||||
|
||||
var ErrOutdatedConfig = errors.New("config version mismatch")
|
||||
|
||||
// Config holds the on-disk config (File) and the runtime view with CLI
|
||||
// overrides applied (Session).
|
||||
//
|
||||
// mu guards File, Session and the write to Path. Provider clients refresh OAuth
|
||||
// tokens from inside concurrent download workers, so both the struct fields and
|
||||
// the config-file write have to be serialized; without this, two workers
|
||||
// refreshing at once raced each other and issued two concurrent os.WriteFile
|
||||
// calls against the same path.
|
||||
type Config struct {
|
||||
Path string
|
||||
mu sync.Mutex
|
||||
File ConfigData
|
||||
Session ConfigData
|
||||
}
|
||||
@@ -227,9 +238,35 @@ func UpgradeOutdated(path string) (string, error) {
|
||||
}
|
||||
|
||||
func (c *Config) SaveFile() error {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
return c.saveFileLocked()
|
||||
}
|
||||
|
||||
func (c *Config) saveFileLocked() error {
|
||||
return saveConfigData(c.Path, c.File)
|
||||
}
|
||||
|
||||
// UpdateTokens applies fn to both the on-disk and session copies of the config
|
||||
// under the config lock, then persists the result. Provider token refresh must
|
||||
// go through this rather than mutating c.File/c.Session directly, because it
|
||||
// runs concurrently from download workers.
|
||||
func (c *Config) UpdateTokens(fn func(file, session *ConfigData)) error {
|
||||
if fn == nil {
|
||||
return nil
|
||||
}
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
fn(&c.File, &c.Session)
|
||||
// An empty Path means there is no config file backing this Config (tests,
|
||||
// and callers that loaded defaults only); the in-memory update still has to
|
||||
// happen, but there is nothing to write.
|
||||
if strings.TrimSpace(c.Path) == "" {
|
||||
return nil
|
||||
}
|
||||
return c.saveFileLocked()
|
||||
}
|
||||
|
||||
func DefaultConfigData() ConfigData {
|
||||
home, _ := os.UserHomeDir()
|
||||
appDir := defaultAppDir()
|
||||
@@ -326,11 +363,16 @@ func DefaultConfigData() ConfigData {
|
||||
}
|
||||
|
||||
func resolvePath(path string) (string, error) {
|
||||
// 0o700: this directory holds the credential-bearing config and the
|
||||
// download databases.
|
||||
if path != "" {
|
||||
return path, os.MkdirAll(filepath.Dir(path), 0o755)
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return path, nil
|
||||
}
|
||||
appDir := defaultAppDir()
|
||||
if err := os.MkdirAll(appDir, 0o755); err != nil {
|
||||
if err := os.MkdirAll(appDir, 0o700); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return filepath.Join(appDir, "config.toml"), nil
|
||||
@@ -345,14 +387,20 @@ func defaultAppDir() string {
|
||||
}
|
||||
|
||||
func saveConfigData(path string, data ConfigData) error {
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||
// 0o700/0o600: this file holds plaintext provider passwords, Deezer ARL
|
||||
// cookies and OAuth access/refresh tokens, so it must not be world-readable.
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o700); err != nil {
|
||||
return err
|
||||
}
|
||||
b, err := toml.Marshal(data)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return os.WriteFile(path, b, 0o644)
|
||||
if err := os.WriteFile(path, b, 0o600); err != nil {
|
||||
return err
|
||||
}
|
||||
// Tighten an existing file that a previous version created as 0o644.
|
||||
return os.Chmod(path, 0o600)
|
||||
}
|
||||
|
||||
func applyRuntimeDefaults(data *ConfigData) {
|
||||
|
||||
Reference in new issue
Block a user