@synopackageland/cli 0.4.0 → 0.5.0

package/templates/_gateway/auth_test.go

@@ -0,0 +1,216 @@
+package main
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"path/filepath"
+	"slices"
+	"strings"
+	"testing"
+)
+
+const groupFile = `root:x:0:
+users:x:100:
+administrators:x:101:admin,alice
+staff:x:1030:alice,carol
+http:x:1023:
+`
+
+// DSM keeps no member list for users: the group is every local account's primary group.
+const passwdFile = `root:x:0:0::/root:/bin/sh
+alice:x:1001:100::/var/services/homes/alice:/sbin/nologin
+bob:x:1002:100::/var/services/homes/bob:/sbin/nologin
+carol:x:1003:100::/var/services/homes/carol:/sbin/nologin
+dave:x:1004:1030::/var/services/homes/dave:/sbin/nologin
+`
+
+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
+}
+
+type exitError struct{}
+
+func (*exitError) Error() string { return "exit status 1" }
+func (*exitError) ExitCode() int { return 1 }
+
+func newTestAuth(t *testing.T, runner *fakeRunner) *dsmAuthenticator {
+	t.Helper()
+	dir := t.TempDir()
+	groups, passwd := filepath.Join(dir, "group"), filepath.Join(dir, "passwd")
+	for path, content := range map[string]string{groups: groupFile, passwd: passwdFile} {
+		if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
+			t.Fatal(err)
+		}
+	}
+	a := newDSMAuthenticator()
+	a.groupFile, a.passwdFile = groups, passwd
+	a.run = runner.run
+	return a
+}
+
+func sessionRequest() *http.Request {
+	r := httptest.NewRequest(http.MethodGet, "/webman/3rdparty/App/cgi/gateway.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 TestUserAndGroupsComeFromAuthenticateCGIAndGroupFile(t *testing.T) {
+	runner := &fakeRunner{out: "alice\n"}
+	id, err := newTestAuth(t, runner).Authenticate(sessionRequest())
+	if err != nil || id.User != "alice" {
+		t.Fatalf("got %+v, %v", id, err)
+	}
+	if want := []string{"users", "administrators", "staff"}; !slices.Equal(id.Groups, want) {
+		t.Errorf("groups = %v, want %v", id.Groups, want)
+	}
+	if runner.path != authenticateCGI {
+		t.Errorf("ran %q", runner.path)
+	}
+}
+
+func TestOrdinaryUserHasNoAdministratorsGroup(t *testing.T) {
+	id, err := newTestAuth(t, &fakeRunner{out: "bob\n"}).Authenticate(sessionRequest())
+	if err != nil || id.User != "bob" || slices.Contains(id.Groups, "administrators") {
+		t.Fatalf("got %+v, %v", id, err)
+	}
+}
+
+func TestPrimaryGroupCountsAsMembershipEvenWithoutAMemberListEntry(t *testing.T) {
+	id, err := newTestAuth(t, &fakeRunner{out: "bob\n"}).Authenticate(sessionRequest())
+	if err != nil || !slices.Equal(id.Groups, []string{"users"}) {
+		t.Fatalf("got %+v, %v", id, err)
+	}
+}
+
+func TestPrimaryGroupIsNotDuplicatedWhenAlsoListedAsMember(t *testing.T) {
+	a := newTestAuth(t, &fakeRunner{out: "dave"})
+	if err := os.WriteFile(a.groupFile, []byte("staff:x:1030:dave\n"), 0o644); err != nil {
+		t.Fatal(err)
+	}
+	id, _ := a.Authenticate(sessionRequest())
+	if !slices.Equal(id.Groups, []string{"staff"}) {
+		t.Fatalf("groups = %v", id.Groups)
+	}
+}
+
+func TestMissingPasswdFileFailsClosedWithoutBeingNoSession(t *testing.T) {
+	a := newTestAuth(t, &fakeRunner{out: "bob"})
+	a.passwdFile = filepath.Join(t.TempDir(), "absent")
+	if _, err := a.Authenticate(sessionRequest()); err == nil || errors.Is(err, errNoSession) {
+		t.Fatalf("err = %v", 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, errNoSession) || runner.path != "" {
+		t.Fatalf("err=%v ran=%q", err, runner.path)
+	}
+}
+
+func TestExpiredOrMalformedSessionsAreNoSession(t *testing.T) {
+	for name, runner := range map[string]*fakeRunner{
+		"expired session (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, errNoSession) {
+				t.Fatalf("err = %v", err)
+			}
+		})
+	}
+}
+
+func TestAuthenticateCGIThatCannotRunFailsClosedWithoutBeingNoSession(t *testing.T) {
+	_, err := newTestAuth(t, &fakeRunner{err: errors.New("fork/exec: no such file")}).Authenticate(sessionRequest())
+	if err == nil || errors.Is(err, errNoSession) {
+		t.Fatalf("err = %v", err)
+	}
+}
+
+func TestGroupMembershipIsReadFreshOnEveryRequest(t *testing.T) {
+	runner := &fakeRunner{out: "carol"}
+	a := newTestAuth(t, runner)
+	id, _ := a.Authenticate(sessionRequest())
+	if !slices.Equal(id.Groups, []string{"users", "staff"}) {
+		t.Fatalf("groups = %v", id.Groups)
+	}
+	if err := os.WriteFile(a.groupFile, []byte("users:x:100:\nstaff:x:1030:alice\n"), 0o644); err != nil {
+		t.Fatal(err)
+	}
+	id, _ = a.Authenticate(sessionRequest())
+	if !slices.Equal(id.Groups, []string{"users"}) {
+		t.Fatalf("groups after removal = %v", id.Groups)
+	}
+}
+
+func tokenEnv(t *testing.T, r *http.Request) []string {
+	t.Helper()
+	runner := &fakeRunner{out: "alice"}
+	if _, err := newTestAuth(t, runner).Authenticate(r); err != nil {
+		t.Fatal(err)
+	}
+	return runner.env
+}
+
+func TestQueryTokenIsUsedWhenHeaderIsEmpty(t *testing.T) {
+	r := sessionRequest()
+	r.Header.Del("X-SYNO-TOKEN")
+	r.URL.RawQuery = "a=b&SynoToken=q%2Btok"
+	env := tokenEnv(t, r)
+	for _, want := range []string{"HTTP_X_SYNO_TOKEN=q+tok", "QUERY_STRING=SynoToken=q%2Btok"} {
+		if !slices.Contains(env, want) {
+			t.Fatalf("env = %q, missing %q", env, want)
+		}
+	}
+}
+
+func TestHeaderTokenWinsOverQueryToken(t *testing.T) {
+	r := sessionRequest()
+	r.URL.RawQuery = "SynoToken=from-query"
+	env := tokenEnv(t, r)
+	if !slices.Contains(env, "HTTP_X_SYNO_TOKEN=tok+en/=") || slices.Contains(env, "QUERY_STRING=SynoToken=from-query") {
+		t.Fatalf("env = %q", env)
+	}
+}

