@synopackageland/cli 0.3.10 → 0.4.0

package/dist/templates/native-go/backend/internal/dsm/auth_test.go

@@ -0,0 +1,139 @@
+package dsm
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"path/filepath"
+	"slices"
+	"strings"
+	"testing"
+
+	"dsmapp/internal/api"
+)
+
+const groupFile = `root:x:0:
+users:x:100:
+administrators:x:101:admin,alice
+http:x:1023:
+`
+
+type fakeRunner struct {
+	out  string
+	err  error
+	env  []string
+	path string
+}
+
+func (f *fakeRunner) run(_ context.Context, path string, env []string) ([]byte, error) {
+	f.path, f.env = path, env
+	return []byte(f.out), f.err
+}
+
+func newTestAuth(t *testing.T, runner *fakeRunner) *Authenticator {
+	t.Helper()
+	groups := filepath.Join(t.TempDir(), "group")
+	if err := os.WriteFile(groups, []byte(groupFile), 0o644); err != nil {
+		t.Fatal(err)
+	}
+	a := NewAuthenticator()
+	a.GroupFile = groups
+	a.run = runner.run
+	return a
+}
+
+func sessionRequest() *http.Request {
+	r := httptest.NewRequest(http.MethodPost, "/webman/3rdparty/App/cgi/api.cgi", nil)
+	r.RemoteAddr = "192.0.2.7:51234"
+	r.Header.Set("Cookie", "id=abc; did=xyz")
+	r.Header.Set("X-SYNO-TOKEN", "tok+en/=")
+	r.Header.Set("User-Agent", "should-not-pass")
+	return r
+}
+
+func TestAdminUserIsResolvedFromAuthenticateCGIAndGroupFile(t *testing.T) {
+	runner := &fakeRunner{out: "alice\n"}
+	id, err := newTestAuth(t, runner).Authenticate(sessionRequest())
+	if err != nil || id.User != "alice" || !id.Admin {
+		t.Fatalf("got %+v, %v", id, err)
+	}
+	if runner.path != AuthenticateCGI {
+		t.Errorf("ran %q", runner.path)
+	}
+}
+
+func TestOrdinaryUserIsNotAdmin(t *testing.T) {
+	id, err := newTestAuth(t, &fakeRunner{out: "bob\n"}).Authenticate(sessionRequest())
+	if err != nil || id.User != "bob" || id.Admin {
+		t.Fatalf("got %+v, %v", id, err)
+	}
+}
+
+func TestOnlySessionCarriersReachAuthenticateCGI(t *testing.T) {
+	runner := &fakeRunner{out: "alice"}
+	if _, err := newTestAuth(t, runner).Authenticate(sessionRequest()); err != nil {
+		t.Fatal(err)
+	}
+	want := []string{
+		"HTTP_COOKIE=id=abc; did=xyz",
+		"HTTP_X_SYNO_TOKEN=tok+en/=",
+		"QUERY_STRING=SynoToken=tok%2Ben%2F%3D",
+		"REMOTE_ADDR=192.0.2.7",
+		"REQUEST_METHOD=GET",
+	}
+	got := slices.Clone(runner.env)
+	slices.Sort(got)
+	if !slices.Equal(got, want) {
+		t.Fatalf("env = %q\nwant  %q", got, want)
+	}
+}
+
+func TestMissingCookieNeverRunsAuthenticateCGI(t *testing.T) {
+	runner := &fakeRunner{out: "alice"}
+	r := sessionRequest()
+	r.Header.Del("Cookie")
+	_, err := newTestAuth(t, runner).Authenticate(r)
+	if !errors.Is(err, api.ErrNoSession) || runner.path != "" {
+		t.Fatalf("err=%v ran=%q", err, runner.path)
+	}
+}
+
+func TestRejectedOrMalformedSessionsAreNoSession(t *testing.T) {
+	for name, runner := range map[string]*fakeRunner{
+		"exit status":   {err: &exitError{}},
+		"empty output":  {out: "\n"},
+		"two lines":     {out: "alice\nadmin\n"},
+		"html output":   {out: "<html>login</html>"},
+		"overlong name": {out: strings.Repeat("a", 200)},
+		"space in name": {out: "alice admin"},
+	} {
+		t.Run(name, func(t *testing.T) {
+			_, err := newTestAuth(t, runner).Authenticate(sessionRequest())
+			if !errors.Is(err, api.ErrNoSession) {
+				t.Fatalf("err = %v", err)
+			}
+		})
+	}
+}
+
+func TestBrokenAuthenticatorIsUnavailableNotNoSession(t *testing.T) {
+	_, err := newTestAuth(t, &fakeRunner{err: errors.New("exec: not found")}).Authenticate(sessionRequest())
+	if err == nil || errors.Is(err, api.ErrNoSession) {
+		t.Fatalf("err = %v", err)
+	}
+}
+
+func TestUnreadableGroupFileFailsClosed(t *testing.T) {
+	a := newTestAuth(t, &fakeRunner{out: "alice"})
+	a.GroupFile = filepath.Join(t.TempDir(), "missing")
+	if _, err := a.Authenticate(sessionRequest()); err == nil || errors.Is(err, api.ErrNoSession) {
+		t.Fatalf("err = %v, want unavailable", err)
+	}
+}
+
+type exitError struct{}
+
+func (*exitError) Error() string { return "exit status 1" }
+func (*exitError) ExitCode() int { return 1 }

