@synopackageland/cli 0.3.10 → 0.4.0

package/templates/native-go/backend/internal/api/registry_test.go

@@ -0,0 +1,329 @@
+package api
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+)
+
+// fakeAuth returns a fixed outcome and counts how often it was consulted, so
+// tests can prove each request authenticates at most once.
+type fakeAuth struct {
+	user  string
+	admin bool
+	err   error
+	calls int
+}
+
+func (f *fakeAuth) Authenticate(*http.Request) (Identity, error) {
+	f.calls++
+	if f.err != nil {
+		return Identity{}, f.err
+	}
+	return Identity{User: f.user, Admin: f.admin}, nil
+}
+
+func post(t *testing.T, srv http.Handler, body string, mutate ...func(*http.Request)) (*httptest.ResponseRecorder, envelope) {
+	t.Helper()
+	req := httptest.NewRequest(http.MethodPost, "http://nas.local/webman/3rdparty/App/cgi/api.cgi", strings.NewReader(body))
+	req.Header.Set("Content-Type", "application/json")
+	for _, m := range mutate {
+		m(req)
+	}
+	rec := httptest.NewRecorder()
+	srv.ServeHTTP(rec, req)
+	var env envelope
+	if err := json.Unmarshal(rec.Body.Bytes(), &env); err != nil {
+		t.Fatalf("response is not JSON: %q", rec.Body.String())
+	}
+	return rec, env
+}
+
+type envelope struct {
+	Success bool            `json:"success"`
+	Data    json.RawMessage `json:"data"`
+	Error   *struct {
+		Code string `json:"code"`
+	} `json:"error"`
+}
+
+func countingRoutes(counter *int) []Route {
+	h := func(_ context.Context, c Caller, _ json.RawMessage) (any, error) {
+		*counter++
+		return map[string]string{"user": c.User()}, nil
+	}
+	return []Route{
+		User("demo.user", h),
+		Admin("demo.admin", h),
+	}
+}
+
+func newTestServer(t *testing.T, auth Authenticator, routes ...Route) *Server {
+	t.Helper()
+	srv, err := NewServer(auth, routes...)
+	if err != nil {
+		t.Fatal(err)
+	}
+	return srv
+}
+
+func TestUserRouteRunsForAuthenticatedUserWithVerifiedCaller(t *testing.T) {
+	var executed int
+	auth := &fakeAuth{user: "alice"}
+	srv := newTestServer(t, auth, countingRoutes(&executed)...)
+
+	rec, env := post(t, srv, `{"method":"demo.user"}`)
+
+	if rec.Code != http.StatusOK || !env.Success {
+		t.Fatalf("got %d %s", rec.Code, rec.Body.String())
+	}
+	if string(env.Data) != `{"user":"alice"}` {
+		t.Fatalf("data = %s", env.Data)
+	}
+	if executed != 1 || auth.calls != 1 {
+		t.Fatalf("executed=%d auth=%d, want 1/1", executed, auth.calls)
+	}
+}
+
+func TestEveryProtectedRouteRefusesMissingInvalidAndUnavailableAuth(t *testing.T) {
+	cases := []struct {
+		name string
+		err  error
+		code string
+	}{
+		{"missing session", ErrNoSession, "session_required"},
+		{"invalid session", ErrNoSession, "session_required"},
+		{"auth unavailable", errors.New("authenticate.cgi crashed"), "auth_unavailable"},
+	}
+	for _, method := range []string{"demo.user", "demo.admin"} {
+		for _, tc := range cases {
+			t.Run(method+"/"+tc.name, func(t *testing.T) {
+				var executed int
+				auth := &fakeAuth{err: tc.err}
+				srv := newTestServer(t, auth, countingRoutes(&executed)...)
+
+				rec, env := post(t, srv, `{"method":"`+method+`"}`)
+
+				if rec.Code != http.StatusOK || env.Success || env.Error.Code != tc.code {
+					t.Fatalf("got %d %s", rec.Code, rec.Body.String())
+				}
+				if executed != 0 || auth.calls != 1 {
+					t.Fatalf("executed=%d auth=%d, want 0/1", executed, auth.calls)
+				}
+			})
+		}
+	}
+}
+
+func TestAdminRouteRefusesNonAdminWithoutExecuting(t *testing.T) {
+	var executed int
+	srv := newTestServer(t, &fakeAuth{user: "bob"}, countingRoutes(&executed)...)
+
+	rec, env := post(t, srv, `{"method":"demo.admin"}`)
+
+	if rec.Code != http.StatusOK || env.Error.Code != "admin_required" || executed != 0 {
+		t.Fatalf("got %d %s executed=%d", rec.Code, rec.Body.String(), executed)
+	}
+}
+
+func TestAdminRouteRunsForAdmin(t *testing.T) {
+	var executed int
+	srv := newTestServer(t, &fakeAuth{user: "root-admin", admin: true}, countingRoutes(&executed)...)
+
+	rec, _ := post(t, srv, `{"method":"demo.admin"}`)
+
+	if rec.Code != http.StatusOK || executed != 1 {
+		t.Fatalf("got %d executed=%d", rec.Code, executed)
+	}
+}
+
+func TestUnknownMethodNeedsSessionThenIsNotFound(t *testing.T) {
+	var executed int
+	srv := newTestServer(t, &fakeAuth{err: ErrNoSession}, countingRoutes(&executed)...)
+	_, env := post(t, srv, `{"method":"demo.missing"}`)
+	if env.Error == nil || env.Error.Code != "session_required" {
+		t.Fatalf("anonymous unknown method: got %+v, want session_required (no route probing)", env.Error)
+	}
+
+	srv = newTestServer(t, &fakeAuth{user: "alice", admin: true}, countingRoutes(&executed)...)
+	rec, env := post(t, srv, `{"method":"demo.missing"}`)
+	if rec.Code != http.StatusOK || env.Error.Code != "unknown_method" || executed != 0 {
+		t.Fatalf("got %d %s executed=%d", rec.Code, rec.Body.String(), executed)
+	}
+}
+
+func TestPublicRouteIsExplicitAndSkipsAuthentication(t *testing.T) {
+	var executed int
+	auth := &fakeAuth{err: ErrNoSession}
+	srv := newTestServer(t, auth, Public("demo.ping", func(_ context.Context, c Caller, _ json.RawMessage) (any, error) {
+		executed++
+		if c.Authenticated() {
+			t.Error("public handler received an authenticated caller")
+		}
+		return "pong", nil
+	}))
+
+	rec, _ := post(t, srv, `{"method":"demo.ping"}`)
+
+	if rec.Code != http.StatusOK || executed != 1 || auth.calls != 0 {
+		t.Fatalf("got %d executed=%d auth=%d", rec.Code, executed, auth.calls)
+	}
+}
+
+func TestTransportGuardsRunBeforeAuthenticationAndDispatch(t *testing.T) {
+	cases := []struct {
+		name   string
+		body   string
+		mutate func(*http.Request)
+		code   string
+	}{
+		{"GET", `{"method":"demo.user"}`, func(r *http.Request) { r.Method = http.MethodGet }, "method_not_allowed"},
+		{"form post", `{"method":"demo.user"}`, func(r *http.Request) { r.Header.Set("Content-Type", "text/plain") }, "json_required"},
+		{"cross-site fetch", `{"method":"demo.user"}`, func(r *http.Request) { r.Header.Set("Sec-Fetch-Site", "cross-site") }, "cross_origin"},
+		{"foreign origin", `{"method":"demo.user"}`, func(r *http.Request) { r.Header.Set("Origin", "https://evil.example") }, "cross_origin"},
+		{"oversized body", `{"method":"demo.user","params":"` + strings.Repeat("x", MaxRequestBytes) + `"}`, nil, "request_too_large"},
+		{"malformed JSON", `{"method":`, nil, "bad_request"},
+		{"unknown field", `{"method":"demo.user","user":"admin"}`, nil, "bad_request"},
+		{"trailing data", `{"method":"demo.user"}{}`, nil, "bad_request"},
+	}
+	for _, tc := range cases {
+		t.Run(tc.name, func(t *testing.T) {
+			var executed int
+			auth := &fakeAuth{user: "alice", admin: true}
+			srv := newTestServer(t, auth, countingRoutes(&executed)...)
+			mutate := []func(*http.Request){}
+			if tc.mutate != nil {
+				mutate = append(mutate, tc.mutate)
+			}
+
+			rec, env := post(t, srv, tc.body, mutate...)
+
+			if rec.Code != http.StatusOK || env.Error == nil || env.Error.Code != tc.code {
+				t.Fatalf("got %d %s", rec.Code, rec.Body.String())
+			}
+			if executed != 0 || auth.calls != 0 {
+				t.Fatalf("executed=%d auth=%d, want 0/0", executed, auth.calls)
+			}
+		})
+	}
+}
+
+// countingReader records how much of the request body the server consumed.
+type countingReader struct {
+	r    io.Reader
+	read int
+}
+
+func (c *countingReader) Read(p []byte) (int, error) {
+	n, err := c.r.Read(p)
+	c.read += n
+	return n, err
+}
+
+// DSM's CGI gateway cuts the reply short when a CGI exits without reading
+// its stdin, so every refusal still consumes the request body.
+func TestRefusalsConsumeTheWholeRequestBody(t *testing.T) {
+	cases := map[string]func(*http.Request){
+		"form post":  func(r *http.Request) { r.Header.Set("Content-Type", "text/plain") },
+		"cross-site": func(r *http.Request) { r.Header.Set("Sec-Fetch-Site", "cross-site") },
+		"GET":        func(r *http.Request) { r.Method = http.MethodGet },
+		"oversized":  func(*http.Request) {},
+	}
+	for name, mutate := range cases {
+		t.Run(name, func(t *testing.T) {
+			var executed int
+			srv := newTestServer(t, &fakeAuth{user: "alice"}, countingRoutes(&executed)...)
+			body := `{"method":"demo.user"}`
+			if name == "oversized" {
+				body = `{"method":"demo.user","params":"` + strings.Repeat("x", 2*MaxRequestBytes) + `"}`
+			}
+			reader := &countingReader{r: strings.NewReader(body)}
+			req := httptest.NewRequest(http.MethodPost, "http://nas.local/api.cgi", reader)
+			req.Header.Set("Content-Type", "application/json")
+			mutate(req)
+			srv.ServeHTTP(httptest.NewRecorder(), req)
+			if reader.read != len(body) {
+				t.Fatalf("read %d of %d body bytes", reader.read, len(body))
+			}
+		})
+	}
+}
+
+func TestSameOriginRequestIsAccepted(t *testing.T) {
+	var executed int
+	srv := newTestServer(t, &fakeAuth{user: "alice"}, countingRoutes(&executed)...)
+	rec, _ := post(t, srv, `{"method":"demo.user"}`, func(r *http.Request) {
+		r.Header.Set("Origin", "http://nas.local")
+		r.Header.Set("Sec-Fetch-Site", "same-origin")
+	})
+	if rec.Code != http.StatusOK {
+		t.Fatalf("got %d %s", rec.Code, rec.Body.String())
+	}
+}
+
+func TestResponsesAreUncachedJSON(t *testing.T) {
+	var executed int
+	srv := newTestServer(t, &fakeAuth{err: ErrNoSession}, countingRoutes(&executed)...)
+	rec, _ := post(t, srv, `{"method":"demo.user"}`)
+	if got := rec.Header().Get("Cache-Control"); got != "no-store" {
+		t.Errorf("Cache-Control = %q", got)
+	}
+	if got := rec.Header().Get("Content-Type"); got != "application/json" {
+		t.Errorf("Content-Type = %q", got)
+	}
+}
+
+func TestHandlerErrorsKeepTheirCodeButInternalErrorsAreHidden(t *testing.T) {
+	srv := newTestServer(t, &fakeAuth{user: "alice"},
+		User("demo.invalid", func(context.Context, Caller, json.RawMessage) (any, error) {
+			return nil, BadRequest("text must not be empty")
+		}),
+		User("demo.crash", func(context.Context, Caller, json.RawMessage) (any, error) {
+			return nil, errors.New("disk path /secret/xyz failed")
+		}),
+		User("demo.panic", func(context.Context, Caller, json.RawMessage) (any, error) {
+			panic("boom")
+		}),
+	)
+
+	rec, env := post(t, srv, `{"method":"demo.invalid"}`)
+	if rec.Code != http.StatusOK || env.Error.Code != "bad_request" || !strings.Contains(rec.Body.String(), "text must not be empty") {
+		t.Fatalf("got %d %s", rec.Code, rec.Body.String())
+	}
+	for _, method := range []string{"demo.crash", "demo.panic"} {
+		rec, env = post(t, srv, `{"method":"`+method+`"}`)
+		if rec.Code != http.StatusOK || env.Error.Code != "internal" || strings.Contains(rec.Body.String(), "secret") || strings.Contains(rec.Body.String(), "boom") {
+			t.Fatalf("%s: got %d %s", method, rec.Code, rec.Body.String())
+		}
+	}
+}
+
+func TestRegistryRefusesUnusableRoutes(t *testing.T) {
+	h := func(context.Context, Caller, json.RawMessage) (any, error) { return nil, nil }
+	cases := map[string][]Route{
+		"zero route (no policy)": {{}},
+		"nil handler":            {User("demo.nil", nil)},
+		"bad method name":        {User("Demo Method", h)},
+		"duplicate method":       {User("demo.x", h), Admin("demo.x", h)},
+	}
+	for name, routes := range cases {
+		if _, err := NewServer(&fakeAuth{}, routes...); err == nil {
+			t.Errorf("%s: NewServer accepted it", name)
+		}
+	}
+	if _, err := NewServer(nil, User("demo.x", h)); err == nil {
+		t.Error("NewServer accepted a nil authenticator")
+	}
+}
+
+func TestZeroCallerIsNotAuthenticated(t *testing.T) {
+	var c Caller
+	if c.Authenticated() || c.Admin() || c.User() != "" {
+		t.Fatal("a Caller built outside the server must carry no authority")
+	}
+}