package/templates/_gateway/cgi.go

@@ -0,0 +1,133 @@
+package main
+
+import (
+	"bufio"
+	"bytes"
+	"errors"
+	"fmt"
+	"io"
+	"net"
+	"net/http"
+	"time"
+)
+
+// serveCGI answers one request the way net/http/cgi.Serve does: "Status:" and headers, a blank line, the body
+// on `out`. It is its own copy so that the reply can be hijacked: the handler then owns `in` and `out`, which
+// is how a WebSocket passes through DSM's CGI interface.
+func serveCGI(h http.Handler, req *http.Request, in io.Reader, out io.Writer) error {
+	if req.Body == nil {
+		req.Body = http.NoBody
+	}
+	rw := &cgiResponse{req: req, header: make(http.Header), in: in, out: out, bufw: bufio.NewWriter(out)}
+	h.ServeHTTP(rw, req)
+	if rw.hijacked {
+		return nil
+	}
+	rw.Write(nil) // make sure a reply is sent
+	return rw.bufw.Flush()
+}
+
+type cgiResponse struct {
+	req         *http.Request
+	header      http.Header
+	code        int
+	wroteHeader bool
+	wroteCGI    bool
+	hijacked    bool
+	in          io.Reader
+	out         io.Writer
+	bufw        *bufio.Writer
+}
+
+func (r *cgiResponse) Header() http.Header { return r.header }
+
+func (r *cgiResponse) Flush() {
+	if !r.hijacked {
+		r.bufw.Flush()
+	}
+}
+
+func (r *cgiResponse) WriteHeader(code int) {
+	if r.wroteHeader {
+		return
+	}
+	r.wroteHeader, r.code = true, code
+}
+
+func (r *cgiResponse) Write(p []byte) (int, error) {
+	if r.hijacked {
+		return 0, http.ErrHijacked
+	}
+	if !r.wroteHeader {
+		r.WriteHeader(http.StatusOK)
+	}
+	if !r.wroteCGI {
+		r.writeCGIHeader(p)
+	}
+	return r.bufw.Write(p)
+}
+
+// writeCGIHeader sends the header block; p, the first chunk of the body, is sniffed for a missing Content-Type.
+func (r *cgiResponse) writeCGIHeader(p []byte) {
+	r.wroteCGI = true
+	fmt.Fprintf(r.bufw, "Status: %d %s\r\n", r.code, http.StatusText(r.code))
+	if _, hasType := r.header["Content-Type"]; !hasType {
+		r.header.Set("Content-Type", http.DetectContentType(p))
+	}
+	r.header.Write(r.bufw)
+	r.bufw.WriteString("\r\n")
+	r.bufw.Flush()
+}
+
+// Hijack hands stdin and stdout to the handler. The first thing it writes is an HTTP/1.1 status line and
+// headers (that is what httputil.ReverseProxy writes for a 101); the CGI interface wants "Status: 101 ..."
+// there, so cgiConn rewrites the status line and leaves everything after the blank line alone.
+func (r *cgiResponse) Hijack() (net.Conn, *bufio.ReadWriter, error) {
+	if r.wroteHeader || r.wroteCGI || r.hijacked {
+		return nil, nil, errors.New("cgi: Hijack after the reply began")
+	}
+	r.hijacked = true
+	c := &cgiConn{in: r.in, out: r.out}
+	return c, bufio.NewReadWriter(bufio.NewReader(c), bufio.NewWriter(c)), nil
+}
+
+type cgiConn struct {
+	in       io.Reader
+	out      io.Writer
+	head     []byte // the header block, held back until it is complete
+	headSent bool
+}
+
+func (c *cgiConn) Read(p []byte) (int, error) { return c.in.Read(p) }
+
+func (c *cgiConn) Write(p []byte) (int, error) {
+	if c.headSent {
+		return c.out.Write(p)
+	}
+	c.head = append(c.head, p...)
+	end := bytes.Index(c.head, []byte("\r\n\r\n"))
+	if end < 0 {
+		return len(p), nil
+	}
+	c.headSent = true
+	statusLine, headers, _ := bytes.Cut(c.head[:end+4], []byte("\r\n"))
+	_, status, _ := bytes.Cut(statusLine, []byte(" ")) // "HTTP/1.1 101 Switching Protocols" -> "101 Switching Protocols"
+	rewritten := append(append([]byte("Status: "), status...), "\r\n"...)
+	rewritten = append(append(rewritten, headers...), c.head[end+4:]...)
+	if _, err := c.out.Write(rewritten); err != nil {
+		return 0, err
+	}
+	return len(p), nil
+}
+
+func (c *cgiConn) Close() error                     { return nil }
+func (c *cgiConn) LocalAddr() net.Addr              { return cgiAddr{} }
+func (c *cgiConn) RemoteAddr() net.Addr             { return cgiAddr{} }
+func (c *cgiConn) SetDeadline(time.Time) error      { return nil }
+func (c *cgiConn) SetReadDeadline(time.Time) error  { return nil }
+func (c *cgiConn) SetWriteDeadline(time.Time) error { return nil }
+
+type cgiAddr struct{}
+
+func (cgiAddr) Network() string { return "cgi" }
+func (cgiAddr) String() string  { return "cgi" }