package/dist/templates/native-go/backend/internal/helper/control.go

@@ -0,0 +1,219 @@
+package helper
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"io"
+	"io/fs"
+	"net"
+	"os"
+	"path/filepath"
+	"syscall"
+	"time"
+)
+
+// Process identity rejects reboot/PID reuse and executable replacement.
+// Linux Stop authenticates the owning supervisor socket; only that parent signals its child.
+type Process struct {
+	Inventory Inventory `json:"inventory"`
+	Mode      string    `json:"mode,omitempty"` // must be supervised; old unsupervised records fail closed
+	PID       int       `json:"pid"`
+	Boot      string    `json:"boot"`
+	Start     string    `json:"start"`
+	Device    uint64    `json:"device"`
+	Inode     uint64    `json:"inode"`
+}
+
+type Processes interface {
+	Stop(Process) error
+	Start(Inventory) error
+}
+type Controller struct {
+	Client
+	Processes Processes
+}
+
+func waitHealthy(ctx context.Context, probe func(context.Context) bool) error {
+	for ctx.Err() == nil {
+		if probe(ctx) {
+			return nil
+		}
+		timer := time.NewTimer(20 * time.Millisecond)
+		select {
+		case <-ctx.Done():
+			timer.Stop()
+			return ctx.Err()
+		case <-timer.C:
+		}
+	}
+	return ctx.Err()
+}
+
+func writeProtected(dir, name string, value any) error {
+	b, err := json.Marshal(value)
+	if err != nil {
+		return err
+	}
+	f, err := os.CreateTemp(dir, ".transition-*")
+	if err != nil {
+		return err
+	}
+	defer os.Remove(f.Name())
+	mode := fs.FileMode(0644)
+	if name == "process.json" {
+		mode = 0600
+	}
+	if err := f.Chmod(mode); err != nil {
+		f.Close()
+		return err
+	}
+	if _, err := f.Write(b); err != nil {
+		f.Close()
+		return err
+	}
+	if err := f.Sync(); err != nil {
+		f.Close()
+		return err
+	}
+	if err := f.Close(); err != nil {
+		return err
+	}
+	if err := os.Rename(f.Name(), filepath.Join(dir, name)); err != nil {
+		return err
+	}
+	d, err := os.Open(dir)
+	if err != nil {
+		return err
+	}
+	defer d.Close()
+	return d.Sync()
+}
+
+func writeProcess(dir string, p Process) error { return writeProtected(dir, "process.json", p) }
+
+func readProcess(dir string, owner uint32) (Process, error) {
+	var p Process
+	if err := protected(dir, owner, true); err != nil {
+		return p, err
+	}
+	path := filepath.Join(dir, "process.json")
+	if err := protected(path, owner, false); err != nil {
+		return p, err
+	}
+	f, err := os.OpenFile(path, os.O_RDONLY|syscall.O_NOFOLLOW, 0)
+	if err != nil {
+		return p, err
+	}
+	defer f.Close()
+	d := json.NewDecoder(io.LimitReader(f, 4097))
+	d.DisallowUnknownFields()
+	if d.Decode(&p) != nil || d.Decode(new(any)) != io.EOF || !p.Inventory.Valid() || p.Mode != "supervised" || p.PID <= 1 || p.Boot == "" || p.Start == "" || p.Inode == 0 {
+		return p, errTrust
+	}
+	return p, nil
+}
+
+// Control is called only by the verified root executable from a fixed DSM
+// task. Package hooks and CGI handlers never call this function.
+func (c Controller) Control(ctx context.Context, action string) error {
+	if ctx.Err() != nil {
+		return ctx.Err()
+	}
+	if action != "enable" && action != "recover" && action != "teardown" && action != "disable" {
+		return errors.New("unsupported lifecycle action")
+	}
+	if !c.Expected.Valid() || c.Processes == nil {
+		return errTrust
+	}
+	if err := protected(c.StateDir, c.Owner, true); err != nil {
+		return err
+	}
+	f, err := os.OpenFile(filepath.Join(c.StateDir, "control.lock"), os.O_CREATE|os.O_RDWR|syscall.O_NOFOLLOW, 0600)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+	if err := protected(f.Name(), c.Owner, false); err != nil {
+		return err
+	}
+	if err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX|syscall.LOCK_NB); err != nil {
+		return errors.New("lifecycle busy")
+	}
+	defer syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
+	r, err := readRecord(c.StateDir, c.Owner)
+	if err != nil && !errors.Is(err, fs.ErrNotExist) {
+		return err
+	}
+	if action == "recover" && (err != nil || !r.Enabled) {
+		return errors.New("explicit enable approval required")
+	}
+	if err != nil {
+		r = Record{Inventory: c.Expected}
+	}
+	if action == "disable" {
+		r.Enabled = false
+	}
+	// Publish the durable gate first. A crashed/failed disable still refuses
+	// requests and exposes required cleanup; never report cleanup as successful.
+	r.Residual = true
+	if err := writeProtected(c.StateDir, "approval.json", r); err != nil {
+		return err
+	}
+	if err := c.teardown(); err != nil {
+		return err
+	}
+	if action == "enable" || action == "recover" {
+		r = Record{Inventory: c.Expected, Enabled: true, Residual: true}
+		if err := writeProtected(c.StateDir, "approval.json", r); err != nil {
+			return err
+		}
+		if err := c.Processes.Start(c.Expected); err != nil {
+			return err
+		}
+	}
+	r.Residual = false
+	return writeProtected(c.StateDir, "approval.json", r)
+}
+
+func (c Controller) teardown() error {
+	p, err := readProcess(c.RunDir, c.Owner)
+	if err != nil && !errors.Is(err, fs.ErrNotExist) {
+		return err
+	}
+	if err == nil {
+		if p.Inventory.Package != c.Expected.Package {
+			return errTrust
+		}
+		if err := c.Processes.Stop(p); err != nil {
+			return err
+		}
+	}
+	for _, name := range []string{"helper.sock", "supervisor.sock"} {
+		path := filepath.Join(c.RunDir, name)
+		st, e := os.Lstat(path)
+		if e == nil {
+			s, ok := st.Sys().(*syscall.Stat_t)
+			if !ok || s.Uid != c.Owner || st.Mode()&os.ModeSocket == 0 || st.Mode().Perm()&0002 != 0 {
+				return errTrust
+			}
+			conn, err := net.DialTimeout("unix", path, 100*time.Millisecond)
+			if err == nil {
+				conn.Close()
+				return errors.New("unidentified live socket")
+			}
+			if !errors.Is(err, syscall.ECONNREFUSED) && !errors.Is(err, fs.ErrNotExist) {
+				return err
+			}
+			if err := os.Remove(path); err != nil && !errors.Is(err, fs.ErrNotExist) {
+				return err
+			}
+		} else if !errors.Is(e, fs.ErrNotExist) {
+			return e
+		}
+	}
+	if err == nil {
+		return os.Remove(filepath.Join(c.RunDir, "process.json"))
+	}
+	return nil
+}