package/templates/native-go/backend/internal/api/server.go

@@ -0,0 +1,155 @@
+package api
+
+import (
+	"bytes"
+	"encoding/json"
+	"errors"
+	"io"
+	"log"
+	"mime"
+	"net/http"
+	"net/url"
+)
+
+// MaxRequestBytes bounds the request body the CGI reads (CONTENT_LENGTH is
+// caller-controlled).
+const MaxRequestBytes = 1 << 20
+
+// ErrNoSession means the request carries no valid DSM session.
+var ErrNoSession = errors.New("no valid DSM session")
+
+// Authenticator verifies the DSM session behind a request.
+type Authenticator interface {
+	Authenticate(r *http.Request) (Identity, error)
+}
+
+// Server is the http.Handler behind the package CGI.
+type Server struct {
+	auth   Authenticator
+	routes map[string]Route
+}
+
+// NewServer refuses an empty authenticator and any route that is not usable,
+// so a mistake fails at startup instead of opening a route.
+func NewServer(auth Authenticator, routes ...Route) (*Server, error) {
+	if auth == nil {
+		return nil, errors.New("api.NewServer needs an Authenticator")
+	}
+	registry, err := buildRegistry(routes)
+	if err != nil {
+		return nil, err
+	}
+	return &Server{auth: auth, routes: registry}, nil
+}
+
+type request struct {
+	Method string          `json:"method"`
+	Params json.RawMessage `json:"params"`
+}
+
+func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	// DSM's CGI gateway cuts the reply short if the CGI exits with request
+	// bytes unread, so drain whatever the handling below did not consume.
+	defer io.Copy(io.Discard, r.Body)
+	defer func() {
+		if p := recover(); p != nil {
+			log.Printf("handler panic: %v", p)
+			writeError(w, internalError)
+		}
+	}()
+	req, apiErr := readRequest(w, r)
+	if apiErr != nil {
+		writeError(w, apiErr)
+		return
+	}
+	caller, route, apiErr := s.authorize(r, req.Method)
+	if apiErr != nil {
+		writeError(w, apiErr)
+		return
+	}
+	data, err := route.handler(r.Context(), caller, req.Params)
+	if err != nil {
+		writeError(w, asError(err))
+		return
+	}
+	writeJSON(w, http.StatusOK, map[string]any{"success": true, "data": data})
+}
+
+// authorize is the single access decision. Public routes skip authentication;
+// everything else, including unknown methods, authenticates exactly once
+// first, so anonymous callers cannot probe which methods exist.
+func (s *Server) authorize(r *http.Request, method string) (Caller, Route, *Error) {
+	route, known := s.routes[method]
+	if known && route.policy == policyPublic {
+		return Caller{}, route, nil
+	}
+	identity, err := s.auth.Authenticate(r)
+	if errors.Is(err, ErrNoSession) {
+		return Caller{}, Route{}, &Error{"session_required", "sign in to DSM again"}
+	}
+	if err != nil {
+		log.Printf("authentication unavailable: %v", err)
+		return Caller{}, Route{}, &Error{"auth_unavailable", "DSM authentication is unavailable"}
+	}
+	if !known {
+		return Caller{}, Route{}, &Error{"unknown_method", "unknown method"}
+	}
+	caller := Caller{identity: identity, authenticated: true}
+	if route.policy == policyAdmin && !caller.Admin() {
+		return Caller{}, Route{}, &Error{"admin_required", "this action needs a DSM administrator"}
+	}
+	return caller, route, nil
+}
+
+func readRequest(w http.ResponseWriter, r *http.Request) (request, *Error) {
+	var req request
+	if r.Method != http.MethodPost {
+		return req, &Error{"method_not_allowed", "use POST"}
+	}
+	if mediaType, _, err := mime.ParseMediaType(r.Header.Get("Content-Type")); err != nil || mediaType != "application/json" {
+		return req, &Error{"json_required", "send Content-Type: application/json"}
+	}
+	if !sameOrigin(r) {
+		return req, &Error{"cross_origin", "cross-origin request refused"}
+	}
+	body, err := io.ReadAll(http.MaxBytesReader(w, r.Body, MaxRequestBytes))
+	if err != nil {
+		return req, &Error{"request_too_large", "request body too large"}
+	}
+	dec := json.NewDecoder(bytes.NewReader(body))
+	dec.DisallowUnknownFields()
+	if err := dec.Decode(&req); err != nil || dec.More() || req.Method == "" {
+		return req, BadRequest(`body must be {"method": "...", "params": {...}}`)
+	}
+	return req, nil
+}
+
+// sameOrigin refuses browser requests another site initiated. The JSON
+// content type already forces a CORS preflight, which DSM never answers; these
+// checks add an explicit refusal when the browser reports the origin.
+func sameOrigin(r *http.Request) bool {
+	if site := r.Header.Get("Sec-Fetch-Site"); site != "" && site != "same-origin" {
+		return false
+	}
+	if origin := r.Header.Get("Origin"); origin != "" {
+		u, err := url.Parse(origin)
+		return err == nil && u.Host == r.Host
+	}
+	return true
+}
+
+func writeJSON(w http.ResponseWriter, status int, body any) {
+	h := w.Header()
+	h.Set("Content-Type", "application/json")
+	h.Set("Cache-Control", "no-store")
+	h.Set("X-Content-Type-Options", "nosniff")
+	w.WriteHeader(status)
+	_ = json.NewEncoder(w).Encode(body)
+}
+
+func writeError(w http.ResponseWriter, e *Error) {
+	writeJSON(w, http.StatusOK, map[string]any{
+		"success": false,
+		"error":   map[string]string{"code": e.Code, "message": e.Message},
+	})
+}