package/templates/_gateway/cgi_test.go

@@ -0,0 +1,156 @@
+package main
+
+import (
+	"bufio"
+	"bytes"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+)
+
+func cgiRequest(t *testing.T) *http.Request {
+	t.Helper()
+	return httptest.NewRequest("GET", "/webman/3rdparty/App/cgi/gateway.cgi/", nil)
+}
+
+func TestCGIReplyIsAStatusLineThenHeadersThenBody(t *testing.T) {
+	var out bytes.Buffer
+	err := serveCGI(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "text/plain")
+		w.Header().Set("X-Thing", "1")
+		w.WriteHeader(404)
+		io.WriteString(w, "nope")
+	}), cgiRequest(t), strings.NewReader(""), &out)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if want := "Status: 404 Not Found\r\nContent-Type: text/plain\r\nX-Thing: 1\r\n\r\nnope"; out.String() != want {
+		t.Fatalf("got %q\nwant %q", out.String(), want)
+	}
+}
+
+func TestCGIReplyWithoutAWriteStillCarriesAStatus(t *testing.T) {
+	var out bytes.Buffer
+	if err := serveCGI(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}), cgiRequest(t), strings.NewReader(""), &out); err != nil {
+		t.Fatal(err)
+	}
+	if !strings.HasPrefix(out.String(), "Status: 200 OK\r\n") || !strings.HasSuffix(out.String(), "\r\n\r\n") {
+		t.Fatalf("got %q", out.String())
+	}
+}
+
+func TestCGIReplySniffsAMissingContentType(t *testing.T) {
+	var out bytes.Buffer
+	serveCGI(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { io.WriteString(w, "<html></html>") }), cgiRequest(t), strings.NewReader(""), &out)
+	if !strings.Contains(out.String(), "Content-Type: text/html; charset=utf-8\r\n") {
+		t.Fatalf("got %q", out.String())
+	}
+}
+
+// flushRecorder notes how many bytes were out when the handler was still running.
+type flushRecorder struct {
+	bytes.Buffer
+	atFlush int
+}
+
+func TestCGIFlushSendsWhatIsBufferedAtOnce(t *testing.T) {
+	var out flushRecorder
+	serveCGI(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "text/event-stream")
+		io.WriteString(w, "data: one\n\n")
+		w.(http.Flusher).Flush()
+		out.atFlush = out.Len()
+		io.WriteString(w, "data: two\n\n")
+	}), cgiRequest(t), strings.NewReader(""), &out)
+	if !strings.HasSuffix(out.String(), "data: one\n\ndata: two\n\n") || out.atFlush < len("data: one\n\n") {
+		t.Fatalf("flushed %d bytes before the handler ended; total %q", out.atFlush, out.String())
+	}
+}
+
+// After a hijack stdin and stdout belong to the handler. What it writes first is an HTTP/1.1 status line;
+// DSM's CGI interface wants "Status:" instead.
+func TestCGIHijackTurnsTheStatusLineIntoACGIHeaderAndPassesBytesBothWays(t *testing.T) {
+	in, inW := io.Pipe()
+	outR, out := io.Pipe()
+	done := make(chan error, 1)
+	go func() {
+		done <- serveCGI(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			conn, brw, err := w.(http.Hijacker).Hijack()
+			if err != nil {
+				t.Error(err)
+				return
+			}
+			defer conn.Close()
+			io.WriteString(brw, "HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\n\r\n")
+			brw.Flush()
+			buf := make([]byte, 16)
+			n, _ := brw.Read(buf)
+			io.WriteString(conn, "got:"+string(buf[:n]))
+		}), cgiRequest(t), in, out)
+		out.Close()
+	}()
+	r := bufio.NewReader(outR)
+	for _, want := range []string{"Status: 101 Switching Protocols", "Upgrade: websocket", "Connection: Upgrade", ""} {
+		if line, _ := r.ReadString('\n'); strings.TrimRight(line, "\r\n") != want {
+			t.Fatalf("header line %q, want %q", line, want)
+		}
+	}
+	io.WriteString(inW, "ping")
+	rest, _ := io.ReadAll(r)
+	if string(rest) != "got:ping" {
+		t.Fatalf("after the header block: %q (nothing, not even a second status, may follow the handler's bytes)", rest)
+	}
+	if err := <-done; err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestCGIReplyCannotBeWrittenAfterAHijack(t *testing.T) {
+	var out bytes.Buffer
+	serveCGI(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if _, _, err := w.(http.Hijacker).Hijack(); err != nil {
+			t.Fatal(err)
+		}
+		if _, err := w.Write([]byte("late")); err == nil {
+			t.Error("Write after Hijack succeeded")
+		}
+	}), cgiRequest(t), strings.NewReader(""), &out)
+	if out.Len() != 0 {
+		t.Fatalf("output after a bare hijack: %q", out.String())
+	}
+}
+
+// The whole chain as DSM runs it: a WebSocket upgrade enters through the CGI environment and the container's
+// bytes come back on stdout.
+func TestWebSocketThroughTheCGIEnvironment(t *testing.T) {
+	up := newUpstream(t, wsEchoHandler)
+	g := newTestGateway(t, config{Access: "users"}, &fakeAuth{id: identity{User: "bob"}}, up)
+	req := httptest.NewRequest("GET", base+"/ws", nil)
+	req.Host = "nas.example:5001"
+	req.Header.Set("Cookie", "id=abc")
+	req.Header.Set("Connection", "Upgrade")
+	req.Header.Set("Upgrade", "websocket")
+	req.Header.Set("Origin", "https://nas.example:5001")
+	in, inW := io.Pipe()
+	outR, out := io.Pipe()
+	done := make(chan error, 1)
+	go func() { done <- serveCGI(g, req, in, out); out.Close() }()
+	r := bufio.NewReader(outR)
+	if line, _ := r.ReadString('\n'); strings.TrimSpace(line) != "Status: 101 Switching Protocols" {
+		t.Fatalf("first line %q", line)
+	}
+	for line, _ := r.ReadString('\n'); strings.TrimSpace(line) != ""; line, _ = r.ReadString('\n') {
+	}
+	io.WriteString(inW, "hello")
+	got := make([]byte, len("echo:hello"))
+	if _, err := io.ReadFull(r, got); err != nil || string(got) != "echo:hello" {
+		t.Fatalf("echo = %q, %v", got, err)
+	}
+	inW.Close() // DSM closes stdin when the browser goes away
+	io.Copy(io.Discard, r)
+	if err := <-done; err != nil {
+		t.Fatal(err)
+	}
+}