package/dist/templates/native-go/backend/internal/helper/control_test.go

@@ -0,0 +1,242 @@
+package helper
+
+import (
+	"context"
+	"errors"
+	"net"
+	"os"
+	"path/filepath"
+	"testing"
+	"time"
+)
+
+func staleSocket(t *testing.T, p string) {
+	l, err := net.ListenUnix("unix", &net.UnixAddr{Name: p, Net: "unix"})
+	if err != nil {
+		t.Fatal(err)
+	}
+	l.SetUnlinkOnClose(false)
+	l.Close()
+}
+
+type fakeProcesses struct {
+	current          Process
+	stopped, started int
+	stopErr          error
+}
+
+func (f *fakeProcesses) Stop(want Process) error {
+	if f.stopErr != nil {
+		return f.stopErr
+	}
+	if want != f.current {
+		return errTrust
+	}
+	f.stopped++
+	return nil
+}
+func (f *fakeProcesses) Start(Inventory) error { f.started++; return nil }
+
+func controlFixture(t *testing.T) (Controller, *fakeProcesses) {
+	c := fixture(t)
+	p := Process{Inventory: c.Expected, Mode: "supervised", PID: 1234, Boot: "fixture-boot", Start: "100", Device: 1, Inode: 2}
+	f := &fakeProcesses{current: p}
+	ctl := Controller{Client: c, Processes: f}
+	record(t, c, Record{Inventory: c.Expected, Enabled: true})
+	if err := writeProcess(c.RunDir, p); err != nil {
+		t.Fatal(err)
+	}
+	return ctl, f
+}
+
+func TestTeardownAndRecoveryVerifyOwnedProcess(t *testing.T) {
+	for _, kind := range []string{"pid", "boot", "start", "inode", "digest", "package"} {
+		t.Run(kind, func(t *testing.T) {
+			c, f := controlFixture(t)
+			switch kind {
+			case "pid":
+				f.current.PID++
+			case "boot":
+				f.current.Boot = "new-boot"
+			case "start":
+				f.current.Start = "reused"
+			case "inode":
+				f.current.Inode++
+			case "digest":
+				f.current.Inventory.PayloadDigest = "foreign"
+			case "package":
+				f.current.Inventory.Package = "Other"
+			}
+			if c.Control(context.Background(), "recover") == nil || f.stopped != 0 || f.started != 0 {
+				t.Fatal("foreign process touched")
+			}
+			if _, err := os.Stat(filepath.Join(c.RunDir, "process.json")); err != nil {
+				t.Fatal("failure evidence removed")
+			}
+		})
+	}
+	c, f := controlFixture(t)
+	if err := c.Control(context.Background(), "teardown"); err != nil {
+		t.Fatal(err)
+	}
+	if f.stopped != 1 || f.started != 0 {
+		t.Fatal(f)
+	}
+	if _, err := os.Stat(filepath.Join(c.RunDir, "process.json")); !os.IsNotExist(err) {
+		t.Fatal(err)
+	}
+	if err := c.Control(context.Background(), "recover"); err != nil || f.started != 1 {
+		t.Fatalf("%v %+v", err, f)
+	}
+}
+
+func TestDisableIsDurableAndPrecedesFailedCleanup(t *testing.T) {
+	c, f := controlFixture(t)
+	f.stopErr = errors.New("fixture stop failed")
+	if c.Control(context.Background(), "disable") == nil {
+		t.Fatal("cleanup falsely succeeded")
+	}
+	r, err := readRecord(c.StateDir, c.Owner)
+	if err != nil || r.Enabled || !r.Residual {
+		t.Fatalf("%+v %v", r, err)
+	}
+	s := c.Status(context.Background())
+	if s.State != "not-enabled" || s.Cleanup != "required" {
+		t.Fatal(s)
+	}
+	if c.Control(context.Background(), "recover") == nil || f.started != 0 {
+		t.Fatal("old recovery resurrected disabled integration")
+	}
+	f.stopErr = nil
+	if err := c.Control(context.Background(), "disable"); err != nil {
+		t.Fatal(err)
+	}
+	r, _ = readRecord(c.StateDir, c.Owner)
+	if r.Enabled || r.Residual {
+		t.Fatal(r)
+	}
+	if err := c.Control(context.Background(), "enable"); err != nil || f.started != 1 {
+		t.Fatalf("%v %+v", err, f)
+	}
+}
+
+func TestMissingApprovalAndUnknownActionCannotStart(t *testing.T) {
+	c, f := controlFixture(t)
+	os.Remove(filepath.Join(c.StateDir, "approval.json"))
+	if c.Control(context.Background(), "recover") == nil {
+		t.Fatal("recover without approval")
+	}
+	if c.Control(context.Background(), "arbitrary-command") == nil || f.started != 0 {
+		t.Fatal("arbitrary action accepted")
+	}
+}
+
+func TestSocketResidueCannotUnlinkForeignFilesOrLiveListeners(t *testing.T) {
+	for _, kind := range []string{"file", "symlink", "live", "stale"} {
+		t.Run(kind, func(t *testing.T) {
+			c, f := controlFixture(t)
+			os.Remove(filepath.Join(c.RunDir, "process.json"))
+			p := filepath.Join(c.RunDir, "helper.sock")
+			switch kind {
+			case "file":
+				os.WriteFile(p, []byte("foreign"), 0600)
+			case "symlink":
+				os.Symlink("foreign", p)
+			case "live":
+				live(t, c.Client, c.Expected, nil)
+			case "stale":
+				staleSocket(t, p)
+			}
+			err := c.Control(context.Background(), "teardown")
+			if kind == "stale" {
+				if err != nil {
+					t.Fatal(err)
+				}
+				if _, err := os.Lstat(p); !os.IsNotExist(err) {
+					t.Fatal("stale socket not removed")
+				}
+			} else {
+				if err == nil {
+					t.Fatal("foreign residue accepted")
+				}
+				if _, err := os.Lstat(p); err != nil {
+					t.Fatal("foreign residue removed")
+				}
+			}
+			if f.stopped != 0 {
+				t.Fatal("unrecorded process signalled")
+			}
+		})
+	}
+}
+
+func TestLifecycleGateBlocksResidueAndAllowsCleanStoppedState(t *testing.T) {
+	c, _ := controlFixture(t)
+	if c.CheckStopped(context.Background()) == nil {
+		t.Fatal("process residue accepted")
+	}
+	if err := c.Control(context.Background(), "teardown"); err != nil {
+		t.Fatal(err)
+	}
+	if err := c.CheckStopped(context.Background()); err != nil {
+		t.Fatal(err)
+	}
+	record(t, c.Client, Record{Inventory: c.Expected, Enabled: false, Residual: true})
+	if c.CheckStopped(context.Background()) == nil {
+		t.Fatal("failed disable accepted")
+	}
+}
+
+func TestStartupProbesShareOneDeadline(t *testing.T) {
+	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
+	defer cancel()
+	err := waitHealthy(ctx, func(probeCtx context.Context) bool {
+		if probeCtx != ctx {
+			t.Fatal("probe got an independent deadline")
+		}
+		<-probeCtx.Done()
+		return false
+	})
+	if !errors.Is(err, context.DeadlineExceeded) {
+		t.Fatal(err)
+	}
+	if err := waitHealthy(context.Background(), func(context.Context) bool { return true }); err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestSupervisorSocketResidueAlsoBlocksLifecycle(t *testing.T) {
+	c, _ := controlFixture(t)
+	os.Remove(filepath.Join(c.RunDir, "process.json"))
+	p := filepath.Join(c.RunDir, "supervisor.sock")
+	l, err := net.ListenUnix("unix", &net.UnixAddr{Name: p, Net: "unix"})
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer l.Close()
+	if c.CheckStopped(context.Background()) == nil {
+		t.Fatal("unidentified supervisor accepted")
+	}
+	if c.Control(context.Background(), "teardown") == nil {
+		t.Fatal("live supervisor ignored")
+	}
+}
+
+func TestOnlySupervisedProcessRecordsAreReadable(t *testing.T) {
+	for _, mode := range []string{"", "supervised", "unknown"} {
+		c, f := controlFixture(t)
+		p := f.current
+		p.Mode = mode
+		if err := writeProcess(c.RunDir, p); err != nil {
+			t.Fatal(err)
+		}
+		got, err := readProcess(c.RunDir, c.Owner)
+		if mode != "supervised" {
+			if err == nil {
+				t.Fatal("unsupervised process mode accepted")
+			}
+		} else if err != nil || got != p {
+			t.Fatalf("mode %q: %+v %v", mode, got, err)
+		}
+	}
+}

package/dist/templates/native-go/backend/internal/helper/peer_linux.go

@@ -0,0 +1,44 @@
+package helper
+
+import (
+	"net"
+	"syscall"
+)
+
+func peerCredentials(conn *net.UnixConn) (*syscall.Ucred, error) {
+	raw, err := conn.SyscallConn()
+	if err != nil {
+		return nil, err
+	}
+	var cred *syscall.Ucred
+	var sockErr error
+	err = raw.Control(func(fd uintptr) {
+		cred, sockErr = syscall.GetsockoptUcred(int(fd), syscall.SOL_SOCKET, syscall.SO_PEERCRED)
+	})
+	if err != nil {
+		return nil, err
+	}
+	if sockErr != nil {
+		return nil, sockErr
+	}
+	return cred, nil
+}
+
+func peerUID(conn *net.UnixConn) (uint32, error) {
+	cred, err := peerCredentials(conn)
+	if err != nil {
+		return 0, err
+	}
+	return cred.Uid, nil
+}
+
+func RootPeer(conn *net.UnixConn) error {
+	uid, err := peerUID(conn)
+	if err != nil {
+		return err
+	}
+	if uid != 0 {
+		return errTrust
+	}
+	return nil
+}

package/dist/templates/native-go/backend/internal/helper/peer_other.go

@@ -0,0 +1,7 @@
+//go:build !linux
+
+package helper
+
+import "net"
+
+func RootPeer(*net.UnixConn) error { return errTrust }