package/templates/native-go/backend/internal/app/root_none.go

@@ -0,0 +1,9 @@
+package app
+
+import "dsmapp/internal/api"
+
+// rootRoutes is empty: this package declares privilege: none and never runs
+// anything as root. `synopkgland init -t native-go --privilege root` creates
+// root.go instead, which reads the results of administrator-approved root
+// operations.
+func (Config) rootRoutes() []api.Route { return nil }

package/templates/native-go/backend/internal/app/routes.go

@@ -0,0 +1,127 @@
+// Package app holds this package's business operations. Add a route here and
+// pick its policy: api.User (any signed-in DSM user), api.Admin (DSM
+// administrators only) or, rarely, api.Public (no sign-in at all).
+package app
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"errors"
+	"io/fs"
+	"os"
+	"path/filepath"
+	"runtime"
+	"time"
+	"unicode/utf8"
+
+	"dsmapp/internal/api"
+	"dsmapp/internal/helper"
+)
+
+// Config is fixed at build time and startup, never taken from a request.
+type Config struct {
+	PackageID       string
+	Version         string
+	HelperInventory helper.Inventory
+	// DataDir is the package's persistent, package-owned directory
+	// (/var/packages/<package>/var). It survives upgrades.
+	DataDir string
+}
+
+func Routes(cfg Config) []api.Route {
+	routes := []api.Route{
+		api.User("integration.status", cfg.integrationStatus),
+		api.User("app.status", cfg.status),
+		api.User("greeting.get", cfg.getGreeting),
+		api.Admin("greeting.set", cfg.setGreeting),
+	}
+	return append(routes, cfg.rootRoutes()...)
+}
+
+func (cfg Config) integrationStatus(ctx context.Context, _ api.Caller, params json.RawMessage) (any, error) {
+	if err := decodeParams(params, &struct{}{}); err != nil {
+		return nil, err
+	}
+	return helper.NewClient(cfg.HelperInventory).Status(ctx), nil
+}
+
+func (cfg Config) status(_ context.Context, caller api.Caller, _ json.RawMessage) (any, error) {
+	return map[string]any{
+		"package":    cfg.PackageID,
+		"version":    cfg.Version,
+		"user":       caller.User(),
+		"admin":      caller.Admin(),
+		"process":    map[string]int{"uid": os.Getuid(), "gid": os.Getgid()},
+		"go_version": runtime.Version(),
+		"platform":   runtime.GOOS + "/" + runtime.GOARCH,
+		"time":       time.Now().UTC().Format(time.RFC3339),
+	}, nil
+}
+
+type greeting struct {
+	Text      string `json:"text"`
+	UpdatedBy string `json:"updated_by,omitempty"`
+}
+
+func (cfg Config) greetingPath() string { return filepath.Join(cfg.DataDir, "greeting.json") }
+
+func (cfg Config) getGreeting(context.Context, api.Caller, json.RawMessage) (any, error) {
+	data, err := os.ReadFile(cfg.greetingPath())
+	if errors.Is(err, fs.ErrNotExist) {
+		return greeting{Text: "Hello"}, nil
+	}
+	if err != nil {
+		return nil, err
+	}
+	var g greeting
+	return g, json.Unmarshal(data, &g)
+}
+
+func (cfg Config) setGreeting(_ context.Context, caller api.Caller, params json.RawMessage) (any, error) {
+	var in struct {
+		Text string `json:"text"`
+	}
+	if err := decodeParams(params, &in); err != nil {
+		return nil, err
+	}
+	if n := utf8.RuneCountInString(in.Text); n < 1 || n > 200 {
+		return nil, api.BadRequest("text must be 1 to 200 characters")
+	}
+	g := greeting{Text: in.Text, UpdatedBy: caller.User()}
+	data, err := json.Marshal(g)
+	if err != nil {
+		return nil, err
+	}
+	return g, writeFileAtomic(cfg.greetingPath(), data)
+}
+
+// decodeParams decodes params strictly: unknown fields are an error.
+func decodeParams(params json.RawMessage, into any) error {
+	if len(params) == 0 {
+		params = json.RawMessage(`{}`)
+	}
+	dec := json.NewDecoder(bytes.NewReader(params))
+	dec.DisallowUnknownFields()
+	if err := dec.Decode(into); err != nil {
+		return api.BadRequest("invalid params: " + err.Error())
+	}
+	return nil
+}
+
+// writeFileAtomic replaces path in one rename, so readers never see half a file.
+func writeFileAtomic(path string, data []byte) error {
+	tmp, err := os.CreateTemp(filepath.Dir(path), ".tmp-*")
+	if err != nil {
+		return err
+	}
+	defer os.Remove(tmp.Name())
+	if _, err := tmp.Write(data); err != nil {
+		tmp.Close()
+		return err
+	}
+	if err := tmp.Close(); err != nil {
+		return err
+	}
+	return os.Rename(tmp.Name(), path)
+}