package/templates/_gateway/csrf.go

@@ -0,0 +1,73 @@
+package main
+
+// CSRF defence for state-changing requests. DSM issues a SynoToken only when
+// "Enhance CSRF protection" (enable_syno_token in synoinfo.conf) is on; when it
+// is off, DSM hands every session the same placeholder and validates nothing,
+// so the token alone proves nothing. The gateway therefore needs evidence that
+// the browser itself made the request from the gateway's own origin, and it
+// never stores or trusts a token value of its own.
+
+import (
+	"net/http"
+	"net/url"
+	"strings"
+)
+
+const maxTokenLen = 256
+
+// wellFormedToken accepts any printable ASCII value of sane length. Whether the
+// value is the right one is DSM's call (authenticate.cgi gets it on every
+// request); the gateway only refuses requests that carry nothing usable.
+func wellFormedToken(token string) bool {
+	if token == "" || len(token) > maxTokenLen {
+		return false
+	}
+	for i := 0; i < len(token); i++ {
+		if token[i] < 0x20 || token[i] > 0x7e {
+			return false
+		}
+	}
+	return true
+}
+
+// sameOrigin reports whether the browser says the request came from the page's
+// own origin. Sec-Fetch-Site, when present, must say same-origin; Origin, when
+// present, must be the request's own host. At least one must be present: a
+// browser sends Origin on every cross-origin and every non-GET request, so a
+// state-changing request with neither is not from a browser that can be trusted
+// to scope it (browsers without either, such as IE 11, are refused).
+func sameOrigin(r *http.Request) bool {
+	site := r.Header.Get("Sec-Fetch-Site")
+	origin := r.Header.Get("Origin")
+	if site == "" && origin == "" {
+		return false
+	}
+	if site != "" && site != "same-origin" {
+		return false
+	}
+	return origin == "" || originMatchesHost(origin, r.Host)
+}
+
+// originMatchesHost compares an Origin header (scheme://host[:port], no path)
+// with the Host the request was addressed to. The scheme only decides which
+// port is the default, because a CGI does not reliably learn whether the
+// connection was TLS.
+func originMatchesHost(origin, host string) bool {
+	u, err := url.Parse(origin)
+	if err != nil || u.Host == "" || (u.Scheme != "http" && u.Scheme != "https") || (u.Path != "" && u.Path != "/") || u.User != nil || u.RawQuery != "" || u.Fragment != "" {
+		return false
+	}
+	return withDefaultPort(u.Host, u.Scheme) == withDefaultPort(host, u.Scheme)
+}
+
+func withDefaultPort(host, scheme string) string {
+	host = strings.ToLower(host)
+	i := strings.LastIndex(host, ":")
+	if i >= 0 && !strings.Contains(host[i:], "]") {
+		return host
+	}
+	if scheme == "https" {
+		return host + ":443"
+	}
+	return host + ":80"
+}